4 # Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
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.
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.
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
22 """Module holding different constants."""
26 from ganeti import _autoconf
30 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
34 OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
35 VCS_VERSION = _autoconf.VCS_VERSION
40 # Format for CONFIG_VERSION:
41 # 01 03 0123 = 01030123
43 # | | + Configuration version/revision
47 # It stored as an integer. Make sure not to write an octal number.
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
54 def BuildVersion(major, minor, revision):
55 """Calculates int version number from major, minor and revision numbers.
57 Returns: int representing version number
60 assert isinstance(major, int)
61 assert isinstance(minor, int)
62 assert isinstance(revision, int)
63 return (1000000 * major +
68 def SplitVersion(version):
69 """Splits version number stored in an int.
71 Returns: tuple; (major, minor, revision)
74 assert isinstance(version, int)
76 (major, remainder) = divmod(version, 1000000)
77 (minor, revision) = divmod(remainder, 10000)
79 return (major, minor, revision)
82 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
83 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
85 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
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
101 WIPE_BLOCK_SIZE = 1024**2
102 MAX_WIPE_CHUNK = 1024 # 1GB
103 MIN_WIPE_CHUNK_PERCENT = 10
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"
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"
149 ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
151 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
153 NODED = "ganeti-noded"
154 CONFD = "ganeti-confd"
156 MASTERD = "ganeti-masterd"
157 # used in the ganeti-nbma project
161 # daemon-name: ("proto", "default-port")
162 NODED: ("tcp", 1811),
163 CONFD: ("udp", 1814),
166 # used in the ganeti-nbma project
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]
175 FIRST_DRBD_PORT = 11000
176 LAST_DRBD_PORT = 14999
177 MASTER_SCRIPT = "ganeti-master"
179 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
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",
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"
196 DEV_CONSOLE = "/dev/console"
198 PROC_MOUNTS = "/proc/mounts"
200 # luxi related constants
202 LUXI_VERSION = CONFIG_VERSION
204 # one of 'no', 'yes', 'only'
205 SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
209 SYSLOG_SOCKET = "/dev/log"
211 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
212 EXPORT_DIR = _autoconf.EXPORT_DIR
214 EXPORT_CONF_FILE = "config.ini"
216 XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
217 XEN_KERNEL = _autoconf.XEN_KERNEL
218 XEN_INITRD = _autoconf.XEN_INITRD
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"
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
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"
239 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
240 X509_CERT_SIGN_DIGEST = "SHA1"
242 # Default validity of certificates in days
243 X509_CERT_DEFAULT_VALIDITY = 365 * 5
245 # commonName (CN) used in certificates
246 X509_CERT_CN = "ganeti.example.com"
248 X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
250 IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
252 # Import/export daemon mode
253 IEM_IMPORT = "import"
254 IEM_EXPORT = "export"
256 # Import/export transport compression
259 IEC_ALL = frozenset([
264 IE_CUSTOM_SIZE = "fd"
266 IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")
269 # Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
271 # Raw block device I/O using "dd"
272 IEIO_RAW_DISK = "raw"
273 # OS definition import/export script
274 IEIO_SCRIPT = "script"
276 VALUE_DEFAULT = "default"
278 VALUE_GENERATE = "generate"
281 VALUE_FALSE = "false"
283 # External script validation mask
284 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
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"
294 # hooks subject type (what object type does the LU deal with)
295 HTYPE_CLUSTER = "CLUSTER"
297 HTYPE_GROUP = "GROUP"
298 HTYPE_INSTANCE = "INSTANCE"
310 # first two are valid in LU context only, not passed to backend
313 # and the rest are valid in backend
318 SF_ALLOCATABLE = "allocatable"
321 SO_FIX_CONSISTENCY = "fix-consistency"
323 # Available fields per storage type
324 VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
325 SF_USED, SF_FREE, SF_ALLOCATABLE])
327 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
329 MODIFIABLE_STORAGE_FIELDS = {
330 ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
333 VALID_STORAGE_OPERATIONS = {
334 ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
338 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
341 LDS_FAULTY) = range(1, 4)
343 # disk template types
344 DT_DISKLESS = "diskless"
349 # the set of network-mirrored disk templates
350 DTS_NET_MIRROR = frozenset([DT_DRBD8])
352 # the set of non-lvm-based disk templates
353 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
355 # the set of disk templates which can be grown
356 DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
358 # the set of disk templates that allow adoption
359 DTS_MAY_ADOPT = frozenset([DT_PLAIN])
365 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
368 DRBD_HMAC_ALG = "md5"
369 DRBD_NET_PROTOCOL = "C"
370 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
372 # file backend driver
376 # the set of drbd-like disk types
377 LDS_DRBD = frozenset([LD_DRBD8])
382 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
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([
396 # Instance export mode
397 EXPORT_MODE_LOCAL = "local"
398 EXPORT_MODE_REMOTE = "remote"
399 EXPORT_MODES = frozenset([
404 # lock recalculate mode
405 LOCKS_REPLACE = 'replace'
406 LOCKS_APPEND = 'append'
408 # instance creation modes
409 INSTANCE_CREATE = "create"
410 INSTANCE_IMPORT = "import"
411 INSTANCE_REMOTE_IMPORT = "remote-import"
412 INSTANCE_CREATE_MODES = frozenset([
415 INSTANCE_REMOTE_IMPORT,
418 # Remote import/export handshake message and version
420 RIE_HANDSHAKE = "Hi, I'm Ganeti"
422 # Remote import/export certificate validity in seconds
423 RIE_CERT_VALIDITY = 24 * 60 * 60
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
430 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
433 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
435 # import/export config options
436 INISECT_EXP = "export"
437 INISECT_INS = "instance"
438 INISECT_HYP = "hypervisor"
439 INISECT_BEP = "backend"
442 # dynamic device modification
444 DDM_REMOVE = "remove"
445 DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
452 EXIT_NODESETUP_ERROR = 12
453 EXIT_CONFIRMATION = 13 # need user confirmation
455 #: Exit code for query operations with unknown fields
456 EXIT_UNKNOWN_FIELD = 14
459 TAG_CLUSTER = "cluster"
461 TAG_INSTANCE = "instance"
462 VALID_TAG_TYPES = frozenset([
468 MAX_TAGS_PER_OBJ = 4096
471 DEFAULT_BRIDGE = "xen-br0"
472 SYNC_SPEED = 60 * 1024
473 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
474 IP4_ADDRESS_ANY = "0.0.0.0"
475 IP6_ADDRESS_LOCALHOST = "::1"
476 IP6_ADDRESS_ANY = "::"
479 TCP_PING_TIMEOUT = 10
480 GANETI_RUNAS = "root"
482 DEFAULT_DRBD_HELPER = "/bin/true"
484 DEFAULT_MAC_PREFIX = "aa:00:00"
485 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
486 # default maximum instance wait time, in seconds.
487 DEFAULT_SHUTDOWN_TIMEOUT = 120
488 NODE_MAX_CLOCK_SKEW = 150
489 # Time for an intra-cluster disk transfer to wait for a connection
490 DISK_TRANSFER_CONNECT_TIMEOUT = 30
495 RUNPARTS_ERR) = range(3)
497 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
501 RPC_ENCODING_ZLIB_BASE64) = range(2)
503 # os related constants
504 OS_SCRIPT_CREATE = 'create'
505 OS_SCRIPT_IMPORT = 'import'
506 OS_SCRIPT_EXPORT = 'export'
507 OS_SCRIPT_RENAME = 'rename'
508 OS_SCRIPT_VERIFY = 'verify'
509 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
510 OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME,
513 OS_API_FILE = 'ganeti_api_version'
514 OS_VARIANTS_FILE = 'variants.list'
515 OS_PARAMETERS_FILE = 'parameters.list'
517 OS_VALIDATE_PARAMETERS = 'parameters'
518 OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
521 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
522 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
523 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
524 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
525 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
530 INSTANCE_REBOOT_SOFT = "soft"
531 INSTANCE_REBOOT_HARD = "hard"
532 INSTANCE_REBOOT_FULL = "full"
534 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
535 INSTANCE_REBOOT_HARD,
536 INSTANCE_REBOOT_FULL])
538 VTYPE_STRING = 'string'
539 VTYPE_MAYBE_STRING = "maybe-string"
541 VTYPE_SIZE = 'size' # size, in MiBs
543 ENFORCEABLE_TYPES = frozenset([
551 # HV parameter names (global namespace)
552 HV_BOOT_ORDER = "boot_order"
553 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
554 HV_NIC_TYPE = "nic_type"
555 HV_DISK_TYPE = "disk_type"
556 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
557 HV_VNC_PASSWORD_FILE = "vnc_password_file"
558 HV_VNC_TLS = "vnc_tls"
559 HV_VNC_X509 = "vnc_x509_path"
560 HV_VNC_X509_VERIFY = "vnc_x509_verify"
563 HV_USE_BOOTLOADER = "use_bootloader"
564 HV_BOOTLOADER_ARGS = "bootloader_args"
565 HV_BOOTLOADER_PATH = "bootloader_path"
566 HV_KERNEL_ARGS = "kernel_args"
567 HV_KERNEL_PATH = "kernel_path"
568 HV_INITRD_PATH = "initrd_path"
569 HV_ROOT_PATH = "root_path"
570 HV_SERIAL_CONSOLE = "serial_console"
571 HV_USB_MOUSE = "usb_mouse"
572 HV_DEVICE_MODEL = "device_model"
573 HV_INIT_SCRIPT = "init_script"
574 HV_MIGRATION_PORT = "migration_port"
575 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
576 HV_MIGRATION_DOWNTIME = "migration_downtime"
577 HV_MIGRATION_MODE = "migration_mode"
578 HV_USE_LOCALTIME = "use_localtime"
579 HV_DISK_CACHE = "disk_cache"
580 HV_SECURITY_MODEL = "security_model"
581 HV_SECURITY_DOMAIN = "security_domain"
582 HV_KVM_FLAG = "kvm_flag"
583 HV_VHOST_NET = "vhost_net"
584 HV_KVM_USE_CHROOT = "use_chroot"
585 HV_CPU_MASK = "cpu_mask"
586 HV_MEM_PATH = "mem_path"
587 HV_BLOCKDEV_PREFIX = "blockdev_prefix"
589 HVS_PARAMETER_TYPES = {
590 HV_BOOT_ORDER: VTYPE_STRING,
591 HV_CDROM_IMAGE_PATH: VTYPE_STRING,
592 HV_NIC_TYPE: VTYPE_STRING,
593 HV_DISK_TYPE: VTYPE_STRING,
594 HV_VNC_PASSWORD_FILE: VTYPE_STRING,
595 HV_VNC_BIND_ADDRESS: VTYPE_STRING,
596 HV_VNC_TLS: VTYPE_BOOL,
597 HV_VNC_X509: VTYPE_STRING,
598 HV_VNC_X509_VERIFY: VTYPE_BOOL,
601 HV_USE_BOOTLOADER: VTYPE_BOOL,
602 HV_BOOTLOADER_PATH: VTYPE_STRING,
603 HV_BOOTLOADER_ARGS: VTYPE_STRING,
604 HV_KERNEL_PATH: VTYPE_STRING,
605 HV_KERNEL_ARGS: VTYPE_STRING,
606 HV_INITRD_PATH: VTYPE_STRING,
607 HV_ROOT_PATH: VTYPE_STRING,
608 HV_SERIAL_CONSOLE: VTYPE_BOOL,
609 HV_USB_MOUSE: VTYPE_STRING,
610 HV_DEVICE_MODEL: VTYPE_STRING,
611 HV_INIT_SCRIPT: VTYPE_STRING,
612 HV_MIGRATION_PORT: VTYPE_INT,
613 HV_MIGRATION_BANDWIDTH: VTYPE_INT,
614 HV_MIGRATION_DOWNTIME: VTYPE_INT,
615 HV_MIGRATION_MODE: VTYPE_STRING,
616 HV_USE_LOCALTIME: VTYPE_BOOL,
617 HV_DISK_CACHE: VTYPE_STRING,
618 HV_SECURITY_MODEL: VTYPE_STRING,
619 HV_SECURITY_DOMAIN: VTYPE_STRING,
620 HV_KVM_FLAG: VTYPE_STRING,
621 HV_VHOST_NET: VTYPE_BOOL,
622 HV_KVM_USE_CHROOT: VTYPE_BOOL,
623 HV_CPU_MASK: VTYPE_STRING,
624 HV_MEM_PATH: VTYPE_STRING,
625 HV_BLOCKDEV_PREFIX: VTYPE_STRING,
628 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
633 BE_AUTO_BALANCE = "auto_balance"
635 BES_PARAMETER_TYPES = {
636 BE_MEMORY: VTYPE_SIZE,
638 BE_AUTO_BALANCE: VTYPE_BOOL,
641 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
643 # Node parameter names
644 ND_OOB_PROGRAM = "oob_program"
646 NDS_PARAMETER_TYPES = {
647 ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
650 NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
652 # OOB supported commands
653 OOB_POWER_ON = "power-on"
654 OOB_POWER_OFF = "power-off"
655 OOB_POWER_CYCLE = "power-cycle"
656 OOB_POWER_STATUS = "power-status"
657 OOB_HEALTH = "health"
659 OOB_COMMANDS = frozenset([OOB_POWER_ON, OOB_POWER_OFF, OOB_POWER_CYCLE,
660 OOB_POWER_STATUS, OOB_HEALTH])
662 OOB_POWER_STATUS_POWERED = "powered"
664 OOB_TIMEOUT = 60 # 60 seconds
667 OOB_STATUS_WARNING = "WARNING"
668 OOB_STATUS_CRITICAL = "CRITICAL"
669 OOB_STATUS_UNKNOWN = "UNKNOWN"
671 OOB_STATUSES = frozenset([
678 # Instance Parameters Profile
679 PP_DEFAULT = "default"
684 NIC_MODE_BRIDGED = "bridged"
685 NIC_MODE_ROUTED = "routed"
687 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
689 NICS_PARAMETER_TYPES = {
690 NIC_MODE: VTYPE_STRING,
691 NIC_LINK: VTYPE_STRING,
694 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
698 IDISK_ADOPT = "adopt"
700 IDISK_PARAMS_TYPES = {
701 IDISK_SIZE: VTYPE_SIZE,
702 IDISK_MODE: VTYPE_STRING,
703 IDISK_ADOPT: VTYPE_STRING,
704 IDISK_VG: VTYPE_STRING,
706 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
712 INIC_BRIDGE = "bridge"
713 INIC_PARAMS_TYPES = {
714 INIC_BRIDGE: VTYPE_STRING,
715 INIC_IP: VTYPE_MAYBE_STRING,
716 INIC_LINK: VTYPE_STRING,
717 INIC_MAC: VTYPE_STRING,
718 INIC_MODE: VTYPE_STRING,
720 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
722 # Hypervisor constants
723 HT_XEN_PVM = "xen-pvm"
725 HT_XEN_HVM = "xen-hvm"
729 HYPER_TYPES = frozenset([
737 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
740 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
741 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
744 HT_NIC_RTL8139 = "rtl8139"
745 HT_NIC_NE2K_PCI = "ne2k_pci"
746 HT_NIC_NE2K_ISA = "ne2k_isa"
747 HT_NIC_I82551 = "i82551"
748 HT_NIC_I85557B = "i82557b"
749 HT_NIC_I8259ER = "i82559er"
750 HT_NIC_PCNET = "pcnet"
751 HT_NIC_E1000 = "e1000"
752 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
754 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
755 HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
756 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
757 HT_NIC_NE2K_ISA, HT_NIC_I82551,
758 HT_NIC_I85557B, HT_NIC_I8259ER,
759 HT_NIC_PCNET, HT_NIC_E1000,
762 HT_DISK_IOEMU = "ioemu"
764 HT_DISK_SCSI = "scsi"
767 HT_DISK_PFLASH = "pflash"
769 HT_CACHE_DEFAULT = "default"
770 HT_CACHE_NONE = "none"
771 HT_CACHE_WTHROUGH = "writethrough"
772 HT_CACHE_WBACK = "writeback"
773 HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
778 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
779 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
780 HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
784 HT_MOUSE_MOUSE = "mouse"
785 HT_MOUSE_TABLET = "tablet"
787 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
790 HT_BO_CDROM = "cdrom"
792 HT_BO_NETWORK = "network"
794 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
801 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
804 HT_KVM_ENABLED = "enabled"
805 HT_KVM_DISABLED = "disabled"
807 HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
810 HT_MIGRATION_LIVE = "live"
811 HT_MIGRATION_NONLIVE = "non-live"
812 HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
814 # Cluster Verify steps
815 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
816 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
818 # Node verify constants
819 NV_DRBDHELPER = "drbd-helper"
820 NV_DRBDLIST = "drbd-list"
821 NV_FILELIST = "filelist"
823 NV_HYPERVISOR = "hypervisor"
824 NV_INSTANCELIST = "instancelist"
826 NV_MASTERIP = "master-ip"
827 NV_NODELIST = "nodelist"
828 NV_NODENETTEST = "node-net-test"
829 NV_NODESETUP = "nodesetup"
833 NV_VERSION = "version"
835 NV_VMNODES = "vmnodes"
837 # SSL certificate check constants (in days)
838 SSL_CERT_EXPIRATION_WARN = 30
839 SSL_CERT_EXPIRATION_ERROR = 7
841 # Allocator framework constants
842 IALLOCATOR_VERSION = 2
843 IALLOCATOR_DIR_IN = "in"
844 IALLOCATOR_DIR_OUT = "out"
845 VALID_IALLOCATOR_DIRECTIONS = frozenset([
849 IALLOCATOR_MODE_ALLOC = "allocate"
850 IALLOCATOR_MODE_RELOC = "relocate"
851 IALLOCATOR_MODE_MEVAC = "multi-evacuate"
852 VALID_IALLOCATOR_MODES = frozenset([
853 IALLOCATOR_MODE_ALLOC,
854 IALLOCATOR_MODE_RELOC,
855 IALLOCATOR_MODE_MEVAC,
857 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
860 JOB_QUEUE_VERSION = 1
861 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
862 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
863 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
864 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
865 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
866 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
867 JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
868 JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
870 JOB_ID_TEMPLATE = r"\d+"
872 # unchanged job return
873 JOB_NOTCHANGED = "nochange"
876 JOB_STATUS_QUEUED = "queued"
877 JOB_STATUS_WAITLOCK = "waiting"
878 JOB_STATUS_CANCELING = "canceling"
879 JOB_STATUS_RUNNING = "running"
880 JOB_STATUS_CANCELED = "canceled"
881 JOB_STATUS_SUCCESS = "success"
882 JOB_STATUS_ERROR = "error"
883 JOBS_FINALIZED = frozenset([
888 JOB_STATUS_ALL = frozenset([
891 JOB_STATUS_CANCELING,
897 OP_STATUS_QUEUED = "queued"
898 OP_STATUS_WAITLOCK = "waiting"
899 OP_STATUS_CANCELING = "canceling"
900 OP_STATUS_RUNNING = "running"
902 OP_STATUS_CANCELED = "canceled"
903 OP_STATUS_SUCCESS = "success"
904 OP_STATUS_ERROR = "error"
905 OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
911 OP_PRIO_HIGHEST = -20
917 OP_PRIO_SUBMIT_VALID = frozenset([
923 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
925 # Execution log types
926 ELOG_MESSAGE = "message"
927 ELOG_PROGRESS = "progress"
928 ELOG_REMOTE_IMPORT = "remote-import"
929 ELOG_JQUEUE_TEST = "jqueue-test"
931 # /etc/hosts modification
932 ETC_HOSTS_ADD = "add"
933 ETC_HOSTS_REMOVE = "remove"
936 JQT_MSGPREFIX = "TESTMSG="
937 JQT_EXPANDNAMES = "expandnames"
939 JQT_LOGMSG = "logmsg"
940 JQT_STARTMSG = "startmsg"
941 JQT_ALL = frozenset([
949 QR_INSTANCE = "instance"
952 #: List of resources which can be queried using L{opcodes.OpQuery}
953 QR_OP_QUERY = frozenset([QR_INSTANCE, QR_NODE])
955 #: List of resources which can be queried using LUXI
956 QR_OP_LUXI = QR_OP_QUERY.union([
960 QFT_UNKNOWN = "unknown"
963 QFT_NUMBER = "number"
965 QFT_TIMESTAMP = "timestamp"
968 #: All query field types
969 QFT_ALL = frozenset([
979 # Query result field status (don't change values as they're used by clients)
980 #: Normal field status
984 #: No data (e.g. node offline)
986 #: Value unavailable for item
989 QRFS_ALL = frozenset([
996 # max dynamic devices
1001 SS_CLUSTER_NAME = "cluster_name"
1002 SS_CLUSTER_TAGS = "cluster_tags"
1003 SS_FILE_STORAGE_DIR = "file_storage_dir"
1004 SS_MASTER_CANDIDATES = "master_candidates"
1005 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1006 SS_MASTER_IP = "master_ip"
1007 SS_MASTER_NETDEV = "master_netdev"
1008 SS_MASTER_NODE = "master_node"
1009 SS_NODE_LIST = "node_list"
1010 SS_NODE_PRIMARY_IPS = "node_primary_ips"
1011 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1012 SS_OFFLINE_NODES = "offline_nodes"
1013 SS_ONLINE_NODES = "online_nodes"
1014 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1015 SS_INSTANCE_LIST = "instance_list"
1016 SS_RELEASE_VERSION = "release_version"
1017 SS_HYPERVISOR_LIST = "hypervisor_list"
1018 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1019 SS_UID_POOL = "uid_pool"
1020 SS_NODEGROUPS = "nodegroups"
1022 # cluster wide default parameters
1023 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1027 HV_USE_BOOTLOADER: False,
1028 HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1029 HV_BOOTLOADER_ARGS: '',
1030 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1032 HV_ROOT_PATH: '/dev/sda1',
1033 HV_KERNEL_ARGS: 'ro',
1034 HV_MIGRATION_PORT: 8002,
1035 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1036 HV_BLOCKDEV_PREFIX: "sd",
1039 HV_BOOT_ORDER: "cd",
1040 HV_CDROM_IMAGE_PATH: '',
1041 HV_NIC_TYPE: HT_NIC_RTL8139,
1042 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1043 HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1044 HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1047 HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1048 HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1049 HV_MIGRATION_PORT: 8002,
1050 HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1051 HV_USE_LOCALTIME: False,
1052 HV_BLOCKDEV_PREFIX: "hd",
1055 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1057 HV_KERNEL_ARGS: 'ro',
1058 HV_ROOT_PATH: '/dev/vda1',
1060 HV_SERIAL_CONSOLE: True,
1061 HV_VNC_BIND_ADDRESS: '',
1064 HV_VNC_X509_VERIFY: False,
1065 HV_VNC_PASSWORD_FILE: '',
1066 HV_CDROM_IMAGE_PATH: '',
1067 HV_BOOT_ORDER: HT_BO_DISK,
1068 HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1069 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1071 HV_MIGRATION_PORT: 8102,
1072 HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1073 HV_MIGRATION_DOWNTIME: 30, # ms
1074 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1075 HV_USE_LOCALTIME: False,
1076 HV_DISK_CACHE: HT_CACHE_DEFAULT,
1077 HV_SECURITY_MODEL: HT_SM_NONE,
1078 HV_SECURITY_DOMAIN: '',
1080 HV_VHOST_NET: False,
1081 HV_KVM_USE_CHROOT: False,
1087 HV_INIT_SCRIPT: "/ganeti-chroot",
1094 HVC_GLOBALS = frozenset([
1096 HV_MIGRATION_BANDWIDTH,
1103 BE_AUTO_BALANCE: True,
1107 ND_OOB_PROGRAM: None,
1111 NIC_MODE: NIC_MODE_BRIDGED,
1112 NIC_LINK: DEFAULT_BRIDGE,
1115 MASTER_POOL_SIZE_DEFAULT = 10
1117 CONFD_PROTOCOL_VERSION = 1
1120 CONFD_REQ_NODE_ROLE_BYNAME = 1
1121 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1122 CONFD_REQ_CLUSTER_MASTER = 3
1123 CONFD_REQ_NODE_PIP_LIST = 4
1124 CONFD_REQ_MC_PIP_LIST = 5
1125 CONFD_REQ_INSTANCES_IPS_LIST = 6
1127 # Confd request query fields. These are used to narrow down queries.
1128 # These must be strings rather than integers, because json-encoding
1129 # converts them to strings anyway, as they're used as dict-keys.
1130 CONFD_REQQ_LINK = "0"
1132 CONFD_REQQ_IPLIST = "2"
1133 CONFD_REQQ_FIELDS = "3"
1135 CONFD_REQFIELD_NAME = "0"
1136 CONFD_REQFIELD_IP = "1"
1137 CONFD_REQFIELD_MNODE_PIP = "2"
1139 CONFD_REQS = frozenset([
1141 CONFD_REQ_NODE_ROLE_BYNAME,
1142 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1143 CONFD_REQ_CLUSTER_MASTER,
1144 CONFD_REQ_NODE_PIP_LIST,
1145 CONFD_REQ_MC_PIP_LIST,
1146 CONFD_REQ_INSTANCES_IPS_LIST,
1149 CONFD_REPL_STATUS_OK = 0
1150 CONFD_REPL_STATUS_ERROR = 1
1151 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1153 CONFD_REPL_STATUSES = frozenset([
1154 CONFD_REPL_STATUS_OK,
1155 CONFD_REPL_STATUS_ERROR,
1156 CONFD_REPL_STATUS_NOTIMPLEMENTED,
1159 (CONFD_NODE_ROLE_MASTER,
1160 CONFD_NODE_ROLE_CANDIDATE,
1161 CONFD_NODE_ROLE_OFFLINE,
1162 CONFD_NODE_ROLE_DRAINED,
1163 CONFD_NODE_ROLE_REGULAR,
1166 # A few common errors for confd
1167 CONFD_ERROR_UNKNOWN_ENTRY = 1
1168 CONFD_ERROR_INTERNAL = 2
1169 CONFD_ERROR_ARGUMENT = 3
1171 # Each request is "salted" by the current timestamp.
1172 # This constants decides how many seconds of skew to accept.
1173 # TODO: make this a default and allow the value to be more configurable
1174 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1176 # When we haven't reloaded the config for more than this amount of seconds, we
1177 # force a test to see if inotify is betraying us.
1178 CONFD_CONFIG_RELOAD_TIMEOUT = 60
1180 # If we receive more than one update in this amount of seconds, we move to
1181 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
1182 # to serve more requests.
1183 CONFD_CONFIG_RELOAD_RATELIMIT = 2
1185 # Magic number prepended to all confd queries.
1186 # This allows us to distinguish different types of confd protocols and handle
1187 # them. For example by changing this we can move the whole payload to be
1188 # compressed, or move away from json.
1189 CONFD_MAGIC_FOURCC = 'plj0'
1191 # By default a confd request is sent to the minimum between this number and all
1192 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
1193 # we should have enough answers to be able to compare more than one.
1194 CONFD_DEFAULT_REQ_COVERAGE = 6
1196 # Timeout in seconds to expire pending query request in the confd client
1197 # library. We don't actually expect any answer more than 10 seconds after we
1199 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1201 # Maximum UDP datagram size.
1202 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1203 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1204 # (assuming we can't use jumbo frames)
1205 # We just set this to 60K, which should be enough
1206 MAX_UDP_DATA_SIZE = 61440
1208 # User-id pool minimum/maximum acceptable user-ids.
1210 UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
1212 # Name or path of the pgrep command
1215 # Name of the node group that gets created at cluster init or upgrade
1216 INITIAL_NODE_GROUP_NAME = "default"
1218 # Possible values for NodeGroup.alloc_policy
1219 ALLOC_POLICY_PREFERRED = "preferred"
1220 ALLOC_POLICY_LAST_RESORT = "last_resort"
1221 ALLOC_POLICY_UNALLOCABLE = "unallocable"
1222 VALID_ALLOC_POLICIES = [
1223 ALLOC_POLICY_PREFERRED,
1224 ALLOC_POLICY_LAST_RESORT,
1225 ALLOC_POLICY_UNALLOCABLE,