Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ ec17d09c

History | View | Annotate | Download (10.7 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
# keep RUN_GANETI_DIR first here, to make sure all get created when the node
88
# daemon is started (this takes care of RUN_DIR being tmpfs)
89
SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
90
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
91
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
92
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
93
SSL_CERT_FILE = DATA_DIR + "/server.pem"
94
WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
95
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
96
QUEUE_DIR = DATA_DIR + "/queue"
97
ETC_HOSTS = "/etc/hosts"
98
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
99

    
100
# Quoting unix(7) on Linux:
101
#   Linux also supports an abstract namespace which is independent of the file
102
#   system. [...] If sun_path starts with a null byte ('\0'), then it refers to
103
#   the abstract namespace maintained by the Unix protocol module. The socket's
104
#   address in this namespace is given by the rest of the bytes in sun_path.
105
#
106
# By using this Linux-specific way we don't have to care about removing the
107
# socket file when quitting or starting (after an unclean shutdown).
108
#
109
# Sample output for "netstat -nlp":
110
#   unix 2 [ ACC ] STREAM LISTENING 247919 1234/python @ganeti-master
111
MASTER_SOCKET = "\0ganeti-master"
112

    
113
# PID files
114
MASTERD_PID = "ganeti-masterd"
115
NODED_PID = "ganeti-noded"
116
RAPI_PID = "ganeti-rapi"
117

    
118
NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
119
DEFAULT_NODED_PORT = 1811
120
FIRST_DRBD_PORT = 11000
121
LAST_DRBD_PORT = 14999
122
MASTER_SCRIPT = "ganeti-master"
123

    
124
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
125
LOG_OS_DIR = LOG_DIR + "os"
126
LOG_NODESERVER = LOG_DIR + "node-daemon.log"
127
LOG_WATCHER = LOG_DIR + "watcher.log"
128
LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
129
LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
130
LOG_COMMANDS = LOG_DIR + "commands.log"
131
LOG_BURNIN = LOG_DIR + "burnin.log"
132

    
133
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
134
EXPORT_DIR = _autoconf.EXPORT_DIR
135

    
136
EXPORT_CONF_FILE = "config.ini"
137

    
138
XEN_KERNEL = _autoconf.XEN_KERNEL
139
XEN_INITRD = _autoconf.XEN_INITRD
140

    
141
KVM_PATH = _autoconf.KVM_PATH
142

    
143
VALUE_DEFAULT = "default"
144
VALUE_AUTO = "auto"
145
VALUE_GENERATE = "generate"
146
VALUE_NONE = "none"
147

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

    
155
# hooks subject type (what object type does the LU deal with)
156
HTYPE_CLUSTER = "CLUSTER"
157
HTYPE_NODE = "NODE"
158
HTYPE_INSTANCE = "INSTANCE"
159

    
160
HKR_SKIP = 0
161
HKR_FAIL = 1
162
HKR_SUCCESS = 2
163

    
164
# disk template types
165
DT_DISKLESS = "diskless"
166
DT_PLAIN = "plain"
167
DT_DRBD8 = "drbd"
168
DT_FILE = "file"
169

    
170
# the set of network-mirrored disk templates
171
DTS_NET_MIRROR = frozenset([DT_DRBD8])
172

    
173
# the set of non-lvm-based disk templates
174
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
175

    
176
# logical disk types
177
LD_LV = "lvm"
178
LD_DRBD8 = "drbd8"
179
LD_FILE = "file"
180
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
181

    
182
# drbd constants
183
DRBD_HMAC_ALG = "md5"
184
DRBD_NET_PROTOCOL = "C"
185

    
186
# file backend driver
187
FD_LOOP = "loop"
188
FD_BLKTAP = "blktap"
189

    
190
# the set of drbd-like disk types
191
LDS_DRBD = frozenset([LD_DRBD8])
192

    
193
# disk access mode
194
DISK_RDONLY = "r"
195
DISK_RDWR = "w"
196
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
197

    
198
# disk replacement mode
199
REPLACE_DISK_PRI = "replace_primary"
200
REPLACE_DISK_SEC = "replace_secondary"
201
REPLACE_DISK_ALL = "replace_all"
202

    
203
# lock recalculate mode
204
LOCKS_REPLACE = 'replace'
205
LOCKS_APPEND = 'append'
206

    
207
# instance creation modes
208
INSTANCE_CREATE = "create"
209
INSTANCE_IMPORT = "import"
210

    
211
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
212
                            DT_DRBD8, DT_FILE])
213

    
214
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
215

    
216
# import/export config options
217
INISECT_EXP = "export"
218
INISECT_INS = "instance"
219

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

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

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

    
244
# os related constants
245
OS_VALID_STATUS = "VALID"
246
OS_SCRIPT_CREATE = 'create'
247
OS_SCRIPT_IMPORT = 'import'
248
OS_SCRIPT_EXPORT = 'export'
249
OS_SCRIPT_RENAME = 'rename'
250
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
251
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
252

    
253
# ssh constants
254
SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
255
SSH_CONFIG_DIR = "/etc/ssh/"
256
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
257
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
258
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
259
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
260
SSH = "ssh"
261
SCP = "scp"
262

    
263
# reboot types
264
INSTANCE_REBOOT_SOFT = "soft"
265
INSTANCE_REBOOT_HARD = "hard"
266
INSTANCE_REBOOT_FULL = "full"
267

    
268
# HV parameter names (global namespace)
269
HV_BOOT_ORDER = "boot_order"
270
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
271
HV_NIC_TYPE = "nic_type"
272
HV_DISK_TYPE = "disk_type"
273
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
274
HV_ACPI = "acpi"
275
HV_PAE = "pae"
276
HV_KERNEL_PATH = "kernel_path"
277
HV_INITRD_PATH = "initrd_path"
278

    
279
HVS_PARAMETERS = frozenset([
280
  HV_BOOT_ORDER,
281
  HV_CDROM_IMAGE_PATH,
282
  HV_NIC_TYPE,
283
  HV_DISK_TYPE,
284
  HV_VNC_BIND_ADDRESS,
285
  HV_ACPI,
286
  HV_PAE,
287
  HV_KERNEL_PATH,
288
  HV_INITRD_PATH,
289
  ])
290

    
291
# BE parameter names
292
BE_MEMORY = "memory"
293
BE_VCPUS = "vcpus"
294
BE_AUTO_BALANCE = "auto_balance"
295

    
296
BES_PARAMETERS = frozenset([
297
  BE_MEMORY,
298
  BE_VCPUS,
299
  BE_AUTO_BALANCE,
300
  ])
301

    
302
# BE GROUP
303
BEGR_DEFAULT = "default"
304

    
305
# Hypervisor constants
306
HT_XEN_PVM = "xen-pvm"
307
HT_FAKE = "fake"
308
HT_XEN_HVM = "xen-hvm"
309
HT_KVM = "kvm"
310
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
311
HTS_REQ_PORT = frozenset([HT_XEN_HVM])
312

    
313
HT_HVM_VNC_BASE_PORT = 5900
314
HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
315
VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
316
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
317

    
318
# HVM NIC types
319
HT_HVM_NIC_RTL8139 = "rtl8139"
320
HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
321
HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
322
HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
323
HT_HVM_DEV_IOEMU = "ioemu"
324
HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
325
                                    HT_HVM_NIC_NE2K_ISA,
326
                                    HT_HVM_DEV_PARAVIRTUAL])
327
HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
328

    
329
# Cluster Verify steps
330
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
331
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
332

    
333
# Allocator framework constants
334
IALLOCATOR_DIR_IN = "in"
335
IALLOCATOR_DIR_OUT = "out"
336
IALLOCATOR_MODE_ALLOC = "allocate"
337
IALLOCATOR_MODE_RELOC = "relocate"
338
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
339
IARUN_NOTFOUND = 1
340
IARUN_FAILURE = 2
341
IARUN_SUCCESS = 3
342

    
343
# Job queue
344
JOB_QUEUE_VERSION = 1
345
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
346
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
347
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
348
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
349
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
350

    
351
JOB_ID_TEMPLATE = r"\d+"
352

    
353
# unchanged job return
354
JOB_NOTCHANGED = "nochange"
355

    
356
# Job status
357
JOB_STATUS_QUEUED = "queued"
358
JOB_STATUS_WAITLOCK = "waiting"
359
JOB_STATUS_RUNNING = "running"
360
JOB_STATUS_CANCELED = "canceled"
361
JOB_STATUS_SUCCESS = "success"
362
JOB_STATUS_ERROR = "error"
363

    
364
OP_STATUS_QUEUED = "queued"
365
OP_STATUS_WAITLOCK = "waiting"
366
OP_STATUS_RUNNING = "running"
367
OP_STATUS_CANCELED = "canceled"
368
OP_STATUS_SUCCESS = "success"
369
OP_STATUS_ERROR = "error"
370

    
371
# Execution log types
372
ELOG_MESSAGE = "message"
373
ELOG_PROGRESS = "progress"
374

    
375
# Temporary RAPI constants until we have cluster parameters
376
RAPI_ENABLE = True
377
RAPI_PORT = 5080
378

    
379
# cluster wide default parameters
380
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
381

    
382
HVC_DEFAULTS = {
383
    HT_XEN_PVM: {
384
        HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
385
        HV_INITRD_PATH: None,
386
        },
387
    HT_XEN_HVM: {
388
        HV_BOOT_ORDER: "cd",
389
        HV_CDROM_IMAGE_PATH: None,
390
        HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
391
        HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
392
        HV_VNC_BIND_ADDRESS: '0.0.0.0',
393
        HV_ACPI: True,
394
        HV_PAE: True,
395
        },
396
    HT_KVM: {
397
        HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
398
        HV_INITRD_PATH: None,
399
        HV_ACPI: True,
400
        },
401
    HT_FAKE: {
402
        },
403
    }
404

    
405
BEC_DEFAULTS = {
406
    BE_MEMORY: 128,
407
    BE_VCPUS: 1,
408
    BE_AUTO_BALANCE: True,
409
    }