Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 7e9366f7

History | View | Annotate | Download (11.5 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
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

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

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

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

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

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

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

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

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

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

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

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

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

    
195
# disk replacement mode
196
REPLACE_DISK_PRI = "replace_primary"   # replace disks on primary
197
REPLACE_DISK_SEC = "replace_secondary" # replace disks on secondary
198
REPLACE_DISK_CHG = "replace_all"       # change secondary node
199

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

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

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

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

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

    
217
# dynamic device modification
218

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

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

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

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

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

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

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

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

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

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

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

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

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

    
312
# BE GROUP
313
BEGR_DEFAULT = "default"
314

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

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

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

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

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

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

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

    
374
JOB_ID_TEMPLATE = r"\d+"
375

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

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

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

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

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

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

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

    
418
# cluster wide default parameters
419
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
420

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

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

    
450
MASTER_POOL_SIZE_DEFAULT = 10