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 #: Console as SSH command
229 #: Console as VNC server
232 #: Display a message for console access
236 CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_MESSAGE])
238 # For RSA keys more bits are better, but they also make operations more
239 # expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
243 # Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
244 # way to disable ciphers would be to use the exclamation mark (!), but socat
245 # versions below 1.5 can't parse exclamation marks in options properly. When
246 # modifying the ciphers, ensure not to accidentially add something after it's
247 # been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
248 # "openssl ciphers -v HIGH:-DES".
249 OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"
251 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
252 X509_CERT_SIGN_DIGEST = "SHA1"
254 # Default validity of certificates in days
255 X509_CERT_DEFAULT_VALIDITY = 365 * 5
257 # commonName (CN) used in certificates
258 X509_CERT_CN = "ganeti.example.com"
260 X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
262 IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
264 # Import/export daemon mode
265 IEM_IMPORT = "import"
266 IEM_EXPORT = "export"
268 # Import/export transport compression
271 IEC_ALL = frozenset([
276 IE_CUSTOM_SIZE = "fd"
278 IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")
281 # Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
283 # Raw block device I/O using "dd"
284 IEIO_RAW_DISK = "raw"
285 # OS definition import/export script
286 IEIO_SCRIPT = "script"
288 VALUE_DEFAULT = "default"
290 VALUE_GENERATE = "generate"
293 VALUE_FALSE = "false"
295 # External script validation mask
296 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
298 # hooks-related constants
299 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
300 HOOKS_PHASE_PRE = "pre"
301 HOOKS_PHASE_POST = "post"
302 HOOKS_NAME_CFGUPDATE = "config-update"
303 HOOKS_NAME_WATCHER = "watcher"
306 # hooks subject type (what object type does the LU deal with)
307 HTYPE_CLUSTER = "CLUSTER"
309 HTYPE_GROUP = "GROUP"
310 HTYPE_INSTANCE = "INSTANCE"
322 # first two are valid in LU context only, not passed to backend
325 # and the rest are valid in backend
330 SF_ALLOCATABLE = "allocatable"
333 SO_FIX_CONSISTENCY = "fix-consistency"
335 # Available fields per storage type
336 VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
337 SF_USED, SF_FREE, SF_ALLOCATABLE])
339 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
341 MODIFIABLE_STORAGE_FIELDS = {
342 ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
345 VALID_STORAGE_OPERATIONS = {
346 ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
350 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
353 LDS_FAULTY) = range(1, 4)
355 # disk template types
356 DT_DISKLESS = "diskless"
361 # the set of network-mirrored disk templates
362 DTS_NET_MIRROR = frozenset([DT_DRBD8])
364 # the set of non-lvm-based disk templates
365 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
367 # the set of disk templates which can be grown
368 DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
370 # the set of disk templates that allow adoption
371 DTS_MAY_ADOPT = frozenset([DT_PLAIN])
377 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
380 DRBD_HMAC_ALG = "md5"
381 DRBD_NET_PROTOCOL = "C"
382 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
384 # file backend driver
388 # the set of drbd-like disk types
389 LDS_DRBD = frozenset([LD_DRBD8])
394 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
396 # disk replacement mode
397 REPLACE_DISK_PRI = "replace_on_primary" # replace disks on primary
398 REPLACE_DISK_SEC = "replace_on_secondary" # replace disks on secondary
399 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
400 REPLACE_DISK_AUTO = "replace_auto"
401 REPLACE_MODES = frozenset([
408 # Instance export mode
409 EXPORT_MODE_LOCAL = "local"
410 EXPORT_MODE_REMOTE = "remote"
411 EXPORT_MODES = frozenset([
416 # lock recalculate mode
417 LOCKS_REPLACE = 'replace'
418 LOCKS_APPEND = 'append'
420 # instance creation modes
421 INSTANCE_CREATE = "create"
422 INSTANCE_IMPORT = "import"
423 INSTANCE_REMOTE_IMPORT = "remote-import"
424 INSTANCE_CREATE_MODES = frozenset([
427 INSTANCE_REMOTE_IMPORT,
430 # Remote import/export handshake message and version
432 RIE_HANDSHAKE = "Hi, I'm Ganeti"
434 # Remote import/export certificate validity in seconds
435 RIE_CERT_VALIDITY = 24 * 60 * 60
437 # Remote import/export connect timeout for socat
438 RIE_CONNECT_TIMEOUT = 60
439 #: Give child process up to 5 seconds to exit after sending a signal
440 CHILD_LINGER_TIMEOUT = 5.0
442 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
445 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
447 # import/export config options
448 INISECT_EXP = "export"
449 INISECT_INS = "instance"
450 INISECT_HYP = "hypervisor"
451 INISECT_BEP = "backend"
454 # dynamic device modification
456 DDM_REMOVE = "remove"
457 DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
464 EXIT_NODESETUP_ERROR = 12
465 EXIT_CONFIRMATION = 13 # need user confirmation
467 #: Exit code for query operations with unknown fields
468 EXIT_UNKNOWN_FIELD = 14
471 TAG_CLUSTER = "cluster"
473 TAG_INSTANCE = "instance"
474 VALID_TAG_TYPES = frozenset([
480 MAX_TAGS_PER_OBJ = 4096
483 DEFAULT_BRIDGE = "xen-br0"
484 SYNC_SPEED = 60 * 1024
485 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
486 IP4_ADDRESS_ANY = "0.0.0.0"
487 IP6_ADDRESS_LOCALHOST = "::1"
488 IP6_ADDRESS_ANY = "::"
491 TCP_PING_TIMEOUT = 10
492 GANETI_RUNAS = "root"
494 DEFAULT_DRBD_HELPER = "/bin/true"
496 DEFAULT_MAC_PREFIX = "aa:00:00"
497 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
498 # default maximum instance wait time, in seconds.
499 DEFAULT_SHUTDOWN_TIMEOUT = 120
500 NODE_MAX_CLOCK_SKEW = 150
501 # Time for an intra-cluster disk transfer to wait for a connection
502 DISK_TRANSFER_CONNECT_TIMEOUT = 30
503 # Disk index separator
504 DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
509 RUNPARTS_ERR) = range(3)
511 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
515 RPC_ENCODING_ZLIB_BASE64) = range(2)
517 # os related constants
518 OS_SCRIPT_CREATE = 'create'
519 OS_SCRIPT_IMPORT = 'import'
520 OS_SCRIPT_EXPORT = 'export'
521 OS_SCRIPT_RENAME = 'rename'
522 OS_SCRIPT_VERIFY = 'verify'
523 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
524 OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME,
527 OS_API_FILE = 'ganeti_api_version'
528 OS_VARIANTS_FILE = 'variants.list'
529 OS_PARAMETERS_FILE = 'parameters.list'
531 OS_VALIDATE_PARAMETERS = 'parameters'
532 OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
535 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
536 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
537 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
538 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
539 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
544 INSTANCE_REBOOT_SOFT = "soft"
545 INSTANCE_REBOOT_HARD = "hard"
546 INSTANCE_REBOOT_FULL = "full"
548 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
549 INSTANCE_REBOOT_HARD,
550 INSTANCE_REBOOT_FULL])
552 VTYPE_STRING = 'string'
553 VTYPE_MAYBE_STRING = "maybe-string"
555 VTYPE_SIZE = 'size' # size, in MiBs
557 ENFORCEABLE_TYPES = frozenset([
565 # HV parameter names (global namespace)
566 HV_BOOT_ORDER = "boot_order"
567 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
568 HV_NIC_TYPE = "nic_type"
569 HV_DISK_TYPE = "disk_type"
570 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
571 HV_VNC_PASSWORD_FILE = "vnc_password_file"
572 HV_VNC_TLS = "vnc_tls"
573 HV_VNC_X509 = "vnc_x509_path"
574 HV_VNC_X509_VERIFY = "vnc_x509_verify"
577 HV_USE_BOOTLOADER = "use_bootloader"
578 HV_BOOTLOADER_ARGS = "bootloader_args"
579 HV_BOOTLOADER_PATH = "bootloader_path"
580 HV_KERNEL_ARGS = "kernel_args"
581 HV_KERNEL_PATH = "kernel_path"
582 HV_INITRD_PATH = "initrd_path"
583 HV_ROOT_PATH = "root_path"
584 HV_SERIAL_CONSOLE = "serial_console"
585 HV_USB_MOUSE = "usb_mouse"
586 HV_DEVICE_MODEL = "device_model"
587 HV_INIT_SCRIPT = "init_script"
588 HV_MIGRATION_PORT = "migration_port"
589 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
590 HV_MIGRATION_DOWNTIME = "migration_downtime"
591 HV_MIGRATION_MODE = "migration_mode"
592 HV_USE_LOCALTIME = "use_localtime"
593 HV_DISK_CACHE = "disk_cache"
594 HV_SECURITY_MODEL = "security_model"
595 HV_SECURITY_DOMAIN = "security_domain"
596 HV_KVM_FLAG = "kvm_flag"
597 HV_VHOST_NET = "vhost_net"
598 HV_KVM_USE_CHROOT = "use_chroot"
599 HV_CPU_MASK = "cpu_mask"
600 HV_MEM_PATH = "mem_path"
601 HV_BLOCKDEV_PREFIX = "blockdev_prefix"
603 HVS_PARAMETER_TYPES = {
604 HV_BOOT_ORDER: VTYPE_STRING,
605 HV_CDROM_IMAGE_PATH: VTYPE_STRING,
606 HV_NIC_TYPE: VTYPE_STRING,
607 HV_DISK_TYPE: VTYPE_STRING,
608 HV_VNC_PASSWORD_FILE: VTYPE_STRING,
609 HV_VNC_BIND_ADDRESS: VTYPE_STRING,
610 HV_VNC_TLS: VTYPE_BOOL,
611 HV_VNC_X509: VTYPE_STRING,
612 HV_VNC_X509_VERIFY: VTYPE_BOOL,
615 HV_USE_BOOTLOADER: VTYPE_BOOL,
616 HV_BOOTLOADER_PATH: VTYPE_STRING,
617 HV_BOOTLOADER_ARGS: VTYPE_STRING,
618 HV_KERNEL_PATH: VTYPE_STRING,
619 HV_KERNEL_ARGS: VTYPE_STRING,
620 HV_INITRD_PATH: VTYPE_STRING,
621 HV_ROOT_PATH: VTYPE_STRING,
622 HV_SERIAL_CONSOLE: VTYPE_BOOL,
623 HV_USB_MOUSE: VTYPE_STRING,
624 HV_DEVICE_MODEL: VTYPE_STRING,
625 HV_INIT_SCRIPT: VTYPE_STRING,
626 HV_MIGRATION_PORT: VTYPE_INT,
627 HV_MIGRATION_BANDWIDTH: VTYPE_INT,
628 HV_MIGRATION_DOWNTIME: VTYPE_INT,
629 HV_MIGRATION_MODE: VTYPE_STRING,
630 HV_USE_LOCALTIME: VTYPE_BOOL,
631 HV_DISK_CACHE: VTYPE_STRING,
632 HV_SECURITY_MODEL: VTYPE_STRING,
633 HV_SECURITY_DOMAIN: VTYPE_STRING,
634 HV_KVM_FLAG: VTYPE_STRING,
635 HV_VHOST_NET: VTYPE_BOOL,
636 HV_KVM_USE_CHROOT: VTYPE_BOOL,
637 HV_CPU_MASK: VTYPE_STRING,
638 HV_MEM_PATH: VTYPE_STRING,
639 HV_BLOCKDEV_PREFIX: VTYPE_STRING,
642 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
647 BE_AUTO_BALANCE = "auto_balance"
649 BES_PARAMETER_TYPES = {
650 BE_MEMORY: VTYPE_SIZE,
652 BE_AUTO_BALANCE: VTYPE_BOOL,
655 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
657 # Node parameter names
658 ND_OOB_PROGRAM = "oob_program"
660 NDS_PARAMETER_TYPES = {
661 ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
664 NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
666 # OOB supported commands
667 OOB_POWER_ON = "power-on"
668 OOB_POWER_OFF = "power-off"
669 OOB_POWER_CYCLE = "power-cycle"
670 OOB_POWER_STATUS = "power-status"
671 OOB_HEALTH = "health"
673 OOB_COMMANDS = frozenset([OOB_POWER_ON, OOB_POWER_OFF, OOB_POWER_CYCLE,
674 OOB_POWER_STATUS, OOB_HEALTH])
676 OOB_POWER_STATUS_POWERED = "powered"
678 OOB_TIMEOUT = 60 # 60 seconds
681 OOB_STATUS_WARNING = "WARNING"
682 OOB_STATUS_CRITICAL = "CRITICAL"
683 OOB_STATUS_UNKNOWN = "UNKNOWN"
685 OOB_STATUSES = frozenset([
692 # Instance Parameters Profile
693 PP_DEFAULT = "default"
698 NIC_MODE_BRIDGED = "bridged"
699 NIC_MODE_ROUTED = "routed"
701 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
703 NICS_PARAMETER_TYPES = {
704 NIC_MODE: VTYPE_STRING,
705 NIC_LINK: VTYPE_STRING,
708 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
712 IDISK_ADOPT = "adopt"
714 IDISK_PARAMS_TYPES = {
715 IDISK_SIZE: VTYPE_SIZE,
716 IDISK_MODE: VTYPE_STRING,
717 IDISK_ADOPT: VTYPE_STRING,
718 IDISK_VG: VTYPE_STRING,
720 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
726 INIC_BRIDGE = "bridge"
727 INIC_PARAMS_TYPES = {
728 INIC_BRIDGE: VTYPE_STRING,
729 INIC_IP: VTYPE_MAYBE_STRING,
730 INIC_LINK: VTYPE_STRING,
731 INIC_MAC: VTYPE_STRING,
732 INIC_MODE: VTYPE_STRING,
734 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
736 # Hypervisor constants
737 HT_XEN_PVM = "xen-pvm"
739 HT_XEN_HVM = "xen-hvm"
743 HYPER_TYPES = frozenset([
751 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
754 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
755 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
758 HT_NIC_RTL8139 = "rtl8139"
759 HT_NIC_NE2K_PCI = "ne2k_pci"
760 HT_NIC_NE2K_ISA = "ne2k_isa"
761 HT_NIC_I82551 = "i82551"
762 HT_NIC_I85557B = "i82557b"
763 HT_NIC_I8259ER = "i82559er"
764 HT_NIC_PCNET = "pcnet"
765 HT_NIC_E1000 = "e1000"
766 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
768 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
769 HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
770 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
771 HT_NIC_NE2K_ISA, HT_NIC_I82551,
772 HT_NIC_I85557B, HT_NIC_I8259ER,
773 HT_NIC_PCNET, HT_NIC_E1000,
776 HT_DISK_IOEMU = "ioemu"
778 HT_DISK_SCSI = "scsi"
781 HT_DISK_PFLASH = "pflash"
783 HT_CACHE_DEFAULT = "default"
784 HT_CACHE_NONE = "none"
785 HT_CACHE_WTHROUGH = "writethrough"
786 HT_CACHE_WBACK = "writeback"
787 HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
792 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
793 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
794 HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
798 HT_MOUSE_MOUSE = "mouse"
799 HT_MOUSE_TABLET = "tablet"
801 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
804 HT_BO_CDROM = "cdrom"
806 HT_BO_NETWORK = "network"
808 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
815 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
818 HT_KVM_ENABLED = "enabled"
819 HT_KVM_DISABLED = "disabled"
821 HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
824 HT_MIGRATION_LIVE = "live"
825 HT_MIGRATION_NONLIVE = "non-live"
826 HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
828 # Cluster Verify steps
829 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
830 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
832 # Node verify constants
833 NV_DRBDHELPER = "drbd-helper"
834 NV_DRBDLIST = "drbd-list"
835 NV_FILELIST = "filelist"
837 NV_HYPERVISOR = "hypervisor"
838 NV_INSTANCELIST = "instancelist"
840 NV_MASTERIP = "master-ip"
841 NV_NODELIST = "nodelist"
842 NV_NODENETTEST = "node-net-test"
843 NV_NODESETUP = "nodesetup"
847 NV_VERSION = "version"
849 NV_VMNODES = "vmnodes"
850 NV_OOB_PATHS = "oob-paths"
852 # SSL certificate check constants (in days)
853 SSL_CERT_EXPIRATION_WARN = 30
854 SSL_CERT_EXPIRATION_ERROR = 7
856 # Allocator framework constants
857 IALLOCATOR_VERSION = 2
858 IALLOCATOR_DIR_IN = "in"
859 IALLOCATOR_DIR_OUT = "out"
860 VALID_IALLOCATOR_DIRECTIONS = frozenset([
864 IALLOCATOR_MODE_ALLOC = "allocate"
865 IALLOCATOR_MODE_RELOC = "relocate"
866 IALLOCATOR_MODE_MEVAC = "multi-evacuate"
867 VALID_IALLOCATOR_MODES = frozenset([
868 IALLOCATOR_MODE_ALLOC,
869 IALLOCATOR_MODE_RELOC,
870 IALLOCATOR_MODE_MEVAC,
872 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
875 JOB_QUEUE_VERSION = 1
876 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
877 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
878 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
879 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
880 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
881 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
882 JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
883 JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
885 JOB_ID_TEMPLATE = r"\d+"
887 # unchanged job return
888 JOB_NOTCHANGED = "nochange"
891 JOB_STATUS_QUEUED = "queued"
892 JOB_STATUS_WAITLOCK = "waiting"
893 JOB_STATUS_CANCELING = "canceling"
894 JOB_STATUS_RUNNING = "running"
895 JOB_STATUS_CANCELED = "canceled"
896 JOB_STATUS_SUCCESS = "success"
897 JOB_STATUS_ERROR = "error"
898 JOBS_FINALIZED = frozenset([
903 JOB_STATUS_ALL = frozenset([
906 JOB_STATUS_CANCELING,
912 OP_STATUS_QUEUED = "queued"
913 OP_STATUS_WAITLOCK = "waiting"
914 OP_STATUS_CANCELING = "canceling"
915 OP_STATUS_RUNNING = "running"
917 OP_STATUS_CANCELED = "canceled"
918 OP_STATUS_SUCCESS = "success"
919 OP_STATUS_ERROR = "error"
920 OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
926 OP_PRIO_HIGHEST = -20
932 OP_PRIO_SUBMIT_VALID = frozenset([
938 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
940 # Execution log types
941 ELOG_MESSAGE = "message"
942 ELOG_PROGRESS = "progress"
943 ELOG_REMOTE_IMPORT = "remote-import"
944 ELOG_JQUEUE_TEST = "jqueue-test"
946 # /etc/hosts modification
947 ETC_HOSTS_ADD = "add"
948 ETC_HOSTS_REMOVE = "remove"
951 JQT_MSGPREFIX = "TESTMSG="
952 JQT_EXPANDNAMES = "expandnames"
954 JQT_LOGMSG = "logmsg"
955 JQT_STARTMSG = "startmsg"
956 JQT_ALL = frozenset([
964 QR_INSTANCE = "instance"
969 #: List of resources which can be queried using L{opcodes.OpQuery}
970 QR_OP_QUERY = frozenset([QR_INSTANCE, QR_NODE, QR_GROUP])
972 #: List of resources which can be queried using LUXI
973 QR_OP_LUXI = QR_OP_QUERY.union([
978 QFT_UNKNOWN = "unknown"
981 QFT_NUMBER = "number"
983 QFT_TIMESTAMP = "timestamp"
986 #: All query field types
987 QFT_ALL = frozenset([
997 # Query result field status (don't change or reuse values as they're used by
999 #: Normal field status
1003 #: No data (e.g. RPC error), can be used instead of L{QRFS_OFFLINE}
1005 #: Value unavailable for item
1007 #: Resource marked offline
1010 QRFS_ALL = frozenset([
1018 # max dynamic devices
1023 SS_CLUSTER_NAME = "cluster_name"
1024 SS_CLUSTER_TAGS = "cluster_tags"
1025 SS_FILE_STORAGE_DIR = "file_storage_dir"
1026 SS_MASTER_CANDIDATES = "master_candidates"
1027 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1028 SS_MASTER_IP = "master_ip"
1029 SS_MASTER_NETDEV = "master_netdev"
1030 SS_MASTER_NODE = "master_node"
1031 SS_NODE_LIST = "node_list"
1032 SS_NODE_PRIMARY_IPS = "node_primary_ips"
1033 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1034 SS_OFFLINE_NODES = "offline_nodes"
1035 SS_ONLINE_NODES = "online_nodes"
1036 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1037 SS_INSTANCE_LIST = "instance_list"
1038 SS_RELEASE_VERSION = "release_version"
1039 SS_HYPERVISOR_LIST = "hypervisor_list"
1040 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1041 SS_UID_POOL = "uid_pool"
1042 SS_NODEGROUPS = "nodegroups"
1044 # cluster wide default parameters
1045 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1049 HV_USE_BOOTLOADER: False,
1050 HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1051 HV_BOOTLOADER_ARGS: '',
1052 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1054 HV_ROOT_PATH: '/dev/sda1',
1055 HV_KERNEL_ARGS: 'ro',
1056 HV_MIGRATION_PORT: 8002,
1057 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1058 HV_BLOCKDEV_PREFIX: "sd",
1061 HV_BOOT_ORDER: "cd",
1062 HV_CDROM_IMAGE_PATH: '',
1063 HV_NIC_TYPE: HT_NIC_RTL8139,
1064 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1065 HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1066 HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1069 HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1070 HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1071 HV_MIGRATION_PORT: 8002,
1072 HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1073 HV_USE_LOCALTIME: False,
1074 HV_BLOCKDEV_PREFIX: "hd",
1077 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1079 HV_KERNEL_ARGS: 'ro',
1080 HV_ROOT_PATH: '/dev/vda1',
1082 HV_SERIAL_CONSOLE: True,
1083 HV_VNC_BIND_ADDRESS: '',
1086 HV_VNC_X509_VERIFY: False,
1087 HV_VNC_PASSWORD_FILE: '',
1088 HV_CDROM_IMAGE_PATH: '',
1089 HV_BOOT_ORDER: HT_BO_DISK,
1090 HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1091 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1093 HV_MIGRATION_PORT: 8102,
1094 HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1095 HV_MIGRATION_DOWNTIME: 30, # ms
1096 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1097 HV_USE_LOCALTIME: False,
1098 HV_DISK_CACHE: HT_CACHE_DEFAULT,
1099 HV_SECURITY_MODEL: HT_SM_NONE,
1100 HV_SECURITY_DOMAIN: '',
1102 HV_VHOST_NET: False,
1103 HV_KVM_USE_CHROOT: False,
1109 HV_INIT_SCRIPT: "/ganeti-chroot",
1116 HVC_GLOBALS = frozenset([
1118 HV_MIGRATION_BANDWIDTH,
1125 BE_AUTO_BALANCE: True,
1129 ND_OOB_PROGRAM: None,
1133 NIC_MODE: NIC_MODE_BRIDGED,
1134 NIC_LINK: DEFAULT_BRIDGE,
1137 MASTER_POOL_SIZE_DEFAULT = 10
1139 CONFD_PROTOCOL_VERSION = 1
1142 CONFD_REQ_NODE_ROLE_BYNAME = 1
1143 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1144 CONFD_REQ_CLUSTER_MASTER = 3
1145 CONFD_REQ_NODE_PIP_LIST = 4
1146 CONFD_REQ_MC_PIP_LIST = 5
1147 CONFD_REQ_INSTANCES_IPS_LIST = 6
1149 # Confd request query fields. These are used to narrow down queries.
1150 # These must be strings rather than integers, because json-encoding
1151 # converts them to strings anyway, as they're used as dict-keys.
1152 CONFD_REQQ_LINK = "0"
1154 CONFD_REQQ_IPLIST = "2"
1155 CONFD_REQQ_FIELDS = "3"
1157 CONFD_REQFIELD_NAME = "0"
1158 CONFD_REQFIELD_IP = "1"
1159 CONFD_REQFIELD_MNODE_PIP = "2"
1161 CONFD_REQS = frozenset([
1163 CONFD_REQ_NODE_ROLE_BYNAME,
1164 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1165 CONFD_REQ_CLUSTER_MASTER,
1166 CONFD_REQ_NODE_PIP_LIST,
1167 CONFD_REQ_MC_PIP_LIST,
1168 CONFD_REQ_INSTANCES_IPS_LIST,
1171 CONFD_REPL_STATUS_OK = 0
1172 CONFD_REPL_STATUS_ERROR = 1
1173 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1175 CONFD_REPL_STATUSES = frozenset([
1176 CONFD_REPL_STATUS_OK,
1177 CONFD_REPL_STATUS_ERROR,
1178 CONFD_REPL_STATUS_NOTIMPLEMENTED,
1181 (CONFD_NODE_ROLE_MASTER,
1182 CONFD_NODE_ROLE_CANDIDATE,
1183 CONFD_NODE_ROLE_OFFLINE,
1184 CONFD_NODE_ROLE_DRAINED,
1185 CONFD_NODE_ROLE_REGULAR,
1188 # A few common errors for confd
1189 CONFD_ERROR_UNKNOWN_ENTRY = 1
1190 CONFD_ERROR_INTERNAL = 2
1191 CONFD_ERROR_ARGUMENT = 3
1193 # Each request is "salted" by the current timestamp.
1194 # This constants decides how many seconds of skew to accept.
1195 # TODO: make this a default and allow the value to be more configurable
1196 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1198 # When we haven't reloaded the config for more than this amount of seconds, we
1199 # force a test to see if inotify is betraying us.
1200 CONFD_CONFIG_RELOAD_TIMEOUT = 60
1202 # If we receive more than one update in this amount of seconds, we move to
1203 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
1204 # to serve more requests.
1205 CONFD_CONFIG_RELOAD_RATELIMIT = 2
1207 # Magic number prepended to all confd queries.
1208 # This allows us to distinguish different types of confd protocols and handle
1209 # them. For example by changing this we can move the whole payload to be
1210 # compressed, or move away from json.
1211 CONFD_MAGIC_FOURCC = 'plj0'
1213 # By default a confd request is sent to the minimum between this number and all
1214 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
1215 # we should have enough answers to be able to compare more than one.
1216 CONFD_DEFAULT_REQ_COVERAGE = 6
1218 # Timeout in seconds to expire pending query request in the confd client
1219 # library. We don't actually expect any answer more than 10 seconds after we
1221 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1223 # Maximum UDP datagram size.
1224 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1225 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1226 # (assuming we can't use jumbo frames)
1227 # We just set this to 60K, which should be enough
1228 MAX_UDP_DATA_SIZE = 61440
1230 # User-id pool minimum/maximum acceptable user-ids.
1232 UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
1234 # Name or path of the pgrep command
1237 # Name of the node group that gets created at cluster init or upgrade
1238 INITIAL_NODE_GROUP_NAME = "default"
1240 # Possible values for NodeGroup.alloc_policy
1241 ALLOC_POLICY_PREFERRED = "preferred"
1242 ALLOC_POLICY_LAST_RESORT = "last_resort"
1243 ALLOC_POLICY_UNALLOCABLE = "unallocable"
1244 VALID_ALLOC_POLICIES = [
1245 ALLOC_POLICY_PREFERRED,
1246 ALLOC_POLICY_LAST_RESORT,
1247 ALLOC_POLICY_UNALLOCABLE,