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
34 # Format for CONFIG_VERSION:
35 # 01 03 0123 = 01030123
37 # | | + Configuration version/revision
41 # It stored as an integer. Make sure not to write an octal number.
43 # BuildVersion and SplitVersion must be in here because we can't import other
44 # modules. The cfgupgrade tool must be able to read and write version numbers
45 # and thus requires these functions. To avoid code duplication, they're kept in
48 def BuildVersion(major, minor, revision):
49 """Calculates int version number from major, minor and revision numbers.
51 Returns: int representing version number
54 assert isinstance(major, int)
55 assert isinstance(minor, int)
56 assert isinstance(revision, int)
57 return (1000000 * major +
62 def SplitVersion(version):
63 """Splits version number stored in an int.
65 Returns: tuple; (major, minor, revision)
68 assert isinstance(version, int)
70 (major, remainder) = divmod(version, 1000000)
71 (minor, revision) = divmod(remainder, 10000)
73 return (major, minor, revision)
76 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
77 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
79 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
82 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
83 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
84 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
85 BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
86 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
88 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
89 SOCKET_DIR_MODE = 0700
90 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
91 # daemon is started (this takes care of RUN_DIR being tmpfs)
92 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
93 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
94 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
95 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
96 SSL_CERT_FILE = DATA_DIR + "/server.pem"
97 RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
98 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
99 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
100 RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
101 QUEUE_DIR = DATA_DIR + "/queue"
102 ETC_HOSTS = "/etc/hosts"
103 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
104 SYSCONFDIR = _autoconf.SYSCONFDIR
106 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
109 MASTERD_PID = "ganeti-masterd"
110 NODED_PID = "ganeti-noded"
111 RAPI_PID = "ganeti-rapi"
113 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
114 DEFAULT_NODED_PORT = 1811
115 FIRST_DRBD_PORT = 11000
116 LAST_DRBD_PORT = 14999
117 MASTER_SCRIPT = "ganeti-master"
119 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
120 LOG_OS_DIR = LOG_DIR + "os"
121 LOG_NODESERVER = LOG_DIR + "node-daemon.log"
122 LOG_WATCHER = LOG_DIR + "watcher.log"
123 LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
124 LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
125 LOG_COMMANDS = LOG_DIR + "commands.log"
126 LOG_BURNIN = LOG_DIR + "burnin.log"
128 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
129 EXPORT_DIR = _autoconf.EXPORT_DIR
131 EXPORT_CONF_FILE = "config.ini"
133 XEN_KERNEL = _autoconf.XEN_KERNEL
134 XEN_INITRD = _autoconf.XEN_INITRD
136 KVM_PATH = _autoconf.KVM_PATH
137 SOCAT_PATH = _autoconf.SOCAT_PATH
138 KVM_MIGRATION_PORT = _autoconf.KVM_MIGRATION_PORT
140 VALUE_DEFAULT = "default"
142 VALUE_GENERATE = "generate"
145 VALUE_FALSE = "false"
147 # hooks-related constants
148 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
149 HOOKS_PHASE_PRE = "pre"
150 HOOKS_PHASE_POST = "post"
151 HOOKS_NAME_CFGUPDATE = "config-update"
154 # hooks subject type (what object type does the LU deal with)
155 HTYPE_CLUSTER = "CLUSTER"
157 HTYPE_INSTANCE = "INSTANCE"
163 # disk template types
164 DT_DISKLESS = "diskless"
169 # the set of network-mirrored disk templates
170 DTS_NET_MIRROR = frozenset([DT_DRBD8])
172 # the set of non-lvm-based disk templates
173 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
179 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
182 DRBD_HMAC_ALG = "md5"
183 DRBD_NET_PROTOCOL = "C"
185 # file backend driver
189 # the set of drbd-like disk types
190 LDS_DRBD = frozenset([LD_DRBD8])
195 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
197 # disk replacement mode
198 REPLACE_DISK_PRI = "replace_on_primary" # replace disks on primary
199 REPLACE_DISK_SEC = "replace_on_secondary" # replace disks on secondary
200 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
202 # lock recalculate mode
203 LOCKS_REPLACE = 'replace'
204 LOCKS_APPEND = 'append'
206 # instance creation modes
207 INSTANCE_CREATE = "create"
208 INSTANCE_IMPORT = "import"
210 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
213 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
215 # import/export config options
216 INISECT_EXP = "export"
217 INISECT_INS = "instance"
219 # dynamic device modification
222 DDM_REMOVE = 'remove'
228 EXIT_NODESETUP_ERROR = 12
229 EXIT_CONFIRMATION = 13 # need user confirmation
232 TAG_CLUSTER = "cluster"
234 TAG_INSTANCE = "instance"
236 MAX_TAGS_PER_OBJ = 4096
239 DEFAULT_BRIDGE = "xen-br0"
240 SYNC_SPEED = 60 * 1024
241 LOCALHOST_IP_ADDRESS = "127.0.0.1"
242 TCP_PING_TIMEOUT = 10
243 GANETI_RUNAS = "root"
245 BIND_ADDRESS_GLOBAL = "0.0.0.0"
247 DEFAULT_MAC_PREFIX = "aa:00:00"
251 RPC_ENCODING_ZLIB_BASE64) = range(2)
253 # os related constants
254 OS_VALID_STATUS = "VALID"
255 OS_SCRIPT_CREATE = 'create'
256 OS_SCRIPT_IMPORT = 'import'
257 OS_SCRIPT_EXPORT = 'export'
258 OS_SCRIPT_RENAME = 'rename'
259 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
260 OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
263 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
264 SSH_CONFIG_DIR = "/etc/ssh/"
265 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
266 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
267 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
268 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
273 INSTANCE_REBOOT_SOFT = "soft"
274 INSTANCE_REBOOT_HARD = "hard"
275 INSTANCE_REBOOT_FULL = "full"
277 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
278 INSTANCE_REBOOT_HARD,
279 INSTANCE_REBOOT_FULL])
281 VTYPE_STRING = 'string'
283 VTYPE_SIZE = 'size' # size, in MiBs
285 ENFORCEABLE_TYPES = frozenset([
292 # HV parameter names (global namespace)
293 HV_BOOT_ORDER = "boot_order"
294 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
295 HV_NIC_TYPE = "nic_type"
296 HV_DISK_TYPE = "disk_type"
297 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
298 HV_VNC_TLS = "vnc_tls"
299 HV_VNC_X509 = "vnc_x509_path"
300 HV_VNC_X509_VERIFY = "vnc_x509_verify"
303 HV_KERNEL_ARGS = "kernel_args"
304 HV_KERNEL_PATH = "kernel_path"
305 HV_INITRD_PATH = "initrd_path"
306 HV_ROOT_PATH = "root_path"
307 HV_SERIAL_CONSOLE = "serial_console"
308 HV_USB_MOUSE = "usb_mouse"
309 HV_DEVICE_MODEL = "device_model"
311 HVS_PARAMETER_TYPES = {
312 HV_BOOT_ORDER: VTYPE_STRING,
313 HV_CDROM_IMAGE_PATH: VTYPE_STRING,
314 HV_NIC_TYPE: VTYPE_STRING,
315 HV_DISK_TYPE: VTYPE_STRING,
316 HV_VNC_BIND_ADDRESS: VTYPE_STRING,
317 HV_VNC_TLS: VTYPE_BOOL,
318 HV_VNC_X509: VTYPE_STRING,
319 HV_VNC_X509_VERIFY: VTYPE_BOOL,
322 HV_KERNEL_PATH: VTYPE_STRING,
323 HV_KERNEL_ARGS: VTYPE_STRING,
324 HV_INITRD_PATH: VTYPE_STRING,
325 HV_ROOT_PATH: VTYPE_STRING,
326 HV_SERIAL_CONSOLE: VTYPE_BOOL,
327 HV_USB_MOUSE: VTYPE_STRING,
328 HV_DEVICE_MODEL: VTYPE_STRING,
331 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
336 BE_AUTO_BALANCE = "auto_balance"
338 BES_PARAMETER_TYPES = {
339 BE_MEMORY: VTYPE_SIZE,
341 BE_AUTO_BALANCE: VTYPE_BOOL,
344 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
346 # Instance Parameters Profile
347 PP_DEFAULT = "default"
352 NIC_MODE_BRIDGED = "bridged"
353 NIC_MODE_ROUTED = "routed"
355 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
357 NICS_PARAMETER_TYPES = {
358 NIC_MODE: VTYPE_STRING,
359 NIC_LINK: VTYPE_STRING,
362 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
364 # Hypervisor constants
365 HT_XEN_PVM = "xen-pvm"
367 HT_XEN_HVM = "xen-hvm"
369 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
370 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
373 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
374 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
377 HT_NIC_RTL8139 = "rtl8139"
378 HT_NIC_NE2K_PCI = "ne2k_pci"
379 HT_NIC_NE2K_ISA = "ne2k_isa"
380 HT_NIC_I82551 = "i82551"
381 HT_NIC_I85557B = "i82557b"
382 HT_NIC_I8259ER = "i82559er"
383 HT_NIC_PCNET = "pcnet"
384 HT_NIC_E1000 = "e1000"
385 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
387 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
388 HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
389 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
390 HT_NIC_NE2K_ISA, HT_NIC_I82551,
391 HT_NIC_I85557B, HT_NIC_I8259ER,
392 HT_NIC_PCNET, HT_NIC_E1000,
395 HT_DISK_IOEMU = "ioemu"
397 HT_DISK_SCSI = "scsi"
400 HT_DISK_PFLASH = "pflash"
402 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
403 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
404 HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
408 HT_MOUSE_MOUSE = "mouse"
409 HT_MOUSE_TABLET = "tablet"
411 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
414 HT_BO_CDROM = "cdrom"
416 HT_BO_NETWORK = "network"
418 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
420 # Cluster Verify steps
421 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
422 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
424 # Node verify constants
425 NV_FILELIST = "filelist"
427 NV_HYPERVISOR = "hypervisor"
428 NV_INSTANCELIST = "instancelist"
430 NV_NODELIST = "nodelist"
431 NV_NODENETTEST = "node-net-test"
432 NV_VERSION = "version"
434 NV_DRBDLIST = "drbd-list"
436 # Allocator framework constants
437 IALLOCATOR_VERSION = 2
438 IALLOCATOR_DIR_IN = "in"
439 IALLOCATOR_DIR_OUT = "out"
440 IALLOCATOR_MODE_ALLOC = "allocate"
441 IALLOCATOR_MODE_RELOC = "relocate"
442 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
448 JOB_QUEUE_VERSION = 1
449 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
450 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
451 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
452 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
453 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
454 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
455 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
457 JOB_ID_TEMPLATE = r"\d+"
459 # unchanged job return
460 JOB_NOTCHANGED = "nochange"
463 JOB_STATUS_QUEUED = "queued"
464 JOB_STATUS_WAITLOCK = "waiting"
465 JOB_STATUS_CANCELING = "canceling"
466 JOB_STATUS_RUNNING = "running"
467 JOB_STATUS_CANCELED = "canceled"
468 JOB_STATUS_SUCCESS = "success"
469 JOB_STATUS_ERROR = "error"
471 OP_STATUS_QUEUED = "queued"
472 OP_STATUS_WAITLOCK = "waiting"
473 OP_STATUS_CANCELING = "canceling"
474 OP_STATUS_RUNNING = "running"
475 OP_STATUS_CANCELED = "canceled"
476 OP_STATUS_SUCCESS = "success"
477 OP_STATUS_ERROR = "error"
479 # Execution log types
480 ELOG_MESSAGE = "message"
481 ELOG_PROGRESS = "progress"
483 # Temporary RAPI constants until we have cluster parameters
487 # max dynamic devices
492 SS_CLUSTER_NAME = "cluster_name"
493 SS_CLUSTER_TAGS = "cluster_tags"
494 SS_FILE_STORAGE_DIR = "file_storage_dir"
495 SS_MASTER_CANDIDATES = "master_candidates"
496 SS_MASTER_IP = "master_ip"
497 SS_MASTER_NETDEV = "master_netdev"
498 SS_MASTER_NODE = "master_node"
499 SS_NODE_LIST = "node_list"
500 SS_OFFLINE_NODES = "offline_nodes"
501 SS_ONLINE_NODES = "online_nodes"
502 SS_INSTANCE_LIST = "instance_list"
503 SS_RELEASE_VERSION = "release_version"
505 # cluster wide default parameters
506 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
510 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
512 HV_ROOT_PATH: '/dev/sda1',
513 HV_KERNEL_ARGS: 'ro',
517 HV_CDROM_IMAGE_PATH: '',
518 HV_NIC_TYPE: HT_NIC_RTL8139,
519 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
520 HV_VNC_BIND_ADDRESS: '0.0.0.0',
523 HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
524 HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
527 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
529 HV_KERNEL_ARGS: 'ro',
530 HV_ROOT_PATH: '/dev/vda1',
532 HV_SERIAL_CONSOLE: True,
533 HV_VNC_BIND_ADDRESS: '',
536 HV_VNC_X509_VERIFY: False,
537 HV_CDROM_IMAGE_PATH: '',
538 HV_BOOT_ORDER: HT_BO_DISK,
539 HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
540 HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
550 BE_AUTO_BALANCE: True,
554 NIC_MODE: NIC_MODE_BRIDGED,
555 NIC_LINK: DEFAULT_BRIDGE,
558 MASTER_POOL_SIZE_DEFAULT = 10