constants.py 36.6 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, 2011 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
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
Guido Trotter's avatar
Guido Trotter committed
30
31
OS_API_V10 = 10
OS_API_V15 = 15
32
33
OS_API_V20 = 20
OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
34
VCS_VERSION = _autoconf.VCS_VERSION
Iustin Pop's avatar
Iustin Pop committed
35
EXPORT_VERSION = 0
36
RAPI_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
37

38

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

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


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

86
87
88
#: RPC protocol version
PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)

89
90
# user separation
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
91
ADMIN_GROUP = _autoconf.ADMIN_GROUP
92
MASTERD_USER = _autoconf.MASTERD_USER
93
MASTERD_GROUP = _autoconf.MASTERD_GROUP
94
RAPI_USER = _autoconf.RAPI_USER
95
96
97
98
RAPI_GROUP = _autoconf.RAPI_GROUP
CONFD_USER = _autoconf.CONFD_USER
CONFD_GROUP = _autoconf.CONFD_GROUP
NODED_USER = _autoconf.NODED_USER
René Nussbaumer's avatar
René Nussbaumer committed
99
NODED_GROUP = _autoconf.NODED_GROUP
100

101

102
# Wipe
103
104
DD_CMD = "dd"
WIPE_BLOCK_SIZE = 1024**2
105
106
107
MAX_WIPE_CHUNK = 1024 # 1GB
MIN_WIPE_CHUNK_PERCENT = 10

108

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

158
ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
159

160
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
161

162
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
163
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
164
RAPI = "ganeti-rapi"
165
MASTERD = "ganeti-masterd"
Guido Trotter's avatar
Guido Trotter committed
166
167
# used in the ganeti-nbma project
NLD = "ganeti-nld"
168
169
170
171

DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
172
  CONFD: ("udp", 1814),
Guido Trotter's avatar
Guido Trotter committed
173
  RAPI: ("tcp", 5080),
174
  "ssh": ("tcp", 22),
Guido Trotter's avatar
Guido Trotter committed
175
176
  # used in the ganeti-nbma project
  NLD: ("udp", 1816),
177
178
}
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
179
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
Guido Trotter's avatar
Guido Trotter committed
180
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
Guido Trotter's avatar
Guido Trotter committed
181
182
# used in the ganeti-nbma project
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
183

Iustin Pop's avatar
Iustin Pop committed
184
185
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999
186
MASTER_SCRIPT = "ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
187

188
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
189
DAEMONS_LOGFILES = {
Michael Hanselmann's avatar
Michael Hanselmann committed
190
191
192
193
194
  # "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
195
196
  # used in the ganeti-nbma project
  NLD: LOG_DIR + "nl-daemon.log",
Michael Hanselmann's avatar
Michael Hanselmann committed
197
  }
Michael Hanselmann's avatar
Michael Hanselmann committed
198

199
200
201
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
202
LOG_BURNIN = LOG_DIR + "burnin.log"
203
LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
Iustin Pop's avatar
Iustin Pop committed
204

Luca Bigliardi's avatar
Luca Bigliardi committed
205
206
DEV_CONSOLE = "/dev/console"

Balazs Lecz's avatar
Balazs Lecz committed
207
208
PROC_MOUNTS = "/proc/mounts"

209
# Local UniX Interface related constants
210
LUXI_EOM = "\3"
211
LUXI_VERSION = CONFIG_VERSION
212

213
214
215
216
217
218
219
# one of 'no', 'yes', 'only'
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

220
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
221
EXPORT_DIR = _autoconf.EXPORT_DIR
Iustin Pop's avatar
Iustin Pop committed
222
223
224

EXPORT_CONF_FILE = "config.ini"

225
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
226
227
228
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD

229
KVM_PATH = _autoconf.KVM_PATH
Guido Trotter's avatar
Guido Trotter committed
230
SOCAT_PATH = _autoconf.SOCAT_PATH
231
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
232
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
233
SOCAT_ESCAPE_CODE = "0x1d"
234

235
236
237
238
239
240
241
242
243
244
245
246
#: Console as SSH command
CONS_SSH = "ssh"

#: Console as VNC server
CONS_VNC = "vnc"

#: Display a message for console access
CONS_MESSAGE = "msg"

#: All console types
CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_MESSAGE])

247
248
249
250
251
# 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

252
253
254
# 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
255
# modifying the ciphers, ensure not to accidentially add something after it's
256
257
258
259
# 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"

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

263
264
265
266
267
268
# Default validity of certificates in days
X509_CERT_DEFAULT_VALIDITY = 365 * 5

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

269
270
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

271
272
273
274
275
276
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"

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

277
278
279
280
281
282
283
284
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
IEC_ALL = frozenset([
  IEC_NONE,
  IEC_GZIP,
  ])

285
286
IE_CUSTOM_SIZE = "fd"

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

289
290
291
292
293
294
295
296
# 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"

297
VALUE_DEFAULT = "default"
298
299
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
300
VALUE_NONE = "none"
301
302
VALUE_TRUE = "true"
VALUE_FALSE = "false"
303

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

Iustin Pop's avatar
Iustin Pop committed
307
# hooks-related constants
308
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
Iustin Pop's avatar
Iustin Pop committed
309
310
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
311
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
312
HOOKS_NAME_WATCHER = "watcher"
313
HOOKS_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
314
315
316
317

# hooks subject type (what object type does the LU deal with)
HTYPE_CLUSTER = "CLUSTER"
HTYPE_NODE = "NODE"
318
HTYPE_GROUP = "GROUP"
Iustin Pop's avatar
Iustin Pop committed
319
320
321
322
323
324
HTYPE_INSTANCE = "INSTANCE"

HKR_SKIP = 0
HKR_FAIL = 1
HKR_SUCCESS = 2

325
326
327
328
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
329
330

# Storage fields
331
332
333
334
# 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
335
336
337
338
339
340
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

341
342
343
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

344
# Available fields per storage type
345
346
347
348
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
349

350
351
352
353
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

354
VALID_STORAGE_OPERATIONS = {
355
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
356
357
  }

358
359
360
361
362
363
# 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
364
365
366
# disk template types
DT_DISKLESS = "diskless"
DT_PLAIN = "plain"
367
DT_DRBD8 = "drbd"
368
DT_FILE = "file"
369
DT_SHARED_FILE = "sharedfile"
370
DT_BLOCK = "blockdev"
371
372

# the set of network-mirrored disk templates
373
DTS_INT_MIRROR = frozenset([DT_DRBD8])
Iustin Pop's avatar
Iustin Pop committed
374

375
376
# the set of externally-mirrored disk templates (e.g. SAN, NAS)
DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK])
377

378
# the set of non-lvm-based disk templates
379
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE, DT_BLOCK])
380

381
# the set of disk templates which can be grown
382
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE])
383

384
# the set of disk templates that allow adoption
385
386
387
388
DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])

# the set of disk templates that *must* use adoption
DTS_MUST_ADOPT = frozenset([DT_BLOCK])
389

390
# the set of disk templates that allow migrations
391
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
392

Guido Trotter's avatar
Guido Trotter committed
393
394
# the set of file based disk templates
DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
395

396
397
# logical disk types
LD_LV = "lvm"
398
LD_DRBD8 = "drbd8"
399
LD_FILE = "file"
400
401
LD_BLOCKDEV = "blockdev"
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV])
402

Iustin Pop's avatar
Iustin Pop committed
403
404
# drbd constants
DRBD_HMAC_ALG = "md5"
405
DRBD_NET_PROTOCOL = "C"
406
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
Iustin Pop's avatar
Iustin Pop committed
407

408
409
410
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
411
412

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

415
# disk access mode
416
417
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
418
419
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

420
# disk replacement mode
421
422
423
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
424
REPLACE_DISK_AUTO = "replace_auto"
425
426
427
428
429
430
REPLACE_MODES = frozenset([
  REPLACE_DISK_PRI,
  REPLACE_DISK_SEC,
  REPLACE_DISK_CHG,
  REPLACE_DISK_AUTO,
  ])
431

432
433
434
435
436
437
438
439
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
EXPORT_MODES = frozenset([
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

440
# Lock recalculate mode
441
LOCKS_REPLACE = 'replace'
442
LOCKS_APPEND = 'append'
443

444
445
446
447
448
449
450
451
# Lock timeout (sum) before we should go into blocking acquire (still
# can be reset by priority change); computed as max time (10 hours)
# before we should actually go into blocking acquire given that we
# start from default priority level; in seconds
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
LOCK_ATTEMPTS_MAXWAIT = 15.0
LOCK_ATTEMPTS_MINWAIT = 1.0

452
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
453
454
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
455
456
457
458
459
460
INSTANCE_REMOTE_IMPORT = "remote-import"
INSTANCE_CREATE_MODES = frozenset([
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
461

462
463
464
465
466
467
468
# 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

469
# Overall timeout for establishing connection
470
RIE_CONNECT_TIMEOUT = 180
471

472
473
474
475
476
477
# Export only: how long to wait per connection attempt (seconds)
RIE_CONNECT_ATTEMPT_TIMEOUT = 20

# Export only: number of attempts to connect
RIE_CONNECT_RETRIES = 10

René Nussbaumer's avatar
René Nussbaumer committed
478
479
#: Give child process up to 5 seconds to exit after sending a signal
CHILD_LINGER_TIMEOUT = 5.0
480

481
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN, DT_DRBD8,
482
                            DT_FILE, DT_SHARED_FILE, DT_BLOCK])
483
484

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
485
486
487
488

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
489
490
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
491
INISECT_OSP = "os"
492

493
# dynamic device modification
494
495
496
DDM_ADD = "add"
DDM_REMOVE = "remove"
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
497

498
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
499
EXIT_SUCCESS = 0
500
EXIT_FAILURE = 1
501
EXIT_NOTCLUSTER = 5
502
EXIT_NOTMASTER = 11
503
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
504
EXIT_CONFIRMATION = 13 # need user confirmation
505

506
507
508
#: Exit code for query operations with unknown fields
EXIT_UNKNOWN_FIELD = 14

509
510
# tags
TAG_CLUSTER = "cluster"
511
TAG_NODEGROUP = "nodegroup"
512
513
TAG_NODE = "node"
TAG_INSTANCE = "instance"
514
515
VALID_TAG_TYPES = frozenset([
  TAG_CLUSTER,
516
  TAG_NODEGROUP,
517
518
519
  TAG_NODE,
  TAG_INSTANCE,
  ])
520
521
522
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

523
524
# others
DEFAULT_BRIDGE = "xen-br0"
Iustin Pop's avatar
Iustin Pop committed
525
SYNC_SPEED = 60 * 1024
526
527
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
IP4_ADDRESS_ANY = "0.0.0.0"
Manuel Franceschini's avatar
Manuel Franceschini committed
528
529
IP6_ADDRESS_LOCALHOST = "::1"
IP6_ADDRESS_ANY = "::"
530
531
IP4_VERSION = 4
IP6_VERSION = 6
532
TCP_PING_TIMEOUT = 10
533
GANETI_RUNAS = "root"
534
DEFAULT_VG = "xenvg"
535
DEFAULT_DRBD_HELPER = "/bin/true"
536
MIN_VG_SIZE = 20480
537
DEFAULT_MAC_PREFIX = "aa:00:00"
538
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
539
540
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
541
NODE_MAX_CLOCK_SKEW = 150
542
# Time for an intra-cluster disk transfer to wait for a connection
543
DISK_TRANSFER_CONNECT_TIMEOUT = 60
544
545
# Disk index separator
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
546

547
548
549
#: Key for job IDs in opcode result
JOB_IDS_KEY = "jobs"

550
551
552
553
554
555
556
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

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

557
558
559
560
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

561
562
563
564
565
# os related constants
OS_SCRIPT_CREATE = 'create'
OS_SCRIPT_IMPORT = 'import'
OS_SCRIPT_EXPORT = 'export'
OS_SCRIPT_RENAME = 'rename'
566
OS_SCRIPT_VERIFY = 'verify'
Iustin Pop's avatar
Iustin Pop committed
567
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
568
569
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME,
                        OS_SCRIPT_VERIFY])
570

571
OS_API_FILE = 'ganeti_api_version'
572
OS_VARIANTS_FILE = 'variants.list'
573
574
575
OS_PARAMETERS_FILE = 'parameters.list'

OS_VALIDATE_PARAMETERS = 'parameters'
576
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
577

578
# ssh constants
579
580
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
581
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
582
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
583
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
584
585
SSH = "ssh"
SCP = "scp"
586
587
588
589
590

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

592
593
594
595
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
                          INSTANCE_REBOOT_HARD,
                          INSTANCE_REBOOT_FULL])

596
VTYPE_STRING = 'string'
597
VTYPE_MAYBE_STRING = "maybe-string"
598
599
600
601
602
VTYPE_BOOL = 'bool'
VTYPE_SIZE = 'size' # size, in MiBs
VTYPE_INT = 'int'
ENFORCEABLE_TYPES = frozenset([
                      VTYPE_STRING,
603
                      VTYPE_MAYBE_STRING,
604
605
606
607
608
                      VTYPE_BOOL,
                      VTYPE_SIZE,
                      VTYPE_INT,
                      ])

609
610
611
# HV parameter names (global namespace)
HV_BOOT_ORDER = "boot_order"
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
612
613
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
614
615
HV_NIC_TYPE = "nic_type"
HV_DISK_TYPE = "disk_type"
616
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
617
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
618
HV_VNC_PASSWORD_FILE = "vnc_password_file"
619
620
621
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
622
623
HV_ACPI = "acpi"
HV_PAE = "pae"
624
625
626
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
627
HV_KERNEL_ARGS = "kernel_args"
628
629
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
630
HV_ROOT_PATH = "root_path"
631
HV_SERIAL_CONSOLE = "serial_console"
632
HV_USB_MOUSE = "usb_mouse"
633
HV_KEYMAP = "keymap"
634
HV_DEVICE_MODEL = "device_model"
635
HV_INIT_SCRIPT = "init_script"
636
HV_MIGRATION_PORT = "migration_port"
637
638
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
639
HV_MIGRATION_MODE = "migration_mode"
640
HV_USE_LOCALTIME = "use_localtime"
641
HV_DISK_CACHE = "disk_cache"
642
643
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
644
HV_KVM_FLAG = "kvm_flag"
645
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
646
HV_KVM_USE_CHROOT = "use_chroot"
647
HV_CPU_MASK = "cpu_mask"
648
HV_MEM_PATH = "mem_path"
649
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
650

651
652
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
653
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
654
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
655
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
656
657
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
658
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
659
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
660
661
662
663
664
665
  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,
666
667
668
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
669
  HV_KERNEL_PATH: VTYPE_STRING,
670
  HV_KERNEL_ARGS: VTYPE_STRING,
671
  HV_INITRD_PATH: VTYPE_STRING,
672
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
673
674
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
675
  HV_KEYMAP: VTYPE_STRING,
676
  HV_DEVICE_MODEL: VTYPE_STRING,
677
  HV_INIT_SCRIPT: VTYPE_STRING,
678
  HV_MIGRATION_PORT: VTYPE_INT,
679
680
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
681
  HV_MIGRATION_MODE: VTYPE_STRING,
682
  HV_USE_LOCALTIME: VTYPE_BOOL,
683
  HV_DISK_CACHE: VTYPE_STRING,
684
685
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
686
  HV_KVM_FLAG: VTYPE_STRING,
687
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
688
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
689
  HV_CPU_MASK: VTYPE_STRING,
690
  HV_MEM_PATH: VTYPE_STRING,
691
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
692
693
694
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
695

696
# Backend parameter names
Iustin Pop's avatar
Iustin Pop committed
697
BE_MEMORY = "memory"
698
BE_VCPUS = "vcpus"
699
BE_AUTO_BALANCE = "auto_balance"
700

701
702
703
704
705
706
707
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
708

709
710
711
712
713
714
715
716
717
# Node parameter names
ND_OOB_PROGRAM = "oob_program"

NDS_PARAMETER_TYPES = {
    ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
    }

NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())

718
719
720
721
722
723
724
725
726
727
# OOB supported commands
OOB_POWER_ON = "power-on"
OOB_POWER_OFF = "power-off"
OOB_POWER_CYCLE = "power-cycle"
OOB_POWER_STATUS = "power-status"
OOB_HEALTH = "health"

OOB_COMMANDS = frozenset([OOB_POWER_ON, OOB_POWER_OFF, OOB_POWER_CYCLE,
                          OOB_POWER_STATUS, OOB_HEALTH])

728
729
OOB_POWER_STATUS_POWERED = "powered"

730
OOB_TIMEOUT = 60 # 60 seconds
731
OOB_POWER_DELAY = 2.0 # 2 seconds
732
733
734
735
736
737
738
739
740
741
742
743
744

OOB_STATUS_OK = "OK"
OOB_STATUS_WARNING = "WARNING"
OOB_STATUS_CRITICAL = "CRITICAL"
OOB_STATUS_UNKNOWN = "UNKNOWN"

OOB_STATUSES = frozenset([
  OOB_STATUS_OK,
  OOB_STATUS_WARNING,
  OOB_STATUS_CRITICAL,
  OOB_STATUS_UNKNOWN,
  ])

745
746
# Instance Parameters Profile
PP_DEFAULT = "default"
747

748
# NIC_* constants are used inside the ganeti config
Guido Trotter's avatar
Guido Trotter committed
749
750
751
752
753
754
755
756
757
758
759
760
761
762
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())
763

764
# IDISK_* constants are used in opcodes, to create/change disks
765
766
IDISK_SIZE = "size"
IDISK_MODE = "mode"
767
IDISK_ADOPT = "adopt"
768
IDISK_VG = "vg"
769
IDISK_METAVG = "metavg"
770
771
772
773
IDISK_PARAMS_TYPES = {
  IDISK_SIZE: VTYPE_SIZE,
  IDISK_MODE: VTYPE_STRING,
  IDISK_ADOPT: VTYPE_STRING,
774
  IDISK_VG: VTYPE_STRING,
775
  IDISK_METAVG: VTYPE_STRING,
776
  }
777
778
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())

779
# INIC_* constants are used in opcodes, to create/change nics
780
781
782
783
INIC_MAC = "mac"
INIC_IP = "ip"
INIC_MODE = "mode"
INIC_LINK = "link"
784
785
786
787
788
789
790
INIC_PARAMS_TYPES = {
  INIC_IP: VTYPE_MAYBE_STRING,
  INIC_LINK: VTYPE_STRING,
  INIC_MAC: VTYPE_STRING,
  INIC_MODE: VTYPE_STRING,
  }
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
791

792
# Hypervisor constants
Iustin Pop's avatar
Iustin Pop committed
793
HT_XEN_PVM = "xen-pvm"
794
HT_FAKE = "fake"
Iustin Pop's avatar
Iustin Pop committed
795
HT_XEN_HVM = "xen-hvm"
Guido Trotter's avatar
Guido Trotter committed
796
HT_KVM = "kvm"
797
HT_CHROOT = "chroot"
Iustin Pop's avatar
Iustin Pop committed
798
799
800
801
802
803
804
805
806
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
807
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
808

809
VNC_BASE_PORT = 5900
810
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
Manuel Franceschini's avatar
Manuel Franceschini committed
811
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
812

813
# NIC types
814
815
816
HT_NIC_RTL8139 = "rtl8139"
HT_NIC_NE2K_PCI = "ne2k_pci"
HT_NIC_NE2K_ISA = "ne2k_isa"
817
818
819
820
821
HT_NIC_I82551 = "i82551"
HT_NIC_I85557B = "i82557b"
HT_NIC_I8259ER = "i82559er"
HT_NIC_PCNET = "pcnet"
HT_NIC_E1000 = "e1000"
822
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
823

824
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
Guido Trotter's avatar
Guido Trotter committed
825
826
                                    HT_NIC_E1000, HT_NIC_NE2K_ISA,
                                    HT_NIC_PARAVIRTUAL])
827
828
829
830
831
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])
832
833
834
835
836
837
838
839
# 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"

840
841
842
843
844
845
846
847
848
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])

849
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
850
851
852
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
                                     HT_DISK_PFLASH])
853

854
855
856
857
858
859
860
# Mouse types:
HT_MOUSE_MOUSE = "mouse"
HT_MOUSE_TABLET = "tablet"

HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])

# Boot order
861
HT_BO_FLOPPY = "floppy"
862
863
864
865
HT_BO_CDROM = "cdrom"
HT_BO_DISK = "disk"
HT_BO_NETWORK = "network"

866
867
HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_FLOPPY, HT_BO_CDROM,
                                   HT_BO_DISK, HT_BO_NETWORK])
868

869
870
871
872
873
874
875
# 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
876
877
878
879
880
881
# Kvm flag values
HT_KVM_ENABLED = "enabled"
HT_KVM_DISABLED = "disabled"

HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])

882
883
884
# Migration type
HT_MIGRATION_LIVE = "live"
HT_MIGRATION_NONLIVE = "non-live"
885
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
886

887
888
889
890
# Cluster Verify steps
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])

891
# Node verify constants
892
NV_DRBDHELPER = "drbd-helper"
893
NV_DRBDLIST = "drbd-list"
894
895
896
NV_FILELIST = "filelist"
NV_HVINFO = "hvinfo"
NV_HYPERVISOR = "hypervisor"
897
NV_HVPARAMS = "hvparms"
898
NV_INSTANCELIST = "instancelist"
899
900
NV_LVLIST = "lvlist"
NV_MASTERIP = "master-ip"
901
902
NV_NODELIST = "nodelist"
NV_NODENETTEST = "node-net-test"
903
NV_NODESETUP = "nodesetup"
904
905
NV_OSLIST = "oslist"
NV_PVLIST = "pvlist"
906
NV_TIME = "time"
907
908
NV_VERSION = "version"
NV_VGLIST = "vglist"
909
NV_VMNODES = "vmnodes"
910
NV_OOB_PATHS = "oob-paths"
911
NV_BRIDGES = "bridges"
912

913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# Instance status
INSTST_RUNNING = "running"
INSTST_ADMINDOWN = "ADMIN_down"
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
INSTST_NODEDOWN = "ERROR_nodedown"
INSTST_WRONGNODE = "ERROR_wrongnode"
INSTST_ERRORUP = "ERROR_up"
INSTST_ERRORDOWN = "ERROR_down"
INSTST_ALL = frozenset([
  INSTST_RUNNING,
  INSTST_ADMINDOWN,
  INSTST_NODEOFFLINE,
  INSTST_NODEDOWN,
  INSTST_WRONGNODE,
  INSTST_ERRORUP,
  INSTST_ERRORDOWN,
  ])

931
932
933
934
935
936
937
938
939
940
941
942
943
944
# Node roles
NR_REGULAR = "R"
NR_MASTER = "M"
NR_MCANDIDATE = "C"
NR_DRAINED = "D"
NR_OFFLINE = "O"
NR_ALL = frozenset([
  NR_REGULAR,
  NR_MASTER,
  NR_MCANDIDATE,
  NR_DRAINED,
  NR_OFFLINE,
  ])

945
946
947
948
# SSL certificate check constants (in days)
SSL_CERT_EXPIRATION_WARN = 30
SSL_CERT_EXPIRATION_ERROR = 7

949
# Allocator framework constants
950
IALLOCATOR_VERSION = 2
951
952
IALLOCATOR_DIR_IN = "in"
IALLOCATOR_DIR_OUT = "out"
953
954
955
956
VALID_IALLOCATOR_DIRECTIONS = frozenset([
  IALLOCATOR_DIR_IN,
  IALLOCATOR_DIR_OUT,
  ])
957
958
IALLOCATOR_MODE_ALLOC = "allocate"
IALLOCATOR_MODE_RELOC = "relocate"
959
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
960
961
IALLOCATOR_MODE_CHG_GROUP = "change-group"
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
962
963
964
965
VALID_IALLOCATOR_MODES = frozenset([
  IALLOCATOR_MODE_ALLOC,
  IALLOCATOR_MODE_RELOC,
  IALLOCATOR_MODE_MEVAC,
966
967
  IALLOCATOR_MODE_CHG_GROUP,
  IALLOCATOR_MODE_NODE_EVAC,
968
  ])