constants.py 23.8 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
25
import re

26
from ganeti import _autoconf
27

Iustin Pop's avatar
Iustin Pop committed
28
# various versions
29
PROTOCOL_VERSION = 30
30
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
Guido Trotter's avatar
Guido Trotter committed
31
32
33
OS_API_V10 = 10
OS_API_V15 = 15
OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15])
Iustin Pop's avatar
Iustin Pop committed
34
EXPORT_VERSION = 0
35
RAPI_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
36

37

38
39
40
41
42
43
44
45
# 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.
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
76
77
78
79

# 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)


80
81
82
CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
CONFIG_REVISION = 0
83
CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
Iustin Pop's avatar
Iustin Pop committed
84
85

# file paths
86
DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
87
RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
88
RUN_GANETI_DIR = RUN_DIR + "/ganeti"
89
BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
90
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
91
RUN_DIRS_MODE = 0755
Guido Trotter's avatar
Guido Trotter committed
92
SOCKET_DIR = RUN_GANETI_DIR + "/socket"
Guido Trotter's avatar
Guido Trotter committed
93
SOCKET_DIR_MODE = 0700
94
95
CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
CRYPTO_KEYS_DIR_MODE = 0700
96
97
IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
IMPORT_EXPORT_DIR_MODE = 0755
98
99
100
# 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
101
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
102
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
103
104
105
# User-id pool lock directory
# The user-ids that are in use have a corresponding lock file in this directory
UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
Iustin Pop's avatar
Iustin Pop committed
106
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
107
NODED_CERT_FILE = DATA_DIR + "/server.pem"
108
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
109
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
Michael Hanselmann's avatar
Michael Hanselmann committed
110
CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
111
WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
112
WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
113
INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
Iustin Pop's avatar
Iustin Pop committed
114
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
115
RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
116
QUEUE_DIR = DATA_DIR + "/queue"
117
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
118
ETC_HOSTS = "/etc/hosts"
119
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
120
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
121
SYSCONFDIR = _autoconf.SYSCONFDIR
122
TOOLSDIR = _autoconf.TOOLSDIR
123
CONF_DIR = SYSCONFDIR + "/ganeti"
124

125
ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
126

127
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
128

129
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
130
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
131
RAPI = "ganeti-rapi"
132
MASTERD = "ganeti-masterd"
Guido Trotter's avatar
Guido Trotter committed
133
134
# used in the ganeti-nbma project
NLD = "ganeti-nld"
135
136
137
138

DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
139
  CONFD: ("udp", 1814),
Guido Trotter's avatar
Guido Trotter committed
140
  RAPI: ("tcp", 5080),
Guido Trotter's avatar
Guido Trotter committed
141
142
  # used in the ganeti-nbma project
  NLD: ("udp", 1816),
143
144
}
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
145
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
Guido Trotter's avatar
Guido Trotter committed
146
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
Guido Trotter's avatar
Guido Trotter committed
147
148
# used in the ganeti-nbma project
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
149

Iustin Pop's avatar
Iustin Pop committed
150
151
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999
152
MASTER_SCRIPT = "ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
153

154
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
155
DAEMONS_LOGFILES = {
Michael Hanselmann's avatar
Michael Hanselmann committed
156
157
158
159
160
  # "daemon-name": "logfile"
  NODED: LOG_DIR + "node-daemon.log",
  CONFD: LOG_DIR + "conf-daemon.log",
  RAPI: LOG_DIR + "rapi-daemon.log",
  MASTERD: LOG_DIR + "master-daemon.log",
Guido Trotter's avatar
Guido Trotter committed
161
162
  # used in the ganeti-nbma project
  NLD: LOG_DIR + "nl-daemon.log",
Michael Hanselmann's avatar
Michael Hanselmann committed
163
  }
Michael Hanselmann's avatar
Michael Hanselmann committed
164

165
166
167
LOG_OS_DIR = LOG_DIR + "os"
LOG_WATCHER = LOG_DIR + "watcher.log"
LOG_COMMANDS = LOG_DIR + "commands.log"
Iustin Pop's avatar
Iustin Pop committed
168
LOG_BURNIN = LOG_DIR + "burnin.log"
Iustin Pop's avatar
Iustin Pop committed
169

170
171
172
173
174
175
176
# one of 'no', 'yes', 'only'
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

177
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
178
EXPORT_DIR = _autoconf.EXPORT_DIR
Iustin Pop's avatar
Iustin Pop committed
179
180
181

EXPORT_CONF_FILE = "config.ini"

182
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
183
184
185
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD

186
KVM_PATH = _autoconf.KVM_PATH
Guido Trotter's avatar
Guido Trotter committed
187
SOCAT_PATH = _autoconf.SOCAT_PATH
188
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
189
SOCAT_ESCAPE_CODE = "0x1d"
190

191
192
193
194
195
196
197
198
# For RSA keys more bits are better, but they also make operations more
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
# 2010 on.
RSA_KEY_BITS = 2048

# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
X509_CERT_SIGN_DIGEST = "SHA1"

199
200
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

201
202
203
204
205
206
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"

# Import/export daemon mode
IEM_IMPORT = "import"
IEM_EXPORT = "export"

207
208
209
210
211
212
213
214
# Import/export I/O
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
IEIO_FILE = "file"
# Raw block device I/O using "dd"
IEIO_RAW_DISK = "raw"
# OS definition import/export script
IEIO_SCRIPT = "script"

215
VALUE_DEFAULT = "default"
216
217
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
218
VALUE_NONE = "none"
219
220
VALUE_TRUE = "true"
VALUE_FALSE = "false"
221

222
223
224
# External script validation mask
EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")

Iustin Pop's avatar
Iustin Pop committed
225
# hooks-related constants
226
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
Iustin Pop's avatar
Iustin Pop committed
227
228
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
229
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
230
HOOKS_NAME_WATCHER = "watcher"
231
HOOKS_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
232
233
234
235
236
237
238
239
240
241

# 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

242
243
244
245
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
246
247

# Storage fields
248
249
250
251
# first two are valid in LU context only, not passed to backend
SF_NODE = "node"
SF_TYPE = "type"
# and the rest are valid in backend
252
253
254
255
256
257
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

258
259
260
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

261
# Available fields per storage type
262
263
264
265
VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
                                  SF_USED, SF_FREE, SF_ALLOCATABLE])

VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
Iustin Pop's avatar
Iustin Pop committed
266

267
268
269
270
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

271
VALID_STORAGE_OPERATIONS = {
272
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
273
274
  }

275
276
277
278
279
280
# Local disk status
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
(LDS_OKAY,
 LDS_UNKNOWN,
 LDS_FAULTY) = range(1, 4)

Iustin Pop's avatar
Iustin Pop committed
281
282
283
# disk template types
DT_DISKLESS = "diskless"
DT_PLAIN = "plain"
284
DT_DRBD8 = "drbd"
285
DT_FILE = "file"
286
287

# the set of network-mirrored disk templates
288
DTS_NET_MIRROR = frozenset([DT_DRBD8])
Iustin Pop's avatar
Iustin Pop committed
289

290
291
292
# the set of non-lvm-based disk templates
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])

293
# the set of disk templates which can be grown
Guido Trotter's avatar
Guido Trotter committed
294
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
295

296
297
# logical disk types
LD_LV = "lvm"
298
LD_DRBD8 = "drbd8"
299
LD_FILE = "file"
300
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
301

Iustin Pop's avatar
Iustin Pop committed
302
303
# drbd constants
DRBD_HMAC_ALG = "md5"
304
DRBD_NET_PROTOCOL = "C"
305
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
Iustin Pop's avatar
Iustin Pop committed
306

307
308
309
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
310
311

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

314
# disk access mode
315
316
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
317
318
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

319
# disk replacement mode
320
321
322
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
323
REPLACE_DISK_AUTO = "replace_auto"
324

325
326
# lock recalculate mode
LOCKS_REPLACE = 'replace'
327
LOCKS_APPEND = 'append'
328

329
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
330
331
332
333
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"

DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
334
335
336
                            DT_DRBD8, DT_FILE])

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
337
338
339
340

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
341
342
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
343

344
345
346
347
348
# dynamic device modification

DDM_ADD = 'add'
DDM_REMOVE = 'remove'

349
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
350
EXIT_SUCCESS = 0
351
EXIT_FAILURE = 1
352
EXIT_NOTCLUSTER = 5
353
EXIT_NOTMASTER = 11
354
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
355
EXIT_CONFIRMATION = 13 # need user confirmation
Guido Trotter's avatar
Guido Trotter committed
356
EXIT_NOTCANDIDATE = 14
357

358
359
360
361
362
363
364
# tags
TAG_CLUSTER = "cluster"
TAG_NODE = "node"
TAG_INSTANCE = "instance"
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

365
366
# others
DEFAULT_BRIDGE = "xen-br0"
Iustin Pop's avatar
Iustin Pop committed
367
SYNC_SPEED = 60 * 1024
Iustin Pop's avatar
Iustin Pop committed
368
LOCALHOST_IP_ADDRESS = "127.0.0.1"
369
TCP_PING_TIMEOUT = 10
370
GANETI_RUNAS = "root"
371
DEFAULT_VG = "xenvg"
372
BIND_ADDRESS_GLOBAL = "0.0.0.0"
373
MIN_VG_SIZE = 20480
374
DEFAULT_MAC_PREFIX = "aa:00:00"
375
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
376
377
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
378
NODE_MAX_CLOCK_SKEW = 150
379

380
381
382
383
384
385
386
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])

387
388
389
390
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

391
392
393
394
395
# os related constants
OS_SCRIPT_CREATE = 'create'
OS_SCRIPT_IMPORT = 'import'
OS_SCRIPT_EXPORT = 'export'
OS_SCRIPT_RENAME = 'rename'
Iustin Pop's avatar
Iustin Pop committed
396
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
397
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
398

399
OS_API_FILE = 'ganeti_api_version'
400
OS_VARIANTS_FILE = 'variants.list'
401

402
# ssh constants
403
404
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
405
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
406
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
407
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
408
409
SSH = "ssh"
SCP = "scp"
410
411
412
413
414

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

416
417
418
419
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
                          INSTANCE_REBOOT_HARD,
                          INSTANCE_REBOOT_FULL])

420
421
422
423
424
425
426
427
428
429
430
VTYPE_STRING = 'string'
VTYPE_BOOL = 'bool'
VTYPE_SIZE = 'size' # size, in MiBs
VTYPE_INT = 'int'
ENFORCEABLE_TYPES = frozenset([
                      VTYPE_STRING,
                      VTYPE_BOOL,
                      VTYPE_SIZE,
                      VTYPE_INT,
                      ])

431
432
433
434
435
436
# 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"
437
HV_VNC_PASSWORD_FILE = "vnc_password_file"
438
439
440
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
441
442
HV_ACPI = "acpi"
HV_PAE = "pae"
443
444
445
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
446
HV_KERNEL_ARGS = "kernel_args"
447
448
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
449
HV_ROOT_PATH = "root_path"
450
HV_SERIAL_CONSOLE = "serial_console"
451
HV_USB_MOUSE = "usb_mouse"
452
HV_DEVICE_MODEL = "device_model"
453
HV_INIT_SCRIPT = "init_script"
454
HV_MIGRATION_PORT = "migration_port"
455
HV_USE_LOCALTIME = "use_localtime"
456
HV_DISK_CACHE = "disk_cache"
457
458
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
459
HV_KVM_FLAG = "kvm_flag"
460

461
462
463
464
465
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
466
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
467
468
469
470
471
472
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
  HV_VNC_TLS: VTYPE_BOOL,
  HV_VNC_X509: VTYPE_STRING,
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
  HV_ACPI: VTYPE_BOOL,
  HV_PAE: VTYPE_BOOL,
473
474
475
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
476
  HV_KERNEL_PATH: VTYPE_STRING,
477
  HV_KERNEL_ARGS: VTYPE_STRING,
478
479
480
481
  HV_INITRD_PATH: VTYPE_STRING,
  HV_ROOT_PATH: VTYPE_STRING,
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
482
  HV_DEVICE_MODEL: VTYPE_STRING,
483
  HV_INIT_SCRIPT: VTYPE_STRING,
484
  HV_MIGRATION_PORT: VTYPE_INT,
485
  HV_USE_LOCALTIME: VTYPE_BOOL,
486
  HV_DISK_CACHE: VTYPE_STRING,
487
488
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
489
  HV_KVM_FLAG: VTYPE_STRING,
490
491
492
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
493

494
# BE parameter names
Iustin Pop's avatar
Iustin Pop committed
495
BE_MEMORY = "memory"
496
BE_VCPUS = "vcpus"
497
BE_AUTO_BALANCE = "auto_balance"
498

499
500
501
502
503
504
505
BES_PARAMETER_TYPES = {
    BE_MEMORY: VTYPE_SIZE,
    BE_VCPUS: VTYPE_INT,
    BE_AUTO_BALANCE: VTYPE_BOOL,
    }

BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
Iustin Pop's avatar
Iustin Pop committed
506

507
508
# Instance Parameters Profile
PP_DEFAULT = "default"
509

Guido Trotter's avatar
Guido Trotter committed
510
511
512
513
514
515
516
517
518
519
520
521
522
523
NIC_MODE = "mode"
NIC_LINK = "link"

NIC_MODE_BRIDGED = "bridged"
NIC_MODE_ROUTED = "routed"

NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])

NICS_PARAMETER_TYPES = {
    NIC_MODE: VTYPE_STRING,
    NIC_LINK: VTYPE_STRING,
    }

NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
524

525
# Hypervisor constants
Iustin Pop's avatar
Iustin Pop committed
526
HT_XEN_PVM = "xen-pvm"
527
HT_FAKE = "fake"
Iustin Pop's avatar
Iustin Pop committed
528
HT_XEN_HVM = "xen-hvm"
Guido Trotter's avatar
Guido Trotter committed
529
HT_KVM = "kvm"
530
531
HT_CHROOT = "chroot"
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
Guido Trotter's avatar
Guido Trotter committed
532
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
533

534
VNC_BASE_PORT = 5900
535
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
536
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
537

538
# NIC types
539
540
541
HT_NIC_RTL8139 = "rtl8139"
HT_NIC_NE2K_PCI = "ne2k_pci"
HT_NIC_NE2K_ISA = "ne2k_isa"
542
543
544
545
546
HT_NIC_I82551 = "i82551"
HT_NIC_I85557B = "i82557b"
HT_NIC_I8259ER = "i82559er"
HT_NIC_PCNET = "pcnet"
HT_NIC_E1000 = "e1000"
547
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
548

549
550
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
551
552
553
554
555
HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
                                    HT_NIC_NE2K_ISA, HT_NIC_I82551,
                                    HT_NIC_I85557B, HT_NIC_I8259ER,
                                    HT_NIC_PCNET, HT_NIC_E1000,
                                    HT_NIC_PARAVIRTUAL])
556
557
558
559
560
561
562
563
# Disk types
HT_DISK_IOEMU = "ioemu"
HT_DISK_IDE = "ide"
HT_DISK_SCSI = "scsi"
HT_DISK_SD = "sd"
HT_DISK_MTD = "mtd"
HT_DISK_PFLASH = "pflash"

564
565
566
567
568
569
570
571
572
HT_CACHE_DEFAULT = "default"
HT_CACHE_NONE = "none"
HT_CACHE_WTHROUGH = "writethrough"
HT_CACHE_WBACK = "writeback"
HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
                                  HT_CACHE_NONE,
                                  HT_CACHE_WTHROUGH,
                                  HT_CACHE_WBACK])

573
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
574
575
576
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
                                     HT_DISK_PFLASH])
577

578
579
580
581
582
583
584
585
586
587
588
589
590
# Mouse types:
HT_MOUSE_MOUSE = "mouse"
HT_MOUSE_TABLET = "tablet"

HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])

# Boot order
HT_BO_CDROM = "cdrom"
HT_BO_DISK = "disk"
HT_BO_NETWORK = "network"

HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])

591
592
593
594
595
596
597
# Security models
HT_SM_NONE = "none"
HT_SM_USER = "user"
HT_SM_POOL = "pool"

HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])

Guido Trotter's avatar
Guido Trotter committed
598
599
600
601
602
603
# Kvm flag values
HT_KVM_ENABLED = "enabled"
HT_KVM_DISABLED = "disabled"

HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])

604
605
606
607
# Cluster Verify steps
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])

608
609
610
611
612
613
614
615
616
# Node verify constants
NV_FILELIST = "filelist"
NV_HVINFO = "hvinfo"
NV_HYPERVISOR = "hypervisor"
NV_INSTANCELIST = "instancelist"
NV_NODELIST = "nodelist"
NV_NODENETTEST = "node-net-test"
NV_VERSION = "version"
NV_VGLIST = "vglist"
617
618
NV_LVLIST = "lvlist"
NV_PVLIST = "pvlist"
619
NV_DRBDLIST = "drbd-list"
620
NV_NODESETUP = "nodesetup"
621
NV_TIME = "time"
622

623
624
625
626
# SSL certificate check constants (in days)
SSL_CERT_EXPIRATION_WARN = 30
SSL_CERT_EXPIRATION_ERROR = 7

627
# Allocator framework constants
628
IALLOCATOR_VERSION = 2
629
630
631
632
IALLOCATOR_DIR_IN = "in"
IALLOCATOR_DIR_OUT = "out"
IALLOCATOR_MODE_ALLOC = "allocate"
IALLOCATOR_MODE_RELOC = "relocate"
633
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
634
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
635

636
637
638
639
640
# 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"
641
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
642
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
Michael Hanselmann's avatar
Michael Hanselmann committed
643
644
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
645

646
647
JOB_ID_TEMPLATE = r"\d+"

648
649
650
# unchanged job return
JOB_NOTCHANGED = "nochange"

651
652
# Job status
JOB_STATUS_QUEUED = "queued"
Iustin Pop's avatar
Iustin Pop committed
653
JOB_STATUS_WAITLOCK = "waiting"
654
JOB_STATUS_CANCELING = "canceling"
655
656
657
658
659
JOB_STATUS_RUNNING = "running"
JOB_STATUS_CANCELED = "canceled"
JOB_STATUS_SUCCESS = "success"
JOB_STATUS_ERROR = "error"

660
661
# OpCode status
# not yet finalized
662
OP_STATUS_QUEUED = "queued"
Iustin Pop's avatar
Iustin Pop committed
663
OP_STATUS_WAITLOCK = "waiting"
664
OP_STATUS_CANCELING = "canceling"
665
OP_STATUS_RUNNING = "running"
666
# finalized
667
OP_STATUS_CANCELED = "canceled"
668
669
OP_STATUS_SUCCESS = "success"
OP_STATUS_ERROR = "error"
670
671
672
OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
                           OP_STATUS_SUCCESS,
                           OP_STATUS_ERROR])
673
674
675
676

# Execution log types
ELOG_MESSAGE = "message"
ELOG_PROGRESS = "progress"
677

678
# max dynamic devices
679
680
681
MAX_NICS = 8
MAX_DISKS = 16

Iustin Pop's avatar
Iustin Pop committed
682
683
# SSCONF keys
SS_CLUSTER_NAME = "cluster_name"
684
SS_CLUSTER_TAGS = "cluster_tags"
Iustin Pop's avatar
Iustin Pop committed
685
SS_FILE_STORAGE_DIR = "file_storage_dir"
686
SS_MASTER_CANDIDATES = "master_candidates"
687
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
Iustin Pop's avatar
Iustin Pop committed
688
689
690
691
SS_MASTER_IP = "master_ip"
SS_MASTER_NETDEV = "master_netdev"
SS_MASTER_NODE = "master_node"
SS_NODE_LIST = "node_list"
692
693
SS_NODE_PRIMARY_IPS = "node_primary_ips"
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
694
SS_OFFLINE_NODES = "offline_nodes"
695
696
SS_ONLINE_NODES = "online_nodes"
SS_INSTANCE_LIST = "instance_list"
697
SS_RELEASE_VERSION = "release_version"
698
SS_HYPERVISOR_LIST = "hypervisor_list"
699
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
Balazs Lecz's avatar
Balazs Lecz committed
700
SS_UID_POOL = "uid_pool"
Iustin Pop's avatar
Iustin Pop committed
701

702
703
704
705
# cluster wide default parameters
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM

HVC_DEFAULTS = {
706
  HT_XEN_PVM: {
707
708
709
    HV_USE_BOOTLOADER: False,
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
    HV_BOOTLOADER_ARGS: '',
710
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
711
    HV_INITRD_PATH: '',
712
    HV_ROOT_PATH: '/dev/sda1',
713
    HV_KERNEL_ARGS: 'ro',
714
    HV_MIGRATION_PORT: 8002,
715
716
717
    },
  HT_XEN_HVM: {
    HV_BOOT_ORDER: "cd",
718
    HV_CDROM_IMAGE_PATH: '',
719
    HV_NIC_TYPE: HT_NIC_RTL8139,
720
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
721
    HV_VNC_BIND_ADDRESS: '0.0.0.0',
722
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
723
724
    HV_ACPI: True,
    HV_PAE: True,
725
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
726
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
727
    HV_MIGRATION_PORT: 8002,
728
    HV_USE_LOCALTIME: False,
729
730
731
    },
  HT_KVM: {
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
732
    HV_INITRD_PATH: '',
733
    HV_KERNEL_ARGS: 'ro',
734
    HV_ROOT_PATH: '/dev/vda1',
735
736
    HV_ACPI: True,
    HV_SERIAL_CONSOLE: True,
737
    HV_VNC_BIND_ADDRESS: '',
738
739
740
    HV_VNC_TLS: False,
    HV_VNC_X509: '',
    HV_VNC_X509_VERIFY: False,
741
    HV_VNC_PASSWORD_FILE: '',
742
    HV_CDROM_IMAGE_PATH: '',
743
    HV_BOOT_ORDER: HT_BO_DISK,
744
745
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
746
    HV_USB_MOUSE: '',
747
    HV_MIGRATION_PORT: 8102,
748
    HV_USE_LOCALTIME: False,
749
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
750
751
    HV_SECURITY_MODEL: HT_SM_NONE,
    HV_SECURITY_DOMAIN: '',
Guido Trotter's avatar
Guido Trotter committed
752
    HV_KVM_FLAG: "",
753
754
755
    },
  HT_FAKE: {
    },
756
757
758
  HT_CHROOT: {
    HV_INIT_SCRIPT: "/ganeti-chroot",
    },
759
  }
760

761
762
763
764
HVC_GLOBALS = frozenset([
  HV_MIGRATION_PORT,
  ])

765
BEC_DEFAULTS = {
766
767
768
769
  BE_MEMORY: 128,
  BE_VCPUS: 1,
  BE_AUTO_BALANCE: True,
  }
770

Guido Trotter's avatar
Guido Trotter committed
771
772
773
774
775
NICC_DEFAULTS = {
  NIC_MODE: NIC_MODE_BRIDGED,
  NIC_LINK: DEFAULT_BRIDGE,
  }

776
MASTER_POOL_SIZE_DEFAULT = 10
Guido Trotter's avatar
Guido Trotter committed
777
778
779

CONFD_PROTOCOL_VERSION = 1

780
CONFD_REQ_PING = 0
Guido Trotter's avatar
Guido Trotter committed
781
782
CONFD_REQ_NODE_ROLE_BYNAME = 1
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
783
CONFD_REQ_CLUSTER_MASTER = 3
784
785
CONFD_REQ_NODE_PIP_LIST = 4
CONFD_REQ_MC_PIP_LIST = 5
786
CONFD_REQ_INSTANCES_IPS_LIST = 6
Guido Trotter's avatar
Guido Trotter committed
787

788
789
790
791
792
793
# Confd request query fields. These are used to narrow down queries.
# These must be strings rather than integers, because json-encoding
# converts them to strings anyway, as they're used as dict-keys.
CONFD_REQQ_LINK = "0"
CONFD_REQQ_IP = "1"
CONFD_REQQ_IPLIST = "2"
794
795
796
797
CONFD_REQQ_FIELDS = "3"

CONFD_REQFIELD_NAME = "0"
CONFD_REQFIELD_IP = "1"
798
CONFD_REQFIELD_MNODE_PIP = "2"
799

Guido Trotter's avatar
Guido Trotter committed
800
CONFD_REQS = frozenset([
801
  CONFD_REQ_PING,
Guido Trotter's avatar
Guido Trotter committed
802
803
  CONFD_REQ_NODE_ROLE_BYNAME,
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
804
  CONFD_REQ_CLUSTER_MASTER,
805
806
  CONFD_REQ_NODE_PIP_LIST,
  CONFD_REQ_MC_PIP_LIST,
807
  CONFD_REQ_INSTANCES_IPS_LIST,
Guido Trotter's avatar
Guido Trotter committed
808
809
  ])

810
811
812
813
814
815
816
817
818
819
CONFD_REPL_STATUS_OK = 0
CONFD_REPL_STATUS_ERROR = 1
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2

CONFD_REPL_STATUSES = frozenset([
  CONFD_REPL_STATUS_OK,
  CONFD_REPL_STATUS_ERROR,
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
  ])

Guido Trotter's avatar
Guido Trotter committed
820
821
822
(CONFD_NODE_ROLE_MASTER,
 CONFD_NODE_ROLE_CANDIDATE,
 CONFD_NODE_ROLE_OFFLINE,
Guido Trotter's avatar
Guido Trotter committed
823
824
825
 CONFD_NODE_ROLE_DRAINED,
 CONFD_NODE_ROLE_REGULAR,
 ) = range(5)
Guido Trotter's avatar
Guido Trotter committed
826

827
828
# A few common errors for confd
CONFD_ERROR_UNKNOWN_ENTRY = 1
829
CONFD_ERROR_INTERNAL = 2
830
CONFD_ERROR_ARGUMENT = 3
831

Guido Trotter's avatar
Guido Trotter committed
832
833
834
# Each request is "salted" by the current timestamp.
# This constants decides how many seconds of skew to accept.
# TODO: make this a default and allow the value to be more configurable
835
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
836
837
838
839
840
841
842
843
844

# When we haven't reloaded the config for more than this amount of seconds, we
# force a test to see if inotify is betraying us.
CONFD_CONFIG_RELOAD_TIMEOUT = 60

# If we receive more than one update in this amount of seconds, we move to
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
# to serve more requests.
CONFD_CONFIG_RELOAD_RATELIMIT = 2
845

846
847
848
849
850
851
# Magic number prepended to all confd queries.
# This allows us to distinguish different types of confd protocols and handle
# them. For example by changing this we can move the whole payload to be
# compressed, or move away from json.
CONFD_MAGIC_FOURCC = 'plj0'

Guido Trotter's avatar
Guido Trotter committed
852
853
854
855
856
857
858
859
860
861
# By default a confd request is sent to the minimum between this number and all
# MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
# we should have enough answers to be able to compare more than one.
CONFD_DEFAULT_REQ_COVERAGE = 6

# Timeout in seconds to expire pending query request in the confd client
# library. We don't actually expect any answer more than 10 seconds after we
# sent a request.
CONFD_CLIENT_EXPIRE_TIMEOUT = 10

862
863
864
865
866
867
# Maximum UDP datagram size.
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
#   (assuming we can't use jumbo frames)
# We just set this to 60K, which should be enough
MAX_UDP_DATA_SIZE = 61440
Balazs Lecz's avatar
Balazs Lecz committed
868
869
870
871

# User-id pool minimum/maximum acceptable user-ids.
UIDPOOL_UID_MIN = 0
UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
872
873
874

# Name or path of the pgrep command
PGREP = "pgrep"