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"
116 MASTERD = "ganeti-masterd"
118 MULTITHREADED_DAEMONS = frozenset([MASTERD])
121 # daemon-name: ("proto", "default-port")
122 NODED: ("tcp", 1811),
125 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
126 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
128 FIRST_DRBD_PORT = 11000
129 LAST_DRBD_PORT = 14999
130 MASTER_SCRIPT = "ganeti-master"
132 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
134 # "daemon-name": "logfile"
135 NODED: LOG_DIR + "node-daemon.log",
136 RAPI: LOG_DIR + "rapi-daemon.log",
137 MASTERD: LOG_DIR + "master-daemon.log",
139 LOG_OS_DIR = LOG_DIR + "os"
140 LOG_WATCHER = LOG_DIR + "watcher.log"
141 LOG_COMMANDS = LOG_DIR + "commands.log"
142 LOG_BURNIN = LOG_DIR + "burnin.log"
144 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
145 EXPORT_DIR = _autoconf.EXPORT_DIR
147 EXPORT_CONF_FILE = "config.ini"
149 XEN_KERNEL = _autoconf.XEN_KERNEL
150 XEN_INITRD = _autoconf.XEN_INITRD
152 KVM_PATH = _autoconf.KVM_PATH
153 SOCAT_PATH = _autoconf.SOCAT_PATH
154 KVM_MIGRATION_PORT = _autoconf.KVM_MIGRATION_PORT
156 VALUE_DEFAULT = "default"
158 VALUE_GENERATE = "generate"
161 VALUE_FALSE = "false"
163 # hooks-related constants
164 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
165 HOOKS_PHASE_PRE = "pre"
166 HOOKS_PHASE_POST = "post"
167 HOOKS_NAME_CFGUPDATE = "config-update"
170 # hooks subject type (what object type does the LU deal with)
171 HTYPE_CLUSTER = "CLUSTER"
173 HTYPE_INSTANCE = "INSTANCE"
179 # disk template types
180 DT_DISKLESS = "diskless"
185 # the set of network-mirrored disk templates
186 DTS_NET_MIRROR = frozenset([DT_DRBD8])
188 # the set of non-lvm-based disk templates
189 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
195 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
198 DRBD_HMAC_ALG = "md5"
199 DRBD_NET_PROTOCOL = "C"
201 # file backend driver
205 # the set of drbd-like disk types
206 LDS_DRBD = frozenset([LD_DRBD8])
211 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
213 # disk replacement mode
214 REPLACE_DISK_PRI = "replace_on_primary" # replace disks on primary
215 REPLACE_DISK_SEC = "replace_on_secondary" # replace disks on secondary
216 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
218 # lock recalculate mode
219 LOCKS_REPLACE = 'replace'
220 LOCKS_APPEND = 'append'
222 # instance creation modes
223 INSTANCE_CREATE = "create"
224 INSTANCE_IMPORT = "import"
226 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
229 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
231 # import/export config options
232 INISECT_EXP = "export"
233 INISECT_INS = "instance"
235 # dynamic device modification
238 DDM_REMOVE = 'remove'
245 EXIT_NODESETUP_ERROR = 12
246 EXIT_CONFIRMATION = 13 # need user confirmation
249 TAG_CLUSTER = "cluster"
251 TAG_INSTANCE = "instance"
253 MAX_TAGS_PER_OBJ = 4096
256 DEFAULT_BRIDGE = "xen-br0"
257 SYNC_SPEED = 60 * 1024
258 LOCALHOST_IP_ADDRESS = "127.0.0.1"
259 TCP_PING_TIMEOUT = 10
260 GANETI_RUNAS = "root"
262 BIND_ADDRESS_GLOBAL = "0.0.0.0"
264 DEFAULT_MAC_PREFIX = "aa:00:00"
265 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
269 RPC_ENCODING_ZLIB_BASE64) = range(2)
271 # os related constants
272 OS_SCRIPT_CREATE = 'create'
273 OS_SCRIPT_IMPORT = 'import'
274 OS_SCRIPT_EXPORT = 'export'
275 OS_SCRIPT_RENAME = 'rename'
276 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
277 OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
280 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
281 SSH_CONFIG_DIR = "/etc/ssh/"
282 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
283 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
284 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
285 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
290 INSTANCE_REBOOT_SOFT = "soft"
291 INSTANCE_REBOOT_HARD = "hard"
292 INSTANCE_REBOOT_FULL = "full"
294 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
295 INSTANCE_REBOOT_HARD,
296 INSTANCE_REBOOT_FULL])
298 VTYPE_STRING = 'string'
300 VTYPE_SIZE = 'size' # size, in MiBs
302 ENFORCEABLE_TYPES = frozenset([
309 # HV parameter names (global namespace)
310 HV_BOOT_ORDER = "boot_order"
311 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
312 HV_NIC_TYPE = "nic_type"
313 HV_DISK_TYPE = "disk_type"
314 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
315 HV_VNC_TLS = "vnc_tls"
316 HV_VNC_X509 = "vnc_x509_path"
317 HV_VNC_X509_VERIFY = "vnc_x509_verify"
320 HV_KERNEL_ARGS = "kernel_args"
321 HV_KERNEL_PATH = "kernel_path"
322 HV_INITRD_PATH = "initrd_path"
323 HV_ROOT_PATH = "root_path"
324 HV_SERIAL_CONSOLE = "serial_console"
325 HV_USB_MOUSE = "usb_mouse"
326 HV_DEVICE_MODEL = "device_model"
328 HVS_PARAMETER_TYPES = {
329 HV_BOOT_ORDER: VTYPE_STRING,
330 HV_CDROM_IMAGE_PATH: VTYPE_STRING,
331 HV_NIC_TYPE: VTYPE_STRING,
332 HV_DISK_TYPE: VTYPE_STRING,
333 HV_VNC_BIND_ADDRESS: VTYPE_STRING,
334 HV_VNC_TLS: VTYPE_BOOL,
335 HV_VNC_X509: VTYPE_STRING,
336 HV_VNC_X509_VERIFY: VTYPE_BOOL,
339 HV_KERNEL_PATH: VTYPE_STRING,
340 HV_KERNEL_ARGS: VTYPE_STRING,
341 HV_INITRD_PATH: VTYPE_STRING,
342 HV_ROOT_PATH: VTYPE_STRING,
343 HV_SERIAL_CONSOLE: VTYPE_BOOL,
344 HV_USB_MOUSE: VTYPE_STRING,
345 HV_DEVICE_MODEL: VTYPE_STRING,
348 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
353 BE_AUTO_BALANCE = "auto_balance"
355 BES_PARAMETER_TYPES = {
356 BE_MEMORY: VTYPE_SIZE,
358 BE_AUTO_BALANCE: VTYPE_BOOL,
361 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
363 # Instance Parameters Profile
364 PP_DEFAULT = "default"
369 NIC_MODE_BRIDGED = "bridged"
370 NIC_MODE_ROUTED = "routed"
372 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
374 NICS_PARAMETER_TYPES = {
375 NIC_MODE: VTYPE_STRING,
376 NIC_LINK: VTYPE_STRING,
379 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
381 # Hypervisor constants
382 HT_XEN_PVM = "xen-pvm"
384 HT_XEN_HVM = "xen-hvm"
386 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
387 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
390 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
391 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
394 HT_NIC_RTL8139 = "rtl8139"
395 HT_NIC_NE2K_PCI = "ne2k_pci"
396 HT_NIC_NE2K_ISA = "ne2k_isa"
397 HT_NIC_I82551 = "i82551"
398 HT_NIC_I85557B = "i82557b"
399 HT_NIC_I8259ER = "i82559er"
400 HT_NIC_PCNET = "pcnet"
401 HT_NIC_E1000 = "e1000"
402 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
404 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
405 HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
406 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
407 HT_NIC_NE2K_ISA, HT_NIC_I82551,
408 HT_NIC_I85557B, HT_NIC_I8259ER,
409 HT_NIC_PCNET, HT_NIC_E1000,
412 HT_DISK_IOEMU = "ioemu"
414 HT_DISK_SCSI = "scsi"
417 HT_DISK_PFLASH = "pflash"
419 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
420 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
421 HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
425 HT_MOUSE_MOUSE = "mouse"
426 HT_MOUSE_TABLET = "tablet"
428 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
431 HT_BO_CDROM = "cdrom"
433 HT_BO_NETWORK = "network"
435 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
437 # Cluster Verify steps
438 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
439 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
441 # Node verify constants
442 NV_FILELIST = "filelist"
444 NV_HYPERVISOR = "hypervisor"
445 NV_INSTANCELIST = "instancelist"
447 NV_NODELIST = "nodelist"
448 NV_NODENETTEST = "node-net-test"
449 NV_VERSION = "version"
451 NV_DRBDLIST = "drbd-list"
453 # Allocator framework constants
454 IALLOCATOR_VERSION = 2
455 IALLOCATOR_DIR_IN = "in"
456 IALLOCATOR_DIR_OUT = "out"
457 IALLOCATOR_MODE_ALLOC = "allocate"
458 IALLOCATOR_MODE_RELOC = "relocate"
459 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
462 JOB_QUEUE_VERSION = 1
463 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
464 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
465 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
466 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
467 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
468 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
469 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
471 JOB_ID_TEMPLATE = r"\d+"
473 # unchanged job return
474 JOB_NOTCHANGED = "nochange"
477 JOB_STATUS_QUEUED = "queued"
478 JOB_STATUS_WAITLOCK = "waiting"
479 JOB_STATUS_CANCELING = "canceling"
480 JOB_STATUS_RUNNING = "running"
481 JOB_STATUS_CANCELED = "canceled"
482 JOB_STATUS_SUCCESS = "success"
483 JOB_STATUS_ERROR = "error"
487 OP_STATUS_QUEUED = "queued"
488 OP_STATUS_WAITLOCK = "waiting"
489 OP_STATUS_CANCELING = "canceling"
490 OP_STATUS_RUNNING = "running"
492 OP_STATUS_CANCELED = "canceled"
493 OP_STATUS_SUCCESS = "success"
494 OP_STATUS_ERROR = "error"
495 OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
499 # Execution log types
500 ELOG_MESSAGE = "message"
501 ELOG_PROGRESS = "progress"
503 # max dynamic devices
508 SS_CLUSTER_NAME = "cluster_name"
509 SS_CLUSTER_TAGS = "cluster_tags"
510 SS_FILE_STORAGE_DIR = "file_storage_dir"
511 SS_MASTER_CANDIDATES = "master_candidates"
512 SS_MASTER_IP = "master_ip"
513 SS_MASTER_NETDEV = "master_netdev"
514 SS_MASTER_NODE = "master_node"
515 SS_NODE_LIST = "node_list"
516 SS_OFFLINE_NODES = "offline_nodes"
517 SS_ONLINE_NODES = "online_nodes"
518 SS_INSTANCE_LIST = "instance_list"
519 SS_RELEASE_VERSION = "release_version"
521 # cluster wide default parameters
522 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
526 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
528 HV_ROOT_PATH: '/dev/sda1',
529 HV_KERNEL_ARGS: 'ro',
533 HV_CDROM_IMAGE_PATH: '',
534 HV_NIC_TYPE: HT_NIC_RTL8139,
535 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
536 HV_VNC_BIND_ADDRESS: '0.0.0.0',
539 HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
540 HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
543 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
545 HV_KERNEL_ARGS: 'ro',
546 HV_ROOT_PATH: '/dev/vda1',
548 HV_SERIAL_CONSOLE: True,
549 HV_VNC_BIND_ADDRESS: '',
552 HV_VNC_X509_VERIFY: False,
553 HV_CDROM_IMAGE_PATH: '',
554 HV_BOOT_ORDER: HT_BO_DISK,
555 HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
556 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
566 BE_AUTO_BALANCE: True,
570 NIC_MODE: NIC_MODE_BRIDGED,
571 NIC_LINK: DEFAULT_BRIDGE,
574 MASTER_POOL_SIZE_DEFAULT = 10