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

Iustin Pop's avatar
Iustin Pop committed
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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
109
110
MOND_USER = _autoconf.MOND_USER
MOND_GROUP = _autoconf.MOND_GROUP
Michael Hanselmann's avatar
Michael Hanselmann committed
111
112
SSH_LOGIN_USER = _autoconf.SSH_LOGIN_USER
SSH_CONSOLE_USER = _autoconf.SSH_CONSOLE_USER
113

Tsachy Shacham's avatar
Tsachy Shacham committed
114
115
116
117
118
# cpu pinning separators and constants
CPU_PINNING_SEP = ":"
CPU_PINNING_ALL = "all"
# internal representation of "all"
CPU_PINNING_ALL_VAL = -1
119
120
# 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
121
122
123
124
125
126
127
128
129

# 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"
130

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

137
# Wipe
138
DD_CMD = "dd"
139
140
141
MAX_WIPE_CHUNK = 1024 # 1GB
MIN_WIPE_CHUNK_PERCENT = 10

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

152
153
154
155
# SSH constants
SSH = "ssh"
SCP = "scp"

156
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
157
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
158
RAPI = "ganeti-rapi"
159
MASTERD = "ganeti-masterd"
160
MOND = "ganeti-mond"
161

162
163
164
165
166
DAEMONS = compat.UniqueFrozenset([
  NODED,
  CONFD,
  RAPI,
  MASTERD,
167
  MOND,
168
169
  ])

170
171
172
DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
173
  CONFD: ("udp", 1814),
174
  MOND: ("tcp", 1815),
Guido Trotter's avatar
Guido Trotter committed
175
  RAPI: ("tcp", 5080),
176
  SSH: ("tcp", 22),
177
}
178

179
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
180
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
181
DEFAULT_MOND_PORT = DAEMONS_PORTS[MOND][1]
Guido Trotter's avatar
Guido Trotter committed
182
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
183

Iustin Pop's avatar
Iustin Pop committed
184
185
186
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999

187
188
189
190
191
DAEMONS_LOGBASE = {
  NODED: "node-daemon",
  CONFD: "conf-daemon",
  RAPI: "rapi-daemon",
  MASTERD: "master-daemon",
192
  MOND: "monitoring-daemon",
193
194
  }

195
196
197
198
DAEMONS_LOGFILES = \
    dict((daemon, pathutils.GetLogFilename(DAEMONS_LOGBASE[daemon]))
         for daemon in DAEMONS_LOGBASE)

199
# Some daemons might require more than one logfile.
200
201
# Specifically, right now only the Haskell http library "snap", used by the
# monitoring daemon, requires multiple log files.
202
203
204
205
206
207
208
209
210
211
212

# These are the only valid reasons for having an extra logfile
EXTRA_LOGREASON_ACCESS = "access"
EXTRA_LOGREASON_ERROR = "error"

VALID_EXTRA_LOGREASONS = compat.UniqueFrozenset([
  EXTRA_LOGREASON_ACCESS,
  EXTRA_LOGREASON_ERROR,
  ])

# These are the extra logfiles, grouped by daemon
213
214
215
216
217
218
DAEMONS_EXTRA_LOGBASE = {
  MOND: {
    EXTRA_LOGREASON_ACCESS: "monitoring-daemon-access",
    EXTRA_LOGREASON_ERROR: "monitoring-daemon-error",
    }
  }
219
220
221
222
223
224
225

DAEMONS_EXTRA_LOGFILES = \
  dict((daemon, dict((extra,
       pathutils.GetLogFilename(DAEMONS_EXTRA_LOGBASE[daemon][extra]))
       for extra in DAEMONS_EXTRA_LOGBASE[daemon]))
         for daemon in DAEMONS_EXTRA_LOGBASE)

Luca Bigliardi's avatar
Luca Bigliardi committed
226
227
DEV_CONSOLE = "/dev/console"

Balazs Lecz's avatar
Balazs Lecz committed
228
229
PROC_MOUNTS = "/proc/mounts"

230
# Local UniX Interface related constants
231
LUXI_EOM = "\3"
232
LUXI_VERSION = CONFIG_VERSION
233
234
235
236
#: Environment variable for the luxi override socket
LUXI_OVERRIDE = "FORCE_LUXI_SOCKET"
LUXI_OVERRIDE_MASTER = "master"
LUXI_OVERRIDE_QUERY = "query"
237

Iustin Pop's avatar
Iustin Pop committed
238
# one of "no", "yes", "only"
239
240
241
242
243
244
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
245
246
EXPORT_CONF_FILE = "config.ini"

247
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
248
249
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD
250
251
252
253
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
254
255
256
257
258
259

KNOWN_XEN_COMMANDS = compat.UniqueFrozenset([
  XEN_CMD_XM,
  XEN_CMD_XL,
  ])

Guido Trotter's avatar
Guido Trotter committed
260
261
262
263
264
# 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.
265
XL_SSH_CMD = ("ssh -l %s -oGlobalKnownHostsFile=%s"
Guido Trotter's avatar
Guido Trotter committed
266
267
              " -oUserKnownHostsFile=/dev/null"
              " -oCheckHostIp=no -oStrictHostKeyChecking=yes"
268
269
              " -oHostKeyAlias=%%s") % (SSH_LOGIN_USER,
                                        pathutils.SSH_KNOWN_HOSTS_FILE)
270

271
KVM_PATH = _autoconf.KVM_PATH
272
KVM_KERNEL = _autoconf.KVM_KERNEL
Guido Trotter's avatar
Guido Trotter committed
273
SOCAT_PATH = _autoconf.SOCAT_PATH
274
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
275
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
276
SOCAT_ESCAPE_CODE = "0x1d"
277

278
279
280
281
282
283
#: Console as SSH command
CONS_SSH = "ssh"

#: Console as VNC server
CONS_VNC = "vnc"

284
285
286
#: Console as SPICE server
CONS_SPICE = "spice"

287
288
289
290
#: Display a message for console access
CONS_MESSAGE = "msg"

#: All console types
291
292
293
294
295
296
CONS_ALL = compat.UniqueFrozenset([
  CONS_SSH,
  CONS_VNC,
  CONS_SPICE,
  CONS_MESSAGE,
  ])
297

298
299
300
301
302
# 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

303
304
305
# 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
306
# modifying the ciphers, ensure not to accidentially add something after it's
307
308
309
310
# 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"

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

314
315
316
317
318
319
# Default validity of certificates in days
X509_CERT_DEFAULT_VALIDITY = 365 * 5

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

320
321
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

322
323
324
325
# Import/export daemon mode
IEM_IMPORT = "import"
IEM_EXPORT = "export"

326
327
328
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
329
IEC_ALL = compat.UniqueFrozenset([
330
331
332
333
  IEC_NONE,
  IEC_GZIP,
  ])

334
335
IE_CUSTOM_SIZE = "fd"

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

338
339
340
341
342
343
344
345
# 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"

346
VALUE_DEFAULT = "default"
347
348
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
349
VALUE_NONE = "none"
350
351
VALUE_TRUE = "true"
VALUE_FALSE = "false"
352

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

Iustin Pop's avatar
Iustin Pop committed
356
357
358
# hooks-related constants
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
359
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
360
HOOKS_NAME_WATCHER = "watcher"
361
HOOKS_VERSION = 2
362
HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
Iustin Pop's avatar
Iustin Pop committed
363
364
365
366

# hooks subject type (what object type does the LU deal with)
HTYPE_CLUSTER = "CLUSTER"
HTYPE_NODE = "NODE"
367
HTYPE_GROUP = "GROUP"
Iustin Pop's avatar
Iustin Pop committed
368
HTYPE_INSTANCE = "INSTANCE"
369
HTYPE_NETWORK = "NETWORK"
Iustin Pop's avatar
Iustin Pop committed
370
371
372
373
374

HKR_SKIP = 0
HKR_FAIL = 1
HKR_SUCCESS = 2

375
# Storage types
376
377
378
ST_BLOCK = "blockdev"
ST_DISKLESS = "diskless"
ST_EXT = "ext"
379
380
381
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
382
ST_RADOS = "rados"
383
ST_SHARED_FILE = "sharedfile"
384
385

VALID_STORAGE_TYPES = compat.UniqueFrozenset([
386
387
388
  ST_BLOCK,
  ST_DISKLESS,
  ST_EXT,
389
390
391
392
  ST_FILE,
  ST_LVM_PV,
  ST_LVM_VG,
  ST_RADOS,
393
  ST_SHARED_FILE,
394
395
  ])

396
# Storage fields
397
398
399
400
# 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
401
402
403
404
405
406
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

407
408
409
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

410
# Available fields per storage type
411
VALID_STORAGE_FIELDS = compat.UniqueFrozenset([
Stephen Shirley's avatar
Stephen Shirley committed
412
413
414
415
416
  SF_NAME,
  SF_TYPE,
  SF_SIZE,
  SF_USED,
  SF_FREE,
417
  SF_ALLOCATABLE,
Stephen Shirley's avatar
Stephen Shirley committed
418
  ])
419

420
421
422
423
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

424
VALID_STORAGE_OPERATIONS = {
425
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
426
427
  }

428
429
430
431
432
433
# 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
434
# disk template types
435
DT_BLOCK = "blockdev"
Iustin Pop's avatar
Iustin Pop committed
436
DT_DISKLESS = "diskless"
437
DT_DRBD8 = "drbd"
438
DT_EXT = "ext"
439
DT_FILE = "file"
440
DT_PLAIN = "plain"
441
DT_RBD = "rbd"
442
443
DT_SHARED_FILE = "sharedfile"

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
# This is used to order determine the default disk template when the list
# of enabled disk templates is inferred from the current state of the cluster.
# This only happens on an upgrade from a version of Ganeti that did not
# support the 'enabled_disk_templates' so far.
DISK_TEMPLATE_PREFERENCE = [
  DT_DRBD8,
  DT_PLAIN,
  DT_FILE,
  DT_SHARED_FILE,
  DT_RBD,
  DT_BLOCK,
  DT_DISKLESS,
  DT_EXT
  ]

DISK_TEMPLATES = compat.UniqueFrozenset([
  DT_DISKLESS,
  DT_PLAIN,
  DT_DRBD8,
  DT_FILE,
  DT_SHARED_FILE,
  DT_BLOCK,
  DT_RBD,
  DT_EXT
  ])

# disk templates that are enabled by default
DEFAULT_ENABLED_DISK_TEMPLATES = compat.UniqueFrozenset([
  DT_DRBD8,
  DT_PLAIN,
  ])

476
477
478
479
480
481
482
483
484
485
486
# mapping of disk templates to storage types
DISK_TEMPLATES_STORAGE_TYPE = {
  DT_BLOCK: ST_BLOCK,
  DT_DISKLESS: ST_DISKLESS,
  DT_DRBD8: ST_LVM_VG,
  DT_EXT: ST_EXT,
  DT_FILE: ST_FILE,
  DT_PLAIN: ST_LVM_VG,
  DT_RBD: ST_RADOS,
  DT_SHARED_FILE: ST_SHARED_FILE,
  }
487
488

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

491
# the set of externally-mirrored disk templates (e.g. SAN, NAS)
492
DTS_EXT_MIRROR = compat.UniqueFrozenset([
493
  DT_DISKLESS, # 'trivially' externally mirrored
494
495
496
  DT_SHARED_FILE,
  DT_BLOCK,
  DT_RBD,
497
  DT_EXT,
498
  ])
499

500
# the set of non-lvm-based disk templates
501
502
503
504
505
506
DTS_NOT_LVM = compat.UniqueFrozenset([
  DT_DISKLESS,
  DT_FILE,
  DT_SHARED_FILE,
  DT_BLOCK,
  DT_RBD,
507
  DT_EXT,
508
  ])
509

510
# the set of disk templates which can be grown
511
512
513
514
515
516
DTS_GROWABLE = compat.UniqueFrozenset([
  DT_PLAIN,
  DT_DRBD8,
  DT_FILE,
  DT_SHARED_FILE,
  DT_RBD,
517
  DT_EXT,
518
  ])
519

520
# the set of disk templates that allow adoption
521
522
523
524
DTS_MAY_ADOPT = compat.UniqueFrozenset([
  DT_PLAIN,
  DT_BLOCK,
  ])
525
526

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

529
# the set of disk templates that allow migrations
530
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
531

Guido Trotter's avatar
Guido Trotter committed
532
# the set of file based disk templates
533
534
535
536
DTS_FILEBASED = compat.UniqueFrozenset([
  DT_FILE,
  DT_SHARED_FILE,
  ])
537

538
# the set of disk templates that are supported by exclusive_storage
539
DTS_EXCL_STORAGE = compat.UniqueFrozenset([DT_PLAIN])
540
541

# templates for which we don't perform checks on free space
542
543
544
545
546
547
DTS_NO_FREE_SPACE_CHECK = compat.UniqueFrozenset([
  DT_FILE,
  DT_SHARED_FILE,
  DT_RBD,
  DT_EXT,
  ])
548

549
550
# logical disk types
LD_LV = "lvm"
551
LD_DRBD8 = "drbd8"
552
LD_FILE = "file"
553
LD_BLOCKDEV = "blockdev"
554
LD_RBD = "rbd"
555
LD_EXT = "ext"
556
LOGICAL_DISK_TYPES = compat.UniqueFrozenset([
557
558
559
560
  LD_LV,
  LD_DRBD8,
  LD_FILE,
  LD_BLOCKDEV,
561
  LD_RBD,
562
  LD_EXT,
563
564
  ])

565
566
567
568
569
LDS_BLOCK = compat.UniqueFrozenset([
  LD_LV,
  LD_DRBD8,
  LD_BLOCKDEV,
  LD_RBD,
570
  LD_EXT,
571
  ])
572

Iustin Pop's avatar
Iustin Pop committed
573
574
# drbd constants
DRBD_HMAC_ALG = "md5"
575
DRBD_NET_PROTOCOL = "C"
576
DRBD_STATUS_FILE = "/proc/drbd"
577

578
579
580
#: Size of DRBD meta block device
DRBD_META_SIZE = 128

581
582
583
584
585
586
587
# 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"
588
DRBD_VALID_BARRIER_OPT = compat.UniqueFrozenset([
589
590
591
592
593
594
595
596
597
  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
598

599
600
601
# rbd tool command
RBD_CMD = "rbd"

602
603
604
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
605
606

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

609
# disk access mode
610
611
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
612
DISK_ACCESS_SET = compat.UniqueFrozenset([DISK_RDONLY, DISK_RDWR])
613

614
# disk replacement mode
615
616
617
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
618
REPLACE_DISK_AUTO = "replace_auto"
619
REPLACE_MODES = compat.UniqueFrozenset([
620
621
622
623
624
  REPLACE_DISK_PRI,
  REPLACE_DISK_SEC,
  REPLACE_DISK_CHG,
  REPLACE_DISK_AUTO,
  ])
625

626
627
628
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
629
EXPORT_MODES = compat.UniqueFrozenset([
630
631
632
633
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

634
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
635
636
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
637
INSTANCE_REMOTE_IMPORT = "remote-import"
638
INSTANCE_CREATE_MODES = compat.UniqueFrozenset([
639
640
641
642
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
643

644
645
646
647
648
649
650
# 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

651
# Overall timeout for establishing connection
652
RIE_CONNECT_TIMEOUT = 180
653

654
655
656
657
658
659
# 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
660
661
#: Give child process up to 5 seconds to exit after sending a signal
CHILD_LINGER_TIMEOUT = 5.0
662

663
FILE_DRIVER = compat.UniqueFrozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
664
665
666
667

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
668
669
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
670
INISECT_OSP = "os"
671

672
# dynamic device modification
673
DDM_ADD = "add"
674
DDM_MODIFY = "modify"
675
DDM_REMOVE = "remove"
676
DDMS_VALUES = compat.UniqueFrozenset([DDM_ADD, DDM_REMOVE])
677
678
679
680
DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
  DDM_MODIFY,
  ]))
# TODO: DDM_SWAP, DDM_MOVE?
681

682
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
683
EXIT_SUCCESS = 0
684
EXIT_FAILURE = 1
685
EXIT_NOTCLUSTER = 5
686
EXIT_NOTMASTER = 11
687
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
688
EXIT_CONFIRMATION = 13 # need user confirmation
689

690
691
692
#: Exit code for query operations with unknown fields
EXIT_UNKNOWN_FIELD = 14

693
694
# tags
TAG_CLUSTER = "cluster"
695
TAG_NODEGROUP = "nodegroup"
696
697
TAG_NODE = "node"
TAG_INSTANCE = "instance"
698
TAG_NETWORK = "network"
699
VALID_TAG_TYPES = compat.UniqueFrozenset([
700
  TAG_CLUSTER,
701
  TAG_NODEGROUP,
702
703
  TAG_NODE,
  TAG_INSTANCE,
704
  TAG_NETWORK,
705
  ])
706
707
708
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

709
710
# others
DEFAULT_BRIDGE = "xen-br0"
711
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
712
713
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
IP4_ADDRESS_ANY = "0.0.0.0"
Manuel Franceschini's avatar
Manuel Franceschini committed
714
715
IP6_ADDRESS_LOCALHOST = "::1"
IP6_ADDRESS_ANY = "::"
716
717
IP4_VERSION = 4
IP6_VERSION = 6
718
VALID_IP_VERSIONS = compat.UniqueFrozenset([IP4_VERSION, IP6_VERSION])
719
720
721
722
# for export to htools
IP4_FAMILY = socket.AF_INET
IP6_FAMILY = socket.AF_INET6

723
TCP_PING_TIMEOUT = 10
724
DEFAULT_VG = "xenvg"
725
DEFAULT_DRBD_HELPER = "/bin/true"
726
MIN_VG_SIZE = 20480
727
DEFAULT_MAC_PREFIX = "aa:00:00"
728
729
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
730
NODE_MAX_CLOCK_SKEW = 150
731
# Time for an intra-cluster disk transfer to wait for a connection
732
DISK_TRANSFER_CONNECT_TIMEOUT = 60
733
734
# Disk index separator
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
735
IP_COMMAND_PATH = _autoconf.IP_PATH
736

737
738
739
#: Key for job IDs in opcode result
JOB_IDS_KEY = "jobs"

740
741
742
743
744
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

745
746
747
748
749
RUNPARTS_STATUS = compat.UniqueFrozenset([
  RUNPARTS_SKIP,
  RUNPARTS_RUN,
  RUNPARTS_ERR,
  ])
750

751
752
753
754
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

755
756
757
758
759
760
761
762
763
764
765
# 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

766
# os related constants
Iustin Pop's avatar
Iustin Pop committed
767
768
769
770
771
OS_SCRIPT_CREATE = "create"
OS_SCRIPT_IMPORT = "import"
OS_SCRIPT_EXPORT = "export"
OS_SCRIPT_RENAME = "rename"
OS_SCRIPT_VERIFY = "verify"
772
OS_SCRIPTS = compat.UniqueFrozenset([
Stephen Shirley's avatar
Stephen Shirley committed
773
774
775
776
  OS_SCRIPT_CREATE,
  OS_SCRIPT_IMPORT,
  OS_SCRIPT_EXPORT,
  OS_SCRIPT_RENAME,
777
  OS_SCRIPT_VERIFY,
Stephen Shirley's avatar
Stephen Shirley committed
778
  ])
779

Iustin Pop's avatar
Iustin Pop committed
780
781
782
OS_API_FILE = "ganeti_api_version"
OS_VARIANTS_FILE = "variants.list"
OS_PARAMETERS_FILE = "parameters.list"
783

Iustin Pop's avatar
Iustin Pop committed
784
OS_VALIDATE_PARAMETERS = "parameters"
785
OS_VALIDATE_CALLS = compat.UniqueFrozenset([OS_VALIDATE_PARAMETERS])
786

787
788
789
790
791
792
793
# 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"
794
ES_ACTION_VERIFY = "verify"
795
796
797
798
799
800
801

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
802
ES_SCRIPT_VERIFY = ES_ACTION_VERIFY
803
804
805
806
807
808
ES_SCRIPTS = frozenset([
  ES_SCRIPT_CREATE,
  ES_SCRIPT_REMOVE,
  ES_SCRIPT_GROW,
  ES_SCRIPT_ATTACH,
  ES_SCRIPT_DETACH,
809
810
  ES_SCRIPT_SETINFO,
  ES_SCRIPT_VERIFY
811
812
  ])

813
814
ES_PARAMETERS_FILE = "parameters.list"

815
816
817
818
# reboot types
INSTANCE_REBOOT_SOFT = "soft"
INSTANCE_REBOOT_HARD = "hard"
INSTANCE_REBOOT_FULL = "full"
819

820
REBOOT_TYPES = compat.UniqueFrozenset([
821
822
  INSTANCE_REBOOT_SOFT,
  INSTANCE_REBOOT_HARD,
823
  INSTANCE_REBOOT_FULL,
824
825
826
827
828
829
  ])

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

830
REBOOT_BEHAVIORS = compat.UniqueFrozenset([
831
  INSTANCE_REBOOT_ALLOWED,
832
  INSTANCE_REBOOT_EXIT,
833
  ])
834

Iustin Pop's avatar
Iustin Pop committed
835
VTYPE_STRING = "string"
836
VTYPE_MAYBE_STRING = "maybe-string"
Iustin Pop's avatar
Iustin Pop committed
837
838
839
VTYPE_BOOL = "bool"
VTYPE_SIZE = "size" # size, in MiBs
VTYPE_INT = "int"
840
ENFORCEABLE_TYPES = compat.UniqueFrozenset([
Stephen Shirley's avatar
Stephen Shirley committed
841
842
843
844
845
846
  VTYPE_STRING,
  VTYPE_MAYBE_STRING,
  VTYPE_BOOL,
  VTYPE_SIZE,
  VTYPE_INT,
  ])
847

848
849
850
# Constant representing that the user does not specify any IP version
IFACE_NO_IP_VERSION_SPECIFIED = 0

Guido Trotter's avatar
Guido Trotter committed
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
VALID_SERIAL_SPEEDS = compat.UniqueFrozenset([
  75,
  110,
  300,
  600,
  1200,
  1800,
  2400,
  4800,
  9600,
  14400,
  19200,
  28800,
  38400,
  57600,
  115200,
  230400,
  345600,
  460800,
  ])

872
873
874
# HV parameter names (global namespace)
HV_BOOT_ORDER = "boot_order"
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
875
876
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
877
878
HV_NIC_TYPE = "nic_type"
HV_DISK_TYPE = "disk_type"
879
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
880
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
881
HV_VNC_PASSWORD_FILE = "vnc_password_file"
882
883
884
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
885
886
HV_KVM_SPICE_BIND = "spice_bind"
HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
887
HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
888
889
890
891
892
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"
893
HV_KVM_SPICE_USE_TLS = "spice_use_tls"
894
895
HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
896
897
HV_ACPI = "acpi"
HV_PAE = "pae"
898
899
900
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
901
HV_KERNEL_ARGS = "kernel_args"
902
903
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
904
HV_ROOT_PATH = "root_path"
905
HV_SERIAL_CONSOLE = "serial_console"
Guido Trotter's avatar
Guido Trotter committed
906
HV_SERIAL_SPEED = "serial_speed"
907
HV_USB_MOUSE = "usb_mouse"
908
HV_KEYMAP = "keymap"
909
HV_DEVICE_MODEL = "device_model"
910
HV_INIT_SCRIPT = "init_script"
911
HV_MIGRATION_PORT = "migration_port"
912
913
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
914
HV_MIGRATION_MODE = "migration_mode"
915
HV_USE_LOCALTIME = "use_localtime"
916
HV_DISK_CACHE = "disk_cache"
917
918
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
919
HV_KVM_FLAG = "kvm_flag"
920
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
921
HV_KVM_USE_CHROOT = "use_chroot"
922
HV_CPU_MASK = "cpu_mask"
923
HV_MEM_PATH = "mem_path"
Jack's avatar
Jack committed
924
HV_PASSTHROUGH = "pci_pass"
925
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
926
HV_REBOOT_BEHAVIOR = "reboot_behavior"
927
HV_CPU_TYPE = "cpu_type"
928
929
HV_CPU_CAP = "cpu_cap"
HV_CPU_WEIGHT = "cpu_weight"
930
931
932
HV_CPU_CORES = "cpu_cores"
HV_CPU_THREADS = "cpu_threads"
HV_CPU_SOCKETS = "cpu_sockets"
Guido Trotter's avatar
Guido Trotter committed
933
HV_SOUNDHW = "soundhw"
Guido Trotter's avatar
Guido Trotter committed
934
HV_USB_DEVICES = "usb_devices"
Guido Trotter's avatar
Guido Trotter committed
935
HV_VGA = "vga"
Guido Trotter's avatar
Guido Trotter committed
936
HV_KVM_EXTRA = "kvm_extra"
937
HV_KVM_MACHINE_VERSION = "machine_version"
938
HV_KVM_PATH = "kvm_path"
939

940

941
HVS_PARAMETER_TYPES = {
942
  HV_KVM_PATH: VTYPE_STRING,
943
  HV_BOOT_ORDER: VTYPE_STRING,
944
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
945
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
946
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
947
948
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
949
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
950
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
951
952
953
954
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
  HV_VNC_TLS: VTYPE_BOOL,
  HV_VNC_X509: VTYPE_STRING,
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
955
956
  HV_KVM_SPICE_BIND: VTYPE_STRING,
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
957
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
958
959
960
961
962
  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,
963
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
964
965
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
966
967
  HV_ACPI: VTYPE_BOOL,
  HV_PAE: VTYPE_BOOL,
968
969
970
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
971
  HV_KERNEL_PATH: VTYPE_STRING,
972
  HV_KERNEL_ARGS: VTYPE_STRING,
973
  HV_INITRD_PATH: VTYPE_STRING,
974
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
975
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
Guido Trotter's avatar
Guido Trotter committed
976
  HV_SERIAL_SPEED: VTYPE_INT,
977
  HV_USB_MOUSE: VTYPE_STRING,
978
  HV_KEYMAP: VTYPE_STRING,
979
  HV_DEVICE_MODEL: VTYPE_STRING,
980
  HV_INIT_SCRIPT: VTYPE_STRING,
981
  HV_MIGRATION_PORT: VTYPE_INT,
982
983
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
984
  HV_MIGRATION_MODE: VTYPE_STRING,
985
  HV_USE_LOCALTIME: VTYPE_BOOL,
986
  HV_DISK_CACHE: VTYPE_STRING,
987
988
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
989
  HV_KVM_FLAG: VTYPE_STRING,
990
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
991
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
992
  HV_CPU_MASK: VTYPE_STRING,
993
  HV_MEM_PATH: VTYPE_STRING,
Jack's avatar
Jack committed
994
  HV_PASSTHROUGH: VTYPE_STRING,
995
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
996
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
997
  HV_CPU_TYPE: VTYPE_STRING,
998
999
  HV_CPU_CAP: VTYPE_INT,
  HV_CPU_WEIGHT: VTYPE_INT,
1000
1001
1002
  HV_CPU_CORES: VTYPE_INT,
  HV_CPU_THREADS: VTYPE_INT,
  HV_CPU_SOCKETS: VTYPE_INT,
Guido Trotter's avatar
Guido Trotter committed
1003
  HV_SOUNDHW: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
1004
  HV_USB_DEVICES: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
1005
  HV_VGA: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
1006
  HV_KVM_EXTRA: VTYPE_STRING,
1007
  HV_KVM_MACHINE_VERSION: VTYPE_STRING,
1008
1009
1010
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
1011

1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
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",