Merge branch 'devel-2.5'
[ganeti-local] / lib / constants.py
1 #
2 #
3
4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
5 #
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 # General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 # 02110-1301, USA.
20
21
22 """Module holding different constants."""
23
24 import re
25
26 from ganeti import _autoconf
27 from ganeti import _vcsversion
28
29 # various versions
30 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
31 OS_API_V10 = 10
32 OS_API_V15 = 15
33 OS_API_V20 = 20
34 OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
35 VCS_VERSION = _vcsversion.VCS_VERSION
36 EXPORT_VERSION = 0
37 RAPI_VERSION = 2
38
39
40 # Format for CONFIG_VERSION:
41 #   01 03 0123 = 01030123
42 #   ^^ ^^ ^^^^
43 #   |  |  + Configuration version/revision
44 #   |  + Minor version
45 #   + Major version
46 #
47 # It stored as an integer. Make sure not to write an octal number.
48
49 # BuildVersion and SplitVersion must be in here because we can't import other
50 # modules. The cfgupgrade tool must be able to read and write version numbers
51 # and thus requires these functions. To avoid code duplication, they're kept in
52 # here.
53
54 def BuildVersion(major, minor, revision):
55   """Calculates int version number from major, minor and revision numbers.
56
57   Returns: int representing version number
58
59   """
60   assert isinstance(major, int)
61   assert isinstance(minor, int)
62   assert isinstance(revision, int)
63   return (1000000 * major +
64             10000 * minor +
65                 1 * revision)
66
67
68 def SplitVersion(version):
69   """Splits version number stored in an int.
70
71   Returns: tuple; (major, minor, revision)
72
73   """
74   assert isinstance(version, int)
75
76   (major, remainder) = divmod(version, 1000000)
77   (minor, revision) = divmod(remainder, 10000)
78
79   return (major, minor, revision)
80
81
82 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
83 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
84 CONFIG_REVISION = 0
85 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
86
87 #: RPC protocol version
88 PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)
89
90 # user separation
91 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 RAPI_GROUP = _autoconf.RAPI_GROUP
97 CONFD_USER = _autoconf.CONFD_USER
98 CONFD_GROUP = _autoconf.CONFD_GROUP
99 NODED_USER = _autoconf.NODED_USER
100 NODED_GROUP = _autoconf.NODED_GROUP
101
102 # cpu pinning separators and constants
103 CPU_PINNING_SEP = ":"
104 CPU_PINNING_ALL = "all"
105 # internal representation of "all"
106 CPU_PINNING_ALL_VAL = -1
107
108 # A Xen-specific implementation detail - there is no way to actually say
109 # "use any cpu for pinning" in a Xen configuration file, as opposed to the
110 # command line, where you can say "xm vcpu-pin <domain> <vcpu> all".
111 # The workaround used in Xen is "0-63" (see source code function
112 # xm_vcpu_pin in <xen-source>/tools/python/xen/xm/main.py).
113 # To support future changes, the following constant is treated as a
114 # blackbox string that simply means use-any-cpu-for-pinning-under-xen.
115 CPU_PINNING_ALL_XEN = "0-63"
116
117 # Wipe
118 DD_CMD = "dd"
119 WIPE_BLOCK_SIZE = 1024 ** 2
120 MAX_WIPE_CHUNK = 1024 # 1GB
121 MIN_WIPE_CHUNK_PERCENT = 10
122
123
124 # file paths
125 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
126 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
127 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
128 BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
129 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
130 RUN_DIRS_MODE = 0775
131 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
132 SECURE_DIR_MODE = 0700
133 SECURE_FILE_MODE = 0600
134 SOCKET_DIR_MODE = 0750
135 CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
136 CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE
137 IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
138 IMPORT_EXPORT_DIR_MODE = 0755
139 ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
140 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
141 # daemon is started (this takes care of RUN_DIR being tmpfs)
142 SUB_RUN_DIRS = [
143   RUN_GANETI_DIR,
144   BDEV_CACHE_DIR,
145   DISK_LINKS_DIR,
146   ]
147 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
148 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
149 # User-id pool lock directory
150 # The user-ids that are in use have a corresponding lock file in this directory
151 UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
152 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
153 NODED_CERT_FILE = DATA_DIR + "/server.pem"
154 RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
155 CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
156 CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
157 INSTANCE_STATUS_FILE = RUN_GANETI_DIR + "/instance-status"
158 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
159 RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
160 QUEUE_DIR = DATA_DIR + "/queue"
161 DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
162 SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
163 KVM_IFUP = _autoconf.PKGLIBDIR + "/kvm-ifup"
164 KVM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/kvm-console-wrapper"
165 XM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/xm-console-wrapper"
166 ETC_HOSTS = "/etc/hosts"
167 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
168 DEFAULT_SHARED_FILE_STORAGE_DIR = _autoconf.SHARED_FILE_STORAGE_DIR
169 ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
170 ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
171 SYSCONFDIR = _autoconf.SYSCONFDIR
172 TOOLSDIR = _autoconf.TOOLSDIR
173 CONF_DIR = SYSCONFDIR + "/ganeti"
174
175 #: Lock file for watcher, locked in shared mode by watcher; lock in exclusive
176 # mode to block watcher (see L{cli._RunWhileClusterStoppedHelper.Call}
177 WATCHER_LOCK_FILE = LOCK_DIR + "/ganeti-watcher.lock"
178
179 #: Status file for per-group watcher, locked in exclusive mode by watcher
180 WATCHER_GROUP_STATE_FILE = DATA_DIR + "/watcher.%s.data"
181
182 #: File for per-group instance status, merged into L{INSTANCE_STATUS_FILE} by
183 #: per-group processes
184 WATCHER_GROUP_INSTANCE_STATUS_FILE = DATA_DIR + "/watcher.%s.instance-status"
185
186 #: File containing Unix timestamp until which watcher should be paused
187 WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
188
189 ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
190
191 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
192
193 NODED = "ganeti-noded"
194 CONFD = "ganeti-confd"
195 RAPI = "ganeti-rapi"
196 MASTERD = "ganeti-masterd"
197 # used in the ganeti-nbma project
198 NLD = "ganeti-nld"
199
200 DAEMONS_PORTS = {
201   # daemon-name: ("proto", "default-port")
202   NODED: ("tcp", 1811),
203   CONFD: ("udp", 1814),
204   RAPI: ("tcp", 5080),
205   "ssh": ("tcp", 22),
206   # used in the ganeti-nbma project
207   NLD: ("udp", 1816),
208 }
209 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
210 DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
211 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
212 # used in the ganeti-nbma project
213 DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
214
215 FIRST_DRBD_PORT = 11000
216 LAST_DRBD_PORT = 14999
217 MASTER_SCRIPT = "ganeti-master"
218
219 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
220 DAEMONS_LOGFILES = {
221   # "daemon-name": "logfile"
222   NODED: LOG_DIR + "node-daemon.log",
223   CONFD: LOG_DIR + "conf-daemon.log",
224   RAPI: LOG_DIR + "rapi-daemon.log",
225   MASTERD: LOG_DIR + "master-daemon.log",
226   # used in the ganeti-nbma project
227   NLD: LOG_DIR + "nl-daemon.log",
228   }
229
230 LOG_OS_DIR = LOG_DIR + "os"
231 LOG_WATCHER = LOG_DIR + "watcher.log"
232 LOG_COMMANDS = LOG_DIR + "commands.log"
233 LOG_BURNIN = LOG_DIR + "burnin.log"
234 LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
235
236 DEV_CONSOLE = "/dev/console"
237
238 PROC_MOUNTS = "/proc/mounts"
239
240 # Local UniX Interface related constants
241 LUXI_EOM = "\3"
242 LUXI_VERSION = CONFIG_VERSION
243
244 # one of "no", "yes", "only"
245 SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
246 SYSLOG_NO = "no"
247 SYSLOG_YES = "yes"
248 SYSLOG_ONLY = "only"
249 SYSLOG_SOCKET = "/dev/log"
250
251 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
252 EXPORT_DIR = _autoconf.EXPORT_DIR
253
254 EXPORT_CONF_FILE = "config.ini"
255
256 XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
257 XEN_KERNEL = _autoconf.XEN_KERNEL
258 XEN_INITRD = _autoconf.XEN_INITRD
259
260 KVM_PATH = _autoconf.KVM_PATH
261 SOCAT_PATH = _autoconf.SOCAT_PATH
262 SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
263 SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
264 SOCAT_ESCAPE_CODE = "0x1d"
265
266 #: Console as SSH command
267 CONS_SSH = "ssh"
268
269 #: Console as VNC server
270 CONS_VNC = "vnc"
271
272 #: Console as SPICE server
273 CONS_SPICE = "spice"
274
275 #: Display a message for console access
276 CONS_MESSAGE = "msg"
277
278 #: All console types
279 CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_SPICE, CONS_MESSAGE])
280
281 # For RSA keys more bits are better, but they also make operations more
282 # expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
283 # 2010 on.
284 RSA_KEY_BITS = 2048
285
286 # Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
287 # way to disable ciphers would be to use the exclamation mark (!), but socat
288 # versions below 1.5 can't parse exclamation marks in options properly. When
289 # modifying the ciphers, ensure not to accidentially add something after it's
290 # been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
291 # "openssl ciphers -v HIGH:-DES".
292 OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"
293
294 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
295 X509_CERT_SIGN_DIGEST = "SHA1"
296
297 # Default validity of certificates in days
298 X509_CERT_DEFAULT_VALIDITY = 365 * 5
299
300 # commonName (CN) used in certificates
301 X509_CERT_CN = "ganeti.example.com"
302
303 X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
304
305 IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
306
307 # Import/export daemon mode
308 IEM_IMPORT = "import"
309 IEM_EXPORT = "export"
310
311 # Import/export transport compression
312 IEC_NONE = "none"
313 IEC_GZIP = "gzip"
314 IEC_ALL = frozenset([
315   IEC_NONE,
316   IEC_GZIP,
317   ])
318
319 IE_CUSTOM_SIZE = "fd"
320
321 IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")
322
323 # Import/export I/O
324 # Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
325 IEIO_FILE = "file"
326 # Raw block device I/O using "dd"
327 IEIO_RAW_DISK = "raw"
328 # OS definition import/export script
329 IEIO_SCRIPT = "script"
330
331 VALUE_DEFAULT = "default"
332 VALUE_AUTO = "auto"
333 VALUE_GENERATE = "generate"
334 VALUE_NONE = "none"
335 VALUE_TRUE = "true"
336 VALUE_FALSE = "false"
337
338 # External script validation mask
339 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
340
341 # hooks-related constants
342 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
343 HOOKS_PHASE_PRE = "pre"
344 HOOKS_PHASE_POST = "post"
345 HOOKS_NAME_CFGUPDATE = "config-update"
346 HOOKS_NAME_WATCHER = "watcher"
347 HOOKS_VERSION = 2
348
349 # hooks subject type (what object type does the LU deal with)
350 HTYPE_CLUSTER = "CLUSTER"
351 HTYPE_NODE = "NODE"
352 HTYPE_GROUP = "GROUP"
353 HTYPE_INSTANCE = "INSTANCE"
354
355 HKR_SKIP = 0
356 HKR_FAIL = 1
357 HKR_SUCCESS = 2
358
359 # Storage types
360 ST_FILE = "file"
361 ST_LVM_PV = "lvm-pv"
362 ST_LVM_VG = "lvm-vg"
363
364 # Storage fields
365 # first two are valid in LU context only, not passed to backend
366 SF_NODE = "node"
367 SF_TYPE = "type"
368 # and the rest are valid in backend
369 SF_NAME = "name"
370 SF_SIZE = "size"
371 SF_FREE = "free"
372 SF_USED = "used"
373 SF_ALLOCATABLE = "allocatable"
374
375 # Storage operations
376 SO_FIX_CONSISTENCY = "fix-consistency"
377
378 # Available fields per storage type
379 VALID_STORAGE_FIELDS = frozenset([
380   SF_NAME,
381   SF_TYPE,
382   SF_SIZE,
383   SF_USED,
384   SF_FREE,
385   SF_ALLOCATABLE
386   ])
387
388 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
389
390 MODIFIABLE_STORAGE_FIELDS = {
391   ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
392   }
393
394 VALID_STORAGE_OPERATIONS = {
395   ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
396   }
397
398 # Local disk status
399 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
400 (LDS_OKAY,
401  LDS_UNKNOWN,
402  LDS_FAULTY) = range(1, 4)
403
404 # disk template types
405 DT_DISKLESS = "diskless"
406 DT_PLAIN = "plain"
407 DT_DRBD8 = "drbd"
408 DT_FILE = "file"
409 DT_SHARED_FILE = "sharedfile"
410 DT_BLOCK = "blockdev"
411
412 # the set of network-mirrored disk templates
413 DTS_INT_MIRROR = frozenset([DT_DRBD8])
414
415 # the set of externally-mirrored disk templates (e.g. SAN, NAS)
416 DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK])
417
418 # the set of non-lvm-based disk templates
419 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE, DT_BLOCK])
420
421 # the set of disk templates which can be grown
422 DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE])
423
424 # the set of disk templates that allow adoption
425 DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])
426
427 # the set of disk templates that *must* use adoption
428 DTS_MUST_ADOPT = frozenset([DT_BLOCK])
429
430 # the set of disk templates that allow migrations
431 DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
432
433 # the set of file based disk templates
434 DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
435
436 # logical disk types
437 LD_LV = "lvm"
438 LD_DRBD8 = "drbd8"
439 LD_FILE = "file"
440 LD_BLOCKDEV = "blockdev"
441 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV])
442
443 # drbd constants
444 DRBD_HMAC_ALG = "md5"
445 DRBD_NET_PROTOCOL = "C"
446 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
447
448 # file backend driver
449 FD_LOOP = "loop"
450 FD_BLKTAP = "blktap"
451
452 # the set of drbd-like disk types
453 LDS_DRBD = frozenset([LD_DRBD8])
454
455 # disk access mode
456 DISK_RDONLY = "ro"
457 DISK_RDWR = "rw"
458 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
459
460 # disk replacement mode
461 REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
462 REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
463 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
464 REPLACE_DISK_AUTO = "replace_auto"
465 REPLACE_MODES = frozenset([
466   REPLACE_DISK_PRI,
467   REPLACE_DISK_SEC,
468   REPLACE_DISK_CHG,
469   REPLACE_DISK_AUTO,
470   ])
471
472 # Instance export mode
473 EXPORT_MODE_LOCAL = "local"
474 EXPORT_MODE_REMOTE = "remote"
475 EXPORT_MODES = frozenset([
476   EXPORT_MODE_LOCAL,
477   EXPORT_MODE_REMOTE,
478   ])
479
480 # Lock recalculate mode
481 LOCKS_REPLACE = "replace"
482 LOCKS_APPEND = "append"
483
484 # Lock timeout (sum) before we should go into blocking acquire (still
485 # can be reset by priority change); computed as max time (10 hours)
486 # before we should actually go into blocking acquire given that we
487 # start from default priority level; in seconds
488 LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
489 LOCK_ATTEMPTS_MAXWAIT = 15.0
490 LOCK_ATTEMPTS_MINWAIT = 1.0
491
492 # instance creation modes
493 INSTANCE_CREATE = "create"
494 INSTANCE_IMPORT = "import"
495 INSTANCE_REMOTE_IMPORT = "remote-import"
496 INSTANCE_CREATE_MODES = frozenset([
497   INSTANCE_CREATE,
498   INSTANCE_IMPORT,
499   INSTANCE_REMOTE_IMPORT,
500   ])
501
502 # Remote import/export handshake message and version
503 RIE_VERSION = 0
504 RIE_HANDSHAKE = "Hi, I'm Ganeti"
505
506 # Remote import/export certificate validity in seconds
507 RIE_CERT_VALIDITY = 24 * 60 * 60
508
509 # Overall timeout for establishing connection
510 RIE_CONNECT_TIMEOUT = 180
511
512 # Export only: how long to wait per connection attempt (seconds)
513 RIE_CONNECT_ATTEMPT_TIMEOUT = 20
514
515 # Export only: number of attempts to connect
516 RIE_CONNECT_RETRIES = 10
517
518 #: Give child process up to 5 seconds to exit after sending a signal
519 CHILD_LINGER_TIMEOUT = 5.0
520
521 DISK_TEMPLATES = frozenset([
522   DT_DISKLESS,
523   DT_PLAIN,
524   DT_DRBD8,
525   DT_FILE,
526   DT_SHARED_FILE,
527   DT_BLOCK
528   ])
529
530 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
531
532 # import/export config options
533 INISECT_EXP = "export"
534 INISECT_INS = "instance"
535 INISECT_HYP = "hypervisor"
536 INISECT_BEP = "backend"
537 INISECT_OSP = "os"
538
539 # dynamic device modification
540 DDM_ADD = "add"
541 DDM_REMOVE = "remove"
542 DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
543
544 # common exit codes
545 EXIT_SUCCESS = 0
546 EXIT_FAILURE = 1
547 EXIT_NOTCLUSTER = 5
548 EXIT_NOTMASTER = 11
549 EXIT_NODESETUP_ERROR = 12
550 EXIT_CONFIRMATION = 13 # need user confirmation
551
552 #: Exit code for query operations with unknown fields
553 EXIT_UNKNOWN_FIELD = 14
554
555 # tags
556 TAG_CLUSTER = "cluster"
557 TAG_NODEGROUP = "nodegroup"
558 TAG_NODE = "node"
559 TAG_INSTANCE = "instance"
560 VALID_TAG_TYPES = frozenset([
561   TAG_CLUSTER,
562   TAG_NODEGROUP,
563   TAG_NODE,
564   TAG_INSTANCE,
565   ])
566 MAX_TAG_LEN = 128
567 MAX_TAGS_PER_OBJ = 4096
568
569 # others
570 DEFAULT_BRIDGE = "xen-br0"
571 SYNC_SPEED = 60 * 1024
572 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
573 IP4_ADDRESS_ANY = "0.0.0.0"
574 IP6_ADDRESS_LOCALHOST = "::1"
575 IP6_ADDRESS_ANY = "::"
576 IP4_VERSION = 4
577 IP6_VERSION = 6
578 VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
579 TCP_PING_TIMEOUT = 10
580 GANETI_RUNAS = "root"
581 DEFAULT_VG = "xenvg"
582 DEFAULT_DRBD_HELPER = "/bin/true"
583 MIN_VG_SIZE = 20480
584 DEFAULT_MAC_PREFIX = "aa:00:00"
585 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
586 # default maximum instance wait time, in seconds.
587 DEFAULT_SHUTDOWN_TIMEOUT = 120
588 NODE_MAX_CLOCK_SKEW = 150
589 # Time for an intra-cluster disk transfer to wait for a connection
590 DISK_TRANSFER_CONNECT_TIMEOUT = 60
591 # Disk index separator
592 DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
593 IP_COMMAND_PATH = _autoconf.IP_PATH
594
595 #: Key for job IDs in opcode result
596 JOB_IDS_KEY = "jobs"
597
598 # runparts results
599 (RUNPARTS_SKIP,
600  RUNPARTS_RUN,
601  RUNPARTS_ERR) = range(3)
602
603 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
604
605 # RPC constants
606 (RPC_ENCODING_NONE,
607  RPC_ENCODING_ZLIB_BASE64) = range(2)
608
609 # os related constants
610 OS_SCRIPT_CREATE = "create"
611 OS_SCRIPT_IMPORT = "import"
612 OS_SCRIPT_EXPORT = "export"
613 OS_SCRIPT_RENAME = "rename"
614 OS_SCRIPT_VERIFY = "verify"
615 OS_SCRIPTS = frozenset([
616   OS_SCRIPT_CREATE,
617   OS_SCRIPT_IMPORT,
618   OS_SCRIPT_EXPORT,
619   OS_SCRIPT_RENAME,
620   OS_SCRIPT_VERIFY
621   ])
622
623 OS_API_FILE = "ganeti_api_version"
624 OS_VARIANTS_FILE = "variants.list"
625 OS_PARAMETERS_FILE = "parameters.list"
626
627 OS_VALIDATE_PARAMETERS = "parameters"
628 OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
629
630 # ssh constants
631 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
632 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
633 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
634 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
635 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
636 SSH = "ssh"
637 SCP = "scp"
638
639 # reboot types
640 INSTANCE_REBOOT_SOFT = "soft"
641 INSTANCE_REBOOT_HARD = "hard"
642 INSTANCE_REBOOT_FULL = "full"
643
644 REBOOT_TYPES = frozenset([
645   INSTANCE_REBOOT_SOFT,
646   INSTANCE_REBOOT_HARD,
647   INSTANCE_REBOOT_FULL
648   ])
649
650 # instance reboot behaviors
651 INSTANCE_REBOOT_ALLOWED = "reboot"
652 INSTANCE_REBOOT_EXIT = "exit"
653
654 REBOOT_BEHAVIORS = frozenset([
655   INSTANCE_REBOOT_ALLOWED,
656   INSTANCE_REBOOT_EXIT
657   ])
658
659 VTYPE_STRING = "string"
660 VTYPE_MAYBE_STRING = "maybe-string"
661 VTYPE_BOOL = "bool"
662 VTYPE_SIZE = "size" # size, in MiBs
663 VTYPE_INT = "int"
664 ENFORCEABLE_TYPES = frozenset([
665   VTYPE_STRING,
666   VTYPE_MAYBE_STRING,
667   VTYPE_BOOL,
668   VTYPE_SIZE,
669   VTYPE_INT,
670   ])
671
672 # Constant representing that the user does not specify any IP version
673 IFACE_NO_IP_VERSION_SPECIFIED = 0
674
675 # HV parameter names (global namespace)
676 HV_BOOT_ORDER = "boot_order"
677 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
678 HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
679 HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
680 HV_NIC_TYPE = "nic_type"
681 HV_DISK_TYPE = "disk_type"
682 HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
683 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
684 HV_VNC_PASSWORD_FILE = "vnc_password_file"
685 HV_VNC_TLS = "vnc_tls"
686 HV_VNC_X509 = "vnc_x509_path"
687 HV_VNC_X509_VERIFY = "vnc_x509_verify"
688 HV_KVM_SPICE_BIND = "spice_bind"
689 HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
690 HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
691 HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
692 HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
693 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
694 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
695 HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
696 HV_ACPI = "acpi"
697 HV_PAE = "pae"
698 HV_USE_BOOTLOADER = "use_bootloader"
699 HV_BOOTLOADER_ARGS = "bootloader_args"
700 HV_BOOTLOADER_PATH = "bootloader_path"
701 HV_KERNEL_ARGS = "kernel_args"
702 HV_KERNEL_PATH = "kernel_path"
703 HV_INITRD_PATH = "initrd_path"
704 HV_ROOT_PATH = "root_path"
705 HV_SERIAL_CONSOLE = "serial_console"
706 HV_USB_MOUSE = "usb_mouse"
707 HV_KEYMAP = "keymap"
708 HV_DEVICE_MODEL = "device_model"
709 HV_INIT_SCRIPT = "init_script"
710 HV_MIGRATION_PORT = "migration_port"
711 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
712 HV_MIGRATION_DOWNTIME = "migration_downtime"
713 HV_MIGRATION_MODE = "migration_mode"
714 HV_USE_LOCALTIME = "use_localtime"
715 HV_DISK_CACHE = "disk_cache"
716 HV_SECURITY_MODEL = "security_model"
717 HV_SECURITY_DOMAIN = "security_domain"
718 HV_KVM_FLAG = "kvm_flag"
719 HV_VHOST_NET = "vhost_net"
720 HV_KVM_USE_CHROOT = "use_chroot"
721 HV_CPU_MASK = "cpu_mask"
722 HV_MEM_PATH = "mem_path"
723 HV_BLOCKDEV_PREFIX = "blockdev_prefix"
724 HV_REBOOT_BEHAVIOR = "reboot_behavior"
725
726 HVS_PARAMETER_TYPES = {
727   HV_BOOT_ORDER: VTYPE_STRING,
728   HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
729   HV_CDROM_IMAGE_PATH: VTYPE_STRING,
730   HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
731   HV_NIC_TYPE: VTYPE_STRING,
732   HV_DISK_TYPE: VTYPE_STRING,
733   HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
734   HV_VNC_PASSWORD_FILE: VTYPE_STRING,
735   HV_VNC_BIND_ADDRESS: VTYPE_STRING,
736   HV_VNC_TLS: VTYPE_BOOL,
737   HV_VNC_X509: VTYPE_STRING,
738   HV_VNC_X509_VERIFY: VTYPE_BOOL,
739   HV_KVM_SPICE_BIND: VTYPE_STRING,
740   HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
741   HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
742   HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
743   HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
744   HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
745   HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
746   HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
747   HV_ACPI: VTYPE_BOOL,
748   HV_PAE: VTYPE_BOOL,
749   HV_USE_BOOTLOADER: VTYPE_BOOL,
750   HV_BOOTLOADER_PATH: VTYPE_STRING,
751   HV_BOOTLOADER_ARGS: VTYPE_STRING,
752   HV_KERNEL_PATH: VTYPE_STRING,
753   HV_KERNEL_ARGS: VTYPE_STRING,
754   HV_INITRD_PATH: VTYPE_STRING,
755   HV_ROOT_PATH: VTYPE_MAYBE_STRING,
756   HV_SERIAL_CONSOLE: VTYPE_BOOL,
757   HV_USB_MOUSE: VTYPE_STRING,
758   HV_KEYMAP: VTYPE_STRING,
759   HV_DEVICE_MODEL: VTYPE_STRING,
760   HV_INIT_SCRIPT: VTYPE_STRING,
761   HV_MIGRATION_PORT: VTYPE_INT,
762   HV_MIGRATION_BANDWIDTH: VTYPE_INT,
763   HV_MIGRATION_DOWNTIME: VTYPE_INT,
764   HV_MIGRATION_MODE: VTYPE_STRING,
765   HV_USE_LOCALTIME: VTYPE_BOOL,
766   HV_DISK_CACHE: VTYPE_STRING,
767   HV_SECURITY_MODEL: VTYPE_STRING,
768   HV_SECURITY_DOMAIN: VTYPE_STRING,
769   HV_KVM_FLAG: VTYPE_STRING,
770   HV_VHOST_NET: VTYPE_BOOL,
771   HV_KVM_USE_CHROOT: VTYPE_BOOL,
772   HV_CPU_MASK: VTYPE_STRING,
773   HV_MEM_PATH: VTYPE_STRING,
774   HV_BLOCKDEV_PREFIX: VTYPE_STRING,
775   HV_REBOOT_BEHAVIOR: VTYPE_STRING,
776   }
777
778 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
779
780 # Backend parameter names
781 BE_MEMORY = "memory"
782 BE_VCPUS = "vcpus"
783 BE_AUTO_BALANCE = "auto_balance"
784
785 BES_PARAMETER_TYPES = {
786     BE_MEMORY: VTYPE_SIZE,
787     BE_VCPUS: VTYPE_INT,
788     BE_AUTO_BALANCE: VTYPE_BOOL,
789     }
790
791 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
792
793 # Node parameter names
794 ND_OOB_PROGRAM = "oob_program"
795
796 NDS_PARAMETER_TYPES = {
797     ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
798     }
799
800 NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
801
802 # OOB supported commands
803 OOB_POWER_ON = "power-on"
804 OOB_POWER_OFF = "power-off"
805 OOB_POWER_CYCLE = "power-cycle"
806 OOB_POWER_STATUS = "power-status"
807 OOB_HEALTH = "health"
808
809 OOB_COMMANDS = frozenset([
810   OOB_POWER_ON,
811   OOB_POWER_OFF,
812   OOB_POWER_CYCLE,
813   OOB_POWER_STATUS,
814   OOB_HEALTH
815   ])
816
817 OOB_POWER_STATUS_POWERED = "powered"
818
819 OOB_TIMEOUT = 60 # 60 seconds
820 OOB_POWER_DELAY = 2.0 # 2 seconds
821
822 OOB_STATUS_OK = "OK"
823 OOB_STATUS_WARNING = "WARNING"
824 OOB_STATUS_CRITICAL = "CRITICAL"
825 OOB_STATUS_UNKNOWN = "UNKNOWN"
826
827 OOB_STATUSES = frozenset([
828   OOB_STATUS_OK,
829   OOB_STATUS_WARNING,
830   OOB_STATUS_CRITICAL,
831   OOB_STATUS_UNKNOWN,
832   ])
833
834 # Instance Parameters Profile
835 PP_DEFAULT = "default"
836
837 # NIC_* constants are used inside the ganeti config
838 NIC_MODE = "mode"
839 NIC_LINK = "link"
840
841 NIC_MODE_BRIDGED = "bridged"
842 NIC_MODE_ROUTED = "routed"
843
844 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
845
846 NICS_PARAMETER_TYPES = {
847     NIC_MODE: VTYPE_STRING,
848     NIC_LINK: VTYPE_STRING,
849     }
850
851 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
852
853 # IDISK_* constants are used in opcodes, to create/change disks
854 IDISK_SIZE = "size"
855 IDISK_MODE = "mode"
856 IDISK_ADOPT = "adopt"
857 IDISK_VG = "vg"
858 IDISK_METAVG = "metavg"
859 IDISK_PARAMS_TYPES = {
860   IDISK_SIZE: VTYPE_SIZE,
861   IDISK_MODE: VTYPE_STRING,
862   IDISK_ADOPT: VTYPE_STRING,
863   IDISK_VG: VTYPE_STRING,
864   IDISK_METAVG: VTYPE_STRING,
865   }
866 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
867
868 # INIC_* constants are used in opcodes, to create/change nics
869 INIC_MAC = "mac"
870 INIC_IP = "ip"
871 INIC_MODE = "mode"
872 INIC_LINK = "link"
873 INIC_PARAMS_TYPES = {
874   INIC_IP: VTYPE_MAYBE_STRING,
875   INIC_LINK: VTYPE_STRING,
876   INIC_MAC: VTYPE_STRING,
877   INIC_MODE: VTYPE_STRING,
878   }
879 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
880
881 # Hypervisor constants
882 HT_XEN_PVM = "xen-pvm"
883 HT_FAKE = "fake"
884 HT_XEN_HVM = "xen-hvm"
885 HT_KVM = "kvm"
886 HT_CHROOT = "chroot"
887 HT_LXC = "lxc"
888 HYPER_TYPES = frozenset([
889   HT_XEN_PVM,
890   HT_FAKE,
891   HT_XEN_HVM,
892   HT_KVM,
893   HT_CHROOT,
894   HT_LXC,
895   ])
896 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
897
898 VNC_BASE_PORT = 5900
899 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
900 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
901
902 # NIC types
903 HT_NIC_RTL8139 = "rtl8139"
904 HT_NIC_NE2K_PCI = "ne2k_pci"
905 HT_NIC_NE2K_ISA = "ne2k_isa"
906 HT_NIC_I82551 = "i82551"
907 HT_NIC_I85557B = "i82557b"
908 HT_NIC_I8259ER = "i82559er"
909 HT_NIC_PCNET = "pcnet"
910 HT_NIC_E1000 = "e1000"
911 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
912
913 HT_HVM_VALID_NIC_TYPES = frozenset([
914   HT_NIC_RTL8139,
915   HT_NIC_NE2K_PCI,
916   HT_NIC_E1000,
917   HT_NIC_NE2K_ISA,
918   HT_NIC_PARAVIRTUAL
919   ])
920 HT_KVM_VALID_NIC_TYPES = frozenset([
921   HT_NIC_RTL8139,
922   HT_NIC_NE2K_PCI,
923   HT_NIC_NE2K_ISA,
924   HT_NIC_I82551,
925   HT_NIC_I85557B,
926   HT_NIC_I8259ER,
927   HT_NIC_PCNET,
928   HT_NIC_E1000,
929   HT_NIC_PARAVIRTUAL
930   ])
931
932 # Disk types
933 HT_DISK_IOEMU = "ioemu"
934 HT_DISK_IDE = "ide"
935 HT_DISK_SCSI = "scsi"
936 HT_DISK_SD = "sd"
937 HT_DISK_MTD = "mtd"
938 HT_DISK_PFLASH = "pflash"
939
940 HT_CACHE_DEFAULT = "default"
941 HT_CACHE_NONE = "none"
942 HT_CACHE_WTHROUGH = "writethrough"
943 HT_CACHE_WBACK = "writeback"
944 HT_VALID_CACHE_TYPES = frozenset([
945   HT_CACHE_DEFAULT,
946   HT_CACHE_NONE,
947   HT_CACHE_WTHROUGH,
948   HT_CACHE_WBACK
949   ])
950
951 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
952 HT_KVM_VALID_DISK_TYPES = frozenset([
953   HT_DISK_PARAVIRTUAL,
954   HT_DISK_IDE,
955   HT_DISK_SCSI,
956   HT_DISK_SD,
957   HT_DISK_MTD,
958   HT_DISK_PFLASH
959   ])
960
961 # Mouse types:
962 HT_MOUSE_MOUSE = "mouse"
963 HT_MOUSE_TABLET = "tablet"
964
965 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
966
967 # Boot order
968 HT_BO_FLOPPY = "floppy"
969 HT_BO_CDROM = "cdrom"
970 HT_BO_DISK = "disk"
971 HT_BO_NETWORK = "network"
972
973 HT_KVM_VALID_BO_TYPES = frozenset([
974   HT_BO_FLOPPY,
975   HT_BO_CDROM,
976   HT_BO_DISK,
977   HT_BO_NETWORK
978   ])
979
980 # SPICE lossless image compression options
981 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
982 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
983 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
984 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
985 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
986 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
987
988 HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
989   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
990   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
991   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
992   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
993   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
994   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
995   ])
996
997 # SPICE lossy image compression options (valid for both jpeg and zlib-glz)
998 HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
999 HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1000 HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1001
1002 HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1003   HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1004   HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1005   HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1006   ])
1007
1008 # SPICE video stream detection
1009 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1010 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1011 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1012
1013 HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1014   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1015   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1016   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1017   ])
1018
1019 # Security models
1020 HT_SM_NONE = "none"
1021 HT_SM_USER = "user"
1022 HT_SM_POOL = "pool"
1023
1024 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1025
1026 # Kvm flag values
1027 HT_KVM_ENABLED = "enabled"
1028 HT_KVM_DISABLED = "disabled"
1029
1030 HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1031
1032 # Migration type
1033 HT_MIGRATION_LIVE = "live"
1034 HT_MIGRATION_NONLIVE = "non-live"
1035 HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1036
1037 # Cluster Verify steps
1038 VERIFY_NPLUSONE_MEM = "nplusone_mem"
1039 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1040
1041 # Node verify constants
1042 NV_DRBDHELPER = "drbd-helper"
1043 NV_DRBDLIST = "drbd-list"
1044 NV_FILELIST = "filelist"
1045 NV_HVINFO = "hvinfo"
1046 NV_HYPERVISOR = "hypervisor"
1047 NV_HVPARAMS = "hvparms"
1048 NV_INSTANCELIST = "instancelist"
1049 NV_LVLIST = "lvlist"
1050 NV_MASTERIP = "master-ip"
1051 NV_NODELIST = "nodelist"
1052 NV_NODENETTEST = "node-net-test"
1053 NV_NODESETUP = "nodesetup"
1054 NV_OSLIST = "oslist"
1055 NV_PVLIST = "pvlist"
1056 NV_TIME = "time"
1057 NV_VERSION = "version"
1058 NV_VGLIST = "vglist"
1059 NV_VMNODES = "vmnodes"
1060 NV_OOB_PATHS = "oob-paths"
1061 NV_BRIDGES = "bridges"
1062
1063 # Instance status
1064 INSTST_RUNNING = "running"
1065 INSTST_ADMINDOWN = "ADMIN_down"
1066 INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1067 INSTST_NODEDOWN = "ERROR_nodedown"
1068 INSTST_WRONGNODE = "ERROR_wrongnode"
1069 INSTST_ERRORUP = "ERROR_up"
1070 INSTST_ERRORDOWN = "ERROR_down"
1071 INSTST_ALL = frozenset([
1072   INSTST_RUNNING,
1073   INSTST_ADMINDOWN,
1074   INSTST_NODEOFFLINE,
1075   INSTST_NODEDOWN,
1076   INSTST_WRONGNODE,
1077   INSTST_ERRORUP,
1078   INSTST_ERRORDOWN,
1079   ])
1080
1081 # Node roles
1082 NR_REGULAR = "R"
1083 NR_MASTER = "M"
1084 NR_MCANDIDATE = "C"
1085 NR_DRAINED = "D"
1086 NR_OFFLINE = "O"
1087 NR_ALL = frozenset([
1088   NR_REGULAR,
1089   NR_MASTER,
1090   NR_MCANDIDATE,
1091   NR_DRAINED,
1092   NR_OFFLINE,
1093   ])
1094
1095 # SSL certificate check constants (in days)
1096 SSL_CERT_EXPIRATION_WARN = 30
1097 SSL_CERT_EXPIRATION_ERROR = 7
1098
1099 # Allocator framework constants
1100 IALLOCATOR_VERSION = 2
1101 IALLOCATOR_DIR_IN = "in"
1102 IALLOCATOR_DIR_OUT = "out"
1103 VALID_IALLOCATOR_DIRECTIONS = frozenset([
1104   IALLOCATOR_DIR_IN,
1105   IALLOCATOR_DIR_OUT,
1106   ])
1107 IALLOCATOR_MODE_ALLOC = "allocate"
1108 IALLOCATOR_MODE_RELOC = "relocate"
1109 IALLOCATOR_MODE_CHG_GROUP = "change-group"
1110 IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1111 VALID_IALLOCATOR_MODES = frozenset([
1112   IALLOCATOR_MODE_ALLOC,
1113   IALLOCATOR_MODE_RELOC,
1114   IALLOCATOR_MODE_CHG_GROUP,
1115   IALLOCATOR_MODE_NODE_EVAC,
1116   ])
1117 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1118
1119 IALLOCATOR_NEVAC_PRI = "primary-only"
1120 IALLOCATOR_NEVAC_SEC = "secondary-only"
1121 IALLOCATOR_NEVAC_ALL = "all"
1122 IALLOCATOR_NEVAC_MODES = frozenset([
1123   IALLOCATOR_NEVAC_PRI,
1124   IALLOCATOR_NEVAC_SEC,
1125   IALLOCATOR_NEVAC_ALL,
1126   ])
1127
1128 # Job queue
1129 JOB_QUEUE_VERSION = 1
1130 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1131 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1132 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1133 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1134 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1135 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1136 JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
1137 JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
1138
1139 JOB_ID_TEMPLATE = r"\d+"
1140 JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1141
1142 # unchanged job return
1143 JOB_NOTCHANGED = "nochange"
1144
1145 # Job status
1146 JOB_STATUS_QUEUED = "queued"
1147 JOB_STATUS_WAITING = "waiting"
1148 JOB_STATUS_CANCELING = "canceling"
1149 JOB_STATUS_RUNNING = "running"
1150 JOB_STATUS_CANCELED = "canceled"
1151 JOB_STATUS_SUCCESS = "success"
1152 JOB_STATUS_ERROR = "error"
1153 JOBS_FINALIZED = frozenset([
1154   JOB_STATUS_CANCELED,
1155   JOB_STATUS_SUCCESS,
1156   JOB_STATUS_ERROR,
1157   ])
1158 JOB_STATUS_ALL = frozenset([
1159   JOB_STATUS_QUEUED,
1160   JOB_STATUS_WAITING,
1161   JOB_STATUS_CANCELING,
1162   JOB_STATUS_RUNNING,
1163   ]) | JOBS_FINALIZED
1164
1165 # OpCode status
1166 # not yet finalized
1167 OP_STATUS_QUEUED = "queued"
1168 OP_STATUS_WAITING = "waiting"
1169 OP_STATUS_CANCELING = "canceling"
1170 OP_STATUS_RUNNING = "running"
1171 # finalized
1172 OP_STATUS_CANCELED = "canceled"
1173 OP_STATUS_SUCCESS = "success"
1174 OP_STATUS_ERROR = "error"
1175 OPS_FINALIZED = frozenset([
1176   OP_STATUS_CANCELED,
1177   OP_STATUS_SUCCESS,
1178   OP_STATUS_ERROR
1179   ])
1180
1181 # OpCode priority
1182 OP_PRIO_LOWEST = +19
1183 OP_PRIO_HIGHEST = -20
1184
1185 OP_PRIO_LOW = +10
1186 OP_PRIO_NORMAL = 0
1187 OP_PRIO_HIGH = -10
1188
1189 OP_PRIO_SUBMIT_VALID = frozenset([
1190   OP_PRIO_LOW,
1191   OP_PRIO_NORMAL,
1192   OP_PRIO_HIGH,
1193   ])
1194
1195 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1196
1197 # Execution log types
1198 ELOG_MESSAGE = "message"
1199 ELOG_PROGRESS = "progress"
1200 ELOG_REMOTE_IMPORT = "remote-import"
1201 ELOG_JQUEUE_TEST = "jqueue-test"
1202
1203 # /etc/hosts modification
1204 ETC_HOSTS_ADD = "add"
1205 ETC_HOSTS_REMOVE = "remove"
1206
1207 # Job queue test
1208 JQT_MSGPREFIX = "TESTMSG="
1209 JQT_EXPANDNAMES = "expandnames"
1210 JQT_EXEC = "exec"
1211 JQT_LOGMSG = "logmsg"
1212 JQT_STARTMSG = "startmsg"
1213 JQT_ALL = frozenset([
1214   JQT_EXPANDNAMES,
1215   JQT_EXEC,
1216   JQT_LOGMSG,
1217   JQT_STARTMSG,
1218   ])
1219
1220 # Query resources
1221 QR_INSTANCE = "instance"
1222 QR_NODE = "node"
1223 QR_LOCK = "lock"
1224 QR_GROUP = "group"
1225 QR_OS = "os"
1226
1227 #: List of resources which can be queried using L{opcodes.OpQuery}
1228 QR_VIA_OP = frozenset([QR_INSTANCE, QR_NODE, QR_GROUP, QR_OS])
1229
1230 #: List of resources which can be queried using Local UniX Interface
1231 QR_VIA_LUXI = QR_VIA_OP.union([
1232   QR_LOCK,
1233   ])
1234
1235 #: List of resources which can be queried using RAPI
1236 QR_VIA_RAPI = QR_VIA_LUXI
1237
1238 # Query field types
1239 QFT_UNKNOWN = "unknown"
1240 QFT_TEXT = "text"
1241 QFT_BOOL = "bool"
1242 QFT_NUMBER = "number"
1243 QFT_UNIT = "unit"
1244 QFT_TIMESTAMP = "timestamp"
1245 QFT_OTHER = "other"
1246
1247 #: All query field types
1248 QFT_ALL = frozenset([
1249   QFT_UNKNOWN,
1250   QFT_TEXT,
1251   QFT_BOOL,
1252   QFT_NUMBER,
1253   QFT_UNIT,
1254   QFT_TIMESTAMP,
1255   QFT_OTHER,
1256   ])
1257
1258 # Query result field status (don't change or reuse values as they're used by
1259 # clients)
1260 #: Normal field status
1261 RS_NORMAL = 0
1262 #: Unknown field
1263 RS_UNKNOWN = 1
1264 #: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1265 RS_NODATA = 2
1266 #: Value unavailable/unsupported for item; if this field is supported
1267 #: but we cannot get the data for the moment, RS_NODATA or
1268 #: RS_OFFLINE should be used
1269 RS_UNAVAIL = 3
1270 #: Resource marked offline
1271 RS_OFFLINE = 4
1272
1273 RS_ALL = frozenset([
1274   RS_NORMAL,
1275   RS_UNKNOWN,
1276   RS_NODATA,
1277   RS_UNAVAIL,
1278   RS_OFFLINE,
1279   ])
1280
1281 #: Dictionary with special field cases and their verbose/terse formatting
1282 RSS_DESCRIPTION = {
1283   RS_UNKNOWN: ("(unknown)", "??"),
1284   RS_NODATA: ("(nodata)", "?"),
1285   RS_OFFLINE: ("(offline)", "*"),
1286   RS_UNAVAIL: ("(unavail)", "-"),
1287   }
1288
1289 # max dynamic devices
1290 MAX_NICS = 8
1291 MAX_DISKS = 16
1292
1293 # SSCONF keys
1294 SS_CLUSTER_NAME = "cluster_name"
1295 SS_CLUSTER_TAGS = "cluster_tags"
1296 SS_FILE_STORAGE_DIR = "file_storage_dir"
1297 SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1298 SS_MASTER_CANDIDATES = "master_candidates"
1299 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1300 SS_MASTER_IP = "master_ip"
1301 SS_MASTER_NETDEV = "master_netdev"
1302 SS_MASTER_NODE = "master_node"
1303 SS_NODE_LIST = "node_list"
1304 SS_NODE_PRIMARY_IPS = "node_primary_ips"
1305 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1306 SS_OFFLINE_NODES = "offline_nodes"
1307 SS_ONLINE_NODES = "online_nodes"
1308 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1309 SS_INSTANCE_LIST = "instance_list"
1310 SS_RELEASE_VERSION = "release_version"
1311 SS_HYPERVISOR_LIST = "hypervisor_list"
1312 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1313 SS_UID_POOL = "uid_pool"
1314 SS_NODEGROUPS = "nodegroups"
1315
1316 SS_FILE_PERMS = 0444
1317
1318 # cluster wide default parameters
1319 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1320
1321 HVC_DEFAULTS = {
1322   HT_XEN_PVM: {
1323     HV_USE_BOOTLOADER: False,
1324     HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1325     HV_BOOTLOADER_ARGS: "",
1326     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1327     HV_INITRD_PATH: "",
1328     HV_ROOT_PATH: "/dev/sda1",
1329     HV_KERNEL_ARGS: "ro",
1330     HV_MIGRATION_PORT: 8002,
1331     HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1332     HV_BLOCKDEV_PREFIX: "sd",
1333     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1334     HV_CPU_MASK: CPU_PINNING_ALL,
1335     },
1336   HT_XEN_HVM: {
1337     HV_BOOT_ORDER: "cd",
1338     HV_CDROM_IMAGE_PATH: "",
1339     HV_NIC_TYPE: HT_NIC_RTL8139,
1340     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1341     HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1342     HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1343     HV_ACPI: True,
1344     HV_PAE: True,
1345     HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1346     HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1347     HV_MIGRATION_PORT: 8002,
1348     HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1349     HV_USE_LOCALTIME: False,
1350     HV_BLOCKDEV_PREFIX: "hd",
1351     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1352     HV_CPU_MASK: CPU_PINNING_ALL,
1353     },
1354   HT_KVM: {
1355     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1356     HV_INITRD_PATH: "",
1357     HV_KERNEL_ARGS: "ro",
1358     HV_ROOT_PATH: "/dev/vda1",
1359     HV_ACPI: True,
1360     HV_SERIAL_CONSOLE: True,
1361     HV_VNC_BIND_ADDRESS: "",
1362     HV_VNC_TLS: False,
1363     HV_VNC_X509: "",
1364     HV_VNC_X509_VERIFY: False,
1365     HV_VNC_PASSWORD_FILE: "",
1366     HV_KVM_SPICE_BIND: "",
1367     HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1368     HV_KVM_SPICE_PASSWORD_FILE: "",
1369     HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1370     HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1371     HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1372     HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1373     HV_KVM_SPICE_AUDIO_COMPR: True,
1374     HV_KVM_FLOPPY_IMAGE_PATH: "",
1375     HV_CDROM_IMAGE_PATH: "",
1376     HV_KVM_CDROM2_IMAGE_PATH: "",
1377     HV_BOOT_ORDER: HT_BO_DISK,
1378     HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1379     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1380     HV_KVM_CDROM_DISK_TYPE: "",
1381     HV_USB_MOUSE: "",
1382     HV_KEYMAP: "",
1383     HV_MIGRATION_PORT: 8102,
1384     HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1385     HV_MIGRATION_DOWNTIME: 30,  # ms
1386     HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1387     HV_USE_LOCALTIME: False,
1388     HV_DISK_CACHE: HT_CACHE_DEFAULT,
1389     HV_SECURITY_MODEL: HT_SM_NONE,
1390     HV_SECURITY_DOMAIN: "",
1391     HV_KVM_FLAG: "",
1392     HV_VHOST_NET: False,
1393     HV_KVM_USE_CHROOT: False,
1394     HV_MEM_PATH: "",
1395     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1396     HV_CPU_MASK: CPU_PINNING_ALL,
1397     },
1398   HT_FAKE: {
1399     },
1400   HT_CHROOT: {
1401     HV_INIT_SCRIPT: "/ganeti-chroot",
1402     },
1403   HT_LXC: {
1404     HV_CPU_MASK: "",
1405     },
1406   }
1407
1408 HVC_GLOBALS = frozenset([
1409   HV_MIGRATION_PORT,
1410   HV_MIGRATION_BANDWIDTH,
1411   HV_MIGRATION_MODE,
1412   ])
1413
1414 BEC_DEFAULTS = {
1415   BE_MEMORY: 128,
1416   BE_VCPUS: 1,
1417   BE_AUTO_BALANCE: True,
1418   }
1419
1420 NDC_DEFAULTS = {
1421   ND_OOB_PROGRAM: None,
1422   }
1423
1424 NICC_DEFAULTS = {
1425   NIC_MODE: NIC_MODE_BRIDGED,
1426   NIC_LINK: DEFAULT_BRIDGE,
1427   }
1428
1429 MASTER_POOL_SIZE_DEFAULT = 10
1430
1431 CONFD_PROTOCOL_VERSION = 1
1432
1433 CONFD_REQ_PING = 0
1434 CONFD_REQ_NODE_ROLE_BYNAME = 1
1435 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1436 CONFD_REQ_CLUSTER_MASTER = 3
1437 CONFD_REQ_NODE_PIP_LIST = 4
1438 CONFD_REQ_MC_PIP_LIST = 5
1439 CONFD_REQ_INSTANCES_IPS_LIST = 6
1440
1441 # Confd request query fields. These are used to narrow down queries.
1442 # These must be strings rather than integers, because json-encoding
1443 # converts them to strings anyway, as they're used as dict-keys.
1444 CONFD_REQQ_LINK = "0"
1445 CONFD_REQQ_IP = "1"
1446 CONFD_REQQ_IPLIST = "2"
1447 CONFD_REQQ_FIELDS = "3"
1448
1449 CONFD_REQFIELD_NAME = "0"
1450 CONFD_REQFIELD_IP = "1"
1451 CONFD_REQFIELD_MNODE_PIP = "2"
1452
1453 CONFD_REQS = frozenset([
1454   CONFD_REQ_PING,
1455   CONFD_REQ_NODE_ROLE_BYNAME,
1456   CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1457   CONFD_REQ_CLUSTER_MASTER,
1458   CONFD_REQ_NODE_PIP_LIST,
1459   CONFD_REQ_MC_PIP_LIST,
1460   CONFD_REQ_INSTANCES_IPS_LIST,
1461   ])
1462
1463 CONFD_REPL_STATUS_OK = 0
1464 CONFD_REPL_STATUS_ERROR = 1
1465 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1466
1467 CONFD_REPL_STATUSES = frozenset([
1468   CONFD_REPL_STATUS_OK,
1469   CONFD_REPL_STATUS_ERROR,
1470   CONFD_REPL_STATUS_NOTIMPLEMENTED,
1471   ])
1472
1473 (CONFD_NODE_ROLE_MASTER,
1474  CONFD_NODE_ROLE_CANDIDATE,
1475  CONFD_NODE_ROLE_OFFLINE,
1476  CONFD_NODE_ROLE_DRAINED,
1477  CONFD_NODE_ROLE_REGULAR,
1478  ) = range(5)
1479
1480 # A few common errors for confd
1481 CONFD_ERROR_UNKNOWN_ENTRY = 1
1482 CONFD_ERROR_INTERNAL = 2
1483 CONFD_ERROR_ARGUMENT = 3
1484
1485 # Each request is "salted" by the current timestamp.
1486 # This constants decides how many seconds of skew to accept.
1487 # TODO: make this a default and allow the value to be more configurable
1488 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1489
1490 # When we haven't reloaded the config for more than this amount of seconds, we
1491 # force a test to see if inotify is betraying us.
1492 CONFD_CONFIG_RELOAD_TIMEOUT = 60
1493
1494 # If we receive more than one update in this amount of seconds, we move to
1495 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
1496 # to serve more requests.
1497 CONFD_CONFIG_RELOAD_RATELIMIT = 2
1498
1499 # Magic number prepended to all confd queries.
1500 # This allows us to distinguish different types of confd protocols and handle
1501 # them. For example by changing this we can move the whole payload to be
1502 # compressed, or move away from json.
1503 CONFD_MAGIC_FOURCC = "plj0"
1504
1505 # By default a confd request is sent to the minimum between this number and all
1506 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
1507 # we should have enough answers to be able to compare more than one.
1508 CONFD_DEFAULT_REQ_COVERAGE = 6
1509
1510 # Timeout in seconds to expire pending query request in the confd client
1511 # library. We don't actually expect any answer more than 10 seconds after we
1512 # sent a request.
1513 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1514
1515 # Maximum UDP datagram size.
1516 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1517 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1518 #   (assuming we can't use jumbo frames)
1519 # We just set this to 60K, which should be enough
1520 MAX_UDP_DATA_SIZE = 61440
1521
1522 # User-id pool minimum/maximum acceptable user-ids.
1523 UIDPOOL_UID_MIN = 0
1524 UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
1525
1526 # Name or path of the pgrep command
1527 PGREP = "pgrep"
1528
1529 # Name of the node group that gets created at cluster init or upgrade
1530 INITIAL_NODE_GROUP_NAME = "default"
1531
1532 # Possible values for NodeGroup.alloc_policy
1533 ALLOC_POLICY_PREFERRED = "preferred"
1534 ALLOC_POLICY_LAST_RESORT = "last_resort"
1535 ALLOC_POLICY_UNALLOCABLE = "unallocable"
1536 VALID_ALLOC_POLICIES = [
1537   ALLOC_POLICY_PREFERRED,
1538   ALLOC_POLICY_LAST_RESORT,
1539   ALLOC_POLICY_UNALLOCABLE,
1540   ]
1541
1542 # Temporary external/shared storage parameters
1543 BLOCKDEV_DRIVER_MANUAL = "manual"
1544
1545 # Whether htools was enabled at compilation time
1546 HTOOLS = _autoconf.HTOOLS
1547 # The hail iallocator
1548 IALLOC_HAIL = "hail"