Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 47334810

History | View | Annotate | Download (55 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
CPU_PINNING_ALL_KVM = 0xFFFFFFFF
124

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

    
131

    
132
# file paths
133
DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
134
RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
135
RUN_GANETI_DIR = RUN_DIR + "/ganeti"
136
BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
137
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
138
RUN_DIRS_MODE = 0775
139
SOCKET_DIR = RUN_GANETI_DIR + "/socket"
140
SECURE_DIR_MODE = 0700
141
SECURE_FILE_MODE = 0600
142
SOCKET_DIR_MODE = 0750
143
CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
144
CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE
145
IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
146
IMPORT_EXPORT_DIR_MODE = 0755
147
ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
148
# keep RUN_GANETI_DIR first here, to make sure all get created when the node
149
# daemon is started (this takes care of RUN_DIR being tmpfs)
150
SUB_RUN_DIRS = [
151
  RUN_GANETI_DIR,
152
  BDEV_CACHE_DIR,
153
  DISK_LINKS_DIR,
154
  ]
155
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
156
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
157
# User-id pool lock directory
158
# The user-ids that are in use have a corresponding lock file in this directory
159
UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
160
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
161
NODED_CERT_FILE = DATA_DIR + "/server.pem"
162
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
163
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
164
SPICE_CERT_FILE = DATA_DIR + "/spice.pem"
165
SPICE_CACERT_FILE = DATA_DIR + "/spice-ca.pem"
166
CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
167
INSTANCE_STATUS_FILE = RUN_GANETI_DIR + "/instance-status"
168
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
169
RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
170
QUEUE_DIR = DATA_DIR + "/queue"
171
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
172
SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
173
KVM_IFUP = _autoconf.PKGLIBDIR + "/kvm-ifup"
174
KVM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/kvm-console-wrapper"
175
XM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/xm-console-wrapper"
176
ETC_HOSTS = "/etc/hosts"
177
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
178
DEFAULT_SHARED_FILE_STORAGE_DIR = _autoconf.SHARED_FILE_STORAGE_DIR
179
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
180
ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
181
SYSCONFDIR = _autoconf.SYSCONFDIR
182
TOOLSDIR = _autoconf.TOOLSDIR
183
CONF_DIR = SYSCONFDIR + "/ganeti"
184
USER_SCRIPTS_DIR = CONF_DIR + "/scripts"
185
ENABLE_CONFD = _autoconf.ENABLE_CONFD
186

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

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

    
194
#: File for per-group instance status, merged into L{INSTANCE_STATUS_FILE} by
195
#: per-group processes
196
WATCHER_GROUP_INSTANCE_STATUS_FILE = DATA_DIR + "/watcher.%s.instance-status"
197

    
198
#: File containing Unix timestamp until which watcher should be paused
199
WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
200

    
201
# Master IP address setup scripts paths (default and user-provided)
202
DEFAULT_MASTER_SETUP_SCRIPT = TOOLSDIR + "/master-ip-setup"
203
EXTERNAL_MASTER_SETUP_SCRIPT = USER_SCRIPTS_DIR + "/master-ip-setup"
204

    
205
ALL_CERT_FILES = frozenset([
206
  NODED_CERT_FILE,
207
  RAPI_CERT_FILE,
208
  SPICE_CERT_FILE,
209
  SPICE_CACERT_FILE,
210
  ])
211

    
212
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
213

    
214
NODED = "ganeti-noded"
215
CONFD = "ganeti-confd"
216
RAPI = "ganeti-rapi"
217
MASTERD = "ganeti-masterd"
218
# used in the ganeti-nbma project
219
NLD = "ganeti-nld"
220

    
221
DAEMONS_PORTS = {
222
  # daemon-name: ("proto", "default-port")
223
  NODED: ("tcp", 1811),
224
  CONFD: ("udp", 1814),
225
  RAPI: ("tcp", 5080),
226
  "ssh": ("tcp", 22),
227
  # used in the ganeti-nbma project
228
  NLD: ("udp", 1816),
229
}
230
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
231
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
232
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
233
# used in the ganeti-nbma project
234
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
235

    
236
FIRST_DRBD_PORT = 11000
237
LAST_DRBD_PORT = 14999
238
MASTER_SCRIPT = "ganeti-master"
239

    
240
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
241
DAEMONS_LOGFILES = {
242
  # "daemon-name": "logfile"
243
  NODED: LOG_DIR + "node-daemon.log",
244
  CONFD: LOG_DIR + "conf-daemon.log",
245
  RAPI: LOG_DIR + "rapi-daemon.log",
246
  MASTERD: LOG_DIR + "master-daemon.log",
247
  # used in the ganeti-nbma project
248
  NLD: LOG_DIR + "nl-daemon.log",
249
  }
250

    
251
LOG_OS_DIR = LOG_DIR + "os"
252
LOG_WATCHER = LOG_DIR + "watcher.log"
253
LOG_COMMANDS = LOG_DIR + "commands.log"
254
LOG_BURNIN = LOG_DIR + "burnin.log"
255
LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
256

    
257
DEV_CONSOLE = "/dev/console"
258

    
259
PROC_MOUNTS = "/proc/mounts"
260

    
261
# Local UniX Interface related constants
262
LUXI_EOM = "\3"
263
LUXI_VERSION = CONFIG_VERSION
264

    
265
# one of "no", "yes", "only"
266
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
267
SYSLOG_NO = "no"
268
SYSLOG_YES = "yes"
269
SYSLOG_ONLY = "only"
270
SYSLOG_SOCKET = "/dev/log"
271

    
272
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
273
EXPORT_DIR = _autoconf.EXPORT_DIR
274

    
275
EXPORT_CONF_FILE = "config.ini"
276

    
277
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
278
XEN_KERNEL = _autoconf.XEN_KERNEL
279
XEN_INITRD = _autoconf.XEN_INITRD
280
XEN_CMD = "xm"
281

    
282
KVM_PATH = _autoconf.KVM_PATH
283
SOCAT_PATH = _autoconf.SOCAT_PATH
284
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
285
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
286
SOCAT_ESCAPE_CODE = "0x1d"
287

    
288
#: Console as SSH command
289
CONS_SSH = "ssh"
290

    
291
#: Console as VNC server
292
CONS_VNC = "vnc"
293

    
294
#: Console as SPICE server
295
CONS_SPICE = "spice"
296

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

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

    
303
# For RSA keys more bits are better, but they also make operations more
304
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
305
# 2010 on.
306
RSA_KEY_BITS = 2048
307

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

    
316
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
317
X509_CERT_SIGN_DIGEST = "SHA1"
318

    
319
# Default validity of certificates in days
320
X509_CERT_DEFAULT_VALIDITY = 365 * 5
321

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

    
325
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
326

    
327
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
328

    
329
# Import/export daemon mode
330
IEM_IMPORT = "import"
331
IEM_EXPORT = "export"
332

    
333
# Import/export transport compression
334
IEC_NONE = "none"
335
IEC_GZIP = "gzip"
336
IEC_ALL = frozenset([
337
  IEC_NONE,
338
  IEC_GZIP,
339
  ])
340

    
341
IE_CUSTOM_SIZE = "fd"
342

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

    
345
# Import/export I/O
346
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
347
IEIO_FILE = "file"
348
# Raw block device I/O using "dd"
349
IEIO_RAW_DISK = "raw"
350
# OS definition import/export script
351
IEIO_SCRIPT = "script"
352

    
353
VALUE_DEFAULT = "default"
354
VALUE_AUTO = "auto"
355
VALUE_GENERATE = "generate"
356
VALUE_NONE = "none"
357
VALUE_TRUE = "true"
358
VALUE_FALSE = "false"
359

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

    
363
# hooks-related constants
364
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
365
HOOKS_PHASE_PRE = "pre"
366
HOOKS_PHASE_POST = "post"
367
HOOKS_NAME_CFGUPDATE = "config-update"
368
HOOKS_NAME_WATCHER = "watcher"
369
HOOKS_VERSION = 2
370
HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
371

    
372
# hooks subject type (what object type does the LU deal with)
373
HTYPE_CLUSTER = "CLUSTER"
374
HTYPE_NODE = "NODE"
375
HTYPE_GROUP = "GROUP"
376
HTYPE_INSTANCE = "INSTANCE"
377

    
378
HKR_SKIP = 0
379
HKR_FAIL = 1
380
HKR_SUCCESS = 2
381

    
382
# Storage types
383
ST_FILE = "file"
384
ST_LVM_PV = "lvm-pv"
385
ST_LVM_VG = "lvm-vg"
386

    
387
# Storage fields
388
# first two are valid in LU context only, not passed to backend
389
SF_NODE = "node"
390
SF_TYPE = "type"
391
# and the rest are valid in backend
392
SF_NAME = "name"
393
SF_SIZE = "size"
394
SF_FREE = "free"
395
SF_USED = "used"
396
SF_ALLOCATABLE = "allocatable"
397

    
398
# Storage operations
399
SO_FIX_CONSISTENCY = "fix-consistency"
400

    
401
# Available fields per storage type
402
VALID_STORAGE_FIELDS = frozenset([
403
  SF_NAME,
404
  SF_TYPE,
405
  SF_SIZE,
406
  SF_USED,
407
  SF_FREE,
408
  SF_ALLOCATABLE
409
  ])
410

    
411
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
412

    
413
MODIFIABLE_STORAGE_FIELDS = {
414
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
415
  }
416

    
417
VALID_STORAGE_OPERATIONS = {
418
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
419
  }
420

    
421
# Local disk status
422
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
423
(LDS_OKAY,
424
 LDS_UNKNOWN,
425
 LDS_FAULTY) = range(1, 4)
426

    
427
# disk template types
428
DT_DISKLESS = "diskless"
429
DT_PLAIN = "plain"
430
DT_DRBD8 = "drbd"
431
DT_FILE = "file"
432
DT_SHARED_FILE = "sharedfile"
433
DT_BLOCK = "blockdev"
434
DT_RBD = "rbd"
435

    
436
# the set of network-mirrored disk templates
437
DTS_INT_MIRROR = frozenset([DT_DRBD8])
438

    
439
# the set of externally-mirrored disk templates (e.g. SAN, NAS)
440
DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK, DT_RBD])
441

    
442
# the set of non-lvm-based disk templates
443
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE,
444
                         DT_BLOCK, DT_RBD])
445

    
446
# the set of disk templates which can be grown
447
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE, DT_RBD])
448

    
449
# the set of disk templates that allow adoption
450
DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])
451

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

    
455
# the set of disk templates that allow migrations
456
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
457

    
458
# the set of file based disk templates
459
DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
460

    
461
# logical disk types
462
LD_LV = "lvm"
463
LD_DRBD8 = "drbd8"
464
LD_FILE = "file"
465
LD_BLOCKDEV = "blockdev"
466
LD_RBD = "rbd"
467
LOGICAL_DISK_TYPES = frozenset([
468
  LD_LV,
469
  LD_DRBD8,
470
  LD_FILE,
471
  LD_BLOCKDEV,
472
  LD_RBD,
473
  ])
474

    
475
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV, LD_RBD])
476

    
477
# drbd constants
478
DRBD_HMAC_ALG = "md5"
479
DRBD_NET_PROTOCOL = "C"
480

    
481
# drbd barrier types
482
DRBD_B_NONE = "n"
483
DRBD_B_DISK_BARRIERS = "b"
484
DRBD_B_DISK_DRAIN = "d"
485
DRBD_B_DISK_FLUSH = "f"
486

    
487
# Valid barrier combinations: "n" or any non-null subset of "bfd"
488
DRBD_VALID_BARRIER_OPT = frozenset([
489
  frozenset([DRBD_B_NONE]),
490
  frozenset([DRBD_B_DISK_BARRIERS]),
491
  frozenset([DRBD_B_DISK_DRAIN]),
492
  frozenset([DRBD_B_DISK_FLUSH]),
493
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
494
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
495
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_DRAIN]),
496
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH]),
497
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH, DRBD_B_DISK_DRAIN]),
498
  ])
499

    
500
# rbd tool command
501
RBD_CMD = "rbd"
502

    
503
# file backend driver
504
FD_LOOP = "loop"
505
FD_BLKTAP = "blktap"
506

    
507
# the set of drbd-like disk types
508
LDS_DRBD = frozenset([LD_DRBD8])
509

    
510
# disk access mode
511
DISK_RDONLY = "ro"
512
DISK_RDWR = "rw"
513
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
514

    
515
# disk replacement mode
516
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
517
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
518
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
519
REPLACE_DISK_AUTO = "replace_auto"
520
REPLACE_MODES = frozenset([
521
  REPLACE_DISK_PRI,
522
  REPLACE_DISK_SEC,
523
  REPLACE_DISK_CHG,
524
  REPLACE_DISK_AUTO,
525
  ])
526

    
527
# Instance export mode
528
EXPORT_MODE_LOCAL = "local"
529
EXPORT_MODE_REMOTE = "remote"
530
EXPORT_MODES = frozenset([
531
  EXPORT_MODE_LOCAL,
532
  EXPORT_MODE_REMOTE,
533
  ])
534

    
535
# Lock recalculate mode
536
LOCKS_REPLACE = "replace"
537
LOCKS_APPEND = "append"
538

    
539
# Lock timeout (sum) before we should go into blocking acquire (still
540
# can be reset by priority change); computed as max time (10 hours)
541
# before we should actually go into blocking acquire given that we
542
# start from default priority level; in seconds
543
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
544
LOCK_ATTEMPTS_MAXWAIT = 15.0
545
LOCK_ATTEMPTS_MINWAIT = 1.0
546

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

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

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

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

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

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

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

    
576
DISK_TEMPLATES = frozenset([
577
  DT_DISKLESS,
578
  DT_PLAIN,
579
  DT_DRBD8,
580
  DT_FILE,
581
  DT_SHARED_FILE,
582
  DT_BLOCK,
583
  DT_RBD
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
VALID_TAG_TYPES = frozenset([
622
  TAG_CLUSTER,
623
  TAG_NODEGROUP,
624
  TAG_NODE,
625
  TAG_INSTANCE,
626
  ])
627
MAX_TAG_LEN = 128
628
MAX_TAGS_PER_OBJ = 4096
629

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

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

    
659
#: Key for job IDs in opcode result
660
JOB_IDS_KEY = "jobs"
661

    
662
# runparts results
663
(RUNPARTS_SKIP,
664
 RUNPARTS_RUN,
665
 RUNPARTS_ERR) = range(3)
666

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

    
669
# RPC constants
670
(RPC_ENCODING_NONE,
671
 RPC_ENCODING_ZLIB_BASE64) = range(2)
672

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

    
687
OS_API_FILE = "ganeti_api_version"
688
OS_VARIANTS_FILE = "variants.list"
689
OS_PARAMETERS_FILE = "parameters.list"
690

    
691
OS_VALIDATE_PARAMETERS = "parameters"
692
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
693

    
694
# ssh constants
695
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
696
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
697
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
698
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
699
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
700
SSH = "ssh"
701
SCP = "scp"
702

    
703
# reboot types
704
INSTANCE_REBOOT_SOFT = "soft"
705
INSTANCE_REBOOT_HARD = "hard"
706
INSTANCE_REBOOT_FULL = "full"
707

    
708
REBOOT_TYPES = frozenset([
709
  INSTANCE_REBOOT_SOFT,
710
  INSTANCE_REBOOT_HARD,
711
  INSTANCE_REBOOT_FULL
712
  ])
713

    
714
# instance reboot behaviors
715
INSTANCE_REBOOT_ALLOWED = "reboot"
716
INSTANCE_REBOOT_EXIT = "exit"
717

    
718
REBOOT_BEHAVIORS = frozenset([
719
  INSTANCE_REBOOT_ALLOWED,
720
  INSTANCE_REBOOT_EXIT
721
  ])
722

    
723
VTYPE_STRING = "string"
724
VTYPE_MAYBE_STRING = "maybe-string"
725
VTYPE_BOOL = "bool"
726
VTYPE_SIZE = "size" # size, in MiBs
727
VTYPE_INT = "int"
728
ENFORCEABLE_TYPES = frozenset([
729
  VTYPE_STRING,
730
  VTYPE_MAYBE_STRING,
731
  VTYPE_BOOL,
732
  VTYPE_SIZE,
733
  VTYPE_INT,
734
  ])
735

    
736
# Constant representing that the user does not specify any IP version
737
IFACE_NO_IP_VERSION_SPECIFIED = 0
738

    
739
# HV parameter names (global namespace)
740
HV_BOOT_ORDER = "boot_order"
741
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
742
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
743
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
744
HV_NIC_TYPE = "nic_type"
745
HV_DISK_TYPE = "disk_type"
746
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
747
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
748
HV_VNC_PASSWORD_FILE = "vnc_password_file"
749
HV_VNC_TLS = "vnc_tls"
750
HV_VNC_X509 = "vnc_x509_path"
751
HV_VNC_X509_VERIFY = "vnc_x509_verify"
752
HV_KVM_SPICE_BIND = "spice_bind"
753
HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
754
HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
755
HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
756
HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
757
HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
758
HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
759
HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
760
HV_KVM_SPICE_USE_TLS = "spice_use_tls"
761
HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
762
HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
763
HV_ACPI = "acpi"
764
HV_PAE = "pae"
765
HV_USE_BOOTLOADER = "use_bootloader"
766
HV_BOOTLOADER_ARGS = "bootloader_args"
767
HV_BOOTLOADER_PATH = "bootloader_path"
768
HV_KERNEL_ARGS = "kernel_args"
769
HV_KERNEL_PATH = "kernel_path"
770
HV_INITRD_PATH = "initrd_path"
771
HV_ROOT_PATH = "root_path"
772
HV_SERIAL_CONSOLE = "serial_console"
773
HV_USB_MOUSE = "usb_mouse"
774
HV_KEYMAP = "keymap"
775
HV_DEVICE_MODEL = "device_model"
776
HV_INIT_SCRIPT = "init_script"
777
HV_MIGRATION_PORT = "migration_port"
778
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
779
HV_MIGRATION_DOWNTIME = "migration_downtime"
780
HV_MIGRATION_MODE = "migration_mode"
781
HV_USE_LOCALTIME = "use_localtime"
782
HV_DISK_CACHE = "disk_cache"
783
HV_SECURITY_MODEL = "security_model"
784
HV_SECURITY_DOMAIN = "security_domain"
785
HV_KVM_FLAG = "kvm_flag"
786
HV_VHOST_NET = "vhost_net"
787
HV_KVM_USE_CHROOT = "use_chroot"
788
HV_CPU_MASK = "cpu_mask"
789
HV_MEM_PATH = "mem_path"
790
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
791
HV_REBOOT_BEHAVIOR = "reboot_behavior"
792

    
793
HVS_PARAMETER_TYPES = {
794
  HV_BOOT_ORDER: VTYPE_STRING,
795
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
796
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
797
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
798
  HV_NIC_TYPE: VTYPE_STRING,
799
  HV_DISK_TYPE: VTYPE_STRING,
800
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
801
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
802
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
803
  HV_VNC_TLS: VTYPE_BOOL,
804
  HV_VNC_X509: VTYPE_STRING,
805
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
806
  HV_KVM_SPICE_BIND: VTYPE_STRING,
807
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
808
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
809
  HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
810
  HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
811
  HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
812
  HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
813
  HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
814
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
815
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
816
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
817
  HV_ACPI: VTYPE_BOOL,
818
  HV_PAE: VTYPE_BOOL,
819
  HV_USE_BOOTLOADER: VTYPE_BOOL,
820
  HV_BOOTLOADER_PATH: VTYPE_STRING,
821
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
822
  HV_KERNEL_PATH: VTYPE_STRING,
823
  HV_KERNEL_ARGS: VTYPE_STRING,
824
  HV_INITRD_PATH: VTYPE_STRING,
825
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
826
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
827
  HV_USB_MOUSE: VTYPE_STRING,
828
  HV_KEYMAP: VTYPE_STRING,
829
  HV_DEVICE_MODEL: VTYPE_STRING,
830
  HV_INIT_SCRIPT: VTYPE_STRING,
831
  HV_MIGRATION_PORT: VTYPE_INT,
832
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
833
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
834
  HV_MIGRATION_MODE: VTYPE_STRING,
835
  HV_USE_LOCALTIME: VTYPE_BOOL,
836
  HV_DISK_CACHE: VTYPE_STRING,
837
  HV_SECURITY_MODEL: VTYPE_STRING,
838
  HV_SECURITY_DOMAIN: VTYPE_STRING,
839
  HV_KVM_FLAG: VTYPE_STRING,
840
  HV_VHOST_NET: VTYPE_BOOL,
841
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
842
  HV_CPU_MASK: VTYPE_STRING,
843
  HV_MEM_PATH: VTYPE_STRING,
844
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
845
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
846
  }
847

    
848
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
849

    
850
# Migration statuses
851
HV_MIGRATION_COMPLETED = "completed"
852
HV_MIGRATION_ACTIVE = "active"
853
HV_MIGRATION_FAILED = "failed"
854
HV_MIGRATION_CANCELLED = "cancelled"
855

    
856
HV_MIGRATION_VALID_STATUSES = frozenset([
857
  HV_MIGRATION_COMPLETED,
858
  HV_MIGRATION_ACTIVE,
859
  HV_MIGRATION_FAILED,
860
  HV_MIGRATION_CANCELLED,
861
  ])
862

    
863
HV_MIGRATION_FAILED_STATUSES = frozenset([
864
  HV_MIGRATION_FAILED,
865
  HV_MIGRATION_CANCELLED,
866
  ])
867

    
868
# KVM-specific statuses
869
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
870

    
871
# Node info keys
872
HV_NODEINFO_KEY_VERSION = "hv_version"
873

    
874
# Hypervisor state
875
HVST_MEMORY_TOTAL = "mem_total"
876
HVST_MEMORY_NODE = "mem_node"
877
HVST_MEMORY_HV = "mem_hv"
878
HVST_CPU_TOTAL = "cpu_total"
879
HVST_CPU_NODE = "cpu_node"
880

    
881
HVST_DEFAULTS = {
882
  HVST_MEMORY_TOTAL: 0,
883
  HVST_MEMORY_NODE: 0,
884
  HVST_MEMORY_HV: 0,
885
  HVST_CPU_TOTAL: 1,
886
  HVST_CPU_NODE: 1,
887
  }
888

    
889
HVSTS_PARAMETER_TYPES = {
890
  HVST_MEMORY_TOTAL: VTYPE_INT,
891
  HVST_MEMORY_NODE: VTYPE_INT,
892
  HVST_MEMORY_HV: VTYPE_INT,
893
  HVST_CPU_TOTAL: VTYPE_INT,
894
  HVST_CPU_NODE: VTYPE_INT,
895
  }
896

    
897
HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
898

    
899
# Disk state
900
DS_DISK_TOTAL = "disk_total"
901
DS_DISK_RESERVED = "disk_reserved"
902
DS_DISK_OVERHEAD = "disk_overhead"
903

    
904
DS_DEFAULTS = {
905
  DS_DISK_TOTAL: 0,
906
  DS_DISK_RESERVED: 0,
907
  DS_DISK_OVERHEAD: 0,
908
  }
909

    
910
DSS_PARAMETER_TYPES = {
911
  DS_DISK_TOTAL: VTYPE_INT,
912
  DS_DISK_RESERVED: VTYPE_INT,
913
  DS_DISK_OVERHEAD: VTYPE_INT,
914
  }
915

    
916
DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
917
DS_VALID_TYPES = frozenset([LD_LV])
918

    
919
# Backend parameter names
920
BE_MEMORY = "memory" # deprecated and replaced by max and min mem
921
BE_MAXMEM = "maxmem"
922
BE_MINMEM = "minmem"
923
BE_VCPUS = "vcpus"
924
BE_AUTO_BALANCE = "auto_balance"
925
BE_ALWAYS_FAILOVER = "always_failover"
926
BE_SPINDLE_USE = "spindle_use"
927

    
928
BES_PARAMETER_TYPES = {
929
  BE_MAXMEM: VTYPE_SIZE,
930
  BE_MINMEM: VTYPE_SIZE,
931
  BE_VCPUS: VTYPE_INT,
932
  BE_AUTO_BALANCE: VTYPE_BOOL,
933
  BE_ALWAYS_FAILOVER: VTYPE_BOOL,
934
  BE_SPINDLE_USE: VTYPE_INT,
935
  }
936

    
937
BES_PARAMETER_COMPAT = {
938
  BE_MEMORY: VTYPE_SIZE,
939
  }
940
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)
941

    
942
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
943

    
944
# instance specs
945
ISPEC_MEM_SIZE = "memory-size"
946
ISPEC_CPU_COUNT = "cpu-count"
947
ISPEC_DISK_COUNT = "disk-count"
948
ISPEC_DISK_SIZE = "disk-size"
949
ISPEC_NIC_COUNT = "nic-count"
950
ISPEC_SPINDLE_USE = "spindle-use"
951

    
952
ISPECS_PARAMETER_TYPES = {
953
  ISPEC_MEM_SIZE: VTYPE_INT,
954
  ISPEC_CPU_COUNT: VTYPE_INT,
955
  ISPEC_DISK_COUNT: VTYPE_INT,
956
  ISPEC_DISK_SIZE: VTYPE_INT,
957
  ISPEC_NIC_COUNT: VTYPE_INT,
958
  ISPEC_SPINDLE_USE: VTYPE_INT,
959
  }
960

    
961
ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())
962

    
963
ISPECS_MIN = "min"
964
ISPECS_MAX = "max"
965
ISPECS_STD = "std"
966
IPOLICY_DTS = "disk-templates"
967
IPOLICY_VCPU_RATIO = "vcpu-ratio"
968
IPOLICY_SPINDLE_RATIO = "spindle-ratio"
969

    
970
IPOLICY_ISPECS = frozenset([
971
  ISPECS_MIN,
972
  ISPECS_MAX,
973
  ISPECS_STD,
974
  ])
975

    
976
IPOLICY_PARAMETERS = frozenset([
977
  IPOLICY_VCPU_RATIO,
978
  IPOLICY_SPINDLE_RATIO,
979
  ])
980

    
981
IPOLICY_ALL_KEYS = (IPOLICY_ISPECS |
982
                    IPOLICY_PARAMETERS |
983
                    frozenset([IPOLICY_DTS]))
984

    
985
# Node parameter names
986
ND_OOB_PROGRAM = "oob_program"
987
ND_SPINDLE_COUNT = "spindle_count"
988

    
989
NDS_PARAMETER_TYPES = {
990
  ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
991
  ND_SPINDLE_COUNT: VTYPE_INT,
992
  }
993

    
994
NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
995

    
996
# Logical Disks parameters
997
LDP_RESYNC_RATE = "resync-rate"
998
LDP_STRIPES = "stripes"
999
LDP_BARRIERS = "disabled-barriers"
1000
LDP_NO_META_FLUSH = "disable-meta-flush"
1001
LDP_DEFAULT_METAVG = "default-metavg"
1002
LDP_DISK_CUSTOM = "disk-custom"
1003
LDP_NET_CUSTOM = "net-custom"
1004
LDP_DYNAMIC_RESYNC = "dynamic-resync"
1005
LDP_PLAN_AHEAD = "c-plan-ahead"
1006
LDP_FILL_TARGET = "c-fill-target"
1007
LDP_DELAY_TARGET = "c-delay-target"
1008
LDP_MAX_RATE = "c-max-rate"
1009
LDP_MIN_RATE = "c-min-rate"
1010
LDP_POOL = "pool"
1011
DISK_LD_TYPES = {
1012
  LDP_RESYNC_RATE: VTYPE_INT,
1013
  LDP_STRIPES: VTYPE_INT,
1014
  LDP_BARRIERS: VTYPE_STRING,
1015
  LDP_NO_META_FLUSH: VTYPE_BOOL,
1016
  LDP_DEFAULT_METAVG: VTYPE_STRING,
1017
  LDP_DISK_CUSTOM: VTYPE_STRING,
1018
  LDP_NET_CUSTOM: VTYPE_STRING,
1019
  LDP_DYNAMIC_RESYNC: VTYPE_BOOL,
1020
  LDP_PLAN_AHEAD: VTYPE_INT,
1021
  LDP_FILL_TARGET: VTYPE_INT,
1022
  LDP_DELAY_TARGET: VTYPE_INT,
1023
  LDP_MAX_RATE: VTYPE_INT,
1024
  LDP_MIN_RATE: VTYPE_INT,
1025
  LDP_POOL: VTYPE_STRING,
1026
  }
1027
DISK_LD_PARAMETERS = frozenset(DISK_LD_TYPES.keys())
1028

    
1029
# Disk template parameters (can be set/changed by the user via gnt-cluster and
1030
# gnt-group)
1031
DRBD_RESYNC_RATE = "resync-rate"
1032
DRBD_DATA_STRIPES = "data-stripes"
1033
DRBD_META_STRIPES = "meta-stripes"
1034
DRBD_DISK_BARRIERS = "disk-barriers"
1035
DRBD_META_BARRIERS = "meta-barriers"
1036
DRBD_DEFAULT_METAVG = "metavg"
1037
DRBD_DISK_CUSTOM = "disk-custom"
1038
DRBD_NET_CUSTOM = "net-custom"
1039
DRBD_DYNAMIC_RESYNC = "dynamic-resync"
1040
DRBD_PLAN_AHEAD = "c-plan-ahead"
1041
DRBD_FILL_TARGET = "c-fill-target"
1042
DRBD_DELAY_TARGET = "c-delay-target"
1043
DRBD_MAX_RATE = "c-max-rate"
1044
DRBD_MIN_RATE = "c-min-rate"
1045
LV_STRIPES = "stripes"
1046
RBD_POOL = "pool"
1047
DISK_DT_TYPES = {
1048
  DRBD_RESYNC_RATE: VTYPE_INT,
1049
  DRBD_DATA_STRIPES: VTYPE_INT,
1050
  DRBD_META_STRIPES: VTYPE_INT,
1051
  DRBD_DISK_BARRIERS: VTYPE_STRING,
1052
  DRBD_META_BARRIERS: VTYPE_BOOL,
1053
  DRBD_DEFAULT_METAVG: VTYPE_STRING,
1054
  DRBD_DISK_CUSTOM: VTYPE_STRING,
1055
  DRBD_NET_CUSTOM: VTYPE_STRING,
1056
  DRBD_DYNAMIC_RESYNC: VTYPE_BOOL,
1057
  DRBD_PLAN_AHEAD: VTYPE_INT,
1058
  DRBD_FILL_TARGET: VTYPE_INT,
1059
  DRBD_DELAY_TARGET: VTYPE_INT,
1060
  DRBD_MAX_RATE: VTYPE_INT,
1061
  DRBD_MIN_RATE: VTYPE_INT,
1062
  LV_STRIPES: VTYPE_INT,
1063
  RBD_POOL: VTYPE_STRING,
1064
  }
1065

    
1066
DISK_DT_PARAMETERS = frozenset(DISK_DT_TYPES.keys())
1067

    
1068
# OOB supported commands
1069
OOB_POWER_ON = "power-on"
1070
OOB_POWER_OFF = "power-off"
1071
OOB_POWER_CYCLE = "power-cycle"
1072
OOB_POWER_STATUS = "power-status"
1073
OOB_HEALTH = "health"
1074

    
1075
OOB_COMMANDS = frozenset([
1076
  OOB_POWER_ON,
1077
  OOB_POWER_OFF,
1078
  OOB_POWER_CYCLE,
1079
  OOB_POWER_STATUS,
1080
  OOB_HEALTH
1081
  ])
1082

    
1083
OOB_POWER_STATUS_POWERED = "powered"
1084

    
1085
OOB_TIMEOUT = 60 # 60 seconds
1086
OOB_POWER_DELAY = 2.0 # 2 seconds
1087

    
1088
OOB_STATUS_OK = "OK"
1089
OOB_STATUS_WARNING = "WARNING"
1090
OOB_STATUS_CRITICAL = "CRITICAL"
1091
OOB_STATUS_UNKNOWN = "UNKNOWN"
1092

    
1093
OOB_STATUSES = frozenset([
1094
  OOB_STATUS_OK,
1095
  OOB_STATUS_WARNING,
1096
  OOB_STATUS_CRITICAL,
1097
  OOB_STATUS_UNKNOWN,
1098
  ])
1099

    
1100
# Instance Parameters Profile
1101
PP_DEFAULT = "default"
1102

    
1103
# NIC_* constants are used inside the ganeti config
1104
NIC_MODE = "mode"
1105
NIC_LINK = "link"
1106

    
1107
NIC_MODE_BRIDGED = "bridged"
1108
NIC_MODE_ROUTED = "routed"
1109

    
1110
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
1111

    
1112
NICS_PARAMETER_TYPES = {
1113
  NIC_MODE: VTYPE_STRING,
1114
  NIC_LINK: VTYPE_STRING,
1115
  }
1116

    
1117
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
1118

    
1119
# IDISK_* constants are used in opcodes, to create/change disks
1120
IDISK_SIZE = "size"
1121
IDISK_MODE = "mode"
1122
IDISK_ADOPT = "adopt"
1123
IDISK_VG = "vg"
1124
IDISK_METAVG = "metavg"
1125
IDISK_PARAMS_TYPES = {
1126
  IDISK_SIZE: VTYPE_SIZE,
1127
  IDISK_MODE: VTYPE_STRING,
1128
  IDISK_ADOPT: VTYPE_STRING,
1129
  IDISK_VG: VTYPE_STRING,
1130
  IDISK_METAVG: VTYPE_STRING,
1131
  }
1132
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
1133

    
1134
# INIC_* constants are used in opcodes, to create/change nics
1135
INIC_MAC = "mac"
1136
INIC_IP = "ip"
1137
INIC_MODE = "mode"
1138
INIC_LINK = "link"
1139
INIC_PARAMS_TYPES = {
1140
  INIC_IP: VTYPE_MAYBE_STRING,
1141
  INIC_LINK: VTYPE_STRING,
1142
  INIC_MAC: VTYPE_STRING,
1143
  INIC_MODE: VTYPE_STRING,
1144
  }
1145
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
1146

    
1147
# Hypervisor constants
1148
HT_XEN_PVM = "xen-pvm"
1149
HT_FAKE = "fake"
1150
HT_XEN_HVM = "xen-hvm"
1151
HT_KVM = "kvm"
1152
HT_CHROOT = "chroot"
1153
HT_LXC = "lxc"
1154
HYPER_TYPES = frozenset([
1155
  HT_XEN_PVM,
1156
  HT_FAKE,
1157
  HT_XEN_HVM,
1158
  HT_KVM,
1159
  HT_CHROOT,
1160
  HT_LXC,
1161
  ])
1162
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
1163

    
1164
VNC_BASE_PORT = 5900
1165
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
1166
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
1167

    
1168
# NIC types
1169
HT_NIC_RTL8139 = "rtl8139"
1170
HT_NIC_NE2K_PCI = "ne2k_pci"
1171
HT_NIC_NE2K_ISA = "ne2k_isa"
1172
HT_NIC_I82551 = "i82551"
1173
HT_NIC_I85557B = "i82557b"
1174
HT_NIC_I8259ER = "i82559er"
1175
HT_NIC_PCNET = "pcnet"
1176
HT_NIC_E1000 = "e1000"
1177
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
1178

    
1179
HT_HVM_VALID_NIC_TYPES = frozenset([
1180
  HT_NIC_RTL8139,
1181
  HT_NIC_NE2K_PCI,
1182
  HT_NIC_E1000,
1183
  HT_NIC_NE2K_ISA,
1184
  HT_NIC_PARAVIRTUAL
1185
  ])
1186
HT_KVM_VALID_NIC_TYPES = frozenset([
1187
  HT_NIC_RTL8139,
1188
  HT_NIC_NE2K_PCI,
1189
  HT_NIC_NE2K_ISA,
1190
  HT_NIC_I82551,
1191
  HT_NIC_I85557B,
1192
  HT_NIC_I8259ER,
1193
  HT_NIC_PCNET,
1194
  HT_NIC_E1000,
1195
  HT_NIC_PARAVIRTUAL
1196
  ])
1197

    
1198
# Disk types
1199
HT_DISK_IOEMU = "ioemu"
1200
HT_DISK_IDE = "ide"
1201
HT_DISK_SCSI = "scsi"
1202
HT_DISK_SD = "sd"
1203
HT_DISK_MTD = "mtd"
1204
HT_DISK_PFLASH = "pflash"
1205

    
1206
HT_CACHE_DEFAULT = "default"
1207
HT_CACHE_NONE = "none"
1208
HT_CACHE_WTHROUGH = "writethrough"
1209
HT_CACHE_WBACK = "writeback"
1210
HT_VALID_CACHE_TYPES = frozenset([
1211
  HT_CACHE_DEFAULT,
1212
  HT_CACHE_NONE,
1213
  HT_CACHE_WTHROUGH,
1214
  HT_CACHE_WBACK
1215
  ])
1216

    
1217
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1218
HT_KVM_VALID_DISK_TYPES = frozenset([
1219
  HT_DISK_PARAVIRTUAL,
1220
  HT_DISK_IDE,
1221
  HT_DISK_SCSI,
1222
  HT_DISK_SD,
1223
  HT_DISK_MTD,
1224
  HT_DISK_PFLASH
1225
  ])
1226

    
1227
# Mouse types:
1228
HT_MOUSE_MOUSE = "mouse"
1229
HT_MOUSE_TABLET = "tablet"
1230

    
1231
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1232

    
1233
# Boot order
1234
HT_BO_FLOPPY = "floppy"
1235
HT_BO_CDROM = "cdrom"
1236
HT_BO_DISK = "disk"
1237
HT_BO_NETWORK = "network"
1238

    
1239
HT_KVM_VALID_BO_TYPES = frozenset([
1240
  HT_BO_FLOPPY,
1241
  HT_BO_CDROM,
1242
  HT_BO_DISK,
1243
  HT_BO_NETWORK
1244
  ])
1245

    
1246
# SPICE lossless image compression options
1247
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1248
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1249
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1250
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1251
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1252
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1253

    
1254
HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1255
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1256
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1257
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1258
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1259
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1260
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1261
  ])
1262

    
1263
# SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1264
HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1265
HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1266
HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1267

    
1268
HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1269
  HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1270
  HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1271
  HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1272
  ])
1273

    
1274
# SPICE video stream detection
1275
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1276
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1277
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1278

    
1279
HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1280
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1281
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1282
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1283
  ])
1284

    
1285
# Security models
1286
HT_SM_NONE = "none"
1287
HT_SM_USER = "user"
1288
HT_SM_POOL = "pool"
1289

    
1290
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1291

    
1292
# Kvm flag values
1293
HT_KVM_ENABLED = "enabled"
1294
HT_KVM_DISABLED = "disabled"
1295

    
1296
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1297

    
1298
# Migration type
1299
HT_MIGRATION_LIVE = "live"
1300
HT_MIGRATION_NONLIVE = "non-live"
1301
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1302

    
1303
# Cluster Verify steps
1304
VERIFY_NPLUSONE_MEM = "nplusone_mem"
1305
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1306

    
1307
# Cluster Verify error classes
1308
CV_TCLUSTER = "cluster"
1309
CV_TNODE = "node"
1310
CV_TINSTANCE = "instance"
1311

    
1312
# Cluster Verify error codes and documentation
1313
CV_ECLUSTERCFG = \
1314
  (CV_TCLUSTER, "ECLUSTERCFG", "Cluster configuration verification failure")
1315
CV_ECLUSTERCERT = \
1316
  (CV_TCLUSTER, "ECLUSTERCERT",
1317
   "Cluster certificate files verification failure")
1318
CV_ECLUSTERFILECHECK = \
1319
  (CV_TCLUSTER, "ECLUSTERFILECHECK",
1320
   "Cluster configuration verification failure")
1321
CV_ECLUSTERDANGLINGNODES = \
1322
  (CV_TNODE, "ECLUSTERDANGLINGNODES",
1323
   "Some nodes belong to non-existing groups")
1324
CV_ECLUSTERDANGLINGINST = \
1325
  (CV_TNODE, "ECLUSTERDANGLINGINST",
1326
   "Some instances have a non-existing primary node")
1327
CV_EINSTANCEBADNODE = \
1328
  (CV_TINSTANCE, "EINSTANCEBADNODE",
1329
   "Instance marked as running lives on an offline node")
1330
CV_EINSTANCEDOWN = \
1331
  (CV_TINSTANCE, "EINSTANCEDOWN", "Instance not running on its primary node")
1332
CV_EINSTANCELAYOUT = \
1333
  (CV_TINSTANCE, "EINSTANCELAYOUT", "Instance has multiple secondary nodes")
1334
CV_EINSTANCEMISSINGDISK = \
1335
  (CV_TINSTANCE, "EINSTANCEMISSINGDISK", "Missing volume on an instance")
1336
CV_EINSTANCEFAULTYDISK = \
1337
  (CV_TINSTANCE, "EINSTANCEFAULTYDISK",
1338
   "Impossible to retrieve status for a disk")
1339
CV_EINSTANCEWRONGNODE = \
1340
  (CV_TINSTANCE, "EINSTANCEWRONGNODE", "Instance running on the wrong node")
1341
CV_EINSTANCESPLITGROUPS = \
1342
  (CV_TINSTANCE, "EINSTANCESPLITGROUPS",
1343
   "Instance with primary and secondary nodes in different groups")
1344
CV_EINSTANCEPOLICY = \
1345
  (CV_TINSTANCE, "EINSTANCEPOLICY",
1346
   "Instance does not meet policy")
1347
CV_ENODEDRBD = \
1348
  (CV_TNODE, "ENODEDRBD", "Error parsing the DRBD status file")
1349
CV_ENODEDRBDHELPER = \
1350
  (CV_TNODE, "ENODEDRBDHELPER", "Error caused by the DRBD helper")
1351
CV_ENODEFILECHECK = \
1352
  (CV_TNODE, "ENODEFILECHECK",
1353
   "Error retrieving the checksum of the node files")
1354
CV_ENODEHOOKS = \
1355
  (CV_TNODE, "ENODEHOOKS", "Communication failure in hooks execution")
1356
CV_ENODEHV = \
1357
  (CV_TNODE, "ENODEHV", "Hypervisor parameters verification failure")
1358
CV_ENODELVM = \
1359
  (CV_TNODE, "ENODELVM", "LVM-related node error")
1360
CV_ENODEN1 = \
1361
  (CV_TNODE, "ENODEN1", "Not enough memory to accommodate instance failovers")
1362
CV_ENODENET = \
1363
  (CV_TNODE, "ENODENET", "Network-related node error")
1364
CV_ENODEOS = \
1365
  (CV_TNODE, "ENODEOS", "OS-related node error")
1366
CV_ENODEORPHANINSTANCE = \
1367
  (CV_TNODE, "ENODEORPHANINSTANCE", "Unknown intance running on a node")
1368
CV_ENODEORPHANLV = \
1369
  (CV_TNODE, "ENODEORPHANLV", "Unknown LVM logical volume")
1370
CV_ENODERPC = \
1371
  (CV_TNODE, "ENODERPC",
1372
   "Error during connection to the primary node of an instance")
1373
CV_ENODESSH = \
1374
  (CV_TNODE, "ENODESSH", "SSH-related node error")
1375
CV_ENODEVERSION = \
1376
  (CV_TNODE, "ENODEVERSION",
1377
   "Protocol version mismatch or Ganeti version mismatch")
1378
CV_ENODESETUP = \
1379
  (CV_TNODE, "ENODESETUP", "Node setup error")
1380
CV_ENODETIME = \
1381
  (CV_TNODE, "ENODETIME", "Node returned invalid time")
1382
CV_ENODEOOBPATH = \
1383
  (CV_TNODE, "ENODEOOBPATH", "Invalid Out Of Band path")
1384
CV_ENODEUSERSCRIPTS = \
1385
  (CV_TNODE, "ENODEUSERSCRIPTS", "User scripts not present or not executable")
1386

    
1387
CV_ALL_ECODES = frozenset([
1388
  CV_ECLUSTERCFG,
1389
  CV_ECLUSTERCERT,
1390
  CV_ECLUSTERFILECHECK,
1391
  CV_ECLUSTERDANGLINGNODES,
1392
  CV_ECLUSTERDANGLINGINST,
1393
  CV_EINSTANCEBADNODE,
1394
  CV_EINSTANCEDOWN,
1395
  CV_EINSTANCELAYOUT,
1396
  CV_EINSTANCEMISSINGDISK,
1397
  CV_EINSTANCEFAULTYDISK,
1398
  CV_EINSTANCEWRONGNODE,
1399
  CV_EINSTANCESPLITGROUPS,
1400
  CV_EINSTANCEPOLICY,
1401
  CV_ENODEDRBD,
1402
  CV_ENODEDRBDHELPER,
1403
  CV_ENODEFILECHECK,
1404
  CV_ENODEHOOKS,
1405
  CV_ENODEHV,
1406
  CV_ENODELVM,
1407
  CV_ENODEN1,
1408
  CV_ENODENET,
1409
  CV_ENODEOS,
1410
  CV_ENODEORPHANINSTANCE,
1411
  CV_ENODEORPHANLV,
1412
  CV_ENODERPC,
1413
  CV_ENODESSH,
1414
  CV_ENODEVERSION,
1415
  CV_ENODESETUP,
1416
  CV_ENODETIME,
1417
  CV_ENODEOOBPATH,
1418
  CV_ENODEUSERSCRIPTS,
1419
  ])
1420

    
1421
CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1422

    
1423
# Node verify constants
1424
NV_DRBDHELPER = "drbd-helper"
1425
NV_DRBDLIST = "drbd-list"
1426
NV_FILELIST = "filelist"
1427
NV_HVINFO = "hvinfo"
1428
NV_HYPERVISOR = "hypervisor"
1429
NV_HVPARAMS = "hvparms"
1430
NV_INSTANCELIST = "instancelist"
1431
NV_LVLIST = "lvlist"
1432
NV_MASTERIP = "master-ip"
1433
NV_NODELIST = "nodelist"
1434
NV_NODENETTEST = "node-net-test"
1435
NV_NODESETUP = "nodesetup"
1436
NV_OSLIST = "oslist"
1437
NV_PVLIST = "pvlist"
1438
NV_TIME = "time"
1439
NV_VERSION = "version"
1440
NV_VGLIST = "vglist"
1441
NV_VMNODES = "vmnodes"
1442
NV_OOB_PATHS = "oob-paths"
1443
NV_BRIDGES = "bridges"
1444
NV_USERSCRIPTS = "user-scripts"
1445

    
1446
# Instance status
1447
INSTST_RUNNING = "running"
1448
INSTST_ADMINDOWN = "ADMIN_down"
1449
INSTST_ADMINOFFLINE = "ADMIN_offline"
1450
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1451
INSTST_NODEDOWN = "ERROR_nodedown"
1452
INSTST_WRONGNODE = "ERROR_wrongnode"
1453
INSTST_ERRORUP = "ERROR_up"
1454
INSTST_ERRORDOWN = "ERROR_down"
1455
INSTST_ALL = frozenset([
1456
  INSTST_RUNNING,
1457
  INSTST_ADMINDOWN,
1458
  INSTST_ADMINOFFLINE,
1459
  INSTST_NODEOFFLINE,
1460
  INSTST_NODEDOWN,
1461
  INSTST_WRONGNODE,
1462
  INSTST_ERRORUP,
1463
  INSTST_ERRORDOWN,
1464
  ])
1465

    
1466
# Admin states
1467
ADMINST_UP = "up"
1468
ADMINST_DOWN = "down"
1469
ADMINST_OFFLINE = "offline"
1470
ADMINST_ALL = frozenset([
1471
  ADMINST_UP,
1472
  ADMINST_DOWN,
1473
  ADMINST_OFFLINE,
1474
  ])
1475

    
1476
# Node roles
1477
NR_REGULAR = "R"
1478
NR_MASTER = "M"
1479
NR_MCANDIDATE = "C"
1480
NR_DRAINED = "D"
1481
NR_OFFLINE = "O"
1482
NR_ALL = frozenset([
1483
  NR_REGULAR,
1484
  NR_MASTER,
1485
  NR_MCANDIDATE,
1486
  NR_DRAINED,
1487
  NR_OFFLINE,
1488
  ])
1489

    
1490
# SSL certificate check constants (in days)
1491
SSL_CERT_EXPIRATION_WARN = 30
1492
SSL_CERT_EXPIRATION_ERROR = 7
1493

    
1494
# Allocator framework constants
1495
IALLOCATOR_VERSION = 2
1496
IALLOCATOR_DIR_IN = "in"
1497
IALLOCATOR_DIR_OUT = "out"
1498
VALID_IALLOCATOR_DIRECTIONS = frozenset([
1499
  IALLOCATOR_DIR_IN,
1500
  IALLOCATOR_DIR_OUT,
1501
  ])
1502
IALLOCATOR_MODE_ALLOC = "allocate"
1503
IALLOCATOR_MODE_RELOC = "relocate"
1504
IALLOCATOR_MODE_CHG_GROUP = "change-group"
1505
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1506
VALID_IALLOCATOR_MODES = frozenset([
1507
  IALLOCATOR_MODE_ALLOC,
1508
  IALLOCATOR_MODE_RELOC,
1509
  IALLOCATOR_MODE_CHG_GROUP,
1510
  IALLOCATOR_MODE_NODE_EVAC,
1511
  ])
1512
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1513

    
1514
IALLOCATOR_NEVAC_PRI = "primary-only"
1515
IALLOCATOR_NEVAC_SEC = "secondary-only"
1516
IALLOCATOR_NEVAC_ALL = "all"
1517
IALLOCATOR_NEVAC_MODES = frozenset([
1518
  IALLOCATOR_NEVAC_PRI,
1519
  IALLOCATOR_NEVAC_SEC,
1520
  IALLOCATOR_NEVAC_ALL,
1521
  ])
1522

    
1523
# Node evacuation
1524
NODE_EVAC_PRI = "primary-only"
1525
NODE_EVAC_SEC = "secondary-only"
1526
NODE_EVAC_ALL = "all"
1527
NODE_EVAC_MODES = frozenset([
1528
  NODE_EVAC_PRI,
1529
  NODE_EVAC_SEC,
1530
  NODE_EVAC_ALL,
1531
  ])
1532

    
1533
# Job queue
1534
JOB_QUEUE_VERSION = 1
1535
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1536
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1537
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1538
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1539
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1540
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1541
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
1542
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
1543

    
1544
JOB_ID_TEMPLATE = r"\d+"
1545
JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1546

    
1547
# unchanged job return
1548
JOB_NOTCHANGED = "nochange"
1549

    
1550
# Job status
1551
JOB_STATUS_QUEUED = "queued"
1552
JOB_STATUS_WAITING = "waiting"
1553
JOB_STATUS_CANCELING = "canceling"
1554
JOB_STATUS_RUNNING = "running"
1555
JOB_STATUS_CANCELED = "canceled"
1556
JOB_STATUS_SUCCESS = "success"
1557
JOB_STATUS_ERROR = "error"
1558
JOBS_FINALIZED = frozenset([
1559
  JOB_STATUS_CANCELED,
1560
  JOB_STATUS_SUCCESS,
1561
  JOB_STATUS_ERROR,
1562
  ])
1563
JOB_STATUS_ALL = frozenset([
1564
  JOB_STATUS_QUEUED,
1565
  JOB_STATUS_WAITING,
1566
  JOB_STATUS_CANCELING,
1567
  JOB_STATUS_RUNNING,
1568
  ]) | JOBS_FINALIZED
1569

    
1570
# OpCode status
1571
# not yet finalized
1572
OP_STATUS_QUEUED = "queued"
1573
OP_STATUS_WAITING = "waiting"
1574
OP_STATUS_CANCELING = "canceling"
1575
OP_STATUS_RUNNING = "running"
1576
# finalized
1577
OP_STATUS_CANCELED = "canceled"
1578
OP_STATUS_SUCCESS = "success"
1579
OP_STATUS_ERROR = "error"
1580
OPS_FINALIZED = frozenset([
1581
  OP_STATUS_CANCELED,
1582
  OP_STATUS_SUCCESS,
1583
  OP_STATUS_ERROR
1584
  ])
1585

    
1586
# OpCode priority
1587
OP_PRIO_LOWEST = +19
1588
OP_PRIO_HIGHEST = -20
1589

    
1590
OP_PRIO_LOW = +10
1591
OP_PRIO_NORMAL = 0
1592
OP_PRIO_HIGH = -10
1593

    
1594
OP_PRIO_SUBMIT_VALID = frozenset([
1595
  OP_PRIO_LOW,
1596
  OP_PRIO_NORMAL,
1597
  OP_PRIO_HIGH,
1598
  ])
1599

    
1600
OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1601

    
1602
# Execution log types
1603
ELOG_MESSAGE = "message"
1604
ELOG_PROGRESS = "progress"
1605
ELOG_REMOTE_IMPORT = "remote-import"
1606
ELOG_JQUEUE_TEST = "jqueue-test"
1607

    
1608
# /etc/hosts modification
1609
ETC_HOSTS_ADD = "add"
1610
ETC_HOSTS_REMOVE = "remove"
1611

    
1612
# Job queue test
1613
JQT_MSGPREFIX = "TESTMSG="
1614
JQT_EXPANDNAMES = "expandnames"
1615
JQT_EXEC = "exec"
1616
JQT_LOGMSG = "logmsg"
1617
JQT_STARTMSG = "startmsg"
1618
JQT_ALL = frozenset([
1619
  JQT_EXPANDNAMES,
1620
  JQT_EXEC,
1621
  JQT_LOGMSG,
1622
  JQT_STARTMSG,
1623
  ])
1624

    
1625
# Query resources
1626
QR_INSTANCE = "instance"
1627
QR_NODE = "node"
1628
QR_LOCK = "lock"
1629
QR_GROUP = "group"
1630
QR_OS = "os"
1631

    
1632
#: List of resources which can be queried using L{opcodes.OpQuery}
1633
QR_VIA_OP = frozenset([QR_INSTANCE, QR_NODE, QR_GROUP, QR_OS])
1634

    
1635
#: List of resources which can be queried using Local UniX Interface
1636
QR_VIA_LUXI = QR_VIA_OP.union([
1637
  QR_LOCK,
1638
  ])
1639

    
1640
#: List of resources which can be queried using RAPI
1641
QR_VIA_RAPI = QR_VIA_LUXI
1642

    
1643
# Query field types
1644
QFT_UNKNOWN = "unknown"
1645
QFT_TEXT = "text"
1646
QFT_BOOL = "bool"
1647
QFT_NUMBER = "number"
1648
QFT_UNIT = "unit"
1649
QFT_TIMESTAMP = "timestamp"
1650
QFT_OTHER = "other"
1651

    
1652
#: All query field types
1653
QFT_ALL = frozenset([
1654
  QFT_UNKNOWN,
1655
  QFT_TEXT,
1656
  QFT_BOOL,
1657
  QFT_NUMBER,
1658
  QFT_UNIT,
1659
  QFT_TIMESTAMP,
1660
  QFT_OTHER,
1661
  ])
1662

    
1663
# Query result field status (don't change or reuse values as they're used by
1664
# clients)
1665
#: Normal field status
1666
RS_NORMAL = 0
1667
#: Unknown field
1668
RS_UNKNOWN = 1
1669
#: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1670
RS_NODATA = 2
1671
#: Value unavailable/unsupported for item; if this field is supported
1672
#: but we cannot get the data for the moment, RS_NODATA or
1673
#: RS_OFFLINE should be used
1674
RS_UNAVAIL = 3
1675
#: Resource marked offline
1676
RS_OFFLINE = 4
1677

    
1678
RS_ALL = frozenset([
1679
  RS_NORMAL,
1680
  RS_UNKNOWN,
1681
  RS_NODATA,
1682
  RS_UNAVAIL,
1683
  RS_OFFLINE,
1684
  ])
1685

    
1686
#: Dictionary with special field cases and their verbose/terse formatting
1687
RSS_DESCRIPTION = {
1688
  RS_UNKNOWN: ("(unknown)", "??"),
1689
  RS_NODATA: ("(nodata)", "?"),
1690
  RS_OFFLINE: ("(offline)", "*"),
1691
  RS_UNAVAIL: ("(unavail)", "-"),
1692
  }
1693

    
1694
# max dynamic devices
1695
MAX_NICS = 8
1696
MAX_DISKS = 16
1697

    
1698
# SSCONF keys
1699
SS_CLUSTER_NAME = "cluster_name"
1700
SS_CLUSTER_TAGS = "cluster_tags"
1701
SS_FILE_STORAGE_DIR = "file_storage_dir"
1702
SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1703
SS_MASTER_CANDIDATES = "master_candidates"
1704
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1705
SS_MASTER_IP = "master_ip"
1706
SS_MASTER_NETDEV = "master_netdev"
1707
SS_MASTER_NETMASK = "master_netmask"
1708
SS_MASTER_NODE = "master_node"
1709
SS_NODE_LIST = "node_list"
1710
SS_NODE_PRIMARY_IPS = "node_primary_ips"
1711
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1712
SS_OFFLINE_NODES = "offline_nodes"
1713
SS_ONLINE_NODES = "online_nodes"
1714
SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1715
SS_INSTANCE_LIST = "instance_list"
1716
SS_RELEASE_VERSION = "release_version"
1717
SS_HYPERVISOR_LIST = "hypervisor_list"
1718
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1719
SS_UID_POOL = "uid_pool"
1720
SS_NODEGROUPS = "nodegroups"
1721

    
1722
SS_FILE_PERMS = 0444
1723

    
1724
# cluster wide default parameters
1725
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1726

    
1727
HVC_DEFAULTS = {
1728
  HT_XEN_PVM: {
1729
    HV_USE_BOOTLOADER: False,
1730
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1731
    HV_BOOTLOADER_ARGS: "",
1732
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1733
    HV_INITRD_PATH: "",
1734
    HV_ROOT_PATH: "/dev/sda1",
1735
    HV_KERNEL_ARGS: "ro",
1736
    HV_MIGRATION_PORT: 8002,
1737
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1738
    HV_BLOCKDEV_PREFIX: "sd",
1739
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1740
    HV_CPU_MASK: CPU_PINNING_ALL,
1741
    },
1742
  HT_XEN_HVM: {
1743
    HV_BOOT_ORDER: "cd",
1744
    HV_CDROM_IMAGE_PATH: "",
1745
    HV_NIC_TYPE: HT_NIC_RTL8139,
1746
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1747
    HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1748
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1749
    HV_ACPI: True,
1750
    HV_PAE: True,
1751
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1752
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1753
    HV_MIGRATION_PORT: 8002,
1754
    HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1755
    HV_USE_LOCALTIME: False,
1756
    HV_BLOCKDEV_PREFIX: "hd",
1757
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1758
    HV_CPU_MASK: CPU_PINNING_ALL,
1759
    },
1760
  HT_KVM: {
1761
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1762
    HV_INITRD_PATH: "",
1763
    HV_KERNEL_ARGS: "ro",
1764
    HV_ROOT_PATH: "/dev/vda1",
1765
    HV_ACPI: True,
1766
    HV_SERIAL_CONSOLE: True,
1767
    HV_VNC_BIND_ADDRESS: "",
1768
    HV_VNC_TLS: False,
1769
    HV_VNC_X509: "",
1770
    HV_VNC_X509_VERIFY: False,
1771
    HV_VNC_PASSWORD_FILE: "",
1772
    HV_KVM_SPICE_BIND: "",
1773
    HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1774
    HV_KVM_SPICE_PASSWORD_FILE: "",
1775
    HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1776
    HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1777
    HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1778
    HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1779
    HV_KVM_SPICE_AUDIO_COMPR: True,
1780
    HV_KVM_SPICE_USE_TLS: False,
1781
    HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1782
    HV_KVM_SPICE_USE_VDAGENT: True,
1783
    HV_KVM_FLOPPY_IMAGE_PATH: "",
1784
    HV_CDROM_IMAGE_PATH: "",
1785
    HV_KVM_CDROM2_IMAGE_PATH: "",
1786
    HV_BOOT_ORDER: HT_BO_DISK,
1787
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1788
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1789
    HV_KVM_CDROM_DISK_TYPE: "",
1790
    HV_USB_MOUSE: "",
1791
    HV_KEYMAP: "",
1792
    HV_MIGRATION_PORT: 8102,
1793
    HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1794
    HV_MIGRATION_DOWNTIME: 30,  # ms
1795
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1796
    HV_USE_LOCALTIME: False,
1797
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
1798
    HV_SECURITY_MODEL: HT_SM_NONE,
1799
    HV_SECURITY_DOMAIN: "",
1800
    HV_KVM_FLAG: "",
1801
    HV_VHOST_NET: False,
1802
    HV_KVM_USE_CHROOT: False,
1803
    HV_MEM_PATH: "",
1804
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1805
    HV_CPU_MASK: CPU_PINNING_ALL,
1806
    },
1807
  HT_FAKE: {
1808
    },
1809
  HT_CHROOT: {
1810
    HV_INIT_SCRIPT: "/ganeti-chroot",
1811
    },
1812
  HT_LXC: {
1813
    HV_CPU_MASK: "",
1814
    },
1815
  }
1816

    
1817
HVC_GLOBALS = frozenset([
1818
  HV_MIGRATION_PORT,
1819
  HV_MIGRATION_BANDWIDTH,
1820
  HV_MIGRATION_MODE,
1821
  ])
1822

    
1823
BEC_DEFAULTS = {
1824
  BE_MINMEM: 128,
1825
  BE_MAXMEM: 128,
1826
  BE_VCPUS: 1,
1827
  BE_AUTO_BALANCE: True,
1828
  BE_ALWAYS_FAILOVER: False,
1829
  BE_SPINDLE_USE: 1,
1830
  }
1831

    
1832
NDC_DEFAULTS = {
1833
  ND_OOB_PROGRAM: None,
1834
  ND_SPINDLE_COUNT: 1,
1835
  }
1836

    
1837
DISK_LD_DEFAULTS = {
1838
  LD_DRBD8: {
1839
    LDP_RESYNC_RATE: CLASSIC_DRBD_SYNC_SPEED,
1840
    LDP_BARRIERS: _autoconf.DRBD_BARRIERS,
1841
    LDP_NO_META_FLUSH: _autoconf.DRBD_NO_META_FLUSH,
1842
    LDP_DEFAULT_METAVG: DEFAULT_VG,
1843
    LDP_DISK_CUSTOM: "",
1844
    LDP_NET_CUSTOM: "",
1845
    LDP_DYNAMIC_RESYNC: False,
1846

    
1847
    # The default values for the DRBD dynamic resync speed algorithm are taken
1848
    # from the drbsetup 8.3.11 man page, except for c-plan-ahead (that we
1849
    # don't need to set to 0, because we have a separate option to enable it)
1850
    # and for c-max-rate, that we cap to the default value for the static resync
1851
    # rate.
1852
    LDP_PLAN_AHEAD: 20, # ds
1853
    LDP_FILL_TARGET: 0, # sectors
1854
    LDP_DELAY_TARGET: 1, # ds
1855
    LDP_MAX_RATE: CLASSIC_DRBD_SYNC_SPEED, # KiB/s
1856
    LDP_MIN_RATE: 4 * 1024, # KiB/s
1857
    },
1858
  LD_LV: {
1859
    LDP_STRIPES: _autoconf.LVM_STRIPECOUNT
1860
    },
1861
  LD_FILE: {
1862
    },
1863
  LD_BLOCKDEV: {
1864
    },
1865
  LD_RBD: {
1866
    LDP_POOL: "rbd"
1867
    },
1868
  }
1869

    
1870
# readability shortcuts
1871
_LV_DEFAULTS = DISK_LD_DEFAULTS[LD_LV]
1872
_DRBD_DEFAULTS = DISK_LD_DEFAULTS[LD_DRBD8]
1873

    
1874
DISK_DT_DEFAULTS = {
1875
  DT_PLAIN: {
1876
    LV_STRIPES: DISK_LD_DEFAULTS[LD_LV][LDP_STRIPES],
1877
    },
1878
  DT_DRBD8: {
1879
    DRBD_RESYNC_RATE: _DRBD_DEFAULTS[LDP_RESYNC_RATE],
1880
    DRBD_DATA_STRIPES: _LV_DEFAULTS[LDP_STRIPES],
1881
    DRBD_META_STRIPES: _LV_DEFAULTS[LDP_STRIPES],
1882
    DRBD_DISK_BARRIERS: _DRBD_DEFAULTS[LDP_BARRIERS],
1883
    DRBD_META_BARRIERS: _DRBD_DEFAULTS[LDP_NO_META_FLUSH],
1884
    DRBD_DEFAULT_METAVG: _DRBD_DEFAULTS[LDP_DEFAULT_METAVG],
1885
    DRBD_DISK_CUSTOM: _DRBD_DEFAULTS[LDP_DISK_CUSTOM],
1886
    DRBD_NET_CUSTOM: _DRBD_DEFAULTS[LDP_NET_CUSTOM],
1887
    DRBD_DYNAMIC_RESYNC: _DRBD_DEFAULTS[LDP_DYNAMIC_RESYNC],
1888
    DRBD_PLAN_AHEAD: _DRBD_DEFAULTS[LDP_PLAN_AHEAD],
1889
    DRBD_FILL_TARGET: _DRBD_DEFAULTS[LDP_FILL_TARGET],
1890
    DRBD_DELAY_TARGET: _DRBD_DEFAULTS[LDP_DELAY_TARGET],
1891
    DRBD_MAX_RATE: _DRBD_DEFAULTS[LDP_MAX_RATE],
1892
    DRBD_MIN_RATE: _DRBD_DEFAULTS[LDP_MIN_RATE],
1893
    },
1894
  DT_DISKLESS: {
1895
    },
1896
  DT_FILE: {
1897
    },
1898
  DT_SHARED_FILE: {
1899
    },
1900
  DT_BLOCK: {
1901
    },
1902
  DT_RBD: {
1903
    RBD_POOL: DISK_LD_DEFAULTS[LD_RBD][LDP_POOL]
1904
    },
1905
  }
1906

    
1907
# we don't want to export the shortcuts
1908
del _LV_DEFAULTS, _DRBD_DEFAULTS
1909

    
1910
NICC_DEFAULTS = {
1911
  NIC_MODE: NIC_MODE_BRIDGED,
1912
  NIC_LINK: DEFAULT_BRIDGE,
1913
  }
1914

    
1915
# All of the following values are quite arbitrarily - there are no
1916
# "good" defaults, these must be customised per-site
1917
IPOLICY_DEFAULTS = {
1918
  ISPECS_MIN: {
1919
    ISPEC_MEM_SIZE: 128,
1920
    ISPEC_CPU_COUNT: 1,
1921
    ISPEC_DISK_COUNT: 1,
1922
    ISPEC_DISK_SIZE: 1024,
1923
    ISPEC_NIC_COUNT: 1,
1924
    ISPEC_SPINDLE_USE: 1,
1925
    },
1926
  ISPECS_MAX: {
1927
    ISPEC_MEM_SIZE: 32768,
1928
    ISPEC_CPU_COUNT: 8,
1929
    ISPEC_DISK_COUNT: MAX_DISKS,
1930
    ISPEC_DISK_SIZE: 1024 * 1024,
1931
    ISPEC_NIC_COUNT: MAX_NICS,
1932
    ISPEC_SPINDLE_USE: 12,
1933
    },
1934
  ISPECS_STD: {
1935
    ISPEC_MEM_SIZE: 128,
1936
    ISPEC_CPU_COUNT: 1,
1937
    ISPEC_DISK_COUNT: 1,
1938
    ISPEC_DISK_SIZE: 1024,
1939
    ISPEC_NIC_COUNT: 1,
1940
    ISPEC_SPINDLE_USE: 1,
1941
    },
1942
  IPOLICY_DTS: DISK_TEMPLATES,
1943
  IPOLICY_VCPU_RATIO: 4.0,
1944
  IPOLICY_SPINDLE_RATIO: 32.0,
1945
  }
1946

    
1947
MASTER_POOL_SIZE_DEFAULT = 10
1948

    
1949
CONFD_PROTOCOL_VERSION = 1
1950

    
1951
CONFD_REQ_PING = 0
1952
CONFD_REQ_NODE_ROLE_BYNAME = 1
1953
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1954
CONFD_REQ_CLUSTER_MASTER = 3
1955
CONFD_REQ_NODE_PIP_LIST = 4
1956
CONFD_REQ_MC_PIP_LIST = 5
1957
CONFD_REQ_INSTANCES_IPS_LIST = 6
1958

    
1959
# Confd request query fields. These are used to narrow down queries.
1960
# These must be strings rather than integers, because json-encoding
1961
# converts them to strings anyway, as they're used as dict-keys.
1962
CONFD_REQQ_LINK = "0"
1963
CONFD_REQQ_IP = "1"
1964
CONFD_REQQ_IPLIST = "2"
1965
CONFD_REQQ_FIELDS = "3"
1966

    
1967
CONFD_REQFIELD_NAME = "0"
1968
CONFD_REQFIELD_IP = "1"
1969
CONFD_REQFIELD_MNODE_PIP = "2"
1970

    
1971
CONFD_REQS = frozenset([
1972
  CONFD_REQ_PING,
1973
  CONFD_REQ_NODE_ROLE_BYNAME,
1974
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1975
  CONFD_REQ_CLUSTER_MASTER,
1976
  CONFD_REQ_NODE_PIP_LIST,
1977
  CONFD_REQ_MC_PIP_LIST,
1978
  CONFD_REQ_INSTANCES_IPS_LIST,
1979
  ])
1980

    
1981
CONFD_REPL_STATUS_OK = 0
1982
CONFD_REPL_STATUS_ERROR = 1
1983
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1984

    
1985
CONFD_REPL_STATUSES = frozenset([
1986
  CONFD_REPL_STATUS_OK,
1987
  CONFD_REPL_STATUS_ERROR,
1988
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
1989
  ])
1990

    
1991
(CONFD_NODE_ROLE_MASTER,
1992
 CONFD_NODE_ROLE_CANDIDATE,
1993
 CONFD_NODE_ROLE_OFFLINE,
1994
 CONFD_NODE_ROLE_DRAINED,
1995
 CONFD_NODE_ROLE_REGULAR,
1996
 ) = range(5)
1997

    
1998
# A few common errors for confd
1999
CONFD_ERROR_UNKNOWN_ENTRY = 1
2000
CONFD_ERROR_INTERNAL = 2
2001
CONFD_ERROR_ARGUMENT = 3
2002

    
2003
# Each request is "salted" by the current timestamp.
2004
# This constants decides how many seconds of skew to accept.
2005
# TODO: make this a default and allow the value to be more configurable
2006
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
2007

    
2008
# When we haven't reloaded the config for more than this amount of seconds, we
2009
# force a test to see if inotify is betraying us.
2010
CONFD_CONFIG_RELOAD_TIMEOUT = 60
2011

    
2012
# If we receive more than one update in this amount of seconds, we move to
2013
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
2014
# to serve more requests.
2015
CONFD_CONFIG_RELOAD_RATELIMIT = 2
2016

    
2017
# Magic number prepended to all confd queries.
2018
# This allows us to distinguish different types of confd protocols and handle
2019
# them. For example by changing this we can move the whole payload to be
2020
# compressed, or move away from json.
2021
CONFD_MAGIC_FOURCC = "plj0"
2022

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

    
2028
# Timeout in seconds to expire pending query request in the confd client
2029
# library. We don't actually expect any answer more than 10 seconds after we
2030
# sent a request.
2031
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
2032

    
2033
# Maximum UDP datagram size.
2034
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
2035
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
2036
#   (assuming we can't use jumbo frames)
2037
# We just set this to 60K, which should be enough
2038
MAX_UDP_DATA_SIZE = 61440
2039

    
2040
# User-id pool minimum/maximum acceptable user-ids.
2041
UIDPOOL_UID_MIN = 0
2042
UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
2043

    
2044
# Name or path of the pgrep command
2045
PGREP = "pgrep"
2046

    
2047
# Name of the node group that gets created at cluster init or upgrade
2048
INITIAL_NODE_GROUP_NAME = "default"
2049

    
2050
# Possible values for NodeGroup.alloc_policy
2051
ALLOC_POLICY_PREFERRED = "preferred"
2052
ALLOC_POLICY_LAST_RESORT = "last_resort"
2053
ALLOC_POLICY_UNALLOCABLE = "unallocable"
2054
VALID_ALLOC_POLICIES = [
2055
  ALLOC_POLICY_PREFERRED,
2056
  ALLOC_POLICY_LAST_RESORT,
2057
  ALLOC_POLICY_UNALLOCABLE,
2058
  ]
2059

    
2060
# Temporary external/shared storage parameters
2061
BLOCKDEV_DRIVER_MANUAL = "manual"
2062

    
2063
# qemu-img path, required for ovfconverter
2064
QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
2065

    
2066
# Whether htools was enabled at compilation time
2067
HTOOLS = _autoconf.HTOOLS
2068
# The hail iallocator
2069
IALLOC_HAIL = "hail"
2070

    
2071
# Fake opcodes for functions that have hooks attached to them via
2072
# backend.RunLocalHooks
2073
FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
2074
FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
2075

    
2076
# Do not re-export imported modules
2077
del re, _vcsversion, _autoconf