constants.py 57.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, 2011, 2012 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
import re
25
import socket
26

27
from ganeti import _autoconf
28
from ganeti import _vcsversion
29
from ganeti import compat
30
from ganeti import pathutils
31

32

Iustin Pop's avatar
Iustin Pop committed
33
# various versions
34
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
Guido Trotter's avatar
Guido Trotter committed
35
36
OS_API_V10 = 10
OS_API_V15 = 15
37
OS_API_V20 = 20
38
39
40
41
42
OS_API_VERSIONS = compat.UniqueFrozenset([
  OS_API_V10,
  OS_API_V15,
  OS_API_V20,
  ])
43
VCS_VERSION = _vcsversion.VCS_VERSION
Iustin Pop's avatar
Iustin Pop committed
44
EXPORT_VERSION = 0
45
RAPI_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
46

47

48
49
50
51
52
53
54
# Format for CONFIG_VERSION:
#   01 03 0123 = 01030123
#   ^^ ^^ ^^^^
#   |  |  + Configuration version/revision
#   |  + Minor version
#   + Major version
#
55
# It is stored as an integer. Make sure not to write an octal number.
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
82
83
84
85
86
87
88
89

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


90
91
92
CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
CONFIG_REVISION = 0
93
CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
Iustin Pop's avatar
Iustin Pop committed
94

95
96
97
#: RPC protocol version
PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)

98
99
# user separation
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
100
ADMIN_GROUP = _autoconf.ADMIN_GROUP
101
MASTERD_USER = _autoconf.MASTERD_USER
102
MASTERD_GROUP = _autoconf.MASTERD_GROUP
103
RAPI_USER = _autoconf.RAPI_USER
104
105
106
107
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
108
NODED_GROUP = _autoconf.NODED_GROUP
Michael Hanselmann's avatar
Michael Hanselmann committed
109
110
SSH_LOGIN_USER = _autoconf.SSH_LOGIN_USER
SSH_CONSOLE_USER = _autoconf.SSH_CONSOLE_USER
111

Tsachy Shacham's avatar
Tsachy Shacham committed
112
113
114
115
116
# cpu pinning separators and constants
CPU_PINNING_SEP = ":"
CPU_PINNING_ALL = "all"
# internal representation of "all"
CPU_PINNING_ALL_VAL = -1
117
118
# one "all" entry in a CPU list means CPU pinning is off
CPU_PINNING_OFF = [CPU_PINNING_ALL_VAL]
Tsachy Shacham's avatar
Tsachy Shacham committed
119
120
121
122
123
124
125
126
127

# A Xen-specific implementation detail - there is no way to actually say
# "use any cpu for pinning" in a Xen configuration file, as opposed to the
# command line, where you can say "xm vcpu-pin <domain> <vcpu> all".
# The workaround used in Xen is "0-63" (see source code function
# xm_vcpu_pin in <xen-source>/tools/python/xen/xm/main.py).
# To support future changes, the following constant is treated as a
# blackbox string that simply means use-any-cpu-for-pinning-under-xen.
CPU_PINNING_ALL_XEN = "0-63"
128

129
130
131
# A KVM-specific implementation detail - the following value is used
# to set CPU affinity to all processors (#0 through #31), per taskset
# man page.
132
# FIXME: This only works for machines with up to 32 CPU cores
133
134
CPU_PINNING_ALL_KVM = 0xFFFFFFFF

135
# Wipe
136
DD_CMD = "dd"
137
138
139
MAX_WIPE_CHUNK = 1024 # 1GB
MIN_WIPE_CHUNK_PERCENT = 10

140
RUN_DIRS_MODE = 0775
141
SECURE_DIR_MODE = 0700
142
SECURE_FILE_MODE = 0600
143
ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
144
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
145
ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
146
ENABLE_CONFD = _autoconf.ENABLE_CONFD
147
ENABLE_SPLIT_QUERY = _autoconf.ENABLE_SPLIT_QUERY
148
ENABLE_RESTRICTED_COMMANDS = _autoconf.ENABLE_RESTRICTED_COMMANDS
149

150
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
151
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
152
RAPI = "ganeti-rapi"
153
MASTERD = "ganeti-masterd"
154
155
156
157

DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
158
  CONFD: ("udp", 1814),
Guido Trotter's avatar
Guido Trotter committed
159
  RAPI: ("tcp", 5080),
160
  "ssh": ("tcp", 22),
161
162
}
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
163
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
Guido Trotter's avatar
Guido Trotter committed
164
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
165

Iustin Pop's avatar
Iustin Pop committed
166
167
168
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999

169
170
171
172
173
174
175
DAEMONS_LOGFILES = {
  NODED: pathutils.GetLogFilename("node-daemon"),
  CONFD: pathutils.GetLogFilename("conf-daemon"),
  RAPI: pathutils.GetLogFilename("rapi-daemon"),
  MASTERD: pathutils.GetLogFilename("master-daemon"),
  }

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

Balazs Lecz's avatar
Balazs Lecz committed
178
179
PROC_MOUNTS = "/proc/mounts"

180
# Local UniX Interface related constants
181
LUXI_EOM = "\3"
182
LUXI_VERSION = CONFIG_VERSION
183

Iustin Pop's avatar
Iustin Pop committed
184
# one of "no", "yes", "only"
185
186
187
188
189
190
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

Iustin Pop's avatar
Iustin Pop committed
191
192
EXPORT_CONF_FILE = "config.ini"

193
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
194
195
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD
196
197
198
199
XEN_CMD_XM = "xm"
XEN_CMD_XL = "xl"
# FIXME: This will be made configurable using hvparams in Ganeti 2.7
XEN_CMD = _autoconf.XEN_CMD
Guido Trotter's avatar
Guido Trotter committed
200
201
202
203
204
# When the Xen toolstack used is "xl", live migration requires the source host
# to connect to the target host via ssh (xl runs this command). We need to pass
# the command xl runs some extra info so that it can use Ganeti's key
# verification and not fail. Note that this string is incomplete: it must be
# filled with the cluster name before being used.
205
XL_SSH_CMD = ("ssh -l %s -oGlobalKnownHostsFile=%s"
Guido Trotter's avatar
Guido Trotter committed
206
207
              " -oUserKnownHostsFile=/dev/null"
              " -oCheckHostIp=no -oStrictHostKeyChecking=yes"
208
209
              " -oHostKeyAlias=%%s") % (SSH_LOGIN_USER,
                                        pathutils.SSH_KNOWN_HOSTS_FILE)
210

211
KVM_PATH = _autoconf.KVM_PATH
212
KVM_KERNEL = _autoconf.KVM_KERNEL
Guido Trotter's avatar
Guido Trotter committed
213
SOCAT_PATH = _autoconf.SOCAT_PATH
214
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
215
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
216
SOCAT_ESCAPE_CODE = "0x1d"
217

218
219
220
221
222
223
#: Console as SSH command
CONS_SSH = "ssh"

#: Console as VNC server
CONS_VNC = "vnc"

224
225
226
#: Console as SPICE server
CONS_SPICE = "spice"

227
228
229
230
#: Display a message for console access
CONS_MESSAGE = "msg"

#: All console types
231
232
233
234
235
236
CONS_ALL = compat.UniqueFrozenset([
  CONS_SSH,
  CONS_VNC,
  CONS_SPICE,
  CONS_MESSAGE,
  ])
237

238
239
240
241
242
# 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

243
244
245
# 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
246
# modifying the ciphers, ensure not to accidentially add something after it's
247
248
249
250
# 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"

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

254
255
256
257
258
259
# Default validity of certificates in days
X509_CERT_DEFAULT_VALIDITY = 365 * 5

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

260
261
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

262
263
264
265
# Import/export daemon mode
IEM_IMPORT = "import"
IEM_EXPORT = "export"

266
267
268
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
269
IEC_ALL = compat.UniqueFrozenset([
270
271
272
273
  IEC_NONE,
  IEC_GZIP,
  ])

274
275
IE_CUSTOM_SIZE = "fd"

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

278
279
280
281
282
283
284
285
# 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"

286
VALUE_DEFAULT = "default"
287
288
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
289
VALUE_NONE = "none"
290
291
VALUE_TRUE = "true"
VALUE_FALSE = "false"
292

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

Iustin Pop's avatar
Iustin Pop committed
296
297
298
# hooks-related constants
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
299
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
300
HOOKS_NAME_WATCHER = "watcher"
301
HOOKS_VERSION = 2
302
HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
Iustin Pop's avatar
Iustin Pop committed
303
304
305
306

# hooks subject type (what object type does the LU deal with)
HTYPE_CLUSTER = "CLUSTER"
HTYPE_NODE = "NODE"
307
HTYPE_GROUP = "GROUP"
Iustin Pop's avatar
Iustin Pop committed
308
HTYPE_INSTANCE = "INSTANCE"
309
HTYPE_NETWORK = "NETWORK"
Iustin Pop's avatar
Iustin Pop committed
310
311
312
313
314

HKR_SKIP = 0
HKR_FAIL = 1
HKR_SUCCESS = 2

315
316
317
318
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
319
320

# Storage fields
321
322
323
324
# 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
325
326
327
328
329
330
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

331
332
333
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

334
# Available fields per storage type
335
VALID_STORAGE_FIELDS = compat.UniqueFrozenset([
Stephen Shirley's avatar
Stephen Shirley committed
336
337
338
339
340
  SF_NAME,
  SF_TYPE,
  SF_SIZE,
  SF_USED,
  SF_FREE,
341
  SF_ALLOCATABLE,
Stephen Shirley's avatar
Stephen Shirley committed
342
  ])
343

344
345
346
347
348
VALID_STORAGE_TYPES = compat.UniqueFrozenset([
  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
DT_RBD = "rbd"
372
DT_EXT = "ext"
373
374

# the set of network-mirrored disk templates
375
DTS_INT_MIRROR = compat.UniqueFrozenset([DT_DRBD8])
Iustin Pop's avatar
Iustin Pop committed
376

377
# the set of externally-mirrored disk templates (e.g. SAN, NAS)
378
379
380
381
DTS_EXT_MIRROR = compat.UniqueFrozenset([
  DT_SHARED_FILE,
  DT_BLOCK,
  DT_RBD,
382
  DT_EXT,
383
  ])
384

385
# the set of non-lvm-based disk templates
386
387
388
389
390
391
DTS_NOT_LVM = compat.UniqueFrozenset([
  DT_DISKLESS,
  DT_FILE,
  DT_SHARED_FILE,
  DT_BLOCK,
  DT_RBD,
392
  DT_EXT,
393
  ])
394

395
# the set of disk templates which can be grown
396
397
398
399
400
401
DTS_GROWABLE = compat.UniqueFrozenset([
  DT_PLAIN,
  DT_DRBD8,
  DT_FILE,
  DT_SHARED_FILE,
  DT_RBD,
402
  DT_EXT,
403
  ])
404

405
# the set of disk templates that allow adoption
406
407
408
409
DTS_MAY_ADOPT = compat.UniqueFrozenset([
  DT_PLAIN,
  DT_BLOCK,
  ])
410
411

# the set of disk templates that *must* use adoption
412
DTS_MUST_ADOPT = compat.UniqueFrozenset([DT_BLOCK])
413

414
# the set of disk templates that allow migrations
415
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
416

Guido Trotter's avatar
Guido Trotter committed
417
# the set of file based disk templates
418
419
420
421
DTS_FILEBASED = compat.UniqueFrozenset([
  DT_FILE,
  DT_SHARED_FILE,
  ])
422

423
424
425
426
# the set of disk templates that are supported by exclusive_storage
DTS_EXCL_STORAGE = frozenset([DT_PLAIN])

# templates for which we don't perform checks on free space
427
428
429
430
431
432
DTS_NO_FREE_SPACE_CHECK = compat.UniqueFrozenset([
  DT_FILE,
  DT_SHARED_FILE,
  DT_RBD,
  DT_EXT,
  ])
433

434
435
# logical disk types
LD_LV = "lvm"
436
LD_DRBD8 = "drbd8"
437
LD_FILE = "file"
438
LD_BLOCKDEV = "blockdev"
439
LD_RBD = "rbd"
440
LD_EXT = "ext"
441
LOGICAL_DISK_TYPES = compat.UniqueFrozenset([
442
443
444
445
  LD_LV,
  LD_DRBD8,
  LD_FILE,
  LD_BLOCKDEV,
446
  LD_RBD,
447
  LD_EXT,
448
449
  ])

450
451
452
453
454
LDS_BLOCK = compat.UniqueFrozenset([
  LD_LV,
  LD_DRBD8,
  LD_BLOCKDEV,
  LD_RBD,
455
  LD_EXT,
456
  ])
457

Iustin Pop's avatar
Iustin Pop committed
458
459
# drbd constants
DRBD_HMAC_ALG = "md5"
460
DRBD_NET_PROTOCOL = "C"
461
DRBD_STATUS_FILE = "/proc/drbd"
462

463
464
465
#: Size of DRBD meta block device
DRBD_META_SIZE = 128

466
467
468
469
470
471
472
# drbd barrier types
DRBD_B_NONE = "n"
DRBD_B_DISK_BARRIERS = "b"
DRBD_B_DISK_DRAIN = "d"
DRBD_B_DISK_FLUSH = "f"

# Valid barrier combinations: "n" or any non-null subset of "bfd"
473
DRBD_VALID_BARRIER_OPT = compat.UniqueFrozenset([
474
475
476
477
478
479
480
481
482
  frozenset([DRBD_B_NONE]),
  frozenset([DRBD_B_DISK_BARRIERS]),
  frozenset([DRBD_B_DISK_DRAIN]),
  frozenset([DRBD_B_DISK_FLUSH]),
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_DRAIN]),
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH]),
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH, DRBD_B_DISK_DRAIN]),
  ])
Iustin Pop's avatar
Iustin Pop committed
483

484
485
486
# rbd tool command
RBD_CMD = "rbd"

487
488
489
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
490
491

# the set of drbd-like disk types
492
LDS_DRBD = compat.UniqueFrozenset([LD_DRBD8])
493

494
# disk access mode
495
496
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
497
DISK_ACCESS_SET = compat.UniqueFrozenset([DISK_RDONLY, DISK_RDWR])
498

499
# disk replacement mode
500
501
502
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
503
REPLACE_DISK_AUTO = "replace_auto"
504
REPLACE_MODES = compat.UniqueFrozenset([
505
506
507
508
509
  REPLACE_DISK_PRI,
  REPLACE_DISK_SEC,
  REPLACE_DISK_CHG,
  REPLACE_DISK_AUTO,
  ])
510

511
512
513
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
514
EXPORT_MODES = compat.UniqueFrozenset([
515
516
517
518
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

519
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
520
521
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
522
INSTANCE_REMOTE_IMPORT = "remote-import"
523
INSTANCE_CREATE_MODES = compat.UniqueFrozenset([
524
525
526
527
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
528

529
530
531
532
533
534
535
# 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

536
# Overall timeout for establishing connection
537
RIE_CONNECT_TIMEOUT = 180
538

539
540
541
542
543
544
# 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
545
546
#: Give child process up to 5 seconds to exit after sending a signal
CHILD_LINGER_TIMEOUT = 5.0
547

548
DISK_TEMPLATES = compat.UniqueFrozenset([
Stephen Shirley's avatar
Stephen Shirley committed
549
550
551
552
553
  DT_DISKLESS,
  DT_PLAIN,
  DT_DRBD8,
  DT_FILE,
  DT_SHARED_FILE,
554
  DT_BLOCK,
555
  DT_RBD,
556
  DT_EXT
Stephen Shirley's avatar
Stephen Shirley committed
557
  ])
558

559
FILE_DRIVER = compat.UniqueFrozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
560
561
562
563

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
564
565
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
566
INISECT_OSP = "os"
567

568
# dynamic device modification
569
DDM_ADD = "add"
570
DDM_MODIFY = "modify"
571
DDM_REMOVE = "remove"
572
DDMS_VALUES = compat.UniqueFrozenset([DDM_ADD, DDM_REMOVE])
573
574
575
576
DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
  DDM_MODIFY,
  ]))
# TODO: DDM_SWAP, DDM_MOVE?
577

578
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
579
EXIT_SUCCESS = 0
580
EXIT_FAILURE = 1
581
EXIT_NOTCLUSTER = 5
582
EXIT_NOTMASTER = 11
583
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
584
EXIT_CONFIRMATION = 13 # need user confirmation
585

586
587
588
#: Exit code for query operations with unknown fields
EXIT_UNKNOWN_FIELD = 14

589
590
# tags
TAG_CLUSTER = "cluster"
591
TAG_NODEGROUP = "nodegroup"
592
593
TAG_NODE = "node"
TAG_INSTANCE = "instance"
594
TAG_NETWORK = "network"
595
VALID_TAG_TYPES = compat.UniqueFrozenset([
596
  TAG_CLUSTER,
597
  TAG_NODEGROUP,
598
599
  TAG_NODE,
  TAG_INSTANCE,
600
  TAG_NETWORK,
601
  ])
602
603
604
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

605
606
# others
DEFAULT_BRIDGE = "xen-br0"
607
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
608
609
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
IP4_ADDRESS_ANY = "0.0.0.0"
Manuel Franceschini's avatar
Manuel Franceschini committed
610
611
IP6_ADDRESS_LOCALHOST = "::1"
IP6_ADDRESS_ANY = "::"
612
613
IP4_VERSION = 4
IP6_VERSION = 6
614
VALID_IP_VERSIONS = compat.UniqueFrozenset([IP4_VERSION, IP6_VERSION])
615
616
617
618
# for export to htools
IP4_FAMILY = socket.AF_INET
IP6_FAMILY = socket.AF_INET6

619
TCP_PING_TIMEOUT = 10
620
DEFAULT_VG = "xenvg"
621
DEFAULT_DRBD_HELPER = "/bin/true"
622
MIN_VG_SIZE = 20480
623
DEFAULT_MAC_PREFIX = "aa:00:00"
624
625
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
626
NODE_MAX_CLOCK_SKEW = 150
627
# Time for an intra-cluster disk transfer to wait for a connection
628
DISK_TRANSFER_CONNECT_TIMEOUT = 60
629
630
# Disk index separator
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
631
IP_COMMAND_PATH = _autoconf.IP_PATH
632

633
634
635
#: Key for job IDs in opcode result
JOB_IDS_KEY = "jobs"

636
637
638
639
640
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

641
642
643
644
645
RUNPARTS_STATUS = compat.UniqueFrozenset([
  RUNPARTS_SKIP,
  RUNPARTS_RUN,
  RUNPARTS_ERR,
  ])
646

647
648
649
650
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

651
652
653
654
655
656
657
658
659
660
661
# Various time constants for the timeout table
RPC_TMO_URGENT = 60 # one minute
RPC_TMO_FAST = 5 * 60 # five minutes
RPC_TMO_NORMAL = 15 * 60 # 15 minutes
RPC_TMO_SLOW = 3600 # one hour
RPC_TMO_4HRS = 4 * 3600
RPC_TMO_1DAY = 86400

# Timeout for connecting to nodes (seconds)
RPC_CONNECT_TIMEOUT = 5

662
# os related constants
Iustin Pop's avatar
Iustin Pop committed
663
664
665
666
667
OS_SCRIPT_CREATE = "create"
OS_SCRIPT_IMPORT = "import"
OS_SCRIPT_EXPORT = "export"
OS_SCRIPT_RENAME = "rename"
OS_SCRIPT_VERIFY = "verify"
668
OS_SCRIPTS = compat.UniqueFrozenset([
Stephen Shirley's avatar
Stephen Shirley committed
669
670
671
672
  OS_SCRIPT_CREATE,
  OS_SCRIPT_IMPORT,
  OS_SCRIPT_EXPORT,
  OS_SCRIPT_RENAME,
673
  OS_SCRIPT_VERIFY,
Stephen Shirley's avatar
Stephen Shirley committed
674
  ])
675

Iustin Pop's avatar
Iustin Pop committed
676
677
678
OS_API_FILE = "ganeti_api_version"
OS_VARIANTS_FILE = "variants.list"
OS_PARAMETERS_FILE = "parameters.list"
679

Iustin Pop's avatar
Iustin Pop committed
680
OS_VALIDATE_PARAMETERS = "parameters"
681
OS_VALIDATE_CALLS = compat.UniqueFrozenset([OS_VALIDATE_PARAMETERS])
682

683
684
685
686
687
688
689
# External Storage (ES) related constants
ES_ACTION_CREATE = "create"
ES_ACTION_REMOVE = "remove"
ES_ACTION_GROW = "grow"
ES_ACTION_ATTACH = "attach"
ES_ACTION_DETACH = "detach"
ES_ACTION_SETINFO = "setinfo"
690
ES_ACTION_VERIFY = "verify"
691
692
693
694
695
696
697

ES_SCRIPT_CREATE = ES_ACTION_CREATE
ES_SCRIPT_REMOVE = ES_ACTION_REMOVE
ES_SCRIPT_GROW = ES_ACTION_GROW
ES_SCRIPT_ATTACH = ES_ACTION_ATTACH
ES_SCRIPT_DETACH = ES_ACTION_DETACH
ES_SCRIPT_SETINFO = ES_ACTION_SETINFO
698
ES_SCRIPT_VERIFY = ES_ACTION_VERIFY
699
700
701
702
703
704
ES_SCRIPTS = frozenset([
  ES_SCRIPT_CREATE,
  ES_SCRIPT_REMOVE,
  ES_SCRIPT_GROW,
  ES_SCRIPT_ATTACH,
  ES_SCRIPT_DETACH,
705
706
  ES_SCRIPT_SETINFO,
  ES_SCRIPT_VERIFY
707
708
  ])

709
710
ES_PARAMETERS_FILE = "parameters.list"

711
# ssh constants
712
713
SSH = "ssh"
SCP = "scp"
714
715
716
717
718

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

720
REBOOT_TYPES = compat.UniqueFrozenset([
721
722
  INSTANCE_REBOOT_SOFT,
  INSTANCE_REBOOT_HARD,
723
  INSTANCE_REBOOT_FULL,
724
725
726
727
728
729
  ])

# instance reboot behaviors
INSTANCE_REBOOT_ALLOWED = "reboot"
INSTANCE_REBOOT_EXIT = "exit"

730
REBOOT_BEHAVIORS = compat.UniqueFrozenset([
731
  INSTANCE_REBOOT_ALLOWED,
732
  INSTANCE_REBOOT_EXIT,
733
  ])
734

Iustin Pop's avatar
Iustin Pop committed
735
VTYPE_STRING = "string"
736
VTYPE_MAYBE_STRING = "maybe-string"
Iustin Pop's avatar
Iustin Pop committed
737
738
739
VTYPE_BOOL = "bool"
VTYPE_SIZE = "size" # size, in MiBs
VTYPE_INT = "int"
740
ENFORCEABLE_TYPES = compat.UniqueFrozenset([
Stephen Shirley's avatar
Stephen Shirley committed
741
742
743
744
745
746
  VTYPE_STRING,
  VTYPE_MAYBE_STRING,
  VTYPE_BOOL,
  VTYPE_SIZE,
  VTYPE_INT,
  ])
747

748
749
750
# Constant representing that the user does not specify any IP version
IFACE_NO_IP_VERSION_SPECIFIED = 0

751
752
753
# HV parameter names (global namespace)
HV_BOOT_ORDER = "boot_order"
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
754
755
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
756
757
HV_NIC_TYPE = "nic_type"
HV_DISK_TYPE = "disk_type"
758
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
759
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
760
HV_VNC_PASSWORD_FILE = "vnc_password_file"
761
762
763
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
764
765
HV_KVM_SPICE_BIND = "spice_bind"
HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
766
HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
767
768
769
770
771
HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
772
HV_KVM_SPICE_USE_TLS = "spice_use_tls"
773
774
HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
775
776
HV_ACPI = "acpi"
HV_PAE = "pae"
777
778
779
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
780
HV_KERNEL_ARGS = "kernel_args"
781
782
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
783
HV_ROOT_PATH = "root_path"
784
HV_SERIAL_CONSOLE = "serial_console"
785
HV_USB_MOUSE = "usb_mouse"
786
HV_KEYMAP = "keymap"
787
HV_DEVICE_MODEL = "device_model"
788
HV_INIT_SCRIPT = "init_script"
789
HV_MIGRATION_PORT = "migration_port"
790
791
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
792
HV_MIGRATION_MODE = "migration_mode"
793
HV_USE_LOCALTIME = "use_localtime"
794
HV_DISK_CACHE = "disk_cache"
795
796
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
797
HV_KVM_FLAG = "kvm_flag"
798
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
799
HV_KVM_USE_CHROOT = "use_chroot"
800
HV_CPU_MASK = "cpu_mask"
801
HV_MEM_PATH = "mem_path"
Jack's avatar
Jack committed
802
HV_PASSTHROUGH = "pci_pass"
803
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
804
HV_REBOOT_BEHAVIOR = "reboot_behavior"
805
HV_CPU_TYPE = "cpu_type"
806
807
808
HV_CPU_CAP = "cpu_cap"
HV_CPU_WEIGHT = "cpu_weight"

809

810
811
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
812
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
813
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
814
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
815
816
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
817
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
818
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
819
820
821
822
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
  HV_VNC_TLS: VTYPE_BOOL,
  HV_VNC_X509: VTYPE_STRING,
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
823
824
  HV_KVM_SPICE_BIND: VTYPE_STRING,
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
825
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
826
827
828
829
830
  HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
  HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
  HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
  HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
  HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
831
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
832
833
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
834
835
  HV_ACPI: VTYPE_BOOL,
  HV_PAE: VTYPE_BOOL,
836
837
838
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
839
  HV_KERNEL_PATH: VTYPE_STRING,
840
  HV_KERNEL_ARGS: VTYPE_STRING,
841
  HV_INITRD_PATH: VTYPE_STRING,
842
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
843
844
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
845
  HV_KEYMAP: VTYPE_STRING,
846
  HV_DEVICE_MODEL: VTYPE_STRING,
847
  HV_INIT_SCRIPT: VTYPE_STRING,
848
  HV_MIGRATION_PORT: VTYPE_INT,
849
850
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
851
  HV_MIGRATION_MODE: VTYPE_STRING,
852
  HV_USE_LOCALTIME: VTYPE_BOOL,
853
  HV_DISK_CACHE: VTYPE_STRING,
854
855
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
856
  HV_KVM_FLAG: VTYPE_STRING,
857
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
858
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
859
  HV_CPU_MASK: VTYPE_STRING,
860
  HV_MEM_PATH: VTYPE_STRING,
Jack's avatar
Jack committed
861
  HV_PASSTHROUGH: VTYPE_STRING,
862
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
863
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
864
  HV_CPU_TYPE: VTYPE_STRING,
865
866
  HV_CPU_CAP: VTYPE_INT,
  HV_CPU_WEIGHT: VTYPE_INT,
867
868
869
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
870

871
872
873
874
875
876
877
878
879
880
881
882
883
884
HVS_PARAMETER_TITLES = {
  HV_ACPI: "ACPI",
  HV_BOOT_ORDER: "Boot_order",
  HV_CDROM_IMAGE_PATH: "CDROM_image_path",
  HV_DISK_TYPE: "Disk_type",
  HV_INITRD_PATH: "Initrd_path",
  HV_KERNEL_PATH: "Kernel_path",
  HV_NIC_TYPE: "NIC_type",
  HV_PAE: "PAE",
  HV_VNC_BIND_ADDRESS: "VNC_bind_address",
  HV_PASSTHROUGH: "pci_pass",
  HV_CPU_TYPE: "cpu_type",
  }

885
886
887
888
889
890
# Migration statuses
HV_MIGRATION_COMPLETED = "completed"
HV_MIGRATION_ACTIVE = "active"
HV_MIGRATION_FAILED = "failed"
HV_MIGRATION_CANCELLED = "cancelled"

891
HV_MIGRATION_VALID_STATUSES = compat.UniqueFrozenset([
892
893
894
895
896
897
  HV_MIGRATION_COMPLETED,
  HV_MIGRATION_ACTIVE,
  HV_MIGRATION_FAILED,
  HV_MIGRATION_CANCELLED,
  ])

898
HV_MIGRATION_FAILED_STATUSES = compat.UniqueFrozenset([
899
900
901
902
903
904
905
  HV_MIGRATION_FAILED,
  HV_MIGRATION_CANCELLED,
  ])

# KVM-specific statuses
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES

906
907
908
# Node info keys
HV_NODEINFO_KEY_VERSION = "hv_version"

909
910
911
912
913
914
915
# Hypervisor state
HVST_MEMORY_TOTAL = "mem_total"
HVST_MEMORY_NODE = "mem_node"
HVST_MEMORY_HV = "mem_hv"
HVST_CPU_TOTAL = "cpu_total"
HVST_CPU_NODE = "cpu_node"

916
917
918
919
920
921
922
923
HVST_DEFAULTS = {
  HVST_MEMORY_TOTAL: 0,
  HVST_MEMORY_NODE: 0,
  HVST_MEMORY_HV: 0,
  HVST_CPU_TOTAL: 1,
  HVST_CPU_NODE: 1,
  }

924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
HVSTS_PARAMETER_TYPES = {
  HVST_MEMORY_TOTAL: VTYPE_INT,
  HVST_MEMORY_NODE: VTYPE_INT,
  HVST_MEMORY_HV: VTYPE_INT,
  HVST_CPU_TOTAL: VTYPE_INT,
  HVST_CPU_NODE: VTYPE_INT,
  }

HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())

# Disk state
DS_DISK_TOTAL = "disk_total"
DS_DISK_RESERVED = "disk_reserved"
DS_DISK_OVERHEAD = "disk_overhead"

939
940
941
942
943
944
DS_DEFAULTS = {
  DS_DISK_TOTAL: 0,
  DS_DISK_RESERVED: 0,
  DS_DISK_OVERHEAD: 0,
  }

945
946
947
948
949
950
951
DSS_PARAMETER_TYPES = {
  DS_DISK_TOTAL: VTYPE_INT,
  DS_DISK_RESERVED: VTYPE_INT,
  DS_DISK_OVERHEAD: VTYPE_INT,
  }

DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
952
DS_VALID_TYPES = compat.UniqueFrozenset([LD_LV])
953

954
# Backend parameter names
955
956
957
BE_MEMORY = "memory" # deprecated and replaced by max and min mem
BE_MAXMEM = "maxmem"
BE_MINMEM = "minmem"
958
BE_VCPUS = "vcpus"
959
BE_AUTO_BALANCE = "auto_balance"
960
BE_ALWAYS_FAILOVER = "always_failover"
961
BE_SPINDLE_USE = "spindle_use"
962

963
BES_PARAMETER_TYPES = {
964
965
966
967
  BE_MAXMEM: VTYPE_SIZE,
  BE_MINMEM: VTYPE_SIZE,
  BE_VCPUS: VTYPE_INT,
  BE_AUTO_BALANCE: VTYPE_BOOL,
968
  BE_ALWAYS_FAILOVER: VTYPE_BOOL,
969
  BE_SPINDLE_USE: VTYPE_INT,
970
  }
971

972
973
974
975
976
977
978
BES_PARAMETER_TITLES = {
  BE_AUTO_BALANCE: "Auto_balance",
  BE_MAXMEM: "ConfigMaxMem",
  BE_MINMEM: "ConfigMinMem",
  BE_VCPUS: "ConfigVCPUs",
  }

979
980
981
982
983
BES_PARAMETER_COMPAT = {
  BE_MEMORY: VTYPE_SIZE,
  }
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)

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

986
# instance specs
987
988
989
990
991
ISPEC_MEM_SIZE = "memory-size"
ISPEC_CPU_COUNT = "cpu-count"
ISPEC_DISK_COUNT = "disk-count"
ISPEC_DISK_SIZE = "disk-size"