4 # Copyright (C) 2006, 2007 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."""
24 from ganeti import _autoconf
28 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
31 OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15])
36 # Format for CONFIG_VERSION:
37 # 01 03 0123 = 01030123
39 # | | + Configuration version/revision
43 # It stored as an integer. Make sure not to write an octal number.
45 # BuildVersion and SplitVersion must be in here because we can't import other
46 # modules. The cfgupgrade tool must be able to read and write version numbers
47 # and thus requires these functions. To avoid code duplication, they're kept in
50 def BuildVersion(major, minor, revision):
51 """Calculates int version number from major, minor and revision numbers.
53 Returns: int representing version number
56 assert isinstance(major, int)
57 assert isinstance(minor, int)
58 assert isinstance(revision, int)
59 return (1000000 * major +
64 def SplitVersion(version):
65 """Splits version number stored in an int.
67 Returns: tuple; (major, minor, revision)
70 assert isinstance(version, int)
72 (major, remainder) = divmod(version, 1000000)
73 (minor, revision) = divmod(remainder, 10000)
75 return (major, minor, revision)
78 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
79 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
81 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
84 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
85 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
86 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
87 BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
88 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
90 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
91 SOCKET_DIR_MODE = 0700
92 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
93 # daemon is started (this takes care of RUN_DIR being tmpfs)
94 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
95 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
96 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
97 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
98 SSL_CERT_FILE = DATA_DIR + "/server.pem"
99 RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
100 HMAC_CLUSTER_KEY = DATA_DIR + "/hmac.key"
101 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
102 INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
103 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
104 RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
105 QUEUE_DIR = DATA_DIR + "/queue"
106 ETC_HOSTS = "/etc/hosts"
107 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
108 SYSCONFDIR = _autoconf.SYSCONFDIR
110 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
112 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
114 NODED = "ganeti-noded"
115 CONFD = "ganeti-confd"
117 MASTERD = "ganeti-masterd"
119 MULTITHREADED_DAEMONS = frozenset([MASTERD])
122 # daemon-name: (default-cert-path, default-key-path)
123 NODED: (SSL_CERT_FILE, SSL_CERT_FILE),
124 RAPI: (RAPI_CERT_FILE, RAPI_CERT_FILE),
128 # daemon-name: ("proto", "default-port")
129 NODED: ("tcp", 1811),
130 CONFD: ("udp", 1814),
133 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
134 DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
135 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
137 FIRST_DRBD_PORT = 11000
138 LAST_DRBD_PORT = 14999
139 MASTER_SCRIPT = "ganeti-master"
141 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
143 # "daemon-name": "logfile"
144 NODED: LOG_DIR + "node-daemon.log",
145 CONFD: LOG_DIR + "conf-daemon.log",
146 RAPI: LOG_DIR + "rapi-daemon.log",
147 MASTERD: LOG_DIR + "master-daemon.log",
149 LOG_OS_DIR = LOG_DIR + "os"
150 LOG_WATCHER = LOG_DIR + "watcher.log"
151 LOG_COMMANDS = LOG_DIR + "commands.log"
152 LOG_BURNIN = LOG_DIR + "burnin.log"
154 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
155 EXPORT_DIR = _autoconf.EXPORT_DIR
157 EXPORT_CONF_FILE = "config.ini"
159 XEN_KERNEL = _autoconf.XEN_KERNEL
160 XEN_INITRD = _autoconf.XEN_INITRD
162 KVM_PATH = _autoconf.KVM_PATH
163 SOCAT_PATH = _autoconf.SOCAT_PATH
164 KVM_MIGRATION_PORT = _autoconf.KVM_MIGRATION_PORT
166 VALUE_DEFAULT = "default"
168 VALUE_GENERATE = "generate"
171 VALUE_FALSE = "false"
173 # hooks-related constants
174 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
175 HOOKS_PHASE_PRE = "pre"
176 HOOKS_PHASE_POST = "post"
177 HOOKS_NAME_CFGUPDATE = "config-update"
180 # hooks subject type (what object type does the LU deal with)
181 HTYPE_CLUSTER = "CLUSTER"
183 HTYPE_INSTANCE = "INSTANCE"
199 SF_ALLOCATABLE = "allocatable"
201 # Available fields per storage type
202 VALID_STORAGE_FIELDS = {
203 ST_FILE: frozenset([SF_NAME, SF_USED, SF_FREE]),
204 ST_LVM_PV: frozenset([SF_NAME, SF_SIZE, SF_USED, SF_FREE, SF_ALLOCATABLE]),
205 ST_LVM_VG: frozenset([SF_NAME, SF_SIZE]),
208 MODIFIABLE_STORAGE_FIELDS = {
209 ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
213 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
216 LDS_FAULTY) = range(1, 4)
218 # disk template types
219 DT_DISKLESS = "diskless"
224 # the set of network-mirrored disk templates
225 DTS_NET_MIRROR = frozenset([DT_DRBD8])
227 # the set of non-lvm-based disk templates
228 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
234 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
237 DRBD_HMAC_ALG = "md5"
238 DRBD_NET_PROTOCOL = "C"
240 # file backend driver
244 # the set of drbd-like disk types
245 LDS_DRBD = frozenset([LD_DRBD8])
250 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
252 # disk replacement mode
253 REPLACE_DISK_PRI = "replace_on_primary" # replace disks on primary
254 REPLACE_DISK_SEC = "replace_on_secondary" # replace disks on secondary
255 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
257 # lock recalculate mode
258 LOCKS_REPLACE = 'replace'
259 LOCKS_APPEND = 'append'
261 # instance creation modes
262 INSTANCE_CREATE = "create"
263 INSTANCE_IMPORT = "import"
265 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
268 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
270 # import/export config options
271 INISECT_EXP = "export"
272 INISECT_INS = "instance"
274 # dynamic device modification
277 DDM_REMOVE = 'remove'
284 EXIT_NODESETUP_ERROR = 12
285 EXIT_CONFIRMATION = 13 # need user confirmation
286 EXIT_NOTCANDIDATE = 14
289 TAG_CLUSTER = "cluster"
291 TAG_INSTANCE = "instance"
293 MAX_TAGS_PER_OBJ = 4096
296 DEFAULT_BRIDGE = "xen-br0"
297 SYNC_SPEED = 60 * 1024
298 LOCALHOST_IP_ADDRESS = "127.0.0.1"
299 TCP_PING_TIMEOUT = 10
300 GANETI_RUNAS = "root"
302 BIND_ADDRESS_GLOBAL = "0.0.0.0"
304 DEFAULT_MAC_PREFIX = "aa:00:00"
305 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
309 RPC_ENCODING_ZLIB_BASE64) = range(2)
311 # os related constants
312 OS_SCRIPT_CREATE = 'create'
313 OS_SCRIPT_IMPORT = 'import'
314 OS_SCRIPT_EXPORT = 'export'
315 OS_SCRIPT_RENAME = 'rename'
316 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
317 OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
320 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
321 SSH_CONFIG_DIR = "/etc/ssh/"
322 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
323 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
324 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
325 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
330 INSTANCE_REBOOT_SOFT = "soft"
331 INSTANCE_REBOOT_HARD = "hard"
332 INSTANCE_REBOOT_FULL = "full"
334 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
335 INSTANCE_REBOOT_HARD,
336 INSTANCE_REBOOT_FULL])
338 VTYPE_STRING = 'string'
340 VTYPE_SIZE = 'size' # size, in MiBs
342 ENFORCEABLE_TYPES = frozenset([
349 # HV parameter names (global namespace)
350 HV_BOOT_ORDER = "boot_order"
351 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
352 HV_NIC_TYPE = "nic_type"
353 HV_DISK_TYPE = "disk_type"
354 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
355 HV_VNC_TLS = "vnc_tls"
356 HV_VNC_X509 = "vnc_x509_path"
357 HV_VNC_X509_VERIFY = "vnc_x509_verify"
360 HV_KERNEL_ARGS = "kernel_args"
361 HV_KERNEL_PATH = "kernel_path"
362 HV_INITRD_PATH = "initrd_path"
363 HV_ROOT_PATH = "root_path"
364 HV_SERIAL_CONSOLE = "serial_console"
365 HV_USB_MOUSE = "usb_mouse"
366 HV_DEVICE_MODEL = "device_model"
367 HV_INIT_SCRIPT = "init_script"
369 HVS_PARAMETER_TYPES = {
370 HV_BOOT_ORDER: VTYPE_STRING,
371 HV_CDROM_IMAGE_PATH: VTYPE_STRING,
372 HV_NIC_TYPE: VTYPE_STRING,
373 HV_DISK_TYPE: VTYPE_STRING,
374 HV_VNC_BIND_ADDRESS: VTYPE_STRING,
375 HV_VNC_TLS: VTYPE_BOOL,
376 HV_VNC_X509: VTYPE_STRING,
377 HV_VNC_X509_VERIFY: VTYPE_BOOL,
380 HV_KERNEL_PATH: VTYPE_STRING,
381 HV_KERNEL_ARGS: VTYPE_STRING,
382 HV_INITRD_PATH: VTYPE_STRING,
383 HV_ROOT_PATH: VTYPE_STRING,
384 HV_SERIAL_CONSOLE: VTYPE_BOOL,
385 HV_USB_MOUSE: VTYPE_STRING,
386 HV_DEVICE_MODEL: VTYPE_STRING,
387 HV_INIT_SCRIPT: VTYPE_STRING,
390 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
395 BE_AUTO_BALANCE = "auto_balance"
397 BES_PARAMETER_TYPES = {
398 BE_MEMORY: VTYPE_SIZE,
400 BE_AUTO_BALANCE: VTYPE_BOOL,
403 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
405 # Instance Parameters Profile
406 PP_DEFAULT = "default"
411 NIC_MODE_BRIDGED = "bridged"
412 NIC_MODE_ROUTED = "routed"
414 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
416 NICS_PARAMETER_TYPES = {
417 NIC_MODE: VTYPE_STRING,
418 NIC_LINK: VTYPE_STRING,
421 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
423 # Hypervisor constants
424 HT_XEN_PVM = "xen-pvm"
426 HT_XEN_HVM = "xen-hvm"
429 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
430 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
433 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
434 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
437 HT_NIC_RTL8139 = "rtl8139"
438 HT_NIC_NE2K_PCI = "ne2k_pci"
439 HT_NIC_NE2K_ISA = "ne2k_isa"
440 HT_NIC_I82551 = "i82551"
441 HT_NIC_I85557B = "i82557b"
442 HT_NIC_I8259ER = "i82559er"
443 HT_NIC_PCNET = "pcnet"
444 HT_NIC_E1000 = "e1000"
445 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
447 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
448 HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
449 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
450 HT_NIC_NE2K_ISA, HT_NIC_I82551,
451 HT_NIC_I85557B, HT_NIC_I8259ER,
452 HT_NIC_PCNET, HT_NIC_E1000,
455 HT_DISK_IOEMU = "ioemu"
457 HT_DISK_SCSI = "scsi"
460 HT_DISK_PFLASH = "pflash"
462 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
463 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
464 HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
468 HT_MOUSE_MOUSE = "mouse"
469 HT_MOUSE_TABLET = "tablet"
471 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
474 HT_BO_CDROM = "cdrom"
476 HT_BO_NETWORK = "network"
478 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
480 # Cluster Verify steps
481 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
482 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
484 # Node verify constants
485 NV_FILELIST = "filelist"
487 NV_HYPERVISOR = "hypervisor"
488 NV_INSTANCELIST = "instancelist"
490 NV_NODELIST = "nodelist"
491 NV_NODENETTEST = "node-net-test"
492 NV_VERSION = "version"
494 NV_DRBDLIST = "drbd-list"
496 # Allocator framework constants
497 IALLOCATOR_VERSION = 2
498 IALLOCATOR_DIR_IN = "in"
499 IALLOCATOR_DIR_OUT = "out"
500 IALLOCATOR_MODE_ALLOC = "allocate"
501 IALLOCATOR_MODE_RELOC = "relocate"
502 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
505 JOB_QUEUE_VERSION = 1
506 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
507 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
508 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
509 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
510 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
511 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
512 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
514 JOB_ID_TEMPLATE = r"\d+"
516 # unchanged job return
517 JOB_NOTCHANGED = "nochange"
520 JOB_STATUS_QUEUED = "queued"
521 JOB_STATUS_WAITLOCK = "waiting"
522 JOB_STATUS_CANCELING = "canceling"
523 JOB_STATUS_RUNNING = "running"
524 JOB_STATUS_CANCELED = "canceled"
525 JOB_STATUS_SUCCESS = "success"
526 JOB_STATUS_ERROR = "error"
530 OP_STATUS_QUEUED = "queued"
531 OP_STATUS_WAITLOCK = "waiting"
532 OP_STATUS_CANCELING = "canceling"
533 OP_STATUS_RUNNING = "running"
535 OP_STATUS_CANCELED = "canceled"
536 OP_STATUS_SUCCESS = "success"
537 OP_STATUS_ERROR = "error"
538 OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
542 # Execution log types
543 ELOG_MESSAGE = "message"
544 ELOG_PROGRESS = "progress"
546 # max dynamic devices
551 SS_CLUSTER_NAME = "cluster_name"
552 SS_CLUSTER_TAGS = "cluster_tags"
553 SS_FILE_STORAGE_DIR = "file_storage_dir"
554 SS_MASTER_CANDIDATES = "master_candidates"
555 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
556 SS_MASTER_IP = "master_ip"
557 SS_MASTER_NETDEV = "master_netdev"
558 SS_MASTER_NODE = "master_node"
559 SS_NODE_LIST = "node_list"
560 SS_NODE_PRIMARY_IPS = "node_primary_ips"
561 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
562 SS_OFFLINE_NODES = "offline_nodes"
563 SS_ONLINE_NODES = "online_nodes"
564 SS_INSTANCE_LIST = "instance_list"
565 SS_RELEASE_VERSION = "release_version"
567 # cluster wide default parameters
568 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
572 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
574 HV_ROOT_PATH: '/dev/sda1',
575 HV_KERNEL_ARGS: 'ro',
579 HV_CDROM_IMAGE_PATH: '',
580 HV_NIC_TYPE: HT_NIC_RTL8139,
581 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
582 HV_VNC_BIND_ADDRESS: '0.0.0.0',
585 HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
586 HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
589 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
591 HV_KERNEL_ARGS: 'ro',
592 HV_ROOT_PATH: '/dev/vda1',
594 HV_SERIAL_CONSOLE: True,
595 HV_VNC_BIND_ADDRESS: '',
598 HV_VNC_X509_VERIFY: False,
599 HV_CDROM_IMAGE_PATH: '',
600 HV_BOOT_ORDER: HT_BO_DISK,
601 HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
602 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
608 HV_INIT_SCRIPT: "/ganeti-chroot",
615 BE_AUTO_BALANCE: True,
619 NIC_MODE: NIC_MODE_BRIDGED,
620 NIC_LINK: DEFAULT_BRIDGE,
623 MASTER_POOL_SIZE_DEFAULT = 10
625 CONFD_PROTOCOL_VERSION = 1
627 CONFD_REQ_NODE_ROLE_BYNAME = 1
628 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
630 CONFD_REQS = frozenset([
631 CONFD_REQ_NODE_ROLE_BYNAME,
632 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
635 CONFD_REPL_STATUS_OK = 0
636 CONFD_REPL_STATUS_ERROR = 1
637 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
639 CONFD_REPL_STATUSES = frozenset([
640 CONFD_REPL_STATUS_OK,
641 CONFD_REPL_STATUS_ERROR,
642 CONFD_REPL_STATUS_NOTIMPLEMENTED,
645 (CONFD_NODE_ROLE_MASTER,
646 CONFD_NODE_ROLE_CANDIDATE,
647 CONFD_NODE_ROLE_OFFLINE,
648 CONFD_NODE_ROLE_DRAINED) = range(4)