utils: Move X509-related code into separate file
[ganeti-local] / lib / constants.py
1 #
2 #
3
4 # Copyright (C) 2006, 2007, 2008, 2009, 2010 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
28 # various versions
29 PROTOCOL_VERSION = 40
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 = _autoconf.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 # user separation
88 DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
89 ADMIN_GROUP = _autoconf.ADMIN_GROUP
90 MASTERD_USER = _autoconf.MASTERD_USER
91 MASTERD_GROUP = _autoconf.MASTERD_GROUP
92 RAPI_USER = _autoconf.RAPI_USER
93 RAPI_GROUP = _autoconf.RAPI_GROUP
94 CONFD_USER = _autoconf.CONFD_USER
95 CONFD_GROUP = _autoconf.CONFD_GROUP
96 NODED_USER = _autoconf.NODED_USER
97
98
99 # Wipe
100 DD_CMD = "dd"
101 WIPE_BLOCK_SIZE = 1024**2
102 MAX_WIPE_CHUNK = 1024 # 1GB
103 MIN_WIPE_CHUNK_PERCENT = 10
104
105
106 # file paths
107 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
108 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
109 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
110 BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
111 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
112 RUN_DIRS_MODE = 0775
113 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
114 SECURE_DIR_MODE = 0700
115 SECURE_FILE_MODE = 0600
116 SOCKET_DIR_MODE = 0750
117 CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
118 CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE
119 IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
120 IMPORT_EXPORT_DIR_MODE = 0755
121 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
122 # daemon is started (this takes care of RUN_DIR being tmpfs)
123 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
124 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
125 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
126 # User-id pool lock directory
127 # The user-ids that are in use have a corresponding lock file in this directory
128 UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
129 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
130 NODED_CERT_FILE = DATA_DIR + "/server.pem"
131 RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
132 CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
133 CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
134 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
135 WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
136 INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
137 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
138 RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
139 QUEUE_DIR = DATA_DIR + "/queue"
140 DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
141 SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
142 ETC_HOSTS = "/etc/hosts"
143 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
144 ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
145 SYSCONFDIR = _autoconf.SYSCONFDIR
146 TOOLSDIR = _autoconf.TOOLSDIR
147 CONF_DIR = SYSCONFDIR + "/ganeti"
148
149 ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
150
151 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
152
153 NODED = "ganeti-noded"
154 CONFD = "ganeti-confd"
155 RAPI = "ganeti-rapi"
156 MASTERD = "ganeti-masterd"
157 # used in the ganeti-nbma project
158 NLD = "ganeti-nld"
159
160 DAEMONS_PORTS = {
161   # daemon-name: ("proto", "default-port")
162   NODED: ("tcp", 1811),
163   CONFD: ("udp", 1814),
164   RAPI: ("tcp", 5080),
165   "ssh": ("tcp", 22),
166   # used in the ganeti-nbma project
167   NLD: ("udp", 1816),
168 }
169 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
170 DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
171 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
172 # used in the ganeti-nbma project
173 DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
174
175 FIRST_DRBD_PORT = 11000
176 LAST_DRBD_PORT = 14999
177 MASTER_SCRIPT = "ganeti-master"
178
179 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
180 DAEMONS_LOGFILES = {
181   # "daemon-name": "logfile"
182   NODED: LOG_DIR + "node-daemon.log",
183   CONFD: LOG_DIR + "conf-daemon.log",
184   RAPI: LOG_DIR + "rapi-daemon.log",
185   MASTERD: LOG_DIR + "master-daemon.log",
186   # used in the ganeti-nbma project
187   NLD: LOG_DIR + "nl-daemon.log",
188   }
189
190 LOG_OS_DIR = LOG_DIR + "os"
191 LOG_WATCHER = LOG_DIR + "watcher.log"
192 LOG_COMMANDS = LOG_DIR + "commands.log"
193 LOG_BURNIN = LOG_DIR + "burnin.log"
194 LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
195
196 DEV_CONSOLE = "/dev/console"
197
198 PROC_MOUNTS = "/proc/mounts"
199
200 # luxi related constants
201 LUXI_EOM = "\3"
202 LUXI_VERSION = CONFIG_VERSION
203
204 # one of 'no', 'yes', 'only'
205 SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
206 SYSLOG_NO = "no"
207 SYSLOG_YES = "yes"
208 SYSLOG_ONLY = "only"
209 SYSLOG_SOCKET = "/dev/log"
210
211 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
212 EXPORT_DIR = _autoconf.EXPORT_DIR
213
214 EXPORT_CONF_FILE = "config.ini"
215
216 XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
217 XEN_KERNEL = _autoconf.XEN_KERNEL
218 XEN_INITRD = _autoconf.XEN_INITRD
219
220 KVM_PATH = _autoconf.KVM_PATH
221 SOCAT_PATH = _autoconf.SOCAT_PATH
222 SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
223 SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
224 SOCAT_ESCAPE_CODE = "0x1d"
225
226 #: Console as SSH command
227 CONS_SSH = "ssh"
228
229 #: Console as VNC server
230 CONS_VNC = "vnc"
231
232 #: Display a message for console access
233 CONS_MESSAGE = "msg"
234
235 #: All console types
236 CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_MESSAGE])
237
238 # For RSA keys more bits are better, but they also make operations more
239 # expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
240 # 2010 on.
241 RSA_KEY_BITS = 2048
242
243 # Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
244 # way to disable ciphers would be to use the exclamation mark (!), but socat
245 # versions below 1.5 can't parse exclamation marks in options properly. When
246 # modifying the ciphers, ensure not to accidentially add something after it's
247 # been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
248 # "openssl ciphers -v HIGH:-DES".
249 OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"
250
251 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
252 X509_CERT_SIGN_DIGEST = "SHA1"
253
254 # Default validity of certificates in days
255 X509_CERT_DEFAULT_VALIDITY = 365 * 5
256
257 # commonName (CN) used in certificates
258 X509_CERT_CN = "ganeti.example.com"
259
260 X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
261
262 IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
263
264 # Import/export daemon mode
265 IEM_IMPORT = "import"
266 IEM_EXPORT = "export"
267
268 # Import/export transport compression
269 IEC_NONE = "none"
270 IEC_GZIP = "gzip"
271 IEC_ALL = frozenset([
272   IEC_NONE,
273   IEC_GZIP,
274   ])
275
276 IE_CUSTOM_SIZE = "fd"
277
278 IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")
279
280 # Import/export I/O
281 # Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
282 IEIO_FILE = "file"
283 # Raw block device I/O using "dd"
284 IEIO_RAW_DISK = "raw"
285 # OS definition import/export script
286 IEIO_SCRIPT = "script"
287
288 VALUE_DEFAULT = "default"
289 VALUE_AUTO = "auto"
290 VALUE_GENERATE = "generate"
291 VALUE_NONE = "none"
292 VALUE_TRUE = "true"
293 VALUE_FALSE = "false"
294
295 # External script validation mask
296 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
297
298 # hooks-related constants
299 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
300 HOOKS_PHASE_PRE = "pre"
301 HOOKS_PHASE_POST = "post"
302 HOOKS_NAME_CFGUPDATE = "config-update"
303 HOOKS_NAME_WATCHER = "watcher"
304 HOOKS_VERSION = 2
305
306 # hooks subject type (what object type does the LU deal with)
307 HTYPE_CLUSTER = "CLUSTER"
308 HTYPE_NODE = "NODE"
309 HTYPE_GROUP = "GROUP"
310 HTYPE_INSTANCE = "INSTANCE"
311
312 HKR_SKIP = 0
313 HKR_FAIL = 1
314 HKR_SUCCESS = 2
315
316 # Storage types
317 ST_FILE = "file"
318 ST_LVM_PV = "lvm-pv"
319 ST_LVM_VG = "lvm-vg"
320
321 # Storage fields
322 # first two are valid in LU context only, not passed to backend
323 SF_NODE = "node"
324 SF_TYPE = "type"
325 # and the rest are valid in backend
326 SF_NAME = "name"
327 SF_SIZE = "size"
328 SF_FREE = "free"
329 SF_USED = "used"
330 SF_ALLOCATABLE = "allocatable"
331
332 # Storage operations
333 SO_FIX_CONSISTENCY = "fix-consistency"
334
335 # Available fields per storage type
336 VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
337                                   SF_USED, SF_FREE, SF_ALLOCATABLE])
338
339 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
340
341 MODIFIABLE_STORAGE_FIELDS = {
342   ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
343   }
344
345 VALID_STORAGE_OPERATIONS = {
346   ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
347   }
348
349 # Local disk status
350 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
351 (LDS_OKAY,
352  LDS_UNKNOWN,
353  LDS_FAULTY) = range(1, 4)
354
355 # disk template types
356 DT_DISKLESS = "diskless"
357 DT_PLAIN = "plain"
358 DT_DRBD8 = "drbd"
359 DT_FILE = "file"
360
361 # the set of network-mirrored disk templates
362 DTS_NET_MIRROR = frozenset([DT_DRBD8])
363
364 # the set of non-lvm-based disk templates
365 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
366
367 # the set of disk templates which can be grown
368 DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
369
370 # the set of disk templates that allow adoption
371 DTS_MAY_ADOPT = frozenset([DT_PLAIN])
372
373 # logical disk types
374 LD_LV = "lvm"
375 LD_DRBD8 = "drbd8"
376 LD_FILE = "file"
377 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
378
379 # drbd constants
380 DRBD_HMAC_ALG = "md5"
381 DRBD_NET_PROTOCOL = "C"
382 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
383
384 # file backend driver
385 FD_LOOP = "loop"
386 FD_BLKTAP = "blktap"
387
388 # the set of drbd-like disk types
389 LDS_DRBD = frozenset([LD_DRBD8])
390
391 # disk access mode
392 DISK_RDONLY = "ro"
393 DISK_RDWR = "rw"
394 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
395
396 # disk replacement mode
397 REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
398 REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
399 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
400 REPLACE_DISK_AUTO = "replace_auto"
401 REPLACE_MODES = frozenset([
402   REPLACE_DISK_PRI,
403   REPLACE_DISK_SEC,
404   REPLACE_DISK_CHG,
405   REPLACE_DISK_AUTO,
406   ])
407
408 # Instance export mode
409 EXPORT_MODE_LOCAL = "local"
410 EXPORT_MODE_REMOTE = "remote"
411 EXPORT_MODES = frozenset([
412   EXPORT_MODE_LOCAL,
413   EXPORT_MODE_REMOTE,
414   ])
415
416 # lock recalculate mode
417 LOCKS_REPLACE = 'replace'
418 LOCKS_APPEND = 'append'
419
420 # instance creation modes
421 INSTANCE_CREATE = "create"
422 INSTANCE_IMPORT = "import"
423 INSTANCE_REMOTE_IMPORT = "remote-import"
424 INSTANCE_CREATE_MODES = frozenset([
425   INSTANCE_CREATE,
426   INSTANCE_IMPORT,
427   INSTANCE_REMOTE_IMPORT,
428   ])
429
430 # Remote import/export handshake message and version
431 RIE_VERSION = 0
432 RIE_HANDSHAKE = "Hi, I'm Ganeti"
433
434 # Remote import/export certificate validity in seconds
435 RIE_CERT_VALIDITY = 24 * 60 * 60
436
437 # Remote import/export connect timeout for socat
438 RIE_CONNECT_TIMEOUT = 60
439 #: Give child process up to 5 seconds to exit after sending a signal
440 CHILD_LINGER_TIMEOUT = 5.0
441
442 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
443                             DT_DRBD8, DT_FILE])
444
445 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
446
447 # import/export config options
448 INISECT_EXP = "export"
449 INISECT_INS = "instance"
450 INISECT_HYP = "hypervisor"
451 INISECT_BEP = "backend"
452 INISECT_OSP = "os"
453
454 # dynamic device modification
455 DDM_ADD = "add"
456 DDM_REMOVE = "remove"
457 DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
458
459 # common exit codes
460 EXIT_SUCCESS = 0
461 EXIT_FAILURE = 1
462 EXIT_NOTCLUSTER = 5
463 EXIT_NOTMASTER = 11
464 EXIT_NODESETUP_ERROR = 12
465 EXIT_CONFIRMATION = 13 # need user confirmation
466
467 #: Exit code for query operations with unknown fields
468 EXIT_UNKNOWN_FIELD = 14
469
470 # tags
471 TAG_CLUSTER = "cluster"
472 TAG_NODE = "node"
473 TAG_INSTANCE = "instance"
474 VALID_TAG_TYPES = frozenset([
475   TAG_CLUSTER,
476   TAG_NODE,
477   TAG_INSTANCE,
478   ])
479 MAX_TAG_LEN = 128
480 MAX_TAGS_PER_OBJ = 4096
481
482 # others
483 DEFAULT_BRIDGE = "xen-br0"
484 SYNC_SPEED = 60 * 1024
485 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
486 IP4_ADDRESS_ANY = "0.0.0.0"
487 IP6_ADDRESS_LOCALHOST = "::1"
488 IP6_ADDRESS_ANY = "::"
489 IP4_VERSION = 4
490 IP6_VERSION = 6
491 TCP_PING_TIMEOUT = 10
492 GANETI_RUNAS = "root"
493 DEFAULT_VG = "xenvg"
494 DEFAULT_DRBD_HELPER = "/bin/true"
495 MIN_VG_SIZE = 20480
496 DEFAULT_MAC_PREFIX = "aa:00:00"
497 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
498 # default maximum instance wait time, in seconds.
499 DEFAULT_SHUTDOWN_TIMEOUT = 120
500 NODE_MAX_CLOCK_SKEW = 150
501 # Time for an intra-cluster disk transfer to wait for a connection
502 DISK_TRANSFER_CONNECT_TIMEOUT = 30
503 # Disk index separator
504 DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
505
506 # runparts results
507 (RUNPARTS_SKIP,
508  RUNPARTS_RUN,
509  RUNPARTS_ERR) = range(3)
510
511 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
512
513 # RPC constants
514 (RPC_ENCODING_NONE,
515  RPC_ENCODING_ZLIB_BASE64) = range(2)
516
517 # os related constants
518 OS_SCRIPT_CREATE = 'create'
519 OS_SCRIPT_IMPORT = 'import'
520 OS_SCRIPT_EXPORT = 'export'
521 OS_SCRIPT_RENAME = 'rename'
522 OS_SCRIPT_VERIFY = 'verify'
523 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
524                         OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME,
525                         OS_SCRIPT_VERIFY])
526
527 OS_API_FILE = 'ganeti_api_version'
528 OS_VARIANTS_FILE = 'variants.list'
529 OS_PARAMETERS_FILE = 'parameters.list'
530
531 OS_VALIDATE_PARAMETERS = 'parameters'
532 OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
533
534 # ssh constants
535 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
536 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
537 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
538 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
539 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
540 SSH = "ssh"
541 SCP = "scp"
542
543 # reboot types
544 INSTANCE_REBOOT_SOFT = "soft"
545 INSTANCE_REBOOT_HARD = "hard"
546 INSTANCE_REBOOT_FULL = "full"
547
548 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
549                           INSTANCE_REBOOT_HARD,
550                           INSTANCE_REBOOT_FULL])
551
552 VTYPE_STRING = 'string'
553 VTYPE_MAYBE_STRING = "maybe-string"
554 VTYPE_BOOL = 'bool'
555 VTYPE_SIZE = 'size' # size, in MiBs
556 VTYPE_INT = 'int'
557 ENFORCEABLE_TYPES = frozenset([
558                       VTYPE_STRING,
559                       VTYPE_MAYBE_STRING,
560                       VTYPE_BOOL,
561                       VTYPE_SIZE,
562                       VTYPE_INT,
563                       ])
564
565 # HV parameter names (global namespace)
566 HV_BOOT_ORDER = "boot_order"
567 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
568 HV_NIC_TYPE = "nic_type"
569 HV_DISK_TYPE = "disk_type"
570 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
571 HV_VNC_PASSWORD_FILE = "vnc_password_file"
572 HV_VNC_TLS = "vnc_tls"
573 HV_VNC_X509 = "vnc_x509_path"
574 HV_VNC_X509_VERIFY = "vnc_x509_verify"
575 HV_ACPI = "acpi"
576 HV_PAE = "pae"
577 HV_USE_BOOTLOADER = "use_bootloader"
578 HV_BOOTLOADER_ARGS = "bootloader_args"
579 HV_BOOTLOADER_PATH = "bootloader_path"
580 HV_KERNEL_ARGS = "kernel_args"
581 HV_KERNEL_PATH = "kernel_path"
582 HV_INITRD_PATH = "initrd_path"
583 HV_ROOT_PATH = "root_path"
584 HV_SERIAL_CONSOLE = "serial_console"
585 HV_USB_MOUSE = "usb_mouse"
586 HV_DEVICE_MODEL = "device_model"
587 HV_INIT_SCRIPT = "init_script"
588 HV_MIGRATION_PORT = "migration_port"
589 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
590 HV_MIGRATION_DOWNTIME = "migration_downtime"
591 HV_MIGRATION_MODE = "migration_mode"
592 HV_USE_LOCALTIME = "use_localtime"
593 HV_DISK_CACHE = "disk_cache"
594 HV_SECURITY_MODEL = "security_model"
595 HV_SECURITY_DOMAIN = "security_domain"
596 HV_KVM_FLAG = "kvm_flag"
597 HV_VHOST_NET = "vhost_net"
598 HV_KVM_USE_CHROOT = "use_chroot"
599 HV_CPU_MASK = "cpu_mask"
600 HV_MEM_PATH = "mem_path"
601 HV_BLOCKDEV_PREFIX = "blockdev_prefix"
602
603 HVS_PARAMETER_TYPES = {
604   HV_BOOT_ORDER: VTYPE_STRING,
605   HV_CDROM_IMAGE_PATH: VTYPE_STRING,
606   HV_NIC_TYPE: VTYPE_STRING,
607   HV_DISK_TYPE: VTYPE_STRING,
608   HV_VNC_PASSWORD_FILE: VTYPE_STRING,
609   HV_VNC_BIND_ADDRESS: VTYPE_STRING,
610   HV_VNC_TLS: VTYPE_BOOL,
611   HV_VNC_X509: VTYPE_STRING,
612   HV_VNC_X509_VERIFY: VTYPE_BOOL,
613   HV_ACPI: VTYPE_BOOL,
614   HV_PAE: VTYPE_BOOL,
615   HV_USE_BOOTLOADER: VTYPE_BOOL,
616   HV_BOOTLOADER_PATH: VTYPE_STRING,
617   HV_BOOTLOADER_ARGS: VTYPE_STRING,
618   HV_KERNEL_PATH: VTYPE_STRING,
619   HV_KERNEL_ARGS: VTYPE_STRING,
620   HV_INITRD_PATH: VTYPE_STRING,
621   HV_ROOT_PATH: VTYPE_STRING,
622   HV_SERIAL_CONSOLE: VTYPE_BOOL,
623   HV_USB_MOUSE: VTYPE_STRING,
624   HV_DEVICE_MODEL: VTYPE_STRING,
625   HV_INIT_SCRIPT: VTYPE_STRING,
626   HV_MIGRATION_PORT: VTYPE_INT,
627   HV_MIGRATION_BANDWIDTH: VTYPE_INT,
628   HV_MIGRATION_DOWNTIME: VTYPE_INT,
629   HV_MIGRATION_MODE: VTYPE_STRING,
630   HV_USE_LOCALTIME: VTYPE_BOOL,
631   HV_DISK_CACHE: VTYPE_STRING,
632   HV_SECURITY_MODEL: VTYPE_STRING,
633   HV_SECURITY_DOMAIN: VTYPE_STRING,
634   HV_KVM_FLAG: VTYPE_STRING,
635   HV_VHOST_NET: VTYPE_BOOL,
636   HV_KVM_USE_CHROOT: VTYPE_BOOL,
637   HV_CPU_MASK: VTYPE_STRING,
638   HV_MEM_PATH: VTYPE_STRING,
639   HV_BLOCKDEV_PREFIX: VTYPE_STRING,
640   }
641
642 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
643
644 # BE parameter names
645 BE_MEMORY = "memory"
646 BE_VCPUS = "vcpus"
647 BE_AUTO_BALANCE = "auto_balance"
648
649 BES_PARAMETER_TYPES = {
650     BE_MEMORY: VTYPE_SIZE,
651     BE_VCPUS: VTYPE_INT,
652     BE_AUTO_BALANCE: VTYPE_BOOL,
653     }
654
655 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
656
657 # Node parameter names
658 ND_OOB_PROGRAM = "oob_program"
659
660 NDS_PARAMETER_TYPES = {
661     ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
662     }
663
664 NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
665
666 # OOB supported commands
667 OOB_POWER_ON = "power-on"
668 OOB_POWER_OFF = "power-off"
669 OOB_POWER_CYCLE = "power-cycle"
670 OOB_POWER_STATUS = "power-status"
671 OOB_HEALTH = "health"
672
673 OOB_COMMANDS = frozenset([OOB_POWER_ON, OOB_POWER_OFF, OOB_POWER_CYCLE,
674                           OOB_POWER_STATUS, OOB_HEALTH])
675
676 OOB_POWER_STATUS_POWERED = "powered"
677
678 OOB_TIMEOUT = 60 # 60 seconds
679
680 OOB_STATUS_OK = "OK"
681 OOB_STATUS_WARNING = "WARNING"
682 OOB_STATUS_CRITICAL = "CRITICAL"
683 OOB_STATUS_UNKNOWN = "UNKNOWN"
684
685 OOB_STATUSES = frozenset([
686   OOB_STATUS_OK,
687   OOB_STATUS_WARNING,
688   OOB_STATUS_CRITICAL,
689   OOB_STATUS_UNKNOWN,
690   ])
691
692 # Instance Parameters Profile
693 PP_DEFAULT = "default"
694
695 NIC_MODE = "mode"
696 NIC_LINK = "link"
697
698 NIC_MODE_BRIDGED = "bridged"
699 NIC_MODE_ROUTED = "routed"
700
701 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
702
703 NICS_PARAMETER_TYPES = {
704     NIC_MODE: VTYPE_STRING,
705     NIC_LINK: VTYPE_STRING,
706     }
707
708 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
709
710 IDISK_SIZE = "size"
711 IDISK_MODE = "mode"
712 IDISK_ADOPT = "adopt"
713 IDISK_VG = "vg"
714 IDISK_PARAMS_TYPES = {
715   IDISK_SIZE: VTYPE_SIZE,
716   IDISK_MODE: VTYPE_STRING,
717   IDISK_ADOPT: VTYPE_STRING,
718   IDISK_VG: VTYPE_STRING,
719   }
720 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
721
722 INIC_MAC = "mac"
723 INIC_IP = "ip"
724 INIC_MODE = "mode"
725 INIC_LINK = "link"
726 INIC_BRIDGE = "bridge"
727 INIC_PARAMS_TYPES = {
728   INIC_BRIDGE: VTYPE_STRING,
729   INIC_IP: VTYPE_MAYBE_STRING,
730   INIC_LINK: VTYPE_STRING,
731   INIC_MAC: VTYPE_STRING,
732   INIC_MODE: VTYPE_STRING,
733   }
734 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
735
736 # Hypervisor constants
737 HT_XEN_PVM = "xen-pvm"
738 HT_FAKE = "fake"
739 HT_XEN_HVM = "xen-hvm"
740 HT_KVM = "kvm"
741 HT_CHROOT = "chroot"
742 HT_LXC = "lxc"
743 HYPER_TYPES = frozenset([
744   HT_XEN_PVM,
745   HT_FAKE,
746   HT_XEN_HVM,
747   HT_KVM,
748   HT_CHROOT,
749   HT_LXC,
750   ])
751 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
752
753 VNC_BASE_PORT = 5900
754 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
755 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
756
757 # NIC types
758 HT_NIC_RTL8139 = "rtl8139"
759 HT_NIC_NE2K_PCI = "ne2k_pci"
760 HT_NIC_NE2K_ISA = "ne2k_isa"
761 HT_NIC_I82551 = "i82551"
762 HT_NIC_I85557B = "i82557b"
763 HT_NIC_I8259ER = "i82559er"
764 HT_NIC_PCNET = "pcnet"
765 HT_NIC_E1000 = "e1000"
766 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
767
768 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
769                                     HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
770 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
771                                     HT_NIC_NE2K_ISA, HT_NIC_I82551,
772                                     HT_NIC_I85557B, HT_NIC_I8259ER,
773                                     HT_NIC_PCNET, HT_NIC_E1000,
774                                     HT_NIC_PARAVIRTUAL])
775 # Disk types
776 HT_DISK_IOEMU = "ioemu"
777 HT_DISK_IDE = "ide"
778 HT_DISK_SCSI = "scsi"
779 HT_DISK_SD = "sd"
780 HT_DISK_MTD = "mtd"
781 HT_DISK_PFLASH = "pflash"
782
783 HT_CACHE_DEFAULT = "default"
784 HT_CACHE_NONE = "none"
785 HT_CACHE_WTHROUGH = "writethrough"
786 HT_CACHE_WBACK = "writeback"
787 HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
788                                   HT_CACHE_NONE,
789                                   HT_CACHE_WTHROUGH,
790                                   HT_CACHE_WBACK])
791
792 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
793 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
794                                      HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
795                                      HT_DISK_PFLASH])
796
797 # Mouse types:
798 HT_MOUSE_MOUSE = "mouse"
799 HT_MOUSE_TABLET = "tablet"
800
801 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
802
803 # Boot order
804 HT_BO_CDROM = "cdrom"
805 HT_BO_DISK = "disk"
806 HT_BO_NETWORK = "network"
807
808 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
809
810 # Security models
811 HT_SM_NONE = "none"
812 HT_SM_USER = "user"
813 HT_SM_POOL = "pool"
814
815 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
816
817 # Kvm flag values
818 HT_KVM_ENABLED = "enabled"
819 HT_KVM_DISABLED = "disabled"
820
821 HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
822
823 # Migration type
824 HT_MIGRATION_LIVE = "live"
825 HT_MIGRATION_NONLIVE = "non-live"
826 HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
827
828 # Cluster Verify steps
829 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
830 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
831
832 # Node verify constants
833 NV_DRBDHELPER = "drbd-helper"
834 NV_DRBDLIST = "drbd-list"
835 NV_FILELIST = "filelist"
836 NV_HVINFO = "hvinfo"
837 NV_HYPERVISOR = "hypervisor"
838 NV_INSTANCELIST = "instancelist"
839 NV_LVLIST = "lvlist"
840 NV_MASTERIP = "master-ip"
841 NV_NODELIST = "nodelist"
842 NV_NODENETTEST = "node-net-test"
843 NV_NODESETUP = "nodesetup"
844 NV_OSLIST = "oslist"
845 NV_PVLIST = "pvlist"
846 NV_TIME = "time"
847 NV_VERSION = "version"
848 NV_VGLIST = "vglist"
849 NV_VMNODES = "vmnodes"
850 NV_OOB_PATHS = "oob-paths"
851
852 # SSL certificate check constants (in days)
853 SSL_CERT_EXPIRATION_WARN = 30
854 SSL_CERT_EXPIRATION_ERROR = 7
855
856 # Allocator framework constants
857 IALLOCATOR_VERSION = 2
858 IALLOCATOR_DIR_IN = "in"
859 IALLOCATOR_DIR_OUT = "out"
860 VALID_IALLOCATOR_DIRECTIONS = frozenset([
861   IALLOCATOR_DIR_IN,
862   IALLOCATOR_DIR_OUT,
863   ])
864 IALLOCATOR_MODE_ALLOC = "allocate"
865 IALLOCATOR_MODE_RELOC = "relocate"
866 IALLOCATOR_MODE_MEVAC = "multi-evacuate"
867 VALID_IALLOCATOR_MODES = frozenset([
868   IALLOCATOR_MODE_ALLOC,
869   IALLOCATOR_MODE_RELOC,
870   IALLOCATOR_MODE_MEVAC,
871   ])
872 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
873
874 # Job queue
875 JOB_QUEUE_VERSION = 1
876 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
877 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
878 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
879 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
880 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
881 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
882 JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
883 JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
884
885 JOB_ID_TEMPLATE = r"\d+"
886
887 # unchanged job return
888 JOB_NOTCHANGED = "nochange"
889
890 # Job status
891 JOB_STATUS_QUEUED = "queued"
892 JOB_STATUS_WAITLOCK = "waiting"
893 JOB_STATUS_CANCELING = "canceling"
894 JOB_STATUS_RUNNING = "running"
895 JOB_STATUS_CANCELED = "canceled"
896 JOB_STATUS_SUCCESS = "success"
897 JOB_STATUS_ERROR = "error"
898 JOBS_FINALIZED = frozenset([
899   JOB_STATUS_CANCELED,
900   JOB_STATUS_SUCCESS,
901   JOB_STATUS_ERROR,
902   ])
903 JOB_STATUS_ALL = frozenset([
904   JOB_STATUS_QUEUED,
905   JOB_STATUS_WAITLOCK,
906   JOB_STATUS_CANCELING,
907   JOB_STATUS_RUNNING,
908   ]) | JOBS_FINALIZED
909
910 # OpCode status
911 # not yet finalized
912 OP_STATUS_QUEUED = "queued"
913 OP_STATUS_WAITLOCK = "waiting"
914 OP_STATUS_CANCELING = "canceling"
915 OP_STATUS_RUNNING = "running"
916 # finalized
917 OP_STATUS_CANCELED = "canceled"
918 OP_STATUS_SUCCESS = "success"
919 OP_STATUS_ERROR = "error"
920 OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
921                            OP_STATUS_SUCCESS,
922                            OP_STATUS_ERROR])
923
924 # OpCode priority
925 OP_PRIO_LOWEST = +19
926 OP_PRIO_HIGHEST = -20
927
928 OP_PRIO_LOW = +10
929 OP_PRIO_NORMAL = 0
930 OP_PRIO_HIGH = -10
931
932 OP_PRIO_SUBMIT_VALID = frozenset([
933   OP_PRIO_LOW,
934   OP_PRIO_NORMAL,
935   OP_PRIO_HIGH,
936   ])
937
938 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
939
940 # Execution log types
941 ELOG_MESSAGE = "message"
942 ELOG_PROGRESS = "progress"
943 ELOG_REMOTE_IMPORT = "remote-import"
944 ELOG_JQUEUE_TEST = "jqueue-test"
945
946 # /etc/hosts modification
947 ETC_HOSTS_ADD = "add"
948 ETC_HOSTS_REMOVE = "remove"
949
950 # Job queue test
951 JQT_MSGPREFIX = "TESTMSG="
952 JQT_EXPANDNAMES = "expandnames"
953 JQT_EXEC = "exec"
954 JQT_LOGMSG = "logmsg"
955 JQT_STARTMSG = "startmsg"
956 JQT_ALL = frozenset([
957   JQT_EXPANDNAMES,
958   JQT_EXEC,
959   JQT_LOGMSG,
960   JQT_STARTMSG,
961   ])
962
963 # Query resources
964 QR_INSTANCE = "instance"
965 QR_NODE = "node"
966 QR_LOCK = "lock"
967 QR_GROUP = "group"
968
969 #: List of resources which can be queried using L{opcodes.OpQuery}
970 QR_OP_QUERY = frozenset([QR_INSTANCE, QR_NODE, QR_GROUP])
971
972 #: List of resources which can be queried using LUXI
973 QR_OP_LUXI = QR_OP_QUERY.union([
974   QR_LOCK,
975   ])
976
977 # Query field types
978 QFT_UNKNOWN = "unknown"
979 QFT_TEXT = "text"
980 QFT_BOOL = "bool"
981 QFT_NUMBER = "number"
982 QFT_UNIT = "unit"
983 QFT_TIMESTAMP = "timestamp"
984 QFT_OTHER = "other"
985
986 #: All query field types
987 QFT_ALL = frozenset([
988   QFT_UNKNOWN,
989   QFT_TEXT,
990   QFT_BOOL,
991   QFT_NUMBER,
992   QFT_UNIT,
993   QFT_TIMESTAMP,
994   QFT_OTHER,
995   ])
996
997 # Query result field status (don't change or reuse values as they're used by
998 # clients)
999 #: Normal field status
1000 QRFS_NORMAL = 0
1001 #: Unknown field
1002 QRFS_UNKNOWN = 1
1003 #: No data (e.g. RPC error), can be used instead of L{QRFS_OFFLINE}
1004 QRFS_NODATA = 2
1005 #: Value unavailable for item
1006 QRFS_UNAVAIL = 3
1007 #: Resource marked offline
1008 QRFS_OFFLINE = 4
1009
1010 QRFS_ALL = frozenset([
1011   QRFS_NORMAL,
1012   QRFS_UNKNOWN,
1013   QRFS_NODATA,
1014   QRFS_UNAVAIL,
1015   QRFS_OFFLINE,
1016   ])
1017
1018 # max dynamic devices
1019 MAX_NICS = 8
1020 MAX_DISKS = 16
1021
1022 # SSCONF keys
1023 SS_CLUSTER_NAME = "cluster_name"
1024 SS_CLUSTER_TAGS = "cluster_tags"
1025 SS_FILE_STORAGE_DIR = "file_storage_dir"
1026 SS_MASTER_CANDIDATES = "master_candidates"
1027 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1028 SS_MASTER_IP = "master_ip"
1029 SS_MASTER_NETDEV = "master_netdev"
1030 SS_MASTER_NODE = "master_node"
1031 SS_NODE_LIST = "node_list"
1032 SS_NODE_PRIMARY_IPS = "node_primary_ips"
1033 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1034 SS_OFFLINE_NODES = "offline_nodes"
1035 SS_ONLINE_NODES = "online_nodes"
1036 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1037 SS_INSTANCE_LIST = "instance_list"
1038 SS_RELEASE_VERSION = "release_version"
1039 SS_HYPERVISOR_LIST = "hypervisor_list"
1040 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1041 SS_UID_POOL = "uid_pool"
1042 SS_NODEGROUPS = "nodegroups"
1043
1044 # cluster wide default parameters
1045 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1046
1047 HVC_DEFAULTS = {
1048   HT_XEN_PVM: {
1049     HV_USE_BOOTLOADER: False,
1050     HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1051     HV_BOOTLOADER_ARGS: '',
1052     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1053     HV_INITRD_PATH: '',
1054     HV_ROOT_PATH: '/dev/sda1',
1055     HV_KERNEL_ARGS: 'ro',
1056     HV_MIGRATION_PORT: 8002,
1057     HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1058     HV_BLOCKDEV_PREFIX: "sd",
1059     },
1060   HT_XEN_HVM: {
1061     HV_BOOT_ORDER: "cd",
1062     HV_CDROM_IMAGE_PATH: '',
1063     HV_NIC_TYPE: HT_NIC_RTL8139,
1064     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1065     HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1066     HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1067     HV_ACPI: True,
1068     HV_PAE: True,
1069     HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1070     HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1071     HV_MIGRATION_PORT: 8002,
1072     HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1073     HV_USE_LOCALTIME: False,
1074     HV_BLOCKDEV_PREFIX: "hd",
1075     },
1076   HT_KVM: {
1077     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1078     HV_INITRD_PATH: '',
1079     HV_KERNEL_ARGS: 'ro',
1080     HV_ROOT_PATH: '/dev/vda1',
1081     HV_ACPI: True,
1082     HV_SERIAL_CONSOLE: True,
1083     HV_VNC_BIND_ADDRESS: '',
1084     HV_VNC_TLS: False,
1085     HV_VNC_X509: '',
1086     HV_VNC_X509_VERIFY: False,
1087     HV_VNC_PASSWORD_FILE: '',
1088     HV_CDROM_IMAGE_PATH: '',
1089     HV_BOOT_ORDER: HT_BO_DISK,
1090     HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1091     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1092     HV_USB_MOUSE: '',
1093     HV_MIGRATION_PORT: 8102,
1094     HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1095     HV_MIGRATION_DOWNTIME: 30,  # ms
1096     HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1097     HV_USE_LOCALTIME: False,
1098     HV_DISK_CACHE: HT_CACHE_DEFAULT,
1099     HV_SECURITY_MODEL: HT_SM_NONE,
1100     HV_SECURITY_DOMAIN: '',
1101     HV_KVM_FLAG: "",
1102     HV_VHOST_NET: False,
1103     HV_KVM_USE_CHROOT: False,
1104     HV_MEM_PATH: "",
1105     },
1106   HT_FAKE: {
1107     },
1108   HT_CHROOT: {
1109     HV_INIT_SCRIPT: "/ganeti-chroot",
1110     },
1111   HT_LXC: {
1112     HV_CPU_MASK: "",
1113     },
1114   }
1115
1116 HVC_GLOBALS = frozenset([
1117   HV_MIGRATION_PORT,
1118   HV_MIGRATION_BANDWIDTH,
1119   HV_MIGRATION_MODE,
1120   ])
1121
1122 BEC_DEFAULTS = {
1123   BE_MEMORY: 128,
1124   BE_VCPUS: 1,
1125   BE_AUTO_BALANCE: True,
1126   }
1127
1128 NDC_DEFAULTS = {
1129   ND_OOB_PROGRAM: None,
1130   }
1131
1132 NICC_DEFAULTS = {
1133   NIC_MODE: NIC_MODE_BRIDGED,
1134   NIC_LINK: DEFAULT_BRIDGE,
1135   }
1136
1137 MASTER_POOL_SIZE_DEFAULT = 10
1138
1139 CONFD_PROTOCOL_VERSION = 1
1140
1141 CONFD_REQ_PING = 0
1142 CONFD_REQ_NODE_ROLE_BYNAME = 1
1143 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1144 CONFD_REQ_CLUSTER_MASTER = 3
1145 CONFD_REQ_NODE_PIP_LIST = 4
1146 CONFD_REQ_MC_PIP_LIST = 5
1147 CONFD_REQ_INSTANCES_IPS_LIST = 6
1148
1149 # Confd request query fields. These are used to narrow down queries.
1150 # These must be strings rather than integers, because json-encoding
1151 # converts them to strings anyway, as they're used as dict-keys.
1152 CONFD_REQQ_LINK = "0"
1153 CONFD_REQQ_IP = "1"
1154 CONFD_REQQ_IPLIST = "2"
1155 CONFD_REQQ_FIELDS = "3"
1156
1157 CONFD_REQFIELD_NAME = "0"
1158 CONFD_REQFIELD_IP = "1"
1159 CONFD_REQFIELD_MNODE_PIP = "2"
1160
1161 CONFD_REQS = frozenset([
1162   CONFD_REQ_PING,
1163   CONFD_REQ_NODE_ROLE_BYNAME,
1164   CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1165   CONFD_REQ_CLUSTER_MASTER,
1166   CONFD_REQ_NODE_PIP_LIST,
1167   CONFD_REQ_MC_PIP_LIST,
1168   CONFD_REQ_INSTANCES_IPS_LIST,
1169   ])
1170
1171 CONFD_REPL_STATUS_OK = 0
1172 CONFD_REPL_STATUS_ERROR = 1
1173 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1174
1175 CONFD_REPL_STATUSES = frozenset([
1176   CONFD_REPL_STATUS_OK,
1177   CONFD_REPL_STATUS_ERROR,
1178   CONFD_REPL_STATUS_NOTIMPLEMENTED,
1179   ])
1180
1181 (CONFD_NODE_ROLE_MASTER,
1182  CONFD_NODE_ROLE_CANDIDATE,
1183  CONFD_NODE_ROLE_OFFLINE,
1184  CONFD_NODE_ROLE_DRAINED,
1185  CONFD_NODE_ROLE_REGULAR,
1186  ) = range(5)
1187
1188 # A few common errors for confd
1189 CONFD_ERROR_UNKNOWN_ENTRY = 1
1190 CONFD_ERROR_INTERNAL = 2
1191 CONFD_ERROR_ARGUMENT = 3
1192
1193 # Each request is "salted" by the current timestamp.
1194 # This constants decides how many seconds of skew to accept.
1195 # TODO: make this a default and allow the value to be more configurable
1196 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1197
1198 # When we haven't reloaded the config for more than this amount of seconds, we
1199 # force a test to see if inotify is betraying us.
1200 CONFD_CONFIG_RELOAD_TIMEOUT = 60
1201
1202 # If we receive more than one update in this amount of seconds, we move to
1203 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
1204 # to serve more requests.
1205 CONFD_CONFIG_RELOAD_RATELIMIT = 2
1206
1207 # Magic number prepended to all confd queries.
1208 # This allows us to distinguish different types of confd protocols and handle
1209 # them. For example by changing this we can move the whole payload to be
1210 # compressed, or move away from json.
1211 CONFD_MAGIC_FOURCC = 'plj0'
1212
1213 # By default a confd request is sent to the minimum between this number and all
1214 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
1215 # we should have enough answers to be able to compare more than one.
1216 CONFD_DEFAULT_REQ_COVERAGE = 6
1217
1218 # Timeout in seconds to expire pending query request in the confd client
1219 # library. We don't actually expect any answer more than 10 seconds after we
1220 # sent a request.
1221 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1222
1223 # Maximum UDP datagram size.
1224 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1225 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1226 #   (assuming we can't use jumbo frames)
1227 # We just set this to 60K, which should be enough
1228 MAX_UDP_DATA_SIZE = 61440
1229
1230 # User-id pool minimum/maximum acceptable user-ids.
1231 UIDPOOL_UID_MIN = 0
1232 UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
1233
1234 # Name or path of the pgrep command
1235 PGREP = "pgrep"
1236
1237 # Name of the node group that gets created at cluster init or upgrade
1238 INITIAL_NODE_GROUP_NAME = "default"
1239
1240 # Possible values for NodeGroup.alloc_policy
1241 ALLOC_POLICY_PREFERRED = "preferred"
1242 ALLOC_POLICY_LAST_RESORT = "last_resort"
1243 ALLOC_POLICY_UNALLOCABLE = "unallocable"
1244 VALID_ALLOC_POLICIES = [
1245   ALLOC_POLICY_PREFERRED,
1246   ALLOC_POLICY_LAST_RESORT,
1247   ALLOC_POLICY_UNALLOCABLE,
1248   ]