constants.py 25.3 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
86
87
88
89
# user separation
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
MASTERD_USER = _autoconf.MASTERD_USER
RAPI_USER = _autoconf.RAPI_USER

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

131
ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
132

133
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
134

135
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
136
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
137
RAPI = "ganeti-rapi"
138
MASTERD = "ganeti-masterd"
Guido Trotter's avatar
Guido Trotter committed
139
140
# used in the ganeti-nbma project
NLD = "ganeti-nld"
141
142
143
144

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

Iustin Pop's avatar
Iustin Pop committed
156
157
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999
158
MASTER_SCRIPT = "ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
159

160
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
161
DAEMONS_LOGFILES = {
Michael Hanselmann's avatar
Michael Hanselmann committed
162
163
164
165
166
  # "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
167
168
  # used in the ganeti-nbma project
  NLD: LOG_DIR + "nl-daemon.log",
Michael Hanselmann's avatar
Michael Hanselmann committed
169
  }
Michael Hanselmann's avatar
Michael Hanselmann committed
170

171
172
173
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
174
LOG_BURNIN = LOG_DIR + "burnin.log"
Iustin Pop's avatar
Iustin Pop committed
175

Luca Bigliardi's avatar
Luca Bigliardi committed
176
177
DEV_CONSOLE = "/dev/console"

178
179
180
# luxi related constants
LUXI_EOM = "\3"

181
182
183
184
185
186
187
# one of 'no', 'yes', 'only'
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

188
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
189
EXPORT_DIR = _autoconf.EXPORT_DIR
Iustin Pop's avatar
Iustin Pop committed
190
191
192

EXPORT_CONF_FILE = "config.ini"

193
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
194
195
196
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD

197
KVM_PATH = _autoconf.KVM_PATH
Guido Trotter's avatar
Guido Trotter committed
198
SOCAT_PATH = _autoconf.SOCAT_PATH
199
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
200
SOCAT_ESCAPE_CODE = "0x1d"
201

202
203
204
205
206
207
208
209
# 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"

210
211
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

212
213
214
215
216
217
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"

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

218
219
220
221
222
223
224
225
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
IEC_ALL = frozenset([
  IEC_NONE,
  IEC_GZIP,
  ])

226
227
IE_CUSTOM_SIZE = "fd"

228
229
230
231
232
233
234
235
# 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"

236
VALUE_DEFAULT = "default"
237
238
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
239
VALUE_NONE = "none"
240
241
VALUE_TRUE = "true"
VALUE_FALSE = "false"
242

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

Iustin Pop's avatar
Iustin Pop committed
246
# hooks-related constants
247
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
Iustin Pop's avatar
Iustin Pop committed
248
249
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
250
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
251
HOOKS_NAME_WATCHER = "watcher"
252
HOOKS_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
253
254
255
256
257
258
259
260
261
262

# 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

263
264
265
266
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
267
268

# Storage fields
269
270
271
272
# 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
273
274
275
276
277
278
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

279
280
281
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

282
# Available fields per storage type
283
284
285
286
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
287

288
289
290
291
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

292
VALID_STORAGE_OPERATIONS = {
293
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
294
295
  }

296
297
298
299
300
301
# 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
302
303
304
# disk template types
DT_DISKLESS = "diskless"
DT_PLAIN = "plain"
305
DT_DRBD8 = "drbd"
306
DT_FILE = "file"
307
308

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

311
312
313
# the set of non-lvm-based disk templates
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])

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

317
318
# logical disk types
LD_LV = "lvm"
319
LD_DRBD8 = "drbd8"
320
LD_FILE = "file"
321
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
322

Iustin Pop's avatar
Iustin Pop committed
323
324
# drbd constants
DRBD_HMAC_ALG = "md5"
325
DRBD_NET_PROTOCOL = "C"
326
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
Iustin Pop's avatar
Iustin Pop committed
327

328
329
330
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
331
332

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

335
# disk access mode
336
337
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
338
339
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

340
# disk replacement mode
341
342
343
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
344
REPLACE_DISK_AUTO = "replace_auto"
345

346
347
348
349
350
351
352
353
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
EXPORT_MODES = frozenset([
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

354
355
# lock recalculate mode
LOCKS_REPLACE = 'replace'
356
LOCKS_APPEND = 'append'
357

358
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
359
360
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
361
362
363
364
365
366
INSTANCE_REMOTE_IMPORT = "remote-import"
INSTANCE_CREATE_MODES = frozenset([
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
367

368
369
370
371
372
373
374
# Remote import/export handshake message and version
RIE_VERSION = 0
RIE_HANDSHAKE = "Hi, I'm Ganeti"

# Remote import/export certificate validity in seconds
RIE_CERT_VALIDITY = 24 * 60 * 60

375
376
377
# Remote import/export connect timeout for socat
RIE_CONNECT_TIMEOUT = 60

Iustin Pop's avatar
Iustin Pop committed
378
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
379
380
381
                            DT_DRBD8, DT_FILE])

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
382
383
384
385

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
386
387
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
388

389
390
391
392
# dynamic device modification
DDM_ADD = 'add'
DDM_REMOVE = 'remove'

393
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
394
EXIT_SUCCESS = 0
395
EXIT_FAILURE = 1
396
EXIT_NOTCLUSTER = 5
397
EXIT_NOTMASTER = 11
398
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
399
EXIT_CONFIRMATION = 13 # need user confirmation
400

401
402
403
404
405
406
407
# tags
TAG_CLUSTER = "cluster"
TAG_NODE = "node"
TAG_INSTANCE = "instance"
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

408
409
# others
DEFAULT_BRIDGE = "xen-br0"
Iustin Pop's avatar
Iustin Pop committed
410
SYNC_SPEED = 60 * 1024
Iustin Pop's avatar
Iustin Pop committed
411
LOCALHOST_IP_ADDRESS = "127.0.0.1"
412
TCP_PING_TIMEOUT = 10
413
GANETI_RUNAS = "root"
414
DEFAULT_VG = "xenvg"
415
BIND_ADDRESS_GLOBAL = "0.0.0.0"
416
MIN_VG_SIZE = 20480
417
DEFAULT_MAC_PREFIX = "aa:00:00"
418
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
419
420
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
421
NODE_MAX_CLOCK_SKEW = 150
422
423
# Time for an intra-cluster disk transfer to wait for a connection
DISK_TRANSFER_CONNECT_TIMEOUT = 30
424

425
426
427
428
429
430
431
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

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

432
433
434
435
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

436
437
438
439
440
# 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
441
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
442
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
443

444
OS_API_FILE = 'ganeti_api_version'
445
OS_VARIANTS_FILE = 'variants.list'
446

447
# ssh constants
448
449
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
450
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
451
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
452
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
453
454
SSH = "ssh"
SCP = "scp"
455
456
457
458
459

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

461
462
463
464
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
                          INSTANCE_REBOOT_HARD,
                          INSTANCE_REBOOT_FULL])

465
466
467
468
469
470
471
472
473
474
475
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,
                      ])

476
477
478
479
480
481
# 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"
482
HV_VNC_PASSWORD_FILE = "vnc_password_file"
483
484
485
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
486
487
HV_ACPI = "acpi"
HV_PAE = "pae"
488
489
490
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
491
HV_KERNEL_ARGS = "kernel_args"
492
493
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
494
HV_ROOT_PATH = "root_path"
495
HV_SERIAL_CONSOLE = "serial_console"
496
HV_USB_MOUSE = "usb_mouse"
497
HV_DEVICE_MODEL = "device_model"
498
HV_INIT_SCRIPT = "init_script"
499
HV_MIGRATION_PORT = "migration_port"
500
501
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
502
HV_USE_LOCALTIME = "use_localtime"
503
HV_DISK_CACHE = "disk_cache"
504
505
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
506
HV_KVM_FLAG = "kvm_flag"
507
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
508
HV_KVM_USE_CHROOT = "use_chroot"
509

510
511
512
513
514
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
515
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
516
517
518
519
520
521
  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,
522
523
524
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
525
  HV_KERNEL_PATH: VTYPE_STRING,
526
  HV_KERNEL_ARGS: VTYPE_STRING,
527
528
529
530
  HV_INITRD_PATH: VTYPE_STRING,
  HV_ROOT_PATH: VTYPE_STRING,
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
531
  HV_DEVICE_MODEL: VTYPE_STRING,
532
  HV_INIT_SCRIPT: VTYPE_STRING,
533
  HV_MIGRATION_PORT: VTYPE_INT,
534
535
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
536
  HV_USE_LOCALTIME: VTYPE_BOOL,
537
  HV_DISK_CACHE: VTYPE_STRING,
538
539
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
540
  HV_KVM_FLAG: VTYPE_STRING,
541
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
542
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
543
544
545
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
546

547
# BE parameter names
Iustin Pop's avatar
Iustin Pop committed
548
BE_MEMORY = "memory"
549
BE_VCPUS = "vcpus"
550
BE_AUTO_BALANCE = "auto_balance"
551

552
553
554
555
556
557
558
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
559

560
561
# Instance Parameters Profile
PP_DEFAULT = "default"
562

Guido Trotter's avatar
Guido Trotter committed
563
564
565
566
567
568
569
570
571
572
573
574
575
576
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())
577

578
# Hypervisor constants
Iustin Pop's avatar
Iustin Pop committed
579
HT_XEN_PVM = "xen-pvm"
580
HT_FAKE = "fake"
Iustin Pop's avatar
Iustin Pop committed
581
HT_XEN_HVM = "xen-hvm"
Guido Trotter's avatar
Guido Trotter committed
582
HT_KVM = "kvm"
583
584
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
585
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
586

587
VNC_BASE_PORT = 5900
588
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
589
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
590

591
# NIC types
592
593
594
HT_NIC_RTL8139 = "rtl8139"
HT_NIC_NE2K_PCI = "ne2k_pci"
HT_NIC_NE2K_ISA = "ne2k_isa"
595
596
597
598
599
HT_NIC_I82551 = "i82551"
HT_NIC_I85557B = "i82557b"
HT_NIC_I8259ER = "i82559er"
HT_NIC_PCNET = "pcnet"
HT_NIC_E1000 = "e1000"
600
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
601

602
603
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
604
605
606
607
608
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])
609
610
611
612
613
614
615
616
# 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"

617
618
619
620
621
622
623
624
625
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])

626
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
627
628
629
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
                                     HT_DISK_PFLASH])
630

631
632
633
634
635
636
637
638
639
640
641
642
643
# 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])

644
645
646
647
648
649
650
# 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
651
652
653
654
655
656
# Kvm flag values
HT_KVM_ENABLED = "enabled"
HT_KVM_DISABLED = "disabled"

HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])

657
658
659
660
# Cluster Verify steps
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])

661
662
663
664
665
666
667
668
669
# 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"
670
671
NV_LVLIST = "lvlist"
NV_PVLIST = "pvlist"
672
NV_DRBDLIST = "drbd-list"
673
NV_NODESETUP = "nodesetup"
674
NV_TIME = "time"
675
NV_MASTERIP = "master-ip"
676

677
678
679
680
# SSL certificate check constants (in days)
SSL_CERT_EXPIRATION_WARN = 30
SSL_CERT_EXPIRATION_ERROR = 7

681
# Allocator framework constants
682
IALLOCATOR_VERSION = 2
683
684
685
686
IALLOCATOR_DIR_IN = "in"
IALLOCATOR_DIR_OUT = "out"
IALLOCATOR_MODE_ALLOC = "allocate"
IALLOCATOR_MODE_RELOC = "relocate"
687
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
688
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
689

690
691
692
693
694
# 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"
695
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
696
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
Michael Hanselmann's avatar
Michael Hanselmann committed
697
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
698
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
699
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
700

701
702
JOB_ID_TEMPLATE = r"\d+"

703
704
705
# unchanged job return
JOB_NOTCHANGED = "nochange"

706
707
# Job status
JOB_STATUS_QUEUED = "queued"
Iustin Pop's avatar
Iustin Pop committed
708
JOB_STATUS_WAITLOCK = "waiting"
709
JOB_STATUS_CANCELING = "canceling"
710
711
712
713
714
JOB_STATUS_RUNNING = "running"
JOB_STATUS_CANCELED = "canceled"
JOB_STATUS_SUCCESS = "success"
JOB_STATUS_ERROR = "error"

715
716
# OpCode status
# not yet finalized
717
OP_STATUS_QUEUED = "queued"
Iustin Pop's avatar
Iustin Pop committed
718
OP_STATUS_WAITLOCK = "waiting"
719
OP_STATUS_CANCELING = "canceling"
720
OP_STATUS_RUNNING = "running"
721
# finalized
722
OP_STATUS_CANCELED = "canceled"
723
724
OP_STATUS_SUCCESS = "success"
OP_STATUS_ERROR = "error"
725
726
727
OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
                           OP_STATUS_SUCCESS,
                           OP_STATUS_ERROR])
728
729
730
731

# Execution log types
ELOG_MESSAGE = "message"
ELOG_PROGRESS = "progress"
732
ELOG_REMOTE_IMPORT = "remote-import"
733

734
# max dynamic devices
735
736
737
MAX_NICS = 8
MAX_DISKS = 16

Iustin Pop's avatar
Iustin Pop committed
738
739
# SSCONF keys
SS_CLUSTER_NAME = "cluster_name"
740
SS_CLUSTER_TAGS = "cluster_tags"
Iustin Pop's avatar
Iustin Pop committed
741
SS_FILE_STORAGE_DIR = "file_storage_dir"
742
SS_MASTER_CANDIDATES = "master_candidates"
743
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
Iustin Pop's avatar
Iustin Pop committed
744
745
746
747
SS_MASTER_IP = "master_ip"
SS_MASTER_NETDEV = "master_netdev"
SS_MASTER_NODE = "master_node"
SS_NODE_LIST = "node_list"
748
749
SS_NODE_PRIMARY_IPS = "node_primary_ips"
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
750
SS_OFFLINE_NODES = "offline_nodes"
751
752
SS_ONLINE_NODES = "online_nodes"
SS_INSTANCE_LIST = "instance_list"
753
SS_RELEASE_VERSION = "release_version"
754
SS_HYPERVISOR_LIST = "hypervisor_list"
755
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
Balazs Lecz's avatar
Balazs Lecz committed
756
SS_UID_POOL = "uid_pool"
Iustin Pop's avatar
Iustin Pop committed
757

758
759
760
761
# cluster wide default parameters
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM

HVC_DEFAULTS = {
762
  HT_XEN_PVM: {
763
764
765
    HV_USE_BOOTLOADER: False,
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
    HV_BOOTLOADER_ARGS: '',
766
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
767
    HV_INITRD_PATH: '',
768
    HV_ROOT_PATH: '/dev/sda1',
769
    HV_KERNEL_ARGS: 'ro',
770
    HV_MIGRATION_PORT: 8002,
771
772
773
    },
  HT_XEN_HVM: {
    HV_BOOT_ORDER: "cd",
774
    HV_CDROM_IMAGE_PATH: '',
775
    HV_NIC_TYPE: HT_NIC_RTL8139,
776
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
777
    HV_VNC_BIND_ADDRESS: '0.0.0.0',
778
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
779
780
    HV_ACPI: True,
    HV_PAE: True,
781
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
782
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
783
    HV_MIGRATION_PORT: 8002,
784
    HV_USE_LOCALTIME: False,
785
786
787
    },
  HT_KVM: {
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
788
    HV_INITRD_PATH: '',
789
    HV_KERNEL_ARGS: 'ro',
790
    HV_ROOT_PATH: '/dev/vda1',
791
792
    HV_ACPI: True,
    HV_SERIAL_CONSOLE: True,
793
    HV_VNC_BIND_ADDRESS: '',
794
795
796
    HV_VNC_TLS: False,
    HV_VNC_X509: '',
    HV_VNC_X509_VERIFY: False,
797
    HV_VNC_PASSWORD_FILE: '',
798
    HV_CDROM_IMAGE_PATH: '',
799
    HV_BOOT_ORDER: HT_BO_DISK,
800
801
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
802
    HV_USB_MOUSE: '',
803
    HV_MIGRATION_PORT: 8102,
804
805
    HV_MIGRATION_BANDWIDTH: 32, # MiB/s
    HV_MIGRATION_DOWNTIME: 30,  # ms
806
    HV_USE_LOCALTIME: False,
807
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
808
809
    HV_SECURITY_MODEL: HT_SM_NONE,
    HV_SECURITY_DOMAIN: '',
Guido Trotter's avatar
Guido Trotter committed
810
    HV_KVM_FLAG: "",
811
    HV_VHOST_NET: False,
Balazs Lecz's avatar
Balazs Lecz committed
812
    HV_KVM_USE_CHROOT: False,
813
814
815
    },
  HT_FAKE: {
    },
816
817
818
  HT_CHROOT: {
    HV_INIT_SCRIPT: "/ganeti-chroot",
    },
819
  }
820

821
822
HVC_GLOBALS = frozenset([
  HV_MIGRATION_PORT,
823
  HV_MIGRATION_BANDWIDTH,
824
825
  ])

826
BEC_DEFAULTS = {
827
828
829
830
  BE_MEMORY: 128,
  BE_VCPUS: 1,
  BE_AUTO_BALANCE: True,
  }
831

Guido Trotter's avatar
Guido Trotter committed
832
833
834
835
836
NICC_DEFAULTS = {
  NIC_MODE: NIC_MODE_BRIDGED,
  NIC_LINK: DEFAULT_BRIDGE,
  }

837
MASTER_POOL_SIZE_DEFAULT = 10
Guido Trotter's avatar
Guido Trotter committed
838
839
840

CONFD_PROTOCOL_VERSION = 1

841
CONFD_REQ_PING = 0
Guido Trotter's avatar
Guido Trotter committed
842
843
CONFD_REQ_NODE_ROLE_BYNAME = 1
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
844
CONFD_REQ_CLUSTER_MASTER = 3
845
846
CONFD_REQ_NODE_PIP_LIST = 4
CONFD_REQ_MC_PIP_LIST = 5
847
CONFD_REQ_INSTANCES_IPS_LIST = 6
Guido Trotter's avatar
Guido Trotter committed
848

849
850
851
852
853
854
# 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"
855
856
857
858
CONFD_REQQ_FIELDS = "3"

CONFD_REQFIELD_NAME = "0"
CONFD_REQFIELD_IP = "1"
859
CONFD_REQFIELD_MNODE_PIP = "2"
860

Guido Trotter's avatar
Guido Trotter committed
861
CONFD_REQS = frozenset([
862
  CONFD_REQ_PING,
Guido Trotter's avatar
Guido Trotter committed
863
864
  CONFD_REQ_NODE_ROLE_BYNAME,
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
865
  CONFD_REQ_CLUSTER_MASTER,
866
867
  CONFD_REQ_NODE_PIP_LIST,
  CONFD_REQ_MC_PIP_LIST,
868
  CONFD_REQ_INSTANCES_IPS_LIST,
Guido Trotter's avatar
Guido Trotter committed
869
870
  ])

871
872
873
874
875
876
877
878
879
880
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
881
882
883
(CONFD_NODE_ROLE_MASTER,
 CONFD_NODE_ROLE_CANDIDATE,
 CONFD_NODE_ROLE_OFFLINE,
Guido Trotter's avatar
Guido Trotter committed
884
885
886
 CONFD_NODE_ROLE_DRAINED,
 CONFD_NODE_ROLE_REGULAR,
 ) = range(5)
Guido Trotter's avatar
Guido Trotter committed
887

888
889
# A few common errors for confd
CONFD_ERROR_UNKNOWN_ENTRY = 1
890
CONFD_ERROR_INTERNAL = 2
891
CONFD_ERROR_ARGUMENT = 3
892

Guido Trotter's avatar
Guido Trotter committed
893
894
895
# 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
896
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
897
898
899
900
901
902
903
904
905

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

907
908
909
910
911
912
# 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
913
914
915
916
917
918
919
920
921
922
# 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

923
924
925
926
927
928
# 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
929
930
931
932

# User-id pool minimum/maximum acceptable user-ids.
UIDPOOL_UID_MIN = 0
UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
933
934
935

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