constants.py 29.7 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#
# 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 = 40
30
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
Guido Trotter's avatar
Guido Trotter committed
31
32
OS_API_V10 = 10
OS_API_V15 = 15
33
34
OS_API_V20 = 20
OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
35
VCS_VERSION = _autoconf.VCS_VERSION
Iustin Pop's avatar
Iustin Pop committed
36
EXPORT_VERSION = 0
37
RAPI_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
38

39

40
41
42
43
44
45
46
47
# 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.
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
80
81

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


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

87
88
# user separation
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
89
ADMIN_GROUP = _autoconf.ADMIN_GROUP
90
MASTERD_USER = _autoconf.MASTERD_USER
91
MASTERD_GROUP = _autoconf.MASTERD_GROUP
92
RAPI_USER = _autoconf.RAPI_USER
93
94
95
96
RAPI_GROUP = _autoconf.RAPI_GROUP
CONFD_USER = _autoconf.CONFD_USER
CONFD_GROUP = _autoconf.CONFD_GROUP
NODED_USER = _autoconf.NODED_USER
97

98

99
# Wipe
100
101
DD_CMD = "dd"
WIPE_BLOCK_SIZE = 1024**2
102
103
104
MAX_WIPE_CHUNK = 1024 # 1GB
MIN_WIPE_CHUNK_PERCENT = 10

105

Iustin Pop's avatar
Iustin Pop committed
106
# file paths
107
DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
108
RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
109
RUN_GANETI_DIR = RUN_DIR + "/ganeti"
110
BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
111
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
112
RUN_DIRS_MODE = 0775
Guido Trotter's avatar
Guido Trotter committed
113
SOCKET_DIR = RUN_GANETI_DIR + "/socket"
114
SECURE_DIR_MODE = 0700
115
SECURE_FILE_MODE = 0600
116
SOCKET_DIR_MODE = 0750
117
CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
Guido Trotter's avatar
Guido Trotter committed
118
CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE
119
120
IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
IMPORT_EXPORT_DIR_MODE = 0755
121
122
123
# 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
124
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
125
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
126
127
128
# 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
129
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
130
NODED_CERT_FILE = DATA_DIR + "/server.pem"
131
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
132
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
Michael Hanselmann's avatar
Michael Hanselmann committed
133
CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
134
WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
135
WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
136
INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
Iustin Pop's avatar
Iustin Pop committed
137
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
138
RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
139
QUEUE_DIR = DATA_DIR + "/queue"
140
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
141
SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
142
ETC_HOSTS = "/etc/hosts"
143
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
144
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
145
SYSCONFDIR = _autoconf.SYSCONFDIR
146
TOOLSDIR = _autoconf.TOOLSDIR
147
CONF_DIR = SYSCONFDIR + "/ganeti"
148

149
ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
150

151
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
152

153
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
154
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
155
RAPI = "ganeti-rapi"
156
MASTERD = "ganeti-masterd"
Guido Trotter's avatar
Guido Trotter committed
157
158
# used in the ganeti-nbma project
NLD = "ganeti-nld"
159
160
161
162

DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
163
  CONFD: ("udp", 1814),
Guido Trotter's avatar
Guido Trotter committed
164
  RAPI: ("tcp", 5080),
165
  "ssh": ("tcp", 22),
Guido Trotter's avatar
Guido Trotter committed
166
167
  # used in the ganeti-nbma project
  NLD: ("udp", 1816),
168
169
}
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
170
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
Guido Trotter's avatar
Guido Trotter committed
171
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
Guido Trotter's avatar
Guido Trotter committed
172
173
# used in the ganeti-nbma project
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
174

Iustin Pop's avatar
Iustin Pop committed
175
176
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999
177
MASTER_SCRIPT = "ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
178

179
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
180
DAEMONS_LOGFILES = {
Michael Hanselmann's avatar
Michael Hanselmann committed
181
182
183
184
185
  # "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
186
187
  # used in the ganeti-nbma project
  NLD: LOG_DIR + "nl-daemon.log",
Michael Hanselmann's avatar
Michael Hanselmann committed
188
  }
Michael Hanselmann's avatar
Michael Hanselmann committed
189

190
191
192
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
193
LOG_BURNIN = LOG_DIR + "burnin.log"
194
LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
Iustin Pop's avatar
Iustin Pop committed
195

Luca Bigliardi's avatar
Luca Bigliardi committed
196
197
DEV_CONSOLE = "/dev/console"

Balazs Lecz's avatar
Balazs Lecz committed
198
199
PROC_MOUNTS = "/proc/mounts"

200
201
# luxi related constants
LUXI_EOM = "\3"
202
LUXI_VERSION = CONFIG_VERSION
203

204
205
206
207
208
209
210
# one of 'no', 'yes', 'only'
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

211
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
212
EXPORT_DIR = _autoconf.EXPORT_DIR
Iustin Pop's avatar
Iustin Pop committed
213
214
215

EXPORT_CONF_FILE = "config.ini"

216
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
217
218
219
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD

220
KVM_PATH = _autoconf.KVM_PATH
Guido Trotter's avatar
Guido Trotter committed
221
SOCAT_PATH = _autoconf.SOCAT_PATH
222
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
223
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
224
SOCAT_ESCAPE_CODE = "0x1d"
225

226
227
228
229
230
# 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

231
232
233
234
235
236
237
238
# Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
# way to disable ciphers would be to use the exclamation mark (!), but socat
# versions below 1.5 can't parse exclamation marks in options properly. When
# modifying the ciphers, ensure to not accidentially add something after it's
# been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
# "openssl ciphers -v HIGH:-DES".
OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"

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

242
243
244
245
246
247
# Default validity of certificates in days
X509_CERT_DEFAULT_VALIDITY = 365 * 5

# commonName (CN) used in certificates
X509_CERT_CN = "ganeti.example.com"

248
249
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

250
251
252
253
254
255
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"

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

256
257
258
259
260
261
262
263
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
IEC_ALL = frozenset([
  IEC_NONE,
  IEC_GZIP,
  ])

264
265
IE_CUSTOM_SIZE = "fd"

266
267
IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")

268
269
270
271
272
273
274
275
# 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"

276
VALUE_DEFAULT = "default"
277
278
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
279
VALUE_NONE = "none"
280
281
VALUE_TRUE = "true"
VALUE_FALSE = "false"
282

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

Iustin Pop's avatar
Iustin Pop committed
286
# hooks-related constants
287
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
Iustin Pop's avatar
Iustin Pop committed
288
289
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
290
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
291
HOOKS_NAME_WATCHER = "watcher"
292
HOOKS_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
293
294
295
296
297
298
299
300
301
302

# 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

303
304
305
306
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
307
308

# Storage fields
309
310
311
312
# 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
313
314
315
316
317
318
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

319
320
321
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

322
# Available fields per storage type
323
324
325
326
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
327

328
329
330
331
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

332
VALID_STORAGE_OPERATIONS = {
333
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
334
335
  }

336
337
338
339
340
341
# 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
342
343
344
# disk template types
DT_DISKLESS = "diskless"
DT_PLAIN = "plain"
345
DT_DRBD8 = "drbd"
346
DT_FILE = "file"
347
348

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

351
352
353
# the set of non-lvm-based disk templates
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])

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

357
358
359
# the set of disk templates that allow adoption
DTS_MAY_ADOPT = frozenset([DT_PLAIN])

360
361
# logical disk types
LD_LV = "lvm"
362
LD_DRBD8 = "drbd8"
363
LD_FILE = "file"
364
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
365

Iustin Pop's avatar
Iustin Pop committed
366
367
# drbd constants
DRBD_HMAC_ALG = "md5"
368
DRBD_NET_PROTOCOL = "C"
369
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
Iustin Pop's avatar
Iustin Pop committed
370

371
372
373
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
374
375

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

378
# disk access mode
379
380
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
381
382
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

383
# disk replacement mode
384
385
386
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
387
REPLACE_DISK_AUTO = "replace_auto"
388
389
390
391
392
393
REPLACE_MODES = frozenset([
  REPLACE_DISK_PRI,
  REPLACE_DISK_SEC,
  REPLACE_DISK_CHG,
  REPLACE_DISK_AUTO,
  ])
394

395
396
397
398
399
400
401
402
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
EXPORT_MODES = frozenset([
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

403
404
# lock recalculate mode
LOCKS_REPLACE = 'replace'
405
LOCKS_APPEND = 'append'
406

407
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
408
409
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
410
411
412
413
414
415
INSTANCE_REMOTE_IMPORT = "remote-import"
INSTANCE_CREATE_MODES = frozenset([
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
416

417
418
419
420
421
422
423
# 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

424
425
# Remote import/export connect timeout for socat
RIE_CONNECT_TIMEOUT = 60
René Nussbaumer's avatar
René Nussbaumer committed
426
427
#: Give child process up to 5 seconds to exit after sending a signal
CHILD_LINGER_TIMEOUT = 5.0
428

Iustin Pop's avatar
Iustin Pop committed
429
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
430
431
432
                            DT_DRBD8, DT_FILE])

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
433
434
435
436

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
437
438
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
439
INISECT_OSP = "os"
440

441
# dynamic device modification
442
443
444
DDM_ADD = "add"
DDM_REMOVE = "remove"
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
445

446
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
447
EXIT_SUCCESS = 0
448
EXIT_FAILURE = 1
449
EXIT_NOTCLUSTER = 5
450
EXIT_NOTMASTER = 11
451
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
452
EXIT_CONFIRMATION = 13 # need user confirmation
453

454
455
456
457
# tags
TAG_CLUSTER = "cluster"
TAG_NODE = "node"
TAG_INSTANCE = "instance"
458
459
460
461
462
VALID_TAG_TYPES = frozenset([
  TAG_CLUSTER,
  TAG_NODE,
  TAG_INSTANCE,
  ])
463
464
465
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

466
467
# others
DEFAULT_BRIDGE = "xen-br0"
Iustin Pop's avatar
Iustin Pop committed
468
SYNC_SPEED = 60 * 1024
469
470
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
IP4_ADDRESS_ANY = "0.0.0.0"
Manuel Franceschini's avatar
Manuel Franceschini committed
471
472
IP6_ADDRESS_LOCALHOST = "::1"
IP6_ADDRESS_ANY = "::"
473
474
IP4_VERSION = 4
IP6_VERSION = 6
475
TCP_PING_TIMEOUT = 10
476
GANETI_RUNAS = "root"
477
DEFAULT_VG = "xenvg"
478
DEFAULT_DRBD_HELPER = "/bin/true"
479
MIN_VG_SIZE = 20480
480
DEFAULT_MAC_PREFIX = "aa:00:00"
481
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
482
483
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
484
NODE_MAX_CLOCK_SKEW = 150
485
486
# Time for an intra-cluster disk transfer to wait for a connection
DISK_TRANSFER_CONNECT_TIMEOUT = 30
487

488
489
490
491
492
493
494
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

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

495
496
497
498
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

499
500
501
502
503
# os related constants
OS_SCRIPT_CREATE = 'create'
OS_SCRIPT_IMPORT = 'import'
OS_SCRIPT_EXPORT = 'export'
OS_SCRIPT_RENAME = 'rename'
504
OS_SCRIPT_VERIFY = 'verify'
Iustin Pop's avatar
Iustin Pop committed
505
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
506
507
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME,
                        OS_SCRIPT_VERIFY])
508

509
OS_API_FILE = 'ganeti_api_version'
510
OS_VARIANTS_FILE = 'variants.list'
511
512
513
OS_PARAMETERS_FILE = 'parameters.list'

OS_VALIDATE_PARAMETERS = 'parameters'
514
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
515

516
# ssh constants
517
518
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
519
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
520
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
521
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
522
523
SSH = "ssh"
SCP = "scp"
524
525
526
527
528

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

530
531
532
533
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
                          INSTANCE_REBOOT_HARD,
                          INSTANCE_REBOOT_FULL])

534
VTYPE_STRING = 'string'
535
VTYPE_MAYBE_STRING = "maybe-string"
536
537
538
539
540
VTYPE_BOOL = 'bool'
VTYPE_SIZE = 'size' # size, in MiBs
VTYPE_INT = 'int'
ENFORCEABLE_TYPES = frozenset([
                      VTYPE_STRING,
541
                      VTYPE_MAYBE_STRING,
542
543
544
545
546
                      VTYPE_BOOL,
                      VTYPE_SIZE,
                      VTYPE_INT,
                      ])

547
548
549
550
551
552
# 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"
553
HV_VNC_PASSWORD_FILE = "vnc_password_file"
554
555
556
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
557
558
HV_ACPI = "acpi"
HV_PAE = "pae"
559
560
561
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
562
HV_KERNEL_ARGS = "kernel_args"
563
564
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
565
HV_ROOT_PATH = "root_path"
566
HV_SERIAL_CONSOLE = "serial_console"
567
HV_USB_MOUSE = "usb_mouse"
568
HV_DEVICE_MODEL = "device_model"
569
HV_INIT_SCRIPT = "init_script"
570
HV_MIGRATION_PORT = "migration_port"
571
572
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
573
HV_MIGRATION_MODE = "migration_mode"
574
HV_USE_LOCALTIME = "use_localtime"
575
HV_DISK_CACHE = "disk_cache"
576
577
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
578
HV_KVM_FLAG = "kvm_flag"
579
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
580
HV_KVM_USE_CHROOT = "use_chroot"
581
HV_CPU_MASK = "cpu_mask"
582
HV_MEM_PATH = "mem_path"
583

584
585
586
587
588
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
589
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
590
591
592
593
594
595
  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,
596
597
598
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
599
  HV_KERNEL_PATH: VTYPE_STRING,
600
  HV_KERNEL_ARGS: VTYPE_STRING,
601
602
603
604
  HV_INITRD_PATH: VTYPE_STRING,
  HV_ROOT_PATH: VTYPE_STRING,
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
605
  HV_DEVICE_MODEL: VTYPE_STRING,
606
  HV_INIT_SCRIPT: VTYPE_STRING,
607
  HV_MIGRATION_PORT: VTYPE_INT,
608
609
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
610
  HV_MIGRATION_MODE: VTYPE_STRING,
611
  HV_USE_LOCALTIME: VTYPE_BOOL,
612
  HV_DISK_CACHE: VTYPE_STRING,
613
614
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
615
  HV_KVM_FLAG: VTYPE_STRING,
616
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
617
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
618
  HV_CPU_MASK: VTYPE_STRING,
619
  HV_MEM_PATH: VTYPE_STRING,
620
621
622
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
623

624
# BE parameter names
Iustin Pop's avatar
Iustin Pop committed
625
BE_MEMORY = "memory"
626
BE_VCPUS = "vcpus"
627
BE_AUTO_BALANCE = "auto_balance"
628

629
630
631
632
633
634
635
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
636

637
638
# Instance Parameters Profile
PP_DEFAULT = "default"
639

Guido Trotter's avatar
Guido Trotter committed
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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())
654

655
656
IDISK_SIZE = "size"
IDISK_MODE = "mode"
657
658
659
660
661
662
IDISK_ADOPT = "adopt"
IDISK_PARAMS_TYPES = {
  IDISK_SIZE: VTYPE_SIZE,
  IDISK_MODE: VTYPE_STRING,
  IDISK_ADOPT: VTYPE_STRING,
  }
663
664
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())

665
666
667
668
669
INIC_MAC = "mac"
INIC_IP = "ip"
INIC_MODE = "mode"
INIC_LINK = "link"
INIC_BRIDGE = "bridge"
670
671
672
673
674
675
676
677
INIC_PARAMS_TYPES = {
  INIC_BRIDGE: VTYPE_STRING,
  INIC_IP: VTYPE_MAYBE_STRING,
  INIC_LINK: VTYPE_STRING,
  INIC_MAC: VTYPE_STRING,
  INIC_MODE: VTYPE_STRING,
  }
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
678

679
# Hypervisor constants
Iustin Pop's avatar
Iustin Pop committed
680
HT_XEN_PVM = "xen-pvm"
681
HT_FAKE = "fake"
Iustin Pop's avatar
Iustin Pop committed
682
HT_XEN_HVM = "xen-hvm"
Guido Trotter's avatar
Guido Trotter committed
683
HT_KVM = "kvm"
684
HT_CHROOT = "chroot"
Iustin Pop's avatar
Iustin Pop committed
685
686
687
688
689
690
691
692
693
HT_LXC = "lxc"
HYPER_TYPES = frozenset([
  HT_XEN_PVM,
  HT_FAKE,
  HT_XEN_HVM,
  HT_KVM,
  HT_CHROOT,
  HT_LXC,
  ])
Guido Trotter's avatar
Guido Trotter committed
694
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
695

696
VNC_BASE_PORT = 5900
697
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
Manuel Franceschini's avatar
Manuel Franceschini committed
698
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
699

700
# NIC types
701
702
703
HT_NIC_RTL8139 = "rtl8139"
HT_NIC_NE2K_PCI = "ne2k_pci"
HT_NIC_NE2K_ISA = "ne2k_isa"
704
705
706
707
708
HT_NIC_I82551 = "i82551"
HT_NIC_I85557B = "i82557b"
HT_NIC_I8259ER = "i82559er"
HT_NIC_PCNET = "pcnet"
HT_NIC_E1000 = "e1000"
709
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
710

711
712
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
713
714
715
716
717
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])
718
719
720
721
722
723
724
725
# 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"

726
727
728
729
730
731
732
733
734
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])

735
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
736
737
738
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
                                     HT_DISK_PFLASH])
739

740
741
742
743
744
745
746
747
748
749
750
751
752
# 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])

753
754
755
756
757
758
759
# 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
760
761
762
763
764
765
# Kvm flag values
HT_KVM_ENABLED = "enabled"
HT_KVM_DISABLED = "disabled"

HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])

766
767
768
# Migration type
HT_MIGRATION_LIVE = "live"
HT_MIGRATION_NONLIVE = "non-live"
769
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
770

771
772
773
774
# Cluster Verify steps
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])

775
# Node verify constants
776
NV_DRBDHELPER = "drbd-helper"
777
NV_DRBDLIST = "drbd-list"
778
779
780
781
NV_FILELIST = "filelist"
NV_HVINFO = "hvinfo"
NV_HYPERVISOR = "hypervisor"
NV_INSTANCELIST = "instancelist"
782
783
NV_LVLIST = "lvlist"
NV_MASTERIP = "master-ip"
784
785
NV_NODELIST = "nodelist"
NV_NODENETTEST = "node-net-test"
786
NV_NODESETUP = "nodesetup"
787
788
NV_OSLIST = "oslist"
NV_PVLIST = "pvlist"
789
NV_TIME = "time"
790
791
NV_VERSION = "version"
NV_VGLIST = "vglist"
792
NV_VMNODES = "vmnodes"
793

794
795
796
797
# SSL certificate check constants (in days)
SSL_CERT_EXPIRATION_WARN = 30
SSL_CERT_EXPIRATION_ERROR = 7

798
# Allocator framework constants
799
IALLOCATOR_VERSION = 2
800
801
IALLOCATOR_DIR_IN = "in"
IALLOCATOR_DIR_OUT = "out"
802
803
804
805
VALID_IALLOCATOR_DIRECTIONS = frozenset([
  IALLOCATOR_DIR_IN,
  IALLOCATOR_DIR_OUT,
  ])
806
807
IALLOCATOR_MODE_ALLOC = "allocate"
IALLOCATOR_MODE_RELOC = "relocate"
808
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
809
810
811
812
813
VALID_IALLOCATOR_MODES = frozenset([
  IALLOCATOR_MODE_ALLOC,
  IALLOCATOR_MODE_RELOC,
  IALLOCATOR_MODE_MEVAC,
  ])
814
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
815

816
817
818
819
820
# 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"
821
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
822
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
Michael Hanselmann's avatar
Michael Hanselmann committed
823
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
824
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
825
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
826

827
828
JOB_ID_TEMPLATE = r"\d+"

829
830
831
# unchanged job return
JOB_NOTCHANGED = "nochange"

832
833
# Job status
JOB_STATUS_QUEUED = "queued"
Iustin Pop's avatar
Iustin Pop committed
834
JOB_STATUS_WAITLOCK = "waiting"
835
JOB_STATUS_CANCELING = "canceling"
836
837
838
839
JOB_STATUS_RUNNING = "running"
JOB_STATUS_CANCELED = "canceled"
JOB_STATUS_SUCCESS = "success"
JOB_STATUS_ERROR = "error"
840
841
842
843
844
JOBS_FINALIZED = frozenset([
  JOB_STATUS_CANCELED,
  JOB_STATUS_SUCCESS,
  JOB_STATUS_ERROR,
  ])
845
846
847
848
849
850
JOB_STATUS_ALL = frozenset([
  JOB_STATUS_QUEUED,
  JOB_STATUS_WAITLOCK,
  JOB_STATUS_CANCELING,
  JOB_STATUS_RUNNING,
  ]) | JOBS_FINALIZED
851

852
853
# OpCode status
# not yet finalized
854
OP_STATUS_QUEUED = "queued"
Iustin Pop's avatar
Iustin Pop committed
855
OP_STATUS_WAITLOCK = "waiting"
856
OP_STATUS_CANCELING = "canceling"
857
OP_STATUS_RUNNING = "running"
858
# finalized
859
OP_STATUS_CANCELED = "canceled"
860
861
OP_STATUS_SUCCESS = "success"
OP_STATUS_ERROR = "error"
862
863
864
OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
                           OP_STATUS_SUCCESS,
                           OP_STATUS_ERROR])
865

866
867
868
869
870
871
872
873
# OpCode priority
OP_PRIO_LOWEST = +19
OP_PRIO_HIGHEST = -20

OP_PRIO_LOW = +10
OP_PRIO_NORMAL = 0
OP_PRIO_HIGH = -10

874
875
876
877
878
879
OP_PRIO_SUBMIT_VALID = frozenset([
  OP_PRIO_LOW,
  OP_PRIO_NORMAL,
  OP_PRIO_HIGH,
  ])

880
881
OP_PRIO_DEFAULT = OP_PRIO_NORMAL

882
883
884
# Execution log types
ELOG_MESSAGE = "message"
ELOG_PROGRESS = "progress"
885
ELOG_REMOTE_IMPORT = "remote-import"
886
887
ELOG_JQUEUE_TEST = "jqueue-test"

888
889
890
891
# /etc/hosts modification
ETC_HOSTS_ADD = "add"
ETC_HOSTS_REMOVE = "remove"

892
893
894
895
896
# Job queue test
JQT_MSGPREFIX = "TESTMSG="
JQT_EXPANDNAMES = "expandnames"
JQT_EXEC = "exec"
JQT_LOGMSG = "logmsg"
897
JQT_STARTMSG = "startmsg"
898
899
900
901
JQT_ALL = frozenset([
  JQT_EXPANDNAMES,
  JQT_EXEC,
  JQT_LOGMSG,
902
  JQT_STARTMSG,
903
  ])
904

905
# max dynamic devices
906
907
908
MAX_NICS = 8
MAX_DISKS = 16

Iustin Pop's avatar
Iustin Pop committed
909
910
# SSCONF keys
SS_CLUSTER_NAME = "cluster_name"
911
SS_CLUSTER_TAGS = "cluster_tags"
Iustin Pop's avatar
Iustin Pop committed
912
SS_FILE_STORAGE_DIR = "file_storage_dir"
913
SS_MASTER_CANDIDATES = "master_candidates"
914
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
Iustin Pop's avatar
Iustin Pop committed
915
916
917
918
SS_MASTER_IP = "master_ip"
SS_MASTER_NETDEV = "master_netdev"
SS_MASTER_NODE = "master_node"
SS_NODE_LIST = "node_list"
919
920
SS_NODE_PRIMARY_IPS = "node_primary_ips"
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
921
SS_OFFLINE_NODES = "offline_nodes"
922
SS_ONLINE_NODES = "online_nodes"
923
SS_PRIMARY_IP_FAMILY = "primary_ip_family"
924
SS_INSTANCE_LIST = "instance_list"
925
SS_RELEASE_VERSION = "release_version"
926
SS_HYPERVISOR_LIST = "hypervisor_list"
927
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
Balazs Lecz's avatar
Balazs Lecz committed
928
SS_UID_POOL = "uid_pool"
929
SS_NODEGROUPS = "nodegroups"
Iustin Pop's avatar
Iustin Pop committed
930

931
932
933
934
# cluster wide default parameters
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM

HVC_DEFAULTS = {
935
  HT_XEN_PVM: {
936
937
938
    HV_USE_BOOTLOADER: False,
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
    HV_BOOTLOADER_ARGS: '',
939
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
940
    HV_INITRD_PATH: '',
941
    HV_ROOT_PATH: '/dev/sda1',
942
    HV_KERNEL_ARGS: 'ro',
943
    HV_MIGRATION_PORT: 8002,
944
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
945
946
947
    },
  HT_XEN_HVM: {
    HV_BOOT_ORDER: "cd",
948
    HV_CDROM_IMAGE_PATH: '',
949
    HV_NIC_TYPE: HT_NIC_RTL8139,
950
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
951
    HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
952
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
953
954
    HV_ACPI: True,
    HV_PAE: True,
955
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
956
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
957
    HV_MIGRATION_PORT: 8002,
958
    HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
959
    HV_USE_LOCALTIME: False,
960
961
962
    },
  HT_KVM: {
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
963
    HV_INITRD_PATH: '',
964
    HV_KERNEL_ARGS: 'ro',
965
    HV_ROOT_PATH: '/dev/vda1',