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
105 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
108 MASTERD_PID = "ganeti-masterd"
109 NODED_PID = "ganeti-noded"
110 RAPI_PID = "ganeti-rapi"
112 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
113 DEFAULT_NODED_PORT = 1811
114 FIRST_DRBD_PORT = 11000
115 LAST_DRBD_PORT = 14999
116 MASTER_SCRIPT = "ganeti-master"
118 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
119 LOG_OS_DIR = LOG_DIR + "os"
120 LOG_NODESERVER = LOG_DIR + "node-daemon.log"
121 LOG_WATCHER = LOG_DIR + "watcher.log"
122 LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
123 LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
124 LOG_COMMANDS = LOG_DIR + "commands.log"
125 LOG_BURNIN = LOG_DIR + "burnin.log"
127 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
128 EXPORT_DIR = _autoconf.EXPORT_DIR
130 EXPORT_CONF_FILE = "config.ini"
132 XEN_KERNEL = _autoconf.XEN_KERNEL
133 XEN_INITRD = _autoconf.XEN_INITRD
135 KVM_PATH = _autoconf.KVM_PATH
136 SOCAT_PATH = _autoconf.SOCAT_PATH
137 KVM_MIGRATION_PORT = _autoconf.KVM_MIGRATION_PORT
139 VALUE_DEFAULT = "default"
141 VALUE_GENERATE = "generate"
144 VALUE_FALSE = "false"
146 # hooks-related constants
147 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
148 HOOKS_PHASE_PRE = "pre"
149 HOOKS_PHASE_POST = "post"
150 HOOKS_NAME_CFGUPDATE = "config-update"
153 # hooks subject type (what object type does the LU deal with)
154 HTYPE_CLUSTER = "CLUSTER"
156 HTYPE_INSTANCE = "INSTANCE"
162 # disk template types
163 DT_DISKLESS = "diskless"
168 # the set of network-mirrored disk templates
169 DTS_NET_MIRROR = frozenset([DT_DRBD8])
171 # the set of non-lvm-based disk templates
172 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
178 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
181 DRBD_HMAC_ALG = "md5"
182 DRBD_NET_PROTOCOL = "C"
184 # file backend driver
188 # the set of drbd-like disk types
189 LDS_DRBD = frozenset([LD_DRBD8])
194 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
196 # disk replacement mode
197 REPLACE_DISK_PRI = "replace_on_primary" # replace disks on primary
198 REPLACE_DISK_SEC = "replace_on_secondary" # replace disks on secondary
199 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
201 # lock recalculate mode
202 LOCKS_REPLACE = 'replace'
203 LOCKS_APPEND = 'append'
205 # instance creation modes
206 INSTANCE_CREATE = "create"
207 INSTANCE_IMPORT = "import"
209 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
212 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
214 # import/export config options
215 INISECT_EXP = "export"
216 INISECT_INS = "instance"
218 # dynamic device modification
221 DDM_REMOVE = 'remove'
227 EXIT_NODESETUP_ERROR = 12
228 EXIT_CONFIRMATION = 13 # need user confirmation
231 TAG_CLUSTER = "cluster"
233 TAG_INSTANCE = "instance"
235 MAX_TAGS_PER_OBJ = 4096
238 DEFAULT_BRIDGE = "xen-br0"
239 SYNC_SPEED = 60 * 1024
240 LOCALHOST_IP_ADDRESS = "127.0.0.1"
241 TCP_PING_TIMEOUT = 10
242 GANETI_RUNAS = "root"
244 BIND_ADDRESS_GLOBAL = "0.0.0.0"
246 DEFAULT_MAC_PREFIX = "aa:00:00"
250 RPC_ENCODING_ZLIB_BASE64) = range(2)
252 # os related constants
253 OS_VALID_STATUS = "VALID"
254 OS_SCRIPT_CREATE = 'create'
255 OS_SCRIPT_IMPORT = 'import'
256 OS_SCRIPT_EXPORT = 'export'
257 OS_SCRIPT_RENAME = 'rename'
258 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
259 OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
262 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
263 SSH_CONFIG_DIR = "/etc/ssh/"
264 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
265 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
266 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
267 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
272 INSTANCE_REBOOT_SOFT = "soft"
273 INSTANCE_REBOOT_HARD = "hard"
274 INSTANCE_REBOOT_FULL = "full"
276 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
277 INSTANCE_REBOOT_HARD,
278 INSTANCE_REBOOT_FULL])
280 # HV parameter names (global namespace)
281 HV_BOOT_ORDER = "boot_order"
282 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
283 HV_NIC_TYPE = "nic_type"
284 HV_DISK_TYPE = "disk_type"
285 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
288 HV_KERNEL_PATH = "kernel_path"
289 HV_INITRD_PATH = "initrd_path"
290 HV_ROOT_PATH = "root_path"
292 HVS_PARAMETERS = frozenset([
308 BE_AUTO_BALANCE = "auto_balance"
310 BES_PARAMETERS = frozenset([
317 BEGR_DEFAULT = "default"
319 # Hypervisor constants
320 HT_XEN_PVM = "xen-pvm"
322 HT_XEN_HVM = "xen-hvm"
324 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
325 HTS_REQ_PORT = frozenset([HT_XEN_HVM])
327 HT_HVM_VNC_BASE_PORT = 5900
328 HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
329 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
330 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
333 HT_HVM_NIC_RTL8139 = "rtl8139"
334 HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
335 HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
336 HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
337 HT_HVM_DEV_IOEMU = "ioemu"
338 HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
340 HT_HVM_DEV_PARAVIRTUAL])
341 HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
343 # Cluster Verify steps
344 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
345 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
347 # Node verify constants
348 NV_FILELIST = "filelist"
350 NV_HYPERVISOR = "hypervisor"
351 NV_INSTANCELIST = "instancelist"
353 NV_NODELIST = "nodelist"
354 NV_NODENETTEST = "node-net-test"
355 NV_VERSION = "version"
357 NV_DRBDLIST = "drbd-list"
359 # Allocator framework constants
360 IALLOCATOR_DIR_IN = "in"
361 IALLOCATOR_DIR_OUT = "out"
362 IALLOCATOR_MODE_ALLOC = "allocate"
363 IALLOCATOR_MODE_RELOC = "relocate"
364 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
370 JOB_QUEUE_VERSION = 1
371 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
372 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
373 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
374 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
375 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
376 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
377 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
379 JOB_ID_TEMPLATE = r"\d+"
381 # unchanged job return
382 JOB_NOTCHANGED = "nochange"
385 JOB_STATUS_QUEUED = "queued"
386 JOB_STATUS_WAITLOCK = "waiting"
387 JOB_STATUS_CANCELING = "canceling"
388 JOB_STATUS_RUNNING = "running"
389 JOB_STATUS_CANCELED = "canceled"
390 JOB_STATUS_SUCCESS = "success"
391 JOB_STATUS_ERROR = "error"
393 OP_STATUS_QUEUED = "queued"
394 OP_STATUS_WAITLOCK = "waiting"
395 OP_STATUS_CANCELING = "canceling"
396 OP_STATUS_RUNNING = "running"
397 OP_STATUS_CANCELED = "canceled"
398 OP_STATUS_SUCCESS = "success"
399 OP_STATUS_ERROR = "error"
401 # Execution log types
402 ELOG_MESSAGE = "message"
403 ELOG_PROGRESS = "progress"
405 # Temporary RAPI constants until we have cluster parameters
409 # max dynamic devices
414 SS_CLUSTER_NAME = "cluster_name"
415 SS_FILE_STORAGE_DIR = "file_storage_dir"
416 SS_MASTER_CANDIDATES = "master_candidates"
417 SS_MASTER_IP = "master_ip"
418 SS_MASTER_NETDEV = "master_netdev"
419 SS_MASTER_NODE = "master_node"
420 SS_NODE_LIST = "node_list"
421 SS_OFFLINE_NODES = "offline_nodes"
422 SS_RELEASE_VERSION = "release_version"
424 # cluster wide default parameters
425 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
429 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
430 HV_INITRD_PATH: None,
431 HV_ROOT_PATH: '/dev/sda',
435 HV_CDROM_IMAGE_PATH: None,
436 HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
437 HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
438 HV_VNC_BIND_ADDRESS: '0.0.0.0',
443 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
444 HV_INITRD_PATH: None,
445 HV_ROOT_PATH: '/dev/vda',
455 BE_AUTO_BALANCE: True,
458 MASTER_POOL_SIZE_DEFAULT = 10