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