Add the list of master candidates to ssconf
[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 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
98 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
99 QUEUE_DIR = DATA_DIR + "/queue"
100 ETC_HOSTS = "/etc/hosts"
101 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
102
103 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
104
105 # PID files
106 MASTERD_PID = "ganeti-masterd"
107 NODED_PID = "ganeti-noded"
108 RAPI_PID = "ganeti-rapi"
109
110 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
111 DEFAULT_NODED_PORT = 1811
112 FIRST_DRBD_PORT = 11000
113 LAST_DRBD_PORT = 14999
114 MASTER_SCRIPT = "ganeti-master"
115
116 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
117 LOG_OS_DIR = LOG_DIR + "os"
118 LOG_NODESERVER = LOG_DIR + "node-daemon.log"
119 LOG_WATCHER = LOG_DIR + "watcher.log"
120 LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
121 LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
122 LOG_COMMANDS = LOG_DIR + "commands.log"
123 LOG_BURNIN = LOG_DIR + "burnin.log"
124
125 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
126 EXPORT_DIR = _autoconf.EXPORT_DIR
127
128 EXPORT_CONF_FILE = "config.ini"
129
130 XEN_KERNEL = _autoconf.XEN_KERNEL
131 XEN_INITRD = _autoconf.XEN_INITRD
132
133 KVM_PATH = _autoconf.KVM_PATH
134
135 VALUE_DEFAULT = "default"
136 VALUE_AUTO = "auto"
137 VALUE_GENERATE = "generate"
138 VALUE_NONE = "none"
139
140 # hooks-related constants
141 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
142 HOOKS_PHASE_PRE = "pre"
143 HOOKS_PHASE_POST = "post"
144 HOOKS_NAME_CFGUPDATE = "config-update"
145 HOOKS_VERSION = 1
146
147 # hooks subject type (what object type does the LU deal with)
148 HTYPE_CLUSTER = "CLUSTER"
149 HTYPE_NODE = "NODE"
150 HTYPE_INSTANCE = "INSTANCE"
151
152 HKR_SKIP = 0
153 HKR_FAIL = 1
154 HKR_SUCCESS = 2
155
156 # disk template types
157 DT_DISKLESS = "diskless"
158 DT_PLAIN = "plain"
159 DT_DRBD8 = "drbd"
160 DT_FILE = "file"
161
162 # the set of network-mirrored disk templates
163 DTS_NET_MIRROR = frozenset([DT_DRBD8])
164
165 # the set of non-lvm-based disk templates
166 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
167
168 # logical disk types
169 LD_LV = "lvm"
170 LD_DRBD8 = "drbd8"
171 LD_FILE = "file"
172 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
173
174 # drbd constants
175 DRBD_HMAC_ALG = "md5"
176 DRBD_NET_PROTOCOL = "C"
177
178 # file backend driver
179 FD_LOOP = "loop"
180 FD_BLKTAP = "blktap"
181
182 # the set of drbd-like disk types
183 LDS_DRBD = frozenset([LD_DRBD8])
184
185 # disk access mode
186 DISK_RDONLY = "ro"
187 DISK_RDWR = "rw"
188 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
189
190 # disk replacement mode
191 REPLACE_DISK_PRI = "replace_primary"
192 REPLACE_DISK_SEC = "replace_secondary"
193 REPLACE_DISK_ALL = "replace_all"
194
195 # lock recalculate mode
196 LOCKS_REPLACE = 'replace'
197 LOCKS_APPEND = 'append'
198
199 # instance creation modes
200 INSTANCE_CREATE = "create"
201 INSTANCE_IMPORT = "import"
202
203 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
204                             DT_DRBD8, DT_FILE])
205
206 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
207
208 # import/export config options
209 INISECT_EXP = "export"
210 INISECT_INS = "instance"
211
212 # dynamic device modification
213
214 DDM_ADD = 'add'
215 DDM_REMOVE = 'remove'
216
217 # common exit codes
218 EXIT_SUCCESS = 0
219 EXIT_FAILURE = 1
220 EXIT_NOTMASTER = 11
221 EXIT_NODESETUP_ERROR = 12
222 EXIT_CONFIRMATION = 13 # need user confirmation
223
224 # tags
225 TAG_CLUSTER = "cluster"
226 TAG_NODE = "node"
227 TAG_INSTANCE = "instance"
228 MAX_TAG_LEN = 128
229 MAX_TAGS_PER_OBJ = 4096
230
231 # others
232 DEFAULT_BRIDGE = "xen-br0"
233 SYNC_SPEED = 30 * 1024
234 LOCALHOST_IP_ADDRESS = "127.0.0.1"
235 TCP_PING_TIMEOUT = 10
236 GANETI_RUNAS = "root"
237 DEFAULT_VG = "xenvg"
238 BIND_ADDRESS_GLOBAL = "0.0.0.0"
239 MIN_VG_SIZE = 20480
240
241 # os related constants
242 OS_VALID_STATUS = "VALID"
243 OS_SCRIPT_CREATE = 'create'
244 OS_SCRIPT_IMPORT = 'import'
245 OS_SCRIPT_EXPORT = 'export'
246 OS_SCRIPT_RENAME = 'rename'
247 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
248                         OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
249
250 # ssh constants
251 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
252 SSH_CONFIG_DIR = "/etc/ssh/"
253 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
254 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
255 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
256 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
257 SSH = "ssh"
258 SCP = "scp"
259
260 # reboot types
261 INSTANCE_REBOOT_SOFT = "soft"
262 INSTANCE_REBOOT_HARD = "hard"
263 INSTANCE_REBOOT_FULL = "full"
264
265 # HV parameter names (global namespace)
266 HV_BOOT_ORDER = "boot_order"
267 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
268 HV_NIC_TYPE = "nic_type"
269 HV_DISK_TYPE = "disk_type"
270 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
271 HV_ACPI = "acpi"
272 HV_PAE = "pae"
273 HV_KERNEL_PATH = "kernel_path"
274 HV_INITRD_PATH = "initrd_path"
275
276 HVS_PARAMETERS = frozenset([
277   HV_BOOT_ORDER,
278   HV_CDROM_IMAGE_PATH,
279   HV_NIC_TYPE,
280   HV_DISK_TYPE,
281   HV_VNC_BIND_ADDRESS,
282   HV_ACPI,
283   HV_PAE,
284   HV_KERNEL_PATH,
285   HV_INITRD_PATH,
286   ])
287
288 # BE parameter names
289 BE_MEMORY = "memory"
290 BE_VCPUS = "vcpus"
291 BE_AUTO_BALANCE = "auto_balance"
292
293 BES_PARAMETERS = frozenset([
294   BE_MEMORY,
295   BE_VCPUS,
296   BE_AUTO_BALANCE,
297   ])
298
299 # BE GROUP
300 BEGR_DEFAULT = "default"
301
302 # Hypervisor constants
303 HT_XEN_PVM = "xen-pvm"
304 HT_FAKE = "fake"
305 HT_XEN_HVM = "xen-hvm"
306 HT_KVM = "kvm"
307 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
308 HTS_REQ_PORT = frozenset([HT_XEN_HVM])
309
310 HT_HVM_VNC_BASE_PORT = 5900
311 HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
312 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
313 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
314
315 # HVM NIC types
316 HT_HVM_NIC_RTL8139 = "rtl8139"
317 HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
318 HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
319 HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
320 HT_HVM_DEV_IOEMU = "ioemu"
321 HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
322                                     HT_HVM_NIC_NE2K_ISA,
323                                     HT_HVM_DEV_PARAVIRTUAL])
324 HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
325
326 # Cluster Verify steps
327 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
328 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
329
330 # Allocator framework constants
331 IALLOCATOR_DIR_IN = "in"
332 IALLOCATOR_DIR_OUT = "out"
333 IALLOCATOR_MODE_ALLOC = "allocate"
334 IALLOCATOR_MODE_RELOC = "relocate"
335 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
336 IARUN_NOTFOUND = 1
337 IARUN_FAILURE = 2
338 IARUN_SUCCESS = 3
339
340 # Job queue
341 JOB_QUEUE_VERSION = 1
342 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
343 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
344 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
345 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
346 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
347
348 JOB_ID_TEMPLATE = r"\d+"
349
350 # unchanged job return
351 JOB_NOTCHANGED = "nochange"
352
353 # Job status
354 JOB_STATUS_QUEUED = "queued"
355 JOB_STATUS_WAITLOCK = "waiting"
356 JOB_STATUS_CANCELING = "canceling"
357 JOB_STATUS_RUNNING = "running"
358 JOB_STATUS_CANCELED = "canceled"
359 JOB_STATUS_SUCCESS = "success"
360 JOB_STATUS_ERROR = "error"
361
362 OP_STATUS_QUEUED = "queued"
363 OP_STATUS_WAITLOCK = "waiting"
364 OP_STATUS_CANCELING = "canceling"
365 OP_STATUS_RUNNING = "running"
366 OP_STATUS_CANCELED = "canceled"
367 OP_STATUS_SUCCESS = "success"
368 OP_STATUS_ERROR = "error"
369
370 # Execution log types
371 ELOG_MESSAGE = "message"
372 ELOG_PROGRESS = "progress"
373
374 # Temporary RAPI constants until we have cluster parameters
375 RAPI_ENABLE = True
376 RAPI_PORT = 5080
377
378 # max dynamnic devices
379 MAX_NICS = 8
380 MAX_DISKS = 16
381
382 # SSCONF keys
383 SS_CLUSTER_NAME = "cluster_name"
384 SS_FILE_STORAGE_DIR = "file_storage_dir"
385 SS_MASTER_CANDIDATES = "master_candidates"
386 SS_MASTER_IP = "master_ip"
387 SS_MASTER_NETDEV = "master_netdev"
388 SS_MASTER_NODE = "master_node"
389 SS_NODE_LIST = "node_list"
390
391 # cluster wide default parameters
392 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
393
394 HVC_DEFAULTS = {
395     HT_XEN_PVM: {
396         HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
397         HV_INITRD_PATH: None,
398         },
399     HT_XEN_HVM: {
400         HV_BOOT_ORDER: "cd",
401         HV_CDROM_IMAGE_PATH: None,
402         HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
403         HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
404         HV_VNC_BIND_ADDRESS: '0.0.0.0',
405         HV_ACPI: True,
406         HV_PAE: True,
407         },
408     HT_KVM: {
409         HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
410         HV_INITRD_PATH: None,
411         HV_ACPI: True,
412         },
413     HT_FAKE: {
414         },
415     }
416
417 BEC_DEFAULTS = {
418     BE_MEMORY: 128,
419     BE_VCPUS: 1,
420     BE_AUTO_BALANCE: True,
421     }