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_ESCAPE_CODE = "0x1d"
225 # For RSA keys more bits are better, but they also make operations more
226 # expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
230 # Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
231 # way to disable ciphers would be to use the exclamation mark (!), but socat
232 # versions below 1.5 can't parse exclamation marks in options properly. When
233 # modifying the ciphers, ensure to not accidentially add something after it's
234 # been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
235 # "openssl ciphers -v HIGH:-DES".
236 OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"
238 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
239 X509_CERT_SIGN_DIGEST = "SHA1"
241 # Default validity of certificates in days
242 X509_CERT_DEFAULT_VALIDITY = 365 * 5
244 # commonName (CN) used in certificates
245 X509_CERT_CN = "ganeti.example.com"
247 X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
249 IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
251 # Import/export daemon mode
252 IEM_IMPORT = "import"
253 IEM_EXPORT = "export"
255 # Import/export transport compression
258 IEC_ALL = frozenset([
263 IE_CUSTOM_SIZE = "fd"
265 IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")
268 # Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
270 # Raw block device I/O using "dd"
271 IEIO_RAW_DISK = "raw"
272 # OS definition import/export script
273 IEIO_SCRIPT = "script"
275 VALUE_DEFAULT = "default"
277 VALUE_GENERATE = "generate"
280 VALUE_FALSE = "false"
282 # External script validation mask
283 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
285 # hooks-related constants
286 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
287 HOOKS_PHASE_PRE = "pre"
288 HOOKS_PHASE_POST = "post"
289 HOOKS_NAME_CFGUPDATE = "config-update"
290 HOOKS_NAME_WATCHER = "watcher"
293 # hooks subject type (what object type does the LU deal with)
294 HTYPE_CLUSTER = "CLUSTER"
296 HTYPE_INSTANCE = "INSTANCE"
308 # first two are valid in LU context only, not passed to backend
311 # and the rest are valid in backend
316 SF_ALLOCATABLE = "allocatable"
319 SO_FIX_CONSISTENCY = "fix-consistency"
321 # Available fields per storage type
322 VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
323 SF_USED, SF_FREE, SF_ALLOCATABLE])
325 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
327 MODIFIABLE_STORAGE_FIELDS = {
328 ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
331 VALID_STORAGE_OPERATIONS = {
332 ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
336 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
339 LDS_FAULTY) = range(1, 4)
341 # disk template types
342 DT_DISKLESS = "diskless"
347 # the set of network-mirrored disk templates
348 DTS_NET_MIRROR = frozenset([DT_DRBD8])
350 # the set of non-lvm-based disk templates
351 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
353 # the set of disk templates which can be grown
354 DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
356 # the set of disk templates that allow adoption
357 DTS_MAY_ADOPT = frozenset([DT_PLAIN])
363 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
366 DRBD_HMAC_ALG = "md5"
367 DRBD_NET_PROTOCOL = "C"
368 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
370 # file backend driver
374 # the set of drbd-like disk types
375 LDS_DRBD = frozenset([LD_DRBD8])
380 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
382 # disk replacement mode
383 REPLACE_DISK_PRI = "replace_on_primary" # replace disks on primary
384 REPLACE_DISK_SEC = "replace_on_secondary" # replace disks on secondary
385 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
386 REPLACE_DISK_AUTO = "replace_auto"
387 REPLACE_MODES = frozenset([
394 # Instance export mode
395 EXPORT_MODE_LOCAL = "local"
396 EXPORT_MODE_REMOTE = "remote"
397 EXPORT_MODES = frozenset([
402 # lock recalculate mode
403 LOCKS_REPLACE = 'replace'
404 LOCKS_APPEND = 'append'
406 # instance creation modes
407 INSTANCE_CREATE = "create"
408 INSTANCE_IMPORT = "import"
409 INSTANCE_REMOTE_IMPORT = "remote-import"
410 INSTANCE_CREATE_MODES = frozenset([
413 INSTANCE_REMOTE_IMPORT,
416 # Remote import/export handshake message and version
418 RIE_HANDSHAKE = "Hi, I'm Ganeti"
420 # Remote import/export certificate validity in seconds
421 RIE_CERT_VALIDITY = 24 * 60 * 60
423 # Remote import/export connect timeout for socat
424 RIE_CONNECT_TIMEOUT = 60
426 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
429 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
431 # import/export config options
432 INISECT_EXP = "export"
433 INISECT_INS = "instance"
434 INISECT_HYP = "hypervisor"
435 INISECT_BEP = "backend"
438 # dynamic device modification
440 DDM_REMOVE = "remove"
441 DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
448 EXIT_NODESETUP_ERROR = 12
449 EXIT_CONFIRMATION = 13 # need user confirmation
452 TAG_CLUSTER = "cluster"
454 TAG_INSTANCE = "instance"
455 VALID_TAG_TYPES = frozenset([
461 MAX_TAGS_PER_OBJ = 4096
464 DEFAULT_BRIDGE = "xen-br0"
465 SYNC_SPEED = 60 * 1024
466 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
467 IP4_ADDRESS_ANY = "0.0.0.0"
468 IP6_ADDRESS_LOCALHOST = "::1"
469 IP6_ADDRESS_ANY = "::"
472 TCP_PING_TIMEOUT = 10
473 GANETI_RUNAS = "root"
475 DEFAULT_DRBD_HELPER = "/bin/true"
477 DEFAULT_MAC_PREFIX = "aa:00:00"
478 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
479 # default maximum instance wait time, in seconds.
480 DEFAULT_SHUTDOWN_TIMEOUT = 120
481 NODE_MAX_CLOCK_SKEW = 150
482 # Time for an intra-cluster disk transfer to wait for a connection
483 DISK_TRANSFER_CONNECT_TIMEOUT = 30
488 RUNPARTS_ERR) = range(3)
490 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
494 RPC_ENCODING_ZLIB_BASE64) = range(2)
496 # os related constants
497 OS_SCRIPT_CREATE = 'create'
498 OS_SCRIPT_IMPORT = 'import'
499 OS_SCRIPT_EXPORT = 'export'
500 OS_SCRIPT_RENAME = 'rename'
501 OS_SCRIPT_VERIFY = 'verify'
502 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
503 OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME,
506 OS_API_FILE = 'ganeti_api_version'
507 OS_VARIANTS_FILE = 'variants.list'
508 OS_PARAMETERS_FILE = 'parameters.list'
510 OS_VALIDATE_PARAMETERS = 'parameters'
511 OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
514 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
515 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
516 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
517 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
518 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
523 INSTANCE_REBOOT_SOFT = "soft"
524 INSTANCE_REBOOT_HARD = "hard"
525 INSTANCE_REBOOT_FULL = "full"
527 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
528 INSTANCE_REBOOT_HARD,
529 INSTANCE_REBOOT_FULL])
531 VTYPE_STRING = 'string'
532 VTYPE_MAYBE_STRING = "maybe-string"
534 VTYPE_SIZE = 'size' # size, in MiBs
536 ENFORCEABLE_TYPES = frozenset([
544 # HV parameter names (global namespace)
545 HV_BOOT_ORDER = "boot_order"
546 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
547 HV_NIC_TYPE = "nic_type"
548 HV_DISK_TYPE = "disk_type"
549 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
550 HV_VNC_PASSWORD_FILE = "vnc_password_file"
551 HV_VNC_TLS = "vnc_tls"
552 HV_VNC_X509 = "vnc_x509_path"
553 HV_VNC_X509_VERIFY = "vnc_x509_verify"
556 HV_USE_BOOTLOADER = "use_bootloader"
557 HV_BOOTLOADER_ARGS = "bootloader_args"
558 HV_BOOTLOADER_PATH = "bootloader_path"
559 HV_KERNEL_ARGS = "kernel_args"
560 HV_KERNEL_PATH = "kernel_path"
561 HV_INITRD_PATH = "initrd_path"
562 HV_ROOT_PATH = "root_path"
563 HV_SERIAL_CONSOLE = "serial_console"
564 HV_USB_MOUSE = "usb_mouse"
565 HV_DEVICE_MODEL = "device_model"
566 HV_INIT_SCRIPT = "init_script"
567 HV_MIGRATION_PORT = "migration_port"
568 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
569 HV_MIGRATION_DOWNTIME = "migration_downtime"
570 HV_MIGRATION_MODE = "migration_mode"
571 HV_USE_LOCALTIME = "use_localtime"
572 HV_DISK_CACHE = "disk_cache"
573 HV_SECURITY_MODEL = "security_model"
574 HV_SECURITY_DOMAIN = "security_domain"
575 HV_KVM_FLAG = "kvm_flag"
576 HV_VHOST_NET = "vhost_net"
577 HV_KVM_USE_CHROOT = "use_chroot"
578 HV_CPU_MASK = "cpu_mask"
579 HV_MEM_PATH = "mem_path"
581 HVS_PARAMETER_TYPES = {
582 HV_BOOT_ORDER: VTYPE_STRING,
583 HV_CDROM_IMAGE_PATH: VTYPE_STRING,
584 HV_NIC_TYPE: VTYPE_STRING,
585 HV_DISK_TYPE: VTYPE_STRING,
586 HV_VNC_PASSWORD_FILE: VTYPE_STRING,
587 HV_VNC_BIND_ADDRESS: VTYPE_STRING,
588 HV_VNC_TLS: VTYPE_BOOL,
589 HV_VNC_X509: VTYPE_STRING,
590 HV_VNC_X509_VERIFY: VTYPE_BOOL,
593 HV_USE_BOOTLOADER: VTYPE_BOOL,
594 HV_BOOTLOADER_PATH: VTYPE_STRING,
595 HV_BOOTLOADER_ARGS: VTYPE_STRING,
596 HV_KERNEL_PATH: VTYPE_STRING,
597 HV_KERNEL_ARGS: VTYPE_STRING,
598 HV_INITRD_PATH: VTYPE_STRING,
599 HV_ROOT_PATH: VTYPE_STRING,
600 HV_SERIAL_CONSOLE: VTYPE_BOOL,
601 HV_USB_MOUSE: VTYPE_STRING,
602 HV_DEVICE_MODEL: VTYPE_STRING,
603 HV_INIT_SCRIPT: VTYPE_STRING,
604 HV_MIGRATION_PORT: VTYPE_INT,
605 HV_MIGRATION_BANDWIDTH: VTYPE_INT,
606 HV_MIGRATION_DOWNTIME: VTYPE_INT,
607 HV_MIGRATION_MODE: VTYPE_STRING,
608 HV_USE_LOCALTIME: VTYPE_BOOL,
609 HV_DISK_CACHE: VTYPE_STRING,
610 HV_SECURITY_MODEL: VTYPE_STRING,
611 HV_SECURITY_DOMAIN: VTYPE_STRING,
612 HV_KVM_FLAG: VTYPE_STRING,
613 HV_VHOST_NET: VTYPE_BOOL,
614 HV_KVM_USE_CHROOT: VTYPE_BOOL,
615 HV_CPU_MASK: VTYPE_STRING,
616 HV_MEM_PATH: VTYPE_STRING,
619 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
624 BE_AUTO_BALANCE = "auto_balance"
626 BES_PARAMETER_TYPES = {
627 BE_MEMORY: VTYPE_SIZE,
629 BE_AUTO_BALANCE: VTYPE_BOOL,
632 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
634 # Instance Parameters Profile
635 PP_DEFAULT = "default"
640 NIC_MODE_BRIDGED = "bridged"
641 NIC_MODE_ROUTED = "routed"
643 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
645 NICS_PARAMETER_TYPES = {
646 NIC_MODE: VTYPE_STRING,
647 NIC_LINK: VTYPE_STRING,
650 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
654 IDISK_ADOPT = "adopt"
655 IDISK_PARAMS_TYPES = {
656 IDISK_SIZE: VTYPE_SIZE,
657 IDISK_MODE: VTYPE_STRING,
658 IDISK_ADOPT: VTYPE_STRING,
660 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
666 INIC_BRIDGE = "bridge"
667 INIC_PARAMS_TYPES = {
668 INIC_BRIDGE: VTYPE_STRING,
669 INIC_IP: VTYPE_MAYBE_STRING,
670 INIC_LINK: VTYPE_STRING,
671 INIC_MAC: VTYPE_STRING,
672 INIC_MODE: VTYPE_STRING,
674 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
676 # Hypervisor constants
677 HT_XEN_PVM = "xen-pvm"
679 HT_XEN_HVM = "xen-hvm"
683 HYPER_TYPES = frozenset([
691 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
694 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
695 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
698 HT_NIC_RTL8139 = "rtl8139"
699 HT_NIC_NE2K_PCI = "ne2k_pci"
700 HT_NIC_NE2K_ISA = "ne2k_isa"
701 HT_NIC_I82551 = "i82551"
702 HT_NIC_I85557B = "i82557b"
703 HT_NIC_I8259ER = "i82559er"
704 HT_NIC_PCNET = "pcnet"
705 HT_NIC_E1000 = "e1000"
706 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
708 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
709 HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
710 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
711 HT_NIC_NE2K_ISA, HT_NIC_I82551,
712 HT_NIC_I85557B, HT_NIC_I8259ER,
713 HT_NIC_PCNET, HT_NIC_E1000,
716 HT_DISK_IOEMU = "ioemu"
718 HT_DISK_SCSI = "scsi"
721 HT_DISK_PFLASH = "pflash"
723 HT_CACHE_DEFAULT = "default"
724 HT_CACHE_NONE = "none"
725 HT_CACHE_WTHROUGH = "writethrough"
726 HT_CACHE_WBACK = "writeback"
727 HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
732 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
733 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
734 HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
738 HT_MOUSE_MOUSE = "mouse"
739 HT_MOUSE_TABLET = "tablet"
741 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
744 HT_BO_CDROM = "cdrom"
746 HT_BO_NETWORK = "network"
748 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
755 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
758 HT_KVM_ENABLED = "enabled"
759 HT_KVM_DISABLED = "disabled"
761 HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
764 HT_MIGRATION_LIVE = "live"
765 HT_MIGRATION_NONLIVE = "non-live"
766 HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
768 # Cluster Verify steps
769 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
770 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
772 # Node verify constants
773 NV_DRBDHELPER = "drbd-helper"
774 NV_DRBDLIST = "drbd-list"
775 NV_FILELIST = "filelist"
777 NV_HYPERVISOR = "hypervisor"
778 NV_INSTANCELIST = "instancelist"
780 NV_MASTERIP = "master-ip"
781 NV_NODELIST = "nodelist"
782 NV_NODENETTEST = "node-net-test"
783 NV_NODESETUP = "nodesetup"
787 NV_VERSION = "version"
789 NV_VMNODES = "vmnodes"
791 # SSL certificate check constants (in days)
792 SSL_CERT_EXPIRATION_WARN = 30
793 SSL_CERT_EXPIRATION_ERROR = 7
795 # Allocator framework constants
796 IALLOCATOR_VERSION = 2
797 IALLOCATOR_DIR_IN = "in"
798 IALLOCATOR_DIR_OUT = "out"
799 VALID_IALLOCATOR_DIRECTIONS = frozenset([
803 IALLOCATOR_MODE_ALLOC = "allocate"
804 IALLOCATOR_MODE_RELOC = "relocate"
805 IALLOCATOR_MODE_MEVAC = "multi-evacuate"
806 VALID_IALLOCATOR_MODES = frozenset([
807 IALLOCATOR_MODE_ALLOC,
808 IALLOCATOR_MODE_RELOC,
809 IALLOCATOR_MODE_MEVAC,
811 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
814 JOB_QUEUE_VERSION = 1
815 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
816 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
817 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
818 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
819 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
820 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
821 JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
822 JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
824 JOB_ID_TEMPLATE = r"\d+"
826 # unchanged job return
827 JOB_NOTCHANGED = "nochange"
830 JOB_STATUS_QUEUED = "queued"
831 JOB_STATUS_WAITLOCK = "waiting"
832 JOB_STATUS_CANCELING = "canceling"
833 JOB_STATUS_RUNNING = "running"
834 JOB_STATUS_CANCELED = "canceled"
835 JOB_STATUS_SUCCESS = "success"
836 JOB_STATUS_ERROR = "error"
837 JOBS_FINALIZED = frozenset([
842 JOB_STATUS_ALL = frozenset([
845 JOB_STATUS_CANCELING,
851 OP_STATUS_QUEUED = "queued"
852 OP_STATUS_WAITLOCK = "waiting"
853 OP_STATUS_CANCELING = "canceling"
854 OP_STATUS_RUNNING = "running"
856 OP_STATUS_CANCELED = "canceled"
857 OP_STATUS_SUCCESS = "success"
858 OP_STATUS_ERROR = "error"
859 OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
865 OP_PRIO_HIGHEST = -20
871 OP_PRIO_SUBMIT_VALID = frozenset([
877 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
879 # Execution log types
880 ELOG_MESSAGE = "message"
881 ELOG_PROGRESS = "progress"
882 ELOG_REMOTE_IMPORT = "remote-import"
883 ELOG_JQUEUE_TEST = "jqueue-test"
885 # /etc/hosts modification
886 ETC_HOSTS_ADD = "add"
887 ETC_HOSTS_REMOVE = "remove"
890 JQT_MSGPREFIX = "TESTMSG="
891 JQT_EXPANDNAMES = "expandnames"
893 JQT_LOGMSG = "logmsg"
894 JQT_STARTMSG = "startmsg"
895 JQT_ALL = frozenset([
902 # max dynamic devices
907 SS_CLUSTER_NAME = "cluster_name"
908 SS_CLUSTER_TAGS = "cluster_tags"
909 SS_FILE_STORAGE_DIR = "file_storage_dir"
910 SS_MASTER_CANDIDATES = "master_candidates"
911 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
912 SS_MASTER_IP = "master_ip"
913 SS_MASTER_NETDEV = "master_netdev"
914 SS_MASTER_NODE = "master_node"
915 SS_NODE_LIST = "node_list"
916 SS_NODE_PRIMARY_IPS = "node_primary_ips"
917 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
918 SS_OFFLINE_NODES = "offline_nodes"
919 SS_ONLINE_NODES = "online_nodes"
920 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
921 SS_INSTANCE_LIST = "instance_list"
922 SS_RELEASE_VERSION = "release_version"
923 SS_HYPERVISOR_LIST = "hypervisor_list"
924 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
925 SS_UID_POOL = "uid_pool"
926 SS_NODEGROUPS = "nodegroups"
928 # cluster wide default parameters
929 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
933 HV_USE_BOOTLOADER: False,
934 HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
935 HV_BOOTLOADER_ARGS: '',
936 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
938 HV_ROOT_PATH: '/dev/sda1',
939 HV_KERNEL_ARGS: 'ro',
940 HV_MIGRATION_PORT: 8002,
941 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
945 HV_CDROM_IMAGE_PATH: '',
946 HV_NIC_TYPE: HT_NIC_RTL8139,
947 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
948 HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
949 HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
952 HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
953 HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
954 HV_MIGRATION_PORT: 8002,
955 HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
956 HV_USE_LOCALTIME: False,
959 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
961 HV_KERNEL_ARGS: 'ro',
962 HV_ROOT_PATH: '/dev/vda1',
964 HV_SERIAL_CONSOLE: True,
965 HV_VNC_BIND_ADDRESS: '',
968 HV_VNC_X509_VERIFY: False,
969 HV_VNC_PASSWORD_FILE: '',
970 HV_CDROM_IMAGE_PATH: '',
971 HV_BOOT_ORDER: HT_BO_DISK,
972 HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
973 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
975 HV_MIGRATION_PORT: 8102,
976 HV_MIGRATION_BANDWIDTH: 32, # MiB/s
977 HV_MIGRATION_DOWNTIME: 30, # ms
978 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
979 HV_USE_LOCALTIME: False,
980 HV_DISK_CACHE: HT_CACHE_DEFAULT,
981 HV_SECURITY_MODEL: HT_SM_NONE,
982 HV_SECURITY_DOMAIN: '',
985 HV_KVM_USE_CHROOT: False,
991 HV_INIT_SCRIPT: "/ganeti-chroot",
998 HVC_GLOBALS = frozenset([
1000 HV_MIGRATION_BANDWIDTH,
1007 BE_AUTO_BALANCE: True,
1011 NIC_MODE: NIC_MODE_BRIDGED,
1012 NIC_LINK: DEFAULT_BRIDGE,
1015 MASTER_POOL_SIZE_DEFAULT = 10
1017 CONFD_PROTOCOL_VERSION = 1
1020 CONFD_REQ_NODE_ROLE_BYNAME = 1
1021 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1022 CONFD_REQ_CLUSTER_MASTER = 3
1023 CONFD_REQ_NODE_PIP_LIST = 4
1024 CONFD_REQ_MC_PIP_LIST = 5
1025 CONFD_REQ_INSTANCES_IPS_LIST = 6
1027 # Confd request query fields. These are used to narrow down queries.
1028 # These must be strings rather than integers, because json-encoding
1029 # converts them to strings anyway, as they're used as dict-keys.
1030 CONFD_REQQ_LINK = "0"
1032 CONFD_REQQ_IPLIST = "2"
1033 CONFD_REQQ_FIELDS = "3"
1035 CONFD_REQFIELD_NAME = "0"
1036 CONFD_REQFIELD_IP = "1"
1037 CONFD_REQFIELD_MNODE_PIP = "2"
1039 CONFD_REQS = frozenset([
1041 CONFD_REQ_NODE_ROLE_BYNAME,
1042 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1043 CONFD_REQ_CLUSTER_MASTER,
1044 CONFD_REQ_NODE_PIP_LIST,
1045 CONFD_REQ_MC_PIP_LIST,
1046 CONFD_REQ_INSTANCES_IPS_LIST,
1049 CONFD_REPL_STATUS_OK = 0
1050 CONFD_REPL_STATUS_ERROR = 1
1051 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1053 CONFD_REPL_STATUSES = frozenset([
1054 CONFD_REPL_STATUS_OK,
1055 CONFD_REPL_STATUS_ERROR,
1056 CONFD_REPL_STATUS_NOTIMPLEMENTED,
1059 (CONFD_NODE_ROLE_MASTER,
1060 CONFD_NODE_ROLE_CANDIDATE,
1061 CONFD_NODE_ROLE_OFFLINE,
1062 CONFD_NODE_ROLE_DRAINED,
1063 CONFD_NODE_ROLE_REGULAR,
1066 # A few common errors for confd
1067 CONFD_ERROR_UNKNOWN_ENTRY = 1
1068 CONFD_ERROR_INTERNAL = 2
1069 CONFD_ERROR_ARGUMENT = 3
1071 # Each request is "salted" by the current timestamp.
1072 # This constants decides how many seconds of skew to accept.
1073 # TODO: make this a default and allow the value to be more configurable
1074 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1076 # When we haven't reloaded the config for more than this amount of seconds, we
1077 # force a test to see if inotify is betraying us.
1078 CONFD_CONFIG_RELOAD_TIMEOUT = 60
1080 # If we receive more than one update in this amount of seconds, we move to
1081 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
1082 # to serve more requests.
1083 CONFD_CONFIG_RELOAD_RATELIMIT = 2
1085 # Magic number prepended to all confd queries.
1086 # This allows us to distinguish different types of confd protocols and handle
1087 # them. For example by changing this we can move the whole payload to be
1088 # compressed, or move away from json.
1089 CONFD_MAGIC_FOURCC = 'plj0'
1091 # By default a confd request is sent to the minimum between this number and all
1092 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
1093 # we should have enough answers to be able to compare more than one.
1094 CONFD_DEFAULT_REQ_COVERAGE = 6
1096 # Timeout in seconds to expire pending query request in the confd client
1097 # library. We don't actually expect any answer more than 10 seconds after we
1099 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1101 # Maximum UDP datagram size.
1102 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1103 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1104 # (assuming we can't use jumbo frames)
1105 # We just set this to 60K, which should be enough
1106 MAX_UDP_DATA_SIZE = 61440
1108 # User-id pool minimum/maximum acceptable user-ids.
1110 UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
1112 # Name or path of the pgrep command