Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ b5b67ef9

History | View | Annotate | Download (11.4 kB)

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
RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
100
QUEUE_DIR = DATA_DIR + "/queue"
101
ETC_HOSTS = "/etc/hosts"
102
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
103

    
104
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
105

    
106
# PID files
107
MASTERD_PID = "ganeti-masterd"
108
NODED_PID = "ganeti-noded"
109
RAPI_PID = "ganeti-rapi"
110

    
111
NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
112
DEFAULT_NODED_PORT = 1811
113
FIRST_DRBD_PORT = 11000
114
LAST_DRBD_PORT = 14999
115
MASTER_SCRIPT = "ganeti-master"
116

    
117
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
118
LOG_OS_DIR = LOG_DIR + "os"
119
LOG_NODESERVER = LOG_DIR + "node-daemon.log"
120
LOG_WATCHER = LOG_DIR + "watcher.log"
121
LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
122
LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
123
LOG_COMMANDS = LOG_DIR + "commands.log"
124
LOG_BURNIN = LOG_DIR + "burnin.log"
125

    
126
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
127
EXPORT_DIR = _autoconf.EXPORT_DIR
128

    
129
EXPORT_CONF_FILE = "config.ini"
130

    
131
XEN_KERNEL = _autoconf.XEN_KERNEL
132
XEN_INITRD = _autoconf.XEN_INITRD
133

    
134
KVM_PATH = _autoconf.KVM_PATH
135
SOCAT_PATH = _autoconf.SOCAT_PATH
136

    
137
VALUE_DEFAULT = "default"
138
VALUE_AUTO = "auto"
139
VALUE_GENERATE = "generate"
140
VALUE_NONE = "none"
141
VALUE_TRUE = "true"
142
VALUE_FALSE = "false"
143

    
144
# hooks-related constants
145
HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
146
HOOKS_PHASE_PRE = "pre"
147
HOOKS_PHASE_POST = "post"
148
HOOKS_NAME_CFGUPDATE = "config-update"
149
HOOKS_VERSION = 1
150

    
151
# hooks subject type (what object type does the LU deal with)
152
HTYPE_CLUSTER = "CLUSTER"
153
HTYPE_NODE = "NODE"
154
HTYPE_INSTANCE = "INSTANCE"
155

    
156
HKR_SKIP = 0
157
HKR_FAIL = 1
158
HKR_SUCCESS = 2
159

    
160
# disk template types
161
DT_DISKLESS = "diskless"
162
DT_PLAIN = "plain"
163
DT_DRBD8 = "drbd"
164
DT_FILE = "file"
165

    
166
# the set of network-mirrored disk templates
167
DTS_NET_MIRROR = frozenset([DT_DRBD8])
168

    
169
# the set of non-lvm-based disk templates
170
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
171

    
172
# logical disk types
173
LD_LV = "lvm"
174
LD_DRBD8 = "drbd8"
175
LD_FILE = "file"
176
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
177

    
178
# drbd constants
179
DRBD_HMAC_ALG = "md5"
180
DRBD_NET_PROTOCOL = "C"
181

    
182
# file backend driver
183
FD_LOOP = "loop"
184
FD_BLKTAP = "blktap"
185

    
186
# the set of drbd-like disk types
187
LDS_DRBD = frozenset([LD_DRBD8])
188

    
189
# disk access mode
190
DISK_RDONLY = "ro"
191
DISK_RDWR = "rw"
192
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
193

    
194
# disk replacement mode
195
REPLACE_DISK_PRI = "replace_primary"
196
REPLACE_DISK_SEC = "replace_secondary"
197
REPLACE_DISK_ALL = "replace_all"
198

    
199
# lock recalculate mode
200
LOCKS_REPLACE = 'replace'
201
LOCKS_APPEND = 'append'
202

    
203
# instance creation modes
204
INSTANCE_CREATE = "create"
205
INSTANCE_IMPORT = "import"
206

    
207
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
208
                            DT_DRBD8, DT_FILE])
209

    
210
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
211

    
212
# import/export config options
213
INISECT_EXP = "export"
214
INISECT_INS = "instance"
215

    
216
# dynamic device modification
217

    
218
DDM_ADD = 'add'
219
DDM_REMOVE = 'remove'
220

    
221
# common exit codes
222
EXIT_SUCCESS = 0
223
EXIT_FAILURE = 1
224
EXIT_NOTMASTER = 11
225
EXIT_NODESETUP_ERROR = 12
226
EXIT_CONFIRMATION = 13 # need user confirmation
227

    
228
# tags
229
TAG_CLUSTER = "cluster"
230
TAG_NODE = "node"
231
TAG_INSTANCE = "instance"
232
MAX_TAG_LEN = 128
233
MAX_TAGS_PER_OBJ = 4096
234

    
235
# others
236
DEFAULT_BRIDGE = "xen-br0"
237
SYNC_SPEED = 30 * 1024
238
LOCALHOST_IP_ADDRESS = "127.0.0.1"
239
TCP_PING_TIMEOUT = 10
240
GANETI_RUNAS = "root"
241
DEFAULT_VG = "xenvg"
242
BIND_ADDRESS_GLOBAL = "0.0.0.0"
243
MIN_VG_SIZE = 20480
244

    
245
# RPC constants
246
(RPC_ENCODING_NONE,
247
 RPC_ENCODING_ZLIB_BASE64) = range(2)
248

    
249
# os related constants
250
OS_VALID_STATUS = "VALID"
251
OS_SCRIPT_CREATE = 'create'
252
OS_SCRIPT_IMPORT = 'import'
253
OS_SCRIPT_EXPORT = 'export'
254
OS_SCRIPT_RENAME = 'rename'
255
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
256
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
257

    
258
# ssh constants
259
SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
260
SSH_CONFIG_DIR = "/etc/ssh/"
261
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
262
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
263
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
264
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
265
SSH = "ssh"
266
SCP = "scp"
267

    
268
# reboot types
269
INSTANCE_REBOOT_SOFT = "soft"
270
INSTANCE_REBOOT_HARD = "hard"
271
INSTANCE_REBOOT_FULL = "full"
272

    
273
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
274
                          INSTANCE_REBOOT_HARD,
275
                          INSTANCE_REBOOT_FULL])
276

    
277
# HV parameter names (global namespace)
278
HV_BOOT_ORDER = "boot_order"
279
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
280
HV_NIC_TYPE = "nic_type"
281
HV_DISK_TYPE = "disk_type"
282
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
283
HV_ACPI = "acpi"
284
HV_PAE = "pae"
285
HV_KERNEL_PATH = "kernel_path"
286
HV_INITRD_PATH = "initrd_path"
287

    
288
HVS_PARAMETERS = frozenset([
289
  HV_BOOT_ORDER,
290
  HV_CDROM_IMAGE_PATH,
291
  HV_NIC_TYPE,
292
  HV_DISK_TYPE,
293
  HV_VNC_BIND_ADDRESS,
294
  HV_ACPI,
295
  HV_PAE,
296
  HV_KERNEL_PATH,
297
  HV_INITRD_PATH,
298
  ])
299

    
300
# BE parameter names
301
BE_MEMORY = "memory"
302
BE_VCPUS = "vcpus"
303
BE_AUTO_BALANCE = "auto_balance"
304

    
305
BES_PARAMETERS = frozenset([
306
  BE_MEMORY,
307
  BE_VCPUS,
308
  BE_AUTO_BALANCE,
309
  ])
310

    
311
# BE GROUP
312
BEGR_DEFAULT = "default"
313

    
314
# Hypervisor constants
315
HT_XEN_PVM = "xen-pvm"
316
HT_FAKE = "fake"
317
HT_XEN_HVM = "xen-hvm"
318
HT_KVM = "kvm"
319
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
320
HTS_REQ_PORT = frozenset([HT_XEN_HVM])
321

    
322
HT_HVM_VNC_BASE_PORT = 5900
323
HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
324
VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
325
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
326

    
327
# HVM NIC types
328
HT_HVM_NIC_RTL8139 = "rtl8139"
329
HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
330
HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
331
HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
332
HT_HVM_DEV_IOEMU = "ioemu"
333
HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
334
                                    HT_HVM_NIC_NE2K_ISA,
335
                                    HT_HVM_DEV_PARAVIRTUAL])
336
HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
337

    
338
# Cluster Verify steps
339
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
340
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
341

    
342
# Node verify constants
343
NV_FILELIST = "filelist"
344
NV_HVINFO = "hvinfo"
345
NV_HYPERVISOR = "hypervisor"
346
NV_INSTANCELIST = "instancelist"
347
NV_LVLIST = "lvlist"
348
NV_NODELIST = "nodelist"
349
NV_NODENETTEST = "node-net-test"
350
NV_VERSION = "version"
351
NV_VGLIST = "vglist"
352

    
353
# Allocator framework constants
354
IALLOCATOR_DIR_IN = "in"
355
IALLOCATOR_DIR_OUT = "out"
356
IALLOCATOR_MODE_ALLOC = "allocate"
357
IALLOCATOR_MODE_RELOC = "relocate"
358
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
359
IARUN_NOTFOUND = 1
360
IARUN_FAILURE = 2
361
IARUN_SUCCESS = 3
362

    
363
# Job queue
364
JOB_QUEUE_VERSION = 1
365
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
366
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
367
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
368
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
369
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
370
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
371
JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
372

    
373
JOB_ID_TEMPLATE = r"\d+"
374

    
375
# unchanged job return
376
JOB_NOTCHANGED = "nochange"
377

    
378
# Job status
379
JOB_STATUS_QUEUED = "queued"
380
JOB_STATUS_WAITLOCK = "waiting"
381
JOB_STATUS_CANCELING = "canceling"
382
JOB_STATUS_RUNNING = "running"
383
JOB_STATUS_CANCELED = "canceled"
384
JOB_STATUS_SUCCESS = "success"
385
JOB_STATUS_ERROR = "error"
386

    
387
OP_STATUS_QUEUED = "queued"
388
OP_STATUS_WAITLOCK = "waiting"
389
OP_STATUS_CANCELING = "canceling"
390
OP_STATUS_RUNNING = "running"
391
OP_STATUS_CANCELED = "canceled"
392
OP_STATUS_SUCCESS = "success"
393
OP_STATUS_ERROR = "error"
394

    
395
# Execution log types
396
ELOG_MESSAGE = "message"
397
ELOG_PROGRESS = "progress"
398

    
399
# Temporary RAPI constants until we have cluster parameters
400
RAPI_ENABLE = True
401
RAPI_PORT = 5080
402

    
403
# max dynamnic devices
404
MAX_NICS = 8
405
MAX_DISKS = 16
406

    
407
# SSCONF keys
408
SS_CLUSTER_NAME = "cluster_name"
409
SS_FILE_STORAGE_DIR = "file_storage_dir"
410
SS_MASTER_CANDIDATES = "master_candidates"
411
SS_MASTER_IP = "master_ip"
412
SS_MASTER_NETDEV = "master_netdev"
413
SS_MASTER_NODE = "master_node"
414
SS_NODE_LIST = "node_list"
415
SS_OFFLINE_NODES = "offline_nodes"
416

    
417
# cluster wide default parameters
418
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
419

    
420
HVC_DEFAULTS = {
421
    HT_XEN_PVM: {
422
        HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
423
        HV_INITRD_PATH: None,
424
        },
425
    HT_XEN_HVM: {
426
        HV_BOOT_ORDER: "cd",
427
        HV_CDROM_IMAGE_PATH: None,
428
        HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
429
        HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
430
        HV_VNC_BIND_ADDRESS: '0.0.0.0',
431
        HV_ACPI: True,
432
        HV_PAE: True,
433
        },
434
    HT_KVM: {
435
        HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
436
        HV_INITRD_PATH: None,
437
        HV_ACPI: True,
438
        },
439
    HT_FAKE: {
440
        },
441
    }
442

    
443
BEC_DEFAULTS = {
444
    BE_MEMORY: 128,
445
    BE_VCPUS: 1,
446
    BE_AUTO_BALANCE: True,
447
    }
448

    
449
MASTER_POOL_SIZE_DEFAULT = 10