Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 73a100df

History | View | Annotate | Download (55.9 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_ES_DIR = LOG_DIR + "extstorage"
243
LOG_WATCHER = LOG_DIR + "watcher.log"
244
LOG_COMMANDS = LOG_DIR + "commands.log"
245
LOG_BURNIN = LOG_DIR + "burnin.log"
246
LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
247

    
248
DEV_CONSOLE = "/dev/console"
249

    
250
PROC_MOUNTS = "/proc/mounts"
251

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

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

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

    
267
EXPORT_CONF_FILE = "config.ini"
268

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

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

    
284
#: Console as SSH command
285
CONS_SSH = "ssh"
286

    
287
#: Console as VNC server
288
CONS_VNC = "vnc"
289

    
290
#: Console as SPICE server
291
CONS_SPICE = "spice"
292

    
293
#: Display a message for console access
294
CONS_MESSAGE = "msg"
295

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

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

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

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

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

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

    
321
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
322

    
323
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
324

    
325
# Import/export daemon mode
326
IEM_IMPORT = "import"
327
IEM_EXPORT = "export"
328

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

    
337
IE_CUSTOM_SIZE = "fd"
338

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

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

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

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

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

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

    
374
HKR_SKIP = 0
375
HKR_FAIL = 1
376
HKR_SUCCESS = 2
377

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

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

    
394
# Storage operations
395
SO_FIX_CONSISTENCY = "fix-consistency"
396

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

    
407
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
408

    
409
MODIFIABLE_STORAGE_FIELDS = {
410
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
411
  }
412

    
413
VALID_STORAGE_OPERATIONS = {
414
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
415
  }
416

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

    
423
# disk template types
424
DT_DISKLESS = "diskless"
425
DT_PLAIN = "plain"
426
DT_DRBD8 = "drbd"
427
DT_FILE = "file"
428
DT_SHARED_FILE = "sharedfile"
429
DT_BLOCK = "blockdev"
430
DT_RBD = "rbd"
431
DT_EXT = "ext"
432

    
433
# the set of network-mirrored disk templates
434
DTS_INT_MIRROR = frozenset([DT_DRBD8])
435

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

    
439
# the set of non-lvm-based disk templates
440
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE,
441
                         DT_BLOCK, DT_RBD, DT_EXT])
442

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

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

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

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

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

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

    
475
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV, LD_RBD, LD_EXT])
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
# instance creation modes
536
INSTANCE_CREATE = "create"
537
INSTANCE_IMPORT = "import"
538
INSTANCE_REMOTE_IMPORT = "remote-import"
539
INSTANCE_CREATE_MODES = frozenset([
540
  INSTANCE_CREATE,
541
  INSTANCE_IMPORT,
542
  INSTANCE_REMOTE_IMPORT,
543
  ])
544

    
545
# Remote import/export handshake message and version
546
RIE_VERSION = 0
547
RIE_HANDSHAKE = "Hi, I'm Ganeti"
548

    
549
# Remote import/export certificate validity in seconds
550
RIE_CERT_VALIDITY = 24 * 60 * 60
551

    
552
# Overall timeout for establishing connection
553
RIE_CONNECT_TIMEOUT = 180
554

    
555
# Export only: how long to wait per connection attempt (seconds)
556
RIE_CONNECT_ATTEMPT_TIMEOUT = 20
557

    
558
# Export only: number of attempts to connect
559
RIE_CONNECT_RETRIES = 10
560

    
561
#: Give child process up to 5 seconds to exit after sending a signal
562
CHILD_LINGER_TIMEOUT = 5.0
563

    
564
DISK_TEMPLATES = frozenset([
565
  DT_DISKLESS,
566
  DT_PLAIN,
567
  DT_DRBD8,
568
  DT_FILE,
569
  DT_SHARED_FILE,
570
  DT_BLOCK,
571
  DT_RBD,
572
  DT_EXT
573
  ])
574

    
575
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
576

    
577
# import/export config options
578
INISECT_EXP = "export"
579
INISECT_INS = "instance"
580
INISECT_HYP = "hypervisor"
581
INISECT_BEP = "backend"
582
INISECT_OSP = "os"
583

    
584
# dynamic device modification
585
DDM_ADD = "add"
586
DDM_MODIFY = "modify"
587
DDM_REMOVE = "remove"
588
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
589
DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
590
  DDM_MODIFY,
591
  ]))
592
# TODO: DDM_SWAP, DDM_MOVE?
593

    
594
# common exit codes
595
EXIT_SUCCESS = 0
596
EXIT_FAILURE = 1
597
EXIT_NOTCLUSTER = 5
598
EXIT_NOTMASTER = 11
599
EXIT_NODESETUP_ERROR = 12
600
EXIT_CONFIRMATION = 13 # need user confirmation
601

    
602
#: Exit code for query operations with unknown fields
603
EXIT_UNKNOWN_FIELD = 14
604

    
605
# tags
606
TAG_CLUSTER = "cluster"
607
TAG_NODEGROUP = "nodegroup"
608
TAG_NODE = "node"
609
TAG_INSTANCE = "instance"
610
VALID_TAG_TYPES = frozenset([
611
  TAG_CLUSTER,
612
  TAG_NODEGROUP,
613
  TAG_NODE,
614
  TAG_INSTANCE,
615
  ])
616
MAX_TAG_LEN = 128
617
MAX_TAGS_PER_OBJ = 4096
618

    
619
# others
620
DEFAULT_BRIDGE = "xen-br0"
621
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
622
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
623
IP4_ADDRESS_ANY = "0.0.0.0"
624
IP6_ADDRESS_LOCALHOST = "::1"
625
IP6_ADDRESS_ANY = "::"
626
IP4_VERSION = 4
627
IP6_VERSION = 6
628
VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
629
# for export to htools
630
IP4_FAMILY = socket.AF_INET
631
IP6_FAMILY = socket.AF_INET6
632

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

    
648
#: Key for job IDs in opcode result
649
JOB_IDS_KEY = "jobs"
650

    
651
# runparts results
652
(RUNPARTS_SKIP,
653
 RUNPARTS_RUN,
654
 RUNPARTS_ERR) = range(3)
655

    
656
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
657

    
658
# RPC constants
659
(RPC_ENCODING_NONE,
660
 RPC_ENCODING_ZLIB_BASE64) = range(2)
661

    
662
# os related constants
663
OS_SCRIPT_CREATE = "create"
664
OS_SCRIPT_IMPORT = "import"
665
OS_SCRIPT_EXPORT = "export"
666
OS_SCRIPT_RENAME = "rename"
667
OS_SCRIPT_VERIFY = "verify"
668
OS_SCRIPTS = frozenset([
669
  OS_SCRIPT_CREATE,
670
  OS_SCRIPT_IMPORT,
671
  OS_SCRIPT_EXPORT,
672
  OS_SCRIPT_RENAME,
673
  OS_SCRIPT_VERIFY
674
  ])
675

    
676
OS_API_FILE = "ganeti_api_version"
677
OS_VARIANTS_FILE = "variants.list"
678
OS_PARAMETERS_FILE = "parameters.list"
679

    
680
OS_VALIDATE_PARAMETERS = "parameters"
681
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
682

    
683
# External Storage (ES) related constants
684
ES_ACTION_CREATE = "create"
685
ES_ACTION_REMOVE = "remove"
686
ES_ACTION_GROW = "grow"
687
ES_ACTION_ATTACH = "attach"
688
ES_ACTION_DETACH = "detach"
689
ES_ACTION_VERIFY = "verify"
690

    
691
ES_SCRIPT_CREATE = ES_ACTION_CREATE
692
ES_SCRIPT_REMOVE = ES_ACTION_REMOVE
693
ES_SCRIPT_GROW = ES_ACTION_GROW
694
ES_SCRIPT_ATTACH = ES_ACTION_ATTACH
695
ES_SCRIPT_DETACH = ES_ACTION_DETACH
696
ES_SCRIPT_VERIFY = ES_ACTION_VERIFY
697
ES_SCRIPTS = frozenset([
698
  ES_SCRIPT_CREATE,
699
  ES_SCRIPT_REMOVE,
700
  ES_SCRIPT_GROW,
701
  ES_SCRIPT_ATTACH,
702
  ES_SCRIPT_DETACH,
703
  ES_SCRIPT_VERIFY
704
  ])
705

    
706
ES_PARAMETERS_FILE = "parameters.list"
707

    
708
# ssh constants
709
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
710
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
711
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
712
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
713
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
714
SSH = "ssh"
715
SCP = "scp"
716

    
717
# reboot types
718
INSTANCE_REBOOT_SOFT = "soft"
719
INSTANCE_REBOOT_HARD = "hard"
720
INSTANCE_REBOOT_FULL = "full"
721

    
722
REBOOT_TYPES = frozenset([
723
  INSTANCE_REBOOT_SOFT,
724
  INSTANCE_REBOOT_HARD,
725
  INSTANCE_REBOOT_FULL
726
  ])
727

    
728
# instance reboot behaviors
729
INSTANCE_REBOOT_ALLOWED = "reboot"
730
INSTANCE_REBOOT_EXIT = "exit"
731

    
732
REBOOT_BEHAVIORS = frozenset([
733
  INSTANCE_REBOOT_ALLOWED,
734
  INSTANCE_REBOOT_EXIT
735
  ])
736

    
737
VTYPE_STRING = "string"
738
VTYPE_MAYBE_STRING = "maybe-string"
739
VTYPE_BOOL = "bool"
740
VTYPE_SIZE = "size" # size, in MiBs
741
VTYPE_INT = "int"
742
ENFORCEABLE_TYPES = frozenset([
743
  VTYPE_STRING,
744
  VTYPE_MAYBE_STRING,
745
  VTYPE_BOOL,
746
  VTYPE_SIZE,
747
  VTYPE_INT,
748
  ])
749

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

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

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

    
864
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
865

    
866
# Migration statuses
867
HV_MIGRATION_COMPLETED = "completed"
868
HV_MIGRATION_ACTIVE = "active"
869
HV_MIGRATION_FAILED = "failed"
870
HV_MIGRATION_CANCELLED = "cancelled"
871

    
872
HV_MIGRATION_VALID_STATUSES = frozenset([
873
  HV_MIGRATION_COMPLETED,
874
  HV_MIGRATION_ACTIVE,
875
  HV_MIGRATION_FAILED,
876
  HV_MIGRATION_CANCELLED,
877
  ])
878

    
879
HV_MIGRATION_FAILED_STATUSES = frozenset([
880
  HV_MIGRATION_FAILED,
881
  HV_MIGRATION_CANCELLED,
882
  ])
883

    
884
# KVM-specific statuses
885
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
886

    
887
# Node info keys
888
HV_NODEINFO_KEY_VERSION = "hv_version"
889

    
890
# Hypervisor state
891
HVST_MEMORY_TOTAL = "mem_total"
892
HVST_MEMORY_NODE = "mem_node"
893
HVST_MEMORY_HV = "mem_hv"
894
HVST_CPU_TOTAL = "cpu_total"
895
HVST_CPU_NODE = "cpu_node"
896

    
897
HVST_DEFAULTS = {
898
  HVST_MEMORY_TOTAL: 0,
899
  HVST_MEMORY_NODE: 0,
900
  HVST_MEMORY_HV: 0,
901
  HVST_CPU_TOTAL: 1,
902
  HVST_CPU_NODE: 1,
903
  }
904

    
905
HVSTS_PARAMETER_TYPES = {
906
  HVST_MEMORY_TOTAL: VTYPE_INT,
907
  HVST_MEMORY_NODE: VTYPE_INT,
908
  HVST_MEMORY_HV: VTYPE_INT,
909
  HVST_CPU_TOTAL: VTYPE_INT,
910
  HVST_CPU_NODE: VTYPE_INT,
911
  }
912

    
913
HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
914

    
915
# Disk state
916
DS_DISK_TOTAL = "disk_total"
917
DS_DISK_RESERVED = "disk_reserved"
918
DS_DISK_OVERHEAD = "disk_overhead"
919

    
920
DS_DEFAULTS = {
921
  DS_DISK_TOTAL: 0,
922
  DS_DISK_RESERVED: 0,
923
  DS_DISK_OVERHEAD: 0,
924
  }
925

    
926
DSS_PARAMETER_TYPES = {
927
  DS_DISK_TOTAL: VTYPE_INT,
928
  DS_DISK_RESERVED: VTYPE_INT,
929
  DS_DISK_OVERHEAD: VTYPE_INT,
930
  }
931

    
932
DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
933
DS_VALID_TYPES = frozenset([LD_LV])
934

    
935
# Backend parameter names
936
BE_MEMORY = "memory" # deprecated and replaced by max and min mem
937
BE_MAXMEM = "maxmem"
938
BE_MINMEM = "minmem"
939
BE_VCPUS = "vcpus"
940
BE_AUTO_BALANCE = "auto_balance"
941
BE_ALWAYS_FAILOVER = "always_failover"
942
BE_SPINDLE_USE = "spindle_use"
943

    
944
BES_PARAMETER_TYPES = {
945
  BE_MAXMEM: VTYPE_SIZE,
946
  BE_MINMEM: VTYPE_SIZE,
947
  BE_VCPUS: VTYPE_INT,
948
  BE_AUTO_BALANCE: VTYPE_BOOL,
949
  BE_ALWAYS_FAILOVER: VTYPE_BOOL,
950
  BE_SPINDLE_USE: VTYPE_INT,
951
  }
952

    
953
BES_PARAMETER_COMPAT = {
954
  BE_MEMORY: VTYPE_SIZE,
955
  }
956
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)
957

    
958
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
959

    
960
# instance specs
961
ISPEC_MEM_SIZE = "memory-size"
962
ISPEC_CPU_COUNT = "cpu-count"
963
ISPEC_DISK_COUNT = "disk-count"
964
ISPEC_DISK_SIZE = "disk-size"
965
ISPEC_NIC_COUNT = "nic-count"
966
ISPEC_SPINDLE_USE = "spindle-use"
967

    
968
ISPECS_PARAMETER_TYPES = {
969
  ISPEC_MEM_SIZE: VTYPE_INT,
970
  ISPEC_CPU_COUNT: VTYPE_INT,
971
  ISPEC_DISK_COUNT: VTYPE_INT,
972
  ISPEC_DISK_SIZE: VTYPE_INT,
973
  ISPEC_NIC_COUNT: VTYPE_INT,
974
  ISPEC_SPINDLE_USE: VTYPE_INT,
975
  }
976

    
977
ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())
978

    
979
ISPECS_MIN = "min"
980
ISPECS_MAX = "max"
981
ISPECS_STD = "std"
982
IPOLICY_DTS = "disk-templates"
983
IPOLICY_VCPU_RATIO = "vcpu-ratio"
984
IPOLICY_SPINDLE_RATIO = "spindle-ratio"
985

    
986
IPOLICY_ISPECS = frozenset([
987
  ISPECS_MIN,
988
  ISPECS_MAX,
989
  ISPECS_STD,
990
  ])
991

    
992
IPOLICY_PARAMETERS = frozenset([
993
  IPOLICY_VCPU_RATIO,
994
  IPOLICY_SPINDLE_RATIO,
995
  ])
996

    
997
IPOLICY_ALL_KEYS = (IPOLICY_ISPECS |
998
                    IPOLICY_PARAMETERS |
999
                    frozenset([IPOLICY_DTS]))
1000

    
1001
# Node parameter names
1002
ND_OOB_PROGRAM = "oob_program"
1003
ND_SPINDLE_COUNT = "spindle_count"
1004

    
1005
NDS_PARAMETER_TYPES = {
1006
  ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
1007
  ND_SPINDLE_COUNT: VTYPE_INT,
1008
  }
1009

    
1010
NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
1011

    
1012
# Logical Disks parameters
1013
LDP_RESYNC_RATE = "resync-rate"
1014
LDP_STRIPES = "stripes"
1015
LDP_BARRIERS = "disabled-barriers"
1016
LDP_NO_META_FLUSH = "disable-meta-flush"
1017
LDP_DEFAULT_METAVG = "default-metavg"
1018
LDP_DISK_CUSTOM = "disk-custom"
1019
LDP_NET_CUSTOM = "net-custom"
1020
LDP_DYNAMIC_RESYNC = "dynamic-resync"
1021
LDP_PLAN_AHEAD = "c-plan-ahead"
1022
LDP_FILL_TARGET = "c-fill-target"
1023
LDP_DELAY_TARGET = "c-delay-target"
1024
LDP_MAX_RATE = "c-max-rate"
1025
LDP_MIN_RATE = "c-min-rate"
1026
LDP_POOL = "pool"
1027
DISK_LD_TYPES = {
1028
  LDP_RESYNC_RATE: VTYPE_INT,
1029
  LDP_STRIPES: VTYPE_INT,
1030
  LDP_BARRIERS: VTYPE_STRING,
1031
  LDP_NO_META_FLUSH: VTYPE_BOOL,
1032
  LDP_DEFAULT_METAVG: VTYPE_STRING,
1033
  LDP_DISK_CUSTOM: VTYPE_STRING,
1034
  LDP_NET_CUSTOM: VTYPE_STRING,
1035
  LDP_DYNAMIC_RESYNC: VTYPE_BOOL,
1036
  LDP_PLAN_AHEAD: VTYPE_INT,
1037
  LDP_FILL_TARGET: VTYPE_INT,
1038
  LDP_DELAY_TARGET: VTYPE_INT,
1039
  LDP_MAX_RATE: VTYPE_INT,
1040
  LDP_MIN_RATE: VTYPE_INT,
1041
  LDP_POOL: VTYPE_STRING,
1042
  }
1043
DISK_LD_PARAMETERS = frozenset(DISK_LD_TYPES.keys())
1044

    
1045
# Disk template parameters (can be set/changed by the user via gnt-cluster and
1046
# gnt-group)
1047
DRBD_RESYNC_RATE = "resync-rate"
1048
DRBD_DATA_STRIPES = "data-stripes"
1049
DRBD_META_STRIPES = "meta-stripes"
1050
DRBD_DISK_BARRIERS = "disk-barriers"
1051
DRBD_META_BARRIERS = "meta-barriers"
1052
DRBD_DEFAULT_METAVG = "metavg"
1053
DRBD_DISK_CUSTOM = "disk-custom"
1054
DRBD_NET_CUSTOM = "net-custom"
1055
DRBD_DYNAMIC_RESYNC = "dynamic-resync"
1056
DRBD_PLAN_AHEAD = "c-plan-ahead"
1057
DRBD_FILL_TARGET = "c-fill-target"
1058
DRBD_DELAY_TARGET = "c-delay-target"
1059
DRBD_MAX_RATE = "c-max-rate"
1060
DRBD_MIN_RATE = "c-min-rate"
1061
LV_STRIPES = "stripes"
1062
RBD_POOL = "pool"
1063
DISK_DT_TYPES = {
1064
  DRBD_RESYNC_RATE: VTYPE_INT,
1065
  DRBD_DATA_STRIPES: VTYPE_INT,
1066
  DRBD_META_STRIPES: VTYPE_INT,
1067
  DRBD_DISK_BARRIERS: VTYPE_STRING,
1068
  DRBD_META_BARRIERS: VTYPE_BOOL,
1069
  DRBD_DEFAULT_METAVG: VTYPE_STRING,
1070
  DRBD_DISK_CUSTOM: VTYPE_STRING,
1071
  DRBD_NET_CUSTOM: VTYPE_STRING,
1072
  DRBD_DYNAMIC_RESYNC: VTYPE_BOOL,
1073
  DRBD_PLAN_AHEAD: VTYPE_INT,
1074
  DRBD_FILL_TARGET: VTYPE_INT,
1075
  DRBD_DELAY_TARGET: VTYPE_INT,
1076
  DRBD_MAX_RATE: VTYPE_INT,
1077
  DRBD_MIN_RATE: VTYPE_INT,
1078
  LV_STRIPES: VTYPE_INT,
1079
  RBD_POOL: VTYPE_STRING,
1080
  }
1081

    
1082
DISK_DT_PARAMETERS = frozenset(DISK_DT_TYPES.keys())
1083

    
1084
# OOB supported commands
1085
OOB_POWER_ON = "power-on"
1086
OOB_POWER_OFF = "power-off"
1087
OOB_POWER_CYCLE = "power-cycle"
1088
OOB_POWER_STATUS = "power-status"
1089
OOB_HEALTH = "health"
1090

    
1091
OOB_COMMANDS = frozenset([
1092
  OOB_POWER_ON,
1093
  OOB_POWER_OFF,
1094
  OOB_POWER_CYCLE,
1095
  OOB_POWER_STATUS,
1096
  OOB_HEALTH
1097
  ])
1098

    
1099
OOB_POWER_STATUS_POWERED = "powered"
1100

    
1101
OOB_TIMEOUT = 60 # 60 seconds
1102
OOB_POWER_DELAY = 2.0 # 2 seconds
1103

    
1104
OOB_STATUS_OK = "OK"
1105
OOB_STATUS_WARNING = "WARNING"
1106
OOB_STATUS_CRITICAL = "CRITICAL"
1107
OOB_STATUS_UNKNOWN = "UNKNOWN"
1108

    
1109
OOB_STATUSES = frozenset([
1110
  OOB_STATUS_OK,
1111
  OOB_STATUS_WARNING,
1112
  OOB_STATUS_CRITICAL,
1113
  OOB_STATUS_UNKNOWN,
1114
  ])
1115

    
1116
# Instance Parameters Profile
1117
PP_DEFAULT = "default"
1118

    
1119
# NIC_* constants are used inside the ganeti config
1120
NIC_MODE = "mode"
1121
NIC_LINK = "link"
1122

    
1123
NIC_MODE_BRIDGED = "bridged"
1124
NIC_MODE_ROUTED = "routed"
1125

    
1126
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
1127

    
1128
NICS_PARAMETER_TYPES = {
1129
  NIC_MODE: VTYPE_STRING,
1130
  NIC_LINK: VTYPE_STRING,
1131
  }
1132

    
1133
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
1134

    
1135
# IDISK_* constants are used in opcodes, to create/change disks
1136
IDISK_SIZE = "size"
1137
IDISK_MODE = "mode"
1138
IDISK_ADOPT = "adopt"
1139
IDISK_VG = "vg"
1140
IDISK_METAVG = "metavg"
1141
IDISK_PROVIDER = "provider"
1142
IDISK_PARAMS_TYPES = {
1143
  IDISK_SIZE: VTYPE_SIZE,
1144
  IDISK_MODE: VTYPE_STRING,
1145
  IDISK_ADOPT: VTYPE_STRING,
1146
  IDISK_VG: VTYPE_STRING,
1147
  IDISK_METAVG: VTYPE_STRING,
1148
  IDISK_PROVIDER: VTYPE_STRING,
1149
  }
1150
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
1151

    
1152
# INIC_* constants are used in opcodes, to create/change nics
1153
INIC_MAC = "mac"
1154
INIC_IP = "ip"
1155
INIC_MODE = "mode"
1156
INIC_LINK = "link"
1157
INIC_PARAMS_TYPES = {
1158
  INIC_IP: VTYPE_MAYBE_STRING,
1159
  INIC_LINK: VTYPE_STRING,
1160
  INIC_MAC: VTYPE_STRING,
1161
  INIC_MODE: VTYPE_STRING,
1162
  }
1163
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
1164

    
1165
# Hypervisor constants
1166
HT_XEN_PVM = "xen-pvm"
1167
HT_FAKE = "fake"
1168
HT_XEN_HVM = "xen-hvm"
1169
HT_KVM = "kvm"
1170
HT_CHROOT = "chroot"
1171
HT_LXC = "lxc"
1172
HYPER_TYPES = frozenset([
1173
  HT_XEN_PVM,
1174
  HT_FAKE,
1175
  HT_XEN_HVM,
1176
  HT_KVM,
1177
  HT_CHROOT,
1178
  HT_LXC,
1179
  ])
1180
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
1181

    
1182
VNC_BASE_PORT = 5900
1183
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
1184
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
1185

    
1186
# NIC types
1187
HT_NIC_RTL8139 = "rtl8139"
1188
HT_NIC_NE2K_PCI = "ne2k_pci"
1189
HT_NIC_NE2K_ISA = "ne2k_isa"
1190
HT_NIC_I82551 = "i82551"
1191
HT_NIC_I85557B = "i82557b"
1192
HT_NIC_I8259ER = "i82559er"
1193
HT_NIC_PCNET = "pcnet"
1194
HT_NIC_E1000 = "e1000"
1195
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
1196

    
1197
HT_HVM_VALID_NIC_TYPES = frozenset([
1198
  HT_NIC_RTL8139,
1199
  HT_NIC_NE2K_PCI,
1200
  HT_NIC_E1000,
1201
  HT_NIC_NE2K_ISA,
1202
  HT_NIC_PARAVIRTUAL
1203
  ])
1204
HT_KVM_VALID_NIC_TYPES = frozenset([
1205
  HT_NIC_RTL8139,
1206
  HT_NIC_NE2K_PCI,
1207
  HT_NIC_NE2K_ISA,
1208
  HT_NIC_I82551,
1209
  HT_NIC_I85557B,
1210
  HT_NIC_I8259ER,
1211
  HT_NIC_PCNET,
1212
  HT_NIC_E1000,
1213
  HT_NIC_PARAVIRTUAL
1214
  ])
1215

    
1216
# Disk types
1217
HT_DISK_IOEMU = "ioemu"
1218
HT_DISK_IDE = "ide"
1219
HT_DISK_SCSI = "scsi"
1220
HT_DISK_SD = "sd"
1221
HT_DISK_MTD = "mtd"
1222
HT_DISK_PFLASH = "pflash"
1223

    
1224
HT_CACHE_DEFAULT = "default"
1225
HT_CACHE_NONE = "none"
1226
HT_CACHE_WTHROUGH = "writethrough"
1227
HT_CACHE_WBACK = "writeback"
1228
HT_VALID_CACHE_TYPES = frozenset([
1229
  HT_CACHE_DEFAULT,
1230
  HT_CACHE_NONE,
1231
  HT_CACHE_WTHROUGH,
1232
  HT_CACHE_WBACK
1233
  ])
1234

    
1235
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1236
HT_KVM_VALID_DISK_TYPES = frozenset([
1237
  HT_DISK_PARAVIRTUAL,
1238
  HT_DISK_IDE,
1239
  HT_DISK_SCSI,
1240
  HT_DISK_SD,
1241
  HT_DISK_MTD,
1242
  HT_DISK_PFLASH
1243
  ])
1244

    
1245
# Mouse types:
1246
HT_MOUSE_MOUSE = "mouse"
1247
HT_MOUSE_TABLET = "tablet"
1248

    
1249
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1250

    
1251
# Boot order
1252
HT_BO_FLOPPY = "floppy"
1253
HT_BO_CDROM = "cdrom"
1254
HT_BO_DISK = "disk"
1255
HT_BO_NETWORK = "network"
1256

    
1257
HT_KVM_VALID_BO_TYPES = frozenset([
1258
  HT_BO_FLOPPY,
1259
  HT_BO_CDROM,
1260
  HT_BO_DISK,
1261
  HT_BO_NETWORK
1262
  ])
1263

    
1264
# SPICE lossless image compression options
1265
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1266
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1267
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1268
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1269
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1270
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1271

    
1272
HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1273
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1274
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1275
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1276
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1277
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1278
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1279
  ])
1280

    
1281
# SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1282
HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1283
HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1284
HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1285

    
1286
HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1287
  HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1288
  HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1289
  HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1290
  ])
1291

    
1292
# SPICE video stream detection
1293
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1294
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1295
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1296

    
1297
HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1298
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1299
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1300
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1301
  ])
1302

    
1303
# Security models
1304
HT_SM_NONE = "none"
1305
HT_SM_USER = "user"
1306
HT_SM_POOL = "pool"
1307

    
1308
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1309

    
1310
# Kvm flag values
1311
HT_KVM_ENABLED = "enabled"
1312
HT_KVM_DISABLED = "disabled"
1313

    
1314
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1315

    
1316
# Migration type
1317
HT_MIGRATION_LIVE = "live"
1318
HT_MIGRATION_NONLIVE = "non-live"
1319
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1320

    
1321
# Cluster Verify steps
1322
VERIFY_NPLUSONE_MEM = "nplusone_mem"
1323
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1324

    
1325
# Cluster Verify error classes
1326
CV_TCLUSTER = "cluster"
1327
CV_TNODE = "node"
1328
CV_TINSTANCE = "instance"
1329

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

    
1405
CV_ALL_ECODES = frozenset([
1406
  CV_ECLUSTERCFG,
1407
  CV_ECLUSTERCERT,
1408
  CV_ECLUSTERFILECHECK,
1409
  CV_ECLUSTERDANGLINGNODES,
1410
  CV_ECLUSTERDANGLINGINST,
1411
  CV_EINSTANCEBADNODE,
1412
  CV_EINSTANCEDOWN,
1413
  CV_EINSTANCELAYOUT,
1414
  CV_EINSTANCEMISSINGDISK,
1415
  CV_EINSTANCEFAULTYDISK,
1416
  CV_EINSTANCEWRONGNODE,
1417
  CV_EINSTANCESPLITGROUPS,
1418
  CV_EINSTANCEPOLICY,
1419
  CV_ENODEDRBD,
1420
  CV_ENODEDRBDHELPER,
1421
  CV_ENODEFILECHECK,
1422
  CV_ENODEHOOKS,
1423
  CV_ENODEHV,
1424
  CV_ENODELVM,
1425
  CV_ENODEN1,
1426
  CV_ENODENET,
1427
  CV_ENODEOS,
1428
  CV_ENODEORPHANINSTANCE,
1429
  CV_ENODEORPHANLV,
1430
  CV_ENODERPC,
1431
  CV_ENODESSH,
1432
  CV_ENODEVERSION,
1433
  CV_ENODESETUP,
1434
  CV_ENODETIME,
1435
  CV_ENODEOOBPATH,
1436
  CV_ENODEUSERSCRIPTS,
1437
  ])
1438

    
1439
CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1440

    
1441
# Node verify constants
1442
NV_DRBDHELPER = "drbd-helper"
1443
NV_DRBDLIST = "drbd-list"
1444
NV_FILELIST = "filelist"
1445
NV_HVINFO = "hvinfo"
1446
NV_HYPERVISOR = "hypervisor"
1447
NV_HVPARAMS = "hvparms"
1448
NV_INSTANCELIST = "instancelist"
1449
NV_LVLIST = "lvlist"
1450
NV_MASTERIP = "master-ip"
1451
NV_NODELIST = "nodelist"
1452
NV_NODENETTEST = "node-net-test"
1453
NV_NODESETUP = "nodesetup"
1454
NV_OSLIST = "oslist"
1455
NV_PVLIST = "pvlist"
1456
NV_TIME = "time"
1457
NV_VERSION = "version"
1458
NV_VGLIST = "vglist"
1459
NV_VMNODES = "vmnodes"
1460
NV_OOB_PATHS = "oob-paths"
1461
NV_BRIDGES = "bridges"
1462
NV_USERSCRIPTS = "user-scripts"
1463

    
1464
# Instance status
1465
INSTST_RUNNING = "running"
1466
INSTST_ADMINDOWN = "ADMIN_down"
1467
INSTST_ADMINOFFLINE = "ADMIN_offline"
1468
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1469
INSTST_NODEDOWN = "ERROR_nodedown"
1470
INSTST_WRONGNODE = "ERROR_wrongnode"
1471
INSTST_ERRORUP = "ERROR_up"
1472
INSTST_ERRORDOWN = "ERROR_down"
1473
INSTST_ALL = frozenset([
1474
  INSTST_RUNNING,
1475
  INSTST_ADMINDOWN,
1476
  INSTST_ADMINOFFLINE,
1477
  INSTST_NODEOFFLINE,
1478
  INSTST_NODEDOWN,
1479
  INSTST_WRONGNODE,
1480
  INSTST_ERRORUP,
1481
  INSTST_ERRORDOWN,
1482
  ])
1483

    
1484
# Admin states
1485
ADMINST_UP = "up"
1486
ADMINST_DOWN = "down"
1487
ADMINST_OFFLINE = "offline"
1488
ADMINST_ALL = frozenset([
1489
  ADMINST_UP,
1490
  ADMINST_DOWN,
1491
  ADMINST_OFFLINE,
1492
  ])
1493

    
1494
# Node roles
1495
NR_REGULAR = "R"
1496
NR_MASTER = "M"
1497
NR_MCANDIDATE = "C"
1498
NR_DRAINED = "D"
1499
NR_OFFLINE = "O"
1500
NR_ALL = frozenset([
1501
  NR_REGULAR,
1502
  NR_MASTER,
1503
  NR_MCANDIDATE,
1504
  NR_DRAINED,
1505
  NR_OFFLINE,
1506
  ])
1507

    
1508
# SSL certificate check constants (in days)
1509
SSL_CERT_EXPIRATION_WARN = 30
1510
SSL_CERT_EXPIRATION_ERROR = 7
1511

    
1512
# Allocator framework constants
1513
IALLOCATOR_VERSION = 2
1514
IALLOCATOR_DIR_IN = "in"
1515
IALLOCATOR_DIR_OUT = "out"
1516
VALID_IALLOCATOR_DIRECTIONS = frozenset([
1517
  IALLOCATOR_DIR_IN,
1518
  IALLOCATOR_DIR_OUT,
1519
  ])
1520
IALLOCATOR_MODE_ALLOC = "allocate"
1521
IALLOCATOR_MODE_RELOC = "relocate"
1522
IALLOCATOR_MODE_CHG_GROUP = "change-group"
1523
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1524
VALID_IALLOCATOR_MODES = frozenset([
1525
  IALLOCATOR_MODE_ALLOC,
1526
  IALLOCATOR_MODE_RELOC,
1527
  IALLOCATOR_MODE_CHG_GROUP,
1528
  IALLOCATOR_MODE_NODE_EVAC,
1529
  ])
1530
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1531

    
1532
IALLOCATOR_NEVAC_PRI = "primary-only"
1533
IALLOCATOR_NEVAC_SEC = "secondary-only"
1534
IALLOCATOR_NEVAC_ALL = "all"
1535
IALLOCATOR_NEVAC_MODES = frozenset([
1536
  IALLOCATOR_NEVAC_PRI,
1537
  IALLOCATOR_NEVAC_SEC,
1538
  IALLOCATOR_NEVAC_ALL,
1539
  ])
1540

    
1541
# Node evacuation
1542
NODE_EVAC_PRI = "primary-only"
1543
NODE_EVAC_SEC = "secondary-only"
1544
NODE_EVAC_ALL = "all"
1545
NODE_EVAC_MODES = frozenset([
1546
  NODE_EVAC_PRI,
1547
  NODE_EVAC_SEC,
1548
  NODE_EVAC_ALL,
1549
  ])
1550

    
1551
# Job queue
1552
JOB_QUEUE_VERSION = 1
1553
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1554
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1555
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1556
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1557
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1558
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1559

    
1560
JOB_ID_TEMPLATE = r"\d+"
1561
JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1562

    
1563
# unchanged job return
1564
JOB_NOTCHANGED = "nochange"
1565

    
1566
# Job status
1567
JOB_STATUS_QUEUED = "queued"
1568
JOB_STATUS_WAITING = "waiting"
1569
JOB_STATUS_CANCELING = "canceling"
1570
JOB_STATUS_RUNNING = "running"
1571
JOB_STATUS_CANCELED = "canceled"
1572
JOB_STATUS_SUCCESS = "success"
1573
JOB_STATUS_ERROR = "error"
1574
JOBS_FINALIZED = frozenset([
1575
  JOB_STATUS_CANCELED,
1576
  JOB_STATUS_SUCCESS,
1577
  JOB_STATUS_ERROR,
1578
  ])
1579
JOB_STATUS_ALL = frozenset([
1580
  JOB_STATUS_QUEUED,
1581
  JOB_STATUS_WAITING,
1582
  JOB_STATUS_CANCELING,
1583
  JOB_STATUS_RUNNING,
1584
  ]) | JOBS_FINALIZED
1585

    
1586
# OpCode status
1587
# not yet finalized
1588
OP_STATUS_QUEUED = "queued"
1589
OP_STATUS_WAITING = "waiting"
1590
OP_STATUS_CANCELING = "canceling"
1591
OP_STATUS_RUNNING = "running"
1592
# finalized
1593
OP_STATUS_CANCELED = "canceled"
1594
OP_STATUS_SUCCESS = "success"
1595
OP_STATUS_ERROR = "error"
1596
OPS_FINALIZED = frozenset([
1597
  OP_STATUS_CANCELED,
1598
  OP_STATUS_SUCCESS,
1599
  OP_STATUS_ERROR
1600
  ])
1601

    
1602
# OpCode priority
1603
OP_PRIO_LOWEST = +19
1604
OP_PRIO_HIGHEST = -20
1605

    
1606
OP_PRIO_LOW = +10
1607
OP_PRIO_NORMAL = 0
1608
OP_PRIO_HIGH = -10
1609

    
1610
OP_PRIO_SUBMIT_VALID = frozenset([
1611
  OP_PRIO_LOW,
1612
  OP_PRIO_NORMAL,
1613
  OP_PRIO_HIGH,
1614
  ])
1615

    
1616
OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1617

    
1618
# Lock recalculate mode
1619
LOCKS_REPLACE = "replace"
1620
LOCKS_APPEND = "append"
1621

    
1622
# Lock timeout (sum) before we should go into blocking acquire (still
1623
# can be reset by priority change); computed as max time (10 hours)
1624
# before we should actually go into blocking acquire given that we
1625
# start from default priority level; in seconds
1626
# TODO
1627
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / (OP_PRIO_DEFAULT - OP_PRIO_HIGHEST)
1628
LOCK_ATTEMPTS_MAXWAIT = 15.0
1629
LOCK_ATTEMPTS_MINWAIT = 1.0
1630

    
1631
# Execution log types
1632
ELOG_MESSAGE = "message"
1633
ELOG_REMOTE_IMPORT = "remote-import"
1634
ELOG_JQUEUE_TEST = "jqueue-test"
1635

    
1636
# /etc/hosts modification
1637
ETC_HOSTS_ADD = "add"
1638
ETC_HOSTS_REMOVE = "remove"
1639

    
1640
# Job queue test
1641
JQT_MSGPREFIX = "TESTMSG="
1642
JQT_EXPANDNAMES = "expandnames"
1643
JQT_EXEC = "exec"
1644
JQT_LOGMSG = "logmsg"
1645
JQT_STARTMSG = "startmsg"
1646
JQT_ALL = frozenset([
1647
  JQT_EXPANDNAMES,
1648
  JQT_EXEC,
1649
  JQT_LOGMSG,
1650
  JQT_STARTMSG,
1651
  ])
1652

    
1653
# Query resources
1654
QR_CLUSTER = "cluster"
1655
QR_INSTANCE = "instance"
1656
QR_NODE = "node"
1657
QR_LOCK = "lock"
1658
QR_GROUP = "group"
1659
QR_OS = "os"
1660
QR_JOB = "job"
1661
QR_EXPORT = "export"
1662

    
1663
#: List of resources which can be queried using L{opcodes.OpQuery}
1664
QR_VIA_OP = frozenset([
1665
  QR_CLUSTER,
1666
  QR_INSTANCE,
1667
  QR_NODE,
1668
  QR_GROUP,
1669
  QR_OS,
1670
  QR_EXPORT,
1671
  ])
1672

    
1673
#: List of resources which can be queried using Local UniX Interface
1674
QR_VIA_LUXI = QR_VIA_OP.union([
1675
  QR_LOCK,
1676
  QR_JOB,
1677
  ])
1678

    
1679
#: List of resources which can be queried using RAPI
1680
QR_VIA_RAPI = QR_VIA_LUXI
1681

    
1682
# Query field types
1683
QFT_UNKNOWN = "unknown"
1684
QFT_TEXT = "text"
1685
QFT_BOOL = "bool"
1686
QFT_NUMBER = "number"
1687
QFT_UNIT = "unit"
1688
QFT_TIMESTAMP = "timestamp"
1689
QFT_OTHER = "other"
1690

    
1691
#: All query field types
1692
QFT_ALL = frozenset([
1693
  QFT_UNKNOWN,
1694
  QFT_TEXT,
1695
  QFT_BOOL,
1696
  QFT_NUMBER,
1697
  QFT_UNIT,
1698
  QFT_TIMESTAMP,
1699
  QFT_OTHER,
1700
  ])
1701

    
1702
# Query result field status (don't change or reuse values as they're used by
1703
# clients)
1704
#: Normal field status
1705
RS_NORMAL = 0
1706
#: Unknown field
1707
RS_UNKNOWN = 1
1708
#: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1709
RS_NODATA = 2
1710
#: Value unavailable/unsupported for item; if this field is supported
1711
#: but we cannot get the data for the moment, RS_NODATA or
1712
#: RS_OFFLINE should be used
1713
RS_UNAVAIL = 3
1714
#: Resource marked offline
1715
RS_OFFLINE = 4
1716

    
1717
RS_ALL = frozenset([
1718
  RS_NORMAL,
1719
  RS_UNKNOWN,
1720
  RS_NODATA,
1721
  RS_UNAVAIL,
1722
  RS_OFFLINE,
1723
  ])
1724

    
1725
#: Dictionary with special field cases and their verbose/terse formatting
1726
RSS_DESCRIPTION = {
1727
  RS_UNKNOWN: ("(unknown)", "??"),
1728
  RS_NODATA: ("(nodata)", "?"),
1729
  RS_OFFLINE: ("(offline)", "*"),
1730
  RS_UNAVAIL: ("(unavail)", "-"),
1731
  }
1732

    
1733
# max dynamic devices
1734
MAX_NICS = 8
1735
MAX_DISKS = 16
1736

    
1737
# SSCONF file prefix
1738
SSCONF_FILEPREFIX = "ssconf_"
1739
# SSCONF keys
1740
SS_CLUSTER_NAME = "cluster_name"
1741
SS_CLUSTER_TAGS = "cluster_tags"
1742
SS_FILE_STORAGE_DIR = "file_storage_dir"
1743
SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1744
SS_MASTER_CANDIDATES = "master_candidates"
1745
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1746
SS_MASTER_IP = "master_ip"
1747
SS_MASTER_NETDEV = "master_netdev"
1748
SS_MASTER_NETMASK = "master_netmask"
1749
SS_MASTER_NODE = "master_node"
1750
SS_NODE_LIST = "node_list"
1751
SS_NODE_PRIMARY_IPS = "node_primary_ips"
1752
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1753
SS_OFFLINE_NODES = "offline_nodes"
1754
SS_ONLINE_NODES = "online_nodes"
1755
SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1756
SS_INSTANCE_LIST = "instance_list"
1757
SS_RELEASE_VERSION = "release_version"
1758
SS_HYPERVISOR_LIST = "hypervisor_list"
1759
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1760
SS_UID_POOL = "uid_pool"
1761
SS_NODEGROUPS = "nodegroups"
1762

    
1763
SS_FILE_PERMS = 0444
1764

    
1765
# cluster wide default parameters
1766
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1767

    
1768
HVC_DEFAULTS = {
1769
  HT_XEN_PVM: {
1770
    HV_USE_BOOTLOADER: False,
1771
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1772
    HV_BOOTLOADER_ARGS: "",
1773
    HV_KERNEL_PATH: XEN_KERNEL,
1774
    HV_INITRD_PATH: "",
1775
    HV_ROOT_PATH: "/dev/sda1",
1776
    HV_KERNEL_ARGS: "ro",
1777
    HV_MIGRATION_PORT: 8002,
1778
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1779
    HV_BLOCKDEV_PREFIX: "sd",
1780
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1781
    HV_CPU_MASK: CPU_PINNING_ALL,
1782
    },
1783
  HT_XEN_HVM: {
1784
    HV_BOOT_ORDER: "cd",
1785
    HV_CDROM_IMAGE_PATH: "",
1786
    HV_NIC_TYPE: HT_NIC_RTL8139,
1787
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1788
    HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1789
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1790
    HV_ACPI: True,
1791
    HV_PAE: True,
1792
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1793
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1794
    HV_MIGRATION_PORT: 8002,
1795
    HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1796
    HV_USE_LOCALTIME: False,
1797
    HV_BLOCKDEV_PREFIX: "hd",
1798
    HV_PASSTHROUGH: "",
1799
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1800
    HV_CPU_MASK: CPU_PINNING_ALL,
1801
    },
1802
  HT_KVM: {
1803
    HV_KERNEL_PATH: KVM_KERNEL,
1804
    HV_INITRD_PATH: "",
1805
    HV_KERNEL_ARGS: "ro",
1806
    HV_ROOT_PATH: "/dev/vda1",
1807
    HV_ACPI: True,
1808
    HV_SERIAL_CONSOLE: True,
1809
    HV_VNC_BIND_ADDRESS: "",
1810
    HV_VNC_TLS: False,
1811
    HV_VNC_X509: "",
1812
    HV_VNC_X509_VERIFY: False,
1813
    HV_VNC_PASSWORD_FILE: "",
1814
    HV_KVM_SPICE_BIND: "",
1815
    HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1816
    HV_KVM_SPICE_PASSWORD_FILE: "",
1817
    HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1818
    HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1819
    HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1820
    HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1821
    HV_KVM_SPICE_AUDIO_COMPR: True,
1822
    HV_KVM_SPICE_USE_TLS: False,
1823
    HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1824
    HV_KVM_SPICE_USE_VDAGENT: True,
1825
    HV_KVM_FLOPPY_IMAGE_PATH: "",
1826
    HV_CDROM_IMAGE_PATH: "",
1827
    HV_KVM_CDROM2_IMAGE_PATH: "",
1828
    HV_BOOT_ORDER: HT_BO_DISK,
1829
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1830
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1831
    HV_KVM_CDROM_DISK_TYPE: "",
1832
    HV_USB_MOUSE: "",
1833
    HV_KEYMAP: "",
1834
    HV_MIGRATION_PORT: 8102,
1835
    HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1836
    HV_MIGRATION_DOWNTIME: 30,  # ms
1837
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1838
    HV_USE_LOCALTIME: False,
1839
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
1840
    HV_SECURITY_MODEL: HT_SM_NONE,
1841
    HV_SECURITY_DOMAIN: "",
1842
    HV_KVM_FLAG: "",
1843
    HV_VHOST_NET: False,
1844
    HV_KVM_USE_CHROOT: False,
1845
    HV_MEM_PATH: "",
1846
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1847
    HV_CPU_MASK: CPU_PINNING_ALL,
1848
    },
1849
  HT_FAKE: {
1850
    },
1851
  HT_CHROOT: {
1852
    HV_INIT_SCRIPT: "/ganeti-chroot",
1853
    },
1854
  HT_LXC: {
1855
    HV_CPU_MASK: "",
1856
    },
1857
  }
1858

    
1859
HVC_GLOBALS = frozenset([
1860
  HV_MIGRATION_PORT,
1861
  HV_MIGRATION_BANDWIDTH,
1862
  HV_MIGRATION_MODE,
1863
  ])
1864

    
1865
BEC_DEFAULTS = {
1866
  BE_MINMEM: 128,
1867
  BE_MAXMEM: 128,
1868
  BE_VCPUS: 1,
1869
  BE_AUTO_BALANCE: True,
1870
  BE_ALWAYS_FAILOVER: False,
1871
  BE_SPINDLE_USE: 1,
1872
  }
1873

    
1874
NDC_DEFAULTS = {
1875
  ND_OOB_PROGRAM: None,
1876
  ND_SPINDLE_COUNT: 1,
1877
  }
1878

    
1879
DISK_LD_DEFAULTS = {
1880
  LD_DRBD8: {
1881
    LDP_RESYNC_RATE: CLASSIC_DRBD_SYNC_SPEED,
1882
    LDP_BARRIERS: _autoconf.DRBD_BARRIERS,
1883
    LDP_NO_META_FLUSH: _autoconf.DRBD_NO_META_FLUSH,
1884
    LDP_DEFAULT_METAVG: DEFAULT_VG,
1885
    LDP_DISK_CUSTOM: "",
1886
    LDP_NET_CUSTOM: "",
1887
    LDP_DYNAMIC_RESYNC: False,
1888

    
1889
    # The default values for the DRBD dynamic resync speed algorithm are taken
1890
    # from the drbsetup 8.3.11 man page, except for c-plan-ahead (that we
1891
    # don't need to set to 0, because we have a separate option to enable it)
1892
    # and for c-max-rate, that we cap to the default value for the static resync
1893
    # rate.
1894
    LDP_PLAN_AHEAD: 20, # ds
1895
    LDP_FILL_TARGET: 0, # sectors
1896
    LDP_DELAY_TARGET: 1, # ds
1897
    LDP_MAX_RATE: CLASSIC_DRBD_SYNC_SPEED, # KiB/s
1898
    LDP_MIN_RATE: 4 * 1024, # KiB/s
1899
    },
1900
  LD_LV: {
1901
    LDP_STRIPES: _autoconf.LVM_STRIPECOUNT
1902
    },
1903
  LD_FILE: {
1904
    },
1905
  LD_BLOCKDEV: {
1906
    },
1907
  LD_RBD: {
1908
    LDP_POOL: "rbd"
1909
    },
1910
  LD_EXT: {
1911
    },
1912
  }
1913

    
1914
# readability shortcuts
1915
_LV_DEFAULTS = DISK_LD_DEFAULTS[LD_LV]
1916
_DRBD_DEFAULTS = DISK_LD_DEFAULTS[LD_DRBD8]
1917

    
1918
DISK_DT_DEFAULTS = {
1919
  DT_PLAIN: {
1920
    LV_STRIPES: DISK_LD_DEFAULTS[LD_LV][LDP_STRIPES],
1921
    },
1922
  DT_DRBD8: {
1923
    DRBD_RESYNC_RATE: _DRBD_DEFAULTS[LDP_RESYNC_RATE],
1924
    DRBD_DATA_STRIPES: _LV_DEFAULTS[LDP_STRIPES],
1925
    DRBD_META_STRIPES: _LV_DEFAULTS[LDP_STRIPES],
1926
    DRBD_DISK_BARRIERS: _DRBD_DEFAULTS[LDP_BARRIERS],
1927
    DRBD_META_BARRIERS: _DRBD_DEFAULTS[LDP_NO_META_FLUSH],
1928
    DRBD_DEFAULT_METAVG: _DRBD_DEFAULTS[LDP_DEFAULT_METAVG],
1929
    DRBD_DISK_CUSTOM: _DRBD_DEFAULTS[LDP_DISK_CUSTOM],
1930
    DRBD_NET_CUSTOM: _DRBD_DEFAULTS[LDP_NET_CUSTOM],
1931
    DRBD_DYNAMIC_RESYNC: _DRBD_DEFAULTS[LDP_DYNAMIC_RESYNC],
1932
    DRBD_PLAN_AHEAD: _DRBD_DEFAULTS[LDP_PLAN_AHEAD],
1933
    DRBD_FILL_TARGET: _DRBD_DEFAULTS[LDP_FILL_TARGET],
1934
    DRBD_DELAY_TARGET: _DRBD_DEFAULTS[LDP_DELAY_TARGET],
1935
    DRBD_MAX_RATE: _DRBD_DEFAULTS[LDP_MAX_RATE],
1936
    DRBD_MIN_RATE: _DRBD_DEFAULTS[LDP_MIN_RATE],
1937
    },
1938
  DT_DISKLESS: {
1939
    },
1940
  DT_FILE: {
1941
    },
1942
  DT_SHARED_FILE: {
1943
    },
1944
  DT_BLOCK: {
1945
    },
1946
  DT_RBD: {
1947
    RBD_POOL: DISK_LD_DEFAULTS[LD_RBD][LDP_POOL]
1948
    },
1949
  DT_EXT: {
1950
    },
1951
  }
1952

    
1953
# we don't want to export the shortcuts
1954
del _LV_DEFAULTS, _DRBD_DEFAULTS
1955

    
1956
NICC_DEFAULTS = {
1957
  NIC_MODE: NIC_MODE_BRIDGED,
1958
  NIC_LINK: DEFAULT_BRIDGE,
1959
  }
1960

    
1961
# All of the following values are quite arbitrarily - there are no
1962
# "good" defaults, these must be customised per-site
1963
IPOLICY_DEFAULTS = {
1964
  ISPECS_MIN: {
1965
    ISPEC_MEM_SIZE: 128,
1966
    ISPEC_CPU_COUNT: 1,
1967
    ISPEC_DISK_COUNT: 1,
1968
    ISPEC_DISK_SIZE: 1024,
1969
    ISPEC_NIC_COUNT: 1,
1970
    ISPEC_SPINDLE_USE: 1,
1971
    },
1972
  ISPECS_MAX: {
1973
    ISPEC_MEM_SIZE: 32768,
1974
    ISPEC_CPU_COUNT: 8,
1975
    ISPEC_DISK_COUNT: MAX_DISKS,
1976
    ISPEC_DISK_SIZE: 1024 * 1024,
1977
    ISPEC_NIC_COUNT: MAX_NICS,
1978
    ISPEC_SPINDLE_USE: 12,
1979
    },
1980
  ISPECS_STD: {
1981
    ISPEC_MEM_SIZE: 128,
1982
    ISPEC_CPU_COUNT: 1,
1983
    ISPEC_DISK_COUNT: 1,
1984
    ISPEC_DISK_SIZE: 1024,
1985
    ISPEC_NIC_COUNT: 1,
1986
    ISPEC_SPINDLE_USE: 1,
1987
    },
1988
  IPOLICY_DTS: DISK_TEMPLATES,
1989
  IPOLICY_VCPU_RATIO: 4.0,
1990
  IPOLICY_SPINDLE_RATIO: 32.0,
1991
  }
1992

    
1993
MASTER_POOL_SIZE_DEFAULT = 10
1994

    
1995
CONFD_PROTOCOL_VERSION = 1
1996

    
1997
CONFD_REQ_PING = 0
1998
CONFD_REQ_NODE_ROLE_BYNAME = 1
1999
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
2000
CONFD_REQ_CLUSTER_MASTER = 3
2001
CONFD_REQ_NODE_PIP_LIST = 4
2002
CONFD_REQ_MC_PIP_LIST = 5
2003
CONFD_REQ_INSTANCES_IPS_LIST = 6
2004

    
2005
# Confd request query fields. These are used to narrow down queries.
2006
# These must be strings rather than integers, because json-encoding
2007
# converts them to strings anyway, as they're used as dict-keys.
2008
CONFD_REQQ_LINK = "0"
2009
CONFD_REQQ_IP = "1"
2010
CONFD_REQQ_IPLIST = "2"
2011
CONFD_REQQ_FIELDS = "3"
2012

    
2013
CONFD_REQFIELD_NAME = "0"
2014
CONFD_REQFIELD_IP = "1"
2015
CONFD_REQFIELD_MNODE_PIP = "2"
2016

    
2017
CONFD_REQS = frozenset([
2018
  CONFD_REQ_PING,
2019
  CONFD_REQ_NODE_ROLE_BYNAME,
2020
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
2021
  CONFD_REQ_CLUSTER_MASTER,
2022
  CONFD_REQ_NODE_PIP_LIST,
2023
  CONFD_REQ_MC_PIP_LIST,
2024
  CONFD_REQ_INSTANCES_IPS_LIST,
2025
  ])
2026

    
2027
CONFD_REPL_STATUS_OK = 0
2028
CONFD_REPL_STATUS_ERROR = 1
2029
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
2030

    
2031
CONFD_REPL_STATUSES = frozenset([
2032
  CONFD_REPL_STATUS_OK,
2033
  CONFD_REPL_STATUS_ERROR,
2034
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
2035
  ])
2036

    
2037
(CONFD_NODE_ROLE_MASTER,
2038
 CONFD_NODE_ROLE_CANDIDATE,
2039
 CONFD_NODE_ROLE_OFFLINE,
2040
 CONFD_NODE_ROLE_DRAINED,
2041
 CONFD_NODE_ROLE_REGULAR,
2042
 ) = range(5)
2043

    
2044
# A few common errors for confd
2045
CONFD_ERROR_UNKNOWN_ENTRY = 1
2046
CONFD_ERROR_INTERNAL = 2
2047
CONFD_ERROR_ARGUMENT = 3
2048

    
2049
# Each request is "salted" by the current timestamp.
2050
# This constants decides how many seconds of skew to accept.
2051
# TODO: make this a default and allow the value to be more configurable
2052
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
2053

    
2054
# When we haven't reloaded the config for more than this amount of seconds, we
2055
# force a test to see if inotify is betraying us.
2056
CONFD_CONFIG_RELOAD_TIMEOUT = 60
2057

    
2058
# If we receive more than one update in this amount of seconds, we move to
2059
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
2060
# to serve more requests.
2061
CONFD_CONFIG_RELOAD_RATELIMIT = 2
2062

    
2063
# Magic number prepended to all confd queries.
2064
# This allows us to distinguish different types of confd protocols and handle
2065
# them. For example by changing this we can move the whole payload to be
2066
# compressed, or move away from json.
2067
CONFD_MAGIC_FOURCC = "plj0"
2068

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

    
2074
# Timeout in seconds to expire pending query request in the confd client
2075
# library. We don't actually expect any answer more than 10 seconds after we
2076
# sent a request.
2077
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
2078

    
2079
# Maximum UDP datagram size.
2080
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
2081
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
2082
#   (assuming we can't use jumbo frames)
2083
# We just set this to 60K, which should be enough
2084
MAX_UDP_DATA_SIZE = 61440
2085

    
2086
# User-id pool minimum/maximum acceptable user-ids.
2087
UIDPOOL_UID_MIN = 0
2088
UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
2089

    
2090
# Name or path of the pgrep command
2091
PGREP = "pgrep"
2092

    
2093
# Name of the node group that gets created at cluster init or upgrade
2094
INITIAL_NODE_GROUP_NAME = "default"
2095

    
2096
# Possible values for NodeGroup.alloc_policy
2097
ALLOC_POLICY_PREFERRED = "preferred"
2098
ALLOC_POLICY_LAST_RESORT = "last_resort"
2099
ALLOC_POLICY_UNALLOCABLE = "unallocable"
2100
VALID_ALLOC_POLICIES = [
2101
  ALLOC_POLICY_PREFERRED,
2102
  ALLOC_POLICY_LAST_RESORT,
2103
  ALLOC_POLICY_UNALLOCABLE,
2104
  ]
2105

    
2106
# Temporary external/shared storage parameters
2107
BLOCKDEV_DRIVER_MANUAL = "manual"
2108
EXTSTORAGE_SAMPLE_PROVIDER = "rbd"
2109

    
2110
# qemu-img path, required for ovfconverter
2111
QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
2112

    
2113
# Whether htools was enabled at compilation time
2114
HTOOLS = _autoconf.HTOOLS
2115
# The hail iallocator
2116
IALLOC_HAIL = "hail"
2117

    
2118
# Fake opcodes for functions that have hooks attached to them via
2119
# backend.RunLocalHooks
2120
FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
2121
FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
2122

    
2123
# Do not re-export imported modules
2124
del re, _vcsversion, _autoconf, socket