Get rid of constants.HT_HVM_DEFAULT_BOOT_ORDER
[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 = 13
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 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
105 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
106
107 # PID files
108 MASTERD_PID = "ganeti-masterd"
109 NODED_PID = "ganeti-noded"
110 RAPI_PID = "ganeti-rapi"
111
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"
117
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"
126
127 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
128 EXPORT_DIR = _autoconf.EXPORT_DIR
129
130 EXPORT_CONF_FILE = "config.ini"
131
132 XEN_KERNEL = _autoconf.XEN_KERNEL
133 XEN_INITRD = _autoconf.XEN_INITRD
134
135 KVM_PATH = _autoconf.KVM_PATH
136 SOCAT_PATH = _autoconf.SOCAT_PATH
137 KVM_MIGRATION_PORT = _autoconf.KVM_MIGRATION_PORT
138
139 VALUE_DEFAULT = "default"
140 VALUE_AUTO = "auto"
141 VALUE_GENERATE = "generate"
142 VALUE_NONE = "none"
143 VALUE_TRUE = "true"
144 VALUE_FALSE = "false"
145
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"
151 HOOKS_VERSION = 1
152
153 # hooks subject type (what object type does the LU deal with)
154 HTYPE_CLUSTER = "CLUSTER"
155 HTYPE_NODE = "NODE"
156 HTYPE_INSTANCE = "INSTANCE"
157
158 HKR_SKIP = 0
159 HKR_FAIL = 1
160 HKR_SUCCESS = 2
161
162 # disk template types
163 DT_DISKLESS = "diskless"
164 DT_PLAIN = "plain"
165 DT_DRBD8 = "drbd"
166 DT_FILE = "file"
167
168 # the set of network-mirrored disk templates
169 DTS_NET_MIRROR = frozenset([DT_DRBD8])
170
171 # the set of non-lvm-based disk templates
172 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
173
174 # logical disk types
175 LD_LV = "lvm"
176 LD_DRBD8 = "drbd8"
177 LD_FILE = "file"
178 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
179
180 # drbd constants
181 DRBD_HMAC_ALG = "md5"
182 DRBD_NET_PROTOCOL = "C"
183
184 # file backend driver
185 FD_LOOP = "loop"
186 FD_BLKTAP = "blktap"
187
188 # the set of drbd-like disk types
189 LDS_DRBD = frozenset([LD_DRBD8])
190
191 # disk access mode
192 DISK_RDONLY = "ro"
193 DISK_RDWR = "rw"
194 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
195
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
200
201 # lock recalculate mode
202 LOCKS_REPLACE = 'replace'
203 LOCKS_APPEND = 'append'
204
205 # instance creation modes
206 INSTANCE_CREATE = "create"
207 INSTANCE_IMPORT = "import"
208
209 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
210                             DT_DRBD8, DT_FILE])
211
212 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
213
214 # import/export config options
215 INISECT_EXP = "export"
216 INISECT_INS = "instance"
217
218 # dynamic device modification
219
220 DDM_ADD = 'add'
221 DDM_REMOVE = 'remove'
222
223 # common exit codes
224 EXIT_SUCCESS = 0
225 EXIT_FAILURE = 1
226 EXIT_NOTMASTER = 11
227 EXIT_NODESETUP_ERROR = 12
228 EXIT_CONFIRMATION = 13 # need user confirmation
229
230 # tags
231 TAG_CLUSTER = "cluster"
232 TAG_NODE = "node"
233 TAG_INSTANCE = "instance"
234 MAX_TAG_LEN = 128
235 MAX_TAGS_PER_OBJ = 4096
236
237 # others
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"
243 DEFAULT_VG = "xenvg"
244 BIND_ADDRESS_GLOBAL = "0.0.0.0"
245 MIN_VG_SIZE = 20480
246 DEFAULT_MAC_PREFIX = "aa:00:00"
247
248 # RPC constants
249 (RPC_ENCODING_NONE,
250  RPC_ENCODING_ZLIB_BASE64) = range(2)
251
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])
260
261 # ssh constants
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"
268 SSH = "ssh"
269 SCP = "scp"
270
271 # reboot types
272 INSTANCE_REBOOT_SOFT = "soft"
273 INSTANCE_REBOOT_HARD = "hard"
274 INSTANCE_REBOOT_FULL = "full"
275
276 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
277                           INSTANCE_REBOOT_HARD,
278                           INSTANCE_REBOOT_FULL])
279
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"
286 HV_VNC_TLS = "vnc_tls"
287 HV_VNC_X509 = "vnc_x509_path"
288 HV_VNC_X509_VERIFY = "vnc_x509_verify"
289 HV_ACPI = "acpi"
290 HV_PAE = "pae"
291 HV_KERNEL_PATH = "kernel_path"
292 HV_INITRD_PATH = "initrd_path"
293 HV_ROOT_PATH = "root_path"
294 HV_SERIAL_CONSOLE = "serial_console"
295
296 HVS_PARAMETERS = frozenset([
297   HV_BOOT_ORDER,
298   HV_CDROM_IMAGE_PATH,
299   HV_NIC_TYPE,
300   HV_DISK_TYPE,
301   HV_VNC_BIND_ADDRESS,
302   HV_VNC_TLS,
303   HV_VNC_X509,
304   HV_VNC_X509_VERIFY,
305   HV_ACPI,
306   HV_PAE,
307   HV_KERNEL_PATH,
308   HV_INITRD_PATH,
309   HV_ROOT_PATH,
310   HV_SERIAL_CONSOLE,
311   ])
312
313 # BE parameter names
314 BE_MEMORY = "memory"
315 BE_VCPUS = "vcpus"
316 BE_AUTO_BALANCE = "auto_balance"
317
318 BES_PARAMETERS = frozenset([
319   BE_MEMORY,
320   BE_VCPUS,
321   BE_AUTO_BALANCE,
322   ])
323
324 # BE GROUP
325 BEGR_DEFAULT = "default"
326
327 # Hypervisor constants
328 HT_XEN_PVM = "xen-pvm"
329 HT_FAKE = "fake"
330 HT_XEN_HVM = "xen-hvm"
331 HT_KVM = "kvm"
332 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
333 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
334 HTS_USE_VNC = frozenset([HT_XEN_HVM, HT_KVM])
335
336 HT_HVM_VNC_BASE_PORT = 5900
337 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
338 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
339
340 # HVM NIC types
341 HT_HVM_NIC_RTL8139 = "rtl8139"
342 HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
343 HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
344 HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
345 HT_HVM_DEV_IOEMU = "ioemu"
346 HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
347                                     HT_HVM_NIC_NE2K_ISA,
348                                     HT_HVM_DEV_PARAVIRTUAL])
349 HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
350
351 # Cluster Verify steps
352 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
353 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
354
355 # Node verify constants
356 NV_FILELIST = "filelist"
357 NV_HVINFO = "hvinfo"
358 NV_HYPERVISOR = "hypervisor"
359 NV_INSTANCELIST = "instancelist"
360 NV_LVLIST = "lvlist"
361 NV_NODELIST = "nodelist"
362 NV_NODENETTEST = "node-net-test"
363 NV_VERSION = "version"
364 NV_VGLIST = "vglist"
365 NV_DRBDLIST = "drbd-list"
366
367 # Allocator framework constants
368 IALLOCATOR_DIR_IN = "in"
369 IALLOCATOR_DIR_OUT = "out"
370 IALLOCATOR_MODE_ALLOC = "allocate"
371 IALLOCATOR_MODE_RELOC = "relocate"
372 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
373 IARUN_NOTFOUND = 1
374 IARUN_FAILURE = 2
375 IARUN_SUCCESS = 3
376
377 # Job queue
378 JOB_QUEUE_VERSION = 1
379 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
380 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
381 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
382 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
383 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
384 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
385 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
386
387 JOB_ID_TEMPLATE = r"\d+"
388
389 # unchanged job return
390 JOB_NOTCHANGED = "nochange"
391
392 # Job status
393 JOB_STATUS_QUEUED = "queued"
394 JOB_STATUS_WAITLOCK = "waiting"
395 JOB_STATUS_CANCELING = "canceling"
396 JOB_STATUS_RUNNING = "running"
397 JOB_STATUS_CANCELED = "canceled"
398 JOB_STATUS_SUCCESS = "success"
399 JOB_STATUS_ERROR = "error"
400
401 OP_STATUS_QUEUED = "queued"
402 OP_STATUS_WAITLOCK = "waiting"
403 OP_STATUS_CANCELING = "canceling"
404 OP_STATUS_RUNNING = "running"
405 OP_STATUS_CANCELED = "canceled"
406 OP_STATUS_SUCCESS = "success"
407 OP_STATUS_ERROR = "error"
408
409 # Execution log types
410 ELOG_MESSAGE = "message"
411 ELOG_PROGRESS = "progress"
412
413 # Temporary RAPI constants until we have cluster parameters
414 RAPI_ENABLE = True
415 RAPI_PORT = 5080
416
417 # max dynamic devices
418 MAX_NICS = 8
419 MAX_DISKS = 16
420
421 # SSCONF keys
422 SS_CLUSTER_NAME = "cluster_name"
423 SS_FILE_STORAGE_DIR = "file_storage_dir"
424 SS_MASTER_CANDIDATES = "master_candidates"
425 SS_MASTER_IP = "master_ip"
426 SS_MASTER_NETDEV = "master_netdev"
427 SS_MASTER_NODE = "master_node"
428 SS_NODE_LIST = "node_list"
429 SS_OFFLINE_NODES = "offline_nodes"
430 SS_ONLINE_NODES = "online_nodes"
431 SS_INSTANCE_LIST = "instance_list"
432 SS_RELEASE_VERSION = "release_version"
433
434 # cluster wide default parameters
435 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
436
437 HVC_DEFAULTS = {
438   HT_XEN_PVM: {
439     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
440     HV_INITRD_PATH: None,
441     HV_ROOT_PATH: '/dev/sda',
442     },
443   HT_XEN_HVM: {
444     HV_BOOT_ORDER: "cd",
445     HV_CDROM_IMAGE_PATH: None,
446     HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
447     HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
448     HV_VNC_BIND_ADDRESS: '0.0.0.0',
449     HV_ACPI: True,
450     HV_PAE: True,
451     },
452   HT_KVM: {
453     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
454     HV_INITRD_PATH: None,
455     HV_ROOT_PATH: '/dev/vda',
456     HV_ACPI: True,
457     HV_SERIAL_CONSOLE: True,
458     HV_VNC_BIND_ADDRESS: None,
459     HV_VNC_TLS: False,
460     HV_VNC_X509: '',
461     HV_VNC_X509_VERIFY: False,
462     },
463   HT_FAKE: {
464     },
465   }
466
467 BEC_DEFAULTS = {
468   BE_MEMORY: 128,
469   BE_VCPUS: 1,
470   BE_AUTO_BALANCE: True,
471   }
472
473 MASTER_POOL_SIZE_DEFAULT = 10