Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 0625d08f

History | View | Annotate | Download (54.8 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
XM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/xm-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

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

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

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

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

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

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

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

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

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

    
227
FIRST_DRBD_PORT = 11000
228
LAST_DRBD_PORT = 14999
229

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

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

    
247
DEV_CONSOLE = "/dev/console"
248

    
249
PROC_MOUNTS = "/proc/mounts"
250

    
251
# Local UniX Interface related constants
252
LUXI_EOM = "\3"
253
LUXI_VERSION = CONFIG_VERSION
254

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

    
262
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
263
EXPORT_DIR = _autoconf.EXPORT_DIR
264

    
265
EXPORT_CONF_FILE = "config.ini"
266

    
267
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
268
XEN_KERNEL = _autoconf.XEN_KERNEL
269
XEN_INITRD = _autoconf.XEN_INITRD
270
XEN_CMD_XM = "xm"
271
XEN_CMD_XL = "xl"
272
# FIXME: This will be made configurable using hvparams in Ganeti 2.7
273
XEN_CMD = _autoconf.XEN_CMD
274

    
275
KVM_PATH = _autoconf.KVM_PATH
276
KVM_KERNEL = _autoconf.KVM_KERNEL
277
SOCAT_PATH = _autoconf.SOCAT_PATH
278
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
279
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
280
SOCAT_ESCAPE_CODE = "0x1d"
281

    
282
#: Console as SSH command
283
CONS_SSH = "ssh"
284

    
285
#: Console as VNC server
286
CONS_VNC = "vnc"
287

    
288
#: Console as SPICE server
289
CONS_SPICE = "spice"
290

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

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

    
297
# For RSA keys more bits are better, but they also make operations more
298
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
299
# 2010 on.
300
RSA_KEY_BITS = 2048
301

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

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

    
313
# Default validity of certificates in days
314
X509_CERT_DEFAULT_VALIDITY = 365 * 5
315

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

    
319
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
320

    
321
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
322

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

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

    
335
IE_CUSTOM_SIZE = "fd"
336

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

    
339
# Import/export I/O
340
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
341
IEIO_FILE = "file"
342
# Raw block device I/O using "dd"
343
IEIO_RAW_DISK = "raw"
344
# OS definition import/export script
345
IEIO_SCRIPT = "script"
346

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

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

    
357
# hooks-related constants
358
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
359
HOOKS_PHASE_PRE = "pre"
360
HOOKS_PHASE_POST = "post"
361
HOOKS_NAME_CFGUPDATE = "config-update"
362
HOOKS_NAME_WATCHER = "watcher"
363
HOOKS_VERSION = 2
364
HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
365

    
366
# hooks subject type (what object type does the LU deal with)
367
HTYPE_CLUSTER = "CLUSTER"
368
HTYPE_NODE = "NODE"
369
HTYPE_GROUP = "GROUP"
370
HTYPE_INSTANCE = "INSTANCE"
371

    
372
HKR_SKIP = 0
373
HKR_FAIL = 1
374
HKR_SUCCESS = 2
375

    
376
# Storage types
377
ST_FILE = "file"
378
ST_LVM_PV = "lvm-pv"
379
ST_LVM_VG = "lvm-vg"
380

    
381
# Storage fields
382
# first two are valid in LU context only, not passed to backend
383
SF_NODE = "node"
384
SF_TYPE = "type"
385
# and the rest are valid in backend
386
SF_NAME = "name"
387
SF_SIZE = "size"
388
SF_FREE = "free"
389
SF_USED = "used"
390
SF_ALLOCATABLE = "allocatable"
391

    
392
# Storage operations
393
SO_FIX_CONSISTENCY = "fix-consistency"
394

    
395
# Available fields per storage type
396
VALID_STORAGE_FIELDS = frozenset([
397
  SF_NAME,
398
  SF_TYPE,
399
  SF_SIZE,
400
  SF_USED,
401
  SF_FREE,
402
  SF_ALLOCATABLE
403
  ])
404

    
405
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
406

    
407
MODIFIABLE_STORAGE_FIELDS = {
408
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
409
  }
410

    
411
VALID_STORAGE_OPERATIONS = {
412
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
413
  }
414

    
415
# Local disk status
416
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
417
(LDS_OKAY,
418
 LDS_UNKNOWN,
419
 LDS_FAULTY) = range(1, 4)
420

    
421
# disk template types
422
DT_DISKLESS = "diskless"
423
DT_PLAIN = "plain"
424
DT_DRBD8 = "drbd"
425
DT_FILE = "file"
426
DT_SHARED_FILE = "sharedfile"
427
DT_BLOCK = "blockdev"
428
DT_RBD = "rbd"
429

    
430
# the set of network-mirrored disk templates
431
DTS_INT_MIRROR = frozenset([DT_DRBD8])
432

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

    
436
# the set of non-lvm-based disk templates
437
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE,
438
                         DT_BLOCK, DT_RBD])
439

    
440
# the set of disk templates which can be grown
441
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE, DT_RBD])
442

    
443
# the set of disk templates that allow adoption
444
DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])
445

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

    
449
# the set of disk templates that allow migrations
450
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
451

    
452
# the set of file based disk templates
453
DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
454

    
455
# logical disk types
456
LD_LV = "lvm"
457
LD_DRBD8 = "drbd8"
458
LD_FILE = "file"
459
LD_BLOCKDEV = "blockdev"
460
LD_RBD = "rbd"
461
LOGICAL_DISK_TYPES = frozenset([
462
  LD_LV,
463
  LD_DRBD8,
464
  LD_FILE,
465
  LD_BLOCKDEV,
466
  LD_RBD,
467
  ])
468

    
469
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV, LD_RBD])
470

    
471
# drbd constants
472
DRBD_HMAC_ALG = "md5"
473
DRBD_NET_PROTOCOL = "C"
474

    
475
# drbd barrier types
476
DRBD_B_NONE = "n"
477
DRBD_B_DISK_BARRIERS = "b"
478
DRBD_B_DISK_DRAIN = "d"
479
DRBD_B_DISK_FLUSH = "f"
480

    
481
# Valid barrier combinations: "n" or any non-null subset of "bfd"
482
DRBD_VALID_BARRIER_OPT = frozenset([
483
  frozenset([DRBD_B_NONE]),
484
  frozenset([DRBD_B_DISK_BARRIERS]),
485
  frozenset([DRBD_B_DISK_DRAIN]),
486
  frozenset([DRBD_B_DISK_FLUSH]),
487
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
488
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
489
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_DRAIN]),
490
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH]),
491
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH, DRBD_B_DISK_DRAIN]),
492
  ])
493

    
494
# rbd tool command
495
RBD_CMD = "rbd"
496

    
497
# file backend driver
498
FD_LOOP = "loop"
499
FD_BLKTAP = "blktap"
500

    
501
# the set of drbd-like disk types
502
LDS_DRBD = frozenset([LD_DRBD8])
503

    
504
# disk access mode
505
DISK_RDONLY = "ro"
506
DISK_RDWR = "rw"
507
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
508

    
509
# disk replacement mode
510
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
511
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
512
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
513
REPLACE_DISK_AUTO = "replace_auto"
514
REPLACE_MODES = frozenset([
515
  REPLACE_DISK_PRI,
516
  REPLACE_DISK_SEC,
517
  REPLACE_DISK_CHG,
518
  REPLACE_DISK_AUTO,
519
  ])
520

    
521
# Instance export mode
522
EXPORT_MODE_LOCAL = "local"
523
EXPORT_MODE_REMOTE = "remote"
524
EXPORT_MODES = frozenset([
525
  EXPORT_MODE_LOCAL,
526
  EXPORT_MODE_REMOTE,
527
  ])
528

    
529
# instance creation modes
530
INSTANCE_CREATE = "create"
531
INSTANCE_IMPORT = "import"
532
INSTANCE_REMOTE_IMPORT = "remote-import"
533
INSTANCE_CREATE_MODES = frozenset([
534
  INSTANCE_CREATE,
535
  INSTANCE_IMPORT,
536
  INSTANCE_REMOTE_IMPORT,
537
  ])
538

    
539
# Remote import/export handshake message and version
540
RIE_VERSION = 0
541
RIE_HANDSHAKE = "Hi, I'm Ganeti"
542

    
543
# Remote import/export certificate validity in seconds
544
RIE_CERT_VALIDITY = 24 * 60 * 60
545

    
546
# Overall timeout for establishing connection
547
RIE_CONNECT_TIMEOUT = 180
548

    
549
# Export only: how long to wait per connection attempt (seconds)
550
RIE_CONNECT_ATTEMPT_TIMEOUT = 20
551

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

    
555
#: Give child process up to 5 seconds to exit after sending a signal
556
CHILD_LINGER_TIMEOUT = 5.0
557

    
558
DISK_TEMPLATES = frozenset([
559
  DT_DISKLESS,
560
  DT_PLAIN,
561
  DT_DRBD8,
562
  DT_FILE,
563
  DT_SHARED_FILE,
564
  DT_BLOCK,
565
  DT_RBD
566
  ])
567

    
568
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
569

    
570
# import/export config options
571
INISECT_EXP = "export"
572
INISECT_INS = "instance"
573
INISECT_HYP = "hypervisor"
574
INISECT_BEP = "backend"
575
INISECT_OSP = "os"
576

    
577
# dynamic device modification
578
DDM_ADD = "add"
579
DDM_MODIFY = "modify"
580
DDM_REMOVE = "remove"
581
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
582
DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
583
  DDM_MODIFY,
584
  ]))
585
# TODO: DDM_SWAP, DDM_MOVE?
586

    
587
# common exit codes
588
EXIT_SUCCESS = 0
589
EXIT_FAILURE = 1
590
EXIT_NOTCLUSTER = 5
591
EXIT_NOTMASTER = 11
592
EXIT_NODESETUP_ERROR = 12
593
EXIT_CONFIRMATION = 13 # need user confirmation
594

    
595
#: Exit code for query operations with unknown fields
596
EXIT_UNKNOWN_FIELD = 14
597

    
598
# tags
599
TAG_CLUSTER = "cluster"
600
TAG_NODEGROUP = "nodegroup"
601
TAG_NODE = "node"
602
TAG_INSTANCE = "instance"
603
VALID_TAG_TYPES = frozenset([
604
  TAG_CLUSTER,
605
  TAG_NODEGROUP,
606
  TAG_NODE,
607
  TAG_INSTANCE,
608
  ])
609
MAX_TAG_LEN = 128
610
MAX_TAGS_PER_OBJ = 4096
611

    
612
# others
613
DEFAULT_BRIDGE = "xen-br0"
614
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
615
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
616
IP4_ADDRESS_ANY = "0.0.0.0"
617
IP6_ADDRESS_LOCALHOST = "::1"
618
IP6_ADDRESS_ANY = "::"
619
IP4_VERSION = 4
620
IP6_VERSION = 6
621
VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
622
# for export to htools
623
IP4_FAMILY = socket.AF_INET
624
IP6_FAMILY = socket.AF_INET6
625

    
626
TCP_PING_TIMEOUT = 10
627
GANETI_RUNAS = "root"
628
DEFAULT_VG = "xenvg"
629
DEFAULT_DRBD_HELPER = "/bin/true"
630
MIN_VG_SIZE = 20480
631
DEFAULT_MAC_PREFIX = "aa:00:00"
632
# default maximum instance wait time, in seconds.
633
DEFAULT_SHUTDOWN_TIMEOUT = 120
634
NODE_MAX_CLOCK_SKEW = 150
635
# Time for an intra-cluster disk transfer to wait for a connection
636
DISK_TRANSFER_CONNECT_TIMEOUT = 60
637
# Disk index separator
638
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
639
IP_COMMAND_PATH = _autoconf.IP_PATH
640

    
641
#: Key for job IDs in opcode result
642
JOB_IDS_KEY = "jobs"
643

    
644
# runparts results
645
(RUNPARTS_SKIP,
646
 RUNPARTS_RUN,
647
 RUNPARTS_ERR) = range(3)
648

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

    
651
# RPC constants
652
(RPC_ENCODING_NONE,
653
 RPC_ENCODING_ZLIB_BASE64) = range(2)
654

    
655
# os related constants
656
OS_SCRIPT_CREATE = "create"
657
OS_SCRIPT_IMPORT = "import"
658
OS_SCRIPT_EXPORT = "export"
659
OS_SCRIPT_RENAME = "rename"
660
OS_SCRIPT_VERIFY = "verify"
661
OS_SCRIPTS = frozenset([
662
  OS_SCRIPT_CREATE,
663
  OS_SCRIPT_IMPORT,
664
  OS_SCRIPT_EXPORT,
665
  OS_SCRIPT_RENAME,
666
  OS_SCRIPT_VERIFY
667
  ])
668

    
669
OS_API_FILE = "ganeti_api_version"
670
OS_VARIANTS_FILE = "variants.list"
671
OS_PARAMETERS_FILE = "parameters.list"
672

    
673
OS_VALIDATE_PARAMETERS = "parameters"
674
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
675

    
676
# ssh constants
677
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
678
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
679
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
680
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
681
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
682
SSH = "ssh"
683
SCP = "scp"
684

    
685
# reboot types
686
INSTANCE_REBOOT_SOFT = "soft"
687
INSTANCE_REBOOT_HARD = "hard"
688
INSTANCE_REBOOT_FULL = "full"
689

    
690
REBOOT_TYPES = frozenset([
691
  INSTANCE_REBOOT_SOFT,
692
  INSTANCE_REBOOT_HARD,
693
  INSTANCE_REBOOT_FULL
694
  ])
695

    
696
# instance reboot behaviors
697
INSTANCE_REBOOT_ALLOWED = "reboot"
698
INSTANCE_REBOOT_EXIT = "exit"
699

    
700
REBOOT_BEHAVIORS = frozenset([
701
  INSTANCE_REBOOT_ALLOWED,
702
  INSTANCE_REBOOT_EXIT
703
  ])
704

    
705
VTYPE_STRING = "string"
706
VTYPE_MAYBE_STRING = "maybe-string"
707
VTYPE_BOOL = "bool"
708
VTYPE_SIZE = "size" # size, in MiBs
709
VTYPE_INT = "int"
710
ENFORCEABLE_TYPES = frozenset([
711
  VTYPE_STRING,
712
  VTYPE_MAYBE_STRING,
713
  VTYPE_BOOL,
714
  VTYPE_SIZE,
715
  VTYPE_INT,
716
  ])
717

    
718
# Constant representing that the user does not specify any IP version
719
IFACE_NO_IP_VERSION_SPECIFIED = 0
720

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

    
775
HVS_PARAMETER_TYPES = {
776
  HV_BOOT_ORDER: VTYPE_STRING,
777
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
778
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
779
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
780
  HV_NIC_TYPE: VTYPE_STRING,
781
  HV_DISK_TYPE: VTYPE_STRING,
782
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
783
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
784
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
785
  HV_VNC_TLS: VTYPE_BOOL,
786
  HV_VNC_X509: VTYPE_STRING,
787
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
788
  HV_KVM_SPICE_BIND: VTYPE_STRING,
789
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
790
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
791
  HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
792
  HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
793
  HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
794
  HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
795
  HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
796
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
797
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
798
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
799
  HV_ACPI: VTYPE_BOOL,
800
  HV_PAE: VTYPE_BOOL,
801
  HV_USE_BOOTLOADER: VTYPE_BOOL,
802
  HV_BOOTLOADER_PATH: VTYPE_STRING,
803
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
804
  HV_KERNEL_PATH: VTYPE_STRING,
805
  HV_KERNEL_ARGS: VTYPE_STRING,
806
  HV_INITRD_PATH: VTYPE_STRING,
807
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
808
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
809
  HV_USB_MOUSE: VTYPE_STRING,
810
  HV_KEYMAP: VTYPE_STRING,
811
  HV_DEVICE_MODEL: VTYPE_STRING,
812
  HV_INIT_SCRIPT: VTYPE_STRING,
813
  HV_MIGRATION_PORT: VTYPE_INT,
814
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
815
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
816
  HV_MIGRATION_MODE: VTYPE_STRING,
817
  HV_USE_LOCALTIME: VTYPE_BOOL,
818
  HV_DISK_CACHE: VTYPE_STRING,
819
  HV_SECURITY_MODEL: VTYPE_STRING,
820
  HV_SECURITY_DOMAIN: VTYPE_STRING,
821
  HV_KVM_FLAG: VTYPE_STRING,
822
  HV_VHOST_NET: VTYPE_BOOL,
823
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
824
  HV_CPU_MASK: VTYPE_STRING,
825
  HV_MEM_PATH: VTYPE_STRING,
826
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
827
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
828
  }
829

    
830
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
831

    
832
# Migration statuses
833
HV_MIGRATION_COMPLETED = "completed"
834
HV_MIGRATION_ACTIVE = "active"
835
HV_MIGRATION_FAILED = "failed"
836
HV_MIGRATION_CANCELLED = "cancelled"
837

    
838
HV_MIGRATION_VALID_STATUSES = frozenset([
839
  HV_MIGRATION_COMPLETED,
840
  HV_MIGRATION_ACTIVE,
841
  HV_MIGRATION_FAILED,
842
  HV_MIGRATION_CANCELLED,
843
  ])
844

    
845
HV_MIGRATION_FAILED_STATUSES = frozenset([
846
  HV_MIGRATION_FAILED,
847
  HV_MIGRATION_CANCELLED,
848
  ])
849

    
850
# KVM-specific statuses
851
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
852

    
853
# Node info keys
854
HV_NODEINFO_KEY_VERSION = "hv_version"
855

    
856
# Hypervisor state
857
HVST_MEMORY_TOTAL = "mem_total"
858
HVST_MEMORY_NODE = "mem_node"
859
HVST_MEMORY_HV = "mem_hv"
860
HVST_CPU_TOTAL = "cpu_total"
861
HVST_CPU_NODE = "cpu_node"
862

    
863
HVST_DEFAULTS = {
864
  HVST_MEMORY_TOTAL: 0,
865
  HVST_MEMORY_NODE: 0,
866
  HVST_MEMORY_HV: 0,
867
  HVST_CPU_TOTAL: 1,
868
  HVST_CPU_NODE: 1,
869
  }
870

    
871
HVSTS_PARAMETER_TYPES = {
872
  HVST_MEMORY_TOTAL: VTYPE_INT,
873
  HVST_MEMORY_NODE: VTYPE_INT,
874
  HVST_MEMORY_HV: VTYPE_INT,
875
  HVST_CPU_TOTAL: VTYPE_INT,
876
  HVST_CPU_NODE: VTYPE_INT,
877
  }
878

    
879
HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
880

    
881
# Disk state
882
DS_DISK_TOTAL = "disk_total"
883
DS_DISK_RESERVED = "disk_reserved"
884
DS_DISK_OVERHEAD = "disk_overhead"
885

    
886
DS_DEFAULTS = {
887
  DS_DISK_TOTAL: 0,
888
  DS_DISK_RESERVED: 0,
889
  DS_DISK_OVERHEAD: 0,
890
  }
891

    
892
DSS_PARAMETER_TYPES = {
893
  DS_DISK_TOTAL: VTYPE_INT,
894
  DS_DISK_RESERVED: VTYPE_INT,
895
  DS_DISK_OVERHEAD: VTYPE_INT,
896
  }
897

    
898
DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
899
DS_VALID_TYPES = frozenset([LD_LV])
900

    
901
# Backend parameter names
902
BE_MEMORY = "memory" # deprecated and replaced by max and min mem
903
BE_MAXMEM = "maxmem"
904
BE_MINMEM = "minmem"
905
BE_VCPUS = "vcpus"
906
BE_AUTO_BALANCE = "auto_balance"
907
BE_ALWAYS_FAILOVER = "always_failover"
908
BE_SPINDLE_USE = "spindle_use"
909

    
910
BES_PARAMETER_TYPES = {
911
  BE_MAXMEM: VTYPE_SIZE,
912
  BE_MINMEM: VTYPE_SIZE,
913
  BE_VCPUS: VTYPE_INT,
914
  BE_AUTO_BALANCE: VTYPE_BOOL,
915
  BE_ALWAYS_FAILOVER: VTYPE_BOOL,
916
  BE_SPINDLE_USE: VTYPE_INT,
917
  }
918

    
919
BES_PARAMETER_COMPAT = {
920
  BE_MEMORY: VTYPE_SIZE,
921
  }
922
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)
923

    
924
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
925

    
926
# instance specs
927
ISPEC_MEM_SIZE = "memory-size"
928
ISPEC_CPU_COUNT = "cpu-count"
929
ISPEC_DISK_COUNT = "disk-count"
930
ISPEC_DISK_SIZE = "disk-size"
931
ISPEC_NIC_COUNT = "nic-count"
932
ISPEC_SPINDLE_USE = "spindle-use"
933

    
934
ISPECS_PARAMETER_TYPES = {
935
  ISPEC_MEM_SIZE: VTYPE_INT,
936
  ISPEC_CPU_COUNT: VTYPE_INT,
937
  ISPEC_DISK_COUNT: VTYPE_INT,
938
  ISPEC_DISK_SIZE: VTYPE_INT,
939
  ISPEC_NIC_COUNT: VTYPE_INT,
940
  ISPEC_SPINDLE_USE: VTYPE_INT,
941
  }
942

    
943
ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())
944

    
945
ISPECS_MIN = "min"
946
ISPECS_MAX = "max"
947
ISPECS_STD = "std"
948
IPOLICY_DTS = "disk-templates"
949
IPOLICY_VCPU_RATIO = "vcpu-ratio"
950
IPOLICY_SPINDLE_RATIO = "spindle-ratio"
951

    
952
IPOLICY_ISPECS = frozenset([
953
  ISPECS_MIN,
954
  ISPECS_MAX,
955
  ISPECS_STD,
956
  ])
957

    
958
IPOLICY_PARAMETERS = frozenset([
959
  IPOLICY_VCPU_RATIO,
960
  IPOLICY_SPINDLE_RATIO,
961
  ])
962

    
963
IPOLICY_ALL_KEYS = (IPOLICY_ISPECS |
964
                    IPOLICY_PARAMETERS |
965
                    frozenset([IPOLICY_DTS]))
966

    
967
# Node parameter names
968
ND_OOB_PROGRAM = "oob_program"
969
ND_SPINDLE_COUNT = "spindle_count"
970

    
971
NDS_PARAMETER_TYPES = {
972
  ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
973
  ND_SPINDLE_COUNT: VTYPE_INT,
974
  }
975

    
976
NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
977

    
978
# Logical Disks parameters
979
LDP_RESYNC_RATE = "resync-rate"
980
LDP_STRIPES = "stripes"
981
LDP_BARRIERS = "disabled-barriers"
982
LDP_NO_META_FLUSH = "disable-meta-flush"
983
LDP_DEFAULT_METAVG = "default-metavg"
984
LDP_DISK_CUSTOM = "disk-custom"
985
LDP_NET_CUSTOM = "net-custom"
986
LDP_DYNAMIC_RESYNC = "dynamic-resync"
987
LDP_PLAN_AHEAD = "c-plan-ahead"
988
LDP_FILL_TARGET = "c-fill-target"
989
LDP_DELAY_TARGET = "c-delay-target"
990
LDP_MAX_RATE = "c-max-rate"
991
LDP_MIN_RATE = "c-min-rate"
992
LDP_POOL = "pool"
993
DISK_LD_TYPES = {
994
  LDP_RESYNC_RATE: VTYPE_INT,
995
  LDP_STRIPES: VTYPE_INT,
996
  LDP_BARRIERS: VTYPE_STRING,
997
  LDP_NO_META_FLUSH: VTYPE_BOOL,
998
  LDP_DEFAULT_METAVG: VTYPE_STRING,
999
  LDP_DISK_CUSTOM: VTYPE_STRING,
1000
  LDP_NET_CUSTOM: VTYPE_STRING,
1001
  LDP_DYNAMIC_RESYNC: VTYPE_BOOL,
1002
  LDP_PLAN_AHEAD: VTYPE_INT,
1003
  LDP_FILL_TARGET: VTYPE_INT,
1004
  LDP_DELAY_TARGET: VTYPE_INT,
1005
  LDP_MAX_RATE: VTYPE_INT,
1006
  LDP_MIN_RATE: VTYPE_INT,
1007
  LDP_POOL: VTYPE_STRING,
1008
  }
1009
DISK_LD_PARAMETERS = frozenset(DISK_LD_TYPES.keys())
1010

    
1011
# Disk template parameters (can be set/changed by the user via gnt-cluster and
1012
# gnt-group)
1013
DRBD_RESYNC_RATE = "resync-rate"
1014
DRBD_DATA_STRIPES = "data-stripes"
1015
DRBD_META_STRIPES = "meta-stripes"
1016
DRBD_DISK_BARRIERS = "disk-barriers"
1017
DRBD_META_BARRIERS = "meta-barriers"
1018
DRBD_DEFAULT_METAVG = "metavg"
1019
DRBD_DISK_CUSTOM = "disk-custom"
1020
DRBD_NET_CUSTOM = "net-custom"
1021
DRBD_DYNAMIC_RESYNC = "dynamic-resync"
1022
DRBD_PLAN_AHEAD = "c-plan-ahead"
1023
DRBD_FILL_TARGET = "c-fill-target"
1024
DRBD_DELAY_TARGET = "c-delay-target"
1025
DRBD_MAX_RATE = "c-max-rate"
1026
DRBD_MIN_RATE = "c-min-rate"
1027
LV_STRIPES = "stripes"
1028
RBD_POOL = "pool"
1029
DISK_DT_TYPES = {
1030
  DRBD_RESYNC_RATE: VTYPE_INT,
1031
  DRBD_DATA_STRIPES: VTYPE_INT,
1032
  DRBD_META_STRIPES: VTYPE_INT,
1033
  DRBD_DISK_BARRIERS: VTYPE_STRING,
1034
  DRBD_META_BARRIERS: VTYPE_BOOL,
1035
  DRBD_DEFAULT_METAVG: VTYPE_STRING,
1036
  DRBD_DISK_CUSTOM: VTYPE_STRING,
1037
  DRBD_NET_CUSTOM: VTYPE_STRING,
1038
  DRBD_DYNAMIC_RESYNC: VTYPE_BOOL,
1039
  DRBD_PLAN_AHEAD: VTYPE_INT,
1040
  DRBD_FILL_TARGET: VTYPE_INT,
1041
  DRBD_DELAY_TARGET: VTYPE_INT,
1042
  DRBD_MAX_RATE: VTYPE_INT,
1043
  DRBD_MIN_RATE: VTYPE_INT,
1044
  LV_STRIPES: VTYPE_INT,
1045
  RBD_POOL: VTYPE_STRING,
1046
  }
1047

    
1048
DISK_DT_PARAMETERS = frozenset(DISK_DT_TYPES.keys())
1049

    
1050
# OOB supported commands
1051
OOB_POWER_ON = "power-on"
1052
OOB_POWER_OFF = "power-off"
1053
OOB_POWER_CYCLE = "power-cycle"
1054
OOB_POWER_STATUS = "power-status"
1055
OOB_HEALTH = "health"
1056

    
1057
OOB_COMMANDS = frozenset([
1058
  OOB_POWER_ON,
1059
  OOB_POWER_OFF,
1060
  OOB_POWER_CYCLE,
1061
  OOB_POWER_STATUS,
1062
  OOB_HEALTH
1063
  ])
1064

    
1065
OOB_POWER_STATUS_POWERED = "powered"
1066

    
1067
OOB_TIMEOUT = 60 # 60 seconds
1068
OOB_POWER_DELAY = 2.0 # 2 seconds
1069

    
1070
OOB_STATUS_OK = "OK"
1071
OOB_STATUS_WARNING = "WARNING"
1072
OOB_STATUS_CRITICAL = "CRITICAL"
1073
OOB_STATUS_UNKNOWN = "UNKNOWN"
1074

    
1075
OOB_STATUSES = frozenset([
1076
  OOB_STATUS_OK,
1077
  OOB_STATUS_WARNING,
1078
  OOB_STATUS_CRITICAL,
1079
  OOB_STATUS_UNKNOWN,
1080
  ])
1081

    
1082
# Instance Parameters Profile
1083
PP_DEFAULT = "default"
1084

    
1085
# NIC_* constants are used inside the ganeti config
1086
NIC_MODE = "mode"
1087
NIC_LINK = "link"
1088

    
1089
NIC_MODE_BRIDGED = "bridged"
1090
NIC_MODE_ROUTED = "routed"
1091

    
1092
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
1093

    
1094
NICS_PARAMETER_TYPES = {
1095
  NIC_MODE: VTYPE_STRING,
1096
  NIC_LINK: VTYPE_STRING,
1097
  }
1098

    
1099
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
1100

    
1101
# IDISK_* constants are used in opcodes, to create/change disks
1102
IDISK_SIZE = "size"
1103
IDISK_MODE = "mode"
1104
IDISK_ADOPT = "adopt"
1105
IDISK_VG = "vg"
1106
IDISK_METAVG = "metavg"
1107
IDISK_PARAMS_TYPES = {
1108
  IDISK_SIZE: VTYPE_SIZE,
1109
  IDISK_MODE: VTYPE_STRING,
1110
  IDISK_ADOPT: VTYPE_STRING,
1111
  IDISK_VG: VTYPE_STRING,
1112
  IDISK_METAVG: VTYPE_STRING,
1113
  }
1114
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
1115

    
1116
# INIC_* constants are used in opcodes, to create/change nics
1117
INIC_MAC = "mac"
1118
INIC_IP = "ip"
1119
INIC_MODE = "mode"
1120
INIC_LINK = "link"
1121
INIC_PARAMS_TYPES = {
1122
  INIC_IP: VTYPE_MAYBE_STRING,
1123
  INIC_LINK: VTYPE_STRING,
1124
  INIC_MAC: VTYPE_STRING,
1125
  INIC_MODE: VTYPE_STRING,
1126
  }
1127
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
1128

    
1129
# Hypervisor constants
1130
HT_XEN_PVM = "xen-pvm"
1131
HT_FAKE = "fake"
1132
HT_XEN_HVM = "xen-hvm"
1133
HT_KVM = "kvm"
1134
HT_CHROOT = "chroot"
1135
HT_LXC = "lxc"
1136
HYPER_TYPES = frozenset([
1137
  HT_XEN_PVM,
1138
  HT_FAKE,
1139
  HT_XEN_HVM,
1140
  HT_KVM,
1141
  HT_CHROOT,
1142
  HT_LXC,
1143
  ])
1144
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
1145

    
1146
VNC_BASE_PORT = 5900
1147
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
1148
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
1149

    
1150
# NIC types
1151
HT_NIC_RTL8139 = "rtl8139"
1152
HT_NIC_NE2K_PCI = "ne2k_pci"
1153
HT_NIC_NE2K_ISA = "ne2k_isa"
1154
HT_NIC_I82551 = "i82551"
1155
HT_NIC_I85557B = "i82557b"
1156
HT_NIC_I8259ER = "i82559er"
1157
HT_NIC_PCNET = "pcnet"
1158
HT_NIC_E1000 = "e1000"
1159
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
1160

    
1161
HT_HVM_VALID_NIC_TYPES = frozenset([
1162
  HT_NIC_RTL8139,
1163
  HT_NIC_NE2K_PCI,
1164
  HT_NIC_E1000,
1165
  HT_NIC_NE2K_ISA,
1166
  HT_NIC_PARAVIRTUAL
1167
  ])
1168
HT_KVM_VALID_NIC_TYPES = frozenset([
1169
  HT_NIC_RTL8139,
1170
  HT_NIC_NE2K_PCI,
1171
  HT_NIC_NE2K_ISA,
1172
  HT_NIC_I82551,
1173
  HT_NIC_I85557B,
1174
  HT_NIC_I8259ER,
1175
  HT_NIC_PCNET,
1176
  HT_NIC_E1000,
1177
  HT_NIC_PARAVIRTUAL
1178
  ])
1179

    
1180
# Disk types
1181
HT_DISK_IOEMU = "ioemu"
1182
HT_DISK_IDE = "ide"
1183
HT_DISK_SCSI = "scsi"
1184
HT_DISK_SD = "sd"
1185
HT_DISK_MTD = "mtd"
1186
HT_DISK_PFLASH = "pflash"
1187

    
1188
HT_CACHE_DEFAULT = "default"
1189
HT_CACHE_NONE = "none"
1190
HT_CACHE_WTHROUGH = "writethrough"
1191
HT_CACHE_WBACK = "writeback"
1192
HT_VALID_CACHE_TYPES = frozenset([
1193
  HT_CACHE_DEFAULT,
1194
  HT_CACHE_NONE,
1195
  HT_CACHE_WTHROUGH,
1196
  HT_CACHE_WBACK
1197
  ])
1198

    
1199
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1200
HT_KVM_VALID_DISK_TYPES = frozenset([
1201
  HT_DISK_PARAVIRTUAL,
1202
  HT_DISK_IDE,
1203
  HT_DISK_SCSI,
1204
  HT_DISK_SD,
1205
  HT_DISK_MTD,
1206
  HT_DISK_PFLASH
1207
  ])
1208

    
1209
# Mouse types:
1210
HT_MOUSE_MOUSE = "mouse"
1211
HT_MOUSE_TABLET = "tablet"
1212

    
1213
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1214

    
1215
# Boot order
1216
HT_BO_FLOPPY = "floppy"
1217
HT_BO_CDROM = "cdrom"
1218
HT_BO_DISK = "disk"
1219
HT_BO_NETWORK = "network"
1220

    
1221
HT_KVM_VALID_BO_TYPES = frozenset([
1222
  HT_BO_FLOPPY,
1223
  HT_BO_CDROM,
1224
  HT_BO_DISK,
1225
  HT_BO_NETWORK
1226
  ])
1227

    
1228
# SPICE lossless image compression options
1229
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1230
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1231
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1232
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1233
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1234
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1235

    
1236
HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1237
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1238
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1239
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1240
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1241
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1242
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1243
  ])
1244

    
1245
# SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1246
HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1247
HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1248
HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1249

    
1250
HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1251
  HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1252
  HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1253
  HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1254
  ])
1255

    
1256
# SPICE video stream detection
1257
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1258
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1259
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1260

    
1261
HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1262
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1263
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1264
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1265
  ])
1266

    
1267
# Security models
1268
HT_SM_NONE = "none"
1269
HT_SM_USER = "user"
1270
HT_SM_POOL = "pool"
1271

    
1272
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1273

    
1274
# Kvm flag values
1275
HT_KVM_ENABLED = "enabled"
1276
HT_KVM_DISABLED = "disabled"
1277

    
1278
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1279

    
1280
# Migration type
1281
HT_MIGRATION_LIVE = "live"
1282
HT_MIGRATION_NONLIVE = "non-live"
1283
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1284

    
1285
# Cluster Verify steps
1286
VERIFY_NPLUSONE_MEM = "nplusone_mem"
1287
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1288

    
1289
# Cluster Verify error classes
1290
CV_TCLUSTER = "cluster"
1291
CV_TNODE = "node"
1292
CV_TINSTANCE = "instance"
1293

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

    
1369
CV_ALL_ECODES = frozenset([
1370
  CV_ECLUSTERCFG,
1371
  CV_ECLUSTERCERT,
1372
  CV_ECLUSTERFILECHECK,
1373
  CV_ECLUSTERDANGLINGNODES,
1374
  CV_ECLUSTERDANGLINGINST,
1375
  CV_EINSTANCEBADNODE,
1376
  CV_EINSTANCEDOWN,
1377
  CV_EINSTANCELAYOUT,
1378
  CV_EINSTANCEMISSINGDISK,
1379
  CV_EINSTANCEFAULTYDISK,
1380
  CV_EINSTANCEWRONGNODE,
1381
  CV_EINSTANCESPLITGROUPS,
1382
  CV_EINSTANCEPOLICY,
1383
  CV_ENODEDRBD,
1384
  CV_ENODEDRBDHELPER,
1385
  CV_ENODEFILECHECK,
1386
  CV_ENODEHOOKS,
1387
  CV_ENODEHV,
1388
  CV_ENODELVM,
1389
  CV_ENODEN1,
1390
  CV_ENODENET,
1391
  CV_ENODEOS,
1392
  CV_ENODEORPHANINSTANCE,
1393
  CV_ENODEORPHANLV,
1394
  CV_ENODERPC,
1395
  CV_ENODESSH,
1396
  CV_ENODEVERSION,
1397
  CV_ENODESETUP,
1398
  CV_ENODETIME,
1399
  CV_ENODEOOBPATH,
1400
  CV_ENODEUSERSCRIPTS,
1401
  ])
1402

    
1403
CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1404

    
1405
# Node verify constants
1406
NV_DRBDHELPER = "drbd-helper"
1407
NV_DRBDLIST = "drbd-list"
1408
NV_FILELIST = "filelist"
1409
NV_HVINFO = "hvinfo"
1410
NV_HYPERVISOR = "hypervisor"
1411
NV_HVPARAMS = "hvparms"
1412
NV_INSTANCELIST = "instancelist"
1413
NV_LVLIST = "lvlist"
1414
NV_MASTERIP = "master-ip"
1415
NV_NODELIST = "nodelist"
1416
NV_NODENETTEST = "node-net-test"
1417
NV_NODESETUP = "nodesetup"
1418
NV_OSLIST = "oslist"
1419
NV_PVLIST = "pvlist"
1420
NV_TIME = "time"
1421
NV_VERSION = "version"
1422
NV_VGLIST = "vglist"
1423
NV_VMNODES = "vmnodes"
1424
NV_OOB_PATHS = "oob-paths"
1425
NV_BRIDGES = "bridges"
1426
NV_USERSCRIPTS = "user-scripts"
1427

    
1428
# Instance status
1429
INSTST_RUNNING = "running"
1430
INSTST_ADMINDOWN = "ADMIN_down"
1431
INSTST_ADMINOFFLINE = "ADMIN_offline"
1432
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1433
INSTST_NODEDOWN = "ERROR_nodedown"
1434
INSTST_WRONGNODE = "ERROR_wrongnode"
1435
INSTST_ERRORUP = "ERROR_up"
1436
INSTST_ERRORDOWN = "ERROR_down"
1437
INSTST_ALL = frozenset([
1438
  INSTST_RUNNING,
1439
  INSTST_ADMINDOWN,
1440
  INSTST_ADMINOFFLINE,
1441
  INSTST_NODEOFFLINE,
1442
  INSTST_NODEDOWN,
1443
  INSTST_WRONGNODE,
1444
  INSTST_ERRORUP,
1445
  INSTST_ERRORDOWN,
1446
  ])
1447

    
1448
# Admin states
1449
ADMINST_UP = "up"
1450
ADMINST_DOWN = "down"
1451
ADMINST_OFFLINE = "offline"
1452
ADMINST_ALL = frozenset([
1453
  ADMINST_UP,
1454
  ADMINST_DOWN,
1455
  ADMINST_OFFLINE,
1456
  ])
1457

    
1458
# Node roles
1459
NR_REGULAR = "R"
1460
NR_MASTER = "M"
1461
NR_MCANDIDATE = "C"
1462
NR_DRAINED = "D"
1463
NR_OFFLINE = "O"
1464
NR_ALL = frozenset([
1465
  NR_REGULAR,
1466
  NR_MASTER,
1467
  NR_MCANDIDATE,
1468
  NR_DRAINED,
1469
  NR_OFFLINE,
1470
  ])
1471

    
1472
# SSL certificate check constants (in days)
1473
SSL_CERT_EXPIRATION_WARN = 30
1474
SSL_CERT_EXPIRATION_ERROR = 7
1475

    
1476
# Allocator framework constants
1477
IALLOCATOR_VERSION = 2
1478
IALLOCATOR_DIR_IN = "in"
1479
IALLOCATOR_DIR_OUT = "out"
1480
VALID_IALLOCATOR_DIRECTIONS = frozenset([
1481
  IALLOCATOR_DIR_IN,
1482
  IALLOCATOR_DIR_OUT,
1483
  ])
1484
IALLOCATOR_MODE_ALLOC = "allocate"
1485
IALLOCATOR_MODE_RELOC = "relocate"
1486
IALLOCATOR_MODE_CHG_GROUP = "change-group"
1487
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1488
VALID_IALLOCATOR_MODES = frozenset([
1489
  IALLOCATOR_MODE_ALLOC,
1490
  IALLOCATOR_MODE_RELOC,
1491
  IALLOCATOR_MODE_CHG_GROUP,
1492
  IALLOCATOR_MODE_NODE_EVAC,
1493
  ])
1494
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1495

    
1496
IALLOCATOR_NEVAC_PRI = "primary-only"
1497
IALLOCATOR_NEVAC_SEC = "secondary-only"
1498
IALLOCATOR_NEVAC_ALL = "all"
1499
IALLOCATOR_NEVAC_MODES = frozenset([
1500
  IALLOCATOR_NEVAC_PRI,
1501
  IALLOCATOR_NEVAC_SEC,
1502
  IALLOCATOR_NEVAC_ALL,
1503
  ])
1504

    
1505
# Node evacuation
1506
NODE_EVAC_PRI = "primary-only"
1507
NODE_EVAC_SEC = "secondary-only"
1508
NODE_EVAC_ALL = "all"
1509
NODE_EVAC_MODES = frozenset([
1510
  NODE_EVAC_PRI,
1511
  NODE_EVAC_SEC,
1512
  NODE_EVAC_ALL,
1513
  ])
1514

    
1515
# Job queue
1516
JOB_QUEUE_VERSION = 1
1517
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1518
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1519
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1520
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1521
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1522
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1523

    
1524
JOB_ID_TEMPLATE = r"\d+"
1525
JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1526

    
1527
# unchanged job return
1528
JOB_NOTCHANGED = "nochange"
1529

    
1530
# Job status
1531
JOB_STATUS_QUEUED = "queued"
1532
JOB_STATUS_WAITING = "waiting"
1533
JOB_STATUS_CANCELING = "canceling"
1534
JOB_STATUS_RUNNING = "running"
1535
JOB_STATUS_CANCELED = "canceled"
1536
JOB_STATUS_SUCCESS = "success"
1537
JOB_STATUS_ERROR = "error"
1538
JOBS_FINALIZED = frozenset([
1539
  JOB_STATUS_CANCELED,
1540
  JOB_STATUS_SUCCESS,
1541
  JOB_STATUS_ERROR,
1542
  ])
1543
JOB_STATUS_ALL = frozenset([
1544
  JOB_STATUS_QUEUED,
1545
  JOB_STATUS_WAITING,
1546
  JOB_STATUS_CANCELING,
1547
  JOB_STATUS_RUNNING,
1548
  ]) | JOBS_FINALIZED
1549

    
1550
# OpCode status
1551
# not yet finalized
1552
OP_STATUS_QUEUED = "queued"
1553
OP_STATUS_WAITING = "waiting"
1554
OP_STATUS_CANCELING = "canceling"
1555
OP_STATUS_RUNNING = "running"
1556
# finalized
1557
OP_STATUS_CANCELED = "canceled"
1558
OP_STATUS_SUCCESS = "success"
1559
OP_STATUS_ERROR = "error"
1560
OPS_FINALIZED = frozenset([
1561
  OP_STATUS_CANCELED,
1562
  OP_STATUS_SUCCESS,
1563
  OP_STATUS_ERROR
1564
  ])
1565

    
1566
# OpCode priority
1567
OP_PRIO_LOWEST = +19
1568
OP_PRIO_HIGHEST = -20
1569

    
1570
OP_PRIO_LOW = +10
1571
OP_PRIO_NORMAL = 0
1572
OP_PRIO_HIGH = -10
1573

    
1574
OP_PRIO_SUBMIT_VALID = frozenset([
1575
  OP_PRIO_LOW,
1576
  OP_PRIO_NORMAL,
1577
  OP_PRIO_HIGH,
1578
  ])
1579

    
1580
OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1581

    
1582
# Lock recalculate mode
1583
LOCKS_REPLACE = "replace"
1584
LOCKS_APPEND = "append"
1585

    
1586
# Lock timeout (sum) before we should go into blocking acquire (still
1587
# can be reset by priority change); computed as max time (10 hours)
1588
# before we should actually go into blocking acquire given that we
1589
# start from default priority level; in seconds
1590
# TODO
1591
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / (OP_PRIO_DEFAULT - OP_PRIO_HIGHEST)
1592
LOCK_ATTEMPTS_MAXWAIT = 15.0
1593
LOCK_ATTEMPTS_MINWAIT = 1.0
1594

    
1595
# Execution log types
1596
ELOG_MESSAGE = "message"
1597
ELOG_REMOTE_IMPORT = "remote-import"
1598
ELOG_JQUEUE_TEST = "jqueue-test"
1599

    
1600
# /etc/hosts modification
1601
ETC_HOSTS_ADD = "add"
1602
ETC_HOSTS_REMOVE = "remove"
1603

    
1604
# Job queue test
1605
JQT_MSGPREFIX = "TESTMSG="
1606
JQT_EXPANDNAMES = "expandnames"
1607
JQT_EXEC = "exec"
1608
JQT_LOGMSG = "logmsg"
1609
JQT_STARTMSG = "startmsg"
1610
JQT_ALL = frozenset([
1611
  JQT_EXPANDNAMES,
1612
  JQT_EXEC,
1613
  JQT_LOGMSG,
1614
  JQT_STARTMSG,
1615
  ])
1616

    
1617
# Query resources
1618
QR_CLUSTER = "cluster"
1619
QR_INSTANCE = "instance"
1620
QR_NODE = "node"
1621
QR_LOCK = "lock"
1622
QR_GROUP = "group"
1623
QR_OS = "os"
1624
QR_JOB = "job"
1625
QR_EXPORT = "export"
1626

    
1627
#: List of resources which can be queried using L{opcodes.OpQuery}
1628
QR_VIA_OP = frozenset([
1629
  QR_CLUSTER,
1630
  QR_INSTANCE,
1631
  QR_NODE,
1632
  QR_GROUP,
1633
  QR_OS,
1634
  QR_EXPORT,
1635
  ])
1636

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

    
1643
#: List of resources which can be queried using RAPI
1644
QR_VIA_RAPI = QR_VIA_LUXI
1645

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

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

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

    
1681
RS_ALL = frozenset([
1682
  RS_NORMAL,
1683
  RS_UNKNOWN,
1684
  RS_NODATA,
1685
  RS_UNAVAIL,
1686
  RS_OFFLINE,
1687
  ])
1688

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

    
1697
# max dynamic devices
1698
MAX_NICS = 8
1699
MAX_DISKS = 16
1700

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

    
1725
SS_FILE_PERMS = 0444
1726

    
1727
# cluster wide default parameters
1728
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1729

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

    
1820
HVC_GLOBALS = frozenset([
1821
  HV_MIGRATION_PORT,
1822
  HV_MIGRATION_BANDWIDTH,
1823
  HV_MIGRATION_MODE,
1824
  ])
1825

    
1826
BEC_DEFAULTS = {
1827
  BE_MINMEM: 128,
1828
  BE_MAXMEM: 128,
1829
  BE_VCPUS: 1,
1830
  BE_AUTO_BALANCE: True,
1831
  BE_ALWAYS_FAILOVER: False,
1832
  BE_SPINDLE_USE: 1,
1833
  }
1834

    
1835
NDC_DEFAULTS = {
1836
  ND_OOB_PROGRAM: None,
1837
  ND_SPINDLE_COUNT: 1,
1838
  }
1839

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

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

    
1873
# readability shortcuts
1874
_LV_DEFAULTS = DISK_LD_DEFAULTS[LD_LV]
1875
_DRBD_DEFAULTS = DISK_LD_DEFAULTS[LD_DRBD8]
1876

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

    
1910
# we don't want to export the shortcuts
1911
del _LV_DEFAULTS, _DRBD_DEFAULTS
1912

    
1913
NICC_DEFAULTS = {
1914
  NIC_MODE: NIC_MODE_BRIDGED,
1915
  NIC_LINK: DEFAULT_BRIDGE,
1916
  }
1917

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

    
1950
MASTER_POOL_SIZE_DEFAULT = 10
1951

    
1952
CONFD_PROTOCOL_VERSION = 1
1953

    
1954
CONFD_REQ_PING = 0
1955
CONFD_REQ_NODE_ROLE_BYNAME = 1
1956
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1957
CONFD_REQ_CLUSTER_MASTER = 3
1958
CONFD_REQ_NODE_PIP_LIST = 4
1959
CONFD_REQ_MC_PIP_LIST = 5
1960
CONFD_REQ_INSTANCES_IPS_LIST = 6
1961

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

    
1970
CONFD_REQFIELD_NAME = "0"
1971
CONFD_REQFIELD_IP = "1"
1972
CONFD_REQFIELD_MNODE_PIP = "2"
1973

    
1974
CONFD_REQS = frozenset([
1975
  CONFD_REQ_PING,
1976
  CONFD_REQ_NODE_ROLE_BYNAME,
1977
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1978
  CONFD_REQ_CLUSTER_MASTER,
1979
  CONFD_REQ_NODE_PIP_LIST,
1980
  CONFD_REQ_MC_PIP_LIST,
1981
  CONFD_REQ_INSTANCES_IPS_LIST,
1982
  ])
1983

    
1984
CONFD_REPL_STATUS_OK = 0
1985
CONFD_REPL_STATUS_ERROR = 1
1986
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1987

    
1988
CONFD_REPL_STATUSES = frozenset([
1989
  CONFD_REPL_STATUS_OK,
1990
  CONFD_REPL_STATUS_ERROR,
1991
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
1992
  ])
1993

    
1994
(CONFD_NODE_ROLE_MASTER,
1995
 CONFD_NODE_ROLE_CANDIDATE,
1996
 CONFD_NODE_ROLE_OFFLINE,
1997
 CONFD_NODE_ROLE_DRAINED,
1998
 CONFD_NODE_ROLE_REGULAR,
1999
 ) = range(5)
2000

    
2001
# A few common errors for confd
2002
CONFD_ERROR_UNKNOWN_ENTRY = 1
2003
CONFD_ERROR_INTERNAL = 2
2004
CONFD_ERROR_ARGUMENT = 3
2005

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

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

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

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

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

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

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

    
2043
# User-id pool minimum/maximum acceptable user-ids.
2044
UIDPOOL_UID_MIN = 0
2045
UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
2046

    
2047
# Name or path of the pgrep command
2048
PGREP = "pgrep"
2049

    
2050
# Name of the node group that gets created at cluster init or upgrade
2051
INITIAL_NODE_GROUP_NAME = "default"
2052

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

    
2063
# Temporary external/shared storage parameters
2064
BLOCKDEV_DRIVER_MANUAL = "manual"
2065

    
2066
# qemu-img path, required for ovfconverter
2067
QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
2068

    
2069
# Whether htools was enabled at compilation time
2070
HTOOLS = _autoconf.HTOOLS
2071
# The hail iallocator
2072
IALLOC_HAIL = "hail"
2073

    
2074
# Fake opcodes for functions that have hooks attached to them via
2075
# backend.RunLocalHooks
2076
FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
2077
FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
2078

    
2079
# Do not re-export imported modules
2080
del re, _vcsversion, _autoconf, socket