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