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"
87 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
88 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
89 # daemon is started (this takes care of RUN_DIR being tmpfs)
90 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
91 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
92 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
93 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
94 SSL_CERT_FILE = DATA_DIR + "/server.pem"
95 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
96 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
97 QUEUE_DIR = DATA_DIR + "/queue"
98 ETC_HOSTS = "/etc/hosts"
99 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
101 # Quoting unix(7) on Linux:
102 # Linux also supports an abstract namespace which is independent of the file
103 # system. [...] If sun_path starts with a null byte ('\0'), then it refers to
104 # the abstract namespace maintained by the Unix protocol module. The socket's
105 # address in this namespace is given by the rest of the bytes in sun_path.
107 # By using this Linux-specific way we don't have to care about removing the
108 # socket file when quitting or starting (after an unclean shutdown).
110 # Sample output for "netstat -nlp":
111 # unix 2 [ ACC ] STREAM LISTENING 247919 1234/python @ganeti-master
112 MASTER_SOCKET = "\0ganeti-master"
115 MASTERD_PID = "ganeti-masterd"
116 NODED_PID = "ganeti-noded"
117 RAPI_PID = "ganeti-rapi"
119 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
120 DEFAULT_NODED_PORT = 1811
121 FIRST_DRBD_PORT = 11000
122 LAST_DRBD_PORT = 14999
123 MASTER_SCRIPT = "ganeti-master"
125 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
126 LOG_OS_DIR = LOG_DIR + "os"
127 LOG_NODESERVER = LOG_DIR + "node-daemon.log"
128 LOG_WATCHER = LOG_DIR + "watcher.log"
129 LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
130 LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
131 LOG_COMMANDS = LOG_DIR + "commands.log"
132 LOG_BURNIN = LOG_DIR + "burnin.log"
134 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
135 EXPORT_DIR = _autoconf.EXPORT_DIR
137 EXPORT_CONF_FILE = "config.ini"
139 XEN_KERNEL = _autoconf.XEN_KERNEL
140 XEN_INITRD = _autoconf.XEN_INITRD
142 KVM_PATH = _autoconf.KVM_PATH
144 VALUE_DEFAULT = "default"
146 VALUE_GENERATE = "generate"
149 # hooks-related constants
150 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
151 HOOKS_PHASE_PRE = "pre"
152 HOOKS_PHASE_POST = "post"
153 HOOKS_NAME_CFGUPDATE = "config-update"
156 # hooks subject type (what object type does the LU deal with)
157 HTYPE_CLUSTER = "CLUSTER"
159 HTYPE_INSTANCE = "INSTANCE"
165 # disk template types
166 DT_DISKLESS = "diskless"
171 # the set of network-mirrored disk templates
172 DTS_NET_MIRROR = frozenset([DT_DRBD8])
174 # the set of non-lvm-based disk templates
175 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
181 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
184 DRBD_HMAC_ALG = "md5"
185 DRBD_NET_PROTOCOL = "C"
187 # file backend driver
191 # the set of drbd-like disk types
192 LDS_DRBD = frozenset([LD_DRBD8])
197 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
199 # disk replacement mode
200 REPLACE_DISK_PRI = "replace_primary"
201 REPLACE_DISK_SEC = "replace_secondary"
202 REPLACE_DISK_ALL = "replace_all"
204 # lock recalculate mode
205 LOCKS_REPLACE = 'replace'
206 LOCKS_APPEND = 'append'
208 # instance creation modes
209 INSTANCE_CREATE = "create"
210 INSTANCE_IMPORT = "import"
212 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
215 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
217 # import/export config options
218 INISECT_EXP = "export"
219 INISECT_INS = "instance"
221 # dynamic device modification
224 DDM_REMOVE = 'remove'
230 EXIT_NODESETUP_ERROR = 12
231 EXIT_CONFIRMATION = 13 # need user confirmation
234 TAG_CLUSTER = "cluster"
236 TAG_INSTANCE = "instance"
238 MAX_TAGS_PER_OBJ = 4096
241 DEFAULT_BRIDGE = "xen-br0"
242 SYNC_SPEED = 30 * 1024
243 LOCALHOST_IP_ADDRESS = "127.0.0.1"
244 TCP_PING_TIMEOUT = 10
245 GANETI_RUNAS = "root"
247 BIND_ADDRESS_GLOBAL = "0.0.0.0"
250 # os related constants
251 OS_VALID_STATUS = "VALID"
252 OS_SCRIPT_CREATE = 'create'
253 OS_SCRIPT_IMPORT = 'import'
254 OS_SCRIPT_EXPORT = 'export'
255 OS_SCRIPT_RENAME = 'rename'
256 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
257 OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
260 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
261 SSH_CONFIG_DIR = "/etc/ssh/"
262 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
263 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
264 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
265 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
270 INSTANCE_REBOOT_SOFT = "soft"
271 INSTANCE_REBOOT_HARD = "hard"
272 INSTANCE_REBOOT_FULL = "full"
274 # HV parameter names (global namespace)
275 HV_BOOT_ORDER = "boot_order"
276 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
277 HV_NIC_TYPE = "nic_type"
278 HV_DISK_TYPE = "disk_type"
279 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
282 HV_KERNEL_PATH = "kernel_path"
283 HV_INITRD_PATH = "initrd_path"
285 HVS_PARAMETERS = frozenset([
300 BE_AUTO_BALANCE = "auto_balance"
302 BES_PARAMETERS = frozenset([
309 BEGR_DEFAULT = "default"
311 # Hypervisor constants
312 HT_XEN_PVM = "xen-pvm"
314 HT_XEN_HVM = "xen-hvm"
316 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
317 HTS_REQ_PORT = frozenset([HT_XEN_HVM])
319 HT_HVM_VNC_BASE_PORT = 5900
320 HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
321 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
322 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
325 HT_HVM_NIC_RTL8139 = "rtl8139"
326 HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
327 HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
328 HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
329 HT_HVM_DEV_IOEMU = "ioemu"
330 HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
332 HT_HVM_DEV_PARAVIRTUAL])
333 HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
335 # Cluster Verify steps
336 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
337 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
339 # Allocator framework constants
340 IALLOCATOR_DIR_IN = "in"
341 IALLOCATOR_DIR_OUT = "out"
342 IALLOCATOR_MODE_ALLOC = "allocate"
343 IALLOCATOR_MODE_RELOC = "relocate"
344 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
350 JOB_QUEUE_VERSION = 1
351 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
352 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
353 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
354 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
355 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
357 JOB_ID_TEMPLATE = r"\d+"
359 # unchanged job return
360 JOB_NOTCHANGED = "nochange"
363 JOB_STATUS_QUEUED = "queued"
364 JOB_STATUS_WAITLOCK = "waiting"
365 JOB_STATUS_RUNNING = "running"
366 JOB_STATUS_CANCELED = "canceled"
367 JOB_STATUS_SUCCESS = "success"
368 JOB_STATUS_ERROR = "error"
370 OP_STATUS_QUEUED = "queued"
371 OP_STATUS_WAITLOCK = "waiting"
372 OP_STATUS_RUNNING = "running"
373 OP_STATUS_CANCELED = "canceled"
374 OP_STATUS_SUCCESS = "success"
375 OP_STATUS_ERROR = "error"
377 # Execution log types
378 ELOG_MESSAGE = "message"
379 ELOG_PROGRESS = "progress"
381 # Temporary RAPI constants until we have cluster parameters
385 # max dynamnic devices
389 # cluster wide default parameters
390 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
394 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
395 HV_INITRD_PATH: None,
399 HV_CDROM_IMAGE_PATH: None,
400 HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
401 HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
402 HV_VNC_BIND_ADDRESS: '0.0.0.0',
407 HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
408 HV_INITRD_PATH: None,
418 BE_AUTO_BALANCE: True,