constants.py 36.6 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Module holding different constants."""

24
25
import re

26
from ganeti import _autoconf
27
from ganeti import _vcsversion
28

Iustin Pop's avatar
Iustin Pop committed
29
# various versions
30
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
Guido Trotter's avatar
Guido Trotter committed
31
32
OS_API_V10 = 10
OS_API_V15 = 15
33
34
OS_API_V20 = 20
OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
35
VCS_VERSION = _vcsversion.VCS_VERSION
Iustin Pop's avatar
Iustin Pop committed
36
EXPORT_VERSION = 0
37
RAPI_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
38

39

40
41
42
43
44
45
46
47
# Format for CONFIG_VERSION:
#   01 03 0123 = 01030123
#   ^^ ^^ ^^^^
#   |  |  + Configuration version/revision
#   |  + Minor version
#   + Major version
#
# It stored as an integer. Make sure not to write an octal number.
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# BuildVersion and SplitVersion must be in here because we can't import other
# modules. The cfgupgrade tool must be able to read and write version numbers
# and thus requires these functions. To avoid code duplication, they're kept in
# here.

def BuildVersion(major, minor, revision):
  """Calculates int version number from major, minor and revision numbers.

  Returns: int representing version number

  """
  assert isinstance(major, int)
  assert isinstance(minor, int)
  assert isinstance(revision, int)
  return (1000000 * major +
            10000 * minor +
                1 * revision)


def SplitVersion(version):
  """Splits version number stored in an int.

  Returns: tuple; (major, minor, revision)

  """
  assert isinstance(version, int)

  (major, remainder) = divmod(version, 1000000)
  (minor, revision) = divmod(remainder, 10000)

  return (major, minor, revision)


82
83
84
CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
CONFIG_REVISION = 0
85
CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
Iustin Pop's avatar
Iustin Pop committed
86

87
88
89
#: RPC protocol version
PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)

90
91
# user separation
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
92
ADMIN_GROUP = _autoconf.ADMIN_GROUP
93
MASTERD_USER = _autoconf.MASTERD_USER
94
MASTERD_GROUP = _autoconf.MASTERD_GROUP
95
RAPI_USER = _autoconf.RAPI_USER
96
97
98
99
RAPI_GROUP = _autoconf.RAPI_GROUP
CONFD_USER = _autoconf.CONFD_USER
CONFD_GROUP = _autoconf.CONFD_GROUP
NODED_USER = _autoconf.NODED_USER
René Nussbaumer's avatar
René Nussbaumer committed
100
NODED_GROUP = _autoconf.NODED_GROUP
101

102

103
# Wipe
104
105
DD_CMD = "dd"
WIPE_BLOCK_SIZE = 1024**2
106
107
108
MAX_WIPE_CHUNK = 1024 # 1GB
MIN_WIPE_CHUNK_PERCENT = 10

109

Iustin Pop's avatar
Iustin Pop committed
110
# file paths
111
DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
112
RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
113
RUN_GANETI_DIR = RUN_DIR + "/ganeti"
114
BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
115
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
116
RUN_DIRS_MODE = 0775
Guido Trotter's avatar
Guido Trotter committed
117
SOCKET_DIR = RUN_GANETI_DIR + "/socket"
118
SECURE_DIR_MODE = 0700
119
SECURE_FILE_MODE = 0600
120
SOCKET_DIR_MODE = 0750
121
CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
Guido Trotter's avatar
Guido Trotter committed
122
CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE
123
124
IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
IMPORT_EXPORT_DIR_MODE = 0755
125
ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
126
127
128
# keep RUN_GANETI_DIR first here, to make sure all get created when the node
# daemon is started (this takes care of RUN_DIR being tmpfs)
SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
Iustin Pop's avatar
Iustin Pop committed
129
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
130
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
131
132
133
# User-id pool lock directory
# The user-ids that are in use have a corresponding lock file in this directory
UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
Iustin Pop's avatar
Iustin Pop committed
134
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
135
NODED_CERT_FILE = DATA_DIR + "/server.pem"
136
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
137
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
Michael Hanselmann's avatar
Michael Hanselmann committed
138
CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
139
WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
140
WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
141
INSTANCE_STATUS_FILE = RUN_GANETI_DIR + "/instance-status"
Iustin Pop's avatar
Iustin Pop committed
142
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
143
RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
144
QUEUE_DIR = DATA_DIR + "/queue"
145
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
146
SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
147
KVM_IFUP = _autoconf.PKGLIBDIR + "/kvm-ifup"
148
KVM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/kvm-console-wrapper"
149
XM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/xm-console-wrapper"
150
ETC_HOSTS = "/etc/hosts"
151
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
152
DEFAULT_SHARED_FILE_STORAGE_DIR = _autoconf.SHARED_FILE_STORAGE_DIR
153
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
154
ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
155
SYSCONFDIR = _autoconf.SYSCONFDIR
156
TOOLSDIR = _autoconf.TOOLSDIR
157
CONF_DIR = SYSCONFDIR + "/ganeti"
158

159
ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
160

161
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
162

163
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
164
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
165
RAPI = "ganeti-rapi"
166
MASTERD = "ganeti-masterd"
Guido Trotter's avatar
Guido Trotter committed
167
168
# used in the ganeti-nbma project
NLD = "ganeti-nld"
169
170
171
172

DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
173
  CONFD: ("udp", 1814),
Guido Trotter's avatar
Guido Trotter committed
174
  RAPI: ("tcp", 5080),
175
  "ssh": ("tcp", 22),
Guido Trotter's avatar
Guido Trotter committed
176
177
  # used in the ganeti-nbma project
  NLD: ("udp", 1816),
178
179
}
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
180
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
Guido Trotter's avatar
Guido Trotter committed
181
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
Guido Trotter's avatar
Guido Trotter committed
182
183
# used in the ganeti-nbma project
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
184

Iustin Pop's avatar
Iustin Pop committed
185
186
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999
187
MASTER_SCRIPT = "ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
188

189
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
190
DAEMONS_LOGFILES = {
Michael Hanselmann's avatar
Michael Hanselmann committed
191
192
193
194
195
  # "daemon-name": "logfile"
  NODED: LOG_DIR + "node-daemon.log",
  CONFD: LOG_DIR + "conf-daemon.log",
  RAPI: LOG_DIR + "rapi-daemon.log",
  MASTERD: LOG_DIR + "master-daemon.log",
Guido Trotter's avatar
Guido Trotter committed
196
197
  # used in the ganeti-nbma project
  NLD: LOG_DIR + "nl-daemon.log",
Michael Hanselmann's avatar
Michael Hanselmann committed
198
  }
Michael Hanselmann's avatar
Michael Hanselmann committed
199

200
201
202
LOG_OS_DIR = LOG_DIR + "os"
LOG_WATCHER = LOG_DIR + "watcher.log"
LOG_COMMANDS = LOG_DIR + "commands.log"
Iustin Pop's avatar
Iustin Pop committed
203
LOG_BURNIN = LOG_DIR + "burnin.log"
204
LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
Iustin Pop's avatar
Iustin Pop committed
205

Luca Bigliardi's avatar
Luca Bigliardi committed
206
207
DEV_CONSOLE = "/dev/console"

Balazs Lecz's avatar
Balazs Lecz committed
208
209
PROC_MOUNTS = "/proc/mounts"

210
# Local UniX Interface related constants
211
LUXI_EOM = "\3"
212
LUXI_VERSION = CONFIG_VERSION
213

Iustin Pop's avatar
Iustin Pop committed
214
# one of "no", "yes", "only"
215
216
217
218
219
220
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

221
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
222
EXPORT_DIR = _autoconf.EXPORT_DIR
Iustin Pop's avatar
Iustin Pop committed
223
224
225

EXPORT_CONF_FILE = "config.ini"

226
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
227
228
229
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD

230
KVM_PATH = _autoconf.KVM_PATH
Guido Trotter's avatar
Guido Trotter committed
231
SOCAT_PATH = _autoconf.SOCAT_PATH
232
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
233
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
234
SOCAT_ESCAPE_CODE = "0x1d"
235

236
237
238
239
240
241
242
243
244
245
246
247
#: Console as SSH command
CONS_SSH = "ssh"

#: Console as VNC server
CONS_VNC = "vnc"

#: Display a message for console access
CONS_MESSAGE = "msg"

#: All console types
CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_MESSAGE])

248
249
250
251
252
# For RSA keys more bits are better, but they also make operations more
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
# 2010 on.
RSA_KEY_BITS = 2048

253
254
255
# Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
# way to disable ciphers would be to use the exclamation mark (!), but socat
# versions below 1.5 can't parse exclamation marks in options properly. When
256
# modifying the ciphers, ensure not to accidentially add something after it's
257
258
259
260
# been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
# "openssl ciphers -v HIGH:-DES".
OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"

261
262
263
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
X509_CERT_SIGN_DIGEST = "SHA1"

264
265
266
267
268
269
# Default validity of certificates in days
X509_CERT_DEFAULT_VALIDITY = 365 * 5

# commonName (CN) used in certificates
X509_CERT_CN = "ganeti.example.com"

270
271
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

272
273
274
275
276
277
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"

# Import/export daemon mode
IEM_IMPORT = "import"
IEM_EXPORT = "export"

278
279
280
281
282
283
284
285
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
IEC_ALL = frozenset([
  IEC_NONE,
  IEC_GZIP,
  ])

286
287
IE_CUSTOM_SIZE = "fd"

288
289
IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")

290
291
292
293
294
295
296
297
# Import/export I/O
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
IEIO_FILE = "file"
# Raw block device I/O using "dd"
IEIO_RAW_DISK = "raw"
# OS definition import/export script
IEIO_SCRIPT = "script"

298
VALUE_DEFAULT = "default"
299
300
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
301
VALUE_NONE = "none"
302
303
VALUE_TRUE = "true"
VALUE_FALSE = "false"
304

305
306
307
# External script validation mask
EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")

Iustin Pop's avatar
Iustin Pop committed
308
# hooks-related constants
309
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
Iustin Pop's avatar
Iustin Pop committed
310
311
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
312
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
313
HOOKS_NAME_WATCHER = "watcher"
314
HOOKS_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
315
316
317
318

# hooks subject type (what object type does the LU deal with)
HTYPE_CLUSTER = "CLUSTER"
HTYPE_NODE = "NODE"
319
HTYPE_GROUP = "GROUP"
Iustin Pop's avatar
Iustin Pop committed
320
321
322
323
324
325
HTYPE_INSTANCE = "INSTANCE"

HKR_SKIP = 0
HKR_FAIL = 1
HKR_SUCCESS = 2

326
327
328
329
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
330
331

# Storage fields
332
333
334
335
# first two are valid in LU context only, not passed to backend
SF_NODE = "node"
SF_TYPE = "type"
# and the rest are valid in backend
336
337
338
339
340
341
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

342
343
344
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

345
# Available fields per storage type
346
347
348
349
VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
                                  SF_USED, SF_FREE, SF_ALLOCATABLE])

VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
Iustin Pop's avatar
Iustin Pop committed
350

351
352
353
354
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

355
VALID_STORAGE_OPERATIONS = {
356
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
357
358
  }

359
360
361
362
363
364
# Local disk status
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
(LDS_OKAY,
 LDS_UNKNOWN,
 LDS_FAULTY) = range(1, 4)

Iustin Pop's avatar
Iustin Pop committed
365
366
367
# disk template types
DT_DISKLESS = "diskless"
DT_PLAIN = "plain"
368
DT_DRBD8 = "drbd"
369
DT_FILE = "file"
370
DT_SHARED_FILE = "sharedfile"
371
DT_BLOCK = "blockdev"
372
373

# the set of network-mirrored disk templates
374
DTS_INT_MIRROR = frozenset([DT_DRBD8])
Iustin Pop's avatar
Iustin Pop committed
375

376
377
# the set of externally-mirrored disk templates (e.g. SAN, NAS)
DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK])
378

379
# the set of non-lvm-based disk templates
380
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE, DT_BLOCK])
381

382
# the set of disk templates which can be grown
383
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE])
384

385
# the set of disk templates that allow adoption
386
387
388
389
DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])

# the set of disk templates that *must* use adoption
DTS_MUST_ADOPT = frozenset([DT_BLOCK])
390

391
# the set of disk templates that allow migrations
392
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
393

Guido Trotter's avatar
Guido Trotter committed
394
395
# the set of file based disk templates
DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
396

397
398
# logical disk types
LD_LV = "lvm"
399
LD_DRBD8 = "drbd8"
400
LD_FILE = "file"
401
402
LD_BLOCKDEV = "blockdev"
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV])
403

Iustin Pop's avatar
Iustin Pop committed
404
405
# drbd constants
DRBD_HMAC_ALG = "md5"
406
DRBD_NET_PROTOCOL = "C"
407
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
Iustin Pop's avatar
Iustin Pop committed
408

409
410
411
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
412
413

# the set of drbd-like disk types
414
LDS_DRBD = frozenset([LD_DRBD8])
415

416
# disk access mode
417
418
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
419
420
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

421
# disk replacement mode
422
423
424
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
425
REPLACE_DISK_AUTO = "replace_auto"
426
427
428
429
430
431
REPLACE_MODES = frozenset([
  REPLACE_DISK_PRI,
  REPLACE_DISK_SEC,
  REPLACE_DISK_CHG,
  REPLACE_DISK_AUTO,
  ])
432

433
434
435
436
437
438
439
440
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
EXPORT_MODES = frozenset([
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

441
# Lock recalculate mode
Iustin Pop's avatar
Iustin Pop committed
442
443
LOCKS_REPLACE = "replace"
LOCKS_APPEND = "append"
444

445
446
447
448
449
450
451
452
# Lock timeout (sum) before we should go into blocking acquire (still
# can be reset by priority change); computed as max time (10 hours)
# before we should actually go into blocking acquire given that we
# start from default priority level; in seconds
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
LOCK_ATTEMPTS_MAXWAIT = 15.0
LOCK_ATTEMPTS_MINWAIT = 1.0

453
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
454
455
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
456
457
458
459
460
461
INSTANCE_REMOTE_IMPORT = "remote-import"
INSTANCE_CREATE_MODES = frozenset([
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
462

463
464
465
466
467
468
469
# Remote import/export handshake message and version
RIE_VERSION = 0
RIE_HANDSHAKE = "Hi, I'm Ganeti"

# Remote import/export certificate validity in seconds
RIE_CERT_VALIDITY = 24 * 60 * 60

470
# Overall timeout for establishing connection
471
RIE_CONNECT_TIMEOUT = 180
472

473
474
475
476
477
478
# Export only: how long to wait per connection attempt (seconds)
RIE_CONNECT_ATTEMPT_TIMEOUT = 20

# Export only: number of attempts to connect
RIE_CONNECT_RETRIES = 10

René Nussbaumer's avatar
René Nussbaumer committed
479
480
#: Give child process up to 5 seconds to exit after sending a signal
CHILD_LINGER_TIMEOUT = 5.0
481

482
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN, DT_DRBD8,
483
                            DT_FILE, DT_SHARED_FILE, DT_BLOCK])
484
485

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
486
487
488
489

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
490
491
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
492
INISECT_OSP = "os"
493

494
# dynamic device modification
495
496
497
DDM_ADD = "add"
DDM_REMOVE = "remove"
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
498

499
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
500
EXIT_SUCCESS = 0
501
EXIT_FAILURE = 1
502
EXIT_NOTCLUSTER = 5
503
EXIT_NOTMASTER = 11
504
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
505
EXIT_CONFIRMATION = 13 # need user confirmation
506

507
508
509
#: Exit code for query operations with unknown fields
EXIT_UNKNOWN_FIELD = 14

510
511
# tags
TAG_CLUSTER = "cluster"
512
TAG_NODEGROUP = "nodegroup"
513
514
TAG_NODE = "node"
TAG_INSTANCE = "instance"
515
516
VALID_TAG_TYPES = frozenset([
  TAG_CLUSTER,
517
  TAG_NODEGROUP,
518
519
520
  TAG_NODE,
  TAG_INSTANCE,
  ])
521
522
523
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

524
525
# others
DEFAULT_BRIDGE = "xen-br0"
Iustin Pop's avatar
Iustin Pop committed
526
SYNC_SPEED = 60 * 1024
527
528
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
IP4_ADDRESS_ANY = "0.0.0.0"
Manuel Franceschini's avatar
Manuel Franceschini committed
529
530
IP6_ADDRESS_LOCALHOST = "::1"
IP6_ADDRESS_ANY = "::"
531
532
IP4_VERSION = 4
IP6_VERSION = 6
533
TCP_PING_TIMEOUT = 10
534
GANETI_RUNAS = "root"
535
DEFAULT_VG = "xenvg"
536
DEFAULT_DRBD_HELPER = "/bin/true"
537
MIN_VG_SIZE = 20480
538
DEFAULT_MAC_PREFIX = "aa:00:00"
539
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
540
541
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
542
NODE_MAX_CLOCK_SKEW = 150
543
# Time for an intra-cluster disk transfer to wait for a connection
544
DISK_TRANSFER_CONNECT_TIMEOUT = 60
545
546
# Disk index separator
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
547

548
549
550
#: Key for job IDs in opcode result
JOB_IDS_KEY = "jobs"

551
552
553
554
555
556
557
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])

558
559
560
561
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

562
# os related constants
Iustin Pop's avatar
Iustin Pop committed
563
564
565
566
567
OS_SCRIPT_CREATE = "create"
OS_SCRIPT_IMPORT = "import"
OS_SCRIPT_EXPORT = "export"
OS_SCRIPT_RENAME = "rename"
OS_SCRIPT_VERIFY = "verify"
Iustin Pop's avatar
Iustin Pop committed
568
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
569
570
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME,
                        OS_SCRIPT_VERIFY])
571

Iustin Pop's avatar
Iustin Pop committed
572
573
574
OS_API_FILE = "ganeti_api_version"
OS_VARIANTS_FILE = "variants.list"
OS_PARAMETERS_FILE = "parameters.list"
575

Iustin Pop's avatar
Iustin Pop committed
576
OS_VALIDATE_PARAMETERS = "parameters"
577
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
578

579
# ssh constants
580
581
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
582
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
583
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
584
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
585
586
SSH = "ssh"
SCP = "scp"
587
588
589
590
591

# reboot types
INSTANCE_REBOOT_SOFT = "soft"
INSTANCE_REBOOT_HARD = "hard"
INSTANCE_REBOOT_FULL = "full"
592

593
594
595
596
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
                          INSTANCE_REBOOT_HARD,
                          INSTANCE_REBOOT_FULL])

Iustin Pop's avatar
Iustin Pop committed
597
VTYPE_STRING = "string"
598
VTYPE_MAYBE_STRING = "maybe-string"
Iustin Pop's avatar
Iustin Pop committed
599
600
601
VTYPE_BOOL = "bool"
VTYPE_SIZE = "size" # size, in MiBs
VTYPE_INT = "int"
602
603
ENFORCEABLE_TYPES = frozenset([
                      VTYPE_STRING,
604
                      VTYPE_MAYBE_STRING,
605
606
607
608
609
                      VTYPE_BOOL,
                      VTYPE_SIZE,
                      VTYPE_INT,
                      ])

610
611
612
# HV parameter names (global namespace)
HV_BOOT_ORDER = "boot_order"
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
613
614
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
615
616
HV_NIC_TYPE = "nic_type"
HV_DISK_TYPE = "disk_type"
617
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
618
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
619
HV_VNC_PASSWORD_FILE = "vnc_password_file"
620
621
622
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
623
624
HV_ACPI = "acpi"
HV_PAE = "pae"
625
626
627
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
628
HV_KERNEL_ARGS = "kernel_args"
629
630
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
631
HV_ROOT_PATH = "root_path"
632
HV_SERIAL_CONSOLE = "serial_console"
633
HV_USB_MOUSE = "usb_mouse"
634
HV_KEYMAP = "keymap"
635
HV_DEVICE_MODEL = "device_model"
636
HV_INIT_SCRIPT = "init_script"
637
HV_MIGRATION_PORT = "migration_port"
638
639
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
640
HV_MIGRATION_MODE = "migration_mode"
641
HV_USE_LOCALTIME = "use_localtime"
642
HV_DISK_CACHE = "disk_cache"
643
644
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
645
HV_KVM_FLAG = "kvm_flag"
646
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
647
HV_KVM_USE_CHROOT = "use_chroot"
648
HV_CPU_MASK = "cpu_mask"
649
HV_MEM_PATH = "mem_path"
650
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
651

652
653
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
654
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
655
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
656
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
657
658
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
659
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
660
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
661
662
663
664
665
666
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
  HV_VNC_TLS: VTYPE_BOOL,
  HV_VNC_X509: VTYPE_STRING,
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
  HV_ACPI: VTYPE_BOOL,
  HV_PAE: VTYPE_BOOL,
667
668
669
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
670
  HV_KERNEL_PATH: VTYPE_STRING,
671
  HV_KERNEL_ARGS: VTYPE_STRING,
672
  HV_INITRD_PATH: VTYPE_STRING,
673
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
674
675
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
676
  HV_KEYMAP: VTYPE_STRING,
677
  HV_DEVICE_MODEL: VTYPE_STRING,
678
  HV_INIT_SCRIPT: VTYPE_STRING,
679
  HV_MIGRATION_PORT: VTYPE_INT,
680
681
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
682
  HV_MIGRATION_MODE: VTYPE_STRING,
683
  HV_USE_LOCALTIME: VTYPE_BOOL,
684
  HV_DISK_CACHE: VTYPE_STRING,
685
686
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
687
  HV_KVM_FLAG: VTYPE_STRING,
688
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
689
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
690
  HV_CPU_MASK: VTYPE_STRING,
691
  HV_MEM_PATH: VTYPE_STRING,
692
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
693
694
695
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
696

697
# Backend parameter names
Iustin Pop's avatar
Iustin Pop committed
698
BE_MEMORY = "memory"
699
BE_VCPUS = "vcpus"
700
BE_AUTO_BALANCE = "auto_balance"
701

702
703
704
705
706
707
708
BES_PARAMETER_TYPES = {
    BE_MEMORY: VTYPE_SIZE,
    BE_VCPUS: VTYPE_INT,
    BE_AUTO_BALANCE: VTYPE_BOOL,
    }

BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
Iustin Pop's avatar
Iustin Pop committed
709

710
711
712
713
714
715
716
717
718
# Node parameter names
ND_OOB_PROGRAM = "oob_program"

NDS_PARAMETER_TYPES = {
    ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
    }

NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())

719
720
721
722
723
724
725
726
727
728
# OOB supported commands
OOB_POWER_ON = "power-on"
OOB_POWER_OFF = "power-off"
OOB_POWER_CYCLE = "power-cycle"
OOB_POWER_STATUS = "power-status"
OOB_HEALTH = "health"

OOB_COMMANDS = frozenset([OOB_POWER_ON, OOB_POWER_OFF, OOB_POWER_CYCLE,
                          OOB_POWER_STATUS, OOB_HEALTH])

729
730
OOB_POWER_STATUS_POWERED = "powered"

731
OOB_TIMEOUT = 60 # 60 seconds
732
OOB_POWER_DELAY = 2.0 # 2 seconds
733
734
735
736
737
738
739
740
741
742
743
744
745

OOB_STATUS_OK = "OK"
OOB_STATUS_WARNING = "WARNING"
OOB_STATUS_CRITICAL = "CRITICAL"
OOB_STATUS_UNKNOWN = "UNKNOWN"

OOB_STATUSES = frozenset([
  OOB_STATUS_OK,
  OOB_STATUS_WARNING,
  OOB_STATUS_CRITICAL,
  OOB_STATUS_UNKNOWN,
  ])

746
747
# Instance Parameters Profile
PP_DEFAULT = "default"
748

749
# NIC_* constants are used inside the ganeti config
Guido Trotter's avatar
Guido Trotter committed
750
751
752
753
754
755
756
757
758
759
760
761
762
763
NIC_MODE = "mode"
NIC_LINK = "link"

NIC_MODE_BRIDGED = "bridged"
NIC_MODE_ROUTED = "routed"

NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])

NICS_PARAMETER_TYPES = {
    NIC_MODE: VTYPE_STRING,
    NIC_LINK: VTYPE_STRING,
    }

NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
764

765
# IDISK_* constants are used in opcodes, to create/change disks
766
767
IDISK_SIZE = "size"
IDISK_MODE = "mode"
768
IDISK_ADOPT = "adopt"
769
IDISK_VG = "vg"
770
IDISK_METAVG = "metavg"
771
772
773
774
IDISK_PARAMS_TYPES = {
  IDISK_SIZE: VTYPE_SIZE,
  IDISK_MODE: VTYPE_STRING,
  IDISK_ADOPT: VTYPE_STRING,
775
  IDISK_VG: VTYPE_STRING,
776
  IDISK_METAVG: VTYPE_STRING,
777
  }
778
779
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())

780
# INIC_* constants are used in opcodes, to create/change nics
781
782
783
784
INIC_MAC = "mac"
INIC_IP = "ip"
INIC_MODE = "mode"
INIC_LINK = "link"
785
786
787
788
789
790
791
INIC_PARAMS_TYPES = {
  INIC_IP: VTYPE_MAYBE_STRING,
  INIC_LINK: VTYPE_STRING,
  INIC_MAC: VTYPE_STRING,
  INIC_MODE: VTYPE_STRING,
  }
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
792

793
# Hypervisor constants
Iustin Pop's avatar
Iustin Pop committed
794
HT_XEN_PVM = "xen-pvm"
795
HT_FAKE = "fake"
Iustin Pop's avatar
Iustin Pop committed
796
HT_XEN_HVM = "xen-hvm"
Guido Trotter's avatar
Guido Trotter committed
797
HT_KVM = "kvm"
798
HT_CHROOT = "chroot"
Iustin Pop's avatar
Iustin Pop committed
799
800
801
802
803
804
805
806
807
HT_LXC = "lxc"
HYPER_TYPES = frozenset([
  HT_XEN_PVM,
  HT_FAKE,
  HT_XEN_HVM,
  HT_KVM,
  HT_CHROOT,
  HT_LXC,
  ])
Guido Trotter's avatar
Guido Trotter committed
808
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
809

810
VNC_BASE_PORT = 5900
811
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
Manuel Franceschini's avatar
Manuel Franceschini committed
812
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
813

814
# NIC types
815
816
817
HT_NIC_RTL8139 = "rtl8139"
HT_NIC_NE2K_PCI = "ne2k_pci"
HT_NIC_NE2K_ISA = "ne2k_isa"
818
819
820
821
822
HT_NIC_I82551 = "i82551"
HT_NIC_I85557B = "i82557b"
HT_NIC_I8259ER = "i82559er"
HT_NIC_PCNET = "pcnet"
HT_NIC_E1000 = "e1000"
823
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
824

825
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
Guido Trotter's avatar
Guido Trotter committed
826
827
                                    HT_NIC_E1000, HT_NIC_NE2K_ISA,
                                    HT_NIC_PARAVIRTUAL])
828
829
830
831
832
HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
                                    HT_NIC_NE2K_ISA, HT_NIC_I82551,
                                    HT_NIC_I85557B, HT_NIC_I8259ER,
                                    HT_NIC_PCNET, HT_NIC_E1000,
                                    HT_NIC_PARAVIRTUAL])
833
834
835
836
837
838
839
840
# Disk types
HT_DISK_IOEMU = "ioemu"
HT_DISK_IDE = "ide"
HT_DISK_SCSI = "scsi"
HT_DISK_SD = "sd"
HT_DISK_MTD = "mtd"
HT_DISK_PFLASH = "pflash"

841
842
843
844
845
846
847
848
849
HT_CACHE_DEFAULT = "default"
HT_CACHE_NONE = "none"
HT_CACHE_WTHROUGH = "writethrough"
HT_CACHE_WBACK = "writeback"
HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
                                  HT_CACHE_NONE,
                                  HT_CACHE_WTHROUGH,
                                  HT_CACHE_WBACK])

850
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
851
852
853
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
                                     HT_DISK_PFLASH])
854

855
856
857
858
859
860
861
# Mouse types:
HT_MOUSE_MOUSE = "mouse"
HT_MOUSE_TABLET = "tablet"

HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])

# Boot order
862
HT_BO_FLOPPY = "floppy"
863
864
865
866
HT_BO_CDROM = "cdrom"
HT_BO_DISK = "disk"
HT_BO_NETWORK = "network"

867
868
HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_FLOPPY, HT_BO_CDROM,
                                   HT_BO_DISK, HT_BO_NETWORK])
869

870
871
872
873
874
875
876
# Security models
HT_SM_NONE = "none"
HT_SM_USER = "user"
HT_SM_POOL = "pool"

HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])

Guido Trotter's avatar
Guido Trotter committed
877
878
879
880
881
882
# Kvm flag values
HT_KVM_ENABLED = "enabled"
HT_KVM_DISABLED = "disabled"

HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])

883
884
885
# Migration type
HT_MIGRATION_LIVE = "live"
HT_MIGRATION_NONLIVE = "non-live"
886
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
887

888
# Cluster Verify steps
Iustin Pop's avatar
Iustin Pop committed
889
VERIFY_NPLUSONE_MEM = "nplusone_mem"
890
891
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])

892
# Node verify constants
893
NV_DRBDHELPER = "drbd-helper"
894
NV_DRBDLIST = "drbd-list"
895
896
897
NV_FILELIST = "filelist"
NV_HVINFO = "hvinfo"
NV_HYPERVISOR = "hypervisor"
898
NV_HVPARAMS = "hvparms"
899
NV_INSTANCELIST = "instancelist"
900
901
NV_LVLIST = "lvlist"
NV_MASTERIP = "master-ip"
902
903
NV_NODELIST = "nodelist"
NV_NODENETTEST = "node-net-test"
904
NV_NODESETUP = "nodesetup"
905
906
NV_OSLIST = "oslist"
NV_PVLIST = "pvlist"
907
NV_TIME = "time"
908
909
NV_VERSION = "version"
NV_VGLIST = "vglist"
910
NV_VMNODES = "vmnodes"
911
NV_OOB_PATHS = "oob-paths"
912
NV_BRIDGES = "bridges"
913

914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# Instance status
INSTST_RUNNING = "running"
INSTST_ADMINDOWN = "ADMIN_down"
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
INSTST_NODEDOWN = "ERROR_nodedown"
INSTST_WRONGNODE = "ERROR_wrongnode"
INSTST_ERRORUP = "ERROR_up"
INSTST_ERRORDOWN = "ERROR_down"
INSTST_ALL = frozenset([
  INSTST_RUNNING,
  INSTST_ADMINDOWN,
  INSTST_NODEOFFLINE,
  INSTST_NODEDOWN,
  INSTST_WRONGNODE,
  INSTST_ERRORUP,
  INSTST_ERRORDOWN,
  ])

932
933
934
935
936
937
938
939
940
941
942
943
944
945
# Node roles
NR_REGULAR = "R"
NR_MASTER = "M"
NR_MCANDIDATE = "C"
NR_DRAINED = "D"
NR_OFFLINE = "O"
NR_ALL = frozenset([
  NR_REGULAR,
  NR_MASTER,
  NR_MCANDIDATE,
  NR_DRAINED,
  NR_OFFLINE,
  ])

946
947
948
949
# SSL certificate check constants (in days)
SSL_CERT_EXPIRATION_WARN = 30
SSL_CERT_EXPIRATION_ERROR = 7

950
# Allocator framework constants
951
IALLOCATOR_VERSION = 2
952
953
IALLOCATOR_DIR_IN = "in"
IALLOCATOR_DIR_OUT = "out"
954
955
956
957
VALID_IALLOCATOR_DIRECTIONS = frozenset([
  IALLOCATOR_DIR_IN,
  IALLOCATOR_DIR_OUT,
  ])
958
959
IALLOCATOR_MODE_ALLOC = "allocate"
IALLOCATOR_MODE_RELOC = "relocate"
960
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
961
962
IALLOCATOR_MODE_CHG_GROUP = "change-group"
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
963