4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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
27 from ganeti import _vcsversion
30 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
34 OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
35 VCS_VERSION = _vcsversion.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)
87 #: RPC protocol version
88 PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)
91 DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
92 ADMIN_GROUP = _autoconf.ADMIN_GROUP
93 MASTERD_USER = _autoconf.MASTERD_USER
94 MASTERD_GROUP = _autoconf.MASTERD_GROUP
95 RAPI_USER = _autoconf.RAPI_USER
96 RAPI_GROUP = _autoconf.RAPI_GROUP
97 CONFD_USER = _autoconf.CONFD_USER
98 CONFD_GROUP = _autoconf.CONFD_GROUP
99 NODED_USER = _autoconf.NODED_USER
100 NODED_GROUP = _autoconf.NODED_GROUP
102 # cpu pinning separators and constants
103 CPU_PINNING_SEP = ":"
104 CPU_PINNING_ALL = "all"
105 # internal representation of "all"
106 CPU_PINNING_ALL_VAL = -1
107 # one "all" entry in a CPU list means CPU pinning is off
108 CPU_PINNING_OFF = [CPU_PINNING_ALL_VAL]
110 # A Xen-specific implementation detail - there is no way to actually say
111 # "use any cpu for pinning" in a Xen configuration file, as opposed to the
112 # command line, where you can say "xm vcpu-pin <domain> <vcpu> all".
113 # The workaround used in Xen is "0-63" (see source code function
114 # xm_vcpu_pin in <xen-source>/tools/python/xen/xm/main.py).
115 # To support future changes, the following constant is treated as a
116 # blackbox string that simply means use-any-cpu-for-pinning-under-xen.
117 CPU_PINNING_ALL_XEN = "0-63"
119 # A KVM-specific implementation detail - the following value is used
120 # to set CPU affinity to all processors (#0 through #31), per taskset
122 CPU_PINNING_ALL_KVM = 0xFFFFFFFF
126 WIPE_BLOCK_SIZE = 1024 ** 2
127 MAX_WIPE_CHUNK = 1024 # 1GB
128 MIN_WIPE_CHUNK_PERCENT = 10
132 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
133 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
134 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
135 BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
136 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
138 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
139 SECURE_DIR_MODE = 0700
140 SECURE_FILE_MODE = 0600
141 SOCKET_DIR_MODE = 0750
142 CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
143 CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE
144 IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
145 IMPORT_EXPORT_DIR_MODE = 0755
146 ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
147 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
148 # daemon is started (this takes care of RUN_DIR being tmpfs)
154 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
155 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
156 # User-id pool lock directory
157 # The user-ids that are in use have a corresponding lock file in this directory
158 UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
159 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
160 NODED_CERT_FILE = DATA_DIR + "/server.pem"
161 RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
162 CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
163 SPICE_CERT_FILE = DATA_DIR + "/spice.pem"
164 SPICE_CACERT_FILE = DATA_DIR + "/spice-ca.pem"
165 CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
166 INSTANCE_STATUS_FILE = RUN_GANETI_DIR + "/instance-status"
167 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
168 RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
169 QUEUE_DIR = DATA_DIR + "/queue"
170 DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
171 SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
172 KVM_IFUP = _autoconf.PKGLIBDIR + "/kvm-ifup"
173 KVM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/kvm-console-wrapper"
174 XM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/xm-console-wrapper"
175 ETC_HOSTS = "/etc/hosts"
176 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
177 DEFAULT_SHARED_FILE_STORAGE_DIR = _autoconf.SHARED_FILE_STORAGE_DIR
178 ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
179 ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
180 SYSCONFDIR = _autoconf.SYSCONFDIR
181 TOOLSDIR = _autoconf.TOOLSDIR
182 CONF_DIR = SYSCONFDIR + "/ganeti"
183 USER_SCRIPTS_DIR = CONF_DIR + "/scripts"
184 ENABLE_CONFD = _autoconf.ENABLE_CONFD
186 #: Lock file for watcher, locked in shared mode by watcher; lock in exclusive
187 # mode to block watcher (see L{cli._RunWhileClusterStoppedHelper.Call}
188 WATCHER_LOCK_FILE = LOCK_DIR + "/ganeti-watcher.lock"
190 #: Status file for per-group watcher, locked in exclusive mode by watcher
191 WATCHER_GROUP_STATE_FILE = DATA_DIR + "/watcher.%s.data"
193 #: File for per-group instance status, merged into L{INSTANCE_STATUS_FILE} by
194 #: per-group processes
195 WATCHER_GROUP_INSTANCE_STATUS_FILE = DATA_DIR + "/watcher.%s.instance-status"
197 #: File containing Unix timestamp until which watcher should be paused
198 WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
200 # Master IP address setup scripts paths (default and user-provided)
201 DEFAULT_MASTER_SETUP_SCRIPT = TOOLSDIR + "/master-ip-setup"
202 EXTERNAL_MASTER_SETUP_SCRIPT = USER_SCRIPTS_DIR + "/master-ip-setup"
204 ALL_CERT_FILES = frozenset([
211 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
213 NODED = "ganeti-noded"
214 CONFD = "ganeti-confd"
216 MASTERD = "ganeti-masterd"
217 # used in the ganeti-nbma project
221 # daemon-name: ("proto", "default-port")
222 NODED: ("tcp", 1811),
223 CONFD: ("udp", 1814),
226 # used in the ganeti-nbma project
229 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
230 DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
231 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
232 # used in the ganeti-nbma project
233 DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
235 FIRST_DRBD_PORT = 11000
236 LAST_DRBD_PORT = 14999
237 MASTER_SCRIPT = "ganeti-master"
239 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
241 # "daemon-name": "logfile"
242 NODED: LOG_DIR + "node-daemon.log",
243 CONFD: LOG_DIR + "conf-daemon.log",
244 RAPI: LOG_DIR + "rapi-daemon.log",
245 MASTERD: LOG_DIR + "master-daemon.log",
246 # used in the ganeti-nbma project
247 NLD: LOG_DIR + "nl-daemon.log",
250 LOG_OS_DIR = LOG_DIR + "os"
251 LOG_WATCHER = LOG_DIR + "watcher.log"
252 LOG_COMMANDS = LOG_DIR + "commands.log"
253 LOG_BURNIN = LOG_DIR + "burnin.log"
254 LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
256 DEV_CONSOLE = "/dev/console"
258 PROC_MOUNTS = "/proc/mounts"
260 # Local UniX Interface related constants
262 LUXI_VERSION = CONFIG_VERSION
264 # one of "no", "yes", "only"
265 SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
269 SYSLOG_SOCKET = "/dev/log"
271 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
272 EXPORT_DIR = _autoconf.EXPORT_DIR
274 EXPORT_CONF_FILE = "config.ini"
276 XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
277 XEN_KERNEL = _autoconf.XEN_KERNEL
278 XEN_INITRD = _autoconf.XEN_INITRD
281 KVM_PATH = _autoconf.KVM_PATH
282 SOCAT_PATH = _autoconf.SOCAT_PATH
283 SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
284 SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
285 SOCAT_ESCAPE_CODE = "0x1d"
287 #: Console as SSH command
290 #: Console as VNC server
293 #: Console as SPICE server
296 #: Display a message for console access
300 CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_SPICE, CONS_MESSAGE])
302 # For RSA keys more bits are better, but they also make operations more
303 # expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
307 # Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
308 # way to disable ciphers would be to use the exclamation mark (!), but socat
309 # versions below 1.5 can't parse exclamation marks in options properly. When
310 # modifying the ciphers, ensure not to accidentially add something after it's
311 # been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
312 # "openssl ciphers -v HIGH:-DES".
313 OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"
315 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
316 X509_CERT_SIGN_DIGEST = "SHA1"
318 # Default validity of certificates in days
319 X509_CERT_DEFAULT_VALIDITY = 365 * 5
321 # commonName (CN) used in certificates
322 X509_CERT_CN = "ganeti.example.com"
324 X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
326 IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
328 # Import/export daemon mode
329 IEM_IMPORT = "import"
330 IEM_EXPORT = "export"
332 # Import/export transport compression
335 IEC_ALL = frozenset([
340 IE_CUSTOM_SIZE = "fd"
342 IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")
345 # Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
347 # Raw block device I/O using "dd"
348 IEIO_RAW_DISK = "raw"
349 # OS definition import/export script
350 IEIO_SCRIPT = "script"
352 VALUE_DEFAULT = "default"
354 VALUE_GENERATE = "generate"
357 VALUE_FALSE = "false"
359 # External script validation mask
360 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
362 # hooks-related constants
363 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
364 HOOKS_PHASE_PRE = "pre"
365 HOOKS_PHASE_POST = "post"
366 HOOKS_NAME_CFGUPDATE = "config-update"
367 HOOKS_NAME_WATCHER = "watcher"
369 HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
371 # hooks subject type (what object type does the LU deal with)
372 HTYPE_CLUSTER = "CLUSTER"
374 HTYPE_GROUP = "GROUP"
375 HTYPE_INSTANCE = "INSTANCE"
387 # first two are valid in LU context only, not passed to backend
390 # and the rest are valid in backend
395 SF_ALLOCATABLE = "allocatable"
398 SO_FIX_CONSISTENCY = "fix-consistency"
400 # Available fields per storage type
401 VALID_STORAGE_FIELDS = frozenset([
410 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
412 MODIFIABLE_STORAGE_FIELDS = {
413 ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
416 VALID_STORAGE_OPERATIONS = {
417 ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
421 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
424 LDS_FAULTY) = range(1, 4)
426 # disk template types
427 DT_DISKLESS = "diskless"
431 DT_SHARED_FILE = "sharedfile"
432 DT_BLOCK = "blockdev"
434 # the set of network-mirrored disk templates
435 DTS_INT_MIRROR = frozenset([DT_DRBD8])
437 # the set of externally-mirrored disk templates (e.g. SAN, NAS)
438 DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK])
440 # the set of non-lvm-based disk templates
441 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE, DT_BLOCK])
443 # the set of disk templates which can be grown
444 DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE])
446 # the set of disk templates that allow adoption
447 DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])
449 # the set of disk templates that *must* use adoption
450 DTS_MUST_ADOPT = frozenset([DT_BLOCK])
452 # the set of disk templates that allow migrations
453 DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
455 # the set of file based disk templates
456 DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
462 LD_BLOCKDEV = "blockdev"
463 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV])
466 DRBD_HMAC_ALG = "md5"
467 DRBD_NET_PROTOCOL = "C"
468 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
470 # file backend driver
474 # the set of drbd-like disk types
475 LDS_DRBD = frozenset([LD_DRBD8])
480 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
482 # disk replacement mode
483 REPLACE_DISK_PRI = "replace_on_primary" # replace disks on primary
484 REPLACE_DISK_SEC = "replace_on_secondary" # replace disks on secondary
485 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
486 REPLACE_DISK_AUTO = "replace_auto"
487 REPLACE_MODES = frozenset([
494 # Instance export mode
495 EXPORT_MODE_LOCAL = "local"
496 EXPORT_MODE_REMOTE = "remote"
497 EXPORT_MODES = frozenset([
502 # Lock recalculate mode
503 LOCKS_REPLACE = "replace"
504 LOCKS_APPEND = "append"
506 # Lock timeout (sum) before we should go into blocking acquire (still
507 # can be reset by priority change); computed as max time (10 hours)
508 # before we should actually go into blocking acquire given that we
509 # start from default priority level; in seconds
510 LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
511 LOCK_ATTEMPTS_MAXWAIT = 15.0
512 LOCK_ATTEMPTS_MINWAIT = 1.0
514 # instance creation modes
515 INSTANCE_CREATE = "create"
516 INSTANCE_IMPORT = "import"
517 INSTANCE_REMOTE_IMPORT = "remote-import"
518 INSTANCE_CREATE_MODES = frozenset([
521 INSTANCE_REMOTE_IMPORT,
524 # Remote import/export handshake message and version
526 RIE_HANDSHAKE = "Hi, I'm Ganeti"
528 # Remote import/export certificate validity in seconds
529 RIE_CERT_VALIDITY = 24 * 60 * 60
531 # Overall timeout for establishing connection
532 RIE_CONNECT_TIMEOUT = 180
534 # Export only: how long to wait per connection attempt (seconds)
535 RIE_CONNECT_ATTEMPT_TIMEOUT = 20
537 # Export only: number of attempts to connect
538 RIE_CONNECT_RETRIES = 10
540 #: Give child process up to 5 seconds to exit after sending a signal
541 CHILD_LINGER_TIMEOUT = 5.0
543 DISK_TEMPLATES = frozenset([
552 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
554 # import/export config options
555 INISECT_EXP = "export"
556 INISECT_INS = "instance"
557 INISECT_HYP = "hypervisor"
558 INISECT_BEP = "backend"
561 # dynamic device modification
563 DDM_REMOVE = "remove"
564 DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
571 EXIT_NODESETUP_ERROR = 12
572 EXIT_CONFIRMATION = 13 # need user confirmation
574 #: Exit code for query operations with unknown fields
575 EXIT_UNKNOWN_FIELD = 14
578 TAG_CLUSTER = "cluster"
579 TAG_NODEGROUP = "nodegroup"
581 TAG_INSTANCE = "instance"
582 VALID_TAG_TYPES = frozenset([
589 MAX_TAGS_PER_OBJ = 4096
592 DEFAULT_BRIDGE = "xen-br0"
593 SYNC_SPEED = 60 * 1024
594 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
595 IP4_ADDRESS_ANY = "0.0.0.0"
596 IP6_ADDRESS_LOCALHOST = "::1"
597 IP6_ADDRESS_ANY = "::"
600 VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
601 TCP_PING_TIMEOUT = 10
602 GANETI_RUNAS = "root"
604 DEFAULT_DRBD_HELPER = "/bin/true"
606 DEFAULT_MAC_PREFIX = "aa:00:00"
607 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
608 # default maximum instance wait time, in seconds.
609 DEFAULT_SHUTDOWN_TIMEOUT = 120
610 NODE_MAX_CLOCK_SKEW = 150
611 # Time for an intra-cluster disk transfer to wait for a connection
612 DISK_TRANSFER_CONNECT_TIMEOUT = 60
613 # Disk index separator
614 DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
615 IP_COMMAND_PATH = _autoconf.IP_PATH
617 #: Key for job IDs in opcode result
623 RUNPARTS_ERR) = range(3)
625 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
629 RPC_ENCODING_ZLIB_BASE64) = range(2)
631 # os related constants
632 OS_SCRIPT_CREATE = "create"
633 OS_SCRIPT_IMPORT = "import"
634 OS_SCRIPT_EXPORT = "export"
635 OS_SCRIPT_RENAME = "rename"
636 OS_SCRIPT_VERIFY = "verify"
637 OS_SCRIPTS = frozenset([
645 OS_API_FILE = "ganeti_api_version"
646 OS_VARIANTS_FILE = "variants.list"
647 OS_PARAMETERS_FILE = "parameters.list"
649 OS_VALIDATE_PARAMETERS = "parameters"
650 OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
653 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
654 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
655 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
656 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
657 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
662 INSTANCE_REBOOT_SOFT = "soft"
663 INSTANCE_REBOOT_HARD = "hard"
664 INSTANCE_REBOOT_FULL = "full"
666 REBOOT_TYPES = frozenset([
667 INSTANCE_REBOOT_SOFT,
668 INSTANCE_REBOOT_HARD,
672 # instance reboot behaviors
673 INSTANCE_REBOOT_ALLOWED = "reboot"
674 INSTANCE_REBOOT_EXIT = "exit"
676 REBOOT_BEHAVIORS = frozenset([
677 INSTANCE_REBOOT_ALLOWED,
681 VTYPE_STRING = "string"
682 VTYPE_MAYBE_STRING = "maybe-string"
684 VTYPE_SIZE = "size" # size, in MiBs
686 ENFORCEABLE_TYPES = frozenset([
694 # Constant representing that the user does not specify any IP version
695 IFACE_NO_IP_VERSION_SPECIFIED = 0
697 # HV parameter names (global namespace)
698 HV_BOOT_ORDER = "boot_order"
699 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
700 HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
701 HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
702 HV_NIC_TYPE = "nic_type"
703 HV_DISK_TYPE = "disk_type"
704 HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
705 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
706 HV_VNC_PASSWORD_FILE = "vnc_password_file"
707 HV_VNC_TLS = "vnc_tls"
708 HV_VNC_X509 = "vnc_x509_path"
709 HV_VNC_X509_VERIFY = "vnc_x509_verify"
710 HV_KVM_SPICE_BIND = "spice_bind"
711 HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
712 HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
713 HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
714 HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
715 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
716 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
717 HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
718 HV_KVM_SPICE_USE_TLS = "spice_use_tls"
719 HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
720 HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
723 HV_USE_BOOTLOADER = "use_bootloader"
724 HV_BOOTLOADER_ARGS = "bootloader_args"
725 HV_BOOTLOADER_PATH = "bootloader_path"
726 HV_KERNEL_ARGS = "kernel_args"
727 HV_KERNEL_PATH = "kernel_path"
728 HV_INITRD_PATH = "initrd_path"
729 HV_ROOT_PATH = "root_path"
730 HV_SERIAL_CONSOLE = "serial_console"
731 HV_USB_MOUSE = "usb_mouse"
733 HV_DEVICE_MODEL = "device_model"
734 HV_INIT_SCRIPT = "init_script"
735 HV_MIGRATION_PORT = "migration_port"
736 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
737 HV_MIGRATION_DOWNTIME = "migration_downtime"
738 HV_MIGRATION_MODE = "migration_mode"
739 HV_USE_LOCALTIME = "use_localtime"
740 HV_DISK_CACHE = "disk_cache"
741 HV_SECURITY_MODEL = "security_model"
742 HV_SECURITY_DOMAIN = "security_domain"
743 HV_KVM_FLAG = "kvm_flag"
744 HV_VHOST_NET = "vhost_net"
745 HV_KVM_USE_CHROOT = "use_chroot"
746 HV_CPU_MASK = "cpu_mask"
747 HV_MEM_PATH = "mem_path"
748 HV_BLOCKDEV_PREFIX = "blockdev_prefix"
749 HV_REBOOT_BEHAVIOR = "reboot_behavior"
751 HVS_PARAMETER_TYPES = {
752 HV_BOOT_ORDER: VTYPE_STRING,
753 HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
754 HV_CDROM_IMAGE_PATH: VTYPE_STRING,
755 HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
756 HV_NIC_TYPE: VTYPE_STRING,
757 HV_DISK_TYPE: VTYPE_STRING,
758 HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
759 HV_VNC_PASSWORD_FILE: VTYPE_STRING,
760 HV_VNC_BIND_ADDRESS: VTYPE_STRING,
761 HV_VNC_TLS: VTYPE_BOOL,
762 HV_VNC_X509: VTYPE_STRING,
763 HV_VNC_X509_VERIFY: VTYPE_BOOL,
764 HV_KVM_SPICE_BIND: VTYPE_STRING,
765 HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
766 HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
767 HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
768 HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
769 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
770 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
771 HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
772 HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
773 HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
774 HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
777 HV_USE_BOOTLOADER: VTYPE_BOOL,
778 HV_BOOTLOADER_PATH: VTYPE_STRING,
779 HV_BOOTLOADER_ARGS: VTYPE_STRING,
780 HV_KERNEL_PATH: VTYPE_STRING,
781 HV_KERNEL_ARGS: VTYPE_STRING,
782 HV_INITRD_PATH: VTYPE_STRING,
783 HV_ROOT_PATH: VTYPE_MAYBE_STRING,
784 HV_SERIAL_CONSOLE: VTYPE_BOOL,
785 HV_USB_MOUSE: VTYPE_STRING,
786 HV_KEYMAP: VTYPE_STRING,
787 HV_DEVICE_MODEL: VTYPE_STRING,
788 HV_INIT_SCRIPT: VTYPE_STRING,
789 HV_MIGRATION_PORT: VTYPE_INT,
790 HV_MIGRATION_BANDWIDTH: VTYPE_INT,
791 HV_MIGRATION_DOWNTIME: VTYPE_INT,
792 HV_MIGRATION_MODE: VTYPE_STRING,
793 HV_USE_LOCALTIME: VTYPE_BOOL,
794 HV_DISK_CACHE: VTYPE_STRING,
795 HV_SECURITY_MODEL: VTYPE_STRING,
796 HV_SECURITY_DOMAIN: VTYPE_STRING,
797 HV_KVM_FLAG: VTYPE_STRING,
798 HV_VHOST_NET: VTYPE_BOOL,
799 HV_KVM_USE_CHROOT: VTYPE_BOOL,
800 HV_CPU_MASK: VTYPE_STRING,
801 HV_MEM_PATH: VTYPE_STRING,
802 HV_BLOCKDEV_PREFIX: VTYPE_STRING,
803 HV_REBOOT_BEHAVIOR: VTYPE_STRING,
806 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
809 HV_MIGRATION_COMPLETED = "completed"
810 HV_MIGRATION_ACTIVE = "active"
811 HV_MIGRATION_FAILED = "failed"
812 HV_MIGRATION_CANCELLED = "cancelled"
814 HV_MIGRATION_VALID_STATUSES = frozenset([
815 HV_MIGRATION_COMPLETED,
818 HV_MIGRATION_CANCELLED,
821 HV_MIGRATION_FAILED_STATUSES = frozenset([
823 HV_MIGRATION_CANCELLED,
826 # KVM-specific statuses
827 HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
830 HV_NODEINFO_KEY_VERSION = "hv_version"
833 HVST_MEMORY_TOTAL = "mem_total"
834 HVST_MEMORY_NODE = "mem_node"
835 HVST_MEMORY_HV = "mem_hv"
836 HVST_CPU_TOTAL = "cpu_total"
837 HVST_CPU_NODE = "cpu_node"
839 HVSTS_PARAMETER_TYPES = {
840 HVST_MEMORY_TOTAL: VTYPE_INT,
841 HVST_MEMORY_NODE: VTYPE_INT,
842 HVST_MEMORY_HV: VTYPE_INT,
843 HVST_CPU_TOTAL: VTYPE_INT,
844 HVST_CPU_NODE: VTYPE_INT,
847 HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
850 DS_DISK_TOTAL = "disk_total"
851 DS_DISK_RESERVED = "disk_reserved"
852 DS_DISK_OVERHEAD = "disk_overhead"
854 DSS_PARAMETER_TYPES = {
855 DS_DISK_TOTAL: VTYPE_INT,
856 DS_DISK_RESERVED: VTYPE_INT,
857 DS_DISK_OVERHEAD: VTYPE_INT,
860 DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
862 # Backend parameter names
865 BE_AUTO_BALANCE = "auto_balance"
867 BES_PARAMETER_TYPES = {
868 BE_MEMORY: VTYPE_SIZE,
870 BE_AUTO_BALANCE: VTYPE_BOOL,
873 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
875 # Node parameter names
876 ND_OOB_PROGRAM = "oob_program"
878 NDS_PARAMETER_TYPES = {
879 ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
882 NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
884 # OOB supported commands
885 OOB_POWER_ON = "power-on"
886 OOB_POWER_OFF = "power-off"
887 OOB_POWER_CYCLE = "power-cycle"
888 OOB_POWER_STATUS = "power-status"
889 OOB_HEALTH = "health"
891 OOB_COMMANDS = frozenset([
899 OOB_POWER_STATUS_POWERED = "powered"
901 OOB_TIMEOUT = 60 # 60 seconds
902 OOB_POWER_DELAY = 2.0 # 2 seconds
905 OOB_STATUS_WARNING = "WARNING"
906 OOB_STATUS_CRITICAL = "CRITICAL"
907 OOB_STATUS_UNKNOWN = "UNKNOWN"
909 OOB_STATUSES = frozenset([
916 # Instance Parameters Profile
917 PP_DEFAULT = "default"
919 # NIC_* constants are used inside the ganeti config
923 NIC_MODE_BRIDGED = "bridged"
924 NIC_MODE_ROUTED = "routed"
926 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
928 NICS_PARAMETER_TYPES = {
929 NIC_MODE: VTYPE_STRING,
930 NIC_LINK: VTYPE_STRING,
933 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
935 # IDISK_* constants are used in opcodes, to create/change disks
938 IDISK_ADOPT = "adopt"
940 IDISK_METAVG = "metavg"
941 IDISK_PARAMS_TYPES = {
942 IDISK_SIZE: VTYPE_SIZE,
943 IDISK_MODE: VTYPE_STRING,
944 IDISK_ADOPT: VTYPE_STRING,
945 IDISK_VG: VTYPE_STRING,
946 IDISK_METAVG: VTYPE_STRING,
948 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
950 # INIC_* constants are used in opcodes, to create/change nics
955 INIC_PARAMS_TYPES = {
956 INIC_IP: VTYPE_MAYBE_STRING,
957 INIC_LINK: VTYPE_STRING,
958 INIC_MAC: VTYPE_STRING,
959 INIC_MODE: VTYPE_STRING,
961 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
963 # Hypervisor constants
964 HT_XEN_PVM = "xen-pvm"
966 HT_XEN_HVM = "xen-hvm"
970 HYPER_TYPES = frozenset([
978 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
981 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
982 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
985 HT_NIC_RTL8139 = "rtl8139"
986 HT_NIC_NE2K_PCI = "ne2k_pci"
987 HT_NIC_NE2K_ISA = "ne2k_isa"
988 HT_NIC_I82551 = "i82551"
989 HT_NIC_I85557B = "i82557b"
990 HT_NIC_I8259ER = "i82559er"
991 HT_NIC_PCNET = "pcnet"
992 HT_NIC_E1000 = "e1000"
993 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
995 HT_HVM_VALID_NIC_TYPES = frozenset([
1002 HT_KVM_VALID_NIC_TYPES = frozenset([
1015 HT_DISK_IOEMU = "ioemu"
1017 HT_DISK_SCSI = "scsi"
1020 HT_DISK_PFLASH = "pflash"
1022 HT_CACHE_DEFAULT = "default"
1023 HT_CACHE_NONE = "none"
1024 HT_CACHE_WTHROUGH = "writethrough"
1025 HT_CACHE_WBACK = "writeback"
1026 HT_VALID_CACHE_TYPES = frozenset([
1033 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1034 HT_KVM_VALID_DISK_TYPES = frozenset([
1035 HT_DISK_PARAVIRTUAL,
1044 HT_MOUSE_MOUSE = "mouse"
1045 HT_MOUSE_TABLET = "tablet"
1047 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1050 HT_BO_FLOPPY = "floppy"
1051 HT_BO_CDROM = "cdrom"
1053 HT_BO_NETWORK = "network"
1055 HT_KVM_VALID_BO_TYPES = frozenset([
1062 # SPICE lossless image compression options
1063 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1064 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1065 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1066 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1067 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1068 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1070 HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1071 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1072 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1073 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1074 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1075 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1076 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1079 # SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1080 HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1081 HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1082 HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1084 HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1085 HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1086 HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1087 HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1090 # SPICE video stream detection
1091 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1092 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1093 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1095 HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1096 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1097 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1098 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1106 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1109 HT_KVM_ENABLED = "enabled"
1110 HT_KVM_DISABLED = "disabled"
1112 HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1115 HT_MIGRATION_LIVE = "live"
1116 HT_MIGRATION_NONLIVE = "non-live"
1117 HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1119 # Cluster Verify steps
1120 VERIFY_NPLUSONE_MEM = "nplusone_mem"
1121 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1123 # Cluster Verify error classes
1124 CV_TCLUSTER = "cluster"
1126 CV_TINSTANCE = "instance"
1128 # Cluster Verify error codes and documentation
1130 (CV_TCLUSTER, "ECLUSTERCFG", "Cluster configuration verification failure")
1132 (CV_TCLUSTER, "ECLUSTERCERT",
1133 "Cluster certificate files verification failure")
1134 CV_ECLUSTERFILECHECK = \
1135 (CV_TCLUSTER, "ECLUSTERFILECHECK",
1136 "Cluster configuration verification failure")
1137 CV_ECLUSTERDANGLINGNODES = \
1138 (CV_TNODE, "ECLUSTERDANGLINGNODES",
1139 "Some nodes belong to non-existing groups")
1140 CV_ECLUSTERDANGLINGINST = \
1141 (CV_TNODE, "ECLUSTERDANGLINGINST",
1142 "Some instances have a non-existing primary node")
1143 CV_EINSTANCEBADNODE = \
1144 (CV_TINSTANCE, "EINSTANCEBADNODE",
1145 "Instance marked as running lives on an offline node")
1146 CV_EINSTANCEDOWN = \
1147 (CV_TINSTANCE, "EINSTANCEDOWN", "Instance not running on its primary node")
1148 CV_EINSTANCELAYOUT = \
1149 (CV_TINSTANCE, "EINSTANCELAYOUT", "Instance has multiple secondary nodes")
1150 CV_EINSTANCEMISSINGDISK = \
1151 (CV_TINSTANCE, "EINSTANCEMISSINGDISK", "Missing volume on an instance")
1152 CV_EINSTANCEFAULTYDISK = \
1153 (CV_TINSTANCE, "EINSTANCEFAULTYDISK",
1154 "Impossible to retrieve status for a disk")
1155 CV_EINSTANCEWRONGNODE = \
1156 (CV_TINSTANCE, "EINSTANCEWRONGNODE", "Instance running on the wrong node")
1157 CV_EINSTANCESPLITGROUPS = \
1158 (CV_TINSTANCE, "EINSTANCESPLITGROUPS",
1159 "Instance with primary and secondary nodes in different groups")
1161 (CV_TNODE, "ENODEDRBD", "Error parsing the DRBD status file")
1162 CV_ENODEDRBDHELPER = \
1163 (CV_TNODE, "ENODEDRBDHELPER", "Error caused by the DRBD helper")
1164 CV_ENODEFILECHECK = \
1165 (CV_TNODE, "ENODEFILECHECK",
1166 "Error retrieving the checksum of the node files")
1168 (CV_TNODE, "ENODEHOOKS", "Communication failure in hooks execution")
1170 (CV_TNODE, "ENODEHV", "Hypervisor parameters verification failure")
1172 (CV_TNODE, "ENODELVM", "LVM-related node error")
1174 (CV_TNODE, "ENODEN1", "Not enough memory to accommodate instance failovers")
1176 (CV_TNODE, "ENODENET", "Network-related node error")
1178 (CV_TNODE, "ENODEOS", "OS-related node error")
1179 CV_ENODEORPHANINSTANCE = \
1180 (CV_TNODE, "ENODEORPHANINSTANCE", "Unknown intance running on a node")
1181 CV_ENODEORPHANLV = \
1182 (CV_TNODE, "ENODEORPHANLV", "Unknown LVM logical volume")
1184 (CV_TNODE, "ENODERPC",
1185 "Error during connection to the primary node of an instance")
1187 (CV_TNODE, "ENODESSH", "SSH-related node error")
1189 (CV_TNODE, "ENODEVERSION",
1190 "Protocol version mismatch or Ganeti version mismatch")
1192 (CV_TNODE, "ENODESETUP", "Node setup error")
1194 (CV_TNODE, "ENODETIME", "Node returned invalid time")
1196 (CV_TNODE, "ENODEOOBPATH", "Invalid Out Of Band path")
1197 CV_ENODEUSERSCRIPTS = \
1198 (CV_TNODE, "ENODEUSERSCRIPTS", "User scripts not present or not executable")
1200 CV_ALL_ECODES = frozenset([
1203 CV_ECLUSTERFILECHECK,
1204 CV_ECLUSTERDANGLINGNODES,
1205 CV_ECLUSTERDANGLINGINST,
1206 CV_EINSTANCEBADNODE,
1209 CV_EINSTANCEMISSINGDISK,
1210 CV_EINSTANCEFAULTYDISK,
1211 CV_EINSTANCEWRONGNODE,
1212 CV_EINSTANCESPLITGROUPS,
1222 CV_ENODEORPHANINSTANCE,
1230 CV_ENODEUSERSCRIPTS,
1233 CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1235 # Node verify constants
1236 NV_DRBDHELPER = "drbd-helper"
1237 NV_DRBDLIST = "drbd-list"
1238 NV_FILELIST = "filelist"
1239 NV_HVINFO = "hvinfo"
1240 NV_HYPERVISOR = "hypervisor"
1241 NV_HVPARAMS = "hvparms"
1242 NV_INSTANCELIST = "instancelist"
1243 NV_LVLIST = "lvlist"
1244 NV_MASTERIP = "master-ip"
1245 NV_NODELIST = "nodelist"
1246 NV_NODENETTEST = "node-net-test"
1247 NV_NODESETUP = "nodesetup"
1248 NV_OSLIST = "oslist"
1249 NV_PVLIST = "pvlist"
1251 NV_VERSION = "version"
1252 NV_VGLIST = "vglist"
1253 NV_VMNODES = "vmnodes"
1254 NV_OOB_PATHS = "oob-paths"
1255 NV_BRIDGES = "bridges"
1256 NV_USERSCRIPTS = "user-scripts"
1259 INSTST_RUNNING = "running"
1260 INSTST_ADMINDOWN = "ADMIN_down"
1261 INSTST_ADMINOFFLINE = "ADMIN_offline"
1262 INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1263 INSTST_NODEDOWN = "ERROR_nodedown"
1264 INSTST_WRONGNODE = "ERROR_wrongnode"
1265 INSTST_ERRORUP = "ERROR_up"
1266 INSTST_ERRORDOWN = "ERROR_down"
1267 INSTST_ALL = frozenset([
1270 INSTST_ADMINOFFLINE,
1280 ADMINST_DOWN = "down"
1281 ADMINST_OFFLINE = "offline"
1282 ADMINST_ALL = frozenset([
1294 NR_ALL = frozenset([
1302 # SSL certificate check constants (in days)
1303 SSL_CERT_EXPIRATION_WARN = 30
1304 SSL_CERT_EXPIRATION_ERROR = 7
1306 # Allocator framework constants
1307 IALLOCATOR_VERSION = 2
1308 IALLOCATOR_DIR_IN = "in"
1309 IALLOCATOR_DIR_OUT = "out"
1310 VALID_IALLOCATOR_DIRECTIONS = frozenset([
1314 IALLOCATOR_MODE_ALLOC = "allocate"
1315 IALLOCATOR_MODE_RELOC = "relocate"
1316 IALLOCATOR_MODE_CHG_GROUP = "change-group"
1317 IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1318 VALID_IALLOCATOR_MODES = frozenset([
1319 IALLOCATOR_MODE_ALLOC,
1320 IALLOCATOR_MODE_RELOC,
1321 IALLOCATOR_MODE_CHG_GROUP,
1322 IALLOCATOR_MODE_NODE_EVAC,
1324 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1326 IALLOCATOR_NEVAC_PRI = "primary-only"
1327 IALLOCATOR_NEVAC_SEC = "secondary-only"
1328 IALLOCATOR_NEVAC_ALL = "all"
1329 IALLOCATOR_NEVAC_MODES = frozenset([
1330 IALLOCATOR_NEVAC_PRI,
1331 IALLOCATOR_NEVAC_SEC,
1332 IALLOCATOR_NEVAC_ALL,
1336 JOB_QUEUE_VERSION = 1
1337 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1338 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1339 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1340 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1341 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1342 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1343 JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
1344 JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
1346 JOB_ID_TEMPLATE = r"\d+"
1347 JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1349 # unchanged job return
1350 JOB_NOTCHANGED = "nochange"
1353 JOB_STATUS_QUEUED = "queued"
1354 JOB_STATUS_WAITING = "waiting"
1355 JOB_STATUS_CANCELING = "canceling"
1356 JOB_STATUS_RUNNING = "running"
1357 JOB_STATUS_CANCELED = "canceled"
1358 JOB_STATUS_SUCCESS = "success"
1359 JOB_STATUS_ERROR = "error"
1360 JOBS_FINALIZED = frozenset([
1361 JOB_STATUS_CANCELED,
1365 JOB_STATUS_ALL = frozenset([
1368 JOB_STATUS_CANCELING,
1374 OP_STATUS_QUEUED = "queued"
1375 OP_STATUS_WAITING = "waiting"
1376 OP_STATUS_CANCELING = "canceling"
1377 OP_STATUS_RUNNING = "running"
1379 OP_STATUS_CANCELED = "canceled"
1380 OP_STATUS_SUCCESS = "success"
1381 OP_STATUS_ERROR = "error"
1382 OPS_FINALIZED = frozenset([
1389 OP_PRIO_LOWEST = +19
1390 OP_PRIO_HIGHEST = -20
1396 OP_PRIO_SUBMIT_VALID = frozenset([
1402 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1404 # Execution log types
1405 ELOG_MESSAGE = "message"
1406 ELOG_PROGRESS = "progress"
1407 ELOG_REMOTE_IMPORT = "remote-import"
1408 ELOG_JQUEUE_TEST = "jqueue-test"
1410 # /etc/hosts modification
1411 ETC_HOSTS_ADD = "add"
1412 ETC_HOSTS_REMOVE = "remove"
1415 JQT_MSGPREFIX = "TESTMSG="
1416 JQT_EXPANDNAMES = "expandnames"
1418 JQT_LOGMSG = "logmsg"
1419 JQT_STARTMSG = "startmsg"
1420 JQT_ALL = frozenset([
1428 QR_INSTANCE = "instance"
1434 #: List of resources which can be queried using L{opcodes.OpQuery}
1435 QR_VIA_OP = frozenset([QR_INSTANCE, QR_NODE, QR_GROUP, QR_OS])
1437 #: List of resources which can be queried using Local UniX Interface
1438 QR_VIA_LUXI = QR_VIA_OP.union([
1442 #: List of resources which can be queried using RAPI
1443 QR_VIA_RAPI = QR_VIA_LUXI
1446 QFT_UNKNOWN = "unknown"
1449 QFT_NUMBER = "number"
1451 QFT_TIMESTAMP = "timestamp"
1454 #: All query field types
1455 QFT_ALL = frozenset([
1465 # Query result field status (don't change or reuse values as they're used by
1467 #: Normal field status
1471 #: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1473 #: Value unavailable/unsupported for item; if this field is supported
1474 #: but we cannot get the data for the moment, RS_NODATA or
1475 #: RS_OFFLINE should be used
1477 #: Resource marked offline
1480 RS_ALL = frozenset([
1488 #: Dictionary with special field cases and their verbose/terse formatting
1490 RS_UNKNOWN: ("(unknown)", "??"),
1491 RS_NODATA: ("(nodata)", "?"),
1492 RS_OFFLINE: ("(offline)", "*"),
1493 RS_UNAVAIL: ("(unavail)", "-"),
1496 # max dynamic devices
1501 SS_CLUSTER_NAME = "cluster_name"
1502 SS_CLUSTER_TAGS = "cluster_tags"
1503 SS_FILE_STORAGE_DIR = "file_storage_dir"
1504 SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1505 SS_MASTER_CANDIDATES = "master_candidates"
1506 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1507 SS_MASTER_IP = "master_ip"
1508 SS_MASTER_NETDEV = "master_netdev"
1509 SS_MASTER_NETMASK = "master_netmask"
1510 SS_MASTER_NODE = "master_node"
1511 SS_NODE_LIST = "node_list"
1512 SS_NODE_PRIMARY_IPS = "node_primary_ips"
1513 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1514 SS_OFFLINE_NODES = "offline_nodes"
1515 SS_ONLINE_NODES = "online_nodes"
1516 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1517 SS_INSTANCE_LIST = "instance_list"
1518 SS_RELEASE_VERSION = "release_version"
1519 SS_HYPERVISOR_LIST = "hypervisor_list"
1520 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1521 SS_UID_POOL = "uid_pool"
1522 SS_NODEGROUPS = "nodegroups"
1524 SS_FILE_PERMS = 0444
1526 # cluster wide default parameters
1527 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1531 HV_USE_BOOTLOADER: False,
1532 HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1533 HV_BOOTLOADER_ARGS: "",
1534 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1536 HV_ROOT_PATH: "/dev/sda1",
1537 HV_KERNEL_ARGS: "ro",
1538 HV_MIGRATION_PORT: 8002,
1539 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1540 HV_BLOCKDEV_PREFIX: "sd",
1541 HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1542 HV_CPU_MASK: CPU_PINNING_ALL,
1545 HV_BOOT_ORDER: "cd",
1546 HV_CDROM_IMAGE_PATH: "",
1547 HV_NIC_TYPE: HT_NIC_RTL8139,
1548 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1549 HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1550 HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1553 HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1554 HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1555 HV_MIGRATION_PORT: 8002,
1556 HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1557 HV_USE_LOCALTIME: False,
1558 HV_BLOCKDEV_PREFIX: "hd",
1559 HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1560 HV_CPU_MASK: CPU_PINNING_ALL,
1563 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1565 HV_KERNEL_ARGS: "ro",
1566 HV_ROOT_PATH: "/dev/vda1",
1568 HV_SERIAL_CONSOLE: True,
1569 HV_VNC_BIND_ADDRESS: "",
1572 HV_VNC_X509_VERIFY: False,
1573 HV_VNC_PASSWORD_FILE: "",
1574 HV_KVM_SPICE_BIND: "",
1575 HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1576 HV_KVM_SPICE_PASSWORD_FILE: "",
1577 HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1578 HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1579 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1580 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1581 HV_KVM_SPICE_AUDIO_COMPR: True,
1582 HV_KVM_SPICE_USE_TLS: False,
1583 HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1584 HV_KVM_SPICE_USE_VDAGENT: True,
1585 HV_KVM_FLOPPY_IMAGE_PATH: "",
1586 HV_CDROM_IMAGE_PATH: "",
1587 HV_KVM_CDROM2_IMAGE_PATH: "",
1588 HV_BOOT_ORDER: HT_BO_DISK,
1589 HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1590 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1591 HV_KVM_CDROM_DISK_TYPE: "",
1594 HV_MIGRATION_PORT: 8102,
1595 HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1596 HV_MIGRATION_DOWNTIME: 30, # ms
1597 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1598 HV_USE_LOCALTIME: False,
1599 HV_DISK_CACHE: HT_CACHE_DEFAULT,
1600 HV_SECURITY_MODEL: HT_SM_NONE,
1601 HV_SECURITY_DOMAIN: "",
1603 HV_VHOST_NET: False,
1604 HV_KVM_USE_CHROOT: False,
1606 HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1607 HV_CPU_MASK: CPU_PINNING_ALL,
1612 HV_INIT_SCRIPT: "/ganeti-chroot",
1619 HVC_GLOBALS = frozenset([
1621 HV_MIGRATION_BANDWIDTH,
1628 BE_AUTO_BALANCE: True,
1632 ND_OOB_PROGRAM: None,
1636 NIC_MODE: NIC_MODE_BRIDGED,
1637 NIC_LINK: DEFAULT_BRIDGE,
1640 MASTER_POOL_SIZE_DEFAULT = 10
1642 CONFD_PROTOCOL_VERSION = 1
1645 CONFD_REQ_NODE_ROLE_BYNAME = 1
1646 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1647 CONFD_REQ_CLUSTER_MASTER = 3
1648 CONFD_REQ_NODE_PIP_LIST = 4
1649 CONFD_REQ_MC_PIP_LIST = 5
1650 CONFD_REQ_INSTANCES_IPS_LIST = 6
1652 # Confd request query fields. These are used to narrow down queries.
1653 # These must be strings rather than integers, because json-encoding
1654 # converts them to strings anyway, as they're used as dict-keys.
1655 CONFD_REQQ_LINK = "0"
1657 CONFD_REQQ_IPLIST = "2"
1658 CONFD_REQQ_FIELDS = "3"
1660 CONFD_REQFIELD_NAME = "0"
1661 CONFD_REQFIELD_IP = "1"
1662 CONFD_REQFIELD_MNODE_PIP = "2"
1664 CONFD_REQS = frozenset([
1666 CONFD_REQ_NODE_ROLE_BYNAME,
1667 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1668 CONFD_REQ_CLUSTER_MASTER,
1669 CONFD_REQ_NODE_PIP_LIST,
1670 CONFD_REQ_MC_PIP_LIST,
1671 CONFD_REQ_INSTANCES_IPS_LIST,
1674 CONFD_REPL_STATUS_OK = 0
1675 CONFD_REPL_STATUS_ERROR = 1
1676 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1678 CONFD_REPL_STATUSES = frozenset([
1679 CONFD_REPL_STATUS_OK,
1680 CONFD_REPL_STATUS_ERROR,
1681 CONFD_REPL_STATUS_NOTIMPLEMENTED,
1684 (CONFD_NODE_ROLE_MASTER,
1685 CONFD_NODE_ROLE_CANDIDATE,
1686 CONFD_NODE_ROLE_OFFLINE,
1687 CONFD_NODE_ROLE_DRAINED,
1688 CONFD_NODE_ROLE_REGULAR,
1691 # A few common errors for confd
1692 CONFD_ERROR_UNKNOWN_ENTRY = 1
1693 CONFD_ERROR_INTERNAL = 2
1694 CONFD_ERROR_ARGUMENT = 3
1696 # Each request is "salted" by the current timestamp.
1697 # This constants decides how many seconds of skew to accept.
1698 # TODO: make this a default and allow the value to be more configurable
1699 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1701 # When we haven't reloaded the config for more than this amount of seconds, we
1702 # force a test to see if inotify is betraying us.
1703 CONFD_CONFIG_RELOAD_TIMEOUT = 60
1705 # If we receive more than one update in this amount of seconds, we move to
1706 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
1707 # to serve more requests.
1708 CONFD_CONFIG_RELOAD_RATELIMIT = 2
1710 # Magic number prepended to all confd queries.
1711 # This allows us to distinguish different types of confd protocols and handle
1712 # them. For example by changing this we can move the whole payload to be
1713 # compressed, or move away from json.
1714 CONFD_MAGIC_FOURCC = "plj0"
1716 # By default a confd request is sent to the minimum between this number and all
1717 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
1718 # we should have enough answers to be able to compare more than one.
1719 CONFD_DEFAULT_REQ_COVERAGE = 6
1721 # Timeout in seconds to expire pending query request in the confd client
1722 # library. We don't actually expect any answer more than 10 seconds after we
1724 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1726 # Maximum UDP datagram size.
1727 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1728 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1729 # (assuming we can't use jumbo frames)
1730 # We just set this to 60K, which should be enough
1731 MAX_UDP_DATA_SIZE = 61440
1733 # User-id pool minimum/maximum acceptable user-ids.
1735 UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
1737 # Name or path of the pgrep command
1740 # Name of the node group that gets created at cluster init or upgrade
1741 INITIAL_NODE_GROUP_NAME = "default"
1743 # Possible values for NodeGroup.alloc_policy
1744 ALLOC_POLICY_PREFERRED = "preferred"
1745 ALLOC_POLICY_LAST_RESORT = "last_resort"
1746 ALLOC_POLICY_UNALLOCABLE = "unallocable"
1747 VALID_ALLOC_POLICIES = [
1748 ALLOC_POLICY_PREFERRED,
1749 ALLOC_POLICY_LAST_RESORT,
1750 ALLOC_POLICY_UNALLOCABLE,
1753 # Temporary external/shared storage parameters
1754 BLOCKDEV_DRIVER_MANUAL = "manual"
1756 # qemu-img path, required for ovfconverter
1757 QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
1759 # Whether htools was enabled at compilation time
1760 HTOOLS = _autoconf.HTOOLS
1761 # The hail iallocator
1762 IALLOC_HAIL = "hail"
1764 # Fake opcodes for functions that have hooks attached to them via
1765 # backend.RunLocalHooks
1766 FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
1767 FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
1769 # Do not re-export imported modules
1770 del re, _vcsversion, _autoconf