constants.py 10.7 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Module holding different constants."""

24
from ganeti import _autoconf
25

Iustin Pop's avatar
Iustin Pop committed
26
# various versions
27
PROTOCOL_VERSION = 13
28
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
Guido Trotter's avatar
Guido Trotter committed
29
OS_API_VERSION = 10
Iustin Pop's avatar
Iustin Pop committed
30
EXPORT_VERSION = 0
31
RAPI_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
32

33

34
35
36
37
38
39
40
41
# Format for CONFIG_VERSION:
#   01 03 0123 = 01030123
#   ^^ ^^ ^^^^
#   |  |  + Configuration version/revision
#   |  + Minor version
#   + Major version
#
# It stored as an integer. Make sure not to write an octal number.
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# BuildVersion and SplitVersion must be in here because we can't import other
# modules. The cfgupgrade tool must be able to read and write version numbers
# and thus requires these functions. To avoid code duplication, they're kept in
# here.

def BuildVersion(major, minor, revision):
  """Calculates int version number from major, minor and revision numbers.

  Returns: int representing version number

  """
  assert isinstance(major, int)
  assert isinstance(minor, int)
  assert isinstance(revision, int)
  return (1000000 * major +
            10000 * minor +
                1 * revision)


def SplitVersion(version):
  """Splits version number stored in an int.

  Returns: tuple; (major, minor, revision)

  """
  assert isinstance(version, int)

  (major, remainder) = divmod(version, 1000000)
  (minor, revision) = divmod(remainder, 10000)

  return (major, minor, revision)


76
77
78
CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
CONFIG_REVISION = 0
79
CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
Iustin Pop's avatar
Iustin Pop committed
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
87
88
89
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
# keep RUN_GANETI_DIR first here, to make sure all get created when the node
# daemon is started (this takes care of RUN_DIR being tmpfs)
SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
Iustin Pop's avatar
Iustin Pop committed
90
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
91
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
Iustin Pop's avatar
Iustin Pop committed
92
93
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
SSL_CERT_FILE = DATA_DIR + "/server.pem"
94
WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
Iustin Pop's avatar
Iustin Pop committed
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
101
102
103
104
105
106
107
108
109
110
111

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

113
# PID files
Iustin Pop's avatar
Iustin Pop committed
114
MASTERD_PID = "ganeti-masterd"
115
116
117
NODED_PID = "ganeti-noded"
RAPI_PID = "ganeti-rapi"

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

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

133
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
134
EXPORT_DIR = _autoconf.EXPORT_DIR
Iustin Pop's avatar
Iustin Pop committed
135
136
137

EXPORT_CONF_FILE = "config.ini"

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

141
142
KVM_PATH = _autoconf.KVM_PATH

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

Iustin Pop's avatar
Iustin Pop committed
148
# hooks-related constants
149
HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
Iustin Pop's avatar
Iustin Pop committed
150
151
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
152
HOOKS_NAME_CFGUPDATE = "config-update"
Iustin Pop's avatar
Iustin Pop committed
153
154
155
156
157
158
159
160
161
162
163
164
165
166
HOOKS_VERSION = 1

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

HKR_SKIP = 0
HKR_FAIL = 1
HKR_SUCCESS = 2

# disk template types
DT_DISKLESS = "diskless"
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])
Iustin Pop's avatar
Iustin Pop committed
172

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

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

Iustin Pop's avatar
Iustin Pop committed
182
183
# drbd constants
DRBD_HMAC_ALG = "md5"
184
DRBD_NET_PROTOCOL = "C"
Iustin Pop's avatar
Iustin Pop committed
185

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

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

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

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

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

207
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
208
209
210
211
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"

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

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
215
216
217
218

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
219
220

# common exit codes
Iustin Pop's avatar
Iustin Pop committed
221
EXIT_SUCCESS = 0
222
EXIT_FAILURE = 1
223
EXIT_NOTMASTER = 11
224
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
225
EXIT_CONFIRMATION = 13 # need user confirmation
226

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

234
235
# others
DEFAULT_BRIDGE = "xen-br0"
236
SYNC_SPEED = 30 * 1024
Iustin Pop's avatar
Iustin Pop committed
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
247
248
249
OS_SCRIPT_CREATE = 'create'
OS_SCRIPT_IMPORT = 'import'
OS_SCRIPT_EXPORT = 'export'
OS_SCRIPT_RENAME = 'rename'
Iustin Pop's avatar
Iustin Pop committed
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
256
257
258
259
SSH_CONFIG_DIR = "/etc/ssh/"
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
260
261
SSH = "ssh"
SCP = "scp"
262
263
264
265
266

# reboot types
INSTANCE_REBOOT_SOFT = "soft"
INSTANCE_REBOOT_HARD = "hard"
INSTANCE_REBOOT_FULL = "full"
267

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

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

291
# BE parameter names
Iustin Pop's avatar
Iustin Pop committed
292
BE_MEMORY = "memory"
293
BE_VCPUS = "vcpus"
294
BE_AUTO_BALANCE = "auto_balance"
295

Iustin Pop's avatar
Iustin Pop committed
296
297
298
BES_PARAMETERS = frozenset([
  BE_MEMORY,
  BE_VCPUS,
299
  BE_AUTO_BALANCE,
Iustin Pop's avatar
Iustin Pop committed
300
301
  ])

302
303
304
# BE GROUP
BEGR_DEFAULT = "default"

305
# Hypervisor constants
Iustin Pop's avatar
Iustin Pop committed
306
HT_XEN_PVM = "xen-pvm"
307
HT_FAKE = "fake"
Iustin Pop's avatar
Iustin Pop committed
308
HT_XEN_HVM = "xen-hvm"
Guido Trotter's avatar
Guido Trotter committed
309
HT_KVM = "kvm"
Iustin Pop's avatar
Iustin Pop committed
310
311
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
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
319
320
321
322
323
# HVM NIC types
HT_HVM_NIC_RTL8139 = "rtl8139"
HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
HT_HVM_DEV_IOEMU = "ioemu"
324
325
326
327
HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
                                    HT_HVM_NIC_NE2K_ISA,
                                    HT_HVM_DEV_PARAVIRTUAL])
HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
328

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

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

343
344
345
346
347
# Job queue
JOB_QUEUE_VERSION = 1
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
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
352
JOB_ID_TEMPLATE = r"\d+"

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

356
357
# Job status
JOB_STATUS_QUEUED = "queued"
Iustin Pop's avatar
Iustin Pop committed
358
JOB_STATUS_WAITLOCK = "waiting"
359
360
361
362
363
364
JOB_STATUS_RUNNING = "running"
JOB_STATUS_CANCELED = "canceled"
JOB_STATUS_SUCCESS = "success"
JOB_STATUS_ERROR = "error"

OP_STATUS_QUEUED = "queued"
Iustin Pop's avatar
Iustin Pop committed
365
OP_STATUS_WAITLOCK = "waiting"
366
OP_STATUS_RUNNING = "running"
367
OP_STATUS_CANCELED = "canceled"
368
369
OP_STATUS_SUCCESS = "success"
OP_STATUS_ERROR = "error"
370
371
372
373

# Execution log types
ELOG_MESSAGE = "message"
ELOG_PROGRESS = "progress"
374
375
376
377

# Temporary RAPI constants until we have cluster parameters
RAPI_ENABLE = True
RAPI_PORT = 5080
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409

# cluster wide default parameters
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM

HVC_DEFAULTS = {
    HT_XEN_PVM: {
        HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
        HV_INITRD_PATH: None,
        },
    HT_XEN_HVM: {
        HV_BOOT_ORDER: "cd",
        HV_CDROM_IMAGE_PATH: None,
        HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
        HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
        HV_VNC_BIND_ADDRESS: '0.0.0.0',
        HV_ACPI: True,
        HV_PAE: True,
        },
    HT_KVM: {
        HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
        HV_INITRD_PATH: None,
        HV_ACPI: True,
        },
    HT_FAKE: {
        },
    }

BEC_DEFAULTS = {
    BE_MEMORY: 128,
    BE_VCPUS: 1,
    BE_AUTO_BALANCE: True,
    }