Add a lvm stripecount configure parameter
[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 from ganeti import _autoconf
25
26 # various versions
27 PROTOCOL_VERSION = 20
28 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
29 OS_API_VERSION = 10
30 EXPORT_VERSION = 0
31 RAPI_VERSION = 2
32
33
34 # Format for CONFIG_VERSION:
35 #   01 03 0123 = 01030123
36 #   ^^ ^^ ^^^^
37 #   |  |  + Configuration version/revision
38 #   |  + Minor version
39 #   + Major version
40 #
41 # It stored as an integer. Make sure not to write an octal number.
42
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
46 # here.
47
48 def BuildVersion(major, minor, revision):
49   """Calculates int version number from major, minor and revision numbers.
50
51   Returns: int representing version number
52
53   """
54   assert isinstance(major, int)
55   assert isinstance(minor, int)
56   assert isinstance(revision, int)
57   return (1000000 * major +
58             10000 * minor +
59                 1 * revision)
60
61
62 def SplitVersion(version):
63   """Splits version number stored in an int.
64
65   Returns: tuple; (major, minor, revision)
66
67   """
68   assert isinstance(version, int)
69
70   (major, remainder) = divmod(version, 1000000)
71   (minor, revision) = divmod(remainder, 10000)
72
73   return (major, minor, revision)
74
75
76 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
77 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
78 CONFIG_REVISION = 0
79 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
80
81 # file paths
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 RUN_DIRS_MODE = 0755
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 INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
100 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
101 RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
102 QUEUE_DIR = DATA_DIR + "/queue"
103 ETC_HOSTS = "/etc/hosts"
104 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
105
106 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
107
108 # PID files
109 MASTERD_PID = "ganeti-masterd"
110 NODED_PID = "ganeti-noded"
111 RAPI_PID = "ganeti-rapi"
112
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"
118
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"
127
128 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
129 EXPORT_DIR = _autoconf.EXPORT_DIR
130
131 EXPORT_CONF_FILE = "config.ini"
132
133 XEN_KERNEL = _autoconf.XEN_KERNEL
134 XEN_INITRD = _autoconf.XEN_INITRD
135
136 KVM_PATH = _autoconf.KVM_PATH
137 SOCAT_PATH = _autoconf.SOCAT_PATH
138 KVM_MIGRATION_PORT = _autoconf.KVM_MIGRATION_PORT
139
140 VALUE_DEFAULT = "default"
141 VALUE_AUTO = "auto"
142 VALUE_GENERATE = "generate"
143 VALUE_NONE = "none"
144 VALUE_TRUE = "true"
145 VALUE_FALSE = "false"
146
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"
152 HOOKS_VERSION = 2
153
154 # hooks subject type (what object type does the LU deal with)
155 HTYPE_CLUSTER = "CLUSTER"
156 HTYPE_NODE = "NODE"
157 HTYPE_INSTANCE = "INSTANCE"
158
159 HKR_SKIP = 0
160 HKR_FAIL = 1
161 HKR_SUCCESS = 2
162
163 # disk template types
164 DT_DISKLESS = "diskless"
165 DT_PLAIN = "plain"
166 DT_DRBD8 = "drbd"
167 DT_FILE = "file"
168
169 # the set of network-mirrored disk templates
170 DTS_NET_MIRROR = frozenset([DT_DRBD8])
171
172 # the set of non-lvm-based disk templates
173 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
174
175 # logical disk types
176 LD_LV = "lvm"
177 LD_DRBD8 = "drbd8"
178 LD_FILE = "file"
179 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
180
181 # drbd constants
182 DRBD_HMAC_ALG = "md5"
183 DRBD_NET_PROTOCOL = "C"
184
185 # file backend driver
186 FD_LOOP = "loop"
187 FD_BLKTAP = "blktap"
188
189 # the set of drbd-like disk types
190 LDS_DRBD = frozenset([LD_DRBD8])
191
192 # disk access mode
193 DISK_RDONLY = "ro"
194 DISK_RDWR = "rw"
195 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
196
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
201
202 # lock recalculate mode
203 LOCKS_REPLACE = 'replace'
204 LOCKS_APPEND = 'append'
205
206 # instance creation modes
207 INSTANCE_CREATE = "create"
208 INSTANCE_IMPORT = "import"
209
210 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
211                             DT_DRBD8, DT_FILE])
212
213 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
214
215 # import/export config options
216 INISECT_EXP = "export"
217 INISECT_INS = "instance"
218
219 # dynamic device modification
220
221 DDM_ADD = 'add'
222 DDM_REMOVE = 'remove'
223
224 # common exit codes
225 EXIT_SUCCESS = 0
226 EXIT_FAILURE = 1
227 EXIT_NOTMASTER = 11
228 EXIT_NODESETUP_ERROR = 12
229 EXIT_CONFIRMATION = 13 # need user confirmation
230
231 # tags
232 TAG_CLUSTER = "cluster"
233 TAG_NODE = "node"
234 TAG_INSTANCE = "instance"
235 MAX_TAG_LEN = 128
236 MAX_TAGS_PER_OBJ = 4096
237
238 # others
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"
244 DEFAULT_VG = "xenvg"
245 BIND_ADDRESS_GLOBAL = "0.0.0.0"
246 MIN_VG_SIZE = 20480
247 DEFAULT_MAC_PREFIX = "aa:00:00"
248 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
249
250 # RPC constants
251 (RPC_ENCODING_NONE,
252  RPC_ENCODING_ZLIB_BASE64) = range(2)
253
254 # os related constants
255 OS_VALID_STATUS = "VALID"
256 OS_SCRIPT_CREATE = 'create'
257 OS_SCRIPT_IMPORT = 'import'
258 OS_SCRIPT_EXPORT = 'export'
259 OS_SCRIPT_RENAME = 'rename'
260 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
261                         OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
262
263 # ssh constants
264 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
265 SSH_CONFIG_DIR = "/etc/ssh/"
266 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
267 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
268 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
269 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
270 SSH = "ssh"
271 SCP = "scp"
272
273 # reboot types
274 INSTANCE_REBOOT_SOFT = "soft"
275 INSTANCE_REBOOT_HARD = "hard"
276 INSTANCE_REBOOT_FULL = "full"
277
278 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
279                           INSTANCE_REBOOT_HARD,
280                           INSTANCE_REBOOT_FULL])
281
282 VTYPE_STRING = 'string'
283 VTYPE_BOOL = 'bool'
284 VTYPE_SIZE = 'size' # size, in MiBs
285 VTYPE_INT = 'int'
286 ENFORCEABLE_TYPES = frozenset([
287                       VTYPE_STRING,
288                       VTYPE_BOOL,
289                       VTYPE_SIZE,
290                       VTYPE_INT,
291                       ])
292
293 # HV parameter names (global namespace)
294 HV_BOOT_ORDER = "boot_order"
295 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
296 HV_NIC_TYPE = "nic_type"
297 HV_DISK_TYPE = "disk_type"
298 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
299 HV_VNC_TLS = "vnc_tls"
300 HV_VNC_X509 = "vnc_x509_path"
301 HV_VNC_X509_VERIFY = "vnc_x509_verify"
302 HV_ACPI = "acpi"
303 HV_PAE = "pae"
304 HV_KERNEL_ARGS = "kernel_args"
305 HV_KERNEL_PATH = "kernel_path"
306 HV_INITRD_PATH = "initrd_path"
307 HV_ROOT_PATH = "root_path"
308 HV_SERIAL_CONSOLE = "serial_console"
309 HV_USB_MOUSE = "usb_mouse"
310
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,
320   HV_ACPI: VTYPE_BOOL,
321   HV_PAE: 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   }
329
330 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
331
332 # BE parameter names
333 BE_MEMORY = "memory"
334 BE_VCPUS = "vcpus"
335 BE_AUTO_BALANCE = "auto_balance"
336
337 BES_PARAMETER_TYPES = {
338     BE_MEMORY: VTYPE_SIZE,
339     BE_VCPUS: VTYPE_INT,
340     BE_AUTO_BALANCE: VTYPE_BOOL,
341     }
342
343 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
344
345 # BE GROUP
346 BEGR_DEFAULT = "default"
347
348 # Hypervisor constants
349 HT_XEN_PVM = "xen-pvm"
350 HT_FAKE = "fake"
351 HT_XEN_HVM = "xen-hvm"
352 HT_KVM = "kvm"
353 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
354 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
355 HTS_COPY_VNC_PASSWORD = frozenset([HT_XEN_HVM])
356
357 VNC_BASE_PORT = 5900
358 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
359 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
360
361 # NIC types
362 HT_NIC_RTL8139 = "rtl8139"
363 HT_NIC_NE2K_PCI = "ne2k_pci"
364 HT_NIC_NE2K_ISA = "ne2k_isa"
365 HT_NIC_I82551 = "i82551"
366 HT_NIC_I85557B = "i82557b"
367 HT_NIC_I8259ER = "i82559er"
368 HT_NIC_PCNET = "pcnet"
369 HT_NIC_E1000 = "e1000"
370 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
371
372 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
373                                     HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
374 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
375                                     HT_NIC_NE2K_ISA, HT_NIC_I82551,
376                                     HT_NIC_I85557B, HT_NIC_I8259ER,
377                                     HT_NIC_PCNET, HT_NIC_E1000,
378                                     HT_NIC_PARAVIRTUAL])
379 # Disk types
380 HT_DISK_IOEMU = "ioemu"
381 HT_DISK_IDE = "ide"
382 HT_DISK_SCSI = "scsi"
383 HT_DISK_SD = "sd"
384 HT_DISK_MTD = "mtd"
385 HT_DISK_PFLASH = "pflash"
386
387 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
388 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
389                                      HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
390                                      HT_DISK_PFLASH])
391
392 # Mouse types:
393 HT_MOUSE_MOUSE = "mouse"
394 HT_MOUSE_TABLET = "tablet"
395
396 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
397
398 # Boot order
399 HT_BO_CDROM = "cdrom"
400 HT_BO_DISK = "disk"
401 HT_BO_NETWORK = "network"
402
403 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
404
405 # Cluster Verify steps
406 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
407 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
408
409 # Node verify constants
410 NV_FILELIST = "filelist"
411 NV_HVINFO = "hvinfo"
412 NV_HYPERVISOR = "hypervisor"
413 NV_INSTANCELIST = "instancelist"
414 NV_LVLIST = "lvlist"
415 NV_NODELIST = "nodelist"
416 NV_NODENETTEST = "node-net-test"
417 NV_VERSION = "version"
418 NV_VGLIST = "vglist"
419 NV_DRBDLIST = "drbd-list"
420
421 # Allocator framework constants
422 IALLOCATOR_VERSION = 2
423 IALLOCATOR_DIR_IN = "in"
424 IALLOCATOR_DIR_OUT = "out"
425 IALLOCATOR_MODE_ALLOC = "allocate"
426 IALLOCATOR_MODE_RELOC = "relocate"
427 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
428 IARUN_NOTFOUND = 1
429 IARUN_FAILURE = 2
430 IARUN_SUCCESS = 3
431
432 # Job queue
433 JOB_QUEUE_VERSION = 1
434 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
435 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
436 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
437 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
438 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
439 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
440 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
441
442 JOB_ID_TEMPLATE = r"\d+"
443
444 # unchanged job return
445 JOB_NOTCHANGED = "nochange"
446
447 # Job status
448 JOB_STATUS_QUEUED = "queued"
449 JOB_STATUS_WAITLOCK = "waiting"
450 JOB_STATUS_CANCELING = "canceling"
451 JOB_STATUS_RUNNING = "running"
452 JOB_STATUS_CANCELED = "canceled"
453 JOB_STATUS_SUCCESS = "success"
454 JOB_STATUS_ERROR = "error"
455
456 OP_STATUS_QUEUED = "queued"
457 OP_STATUS_WAITLOCK = "waiting"
458 OP_STATUS_CANCELING = "canceling"
459 OP_STATUS_RUNNING = "running"
460 OP_STATUS_CANCELED = "canceled"
461 OP_STATUS_SUCCESS = "success"
462 OP_STATUS_ERROR = "error"
463
464 # Execution log types
465 ELOG_MESSAGE = "message"
466 ELOG_PROGRESS = "progress"
467
468 # Temporary RAPI constants until we have cluster parameters
469 RAPI_ENABLE = True
470 RAPI_PORT = 5080
471
472 # max dynamic devices
473 MAX_NICS = 8
474 MAX_DISKS = 16
475
476 # SSCONF keys
477 SS_CLUSTER_NAME = "cluster_name"
478 SS_CLUSTER_TAGS = "cluster_tags"
479 SS_FILE_STORAGE_DIR = "file_storage_dir"
480 SS_MASTER_CANDIDATES = "master_candidates"
481 SS_MASTER_IP = "master_ip"
482 SS_MASTER_NETDEV = "master_netdev"
483 SS_MASTER_NODE = "master_node"
484 SS_NODE_LIST = "node_list"
485 SS_OFFLINE_NODES = "offline_nodes"
486 SS_ONLINE_NODES = "online_nodes"
487 SS_INSTANCE_LIST = "instance_list"
488 SS_RELEASE_VERSION = "release_version"
489
490 # cluster wide default parameters
491 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
492
493 HVC_DEFAULTS = {
494   HT_XEN_PVM: {
495     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
496     HV_INITRD_PATH: '',
497     HV_ROOT_PATH: '/dev/sda1',
498     HV_KERNEL_ARGS: 'ro',
499     },
500   HT_XEN_HVM: {
501     HV_BOOT_ORDER: "cd",
502     HV_CDROM_IMAGE_PATH: '',
503     HV_NIC_TYPE: HT_NIC_RTL8139,
504     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
505     HV_VNC_BIND_ADDRESS: '0.0.0.0',
506     HV_ACPI: True,
507     HV_PAE: True,
508     },
509   HT_KVM: {
510     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
511     HV_INITRD_PATH: '',
512     HV_KERNEL_ARGS: 'ro',
513     HV_ROOT_PATH: '/dev/vda1',
514     HV_ACPI: True,
515     HV_SERIAL_CONSOLE: True,
516     HV_VNC_BIND_ADDRESS: '',
517     HV_VNC_TLS: False,
518     HV_VNC_X509: '',
519     HV_VNC_X509_VERIFY: False,
520     HV_CDROM_IMAGE_PATH: '',
521     HV_BOOT_ORDER: HT_BO_DISK,
522     HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
523     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
524     HV_USB_MOUSE: '',
525     },
526   HT_FAKE: {
527     },
528   }
529
530 BEC_DEFAULTS = {
531   BE_MEMORY: 128,
532   BE_VCPUS: 1,
533   BE_AUTO_BALANCE: True,
534   }
535
536 MASTER_POOL_SIZE_DEFAULT = 10