Rename SSL_CERT_FILE to NODED_CERT_FILE
[ganeti-local] / lib / constants.py
1 #
2 #
3
4 # Copyright (C) 2006, 2007 Google Inc.
5 #
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.
10 #
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.
15 #
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
19 # 02110-1301, USA.
20
21
22 """Module holding different constants."""
23
24 import re
25
26 from ganeti import _autoconf
27
28 # various versions
29 PROTOCOL_VERSION = 30
30 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
31 OS_API_V10 = 10
32 OS_API_V15 = 15
33 OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15])
34 EXPORT_VERSION = 0
35 RAPI_VERSION = 2
36
37
38 # Format for CONFIG_VERSION:
39 #   01 03 0123 = 01030123
40 #   ^^ ^^ ^^^^
41 #   |  |  + Configuration version/revision
42 #   |  + Minor version
43 #   + Major version
44 #
45 # It stored as an integer. Make sure not to write an octal number.
46
47 # BuildVersion and SplitVersion must be in here because we can't import other
48 # modules. The cfgupgrade tool must be able to read and write version numbers
49 # and thus requires these functions. To avoid code duplication, they're kept in
50 # here.
51
52 def BuildVersion(major, minor, revision):
53   """Calculates int version number from major, minor and revision numbers.
54
55   Returns: int representing version number
56
57   """
58   assert isinstance(major, int)
59   assert isinstance(minor, int)
60   assert isinstance(revision, int)
61   return (1000000 * major +
62             10000 * minor +
63                 1 * revision)
64
65
66 def SplitVersion(version):
67   """Splits version number stored in an int.
68
69   Returns: tuple; (major, minor, revision)
70
71   """
72   assert isinstance(version, int)
73
74   (major, remainder) = divmod(version, 1000000)
75   (minor, revision) = divmod(remainder, 10000)
76
77   return (major, minor, revision)
78
79
80 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
81 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
82 CONFIG_REVISION = 0
83 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
84
85 # file paths
86 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
87 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
88 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
89 BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
90 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
91 RUN_DIRS_MODE = 0755
92 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
93 SOCKET_DIR_MODE = 0700
94 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
95 # daemon is started (this takes care of RUN_DIR being tmpfs)
96 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
97 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
98 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
99 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
100 NODED_CERT_FILE = DATA_DIR + "/server.pem"
101 RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
102 HMAC_CLUSTER_KEY = DATA_DIR + "/hmac.key"
103 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
104 WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
105 INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
106 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
107 RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
108 QUEUE_DIR = DATA_DIR + "/queue"
109 DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
110 ETC_HOSTS = "/etc/hosts"
111 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
112 ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
113 SYSCONFDIR = _autoconf.SYSCONFDIR
114 TOOLSDIR = _autoconf.TOOLSDIR
115 CONF_DIR = SYSCONFDIR + "/ganeti"
116
117 ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
118
119 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
120
121 NODED = "ganeti-noded"
122 CONFD = "ganeti-confd"
123 RAPI = "ganeti-rapi"
124 MASTERD = "ganeti-masterd"
125 # used in the ganeti-nbma project
126 NLD = "ganeti-nld"
127
128 MULTITHREADED_DAEMONS = frozenset([MASTERD])
129
130 DAEMONS_SSL = {
131   # daemon-name: (default-cert-path, default-key-path)
132   NODED: (NODED_CERT_FILE, NODED_CERT_FILE),
133   RAPI: (RAPI_CERT_FILE, RAPI_CERT_FILE),
134 }
135
136 DAEMONS_PORTS = {
137   # daemon-name: ("proto", "default-port")
138   NODED: ("tcp", 1811),
139   CONFD: ("udp", 1814),
140   RAPI: ("tcp", 5080),
141   # used in the ganeti-nbma project
142   NLD: ("udp", 1816),
143 }
144 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
145 DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
146 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
147 # used in the ganeti-nbma project
148 DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
149
150 FIRST_DRBD_PORT = 11000
151 LAST_DRBD_PORT = 14999
152 MASTER_SCRIPT = "ganeti-master"
153
154 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
155 DAEMONS_LOGFILES = {
156   # "daemon-name": "logfile"
157   NODED: LOG_DIR + "node-daemon.log",
158   CONFD: LOG_DIR + "conf-daemon.log",
159   RAPI: LOG_DIR + "rapi-daemon.log",
160   MASTERD: LOG_DIR + "master-daemon.log",
161   # used in the ganeti-nbma project
162   NLD: LOG_DIR + "nl-daemon.log",
163   }
164 LOG_OS_DIR = LOG_DIR + "os"
165 LOG_WATCHER = LOG_DIR + "watcher.log"
166 LOG_COMMANDS = LOG_DIR + "commands.log"
167 LOG_BURNIN = LOG_DIR + "burnin.log"
168
169 # one of 'no', 'yes', 'only'
170 SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
171 SYSLOG_NO = "no"
172 SYSLOG_YES = "yes"
173 SYSLOG_ONLY = "only"
174 SYSLOG_SOCKET = "/dev/log"
175
176 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
177 EXPORT_DIR = _autoconf.EXPORT_DIR
178
179 EXPORT_CONF_FILE = "config.ini"
180
181 XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
182 XEN_KERNEL = _autoconf.XEN_KERNEL
183 XEN_INITRD = _autoconf.XEN_INITRD
184
185 KVM_PATH = _autoconf.KVM_PATH
186 SOCAT_PATH = _autoconf.SOCAT_PATH
187 SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
188 SOCAT_ESCAPE_CODE = "0x1d"
189
190 VALUE_DEFAULT = "default"
191 VALUE_AUTO = "auto"
192 VALUE_GENERATE = "generate"
193 VALUE_NONE = "none"
194 VALUE_TRUE = "true"
195 VALUE_FALSE = "false"
196
197 # External script validation mask
198 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
199
200 # hooks-related constants
201 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
202 HOOKS_PHASE_PRE = "pre"
203 HOOKS_PHASE_POST = "post"
204 HOOKS_NAME_CFGUPDATE = "config-update"
205 HOOKS_NAME_WATCHER = "watcher"
206 HOOKS_VERSION = 2
207
208 # hooks subject type (what object type does the LU deal with)
209 HTYPE_CLUSTER = "CLUSTER"
210 HTYPE_NODE = "NODE"
211 HTYPE_INSTANCE = "INSTANCE"
212
213 HKR_SKIP = 0
214 HKR_FAIL = 1
215 HKR_SUCCESS = 2
216
217 # Storage types
218 ST_FILE = "file"
219 ST_LVM_PV = "lvm-pv"
220 ST_LVM_VG = "lvm-vg"
221
222 # Storage fields
223 # first two are valid in LU context only, not passed to backend
224 SF_NODE = "node"
225 SF_TYPE = "type"
226 # and the rest are valid in backend
227 SF_NAME = "name"
228 SF_SIZE = "size"
229 SF_FREE = "free"
230 SF_USED = "used"
231 SF_ALLOCATABLE = "allocatable"
232
233 # Storage operations
234 SO_FIX_CONSISTENCY = "fix-consistency"
235
236 # Available fields per storage type
237 VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
238                                   SF_USED, SF_FREE, SF_ALLOCATABLE])
239
240 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
241
242 MODIFIABLE_STORAGE_FIELDS = {
243   ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
244   }
245
246 VALID_STORAGE_OPERATIONS = {
247   ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
248   }
249
250 # Local disk status
251 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
252 (LDS_OKAY,
253  LDS_UNKNOWN,
254  LDS_FAULTY) = range(1, 4)
255
256 # disk template types
257 DT_DISKLESS = "diskless"
258 DT_PLAIN = "plain"
259 DT_DRBD8 = "drbd"
260 DT_FILE = "file"
261
262 # the set of network-mirrored disk templates
263 DTS_NET_MIRROR = frozenset([DT_DRBD8])
264
265 # the set of non-lvm-based disk templates
266 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
267
268 # logical disk types
269 LD_LV = "lvm"
270 LD_DRBD8 = "drbd8"
271 LD_FILE = "file"
272 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
273
274 # drbd constants
275 DRBD_HMAC_ALG = "md5"
276 DRBD_NET_PROTOCOL = "C"
277 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
278
279 # file backend driver
280 FD_LOOP = "loop"
281 FD_BLKTAP = "blktap"
282
283 # the set of drbd-like disk types
284 LDS_DRBD = frozenset([LD_DRBD8])
285
286 # disk access mode
287 DISK_RDONLY = "ro"
288 DISK_RDWR = "rw"
289 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
290
291 # disk replacement mode
292 REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
293 REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
294 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
295 REPLACE_DISK_AUTO = "replace_auto"
296
297 # lock recalculate mode
298 LOCKS_REPLACE = 'replace'
299 LOCKS_APPEND = 'append'
300
301 # instance creation modes
302 INSTANCE_CREATE = "create"
303 INSTANCE_IMPORT = "import"
304
305 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
306                             DT_DRBD8, DT_FILE])
307
308 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
309
310 # import/export config options
311 INISECT_EXP = "export"
312 INISECT_INS = "instance"
313
314 # dynamic device modification
315
316 DDM_ADD = 'add'
317 DDM_REMOVE = 'remove'
318
319 # common exit codes
320 EXIT_SUCCESS = 0
321 EXIT_FAILURE = 1
322 EXIT_NOTCLUSTER = 5
323 EXIT_NOTMASTER = 11
324 EXIT_NODESETUP_ERROR = 12
325 EXIT_CONFIRMATION = 13 # need user confirmation
326 EXIT_NOTCANDIDATE = 14
327
328 # tags
329 TAG_CLUSTER = "cluster"
330 TAG_NODE = "node"
331 TAG_INSTANCE = "instance"
332 MAX_TAG_LEN = 128
333 MAX_TAGS_PER_OBJ = 4096
334
335 # others
336 DEFAULT_BRIDGE = "xen-br0"
337 SYNC_SPEED = 60 * 1024
338 LOCALHOST_IP_ADDRESS = "127.0.0.1"
339 TCP_PING_TIMEOUT = 10
340 GANETI_RUNAS = "root"
341 DEFAULT_VG = "xenvg"
342 BIND_ADDRESS_GLOBAL = "0.0.0.0"
343 MIN_VG_SIZE = 20480
344 DEFAULT_MAC_PREFIX = "aa:00:00"
345 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
346 # default maximum instance wait time, in seconds.
347 DEFAULT_SHUTDOWN_TIMEOUT = 120
348 NODE_MAX_CLOCK_SKEW = 150
349
350 # runparts results
351 (RUNPARTS_SKIP,
352  RUNPARTS_RUN,
353  RUNPARTS_ERR) = range(3)
354
355 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
356
357 # RPC constants
358 (RPC_ENCODING_NONE,
359  RPC_ENCODING_ZLIB_BASE64) = range(2)
360
361 # os related constants
362 OS_SCRIPT_CREATE = 'create'
363 OS_SCRIPT_IMPORT = 'import'
364 OS_SCRIPT_EXPORT = 'export'
365 OS_SCRIPT_RENAME = 'rename'
366 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
367                         OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
368
369 OS_API_FILE = 'ganeti_api_version'
370 OS_VARIANTS_FILE = 'variants.list'
371
372 # ssh constants
373 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
374 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
375 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
376 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
377 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
378 SSH = "ssh"
379 SCP = "scp"
380
381 # reboot types
382 INSTANCE_REBOOT_SOFT = "soft"
383 INSTANCE_REBOOT_HARD = "hard"
384 INSTANCE_REBOOT_FULL = "full"
385
386 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
387                           INSTANCE_REBOOT_HARD,
388                           INSTANCE_REBOOT_FULL])
389
390 VTYPE_STRING = 'string'
391 VTYPE_BOOL = 'bool'
392 VTYPE_SIZE = 'size' # size, in MiBs
393 VTYPE_INT = 'int'
394 ENFORCEABLE_TYPES = frozenset([
395                       VTYPE_STRING,
396                       VTYPE_BOOL,
397                       VTYPE_SIZE,
398                       VTYPE_INT,
399                       ])
400
401 # HV parameter names (global namespace)
402 HV_BOOT_ORDER = "boot_order"
403 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
404 HV_NIC_TYPE = "nic_type"
405 HV_DISK_TYPE = "disk_type"
406 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
407 HV_VNC_PASSWORD_FILE = "vnc_password_file"
408 HV_VNC_TLS = "vnc_tls"
409 HV_VNC_X509 = "vnc_x509_path"
410 HV_VNC_X509_VERIFY = "vnc_x509_verify"
411 HV_ACPI = "acpi"
412 HV_PAE = "pae"
413 HV_USE_BOOTLOADER = "use_bootloader"
414 HV_BOOTLOADER_ARGS = "bootloader_args"
415 HV_BOOTLOADER_PATH = "bootloader_path"
416 HV_KERNEL_ARGS = "kernel_args"
417 HV_KERNEL_PATH = "kernel_path"
418 HV_INITRD_PATH = "initrd_path"
419 HV_ROOT_PATH = "root_path"
420 HV_SERIAL_CONSOLE = "serial_console"
421 HV_USB_MOUSE = "usb_mouse"
422 HV_DEVICE_MODEL = "device_model"
423 HV_INIT_SCRIPT = "init_script"
424 HV_MIGRATION_PORT = "migration_port"
425 HV_USE_LOCALTIME = "use_localtime"
426 HV_DISK_CACHE = "disk_cache"
427 HV_SECURITY_MODEL = "security_model"
428 HV_SECURITY_DOMAIN = "security_domain"
429
430 HVS_PARAMETER_TYPES = {
431   HV_BOOT_ORDER: VTYPE_STRING,
432   HV_CDROM_IMAGE_PATH: VTYPE_STRING,
433   HV_NIC_TYPE: VTYPE_STRING,
434   HV_DISK_TYPE: VTYPE_STRING,
435   HV_VNC_PASSWORD_FILE: VTYPE_STRING,
436   HV_VNC_BIND_ADDRESS: VTYPE_STRING,
437   HV_VNC_TLS: VTYPE_BOOL,
438   HV_VNC_X509: VTYPE_STRING,
439   HV_VNC_X509_VERIFY: VTYPE_BOOL,
440   HV_ACPI: VTYPE_BOOL,
441   HV_PAE: VTYPE_BOOL,
442   HV_USE_BOOTLOADER: VTYPE_BOOL,
443   HV_BOOTLOADER_PATH: VTYPE_STRING,
444   HV_BOOTLOADER_ARGS: VTYPE_STRING,
445   HV_KERNEL_PATH: VTYPE_STRING,
446   HV_KERNEL_ARGS: VTYPE_STRING,
447   HV_INITRD_PATH: VTYPE_STRING,
448   HV_ROOT_PATH: VTYPE_STRING,
449   HV_SERIAL_CONSOLE: VTYPE_BOOL,
450   HV_USB_MOUSE: VTYPE_STRING,
451   HV_DEVICE_MODEL: VTYPE_STRING,
452   HV_INIT_SCRIPT: VTYPE_STRING,
453   HV_MIGRATION_PORT: VTYPE_INT,
454   HV_USE_LOCALTIME: VTYPE_BOOL,
455   HV_DISK_CACHE: VTYPE_STRING,
456   HV_SECURITY_MODEL: VTYPE_STRING,
457   HV_SECURITY_DOMAIN: VTYPE_STRING,
458   }
459
460 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
461
462 # BE parameter names
463 BE_MEMORY = "memory"
464 BE_VCPUS = "vcpus"
465 BE_AUTO_BALANCE = "auto_balance"
466
467 BES_PARAMETER_TYPES = {
468     BE_MEMORY: VTYPE_SIZE,
469     BE_VCPUS: VTYPE_INT,
470     BE_AUTO_BALANCE: VTYPE_BOOL,
471     }
472
473 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
474
475 # Instance Parameters Profile
476 PP_DEFAULT = "default"
477
478 NIC_MODE = "mode"
479 NIC_LINK = "link"
480
481 NIC_MODE_BRIDGED = "bridged"
482 NIC_MODE_ROUTED = "routed"
483
484 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
485
486 NICS_PARAMETER_TYPES = {
487     NIC_MODE: VTYPE_STRING,
488     NIC_LINK: VTYPE_STRING,
489     }
490
491 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
492
493 # Hypervisor constants
494 HT_XEN_PVM = "xen-pvm"
495 HT_FAKE = "fake"
496 HT_XEN_HVM = "xen-hvm"
497 HT_KVM = "kvm"
498 HT_CHROOT = "chroot"
499 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
500 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
501
502 VNC_BASE_PORT = 5900
503 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
504 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
505
506 # NIC types
507 HT_NIC_RTL8139 = "rtl8139"
508 HT_NIC_NE2K_PCI = "ne2k_pci"
509 HT_NIC_NE2K_ISA = "ne2k_isa"
510 HT_NIC_I82551 = "i82551"
511 HT_NIC_I85557B = "i82557b"
512 HT_NIC_I8259ER = "i82559er"
513 HT_NIC_PCNET = "pcnet"
514 HT_NIC_E1000 = "e1000"
515 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
516
517 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
518                                     HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
519 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
520                                     HT_NIC_NE2K_ISA, HT_NIC_I82551,
521                                     HT_NIC_I85557B, HT_NIC_I8259ER,
522                                     HT_NIC_PCNET, HT_NIC_E1000,
523                                     HT_NIC_PARAVIRTUAL])
524 # Disk types
525 HT_DISK_IOEMU = "ioemu"
526 HT_DISK_IDE = "ide"
527 HT_DISK_SCSI = "scsi"
528 HT_DISK_SD = "sd"
529 HT_DISK_MTD = "mtd"
530 HT_DISK_PFLASH = "pflash"
531
532 HT_CACHE_DEFAULT = "default"
533 HT_CACHE_NONE = "none"
534 HT_CACHE_WTHROUGH = "writethrough"
535 HT_CACHE_WBACK = "writeback"
536 HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
537                                   HT_CACHE_NONE,
538                                   HT_CACHE_WTHROUGH,
539                                   HT_CACHE_WBACK])
540
541 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
542 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
543                                      HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
544                                      HT_DISK_PFLASH])
545
546 # Mouse types:
547 HT_MOUSE_MOUSE = "mouse"
548 HT_MOUSE_TABLET = "tablet"
549
550 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
551
552 # Boot order
553 HT_BO_CDROM = "cdrom"
554 HT_BO_DISK = "disk"
555 HT_BO_NETWORK = "network"
556
557 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
558
559 # Security models
560 HT_SM_NONE = "none"
561 HT_SM_USER = "user"
562 HT_SM_POOL = "pool"
563
564 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
565
566 # Cluster Verify steps
567 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
568 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
569
570 # Node verify constants
571 NV_FILELIST = "filelist"
572 NV_HVINFO = "hvinfo"
573 NV_HYPERVISOR = "hypervisor"
574 NV_INSTANCELIST = "instancelist"
575 NV_NODELIST = "nodelist"
576 NV_NODENETTEST = "node-net-test"
577 NV_VERSION = "version"
578 NV_VGLIST = "vglist"
579 NV_LVLIST = "lvlist"
580 NV_PVLIST = "pvlist"
581 NV_DRBDLIST = "drbd-list"
582 NV_NODESETUP = "nodesetup"
583 NV_TIME = "time"
584
585 # SSL certificate check constants (in days)
586 SSL_CERT_EXPIRATION_WARN = 30
587 SSL_CERT_EXPIRATION_ERROR = 7
588
589 # Allocator framework constants
590 IALLOCATOR_VERSION = 2
591 IALLOCATOR_DIR_IN = "in"
592 IALLOCATOR_DIR_OUT = "out"
593 IALLOCATOR_MODE_ALLOC = "allocate"
594 IALLOCATOR_MODE_RELOC = "relocate"
595 IALLOCATOR_MODE_MEVAC = "multi-evacuate"
596 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
597
598 # Job queue
599 JOB_QUEUE_VERSION = 1
600 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
601 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
602 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
603 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
604 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
605 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
606 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
607
608 JOB_ID_TEMPLATE = r"\d+"
609
610 # unchanged job return
611 JOB_NOTCHANGED = "nochange"
612
613 # Job status
614 JOB_STATUS_QUEUED = "queued"
615 JOB_STATUS_WAITLOCK = "waiting"
616 JOB_STATUS_CANCELING = "canceling"
617 JOB_STATUS_RUNNING = "running"
618 JOB_STATUS_CANCELED = "canceled"
619 JOB_STATUS_SUCCESS = "success"
620 JOB_STATUS_ERROR = "error"
621
622 # OpCode status
623 # not yet finalized
624 OP_STATUS_QUEUED = "queued"
625 OP_STATUS_WAITLOCK = "waiting"
626 OP_STATUS_CANCELING = "canceling"
627 OP_STATUS_RUNNING = "running"
628 # finalized
629 OP_STATUS_CANCELED = "canceled"
630 OP_STATUS_SUCCESS = "success"
631 OP_STATUS_ERROR = "error"
632 OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
633                            OP_STATUS_SUCCESS,
634                            OP_STATUS_ERROR])
635
636 # Execution log types
637 ELOG_MESSAGE = "message"
638 ELOG_PROGRESS = "progress"
639
640 # max dynamic devices
641 MAX_NICS = 8
642 MAX_DISKS = 16
643
644 # SSCONF keys
645 SS_CLUSTER_NAME = "cluster_name"
646 SS_CLUSTER_TAGS = "cluster_tags"
647 SS_FILE_STORAGE_DIR = "file_storage_dir"
648 SS_MASTER_CANDIDATES = "master_candidates"
649 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
650 SS_MASTER_IP = "master_ip"
651 SS_MASTER_NETDEV = "master_netdev"
652 SS_MASTER_NODE = "master_node"
653 SS_NODE_LIST = "node_list"
654 SS_NODE_PRIMARY_IPS = "node_primary_ips"
655 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
656 SS_OFFLINE_NODES = "offline_nodes"
657 SS_ONLINE_NODES = "online_nodes"
658 SS_INSTANCE_LIST = "instance_list"
659 SS_RELEASE_VERSION = "release_version"
660
661 # cluster wide default parameters
662 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
663
664 HVC_DEFAULTS = {
665   HT_XEN_PVM: {
666     HV_USE_BOOTLOADER: False,
667     HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
668     HV_BOOTLOADER_ARGS: '',
669     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
670     HV_INITRD_PATH: '',
671     HV_ROOT_PATH: '/dev/sda1',
672     HV_KERNEL_ARGS: 'ro',
673     HV_MIGRATION_PORT: 8002,
674     },
675   HT_XEN_HVM: {
676     HV_BOOT_ORDER: "cd",
677     HV_CDROM_IMAGE_PATH: '',
678     HV_NIC_TYPE: HT_NIC_RTL8139,
679     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
680     HV_VNC_BIND_ADDRESS: '0.0.0.0',
681     HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
682     HV_ACPI: True,
683     HV_PAE: True,
684     HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
685     HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
686     HV_MIGRATION_PORT: 8002,
687     HV_USE_LOCALTIME: False,
688     },
689   HT_KVM: {
690     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
691     HV_INITRD_PATH: '',
692     HV_KERNEL_ARGS: 'ro',
693     HV_ROOT_PATH: '/dev/vda1',
694     HV_ACPI: True,
695     HV_SERIAL_CONSOLE: True,
696     HV_VNC_BIND_ADDRESS: '',
697     HV_VNC_TLS: False,
698     HV_VNC_X509: '',
699     HV_VNC_X509_VERIFY: False,
700     HV_VNC_PASSWORD_FILE: '',
701     HV_CDROM_IMAGE_PATH: '',
702     HV_BOOT_ORDER: HT_BO_DISK,
703     HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
704     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
705     HV_USB_MOUSE: '',
706     HV_MIGRATION_PORT: 8102,
707     HV_USE_LOCALTIME: False,
708     HV_DISK_CACHE: HT_CACHE_DEFAULT,
709     HV_SECURITY_MODEL: HT_SM_NONE,
710     HV_SECURITY_DOMAIN: '',
711     },
712   HT_FAKE: {
713     },
714   HT_CHROOT: {
715     HV_INIT_SCRIPT: "/ganeti-chroot",
716     },
717   }
718
719 HVC_GLOBALS = frozenset([
720   HV_MIGRATION_PORT,
721   ])
722
723 BEC_DEFAULTS = {
724   BE_MEMORY: 128,
725   BE_VCPUS: 1,
726   BE_AUTO_BALANCE: True,
727   }
728
729 NICC_DEFAULTS = {
730   NIC_MODE: NIC_MODE_BRIDGED,
731   NIC_LINK: DEFAULT_BRIDGE,
732   }
733
734 MASTER_POOL_SIZE_DEFAULT = 10
735
736 CONFD_PROTOCOL_VERSION = 1
737
738 CONFD_REQ_PING = 0
739 CONFD_REQ_NODE_ROLE_BYNAME = 1
740 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
741 CONFD_REQ_CLUSTER_MASTER = 3
742 CONFD_REQ_NODE_PIP_LIST = 4
743 CONFD_REQ_MC_PIP_LIST = 5
744 CONFD_REQ_INSTANCES_IPS_LIST = 6
745
746 # Confd request query fields. These are used to narrow down queries.
747 # These must be strings rather than integers, because json-encoding
748 # converts them to strings anyway, as they're used as dict-keys.
749 CONFD_REQQ_LINK = "0"
750 CONFD_REQQ_IP = "1"
751 CONFD_REQQ_IPLIST = "2"
752 CONFD_REQQ_FIELDS = "3"
753
754 CONFD_REQFIELD_NAME = "0"
755 CONFD_REQFIELD_IP = "1"
756 CONFD_REQFIELD_MNODE_PIP = "2"
757
758 CONFD_REQS = frozenset([
759   CONFD_REQ_PING,
760   CONFD_REQ_NODE_ROLE_BYNAME,
761   CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
762   CONFD_REQ_CLUSTER_MASTER,
763   CONFD_REQ_NODE_PIP_LIST,
764   CONFD_REQ_MC_PIP_LIST,
765   CONFD_REQ_INSTANCES_IPS_LIST,
766   ])
767
768 CONFD_REPL_STATUS_OK = 0
769 CONFD_REPL_STATUS_ERROR = 1
770 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
771
772 CONFD_REPL_STATUSES = frozenset([
773   CONFD_REPL_STATUS_OK,
774   CONFD_REPL_STATUS_ERROR,
775   CONFD_REPL_STATUS_NOTIMPLEMENTED,
776   ])
777
778 (CONFD_NODE_ROLE_MASTER,
779  CONFD_NODE_ROLE_CANDIDATE,
780  CONFD_NODE_ROLE_OFFLINE,
781  CONFD_NODE_ROLE_DRAINED,
782  CONFD_NODE_ROLE_REGULAR,
783  ) = range(5)
784
785 # A few common errors for confd
786 CONFD_ERROR_UNKNOWN_ENTRY = 1
787 CONFD_ERROR_INTERNAL = 2
788 CONFD_ERROR_ARGUMENT = 3
789
790 # Each request is "salted" by the current timestamp.
791 # This constants decides how many seconds of skew to accept.
792 # TODO: make this a default and allow the value to be more configurable
793 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
794
795 # When we haven't reloaded the config for more than this amount of seconds, we
796 # force a test to see if inotify is betraying us.
797 CONFD_CONFIG_RELOAD_TIMEOUT = 60
798
799 # If we receive more than one update in this amount of seconds, we move to
800 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
801 # to serve more requests.
802 CONFD_CONFIG_RELOAD_RATELIMIT = 2
803
804 # Magic number prepended to all confd queries.
805 # This allows us to distinguish different types of confd protocols and handle
806 # them. For example by changing this we can move the whole payload to be
807 # compressed, or move away from json.
808 CONFD_MAGIC_FOURCC = 'plj0'
809
810 # By default a confd request is sent to the minimum between this number and all
811 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
812 # we should have enough answers to be able to compare more than one.
813 CONFD_DEFAULT_REQ_COVERAGE = 6
814
815 # Timeout in seconds to expire pending query request in the confd client
816 # library. We don't actually expect any answer more than 10 seconds after we
817 # sent a request.
818 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
819
820 # Maximum UDP datagram size.
821 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
822 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
823 #   (assuming we can't use jumbo frames)
824 # We just set this to 60K, which should be enough
825 MAX_UDP_DATA_SIZE = 61440