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"
184 #: Lock file for watcher, locked in shared mode by watcher; lock in exclusive
185 # mode to block watcher (see L{cli._RunWhileClusterStoppedHelper.Call}
186 WATCHER_LOCK_FILE = LOCK_DIR + "/ganeti-watcher.lock"
188 #: Status file for per-group watcher, locked in exclusive mode by watcher
189 WATCHER_GROUP_STATE_FILE = DATA_DIR + "/watcher.%s.data"
191 #: File for per-group instance status, merged into L{INSTANCE_STATUS_FILE} by
192 #: per-group processes
193 WATCHER_GROUP_INSTANCE_STATUS_FILE = DATA_DIR + "/watcher.%s.instance-status"
195 #: File containing Unix timestamp until which watcher should be paused
196 WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
198 ALL_CERT_FILES = frozenset([
205 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
207 NODED = "ganeti-noded"
208 CONFD = "ganeti-confd"
210 MASTERD = "ganeti-masterd"
211 # used in the ganeti-nbma project
215 # daemon-name: ("proto", "default-port")
216 NODED: ("tcp", 1811),
217 CONFD: ("udp", 1814),
220 # used in the ganeti-nbma project
223 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
224 DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
225 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
226 # used in the ganeti-nbma project
227 DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
229 FIRST_DRBD_PORT = 11000
230 LAST_DRBD_PORT = 14999
231 MASTER_SCRIPT = "ganeti-master"
233 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
235 # "daemon-name": "logfile"
236 NODED: LOG_DIR + "node-daemon.log",
237 CONFD: LOG_DIR + "conf-daemon.log",
238 RAPI: LOG_DIR + "rapi-daemon.log",
239 MASTERD: LOG_DIR + "master-daemon.log",
240 # used in the ganeti-nbma project
241 NLD: LOG_DIR + "nl-daemon.log",
244 LOG_OS_DIR = LOG_DIR + "os"
245 LOG_WATCHER = LOG_DIR + "watcher.log"
246 LOG_COMMANDS = LOG_DIR + "commands.log"
247 LOG_BURNIN = LOG_DIR + "burnin.log"
248 LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
250 DEV_CONSOLE = "/dev/console"
252 PROC_MOUNTS = "/proc/mounts"
254 # Local UniX Interface related constants
256 LUXI_VERSION = CONFIG_VERSION
258 # one of "no", "yes", "only"
259 SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
263 SYSLOG_SOCKET = "/dev/log"
265 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
266 EXPORT_DIR = _autoconf.EXPORT_DIR
268 EXPORT_CONF_FILE = "config.ini"
270 XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
271 XEN_KERNEL = _autoconf.XEN_KERNEL
272 XEN_INITRD = _autoconf.XEN_INITRD
275 KVM_PATH = _autoconf.KVM_PATH
276 SOCAT_PATH = _autoconf.SOCAT_PATH
277 SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
278 SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
279 SOCAT_ESCAPE_CODE = "0x1d"
281 #: Console as SSH command
284 #: Console as VNC server
287 #: Console as SPICE server
290 #: Display a message for console access
294 CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_SPICE, CONS_MESSAGE])
296 # For RSA keys more bits are better, but they also make operations more
297 # expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
301 # Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
302 # way to disable ciphers would be to use the exclamation mark (!), but socat
303 # versions below 1.5 can't parse exclamation marks in options properly. When
304 # modifying the ciphers, ensure not to accidentially add something after it's
305 # been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
306 # "openssl ciphers -v HIGH:-DES".
307 OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"
309 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
310 X509_CERT_SIGN_DIGEST = "SHA1"
312 # Default validity of certificates in days
313 X509_CERT_DEFAULT_VALIDITY = 365 * 5
315 # commonName (CN) used in certificates
316 X509_CERT_CN = "ganeti.example.com"
318 X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
320 IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
322 # Import/export daemon mode
323 IEM_IMPORT = "import"
324 IEM_EXPORT = "export"
326 # Import/export transport compression
329 IEC_ALL = frozenset([
334 IE_CUSTOM_SIZE = "fd"
336 IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")
339 # Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
341 # Raw block device I/O using "dd"
342 IEIO_RAW_DISK = "raw"
343 # OS definition import/export script
344 IEIO_SCRIPT = "script"
346 VALUE_DEFAULT = "default"
348 VALUE_GENERATE = "generate"
351 VALUE_FALSE = "false"
353 # External script validation mask
354 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
356 # hooks-related constants
357 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
358 HOOKS_PHASE_PRE = "pre"
359 HOOKS_PHASE_POST = "post"
360 HOOKS_NAME_CFGUPDATE = "config-update"
361 HOOKS_NAME_WATCHER = "watcher"
364 # hooks subject type (what object type does the LU deal with)
365 HTYPE_CLUSTER = "CLUSTER"
367 HTYPE_GROUP = "GROUP"
368 HTYPE_INSTANCE = "INSTANCE"
380 # first two are valid in LU context only, not passed to backend
383 # and the rest are valid in backend
388 SF_ALLOCATABLE = "allocatable"
391 SO_FIX_CONSISTENCY = "fix-consistency"
393 # Available fields per storage type
394 VALID_STORAGE_FIELDS = frozenset([
403 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
405 MODIFIABLE_STORAGE_FIELDS = {
406 ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
409 VALID_STORAGE_OPERATIONS = {
410 ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
414 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
417 LDS_FAULTY) = range(1, 4)
419 # disk template types
420 DT_DISKLESS = "diskless"
424 DT_SHARED_FILE = "sharedfile"
425 DT_BLOCK = "blockdev"
427 # the set of network-mirrored disk templates
428 DTS_INT_MIRROR = frozenset([DT_DRBD8])
430 # the set of externally-mirrored disk templates (e.g. SAN, NAS)
431 DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK])
433 # the set of non-lvm-based disk templates
434 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE, DT_BLOCK])
436 # the set of disk templates which can be grown
437 DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE])
439 # the set of disk templates that allow adoption
440 DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])
442 # the set of disk templates that *must* use adoption
443 DTS_MUST_ADOPT = frozenset([DT_BLOCK])
445 # the set of disk templates that allow migrations
446 DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
448 # the set of file based disk templates
449 DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
455 LD_BLOCKDEV = "blockdev"
456 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV])
459 DRBD_HMAC_ALG = "md5"
460 DRBD_NET_PROTOCOL = "C"
461 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
463 # file backend driver
467 # the set of drbd-like disk types
468 LDS_DRBD = frozenset([LD_DRBD8])
473 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
475 # disk replacement mode
476 REPLACE_DISK_PRI = "replace_on_primary" # replace disks on primary
477 REPLACE_DISK_SEC = "replace_on_secondary" # replace disks on secondary
478 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
479 REPLACE_DISK_AUTO = "replace_auto"
480 REPLACE_MODES = frozenset([
487 # Instance export mode
488 EXPORT_MODE_LOCAL = "local"
489 EXPORT_MODE_REMOTE = "remote"
490 EXPORT_MODES = frozenset([
495 # Lock recalculate mode
496 LOCKS_REPLACE = "replace"
497 LOCKS_APPEND = "append"
499 # Lock timeout (sum) before we should go into blocking acquire (still
500 # can be reset by priority change); computed as max time (10 hours)
501 # before we should actually go into blocking acquire given that we
502 # start from default priority level; in seconds
503 LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
504 LOCK_ATTEMPTS_MAXWAIT = 15.0
505 LOCK_ATTEMPTS_MINWAIT = 1.0
507 # instance creation modes
508 INSTANCE_CREATE = "create"
509 INSTANCE_IMPORT = "import"
510 INSTANCE_REMOTE_IMPORT = "remote-import"
511 INSTANCE_CREATE_MODES = frozenset([
514 INSTANCE_REMOTE_IMPORT,
517 # Remote import/export handshake message and version
519 RIE_HANDSHAKE = "Hi, I'm Ganeti"
521 # Remote import/export certificate validity in seconds
522 RIE_CERT_VALIDITY = 24 * 60 * 60
524 # Overall timeout for establishing connection
525 RIE_CONNECT_TIMEOUT = 180
527 # Export only: how long to wait per connection attempt (seconds)
528 RIE_CONNECT_ATTEMPT_TIMEOUT = 20
530 # Export only: number of attempts to connect
531 RIE_CONNECT_RETRIES = 10
533 #: Give child process up to 5 seconds to exit after sending a signal
534 CHILD_LINGER_TIMEOUT = 5.0
536 DISK_TEMPLATES = frozenset([
545 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
547 # import/export config options
548 INISECT_EXP = "export"
549 INISECT_INS = "instance"
550 INISECT_HYP = "hypervisor"
551 INISECT_BEP = "backend"
554 # dynamic device modification
556 DDM_REMOVE = "remove"
557 DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
564 EXIT_NODESETUP_ERROR = 12
565 EXIT_CONFIRMATION = 13 # need user confirmation
567 #: Exit code for query operations with unknown fields
568 EXIT_UNKNOWN_FIELD = 14
571 TAG_CLUSTER = "cluster"
572 TAG_NODEGROUP = "nodegroup"
574 TAG_INSTANCE = "instance"
575 VALID_TAG_TYPES = frozenset([
582 MAX_TAGS_PER_OBJ = 4096
585 DEFAULT_BRIDGE = "xen-br0"
586 SYNC_SPEED = 60 * 1024
587 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
588 IP4_ADDRESS_ANY = "0.0.0.0"
589 IP6_ADDRESS_LOCALHOST = "::1"
590 IP6_ADDRESS_ANY = "::"
593 VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
594 TCP_PING_TIMEOUT = 10
595 GANETI_RUNAS = "root"
597 DEFAULT_DRBD_HELPER = "/bin/true"
599 DEFAULT_MAC_PREFIX = "aa:00:00"
600 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
601 # default maximum instance wait time, in seconds.
602 DEFAULT_SHUTDOWN_TIMEOUT = 120
603 NODE_MAX_CLOCK_SKEW = 150
604 # Time for an intra-cluster disk transfer to wait for a connection
605 DISK_TRANSFER_CONNECT_TIMEOUT = 60
606 # Disk index separator
607 DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
608 IP_COMMAND_PATH = _autoconf.IP_PATH
610 #: Key for job IDs in opcode result
616 RUNPARTS_ERR) = range(3)
618 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
622 RPC_ENCODING_ZLIB_BASE64) = range(2)
624 # os related constants
625 OS_SCRIPT_CREATE = "create"
626 OS_SCRIPT_IMPORT = "import"
627 OS_SCRIPT_EXPORT = "export"
628 OS_SCRIPT_RENAME = "rename"
629 OS_SCRIPT_VERIFY = "verify"
630 OS_SCRIPTS = frozenset([
638 OS_API_FILE = "ganeti_api_version"
639 OS_VARIANTS_FILE = "variants.list"
640 OS_PARAMETERS_FILE = "parameters.list"
642 OS_VALIDATE_PARAMETERS = "parameters"
643 OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
646 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
647 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
648 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
649 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
650 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
655 INSTANCE_REBOOT_SOFT = "soft"
656 INSTANCE_REBOOT_HARD = "hard"
657 INSTANCE_REBOOT_FULL = "full"
659 REBOOT_TYPES = frozenset([
660 INSTANCE_REBOOT_SOFT,
661 INSTANCE_REBOOT_HARD,
665 # instance reboot behaviors
666 INSTANCE_REBOOT_ALLOWED = "reboot"
667 INSTANCE_REBOOT_EXIT = "exit"
669 REBOOT_BEHAVIORS = frozenset([
670 INSTANCE_REBOOT_ALLOWED,
674 VTYPE_STRING = "string"
675 VTYPE_MAYBE_STRING = "maybe-string"
677 VTYPE_SIZE = "size" # size, in MiBs
679 ENFORCEABLE_TYPES = frozenset([
687 # Constant representing that the user does not specify any IP version
688 IFACE_NO_IP_VERSION_SPECIFIED = 0
690 # HV parameter names (global namespace)
691 HV_BOOT_ORDER = "boot_order"
692 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
693 HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
694 HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
695 HV_NIC_TYPE = "nic_type"
696 HV_DISK_TYPE = "disk_type"
697 HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
698 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
699 HV_VNC_PASSWORD_FILE = "vnc_password_file"
700 HV_VNC_TLS = "vnc_tls"
701 HV_VNC_X509 = "vnc_x509_path"
702 HV_VNC_X509_VERIFY = "vnc_x509_verify"
703 HV_KVM_SPICE_BIND = "spice_bind"
704 HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
705 HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
706 HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
707 HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
708 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
709 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
710 HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
711 HV_KVM_SPICE_USE_TLS = "spice_use_tls"
712 HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
713 HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
716 HV_USE_BOOTLOADER = "use_bootloader"
717 HV_BOOTLOADER_ARGS = "bootloader_args"
718 HV_BOOTLOADER_PATH = "bootloader_path"
719 HV_KERNEL_ARGS = "kernel_args"
720 HV_KERNEL_PATH = "kernel_path"
721 HV_INITRD_PATH = "initrd_path"
722 HV_ROOT_PATH = "root_path"
723 HV_SERIAL_CONSOLE = "serial_console"
724 HV_USB_MOUSE = "usb_mouse"
726 HV_DEVICE_MODEL = "device_model"
727 HV_INIT_SCRIPT = "init_script"
728 HV_MIGRATION_PORT = "migration_port"
729 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
730 HV_MIGRATION_DOWNTIME = "migration_downtime"
731 HV_MIGRATION_MODE = "migration_mode"
732 HV_USE_LOCALTIME = "use_localtime"
733 HV_DISK_CACHE = "disk_cache"
734 HV_SECURITY_MODEL = "security_model"
735 HV_SECURITY_DOMAIN = "security_domain"
736 HV_KVM_FLAG = "kvm_flag"
737 HV_VHOST_NET = "vhost_net"
738 HV_KVM_USE_CHROOT = "use_chroot"
739 HV_CPU_MASK = "cpu_mask"
740 HV_MEM_PATH = "mem_path"
741 HV_BLOCKDEV_PREFIX = "blockdev_prefix"
742 HV_REBOOT_BEHAVIOR = "reboot_behavior"
744 HVS_PARAMETER_TYPES = {
745 HV_BOOT_ORDER: VTYPE_STRING,
746 HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
747 HV_CDROM_IMAGE_PATH: VTYPE_STRING,
748 HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
749 HV_NIC_TYPE: VTYPE_STRING,
750 HV_DISK_TYPE: VTYPE_STRING,
751 HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
752 HV_VNC_PASSWORD_FILE: VTYPE_STRING,
753 HV_VNC_BIND_ADDRESS: VTYPE_STRING,
754 HV_VNC_TLS: VTYPE_BOOL,
755 HV_VNC_X509: VTYPE_STRING,
756 HV_VNC_X509_VERIFY: VTYPE_BOOL,
757 HV_KVM_SPICE_BIND: VTYPE_STRING,
758 HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
759 HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
760 HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
761 HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
762 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
763 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
764 HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
765 HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
766 HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
767 HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
770 HV_USE_BOOTLOADER: VTYPE_BOOL,
771 HV_BOOTLOADER_PATH: VTYPE_STRING,
772 HV_BOOTLOADER_ARGS: VTYPE_STRING,
773 HV_KERNEL_PATH: VTYPE_STRING,
774 HV_KERNEL_ARGS: VTYPE_STRING,
775 HV_INITRD_PATH: VTYPE_STRING,
776 HV_ROOT_PATH: VTYPE_MAYBE_STRING,
777 HV_SERIAL_CONSOLE: VTYPE_BOOL,
778 HV_USB_MOUSE: VTYPE_STRING,
779 HV_KEYMAP: VTYPE_STRING,
780 HV_DEVICE_MODEL: VTYPE_STRING,
781 HV_INIT_SCRIPT: VTYPE_STRING,
782 HV_MIGRATION_PORT: VTYPE_INT,
783 HV_MIGRATION_BANDWIDTH: VTYPE_INT,
784 HV_MIGRATION_DOWNTIME: VTYPE_INT,
785 HV_MIGRATION_MODE: VTYPE_STRING,
786 HV_USE_LOCALTIME: VTYPE_BOOL,
787 HV_DISK_CACHE: VTYPE_STRING,
788 HV_SECURITY_MODEL: VTYPE_STRING,
789 HV_SECURITY_DOMAIN: VTYPE_STRING,
790 HV_KVM_FLAG: VTYPE_STRING,
791 HV_VHOST_NET: VTYPE_BOOL,
792 HV_KVM_USE_CHROOT: VTYPE_BOOL,
793 HV_CPU_MASK: VTYPE_STRING,
794 HV_MEM_PATH: VTYPE_STRING,
795 HV_BLOCKDEV_PREFIX: VTYPE_STRING,
796 HV_REBOOT_BEHAVIOR: VTYPE_STRING,
799 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
802 HV_MIGRATION_COMPLETED = "completed"
803 HV_MIGRATION_ACTIVE = "active"
804 HV_MIGRATION_FAILED = "failed"
805 HV_MIGRATION_CANCELLED = "cancelled"
807 HV_MIGRATION_VALID_STATUSES = frozenset([
808 HV_MIGRATION_COMPLETED,
811 HV_MIGRATION_CANCELLED,
814 HV_MIGRATION_FAILED_STATUSES = frozenset([
816 HV_MIGRATION_CANCELLED,
819 # KVM-specific statuses
820 HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
823 HV_NODEINFO_KEY_VERSION = "hv_version"
825 # Backend parameter names
828 BE_AUTO_BALANCE = "auto_balance"
830 BES_PARAMETER_TYPES = {
831 BE_MEMORY: VTYPE_SIZE,
833 BE_AUTO_BALANCE: VTYPE_BOOL,
836 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
838 # Node parameter names
839 ND_OOB_PROGRAM = "oob_program"
841 NDS_PARAMETER_TYPES = {
842 ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
845 NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
847 # OOB supported commands
848 OOB_POWER_ON = "power-on"
849 OOB_POWER_OFF = "power-off"
850 OOB_POWER_CYCLE = "power-cycle"
851 OOB_POWER_STATUS = "power-status"
852 OOB_HEALTH = "health"
854 OOB_COMMANDS = frozenset([
862 OOB_POWER_STATUS_POWERED = "powered"
864 OOB_TIMEOUT = 60 # 60 seconds
865 OOB_POWER_DELAY = 2.0 # 2 seconds
868 OOB_STATUS_WARNING = "WARNING"
869 OOB_STATUS_CRITICAL = "CRITICAL"
870 OOB_STATUS_UNKNOWN = "UNKNOWN"
872 OOB_STATUSES = frozenset([
879 # Instance Parameters Profile
880 PP_DEFAULT = "default"
882 # NIC_* constants are used inside the ganeti config
886 NIC_MODE_BRIDGED = "bridged"
887 NIC_MODE_ROUTED = "routed"
889 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
891 NICS_PARAMETER_TYPES = {
892 NIC_MODE: VTYPE_STRING,
893 NIC_LINK: VTYPE_STRING,
896 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
898 # IDISK_* constants are used in opcodes, to create/change disks
901 IDISK_ADOPT = "adopt"
903 IDISK_METAVG = "metavg"
904 IDISK_PARAMS_TYPES = {
905 IDISK_SIZE: VTYPE_SIZE,
906 IDISK_MODE: VTYPE_STRING,
907 IDISK_ADOPT: VTYPE_STRING,
908 IDISK_VG: VTYPE_STRING,
909 IDISK_METAVG: VTYPE_STRING,
911 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
913 # INIC_* constants are used in opcodes, to create/change nics
918 INIC_PARAMS_TYPES = {
919 INIC_IP: VTYPE_MAYBE_STRING,
920 INIC_LINK: VTYPE_STRING,
921 INIC_MAC: VTYPE_STRING,
922 INIC_MODE: VTYPE_STRING,
924 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
926 # Hypervisor constants
927 HT_XEN_PVM = "xen-pvm"
929 HT_XEN_HVM = "xen-hvm"
933 HYPER_TYPES = frozenset([
941 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
944 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
945 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
948 HT_NIC_RTL8139 = "rtl8139"
949 HT_NIC_NE2K_PCI = "ne2k_pci"
950 HT_NIC_NE2K_ISA = "ne2k_isa"
951 HT_NIC_I82551 = "i82551"
952 HT_NIC_I85557B = "i82557b"
953 HT_NIC_I8259ER = "i82559er"
954 HT_NIC_PCNET = "pcnet"
955 HT_NIC_E1000 = "e1000"
956 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
958 HT_HVM_VALID_NIC_TYPES = frozenset([
965 HT_KVM_VALID_NIC_TYPES = frozenset([
978 HT_DISK_IOEMU = "ioemu"
980 HT_DISK_SCSI = "scsi"
983 HT_DISK_PFLASH = "pflash"
985 HT_CACHE_DEFAULT = "default"
986 HT_CACHE_NONE = "none"
987 HT_CACHE_WTHROUGH = "writethrough"
988 HT_CACHE_WBACK = "writeback"
989 HT_VALID_CACHE_TYPES = frozenset([
996 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
997 HT_KVM_VALID_DISK_TYPES = frozenset([
1007 HT_MOUSE_MOUSE = "mouse"
1008 HT_MOUSE_TABLET = "tablet"
1010 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1013 HT_BO_FLOPPY = "floppy"
1014 HT_BO_CDROM = "cdrom"
1016 HT_BO_NETWORK = "network"
1018 HT_KVM_VALID_BO_TYPES = frozenset([
1025 # SPICE lossless image compression options
1026 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1027 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1028 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1029 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1030 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1031 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1033 HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1034 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1035 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1036 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1037 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1038 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1039 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1042 # SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1043 HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1044 HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1045 HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1047 HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1048 HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1049 HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1050 HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1053 # SPICE video stream detection
1054 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1055 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1056 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1058 HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1059 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1060 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1061 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1069 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1072 HT_KVM_ENABLED = "enabled"
1073 HT_KVM_DISABLED = "disabled"
1075 HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1078 HT_MIGRATION_LIVE = "live"
1079 HT_MIGRATION_NONLIVE = "non-live"
1080 HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1082 # Cluster Verify steps
1083 VERIFY_NPLUSONE_MEM = "nplusone_mem"
1084 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1086 # Cluster Verify error classes
1087 CV_TCLUSTER = "cluster"
1089 CV_TINSTANCE = "instance"
1091 # Cluster Verify error codes and documentation
1093 (CV_TCLUSTER, "ECLUSTERCFG", "Cluster configuration verification failure")
1095 (CV_TCLUSTER, "ECLUSTERCERT",
1096 "Cluster certificate files verification failure")
1097 CV_ECLUSTERFILECHECK = \
1098 (CV_TCLUSTER, "ECLUSTERFILECHECK",
1099 "Cluster configuration verification failure")
1100 CV_ECLUSTERDANGLINGNODES = \
1101 (CV_TNODE, "ECLUSTERDANGLINGNODES",
1102 "Some nodes belong to non-existing groups")
1103 CV_ECLUSTERDANGLINGINST = \
1104 (CV_TNODE, "ECLUSTERDANGLINGINST",
1105 "Some instances have a non-existing primary node")
1106 CV_EINSTANCEBADNODE = \
1107 (CV_TINSTANCE, "EINSTANCEBADNODE",
1108 "Instance marked as running lives on an offline node")
1109 CV_EINSTANCEDOWN = \
1110 (CV_TINSTANCE, "EINSTANCEDOWN", "Instance not running on its primary node")
1111 CV_EINSTANCELAYOUT = \
1112 (CV_TINSTANCE, "EINSTANCELAYOUT", "Instance has multiple secondary nodes")
1113 CV_EINSTANCEMISSINGDISK = \
1114 (CV_TINSTANCE, "EINSTANCEMISSINGDISK", "Missing volume on an instance")
1115 CV_EINSTANCEFAULTYDISK = \
1116 (CV_TINSTANCE, "EINSTANCEFAULTYDISK",
1117 "Impossible to retrieve status for a disk")
1118 CV_EINSTANCEWRONGNODE = \
1119 (CV_TINSTANCE, "EINSTANCEWRONGNODE", "Instance running on the wrong node")
1120 CV_EINSTANCESPLITGROUPS = \
1121 (CV_TINSTANCE, "EINSTANCESPLITGROUPS",
1122 "Instance with primary and secondary nodes in different groups")
1124 (CV_TNODE, "ENODEDRBD", "Error parsing the DRBD status file")
1125 CV_ENODEDRBDHELPER = \
1126 (CV_TNODE, "ENODEDRBDHELPER", "Error caused by the DRBD helper")
1127 CV_ENODEFILECHECK = \
1128 (CV_TNODE, "ENODEFILECHECK",
1129 "Error retrieving the checksum of the node files")
1131 (CV_TNODE, "ENODEHOOKS", "Communication failure in hooks execution")
1133 (CV_TNODE, "ENODEHV", "Hypervisor parameters verification failure")
1135 (CV_TNODE, "ENODELVM", "LVM-related node error")
1137 (CV_TNODE, "ENODEN1", "Not enough memory to accommodate instance failovers")
1139 (CV_TNODE, "ENODENET", "Network-related node error")
1141 (CV_TNODE, "ENODEOS", "OS-related node error")
1142 CV_ENODEORPHANINSTANCE = \
1143 (CV_TNODE, "ENODEORPHANINSTANCE", "Unknown intance running on a node")
1144 CV_ENODEORPHANLV = \
1145 (CV_TNODE, "ENODEORPHANLV", "Unknown LVM logical volume")
1147 (CV_TNODE, "ENODERPC",
1148 "Error during connection to the primary node of an instance")
1150 (CV_TNODE, "ENODESSH", "SSH-related node error")
1152 (CV_TNODE, "ENODEVERSION",
1153 "Protocol version mismatch or Ganeti version mismatch")
1155 (CV_TNODE, "ENODESETUP", "Node setup error")
1157 (CV_TNODE, "ENODETIME", "Node returned invalid time")
1159 (CV_TNODE, "ENODEOOBPATH", "Invalid Out Of Band path")
1161 CV_ALL_ECODES = frozenset([
1164 CV_ECLUSTERFILECHECK,
1165 CV_ECLUSTERDANGLINGNODES,
1166 CV_ECLUSTERDANGLINGINST,
1167 CV_EINSTANCEBADNODE,
1170 CV_EINSTANCEMISSINGDISK,
1171 CV_EINSTANCEFAULTYDISK,
1172 CV_EINSTANCEWRONGNODE,
1173 CV_EINSTANCESPLITGROUPS,
1183 CV_ENODEORPHANINSTANCE,
1193 CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1195 # Node verify constants
1196 NV_DRBDHELPER = "drbd-helper"
1197 NV_DRBDLIST = "drbd-list"
1198 NV_FILELIST = "filelist"
1199 NV_HVINFO = "hvinfo"
1200 NV_HYPERVISOR = "hypervisor"
1201 NV_HVPARAMS = "hvparms"
1202 NV_INSTANCELIST = "instancelist"
1203 NV_LVLIST = "lvlist"
1204 NV_MASTERIP = "master-ip"
1205 NV_NODELIST = "nodelist"
1206 NV_NODENETTEST = "node-net-test"
1207 NV_NODESETUP = "nodesetup"
1208 NV_OSLIST = "oslist"
1209 NV_PVLIST = "pvlist"
1211 NV_VERSION = "version"
1212 NV_VGLIST = "vglist"
1213 NV_VMNODES = "vmnodes"
1214 NV_OOB_PATHS = "oob-paths"
1215 NV_BRIDGES = "bridges"
1218 INSTST_RUNNING = "running"
1219 INSTST_ADMINDOWN = "ADMIN_down"
1220 INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1221 INSTST_NODEDOWN = "ERROR_nodedown"
1222 INSTST_WRONGNODE = "ERROR_wrongnode"
1223 INSTST_ERRORUP = "ERROR_up"
1224 INSTST_ERRORDOWN = "ERROR_down"
1225 INSTST_ALL = frozenset([
1241 NR_ALL = frozenset([
1249 # SSL certificate check constants (in days)
1250 SSL_CERT_EXPIRATION_WARN = 30
1251 SSL_CERT_EXPIRATION_ERROR = 7
1253 # Allocator framework constants
1254 IALLOCATOR_VERSION = 2
1255 IALLOCATOR_DIR_IN = "in"
1256 IALLOCATOR_DIR_OUT = "out"
1257 VALID_IALLOCATOR_DIRECTIONS = frozenset([
1261 IALLOCATOR_MODE_ALLOC = "allocate"
1262 IALLOCATOR_MODE_RELOC = "relocate"
1263 IALLOCATOR_MODE_CHG_GROUP = "change-group"
1264 IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1265 VALID_IALLOCATOR_MODES = frozenset([
1266 IALLOCATOR_MODE_ALLOC,
1267 IALLOCATOR_MODE_RELOC,
1268 IALLOCATOR_MODE_CHG_GROUP,
1269 IALLOCATOR_MODE_NODE_EVAC,
1271 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1273 IALLOCATOR_NEVAC_PRI = "primary-only"
1274 IALLOCATOR_NEVAC_SEC = "secondary-only"
1275 IALLOCATOR_NEVAC_ALL = "all"
1276 IALLOCATOR_NEVAC_MODES = frozenset([
1277 IALLOCATOR_NEVAC_PRI,
1278 IALLOCATOR_NEVAC_SEC,
1279 IALLOCATOR_NEVAC_ALL,
1283 JOB_QUEUE_VERSION = 1
1284 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1285 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1286 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1287 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1288 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1289 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1290 JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
1291 JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
1293 JOB_ID_TEMPLATE = r"\d+"
1294 JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1296 # unchanged job return
1297 JOB_NOTCHANGED = "nochange"
1300 JOB_STATUS_QUEUED = "queued"
1301 JOB_STATUS_WAITING = "waiting"
1302 JOB_STATUS_CANCELING = "canceling"
1303 JOB_STATUS_RUNNING = "running"
1304 JOB_STATUS_CANCELED = "canceled"
1305 JOB_STATUS_SUCCESS = "success"
1306 JOB_STATUS_ERROR = "error"
1307 JOBS_FINALIZED = frozenset([
1308 JOB_STATUS_CANCELED,
1312 JOB_STATUS_ALL = frozenset([
1315 JOB_STATUS_CANCELING,
1321 OP_STATUS_QUEUED = "queued"
1322 OP_STATUS_WAITING = "waiting"
1323 OP_STATUS_CANCELING = "canceling"
1324 OP_STATUS_RUNNING = "running"
1326 OP_STATUS_CANCELED = "canceled"
1327 OP_STATUS_SUCCESS = "success"
1328 OP_STATUS_ERROR = "error"
1329 OPS_FINALIZED = frozenset([
1336 OP_PRIO_LOWEST = +19
1337 OP_PRIO_HIGHEST = -20
1343 OP_PRIO_SUBMIT_VALID = frozenset([
1349 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1351 # Execution log types
1352 ELOG_MESSAGE = "message"
1353 ELOG_PROGRESS = "progress"
1354 ELOG_REMOTE_IMPORT = "remote-import"
1355 ELOG_JQUEUE_TEST = "jqueue-test"
1357 # /etc/hosts modification
1358 ETC_HOSTS_ADD = "add"
1359 ETC_HOSTS_REMOVE = "remove"
1362 JQT_MSGPREFIX = "TESTMSG="
1363 JQT_EXPANDNAMES = "expandnames"
1365 JQT_LOGMSG = "logmsg"
1366 JQT_STARTMSG = "startmsg"
1367 JQT_ALL = frozenset([
1375 QR_INSTANCE = "instance"
1381 #: List of resources which can be queried using L{opcodes.OpQuery}
1382 QR_VIA_OP = frozenset([QR_INSTANCE, QR_NODE, QR_GROUP, QR_OS])
1384 #: List of resources which can be queried using Local UniX Interface
1385 QR_VIA_LUXI = QR_VIA_OP.union([
1389 #: List of resources which can be queried using RAPI
1390 QR_VIA_RAPI = QR_VIA_LUXI
1393 QFT_UNKNOWN = "unknown"
1396 QFT_NUMBER = "number"
1398 QFT_TIMESTAMP = "timestamp"
1401 #: All query field types
1402 QFT_ALL = frozenset([
1412 # Query result field status (don't change or reuse values as they're used by
1414 #: Normal field status
1418 #: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1420 #: Value unavailable/unsupported for item; if this field is supported
1421 #: but we cannot get the data for the moment, RS_NODATA or
1422 #: RS_OFFLINE should be used
1424 #: Resource marked offline
1427 RS_ALL = frozenset([
1435 #: Dictionary with special field cases and their verbose/terse formatting
1437 RS_UNKNOWN: ("(unknown)", "??"),
1438 RS_NODATA: ("(nodata)", "?"),
1439 RS_OFFLINE: ("(offline)", "*"),
1440 RS_UNAVAIL: ("(unavail)", "-"),
1443 # max dynamic devices
1448 SS_CLUSTER_NAME = "cluster_name"
1449 SS_CLUSTER_TAGS = "cluster_tags"
1450 SS_FILE_STORAGE_DIR = "file_storage_dir"
1451 SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1452 SS_MASTER_CANDIDATES = "master_candidates"
1453 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1454 SS_MASTER_IP = "master_ip"
1455 SS_MASTER_NETDEV = "master_netdev"
1456 SS_MASTER_NETMASK = "master_netmask"
1457 SS_MASTER_NODE = "master_node"
1458 SS_NODE_LIST = "node_list"
1459 SS_NODE_PRIMARY_IPS = "node_primary_ips"
1460 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1461 SS_OFFLINE_NODES = "offline_nodes"
1462 SS_ONLINE_NODES = "online_nodes"
1463 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1464 SS_INSTANCE_LIST = "instance_list"
1465 SS_RELEASE_VERSION = "release_version"
1466 SS_HYPERVISOR_LIST = "hypervisor_list"
1467 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1468 SS_UID_POOL = "uid_pool"
1469 SS_NODEGROUPS = "nodegroups"
1471 SS_FILE_PERMS = 0444
1473 # cluster wide default parameters
1474 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1478 HV_USE_BOOTLOADER: False,
1479 HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1480 HV_BOOTLOADER_ARGS: "",
1481 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1483 HV_ROOT_PATH: "/dev/sda1",
1484 HV_KERNEL_ARGS: "ro",
1485 HV_MIGRATION_PORT: 8002,
1486 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1487 HV_BLOCKDEV_PREFIX: "sd",
1488 HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1489 HV_CPU_MASK: CPU_PINNING_ALL,
1492 HV_BOOT_ORDER: "cd",
1493 HV_CDROM_IMAGE_PATH: "",
1494 HV_NIC_TYPE: HT_NIC_RTL8139,
1495 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1496 HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1497 HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1500 HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1501 HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1502 HV_MIGRATION_PORT: 8002,
1503 HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1504 HV_USE_LOCALTIME: False,
1505 HV_BLOCKDEV_PREFIX: "hd",
1506 HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1507 HV_CPU_MASK: CPU_PINNING_ALL,
1510 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1512 HV_KERNEL_ARGS: "ro",
1513 HV_ROOT_PATH: "/dev/vda1",
1515 HV_SERIAL_CONSOLE: True,
1516 HV_VNC_BIND_ADDRESS: "",
1519 HV_VNC_X509_VERIFY: False,
1520 HV_VNC_PASSWORD_FILE: "",
1521 HV_KVM_SPICE_BIND: "",
1522 HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1523 HV_KVM_SPICE_PASSWORD_FILE: "",
1524 HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1525 HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1526 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1527 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1528 HV_KVM_SPICE_AUDIO_COMPR: True,
1529 HV_KVM_SPICE_USE_TLS: False,
1530 HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1531 HV_KVM_SPICE_USE_VDAGENT: True,
1532 HV_KVM_FLOPPY_IMAGE_PATH: "",
1533 HV_CDROM_IMAGE_PATH: "",
1534 HV_KVM_CDROM2_IMAGE_PATH: "",
1535 HV_BOOT_ORDER: HT_BO_DISK,
1536 HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1537 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1538 HV_KVM_CDROM_DISK_TYPE: "",
1541 HV_MIGRATION_PORT: 8102,
1542 HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1543 HV_MIGRATION_DOWNTIME: 30, # ms
1544 HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1545 HV_USE_LOCALTIME: False,
1546 HV_DISK_CACHE: HT_CACHE_DEFAULT,
1547 HV_SECURITY_MODEL: HT_SM_NONE,
1548 HV_SECURITY_DOMAIN: "",
1550 HV_VHOST_NET: False,
1551 HV_KVM_USE_CHROOT: False,
1553 HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1554 HV_CPU_MASK: CPU_PINNING_ALL,
1559 HV_INIT_SCRIPT: "/ganeti-chroot",
1566 HVC_GLOBALS = frozenset([
1568 HV_MIGRATION_BANDWIDTH,
1575 BE_AUTO_BALANCE: True,
1579 ND_OOB_PROGRAM: None,
1583 NIC_MODE: NIC_MODE_BRIDGED,
1584 NIC_LINK: DEFAULT_BRIDGE,
1587 MASTER_POOL_SIZE_DEFAULT = 10
1589 CONFD_PROTOCOL_VERSION = 1
1592 CONFD_REQ_NODE_ROLE_BYNAME = 1
1593 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1594 CONFD_REQ_CLUSTER_MASTER = 3
1595 CONFD_REQ_NODE_PIP_LIST = 4
1596 CONFD_REQ_MC_PIP_LIST = 5
1597 CONFD_REQ_INSTANCES_IPS_LIST = 6
1599 # Confd request query fields. These are used to narrow down queries.
1600 # These must be strings rather than integers, because json-encoding
1601 # converts them to strings anyway, as they're used as dict-keys.
1602 CONFD_REQQ_LINK = "0"
1604 CONFD_REQQ_IPLIST = "2"
1605 CONFD_REQQ_FIELDS = "3"
1607 CONFD_REQFIELD_NAME = "0"
1608 CONFD_REQFIELD_IP = "1"
1609 CONFD_REQFIELD_MNODE_PIP = "2"
1611 CONFD_REQS = frozenset([
1613 CONFD_REQ_NODE_ROLE_BYNAME,
1614 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1615 CONFD_REQ_CLUSTER_MASTER,
1616 CONFD_REQ_NODE_PIP_LIST,
1617 CONFD_REQ_MC_PIP_LIST,
1618 CONFD_REQ_INSTANCES_IPS_LIST,
1621 CONFD_REPL_STATUS_OK = 0
1622 CONFD_REPL_STATUS_ERROR = 1
1623 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1625 CONFD_REPL_STATUSES = frozenset([
1626 CONFD_REPL_STATUS_OK,
1627 CONFD_REPL_STATUS_ERROR,
1628 CONFD_REPL_STATUS_NOTIMPLEMENTED,
1631 (CONFD_NODE_ROLE_MASTER,
1632 CONFD_NODE_ROLE_CANDIDATE,
1633 CONFD_NODE_ROLE_OFFLINE,
1634 CONFD_NODE_ROLE_DRAINED,
1635 CONFD_NODE_ROLE_REGULAR,
1638 # A few common errors for confd
1639 CONFD_ERROR_UNKNOWN_ENTRY = 1
1640 CONFD_ERROR_INTERNAL = 2
1641 CONFD_ERROR_ARGUMENT = 3
1643 # Each request is "salted" by the current timestamp.
1644 # This constants decides how many seconds of skew to accept.
1645 # TODO: make this a default and allow the value to be more configurable
1646 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1648 # When we haven't reloaded the config for more than this amount of seconds, we
1649 # force a test to see if inotify is betraying us.
1650 CONFD_CONFIG_RELOAD_TIMEOUT = 60
1652 # If we receive more than one update in this amount of seconds, we move to
1653 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
1654 # to serve more requests.
1655 CONFD_CONFIG_RELOAD_RATELIMIT = 2
1657 # Magic number prepended to all confd queries.
1658 # This allows us to distinguish different types of confd protocols and handle
1659 # them. For example by changing this we can move the whole payload to be
1660 # compressed, or move away from json.
1661 CONFD_MAGIC_FOURCC = "plj0"
1663 # By default a confd request is sent to the minimum between this number and all
1664 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
1665 # we should have enough answers to be able to compare more than one.
1666 CONFD_DEFAULT_REQ_COVERAGE = 6
1668 # Timeout in seconds to expire pending query request in the confd client
1669 # library. We don't actually expect any answer more than 10 seconds after we
1671 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1673 # Maximum UDP datagram size.
1674 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1675 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1676 # (assuming we can't use jumbo frames)
1677 # We just set this to 60K, which should be enough
1678 MAX_UDP_DATA_SIZE = 61440
1680 # User-id pool minimum/maximum acceptable user-ids.
1682 UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
1684 # Name or path of the pgrep command
1687 # Name of the node group that gets created at cluster init or upgrade
1688 INITIAL_NODE_GROUP_NAME = "default"
1690 # Possible values for NodeGroup.alloc_policy
1691 ALLOC_POLICY_PREFERRED = "preferred"
1692 ALLOC_POLICY_LAST_RESORT = "last_resort"
1693 ALLOC_POLICY_UNALLOCABLE = "unallocable"
1694 VALID_ALLOC_POLICIES = [
1695 ALLOC_POLICY_PREFERRED,
1696 ALLOC_POLICY_LAST_RESORT,
1697 ALLOC_POLICY_UNALLOCABLE,
1700 # Temporary external/shared storage parameters
1701 BLOCKDEV_DRIVER_MANUAL = "manual"
1703 # qemu-img path, required for ovfconverter
1704 QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
1706 # Whether htools was enabled at compilation time
1707 HTOOLS = _autoconf.HTOOLS
1708 # The hail iallocator
1709 IALLOC_HAIL = "hail"
1711 # Fake opcodes for functions that have hooks attached to them via
1712 # backend.RunLocalHooks
1713 FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
1714 FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
1716 # Do not re-export imported modules
1717 del re, _vcsversion, _autoconf