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