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