Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ c07f38e1

History | View | Annotate | Download (57.2 kB)

1
#
2
#
3

    
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc.
5
#
6
# This program is free software; you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation; either version 2 of the License, or
9
# (at your option) any later version.
10
#
11
# This program is distributed in the hope that it will be useful, but
12
# WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
# General Public License for more details.
15
#
16
# You should have received a copy of the GNU General Public License
17
# along with this program; if not, write to the Free Software
18
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19
# 02110-1301, USA.
20

    
21

    
22
"""Module holding different constants."""
23

    
24
import re
25
import socket
26

    
27
from ganeti import _autoconf
28
from ganeti import _vcsversion
29

    
30
# various versions
31
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
32
OS_API_V10 = 10
33
OS_API_V15 = 15
34
OS_API_V20 = 20
35
OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
36
VCS_VERSION = _vcsversion.VCS_VERSION
37
EXPORT_VERSION = 0
38
RAPI_VERSION = 2
39

    
40

    
41
# Format for CONFIG_VERSION:
42
#   01 03 0123 = 01030123
43
#   ^^ ^^ ^^^^
44
#   |  |  + Configuration version/revision
45
#   |  + Minor version
46
#   + Major version
47
#
48
# It stored as an integer. Make sure not to write an octal number.
49

    
50
# BuildVersion and SplitVersion must be in here because we can't import other
51
# modules. The cfgupgrade tool must be able to read and write version numbers
52
# and thus requires these functions. To avoid code duplication, they're kept in
53
# here.
54

    
55
def BuildVersion(major, minor, revision):
56
  """Calculates int version number from major, minor and revision numbers.
57

58
  Returns: int representing version number
59

60
  """
61
  assert isinstance(major, int)
62
  assert isinstance(minor, int)
63
  assert isinstance(revision, int)
64
  return (1000000 * major +
65
            10000 * minor +
66
                1 * revision)
67

    
68

    
69
def SplitVersion(version):
70
  """Splits version number stored in an int.
71

72
  Returns: tuple; (major, minor, revision)
73

74
  """
75
  assert isinstance(version, int)
76

    
77
  (major, remainder) = divmod(version, 1000000)
78
  (minor, revision) = divmod(remainder, 10000)
79

    
80
  return (major, minor, revision)
81

    
82

    
83
CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
84
CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
85
CONFIG_REVISION = 0
86
CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
87

    
88
#: RPC protocol version
89
PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)
90

    
91
# user separation
92
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
93
ADMIN_GROUP = _autoconf.ADMIN_GROUP
94
MASTERD_USER = _autoconf.MASTERD_USER
95
MASTERD_GROUP = _autoconf.MASTERD_GROUP
96
RAPI_USER = _autoconf.RAPI_USER
97
RAPI_GROUP = _autoconf.RAPI_GROUP
98
CONFD_USER = _autoconf.CONFD_USER
99
CONFD_GROUP = _autoconf.CONFD_GROUP
100
NODED_USER = _autoconf.NODED_USER
101
NODED_GROUP = _autoconf.NODED_GROUP
102

    
103
# cpu pinning separators and constants
104
CPU_PINNING_SEP = ":"
105
CPU_PINNING_ALL = "all"
106
# internal representation of "all"
107
CPU_PINNING_ALL_VAL = -1
108
# one "all" entry in a CPU list means CPU pinning is off
109
CPU_PINNING_OFF = [CPU_PINNING_ALL_VAL]
110

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

    
120
# A KVM-specific implementation detail - the following value is used
121
# to set CPU affinity to all processors (#0 through #31), per taskset
122
# man page.
123
# FIXME: This only works for machines with up to 32 CPU cores
124
CPU_PINNING_ALL_KVM = 0xFFFFFFFF
125

    
126
# Wipe
127
DD_CMD = "dd"
128
WIPE_BLOCK_SIZE = 1024 ** 2
129
MAX_WIPE_CHUNK = 1024 # 1GB
130
MIN_WIPE_CHUNK_PERCENT = 10
131

    
132

    
133
# file paths
134
DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
135
RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
136
RUN_GANETI_DIR = RUN_DIR + "/ganeti"
137
BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
138
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
139
RUN_DIRS_MODE = 0775
140
SOCKET_DIR = RUN_GANETI_DIR + "/socket"
141
SECURE_DIR_MODE = 0700
142
SECURE_FILE_MODE = 0600
143
CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
144
IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
145
ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
146
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
147
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
148
# User-id pool lock directory
149
# The user-ids that are in use have a corresponding lock file in this directory
150
UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
151
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
152
NODED_CERT_FILE = DATA_DIR + "/server.pem"
153
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
154
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
155
SPICE_CERT_FILE = DATA_DIR + "/spice.pem"
156
SPICE_CACERT_FILE = DATA_DIR + "/spice-ca.pem"
157
CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
158
INSTANCE_STATUS_FILE = RUN_GANETI_DIR + "/instance-status"
159
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
160
RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
161
QUEUE_DIR = DATA_DIR + "/queue"
162
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
163
SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
164
KVM_IFUP = _autoconf.PKGLIBDIR + "/kvm-ifup"
165
KVM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/kvm-console-wrapper"
166
XEN_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/xen-console-wrapper"
167
ETC_HOSTS = "/etc/hosts"
168
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
169
DEFAULT_SHARED_FILE_STORAGE_DIR = _autoconf.SHARED_FILE_STORAGE_DIR
170
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
171
ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
172
SYSCONFDIR = _autoconf.SYSCONFDIR
173
TOOLSDIR = _autoconf.TOOLSDIR
174
CONF_DIR = SYSCONFDIR + "/ganeti"
175
USER_SCRIPTS_DIR = CONF_DIR + "/scripts"
176
ENABLE_CONFD = _autoconf.ENABLE_CONFD
177
HS_CONFD = _autoconf.HS_CONFD
178

    
179
#: Lock file for watcher, locked in shared mode by watcher; lock in exclusive
180
# mode to block watcher (see L{cli._RunWhileClusterStoppedHelper.Call}
181
WATCHER_LOCK_FILE = LOCK_DIR + "/ganeti-watcher.lock"
182

    
183
#: Status file for per-group watcher, locked in exclusive mode by watcher
184
WATCHER_GROUP_STATE_FILE = DATA_DIR + "/watcher.%s.data"
185

    
186
#: File for per-group instance status, merged into L{INSTANCE_STATUS_FILE} by
187
#: per-group processes
188
WATCHER_GROUP_INSTANCE_STATUS_FILE = DATA_DIR + "/watcher.%s.instance-status"
189

    
190
#: File containing Unix timestamp until which watcher should be paused
191
WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
192

    
193
# Master IP address setup scripts paths (default and user-provided)
194
DEFAULT_MASTER_SETUP_SCRIPT = TOOLSDIR + "/master-ip-setup"
195
EXTERNAL_MASTER_SETUP_SCRIPT = USER_SCRIPTS_DIR + "/master-ip-setup"
196

    
197
ALL_CERT_FILES = frozenset([
198
  NODED_CERT_FILE,
199
  RAPI_CERT_FILE,
200
  SPICE_CERT_FILE,
201
  SPICE_CACERT_FILE,
202
  ])
203

    
204
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
205

    
206
NODED = "ganeti-noded"
207
CONFD = "ganeti-confd"
208
RAPI = "ganeti-rapi"
209
MASTERD = "ganeti-masterd"
210
# used in the ganeti-nbma project
211
NLD = "ganeti-nld"
212

    
213
DAEMONS_PORTS = {
214
  # daemon-name: ("proto", "default-port")
215
  NODED: ("tcp", 1811),
216
  CONFD: ("udp", 1814),
217
  RAPI: ("tcp", 5080),
218
  "ssh": ("tcp", 22),
219
  # used in the ganeti-nbma project
220
  NLD: ("udp", 1816),
221
}
222
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
223
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
224
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
225
# used in the ganeti-nbma project
226
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
227

    
228
FIRST_DRBD_PORT = 11000
229
LAST_DRBD_PORT = 14999
230

    
231
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
232
DAEMONS_LOGFILES = {
233
  # "daemon-name": "logfile"
234
  NODED: LOG_DIR + "node-daemon.log",
235
  CONFD: LOG_DIR + "conf-daemon.log",
236
  RAPI: LOG_DIR + "rapi-daemon.log",
237
  MASTERD: LOG_DIR + "master-daemon.log",
238
  # used in the ganeti-nbma project
239
  NLD: LOG_DIR + "nl-daemon.log",
240
  }
241

    
242
LOG_OS_DIR = LOG_DIR + "os"
243
LOG_ES_DIR = LOG_DIR + "extstorage"
244
LOG_WATCHER = LOG_DIR + "watcher.log"
245
LOG_COMMANDS = LOG_DIR + "commands.log"
246
LOG_BURNIN = LOG_DIR + "burnin.log"
247
LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
248

    
249
DEV_CONSOLE = "/dev/console"
250

    
251
PROC_MOUNTS = "/proc/mounts"
252

    
253
# Local UniX Interface related constants
254
LUXI_EOM = "\3"
255
LUXI_VERSION = CONFIG_VERSION
256

    
257
# one of "no", "yes", "only"
258
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
259
SYSLOG_NO = "no"
260
SYSLOG_YES = "yes"
261
SYSLOG_ONLY = "only"
262
SYSLOG_SOCKET = "/dev/log"
263

    
264
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
265
ES_SEARCH_PATH = _autoconf.ES_SEARCH_PATH
266
EXPORT_DIR = _autoconf.EXPORT_DIR
267

    
268
EXPORT_CONF_FILE = "config.ini"
269

    
270
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
271
XEN_KERNEL = _autoconf.XEN_KERNEL
272
XEN_INITRD = _autoconf.XEN_INITRD
273
XEN_CMD_XM = "xm"
274
XEN_CMD_XL = "xl"
275
# FIXME: This will be made configurable using hvparams in Ganeti 2.7
276
XEN_CMD = _autoconf.XEN_CMD
277
# When the Xen toolstack used is "xl", live migration requires the source host
278
# to connect to the target host via ssh (xl runs this command). We need to pass
279
# the command xl runs some extra info so that it can use Ganeti's key
280
# verification and not fail. Note that this string is incomplete: it must be
281
# filled with the cluster name before being used.
282
XL_SSH_CMD = ("ssh -l root -oGlobalKnownHostsFile=%s"
283
              " -oUserKnownHostsFile=/dev/null"
284
              " -oCheckHostIp=no -oStrictHostKeyChecking=yes"
285
              " -oHostKeyAlias=%%s") % SSH_KNOWN_HOSTS_FILE
286

    
287
KVM_PATH = _autoconf.KVM_PATH
288
KVM_KERNEL = _autoconf.KVM_KERNEL
289
SOCAT_PATH = _autoconf.SOCAT_PATH
290
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
291
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
292
SOCAT_ESCAPE_CODE = "0x1d"
293

    
294
#: Console as SSH command
295
CONS_SSH = "ssh"
296

    
297
#: Console as VNC server
298
CONS_VNC = "vnc"
299

    
300
#: Console as SPICE server
301
CONS_SPICE = "spice"
302

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

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

    
309
# For RSA keys more bits are better, but they also make operations more
310
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
311
# 2010 on.
312
RSA_KEY_BITS = 2048
313

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

    
322
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
323
X509_CERT_SIGN_DIGEST = "SHA1"
324

    
325
# Default validity of certificates in days
326
X509_CERT_DEFAULT_VALIDITY = 365 * 5
327

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

    
331
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
332

    
333
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
334

    
335
# Import/export daemon mode
336
IEM_IMPORT = "import"
337
IEM_EXPORT = "export"
338

    
339
# Import/export transport compression
340
IEC_NONE = "none"
341
IEC_GZIP = "gzip"
342
IEC_ALL = frozenset([
343
  IEC_NONE,
344
  IEC_GZIP,
345
  ])
346

    
347
IE_CUSTOM_SIZE = "fd"
348

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

    
351
# Import/export I/O
352
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
353
IEIO_FILE = "file"
354
# Raw block device I/O using "dd"
355
IEIO_RAW_DISK = "raw"
356
# OS definition import/export script
357
IEIO_SCRIPT = "script"
358

    
359
VALUE_DEFAULT = "default"
360
VALUE_AUTO = "auto"
361
VALUE_GENERATE = "generate"
362
VALUE_NONE = "none"
363
VALUE_TRUE = "true"
364
VALUE_FALSE = "false"
365

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

    
369
# hooks-related constants
370
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
371
HOOKS_PHASE_PRE = "pre"
372
HOOKS_PHASE_POST = "post"
373
HOOKS_NAME_CFGUPDATE = "config-update"
374
HOOKS_NAME_WATCHER = "watcher"
375
HOOKS_VERSION = 2
376
HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
377

    
378
# hooks subject type (what object type does the LU deal with)
379
HTYPE_CLUSTER = "CLUSTER"
380
HTYPE_NODE = "NODE"
381
HTYPE_GROUP = "GROUP"
382
HTYPE_INSTANCE = "INSTANCE"
383
HTYPE_NETWORK = "NETWORK"
384

    
385
HKR_SKIP = 0
386
HKR_FAIL = 1
387
HKR_SUCCESS = 2
388

    
389
# Storage types
390
ST_FILE = "file"
391
ST_LVM_PV = "lvm-pv"
392
ST_LVM_VG = "lvm-vg"
393

    
394
# Storage fields
395
# first two are valid in LU context only, not passed to backend
396
SF_NODE = "node"
397
SF_TYPE = "type"
398
# and the rest are valid in backend
399
SF_NAME = "name"
400
SF_SIZE = "size"
401
SF_FREE = "free"
402
SF_USED = "used"
403
SF_ALLOCATABLE = "allocatable"
404

    
405
# Storage operations
406
SO_FIX_CONSISTENCY = "fix-consistency"
407

    
408
# Available fields per storage type
409
VALID_STORAGE_FIELDS = frozenset([
410
  SF_NAME,
411
  SF_TYPE,
412
  SF_SIZE,
413
  SF_USED,
414
  SF_FREE,
415
  SF_ALLOCATABLE
416
  ])
417

    
418
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
419

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

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

    
428
# Local disk status
429
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
430
(LDS_OKAY,
431
 LDS_UNKNOWN,
432
 LDS_FAULTY) = range(1, 4)
433

    
434
# disk template types
435
DT_DISKLESS = "diskless"
436
DT_PLAIN = "plain"
437
DT_DRBD8 = "drbd"
438
DT_FILE = "file"
439
DT_SHARED_FILE = "sharedfile"
440
DT_BLOCK = "blockdev"
441
DT_RBD = "rbd"
442
DT_EXT = "ext"
443

    
444
# the set of network-mirrored disk templates
445
DTS_INT_MIRROR = frozenset([DT_DRBD8])
446

    
447
# the set of externally-mirrored disk templates (e.g. SAN, NAS)
448
DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK, DT_RBD, DT_EXT])
449

    
450
# the set of non-lvm-based disk templates
451
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE,
452
                         DT_BLOCK, DT_RBD, DT_EXT])
453

    
454
# the set of disk templates which can be grown
455
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE,
456
                          DT_RBD, DT_EXT])
457

    
458
# the set of disk templates that allow adoption
459
DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])
460

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

    
464
# the set of disk templates that allow migrations
465
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
466

    
467
# the set of file based disk templates
468
DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
469

    
470
# logical disk types
471
LD_LV = "lvm"
472
LD_DRBD8 = "drbd8"
473
LD_FILE = "file"
474
LD_BLOCKDEV = "blockdev"
475
LD_RBD = "rbd"
476
LD_EXT = "ext"
477
LOGICAL_DISK_TYPES = frozenset([
478
  LD_LV,
479
  LD_DRBD8,
480
  LD_FILE,
481
  LD_BLOCKDEV,
482
  LD_RBD,
483
  LD_EXT,
484
  ])
485

    
486
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV, LD_RBD, LD_EXT])
487

    
488
# drbd constants
489
DRBD_HMAC_ALG = "md5"
490
DRBD_NET_PROTOCOL = "C"
491

    
492
# drbd barrier types
493
DRBD_B_NONE = "n"
494
DRBD_B_DISK_BARRIERS = "b"
495
DRBD_B_DISK_DRAIN = "d"
496
DRBD_B_DISK_FLUSH = "f"
497

    
498
# Valid barrier combinations: "n" or any non-null subset of "bfd"
499
DRBD_VALID_BARRIER_OPT = frozenset([
500
  frozenset([DRBD_B_NONE]),
501
  frozenset([DRBD_B_DISK_BARRIERS]),
502
  frozenset([DRBD_B_DISK_DRAIN]),
503
  frozenset([DRBD_B_DISK_FLUSH]),
504
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
505
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
506
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_DRAIN]),
507
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH]),
508
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH, DRBD_B_DISK_DRAIN]),
509
  ])
510

    
511
# rbd tool command
512
RBD_CMD = "rbd"
513

    
514
# file backend driver
515
FD_LOOP = "loop"
516
FD_BLKTAP = "blktap"
517

    
518
# the set of drbd-like disk types
519
LDS_DRBD = frozenset([LD_DRBD8])
520

    
521
# disk access mode
522
DISK_RDONLY = "ro"
523
DISK_RDWR = "rw"
524
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
525

    
526
# disk replacement mode
527
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
528
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
529
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
530
REPLACE_DISK_AUTO = "replace_auto"
531
REPLACE_MODES = frozenset([
532
  REPLACE_DISK_PRI,
533
  REPLACE_DISK_SEC,
534
  REPLACE_DISK_CHG,
535
  REPLACE_DISK_AUTO,
536
  ])
537

    
538
# Instance export mode
539
EXPORT_MODE_LOCAL = "local"
540
EXPORT_MODE_REMOTE = "remote"
541
EXPORT_MODES = frozenset([
542
  EXPORT_MODE_LOCAL,
543
  EXPORT_MODE_REMOTE,
544
  ])
545

    
546
# instance creation modes
547
INSTANCE_CREATE = "create"
548
INSTANCE_IMPORT = "import"
549
INSTANCE_REMOTE_IMPORT = "remote-import"
550
INSTANCE_CREATE_MODES = frozenset([
551
  INSTANCE_CREATE,
552
  INSTANCE_IMPORT,
553
  INSTANCE_REMOTE_IMPORT,
554
  ])
555

    
556
# Remote import/export handshake message and version
557
RIE_VERSION = 0
558
RIE_HANDSHAKE = "Hi, I'm Ganeti"
559

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

    
563
# Overall timeout for establishing connection
564
RIE_CONNECT_TIMEOUT = 180
565

    
566
# Export only: how long to wait per connection attempt (seconds)
567
RIE_CONNECT_ATTEMPT_TIMEOUT = 20
568

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

    
572
#: Give child process up to 5 seconds to exit after sending a signal
573
CHILD_LINGER_TIMEOUT = 5.0
574

    
575
DISK_TEMPLATES = frozenset([
576
  DT_DISKLESS,
577
  DT_PLAIN,
578
  DT_DRBD8,
579
  DT_FILE,
580
  DT_SHARED_FILE,
581
  DT_BLOCK,
582
  DT_RBD,
583
  DT_EXT
584
  ])
585

    
586
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
587

    
588
# import/export config options
589
INISECT_EXP = "export"
590
INISECT_INS = "instance"
591
INISECT_HYP = "hypervisor"
592
INISECT_BEP = "backend"
593
INISECT_OSP = "os"
594

    
595
# dynamic device modification
596
DDM_ADD = "add"
597
DDM_MODIFY = "modify"
598
DDM_REMOVE = "remove"
599
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
600
DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
601
  DDM_MODIFY,
602
  ]))
603
# TODO: DDM_SWAP, DDM_MOVE?
604

    
605
# common exit codes
606
EXIT_SUCCESS = 0
607
EXIT_FAILURE = 1
608
EXIT_NOTCLUSTER = 5
609
EXIT_NOTMASTER = 11
610
EXIT_NODESETUP_ERROR = 12
611
EXIT_CONFIRMATION = 13 # need user confirmation
612

    
613
#: Exit code for query operations with unknown fields
614
EXIT_UNKNOWN_FIELD = 14
615

    
616
# tags
617
TAG_CLUSTER = "cluster"
618
TAG_NODEGROUP = "nodegroup"
619
TAG_NODE = "node"
620
TAG_INSTANCE = "instance"
621
TAG_NETWORK = "network"
622
VALID_TAG_TYPES = frozenset([
623
  TAG_CLUSTER,
624
  TAG_NODEGROUP,
625
  TAG_NODE,
626
  TAG_INSTANCE,
627
  TAG_NETWORK,
628
  ])
629
MAX_TAG_LEN = 128
630
MAX_TAGS_PER_OBJ = 4096
631

    
632
# others
633
DEFAULT_BRIDGE = "xen-br0"
634
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
635
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
636
IP4_ADDRESS_ANY = "0.0.0.0"
637
IP6_ADDRESS_LOCALHOST = "::1"
638
IP6_ADDRESS_ANY = "::"
639
IP4_VERSION = 4
640
IP6_VERSION = 6
641
VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
642
# for export to htools
643
IP4_FAMILY = socket.AF_INET
644
IP6_FAMILY = socket.AF_INET6
645

    
646
TCP_PING_TIMEOUT = 10
647
GANETI_RUNAS = "root"
648
DEFAULT_VG = "xenvg"
649
DEFAULT_DRBD_HELPER = "/bin/true"
650
MIN_VG_SIZE = 20480
651
DEFAULT_MAC_PREFIX = "aa:00:00"
652
# default maximum instance wait time, in seconds.
653
DEFAULT_SHUTDOWN_TIMEOUT = 120
654
NODE_MAX_CLOCK_SKEW = 150
655
# Time for an intra-cluster disk transfer to wait for a connection
656
DISK_TRANSFER_CONNECT_TIMEOUT = 60
657
# Disk index separator
658
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
659
IP_COMMAND_PATH = _autoconf.IP_PATH
660

    
661
#: Key for job IDs in opcode result
662
JOB_IDS_KEY = "jobs"
663

    
664
# runparts results
665
(RUNPARTS_SKIP,
666
 RUNPARTS_RUN,
667
 RUNPARTS_ERR) = range(3)
668

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

    
671
# RPC constants
672
(RPC_ENCODING_NONE,
673
 RPC_ENCODING_ZLIB_BASE64) = range(2)
674

    
675
# os related constants
676
OS_SCRIPT_CREATE = "create"
677
OS_SCRIPT_IMPORT = "import"
678
OS_SCRIPT_EXPORT = "export"
679
OS_SCRIPT_RENAME = "rename"
680
OS_SCRIPT_VERIFY = "verify"
681
OS_SCRIPTS = frozenset([
682
  OS_SCRIPT_CREATE,
683
  OS_SCRIPT_IMPORT,
684
  OS_SCRIPT_EXPORT,
685
  OS_SCRIPT_RENAME,
686
  OS_SCRIPT_VERIFY
687
  ])
688

    
689
OS_API_FILE = "ganeti_api_version"
690
OS_VARIANTS_FILE = "variants.list"
691
OS_PARAMETERS_FILE = "parameters.list"
692

    
693
OS_VALIDATE_PARAMETERS = "parameters"
694
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
695

    
696
# External Storage (ES) related constants
697
ES_ACTION_CREATE = "create"
698
ES_ACTION_REMOVE = "remove"
699
ES_ACTION_GROW = "grow"
700
ES_ACTION_ATTACH = "attach"
701
ES_ACTION_DETACH = "detach"
702
ES_ACTION_VERIFY = "verify"
703

    
704
ES_SCRIPT_CREATE = ES_ACTION_CREATE
705
ES_SCRIPT_REMOVE = ES_ACTION_REMOVE
706
ES_SCRIPT_GROW = ES_ACTION_GROW
707
ES_SCRIPT_ATTACH = ES_ACTION_ATTACH
708
ES_SCRIPT_DETACH = ES_ACTION_DETACH
709
ES_SCRIPT_VERIFY = ES_ACTION_VERIFY
710
ES_SCRIPTS = frozenset([
711
  ES_SCRIPT_CREATE,
712
  ES_SCRIPT_REMOVE,
713
  ES_SCRIPT_GROW,
714
  ES_SCRIPT_ATTACH,
715
  ES_SCRIPT_DETACH,
716
  ES_SCRIPT_VERIFY
717
  ])
718

    
719
ES_PARAMETERS_FILE = "parameters.list"
720

    
721
# ssh constants
722
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
723
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
724
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
725
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
726
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
727
SSH = "ssh"
728
SCP = "scp"
729

    
730
# reboot types
731
INSTANCE_REBOOT_SOFT = "soft"
732
INSTANCE_REBOOT_HARD = "hard"
733
INSTANCE_REBOOT_FULL = "full"
734

    
735
REBOOT_TYPES = frozenset([
736
  INSTANCE_REBOOT_SOFT,
737
  INSTANCE_REBOOT_HARD,
738
  INSTANCE_REBOOT_FULL
739
  ])
740

    
741
# instance reboot behaviors
742
INSTANCE_REBOOT_ALLOWED = "reboot"
743
INSTANCE_REBOOT_EXIT = "exit"
744

    
745
REBOOT_BEHAVIORS = frozenset([
746
  INSTANCE_REBOOT_ALLOWED,
747
  INSTANCE_REBOOT_EXIT
748
  ])
749

    
750
VTYPE_STRING = "string"
751
VTYPE_MAYBE_STRING = "maybe-string"
752
VTYPE_BOOL = "bool"
753
VTYPE_SIZE = "size" # size, in MiBs
754
VTYPE_INT = "int"
755
ENFORCEABLE_TYPES = frozenset([
756
  VTYPE_STRING,
757
  VTYPE_MAYBE_STRING,
758
  VTYPE_BOOL,
759
  VTYPE_SIZE,
760
  VTYPE_INT,
761
  ])
762

    
763
# Constant representing that the user does not specify any IP version
764
IFACE_NO_IP_VERSION_SPECIFIED = 0
765

    
766
# HV parameter names (global namespace)
767
HV_BOOT_ORDER = "boot_order"
768
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
769
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
770
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
771
HV_NIC_TYPE = "nic_type"
772
HV_DISK_TYPE = "disk_type"
773
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
774
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
775
HV_VNC_PASSWORD_FILE = "vnc_password_file"
776
HV_VNC_TLS = "vnc_tls"
777
HV_VNC_X509 = "vnc_x509_path"
778
HV_VNC_X509_VERIFY = "vnc_x509_verify"
779
HV_KVM_SPICE_BIND = "spice_bind"
780
HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
781
HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
782
HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
783
HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
784
HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
785
HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
786
HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
787
HV_KVM_SPICE_USE_TLS = "spice_use_tls"
788
HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
789
HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
790
HV_ACPI = "acpi"
791
HV_PAE = "pae"
792
HV_USE_BOOTLOADER = "use_bootloader"
793
HV_BOOTLOADER_ARGS = "bootloader_args"
794
HV_BOOTLOADER_PATH = "bootloader_path"
795
HV_KERNEL_ARGS = "kernel_args"
796
HV_KERNEL_PATH = "kernel_path"
797
HV_INITRD_PATH = "initrd_path"
798
HV_ROOT_PATH = "root_path"
799
HV_SERIAL_CONSOLE = "serial_console"
800
HV_USB_MOUSE = "usb_mouse"
801
HV_KEYMAP = "keymap"
802
HV_DEVICE_MODEL = "device_model"
803
HV_INIT_SCRIPT = "init_script"
804
HV_MIGRATION_PORT = "migration_port"
805
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
806
HV_MIGRATION_DOWNTIME = "migration_downtime"
807
HV_MIGRATION_MODE = "migration_mode"
808
HV_USE_LOCALTIME = "use_localtime"
809
HV_DISK_CACHE = "disk_cache"
810
HV_SECURITY_MODEL = "security_model"
811
HV_SECURITY_DOMAIN = "security_domain"
812
HV_KVM_FLAG = "kvm_flag"
813
HV_VHOST_NET = "vhost_net"
814
HV_KVM_USE_CHROOT = "use_chroot"
815
HV_CPU_MASK = "cpu_mask"
816
HV_MEM_PATH = "mem_path"
817
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
818
HV_REBOOT_BEHAVIOR = "reboot_behavior"
819
HV_KVM_MACHINE_VERSION = "machine_version"
820
HV_VIF_SCRIPT = "vif_script"
821

    
822

    
823
HVS_PARAMETER_TYPES = {
824
  HV_BOOT_ORDER: VTYPE_STRING,
825
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
826
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
827
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
828
  HV_NIC_TYPE: VTYPE_STRING,
829
  HV_DISK_TYPE: VTYPE_STRING,
830
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
831
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
832
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
833
  HV_VNC_TLS: VTYPE_BOOL,
834
  HV_VNC_X509: VTYPE_STRING,
835
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
836
  HV_KVM_SPICE_BIND: VTYPE_STRING,
837
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
838
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
839
  HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
840
  HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
841
  HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
842
  HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
843
  HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
844
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
845
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
846
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
847
  HV_ACPI: VTYPE_BOOL,
848
  HV_PAE: VTYPE_BOOL,
849
  HV_USE_BOOTLOADER: VTYPE_BOOL,
850
  HV_BOOTLOADER_PATH: VTYPE_STRING,
851
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
852
  HV_KERNEL_PATH: VTYPE_STRING,
853
  HV_KERNEL_ARGS: VTYPE_STRING,
854
  HV_INITRD_PATH: VTYPE_STRING,
855
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
856
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
857
  HV_USB_MOUSE: VTYPE_STRING,
858
  HV_KEYMAP: VTYPE_STRING,
859
  HV_DEVICE_MODEL: VTYPE_STRING,
860
  HV_INIT_SCRIPT: VTYPE_STRING,
861
  HV_MIGRATION_PORT: VTYPE_INT,
862
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
863
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
864
  HV_MIGRATION_MODE: VTYPE_STRING,
865
  HV_USE_LOCALTIME: VTYPE_BOOL,
866
  HV_DISK_CACHE: VTYPE_STRING,
867
  HV_SECURITY_MODEL: VTYPE_STRING,
868
  HV_SECURITY_DOMAIN: VTYPE_STRING,
869
  HV_KVM_FLAG: VTYPE_STRING,
870
  HV_VHOST_NET: VTYPE_BOOL,
871
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
872
  HV_CPU_MASK: VTYPE_STRING,
873
  HV_MEM_PATH: VTYPE_STRING,
874
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
875
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
876
  HV_KVM_MACHINE_VERSION: VTYPE_STRING,
877
  HV_VIF_SCRIPT: VTYPE_STRING,
878
  }
879

    
880
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
881

    
882
# Migration statuses
883
HV_MIGRATION_COMPLETED = "completed"
884
HV_MIGRATION_ACTIVE = "active"
885
HV_MIGRATION_FAILED = "failed"
886
HV_MIGRATION_CANCELLED = "cancelled"
887

    
888
HV_MIGRATION_VALID_STATUSES = frozenset([
889
  HV_MIGRATION_COMPLETED,
890
  HV_MIGRATION_ACTIVE,
891
  HV_MIGRATION_FAILED,
892
  HV_MIGRATION_CANCELLED,
893
  ])
894

    
895
HV_MIGRATION_FAILED_STATUSES = frozenset([
896
  HV_MIGRATION_FAILED,
897
  HV_MIGRATION_CANCELLED,
898
  ])
899

    
900
# KVM-specific statuses
901
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
902

    
903
# Node info keys
904
HV_NODEINFO_KEY_VERSION = "hv_version"
905

    
906
# Hypervisor state
907
HVST_MEMORY_TOTAL = "mem_total"
908
HVST_MEMORY_NODE = "mem_node"
909
HVST_MEMORY_HV = "mem_hv"
910
HVST_CPU_TOTAL = "cpu_total"
911
HVST_CPU_NODE = "cpu_node"
912

    
913
HVST_DEFAULTS = {
914
  HVST_MEMORY_TOTAL: 0,
915
  HVST_MEMORY_NODE: 0,
916
  HVST_MEMORY_HV: 0,
917
  HVST_CPU_TOTAL: 1,
918
  HVST_CPU_NODE: 1,
919
  }
920

    
921
HVSTS_PARAMETER_TYPES = {
922
  HVST_MEMORY_TOTAL: VTYPE_INT,
923
  HVST_MEMORY_NODE: VTYPE_INT,
924
  HVST_MEMORY_HV: VTYPE_INT,
925
  HVST_CPU_TOTAL: VTYPE_INT,
926
  HVST_CPU_NODE: VTYPE_INT,
927
  }
928

    
929
HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
930

    
931
# Disk state
932
DS_DISK_TOTAL = "disk_total"
933
DS_DISK_RESERVED = "disk_reserved"
934
DS_DISK_OVERHEAD = "disk_overhead"
935

    
936
DS_DEFAULTS = {
937
  DS_DISK_TOTAL: 0,
938
  DS_DISK_RESERVED: 0,
939
  DS_DISK_OVERHEAD: 0,
940
  }
941

    
942
DSS_PARAMETER_TYPES = {
943
  DS_DISK_TOTAL: VTYPE_INT,
944
  DS_DISK_RESERVED: VTYPE_INT,
945
  DS_DISK_OVERHEAD: VTYPE_INT,
946
  }
947

    
948
DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
949
DS_VALID_TYPES = frozenset([LD_LV])
950

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

    
960
BES_PARAMETER_TYPES = {
961
  BE_MAXMEM: VTYPE_SIZE,
962
  BE_MINMEM: VTYPE_SIZE,
963
  BE_VCPUS: VTYPE_INT,
964
  BE_AUTO_BALANCE: VTYPE_BOOL,
965
  BE_ALWAYS_FAILOVER: VTYPE_BOOL,
966
  BE_SPINDLE_USE: VTYPE_INT,
967
  }
968

    
969
BES_PARAMETER_COMPAT = {
970
  BE_MEMORY: VTYPE_SIZE,
971
  }
972
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)
973

    
974
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
975

    
976
# instance specs
977
ISPEC_MEM_SIZE = "memory-size"
978
ISPEC_CPU_COUNT = "cpu-count"
979
ISPEC_DISK_COUNT = "disk-count"
980
ISPEC_DISK_SIZE = "disk-size"
981
ISPEC_NIC_COUNT = "nic-count"
982
ISPEC_SPINDLE_USE = "spindle-use"
983

    
984
ISPECS_PARAMETER_TYPES = {
985
  ISPEC_MEM_SIZE: VTYPE_INT,
986
  ISPEC_CPU_COUNT: VTYPE_INT,
987
  ISPEC_DISK_COUNT: VTYPE_INT,
988
  ISPEC_DISK_SIZE: VTYPE_INT,
989
  ISPEC_NIC_COUNT: VTYPE_INT,
990
  ISPEC_SPINDLE_USE: VTYPE_INT,
991
  }
992

    
993
ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())
994

    
995
ISPECS_MIN = "min"
996
ISPECS_MAX = "max"
997
ISPECS_STD = "std"
998
IPOLICY_DTS = "disk-templates"
999
IPOLICY_VCPU_RATIO = "vcpu-ratio"
1000
IPOLICY_SPINDLE_RATIO = "spindle-ratio"
1001

    
1002
IPOLICY_ISPECS = frozenset([
1003
  ISPECS_MIN,
1004
  ISPECS_MAX,
1005
  ISPECS_STD,
1006
  ])
1007

    
1008
IPOLICY_PARAMETERS = frozenset([
1009
  IPOLICY_VCPU_RATIO,
1010
  IPOLICY_SPINDLE_RATIO,
1011
  ])
1012

    
1013
IPOLICY_ALL_KEYS = (IPOLICY_ISPECS |
1014
                    IPOLICY_PARAMETERS |
1015
                    frozenset([IPOLICY_DTS]))
1016

    
1017
# Node parameter names
1018
ND_OOB_PROGRAM = "oob_program"
1019
ND_SPINDLE_COUNT = "spindle_count"
1020

    
1021
NDS_PARAMETER_TYPES = {
1022
  ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
1023
  ND_SPINDLE_COUNT: VTYPE_INT,
1024
  }
1025

    
1026
NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
1027

    
1028
# Logical Disks parameters
1029
LDP_RESYNC_RATE = "resync-rate"
1030
LDP_STRIPES = "stripes"
1031
LDP_BARRIERS = "disabled-barriers"
1032
LDP_NO_META_FLUSH = "disable-meta-flush"
1033
LDP_DEFAULT_METAVG = "default-metavg"
1034
LDP_DISK_CUSTOM = "disk-custom"
1035
LDP_NET_CUSTOM = "net-custom"
1036
LDP_DYNAMIC_RESYNC = "dynamic-resync"
1037
LDP_PLAN_AHEAD = "c-plan-ahead"
1038
LDP_FILL_TARGET = "c-fill-target"
1039
LDP_DELAY_TARGET = "c-delay-target"
1040
LDP_MAX_RATE = "c-max-rate"
1041
LDP_MIN_RATE = "c-min-rate"
1042
LDP_POOL = "pool"
1043
DISK_LD_TYPES = {
1044
  LDP_RESYNC_RATE: VTYPE_INT,
1045
  LDP_STRIPES: VTYPE_INT,
1046
  LDP_BARRIERS: VTYPE_STRING,
1047
  LDP_NO_META_FLUSH: VTYPE_BOOL,
1048
  LDP_DEFAULT_METAVG: VTYPE_STRING,
1049
  LDP_DISK_CUSTOM: VTYPE_STRING,
1050
  LDP_NET_CUSTOM: VTYPE_STRING,
1051
  LDP_DYNAMIC_RESYNC: VTYPE_BOOL,
1052
  LDP_PLAN_AHEAD: VTYPE_INT,
1053
  LDP_FILL_TARGET: VTYPE_INT,
1054
  LDP_DELAY_TARGET: VTYPE_INT,
1055
  LDP_MAX_RATE: VTYPE_INT,
1056
  LDP_MIN_RATE: VTYPE_INT,
1057
  LDP_POOL: VTYPE_STRING,
1058
  }
1059
DISK_LD_PARAMETERS = frozenset(DISK_LD_TYPES.keys())
1060

    
1061
# Disk template parameters (can be set/changed by the user via gnt-cluster and
1062
# gnt-group)
1063
DRBD_RESYNC_RATE = "resync-rate"
1064
DRBD_DATA_STRIPES = "data-stripes"
1065
DRBD_META_STRIPES = "meta-stripes"
1066
DRBD_DISK_BARRIERS = "disk-barriers"
1067
DRBD_META_BARRIERS = "meta-barriers"
1068
DRBD_DEFAULT_METAVG = "metavg"
1069
DRBD_DISK_CUSTOM = "disk-custom"
1070
DRBD_NET_CUSTOM = "net-custom"
1071
DRBD_DYNAMIC_RESYNC = "dynamic-resync"
1072
DRBD_PLAN_AHEAD = "c-plan-ahead"
1073
DRBD_FILL_TARGET = "c-fill-target"
1074
DRBD_DELAY_TARGET = "c-delay-target"
1075
DRBD_MAX_RATE = "c-max-rate"
1076
DRBD_MIN_RATE = "c-min-rate"
1077
LV_STRIPES = "stripes"
1078
RBD_POOL = "pool"
1079
DISK_DT_TYPES = {
1080
  DRBD_RESYNC_RATE: VTYPE_INT,
1081
  DRBD_DATA_STRIPES: VTYPE_INT,
1082
  DRBD_META_STRIPES: VTYPE_INT,
1083
  DRBD_DISK_BARRIERS: VTYPE_STRING,
1084
  DRBD_META_BARRIERS: VTYPE_BOOL,
1085
  DRBD_DEFAULT_METAVG: VTYPE_STRING,
1086
  DRBD_DISK_CUSTOM: VTYPE_STRING,
1087
  DRBD_NET_CUSTOM: VTYPE_STRING,
1088
  DRBD_DYNAMIC_RESYNC: VTYPE_BOOL,
1089
  DRBD_PLAN_AHEAD: VTYPE_INT,
1090
  DRBD_FILL_TARGET: VTYPE_INT,
1091
  DRBD_DELAY_TARGET: VTYPE_INT,
1092
  DRBD_MAX_RATE: VTYPE_INT,
1093
  DRBD_MIN_RATE: VTYPE_INT,
1094
  LV_STRIPES: VTYPE_INT,
1095
  RBD_POOL: VTYPE_STRING,
1096
  }
1097

    
1098
DISK_DT_PARAMETERS = frozenset(DISK_DT_TYPES.keys())
1099

    
1100
# OOB supported commands
1101
OOB_POWER_ON = "power-on"
1102
OOB_POWER_OFF = "power-off"
1103
OOB_POWER_CYCLE = "power-cycle"
1104
OOB_POWER_STATUS = "power-status"
1105
OOB_HEALTH = "health"
1106

    
1107
OOB_COMMANDS = frozenset([
1108
  OOB_POWER_ON,
1109
  OOB_POWER_OFF,
1110
  OOB_POWER_CYCLE,
1111
  OOB_POWER_STATUS,
1112
  OOB_HEALTH
1113
  ])
1114

    
1115
OOB_POWER_STATUS_POWERED = "powered"
1116

    
1117
OOB_TIMEOUT = 60 # 60 seconds
1118
OOB_POWER_DELAY = 2.0 # 2 seconds
1119

    
1120
OOB_STATUS_OK = "OK"
1121
OOB_STATUS_WARNING = "WARNING"
1122
OOB_STATUS_CRITICAL = "CRITICAL"
1123
OOB_STATUS_UNKNOWN = "UNKNOWN"
1124

    
1125
OOB_STATUSES = frozenset([
1126
  OOB_STATUS_OK,
1127
  OOB_STATUS_WARNING,
1128
  OOB_STATUS_CRITICAL,
1129
  OOB_STATUS_UNKNOWN,
1130
  ])
1131

    
1132
# Instance Parameters Profile
1133
PP_DEFAULT = "default"
1134

    
1135
# NIC_* constants are used inside the ganeti config
1136
NIC_MODE = "mode"
1137
NIC_LINK = "link"
1138

    
1139
NIC_MODE_BRIDGED = "bridged"
1140
NIC_MODE_ROUTED = "routed"
1141
NIC_IP_POOL = "pool"
1142

    
1143
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
1144

    
1145
RESERVE_ACTION = 'reserve'
1146
RELEASE_ACTION = 'release'
1147

    
1148
# An extra description of the network.
1149
# Can be used by hooks/kvm-vif-bridge to apply different rules
1150
NETWORK_TYPE_PRIVATE = "private"
1151
NETWORK_TYPE_PUBLIC = "public"
1152

    
1153
NETWORK_VALID_TYPES = frozenset([NETWORK_TYPE_PRIVATE, NETWORK_TYPE_PUBLIC])
1154

    
1155
NICS_PARAMETER_TYPES = {
1156
  NIC_MODE: VTYPE_STRING,
1157
  NIC_LINK: VTYPE_STRING,
1158
  }
1159

    
1160
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
1161

    
1162
# IDISK_* constants are used in opcodes, to create/change disks
1163
IDISK_SIZE = "size"
1164
IDISK_MODE = "mode"
1165
IDISK_ADOPT = "adopt"
1166
IDISK_VG = "vg"
1167
IDISK_METAVG = "metavg"
1168
IDISK_PROVIDER = "provider"
1169
IDISK_PARAMS_TYPES = {
1170
  IDISK_SIZE: VTYPE_SIZE,
1171
  IDISK_MODE: VTYPE_STRING,
1172
  IDISK_ADOPT: VTYPE_STRING,
1173
  IDISK_VG: VTYPE_STRING,
1174
  IDISK_METAVG: VTYPE_STRING,
1175
  IDISK_PROVIDER: VTYPE_STRING,
1176
  }
1177
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
1178

    
1179
# INIC_* constants are used in opcodes, to create/change nics
1180
INIC_MAC = "mac"
1181
INIC_IP = "ip"
1182
INIC_MODE = "mode"
1183
INIC_LINK = "link"
1184
INIC_NETWORK = "network"
1185
INIC_PARAMS_TYPES = {
1186
  INIC_IP: VTYPE_MAYBE_STRING,
1187
  INIC_LINK: VTYPE_STRING,
1188
  INIC_MAC: VTYPE_STRING,
1189
  INIC_MODE: VTYPE_STRING,
1190
  INIC_NETWORK: VTYPE_MAYBE_STRING,
1191
  }
1192
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
1193

    
1194
# Hypervisor constants
1195
HT_XEN_PVM = "xen-pvm"
1196
HT_FAKE = "fake"
1197
HT_XEN_HVM = "xen-hvm"
1198
HT_KVM = "kvm"
1199
HT_CHROOT = "chroot"
1200
HT_LXC = "lxc"
1201
HYPER_TYPES = frozenset([
1202
  HT_XEN_PVM,
1203
  HT_FAKE,
1204
  HT_XEN_HVM,
1205
  HT_KVM,
1206
  HT_CHROOT,
1207
  HT_LXC,
1208
  ])
1209
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
1210

    
1211
VNC_BASE_PORT = 5900
1212
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
1213
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
1214

    
1215
# NIC types
1216
HT_NIC_RTL8139 = "rtl8139"
1217
HT_NIC_NE2K_PCI = "ne2k_pci"
1218
HT_NIC_NE2K_ISA = "ne2k_isa"
1219
HT_NIC_I82551 = "i82551"
1220
HT_NIC_I85557B = "i82557b"
1221
HT_NIC_I8259ER = "i82559er"
1222
HT_NIC_PCNET = "pcnet"
1223
HT_NIC_E1000 = "e1000"
1224
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
1225

    
1226
HT_HVM_VALID_NIC_TYPES = frozenset([
1227
  HT_NIC_RTL8139,
1228
  HT_NIC_NE2K_PCI,
1229
  HT_NIC_E1000,
1230
  HT_NIC_NE2K_ISA,
1231
  HT_NIC_PARAVIRTUAL
1232
  ])
1233
HT_KVM_VALID_NIC_TYPES = frozenset([
1234
  HT_NIC_RTL8139,
1235
  HT_NIC_NE2K_PCI,
1236
  HT_NIC_NE2K_ISA,
1237
  HT_NIC_I82551,
1238
  HT_NIC_I85557B,
1239
  HT_NIC_I8259ER,
1240
  HT_NIC_PCNET,
1241
  HT_NIC_E1000,
1242
  HT_NIC_PARAVIRTUAL
1243
  ])
1244

    
1245
# Disk types
1246
HT_DISK_IOEMU = "ioemu"
1247
HT_DISK_IDE = "ide"
1248
HT_DISK_SCSI = "scsi"
1249
HT_DISK_SD = "sd"
1250
HT_DISK_MTD = "mtd"
1251
HT_DISK_PFLASH = "pflash"
1252

    
1253
HT_CACHE_DEFAULT = "default"
1254
HT_CACHE_NONE = "none"
1255
HT_CACHE_WTHROUGH = "writethrough"
1256
HT_CACHE_WBACK = "writeback"
1257
HT_VALID_CACHE_TYPES = frozenset([
1258
  HT_CACHE_DEFAULT,
1259
  HT_CACHE_NONE,
1260
  HT_CACHE_WTHROUGH,
1261
  HT_CACHE_WBACK
1262
  ])
1263

    
1264
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1265
HT_KVM_VALID_DISK_TYPES = frozenset([
1266
  HT_DISK_PARAVIRTUAL,
1267
  HT_DISK_IDE,
1268
  HT_DISK_SCSI,
1269
  HT_DISK_SD,
1270
  HT_DISK_MTD,
1271
  HT_DISK_PFLASH
1272
  ])
1273

    
1274
# Mouse types:
1275
HT_MOUSE_MOUSE = "mouse"
1276
HT_MOUSE_TABLET = "tablet"
1277

    
1278
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1279

    
1280
# Boot order
1281
HT_BO_FLOPPY = "floppy"
1282
HT_BO_CDROM = "cdrom"
1283
HT_BO_DISK = "disk"
1284
HT_BO_NETWORK = "network"
1285

    
1286
HT_KVM_VALID_BO_TYPES = frozenset([
1287
  HT_BO_FLOPPY,
1288
  HT_BO_CDROM,
1289
  HT_BO_DISK,
1290
  HT_BO_NETWORK
1291
  ])
1292

    
1293
# SPICE lossless image compression options
1294
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1295
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1296
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1297
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1298
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1299
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1300

    
1301
HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1302
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1303
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1304
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1305
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1306
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1307
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1308
  ])
1309

    
1310
# SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1311
HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1312
HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1313
HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1314

    
1315
HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1316
  HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1317
  HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1318
  HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1319
  ])
1320

    
1321
# SPICE video stream detection
1322
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1323
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1324
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1325

    
1326
HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1327
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1328
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1329
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1330
  ])
1331

    
1332
# Security models
1333
HT_SM_NONE = "none"
1334
HT_SM_USER = "user"
1335
HT_SM_POOL = "pool"
1336

    
1337
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1338

    
1339
# Kvm flag values
1340
HT_KVM_ENABLED = "enabled"
1341
HT_KVM_DISABLED = "disabled"
1342

    
1343
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1344

    
1345
# Migration type
1346
HT_MIGRATION_LIVE = "live"
1347
HT_MIGRATION_NONLIVE = "non-live"
1348
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1349

    
1350
# Cluster Verify steps
1351
VERIFY_NPLUSONE_MEM = "nplusone_mem"
1352
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1353

    
1354
# Cluster Verify error classes
1355
CV_TCLUSTER = "cluster"
1356
CV_TNODE = "node"
1357
CV_TINSTANCE = "instance"
1358

    
1359
# Cluster Verify error codes and documentation
1360
CV_ECLUSTERCFG = \
1361
  (CV_TCLUSTER, "ECLUSTERCFG", "Cluster configuration verification failure")
1362
CV_ECLUSTERCERT = \
1363
  (CV_TCLUSTER, "ECLUSTERCERT",
1364
   "Cluster certificate files verification failure")
1365
CV_ECLUSTERFILECHECK = \
1366
  (CV_TCLUSTER, "ECLUSTERFILECHECK",
1367
   "Cluster configuration verification failure")
1368
CV_ECLUSTERDANGLINGNODES = \
1369
  (CV_TNODE, "ECLUSTERDANGLINGNODES",
1370
   "Some nodes belong to non-existing groups")
1371
CV_ECLUSTERDANGLINGINST = \
1372
  (CV_TNODE, "ECLUSTERDANGLINGINST",
1373
   "Some instances have a non-existing primary node")
1374
CV_EINSTANCEBADNODE = \
1375
  (CV_TINSTANCE, "EINSTANCEBADNODE",
1376
   "Instance marked as running lives on an offline node")
1377
CV_EINSTANCEDOWN = \
1378
  (CV_TINSTANCE, "EINSTANCEDOWN", "Instance not running on its primary node")
1379
CV_EINSTANCELAYOUT = \
1380
  (CV_TINSTANCE, "EINSTANCELAYOUT", "Instance has multiple secondary nodes")
1381
CV_EINSTANCEMISSINGDISK = \
1382
  (CV_TINSTANCE, "EINSTANCEMISSINGDISK", "Missing volume on an instance")
1383
CV_EINSTANCEFAULTYDISK = \
1384
  (CV_TINSTANCE, "EINSTANCEFAULTYDISK",
1385
   "Impossible to retrieve status for a disk")
1386
CV_EINSTANCEWRONGNODE = \
1387
  (CV_TINSTANCE, "EINSTANCEWRONGNODE", "Instance running on the wrong node")
1388
CV_EINSTANCESPLITGROUPS = \
1389
  (CV_TINSTANCE, "EINSTANCESPLITGROUPS",
1390
   "Instance with primary and secondary nodes in different groups")
1391
CV_EINSTANCEPOLICY = \
1392
  (CV_TINSTANCE, "EINSTANCEPOLICY",
1393
   "Instance does not meet policy")
1394
CV_ENODEDRBD = \
1395
  (CV_TNODE, "ENODEDRBD", "Error parsing the DRBD status file")
1396
CV_ENODEDRBDHELPER = \
1397
  (CV_TNODE, "ENODEDRBDHELPER", "Error caused by the DRBD helper")
1398
CV_ENODEFILECHECK = \
1399
  (CV_TNODE, "ENODEFILECHECK",
1400
   "Error retrieving the checksum of the node files")
1401
CV_ENODEHOOKS = \
1402
  (CV_TNODE, "ENODEHOOKS", "Communication failure in hooks execution")
1403
CV_ENODEHV = \
1404
  (CV_TNODE, "ENODEHV", "Hypervisor parameters verification failure")
1405
CV_ENODELVM = \
1406
  (CV_TNODE, "ENODELVM", "LVM-related node error")
1407
CV_ENODEN1 = \
1408
  (CV_TNODE, "ENODEN1", "Not enough memory to accommodate instance failovers")
1409
CV_ENODENET = \
1410
  (CV_TNODE, "ENODENET", "Network-related node error")
1411
CV_ENODEOS = \
1412
  (CV_TNODE, "ENODEOS", "OS-related node error")
1413
CV_ENODEORPHANINSTANCE = \
1414
  (CV_TNODE, "ENODEORPHANINSTANCE", "Unknown intance running on a node")
1415
CV_ENODEORPHANLV = \
1416
  (CV_TNODE, "ENODEORPHANLV", "Unknown LVM logical volume")
1417
CV_ENODERPC = \
1418
  (CV_TNODE, "ENODERPC",
1419
   "Error during connection to the primary node of an instance")
1420
CV_ENODESSH = \
1421
  (CV_TNODE, "ENODESSH", "SSH-related node error")
1422
CV_ENODEVERSION = \
1423
  (CV_TNODE, "ENODEVERSION",
1424
   "Protocol version mismatch or Ganeti version mismatch")
1425
CV_ENODESETUP = \
1426
  (CV_TNODE, "ENODESETUP", "Node setup error")
1427
CV_ENODETIME = \
1428
  (CV_TNODE, "ENODETIME", "Node returned invalid time")
1429
CV_ENODEOOBPATH = \
1430
  (CV_TNODE, "ENODEOOBPATH", "Invalid Out Of Band path")
1431
CV_ENODEUSERSCRIPTS = \
1432
  (CV_TNODE, "ENODEUSERSCRIPTS", "User scripts not present or not executable")
1433

    
1434
CV_ALL_ECODES = frozenset([
1435
  CV_ECLUSTERCFG,
1436
  CV_ECLUSTERCERT,
1437
  CV_ECLUSTERFILECHECK,
1438
  CV_ECLUSTERDANGLINGNODES,
1439
  CV_ECLUSTERDANGLINGINST,
1440
  CV_EINSTANCEBADNODE,
1441
  CV_EINSTANCEDOWN,
1442
  CV_EINSTANCELAYOUT,
1443
  CV_EINSTANCEMISSINGDISK,
1444
  CV_EINSTANCEFAULTYDISK,
1445
  CV_EINSTANCEWRONGNODE,
1446
  CV_EINSTANCESPLITGROUPS,
1447
  CV_EINSTANCEPOLICY,
1448
  CV_ENODEDRBD,
1449
  CV_ENODEDRBDHELPER,
1450
  CV_ENODEFILECHECK,
1451
  CV_ENODEHOOKS,
1452
  CV_ENODEHV,
1453
  CV_ENODELVM,
1454
  CV_ENODEN1,
1455
  CV_ENODENET,
1456
  CV_ENODEOS,
1457
  CV_ENODEORPHANINSTANCE,
1458
  CV_ENODEORPHANLV,
1459
  CV_ENODERPC,
1460
  CV_ENODESSH,
1461
  CV_ENODEVERSION,
1462
  CV_ENODESETUP,
1463
  CV_ENODETIME,
1464
  CV_ENODEOOBPATH,
1465
  CV_ENODEUSERSCRIPTS,
1466
  ])
1467

    
1468
CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1469

    
1470
# Node verify constants
1471
NV_DRBDHELPER = "drbd-helper"
1472
NV_DRBDLIST = "drbd-list"
1473
NV_FILELIST = "filelist"
1474
NV_HVINFO = "hvinfo"
1475
NV_HYPERVISOR = "hypervisor"
1476
NV_HVPARAMS = "hvparms"
1477
NV_INSTANCELIST = "instancelist"
1478
NV_LVLIST = "lvlist"
1479
NV_MASTERIP = "master-ip"
1480
NV_NODELIST = "nodelist"
1481
NV_NODENETTEST = "node-net-test"
1482
NV_NODESETUP = "nodesetup"
1483
NV_OSLIST = "oslist"
1484
NV_PVLIST = "pvlist"
1485
NV_TIME = "time"
1486
NV_VERSION = "version"
1487
NV_VGLIST = "vglist"
1488
NV_VMNODES = "vmnodes"
1489
NV_OOB_PATHS = "oob-paths"
1490
NV_BRIDGES = "bridges"
1491
NV_USERSCRIPTS = "user-scripts"
1492

    
1493
# Instance status
1494
INSTST_RUNNING = "running"
1495
INSTST_ADMINDOWN = "ADMIN_down"
1496
INSTST_ADMINOFFLINE = "ADMIN_offline"
1497
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1498
INSTST_NODEDOWN = "ERROR_nodedown"
1499
INSTST_WRONGNODE = "ERROR_wrongnode"
1500
INSTST_ERRORUP = "ERROR_up"
1501
INSTST_ERRORDOWN = "ERROR_down"
1502
INSTST_ALL = frozenset([
1503
  INSTST_RUNNING,
1504
  INSTST_ADMINDOWN,
1505
  INSTST_ADMINOFFLINE,
1506
  INSTST_NODEOFFLINE,
1507
  INSTST_NODEDOWN,
1508
  INSTST_WRONGNODE,
1509
  INSTST_ERRORUP,
1510
  INSTST_ERRORDOWN,
1511
  ])
1512

    
1513
# Admin states
1514
ADMINST_UP = "up"
1515
ADMINST_DOWN = "down"
1516
ADMINST_OFFLINE = "offline"
1517
ADMINST_ALL = frozenset([
1518
  ADMINST_UP,
1519
  ADMINST_DOWN,
1520
  ADMINST_OFFLINE,
1521
  ])
1522

    
1523
# Node roles
1524
NR_REGULAR = "R"
1525
NR_MASTER = "M"
1526
NR_MCANDIDATE = "C"
1527
NR_DRAINED = "D"
1528
NR_OFFLINE = "O"
1529
NR_ALL = frozenset([
1530
  NR_REGULAR,
1531
  NR_MASTER,
1532
  NR_MCANDIDATE,
1533
  NR_DRAINED,
1534
  NR_OFFLINE,
1535
  ])
1536

    
1537
# SSL certificate check constants (in days)
1538
SSL_CERT_EXPIRATION_WARN = 30
1539
SSL_CERT_EXPIRATION_ERROR = 7
1540

    
1541
# Allocator framework constants
1542
IALLOCATOR_VERSION = 2
1543
IALLOCATOR_DIR_IN = "in"
1544
IALLOCATOR_DIR_OUT = "out"
1545
VALID_IALLOCATOR_DIRECTIONS = frozenset([
1546
  IALLOCATOR_DIR_IN,
1547
  IALLOCATOR_DIR_OUT,
1548
  ])
1549
IALLOCATOR_MODE_ALLOC = "allocate"
1550
IALLOCATOR_MODE_RELOC = "relocate"
1551
IALLOCATOR_MODE_CHG_GROUP = "change-group"
1552
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1553
VALID_IALLOCATOR_MODES = frozenset([
1554
  IALLOCATOR_MODE_ALLOC,
1555
  IALLOCATOR_MODE_RELOC,
1556
  IALLOCATOR_MODE_CHG_GROUP,
1557
  IALLOCATOR_MODE_NODE_EVAC,
1558
  ])
1559
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1560

    
1561
IALLOCATOR_NEVAC_PRI = "primary-only"
1562
IALLOCATOR_NEVAC_SEC = "secondary-only"
1563
IALLOCATOR_NEVAC_ALL = "all"
1564
IALLOCATOR_NEVAC_MODES = frozenset([
1565
  IALLOCATOR_NEVAC_PRI,
1566
  IALLOCATOR_NEVAC_SEC,
1567
  IALLOCATOR_NEVAC_ALL,
1568
  ])
1569

    
1570
# Node evacuation
1571
NODE_EVAC_PRI = "primary-only"
1572
NODE_EVAC_SEC = "secondary-only"
1573
NODE_EVAC_ALL = "all"
1574
NODE_EVAC_MODES = frozenset([
1575
  NODE_EVAC_PRI,
1576
  NODE_EVAC_SEC,
1577
  NODE_EVAC_ALL,
1578
  ])
1579

    
1580
# Job queue
1581
JOB_QUEUE_VERSION = 1
1582
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1583
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1584
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1585
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1586
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1587
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1588

    
1589
JOB_ID_TEMPLATE = r"\d+"
1590
JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1591

    
1592
# unchanged job return
1593
JOB_NOTCHANGED = "nochange"
1594

    
1595
# Job status
1596
JOB_STATUS_QUEUED = "queued"
1597
JOB_STATUS_WAITING = "waiting"
1598
JOB_STATUS_CANCELING = "canceling"
1599
JOB_STATUS_RUNNING = "running"
1600
JOB_STATUS_CANCELED = "canceled"
1601
JOB_STATUS_SUCCESS = "success"
1602
JOB_STATUS_ERROR = "error"
1603
JOBS_FINALIZED = frozenset([
1604
  JOB_STATUS_CANCELED,
1605
  JOB_STATUS_SUCCESS,
1606
  JOB_STATUS_ERROR,
1607
  ])
1608
JOB_STATUS_ALL = frozenset([
1609
  JOB_STATUS_QUEUED,
1610
  JOB_STATUS_WAITING,
1611
  JOB_STATUS_CANCELING,
1612
  JOB_STATUS_RUNNING,
1613
  ]) | JOBS_FINALIZED
1614

    
1615
# OpCode status
1616
# not yet finalized
1617
OP_STATUS_QUEUED = "queued"
1618
OP_STATUS_WAITING = "waiting"
1619
OP_STATUS_CANCELING = "canceling"
1620
OP_STATUS_RUNNING = "running"
1621
# finalized
1622
OP_STATUS_CANCELED = "canceled"
1623
OP_STATUS_SUCCESS = "success"
1624
OP_STATUS_ERROR = "error"
1625
OPS_FINALIZED = frozenset([
1626
  OP_STATUS_CANCELED,
1627
  OP_STATUS_SUCCESS,
1628
  OP_STATUS_ERROR
1629
  ])
1630

    
1631
# OpCode priority
1632
OP_PRIO_LOWEST = +19
1633
OP_PRIO_HIGHEST = -20
1634

    
1635
OP_PRIO_LOW = +10
1636
OP_PRIO_NORMAL = 0
1637
OP_PRIO_HIGH = -10
1638

    
1639
OP_PRIO_SUBMIT_VALID = frozenset([
1640
  OP_PRIO_LOW,
1641
  OP_PRIO_NORMAL,
1642
  OP_PRIO_HIGH,
1643
  ])
1644

    
1645
OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1646

    
1647
# Lock recalculate mode
1648
LOCKS_REPLACE = "replace"
1649
LOCKS_APPEND = "append"
1650

    
1651
# Lock timeout (sum) before we should go into blocking acquire (still
1652
# can be reset by priority change); computed as max time (10 hours)
1653
# before we should actually go into blocking acquire given that we
1654
# start from default priority level; in seconds
1655
# TODO
1656
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / (OP_PRIO_DEFAULT - OP_PRIO_HIGHEST)
1657
LOCK_ATTEMPTS_MAXWAIT = 15.0
1658
LOCK_ATTEMPTS_MINWAIT = 1.0
1659

    
1660
# Execution log types
1661
ELOG_MESSAGE = "message"
1662
ELOG_REMOTE_IMPORT = "remote-import"
1663
ELOG_JQUEUE_TEST = "jqueue-test"
1664

    
1665
# /etc/hosts modification
1666
ETC_HOSTS_ADD = "add"
1667
ETC_HOSTS_REMOVE = "remove"
1668

    
1669
# Job queue test
1670
JQT_MSGPREFIX = "TESTMSG="
1671
JQT_EXPANDNAMES = "expandnames"
1672
JQT_EXEC = "exec"
1673
JQT_LOGMSG = "logmsg"
1674
JQT_STARTMSG = "startmsg"
1675
JQT_ALL = frozenset([
1676
  JQT_EXPANDNAMES,
1677
  JQT_EXEC,
1678
  JQT_LOGMSG,
1679
  JQT_STARTMSG,
1680
  ])
1681

    
1682
# Query resources
1683
QR_CLUSTER = "cluster"
1684
QR_INSTANCE = "instance"
1685
QR_NODE = "node"
1686
QR_LOCK = "lock"
1687
QR_GROUP = "group"
1688
QR_OS = "os"
1689
QR_JOB = "job"
1690
QR_EXPORT = "export"
1691
QR_NETWORK = "network"
1692
QR_EXTSTORAGE = "extstorage"
1693

    
1694
#: List of resources which can be queried using L{opcodes.OpQuery}
1695
QR_VIA_OP = frozenset([
1696
  QR_CLUSTER,
1697
  QR_INSTANCE,
1698
  QR_NODE,
1699
  QR_GROUP,
1700
  QR_OS,
1701
  QR_EXPORT,
1702
  QR_NETWORK,
1703
  QR_EXTSTORAGE,
1704
  ])
1705

    
1706
#: List of resources which can be queried using Local UniX Interface
1707
QR_VIA_LUXI = QR_VIA_OP.union([
1708
  QR_LOCK,
1709
  QR_JOB,
1710
  ])
1711

    
1712
#: List of resources which can be queried using RAPI
1713
QR_VIA_RAPI = QR_VIA_LUXI
1714

    
1715
# Query field types
1716
QFT_UNKNOWN = "unknown"
1717
QFT_TEXT = "text"
1718
QFT_BOOL = "bool"
1719
QFT_NUMBER = "number"
1720
QFT_UNIT = "unit"
1721
QFT_TIMESTAMP = "timestamp"
1722
QFT_OTHER = "other"
1723

    
1724
#: All query field types
1725
QFT_ALL = frozenset([
1726
  QFT_UNKNOWN,
1727
  QFT_TEXT,
1728
  QFT_BOOL,
1729
  QFT_NUMBER,
1730
  QFT_UNIT,
1731
  QFT_TIMESTAMP,
1732
  QFT_OTHER,
1733
  ])
1734

    
1735
# Query result field status (don't change or reuse values as they're used by
1736
# clients)
1737
#: Normal field status
1738
RS_NORMAL = 0
1739
#: Unknown field
1740
RS_UNKNOWN = 1
1741
#: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1742
RS_NODATA = 2
1743
#: Value unavailable/unsupported for item; if this field is supported
1744
#: but we cannot get the data for the moment, RS_NODATA or
1745
#: RS_OFFLINE should be used
1746
RS_UNAVAIL = 3
1747
#: Resource marked offline
1748
RS_OFFLINE = 4
1749

    
1750
RS_ALL = frozenset([
1751
  RS_NORMAL,
1752
  RS_UNKNOWN,
1753
  RS_NODATA,
1754
  RS_UNAVAIL,
1755
  RS_OFFLINE,
1756
  ])
1757

    
1758
#: Dictionary with special field cases and their verbose/terse formatting
1759
RSS_DESCRIPTION = {
1760
  RS_UNKNOWN: ("(unknown)", "??"),
1761
  RS_NODATA: ("(nodata)", "?"),
1762
  RS_OFFLINE: ("(offline)", "*"),
1763
  RS_UNAVAIL: ("(unavail)", "-"),
1764
  }
1765

    
1766
# max dynamic devices
1767
MAX_NICS = 8
1768
MAX_DISKS = 16
1769

    
1770
# SSCONF file prefix
1771
SSCONF_FILEPREFIX = "ssconf_"
1772
# SSCONF keys
1773
SS_CLUSTER_NAME = "cluster_name"
1774
SS_CLUSTER_TAGS = "cluster_tags"
1775
SS_FILE_STORAGE_DIR = "file_storage_dir"
1776
SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1777
SS_MASTER_CANDIDATES = "master_candidates"
1778
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1779
SS_MASTER_IP = "master_ip"
1780
SS_MASTER_NETDEV = "master_netdev"
1781
SS_MASTER_NETMASK = "master_netmask"
1782
SS_MASTER_NODE = "master_node"
1783
SS_NODE_LIST = "node_list"
1784
SS_NODE_PRIMARY_IPS = "node_primary_ips"
1785
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1786
SS_OFFLINE_NODES = "offline_nodes"
1787
SS_ONLINE_NODES = "online_nodes"
1788
SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1789
SS_INSTANCE_LIST = "instance_list"
1790
SS_RELEASE_VERSION = "release_version"
1791
SS_HYPERVISOR_LIST = "hypervisor_list"
1792
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1793
SS_UID_POOL = "uid_pool"
1794
SS_NODEGROUPS = "nodegroups"
1795
SS_NETWORKS = "networks"
1796

    
1797
SS_FILE_PERMS = 0444
1798

    
1799
# cluster wide default parameters
1800
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1801

    
1802
HVC_DEFAULTS = {
1803
  HT_XEN_PVM: {
1804
    HV_USE_BOOTLOADER: False,
1805
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1806
    HV_BOOTLOADER_ARGS: "",
1807
    HV_KERNEL_PATH: XEN_KERNEL,
1808
    HV_INITRD_PATH: "",
1809
    HV_ROOT_PATH: "/dev/sda1",
1810
    HV_KERNEL_ARGS: "ro",
1811
    HV_MIGRATION_PORT: 8002,
1812
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1813
    HV_BLOCKDEV_PREFIX: "sd",
1814
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1815
    HV_CPU_MASK: CPU_PINNING_ALL,
1816
    HV_VIF_SCRIPT: "",
1817
    },
1818
  HT_XEN_HVM: {
1819
    HV_BOOT_ORDER: "cd",
1820
    HV_CDROM_IMAGE_PATH: "",
1821
    HV_NIC_TYPE: HT_NIC_RTL8139,
1822
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1823
    HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1824
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1825
    HV_ACPI: True,
1826
    HV_PAE: True,
1827
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1828
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1829
    HV_MIGRATION_PORT: 8002,
1830
    HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1831
    HV_USE_LOCALTIME: False,
1832
    HV_BLOCKDEV_PREFIX: "hd",
1833
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1834
    HV_CPU_MASK: CPU_PINNING_ALL,
1835
    HV_VIF_SCRIPT: "",
1836
    },
1837
  HT_KVM: {
1838
    HV_KERNEL_PATH: KVM_KERNEL,
1839
    HV_INITRD_PATH: "",
1840
    HV_KERNEL_ARGS: "ro",
1841
    HV_ROOT_PATH: "/dev/vda1",
1842
    HV_ACPI: True,
1843
    HV_SERIAL_CONSOLE: True,
1844
    HV_VNC_BIND_ADDRESS: "",
1845
    HV_VNC_TLS: False,
1846
    HV_VNC_X509: "",
1847
    HV_VNC_X509_VERIFY: False,
1848
    HV_VNC_PASSWORD_FILE: "",
1849
    HV_KVM_SPICE_BIND: "",
1850
    HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1851
    HV_KVM_SPICE_PASSWORD_FILE: "",
1852
    HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1853
    HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1854
    HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1855
    HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1856
    HV_KVM_SPICE_AUDIO_COMPR: True,
1857
    HV_KVM_SPICE_USE_TLS: False,
1858
    HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1859
    HV_KVM_SPICE_USE_VDAGENT: True,
1860
    HV_KVM_FLOPPY_IMAGE_PATH: "",
1861
    HV_CDROM_IMAGE_PATH: "",
1862
    HV_KVM_CDROM2_IMAGE_PATH: "",
1863
    HV_BOOT_ORDER: HT_BO_DISK,
1864
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1865
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1866
    HV_KVM_CDROM_DISK_TYPE: "",
1867
    HV_USB_MOUSE: "",
1868
    HV_KEYMAP: "",
1869
    HV_MIGRATION_PORT: 8102,
1870
    HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1871
    HV_MIGRATION_DOWNTIME: 30,  # ms
1872
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1873
    HV_USE_LOCALTIME: False,
1874
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
1875
    HV_SECURITY_MODEL: HT_SM_NONE,
1876
    HV_SECURITY_DOMAIN: "",
1877
    HV_KVM_FLAG: "",
1878
    HV_VHOST_NET: False,
1879
    HV_KVM_USE_CHROOT: False,
1880
    HV_MEM_PATH: "",
1881
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1882
    HV_CPU_MASK: CPU_PINNING_ALL,
1883
    HV_KVM_MACHINE_VERSION: "",
1884
    },
1885
  HT_FAKE: {
1886
    },
1887
  HT_CHROOT: {
1888
    HV_INIT_SCRIPT: "/ganeti-chroot",
1889
    },
1890
  HT_LXC: {
1891
    HV_CPU_MASK: "",
1892
    },
1893
  }
1894

    
1895
HVC_GLOBALS = frozenset([
1896
  HV_MIGRATION_PORT,
1897
  HV_MIGRATION_BANDWIDTH,
1898
  HV_MIGRATION_MODE,
1899
  ])
1900

    
1901
BEC_DEFAULTS = {
1902
  BE_MINMEM: 128,
1903
  BE_MAXMEM: 128,
1904
  BE_VCPUS: 1,
1905
  BE_AUTO_BALANCE: True,
1906
  BE_ALWAYS_FAILOVER: False,
1907
  BE_SPINDLE_USE: 1,
1908
  }
1909

    
1910
NDC_DEFAULTS = {
1911
  ND_OOB_PROGRAM: None,
1912
  ND_SPINDLE_COUNT: 1,
1913
  }
1914

    
1915
DISK_LD_DEFAULTS = {
1916
  LD_DRBD8: {
1917
    LDP_RESYNC_RATE: CLASSIC_DRBD_SYNC_SPEED,
1918
    LDP_BARRIERS: _autoconf.DRBD_BARRIERS,
1919
    LDP_NO_META_FLUSH: _autoconf.DRBD_NO_META_FLUSH,
1920
    LDP_DEFAULT_METAVG: DEFAULT_VG,
1921
    LDP_DISK_CUSTOM: "",
1922
    LDP_NET_CUSTOM: "",
1923
    LDP_DYNAMIC_RESYNC: False,
1924

    
1925
    # The default values for the DRBD dynamic resync speed algorithm are taken
1926
    # from the drbsetup 8.3.11 man page, except for c-plan-ahead (that we
1927
    # don't need to set to 0, because we have a separate option to enable it)
1928
    # and for c-max-rate, that we cap to the default value for the static resync
1929
    # rate.
1930
    LDP_PLAN_AHEAD: 20, # ds
1931
    LDP_FILL_TARGET: 0, # sectors
1932
    LDP_DELAY_TARGET: 1, # ds
1933
    LDP_MAX_RATE: CLASSIC_DRBD_SYNC_SPEED, # KiB/s
1934
    LDP_MIN_RATE: 4 * 1024, # KiB/s
1935
    },
1936
  LD_LV: {
1937
    LDP_STRIPES: _autoconf.LVM_STRIPECOUNT
1938
    },
1939
  LD_FILE: {
1940
    },
1941
  LD_BLOCKDEV: {
1942
    },
1943
  LD_RBD: {
1944
    LDP_POOL: "rbd"
1945
    },
1946
  LD_EXT: {
1947
    },
1948
  }
1949

    
1950
# readability shortcuts
1951
_LV_DEFAULTS = DISK_LD_DEFAULTS[LD_LV]
1952
_DRBD_DEFAULTS = DISK_LD_DEFAULTS[LD_DRBD8]
1953

    
1954
DISK_DT_DEFAULTS = {
1955
  DT_PLAIN: {
1956
    LV_STRIPES: DISK_LD_DEFAULTS[LD_LV][LDP_STRIPES],
1957
    },
1958
  DT_DRBD8: {
1959
    DRBD_RESYNC_RATE: _DRBD_DEFAULTS[LDP_RESYNC_RATE],
1960
    DRBD_DATA_STRIPES: _LV_DEFAULTS[LDP_STRIPES],
1961
    DRBD_META_STRIPES: _LV_DEFAULTS[LDP_STRIPES],
1962
    DRBD_DISK_BARRIERS: _DRBD_DEFAULTS[LDP_BARRIERS],
1963
    DRBD_META_BARRIERS: _DRBD_DEFAULTS[LDP_NO_META_FLUSH],
1964
    DRBD_DEFAULT_METAVG: _DRBD_DEFAULTS[LDP_DEFAULT_METAVG],
1965
    DRBD_DISK_CUSTOM: _DRBD_DEFAULTS[LDP_DISK_CUSTOM],
1966
    DRBD_NET_CUSTOM: _DRBD_DEFAULTS[LDP_NET_CUSTOM],
1967
    DRBD_DYNAMIC_RESYNC: _DRBD_DEFAULTS[LDP_DYNAMIC_RESYNC],
1968
    DRBD_PLAN_AHEAD: _DRBD_DEFAULTS[LDP_PLAN_AHEAD],
1969
    DRBD_FILL_TARGET: _DRBD_DEFAULTS[LDP_FILL_TARGET],
1970
    DRBD_DELAY_TARGET: _DRBD_DEFAULTS[LDP_DELAY_TARGET],
1971
    DRBD_MAX_RATE: _DRBD_DEFAULTS[LDP_MAX_RATE],
1972
    DRBD_MIN_RATE: _DRBD_DEFAULTS[LDP_MIN_RATE],
1973
    },
1974
  DT_DISKLESS: {
1975
    },
1976
  DT_FILE: {
1977
    },
1978
  DT_SHARED_FILE: {
1979
    },
1980
  DT_BLOCK: {
1981
    },
1982
  DT_RBD: {
1983
    RBD_POOL: DISK_LD_DEFAULTS[LD_RBD][LDP_POOL]
1984
    },
1985
  DT_EXT: {
1986
    },
1987
  }
1988

    
1989
# we don't want to export the shortcuts
1990
del _LV_DEFAULTS, _DRBD_DEFAULTS
1991

    
1992
NICC_DEFAULTS = {
1993
  NIC_MODE: NIC_MODE_BRIDGED,
1994
  NIC_LINK: DEFAULT_BRIDGE,
1995
  }
1996

    
1997
# All of the following values are quite arbitrarily - there are no
1998
# "good" defaults, these must be customised per-site
1999
IPOLICY_DEFAULTS = {
2000
  ISPECS_MIN: {
2001
    ISPEC_MEM_SIZE: 128,
2002
    ISPEC_CPU_COUNT: 1,
2003
    ISPEC_DISK_COUNT: 1,
2004
    ISPEC_DISK_SIZE: 1024,
2005
    ISPEC_NIC_COUNT: 1,
2006
    ISPEC_SPINDLE_USE: 1,
2007
    },
2008
  ISPECS_MAX: {
2009
    ISPEC_MEM_SIZE: 32768,
2010
    ISPEC_CPU_COUNT: 8,
2011
    ISPEC_DISK_COUNT: MAX_DISKS,
2012
    ISPEC_DISK_SIZE: 1024 * 1024,
2013
    ISPEC_NIC_COUNT: MAX_NICS,
2014
    ISPEC_SPINDLE_USE: 12,
2015
    },
2016
  ISPECS_STD: {
2017
    ISPEC_MEM_SIZE: 128,
2018
    ISPEC_CPU_COUNT: 1,
2019
    ISPEC_DISK_COUNT: 1,
2020
    ISPEC_DISK_SIZE: 1024,
2021
    ISPEC_NIC_COUNT: 1,
2022
    ISPEC_SPINDLE_USE: 1,
2023
    },
2024
  IPOLICY_DTS: DISK_TEMPLATES,
2025
  IPOLICY_VCPU_RATIO: 4.0,
2026
  IPOLICY_SPINDLE_RATIO: 32.0,
2027
  }
2028

    
2029
MASTER_POOL_SIZE_DEFAULT = 10
2030

    
2031
CONFD_PROTOCOL_VERSION = 1
2032

    
2033
CONFD_REQ_PING = 0
2034
CONFD_REQ_NODE_ROLE_BYNAME = 1
2035
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
2036
CONFD_REQ_CLUSTER_MASTER = 3
2037
CONFD_REQ_NODE_PIP_LIST = 4
2038
CONFD_REQ_MC_PIP_LIST = 5
2039
CONFD_REQ_INSTANCES_IPS_LIST = 6
2040
CONFD_REQ_NODE_DRBD = 7
2041

    
2042
# Confd request query fields. These are used to narrow down queries.
2043
# These must be strings rather than integers, because json-encoding
2044
# converts them to strings anyway, as they're used as dict-keys.
2045
CONFD_REQQ_LINK = "0"
2046
CONFD_REQQ_IP = "1"
2047
CONFD_REQQ_IPLIST = "2"
2048
CONFD_REQQ_FIELDS = "3"
2049

    
2050
CONFD_REQFIELD_NAME = "0"
2051
CONFD_REQFIELD_IP = "1"
2052
CONFD_REQFIELD_MNODE_PIP = "2"
2053

    
2054
CONFD_REQS = frozenset([
2055
  CONFD_REQ_PING,
2056
  CONFD_REQ_NODE_ROLE_BYNAME,
2057
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
2058
  CONFD_REQ_CLUSTER_MASTER,
2059
  CONFD_REQ_NODE_PIP_LIST,
2060
  CONFD_REQ_MC_PIP_LIST,
2061
  CONFD_REQ_INSTANCES_IPS_LIST,
2062
  CONFD_REQ_NODE_DRBD,
2063
  ])
2064

    
2065
CONFD_REPL_STATUS_OK = 0
2066
CONFD_REPL_STATUS_ERROR = 1
2067
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
2068

    
2069
CONFD_REPL_STATUSES = frozenset([
2070
  CONFD_REPL_STATUS_OK,
2071
  CONFD_REPL_STATUS_ERROR,
2072
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
2073
  ])
2074

    
2075
(CONFD_NODE_ROLE_MASTER,
2076
 CONFD_NODE_ROLE_CANDIDATE,
2077
 CONFD_NODE_ROLE_OFFLINE,
2078
 CONFD_NODE_ROLE_DRAINED,
2079
 CONFD_NODE_ROLE_REGULAR,
2080
 ) = range(5)
2081

    
2082
# A few common errors for confd
2083
CONFD_ERROR_UNKNOWN_ENTRY = 1
2084
CONFD_ERROR_INTERNAL = 2
2085
CONFD_ERROR_ARGUMENT = 3
2086

    
2087
# Each request is "salted" by the current timestamp.
2088
# This constants decides how many seconds of skew to accept.
2089
# TODO: make this a default and allow the value to be more configurable
2090
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
2091

    
2092
# When we haven't reloaded the config for more than this amount of seconds, we
2093
# force a test to see if inotify is betraying us.
2094
CONFD_CONFIG_RELOAD_TIMEOUT = 60
2095

    
2096
# If we receive more than one update in this amount of seconds, we move to
2097
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
2098
# to serve more requests.
2099
CONFD_CONFIG_RELOAD_RATELIMIT = 2
2100

    
2101
# Magic number prepended to all confd queries.
2102
# This allows us to distinguish different types of confd protocols and handle
2103
# them. For example by changing this we can move the whole payload to be
2104
# compressed, or move away from json.
2105
CONFD_MAGIC_FOURCC = "plj0"
2106

    
2107
# By default a confd request is sent to the minimum between this number and all
2108
# MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
2109
# we should have enough answers to be able to compare more than one.
2110
CONFD_DEFAULT_REQ_COVERAGE = 6
2111

    
2112
# Timeout in seconds to expire pending query request in the confd client
2113
# library. We don't actually expect any answer more than 10 seconds after we
2114
# sent a request.
2115
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
2116

    
2117
# Maximum UDP datagram size.
2118
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
2119
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
2120
#   (assuming we can't use jumbo frames)
2121
# We just set this to 60K, which should be enough
2122
MAX_UDP_DATA_SIZE = 61440
2123

    
2124
# User-id pool minimum/maximum acceptable user-ids.
2125
UIDPOOL_UID_MIN = 0
2126
UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
2127

    
2128
# Name or path of the pgrep command
2129
PGREP = "pgrep"
2130

    
2131
# Name of the node group that gets created at cluster init or upgrade
2132
INITIAL_NODE_GROUP_NAME = "default"
2133

    
2134
# Possible values for NodeGroup.alloc_policy
2135
ALLOC_POLICY_PREFERRED = "preferred"
2136
ALLOC_POLICY_LAST_RESORT = "last_resort"
2137
ALLOC_POLICY_UNALLOCABLE = "unallocable"
2138
VALID_ALLOC_POLICIES = [
2139
  ALLOC_POLICY_PREFERRED,
2140
  ALLOC_POLICY_LAST_RESORT,
2141
  ALLOC_POLICY_UNALLOCABLE,
2142
  ]
2143

    
2144
# Temporary external/shared storage parameters
2145
BLOCKDEV_DRIVER_MANUAL = "manual"
2146
EXTSTORAGE_SAMPLE_PROVIDER = "rbd"
2147

    
2148
# qemu-img path, required for ovfconverter
2149
QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
2150

    
2151
# Whether htools was enabled at compilation time
2152
HTOOLS = _autoconf.HTOOLS
2153
# The hail iallocator
2154
IALLOC_HAIL = "hail"
2155

    
2156
# Fake opcodes for functions that have hooks attached to them via
2157
# backend.RunLocalHooks
2158
FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
2159
FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
2160

    
2161
# Do not re-export imported modules
2162
del re, _vcsversion, _autoconf, socket