Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 85d96a3c

History | View | Annotate | Download (56.2 kB)

1
#
2
#
3

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

    
21

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

    
24
import re
25
import socket
26

    
27
from ganeti import _autoconf
28
from ganeti import _vcsversion
29

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

    
40

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

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

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

58
  Returns: int representing version number
59

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

    
68

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

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

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

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

    
80
  return (major, minor, revision)
81

    
82

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

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

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

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

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

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

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

    
132

    
133
# file paths
134
DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
135
RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
136
RUN_GANETI_DIR = RUN_DIR + "/ganeti"
137
BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
138
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
139
RUN_DIRS_MODE = 0775
140
SOCKET_DIR = RUN_GANETI_DIR + "/socket"
141
SECURE_DIR_MODE = 0700
142
SECURE_FILE_MODE = 0600
143
CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
144
IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
145
ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
146
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
147
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
148
# User-id pool lock directory
149
# The user-ids that are in use have a corresponding lock file in this directory
150
UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
151
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
152
NODED_CERT_FILE = DATA_DIR + "/server.pem"
153
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
154
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
155
SPICE_CERT_FILE = DATA_DIR + "/spice.pem"
156
SPICE_CACERT_FILE = DATA_DIR + "/spice-ca.pem"
157
CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
158
INSTANCE_STATUS_FILE = RUN_GANETI_DIR + "/instance-status"
159
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
160
RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
161
QUEUE_DIR = DATA_DIR + "/queue"
162
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
163
SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
164
KVM_IFUP = _autoconf.PKGLIBDIR + "/kvm-ifup"
165
KVM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/kvm-console-wrapper"
166
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
HS_CONFD = _autoconf.HS_CONFD
178
ENABLE_SPLIT_QUERY = _autoconf.ENABLE_SPLIT_QUERY
179

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

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

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

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

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

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

    
205
#: LUXI socket used for job execution
206
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
207
#: LUXI socket used for queries only
208
QUERY_SOCKET = SOCKET_DIR + "/ganeti-query"
209

    
210
NODED = "ganeti-noded"
211
CONFD = "ganeti-confd"
212
RAPI = "ganeti-rapi"
213
MASTERD = "ganeti-masterd"
214
# used in the ganeti-nbma project
215
NLD = "ganeti-nld"
216

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

    
232
FIRST_DRBD_PORT = 11000
233
LAST_DRBD_PORT = 14999
234

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

    
246
LOG_OS_DIR = LOG_DIR + "os"
247
LOG_WATCHER = LOG_DIR + "watcher.log"
248
LOG_COMMANDS = LOG_DIR + "commands.log"
249
LOG_BURNIN = LOG_DIR + "burnin.log"
250
LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
251

    
252
DEV_CONSOLE = "/dev/console"
253

    
254
PROC_MOUNTS = "/proc/mounts"
255

    
256
# Local UniX Interface related constants
257
LUXI_EOM = "\3"
258
LUXI_VERSION = CONFIG_VERSION
259

    
260
# one of "no", "yes", "only"
261
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
262
SYSLOG_NO = "no"
263
SYSLOG_YES = "yes"
264
SYSLOG_ONLY = "only"
265
SYSLOG_SOCKET = "/dev/log"
266

    
267
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
268
EXPORT_DIR = _autoconf.EXPORT_DIR
269

    
270
EXPORT_CONF_FILE = "config.ini"
271

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

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

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

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

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

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

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

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

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

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

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

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

    
324
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
325

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

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

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

    
340
IE_CUSTOM_SIZE = "fd"
341

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
534
# instance creation modes
535
INSTANCE_CREATE = "create"
536
INSTANCE_IMPORT = "import"
537
INSTANCE_REMOTE_IMPORT = "remote-import"
538
INSTANCE_CREATE_MODES = frozenset([
539
  INSTANCE_CREATE,
540
  INSTANCE_IMPORT,
541
  INSTANCE_REMOTE_IMPORT,
542
  ])
543

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

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

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

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

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

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

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

    
573
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
574

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

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

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

    
600
#: Exit code for query operations with unknown fields
601
EXIT_UNKNOWN_FIELD = 14
602

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

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

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

    
646
#: Key for job IDs in opcode result
647
JOB_IDS_KEY = "jobs"
648

    
649
# runparts results
650
(RUNPARTS_SKIP,
651
 RUNPARTS_RUN,
652
 RUNPARTS_ERR) = range(3)
653

    
654
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
655

    
656
# RPC constants
657
(RPC_ENCODING_NONE,
658
 RPC_ENCODING_ZLIB_BASE64) = range(2)
659

    
660
# Various time constants for the timeout table
661
RPC_TMO_URGENT = 60 # one minute
662
RPC_TMO_FAST = 5 * 60 # five minutes
663
RPC_TMO_NORMAL = 15 * 60 # 15 minutes
664
RPC_TMO_SLOW = 3600 # one hour
665
RPC_TMO_4HRS = 4 * 3600
666
RPC_TMO_1DAY = 86400
667

    
668
# Timeout for connecting to nodes (seconds)
669
RPC_CONNECT_TIMEOUT = 5
670

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

    
685
OS_API_FILE = "ganeti_api_version"
686
OS_VARIANTS_FILE = "variants.list"
687
OS_PARAMETERS_FILE = "parameters.list"
688

    
689
OS_VALIDATE_PARAMETERS = "parameters"
690
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
691

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

    
701
# reboot types
702
INSTANCE_REBOOT_SOFT = "soft"
703
INSTANCE_REBOOT_HARD = "hard"
704
INSTANCE_REBOOT_FULL = "full"
705

    
706
REBOOT_TYPES = frozenset([
707
  INSTANCE_REBOOT_SOFT,
708
  INSTANCE_REBOOT_HARD,
709
  INSTANCE_REBOOT_FULL
710
  ])
711

    
712
# instance reboot behaviors
713
INSTANCE_REBOOT_ALLOWED = "reboot"
714
INSTANCE_REBOOT_EXIT = "exit"
715

    
716
REBOOT_BEHAVIORS = frozenset([
717
  INSTANCE_REBOOT_ALLOWED,
718
  INSTANCE_REBOOT_EXIT
719
  ])
720

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

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

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

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

    
850
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
851

    
852
HVS_PARAMETER_TITLES = {
853
  HV_ACPI: "ACPI",
854
  HV_BOOT_ORDER: "Boot_order",
855
  HV_CDROM_IMAGE_PATH: "CDROM_image_path",
856
  HV_DISK_TYPE: "Disk_type",
857
  HV_INITRD_PATH: "Initrd_path",
858
  HV_KERNEL_PATH: "Kernel_path",
859
  HV_NIC_TYPE: "NIC_type",
860
  HV_PAE: "PAE",
861
  HV_VNC_BIND_ADDRESS: "VNC_bind_address",
862
  HV_PASSTHROUGH: "pci_pass",
863
  HV_CPU_TYPE: "cpu_type",
864
  }
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_TITLES = {
954
  BE_AUTO_BALANCE: "Auto_balance",
955
  BE_MAXMEM: "ConfigMaxMem",
956
  BE_MINMEM: "ConfigMinMem",
957
  BE_VCPUS: "ConfigVCPUs",
958
  }
959

    
960
BES_PARAMETER_COMPAT = {
961
  BE_MEMORY: VTYPE_SIZE,
962
  }
963
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)
964

    
965
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
966

    
967
# instance specs
968
ISPEC_MEM_SIZE = "memory-size"
969
ISPEC_CPU_COUNT = "cpu-count"
970
ISPEC_DISK_COUNT = "disk-count"
971
ISPEC_DISK_SIZE = "disk-size"
972
ISPEC_NIC_COUNT = "nic-count"
973
ISPEC_SPINDLE_USE = "spindle-use"
974

    
975
ISPECS_PARAMETER_TYPES = {
976
  ISPEC_MEM_SIZE: VTYPE_INT,
977
  ISPEC_CPU_COUNT: VTYPE_INT,
978
  ISPEC_DISK_COUNT: VTYPE_INT,
979
  ISPEC_DISK_SIZE: VTYPE_INT,
980
  ISPEC_NIC_COUNT: VTYPE_INT,
981
  ISPEC_SPINDLE_USE: VTYPE_INT,
982
  }
983

    
984
ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())
985

    
986
ISPECS_MIN = "min"
987
ISPECS_MAX = "max"
988
ISPECS_STD = "std"
989
IPOLICY_DTS = "disk-templates"
990
IPOLICY_VCPU_RATIO = "vcpu-ratio"
991
IPOLICY_SPINDLE_RATIO = "spindle-ratio"
992

    
993
IPOLICY_ISPECS = frozenset([
994
  ISPECS_MIN,
995
  ISPECS_MAX,
996
  ISPECS_STD,
997
  ])
998

    
999
IPOLICY_PARAMETERS = frozenset([
1000
  IPOLICY_VCPU_RATIO,
1001
  IPOLICY_SPINDLE_RATIO,
1002
  ])
1003

    
1004
IPOLICY_ALL_KEYS = (IPOLICY_ISPECS |
1005
                    IPOLICY_PARAMETERS |
1006
                    frozenset([IPOLICY_DTS]))
1007

    
1008
# Node parameter names
1009
ND_OOB_PROGRAM = "oob_program"
1010
ND_SPINDLE_COUNT = "spindle_count"
1011

    
1012
NDS_PARAMETER_TYPES = {
1013
  ND_OOB_PROGRAM: VTYPE_STRING,
1014
  ND_SPINDLE_COUNT: VTYPE_INT,
1015
  }
1016

    
1017
NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
1018

    
1019
NDS_PARAMETER_TITLES = {
1020
  ND_OOB_PROGRAM: "OutOfBandProgram",
1021
  ND_SPINDLE_COUNT: "SpindleCount",
1022
  }
1023

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

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

    
1094
DISK_DT_PARAMETERS = frozenset(DISK_DT_TYPES.keys())
1095

    
1096
# OOB supported commands
1097
OOB_POWER_ON = "power-on"
1098
OOB_POWER_OFF = "power-off"
1099
OOB_POWER_CYCLE = "power-cycle"
1100
OOB_POWER_STATUS = "power-status"
1101
OOB_HEALTH = "health"
1102

    
1103
OOB_COMMANDS = frozenset([
1104
  OOB_POWER_ON,
1105
  OOB_POWER_OFF,
1106
  OOB_POWER_CYCLE,
1107
  OOB_POWER_STATUS,
1108
  OOB_HEALTH
1109
  ])
1110

    
1111
OOB_POWER_STATUS_POWERED = "powered"
1112

    
1113
OOB_TIMEOUT = 60 # 60 seconds
1114
OOB_POWER_DELAY = 2.0 # 2 seconds
1115

    
1116
OOB_STATUS_OK = "OK"
1117
OOB_STATUS_WARNING = "WARNING"
1118
OOB_STATUS_CRITICAL = "CRITICAL"
1119
OOB_STATUS_UNKNOWN = "UNKNOWN"
1120

    
1121
OOB_STATUSES = frozenset([
1122
  OOB_STATUS_OK,
1123
  OOB_STATUS_WARNING,
1124
  OOB_STATUS_CRITICAL,
1125
  OOB_STATUS_UNKNOWN,
1126
  ])
1127

    
1128
# Instance Parameters Profile
1129
PP_DEFAULT = "default"
1130

    
1131
# NIC_* constants are used inside the ganeti config
1132
NIC_MODE = "mode"
1133
NIC_LINK = "link"
1134

    
1135
NIC_MODE_BRIDGED = "bridged"
1136
NIC_MODE_ROUTED = "routed"
1137

    
1138
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
1139

    
1140
NICS_PARAMETER_TYPES = {
1141
  NIC_MODE: VTYPE_STRING,
1142
  NIC_LINK: VTYPE_STRING,
1143
  }
1144

    
1145
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
1146

    
1147
# IDISK_* constants are used in opcodes, to create/change disks
1148
IDISK_SIZE = "size"
1149
IDISK_MODE = "mode"
1150
IDISK_ADOPT = "adopt"
1151
IDISK_VG = "vg"
1152
IDISK_METAVG = "metavg"
1153
IDISK_PARAMS_TYPES = {
1154
  IDISK_SIZE: VTYPE_SIZE,
1155
  IDISK_MODE: VTYPE_STRING,
1156
  IDISK_ADOPT: VTYPE_STRING,
1157
  IDISK_VG: VTYPE_STRING,
1158
  IDISK_METAVG: VTYPE_STRING,
1159
  }
1160
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
1161

    
1162
# INIC_* constants are used in opcodes, to create/change nics
1163
INIC_MAC = "mac"
1164
INIC_IP = "ip"
1165
INIC_MODE = "mode"
1166
INIC_LINK = "link"
1167
INIC_PARAMS_TYPES = {
1168
  INIC_IP: VTYPE_MAYBE_STRING,
1169
  INIC_LINK: VTYPE_STRING,
1170
  INIC_MAC: VTYPE_STRING,
1171
  INIC_MODE: VTYPE_STRING,
1172
  }
1173
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
1174

    
1175
# Hypervisor constants
1176
HT_XEN_PVM = "xen-pvm"
1177
HT_FAKE = "fake"
1178
HT_XEN_HVM = "xen-hvm"
1179
HT_KVM = "kvm"
1180
HT_CHROOT = "chroot"
1181
HT_LXC = "lxc"
1182
HYPER_TYPES = frozenset([
1183
  HT_XEN_PVM,
1184
  HT_FAKE,
1185
  HT_XEN_HVM,
1186
  HT_KVM,
1187
  HT_CHROOT,
1188
  HT_LXC,
1189
  ])
1190
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
1191

    
1192
VNC_BASE_PORT = 5900
1193
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
1194
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
1195

    
1196
# NIC types
1197
HT_NIC_RTL8139 = "rtl8139"
1198
HT_NIC_NE2K_PCI = "ne2k_pci"
1199
HT_NIC_NE2K_ISA = "ne2k_isa"
1200
HT_NIC_I82551 = "i82551"
1201
HT_NIC_I85557B = "i82557b"
1202
HT_NIC_I8259ER = "i82559er"
1203
HT_NIC_PCNET = "pcnet"
1204
HT_NIC_E1000 = "e1000"
1205
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
1206

    
1207
HT_HVM_VALID_NIC_TYPES = frozenset([
1208
  HT_NIC_RTL8139,
1209
  HT_NIC_NE2K_PCI,
1210
  HT_NIC_E1000,
1211
  HT_NIC_NE2K_ISA,
1212
  HT_NIC_PARAVIRTUAL
1213
  ])
1214
HT_KVM_VALID_NIC_TYPES = frozenset([
1215
  HT_NIC_RTL8139,
1216
  HT_NIC_NE2K_PCI,
1217
  HT_NIC_NE2K_ISA,
1218
  HT_NIC_I82551,
1219
  HT_NIC_I85557B,
1220
  HT_NIC_I8259ER,
1221
  HT_NIC_PCNET,
1222
  HT_NIC_E1000,
1223
  HT_NIC_PARAVIRTUAL
1224
  ])
1225

    
1226
# Disk types
1227
HT_DISK_IOEMU = "ioemu"
1228
HT_DISK_IDE = "ide"
1229
HT_DISK_SCSI = "scsi"
1230
HT_DISK_SD = "sd"
1231
HT_DISK_MTD = "mtd"
1232
HT_DISK_PFLASH = "pflash"
1233

    
1234
HT_CACHE_DEFAULT = "default"
1235
HT_CACHE_NONE = "none"
1236
HT_CACHE_WTHROUGH = "writethrough"
1237
HT_CACHE_WBACK = "writeback"
1238
HT_VALID_CACHE_TYPES = frozenset([
1239
  HT_CACHE_DEFAULT,
1240
  HT_CACHE_NONE,
1241
  HT_CACHE_WTHROUGH,
1242
  HT_CACHE_WBACK
1243
  ])
1244

    
1245
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1246
HT_KVM_VALID_DISK_TYPES = frozenset([
1247
  HT_DISK_PARAVIRTUAL,
1248
  HT_DISK_IDE,
1249
  HT_DISK_SCSI,
1250
  HT_DISK_SD,
1251
  HT_DISK_MTD,
1252
  HT_DISK_PFLASH
1253
  ])
1254

    
1255
# Mouse types:
1256
HT_MOUSE_MOUSE = "mouse"
1257
HT_MOUSE_TABLET = "tablet"
1258

    
1259
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1260

    
1261
# Boot order
1262
HT_BO_FLOPPY = "floppy"
1263
HT_BO_CDROM = "cdrom"
1264
HT_BO_DISK = "disk"
1265
HT_BO_NETWORK = "network"
1266

    
1267
HT_KVM_VALID_BO_TYPES = frozenset([
1268
  HT_BO_FLOPPY,
1269
  HT_BO_CDROM,
1270
  HT_BO_DISK,
1271
  HT_BO_NETWORK
1272
  ])
1273

    
1274
# SPICE lossless image compression options
1275
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1276
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1277
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1278
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1279
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1280
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1281

    
1282
HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1283
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1284
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1285
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1286
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1287
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1288
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1289
  ])
1290

    
1291
# SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1292
HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1293
HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1294
HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1295

    
1296
HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1297
  HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1298
  HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1299
  HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1300
  ])
1301

    
1302
# SPICE video stream detection
1303
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1304
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1305
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1306

    
1307
HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1308
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1309
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1310
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1311
  ])
1312

    
1313
# Security models
1314
HT_SM_NONE = "none"
1315
HT_SM_USER = "user"
1316
HT_SM_POOL = "pool"
1317

    
1318
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1319

    
1320
# Kvm flag values
1321
HT_KVM_ENABLED = "enabled"
1322
HT_KVM_DISABLED = "disabled"
1323

    
1324
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1325

    
1326
# Migration type
1327
HT_MIGRATION_LIVE = "live"
1328
HT_MIGRATION_NONLIVE = "non-live"
1329
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1330

    
1331
# Cluster Verify steps
1332
VERIFY_NPLUSONE_MEM = "nplusone_mem"
1333
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1334

    
1335
# Cluster Verify error classes
1336
CV_TCLUSTER = "cluster"
1337
CV_TNODE = "node"
1338
CV_TINSTANCE = "instance"
1339

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

    
1415
CV_ALL_ECODES = frozenset([
1416
  CV_ECLUSTERCFG,
1417
  CV_ECLUSTERCERT,
1418
  CV_ECLUSTERFILECHECK,
1419
  CV_ECLUSTERDANGLINGNODES,
1420
  CV_ECLUSTERDANGLINGINST,
1421
  CV_EINSTANCEBADNODE,
1422
  CV_EINSTANCEDOWN,
1423
  CV_EINSTANCELAYOUT,
1424
  CV_EINSTANCEMISSINGDISK,
1425
  CV_EINSTANCEFAULTYDISK,
1426
  CV_EINSTANCEWRONGNODE,
1427
  CV_EINSTANCESPLITGROUPS,
1428
  CV_EINSTANCEPOLICY,
1429
  CV_ENODEDRBD,
1430
  CV_ENODEDRBDHELPER,
1431
  CV_ENODEFILECHECK,
1432
  CV_ENODEHOOKS,
1433
  CV_ENODEHV,
1434
  CV_ENODELVM,
1435
  CV_ENODEN1,
1436
  CV_ENODENET,
1437
  CV_ENODEOS,
1438
  CV_ENODEORPHANINSTANCE,
1439
  CV_ENODEORPHANLV,
1440
  CV_ENODERPC,
1441
  CV_ENODESSH,
1442
  CV_ENODEVERSION,
1443
  CV_ENODESETUP,
1444
  CV_ENODETIME,
1445
  CV_ENODEOOBPATH,
1446
  CV_ENODEUSERSCRIPTS,
1447
  ])
1448

    
1449
CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1450

    
1451
# Node verify constants
1452
NV_DRBDHELPER = "drbd-helper"
1453
NV_DRBDLIST = "drbd-list"
1454
NV_FILELIST = "filelist"
1455
NV_HVINFO = "hvinfo"
1456
NV_HYPERVISOR = "hypervisor"
1457
NV_HVPARAMS = "hvparms"
1458
NV_INSTANCELIST = "instancelist"
1459
NV_LVLIST = "lvlist"
1460
NV_MASTERIP = "master-ip"
1461
NV_NODELIST = "nodelist"
1462
NV_NODENETTEST = "node-net-test"
1463
NV_NODESETUP = "nodesetup"
1464
NV_OSLIST = "oslist"
1465
NV_PVLIST = "pvlist"
1466
NV_TIME = "time"
1467
NV_VERSION = "version"
1468
NV_VGLIST = "vglist"
1469
NV_VMNODES = "vmnodes"
1470
NV_OOB_PATHS = "oob-paths"
1471
NV_BRIDGES = "bridges"
1472
NV_USERSCRIPTS = "user-scripts"
1473

    
1474
# Instance status
1475
INSTST_RUNNING = "running"
1476
INSTST_ADMINDOWN = "ADMIN_down"
1477
INSTST_ADMINOFFLINE = "ADMIN_offline"
1478
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1479
INSTST_NODEDOWN = "ERROR_nodedown"
1480
INSTST_WRONGNODE = "ERROR_wrongnode"
1481
INSTST_ERRORUP = "ERROR_up"
1482
INSTST_ERRORDOWN = "ERROR_down"
1483
INSTST_ALL = frozenset([
1484
  INSTST_RUNNING,
1485
  INSTST_ADMINDOWN,
1486
  INSTST_ADMINOFFLINE,
1487
  INSTST_NODEOFFLINE,
1488
  INSTST_NODEDOWN,
1489
  INSTST_WRONGNODE,
1490
  INSTST_ERRORUP,
1491
  INSTST_ERRORDOWN,
1492
  ])
1493

    
1494
# Admin states
1495
ADMINST_UP = "up"
1496
ADMINST_DOWN = "down"
1497
ADMINST_OFFLINE = "offline"
1498
ADMINST_ALL = frozenset([
1499
  ADMINST_UP,
1500
  ADMINST_DOWN,
1501
  ADMINST_OFFLINE,
1502
  ])
1503

    
1504
# Node roles
1505
NR_REGULAR = "R"
1506
NR_MASTER = "M"
1507
NR_MCANDIDATE = "C"
1508
NR_DRAINED = "D"
1509
NR_OFFLINE = "O"
1510
NR_ALL = frozenset([
1511
  NR_REGULAR,
1512
  NR_MASTER,
1513
  NR_MCANDIDATE,
1514
  NR_DRAINED,
1515
  NR_OFFLINE,
1516
  ])
1517

    
1518
# SSL certificate check constants (in days)
1519
SSL_CERT_EXPIRATION_WARN = 30
1520
SSL_CERT_EXPIRATION_ERROR = 7
1521

    
1522
# Allocator framework constants
1523
IALLOCATOR_VERSION = 2
1524
IALLOCATOR_DIR_IN = "in"
1525
IALLOCATOR_DIR_OUT = "out"
1526
VALID_IALLOCATOR_DIRECTIONS = frozenset([
1527
  IALLOCATOR_DIR_IN,
1528
  IALLOCATOR_DIR_OUT,
1529
  ])
1530
IALLOCATOR_MODE_ALLOC = "allocate"
1531
IALLOCATOR_MODE_RELOC = "relocate"
1532
IALLOCATOR_MODE_CHG_GROUP = "change-group"
1533
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1534
IALLOCATOR_MODE_MULTI_ALLOC = "multi-allocate"
1535
VALID_IALLOCATOR_MODES = frozenset([
1536
  IALLOCATOR_MODE_ALLOC,
1537
  IALLOCATOR_MODE_RELOC,
1538
  IALLOCATOR_MODE_CHG_GROUP,
1539
  IALLOCATOR_MODE_NODE_EVAC,
1540
  IALLOCATOR_MODE_MULTI_ALLOC,
1541
  ])
1542
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1543

    
1544
IALLOCATOR_NEVAC_PRI = "primary-only"
1545
IALLOCATOR_NEVAC_SEC = "secondary-only"
1546
IALLOCATOR_NEVAC_ALL = "all"
1547
IALLOCATOR_NEVAC_MODES = frozenset([
1548
  IALLOCATOR_NEVAC_PRI,
1549
  IALLOCATOR_NEVAC_SEC,
1550
  IALLOCATOR_NEVAC_ALL,
1551
  ])
1552

    
1553
# Node evacuation
1554
NODE_EVAC_PRI = "primary-only"
1555
NODE_EVAC_SEC = "secondary-only"
1556
NODE_EVAC_ALL = "all"
1557
NODE_EVAC_MODES = frozenset([
1558
  NODE_EVAC_PRI,
1559
  NODE_EVAC_SEC,
1560
  NODE_EVAC_ALL,
1561
  ])
1562

    
1563
# Job queue
1564
JOB_QUEUE_VERSION = 1
1565
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1566
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1567
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1568
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1569
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1570
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1571

    
1572
JOB_ID_TEMPLATE = r"\d+"
1573
JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1574

    
1575
# unchanged job return
1576
JOB_NOTCHANGED = "nochange"
1577

    
1578
# Job status
1579
JOB_STATUS_QUEUED = "queued"
1580
JOB_STATUS_WAITING = "waiting"
1581
JOB_STATUS_CANCELING = "canceling"
1582
JOB_STATUS_RUNNING = "running"
1583
JOB_STATUS_CANCELED = "canceled"
1584
JOB_STATUS_SUCCESS = "success"
1585
JOB_STATUS_ERROR = "error"
1586
JOBS_FINALIZED = frozenset([
1587
  JOB_STATUS_CANCELED,
1588
  JOB_STATUS_SUCCESS,
1589
  JOB_STATUS_ERROR,
1590
  ])
1591
JOB_STATUS_ALL = frozenset([
1592
  JOB_STATUS_QUEUED,
1593
  JOB_STATUS_WAITING,
1594
  JOB_STATUS_CANCELING,
1595
  JOB_STATUS_RUNNING,
1596
  ]) | JOBS_FINALIZED
1597

    
1598
# OpCode status
1599
# not yet finalized
1600
OP_STATUS_QUEUED = "queued"
1601
OP_STATUS_WAITING = "waiting"
1602
OP_STATUS_CANCELING = "canceling"
1603
OP_STATUS_RUNNING = "running"
1604
# finalized
1605
OP_STATUS_CANCELED = "canceled"
1606
OP_STATUS_SUCCESS = "success"
1607
OP_STATUS_ERROR = "error"
1608
OPS_FINALIZED = frozenset([
1609
  OP_STATUS_CANCELED,
1610
  OP_STATUS_SUCCESS,
1611
  OP_STATUS_ERROR
1612
  ])
1613

    
1614
# OpCode priority
1615
OP_PRIO_LOWEST = +19
1616
OP_PRIO_HIGHEST = -20
1617

    
1618
OP_PRIO_LOW = +10
1619
OP_PRIO_NORMAL = 0
1620
OP_PRIO_HIGH = -10
1621

    
1622
OP_PRIO_SUBMIT_VALID = frozenset([
1623
  OP_PRIO_LOW,
1624
  OP_PRIO_NORMAL,
1625
  OP_PRIO_HIGH,
1626
  ])
1627

    
1628
OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1629

    
1630
# Lock recalculate mode
1631
LOCKS_REPLACE = "replace"
1632
LOCKS_APPEND = "append"
1633

    
1634
# Lock timeout (sum) before we should go into blocking acquire (still
1635
# can be reset by priority change); computed as max time (10 hours)
1636
# before we should actually go into blocking acquire given that we
1637
# start from default priority level; in seconds
1638
# TODO
1639
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / (OP_PRIO_DEFAULT - OP_PRIO_HIGHEST)
1640
LOCK_ATTEMPTS_MAXWAIT = 15.0
1641
LOCK_ATTEMPTS_MINWAIT = 1.0
1642

    
1643
# Execution log types
1644
ELOG_MESSAGE = "message"
1645
ELOG_REMOTE_IMPORT = "remote-import"
1646
ELOG_JQUEUE_TEST = "jqueue-test"
1647

    
1648
# /etc/hosts modification
1649
ETC_HOSTS_ADD = "add"
1650
ETC_HOSTS_REMOVE = "remove"
1651

    
1652
# Job queue test
1653
JQT_MSGPREFIX = "TESTMSG="
1654
JQT_EXPANDNAMES = "expandnames"
1655
JQT_EXEC = "exec"
1656
JQT_LOGMSG = "logmsg"
1657
JQT_STARTMSG = "startmsg"
1658
JQT_ALL = frozenset([
1659
  JQT_EXPANDNAMES,
1660
  JQT_EXEC,
1661
  JQT_LOGMSG,
1662
  JQT_STARTMSG,
1663
  ])
1664

    
1665
# Query resources
1666
QR_CLUSTER = "cluster"
1667
QR_INSTANCE = "instance"
1668
QR_NODE = "node"
1669
QR_LOCK = "lock"
1670
QR_GROUP = "group"
1671
QR_OS = "os"
1672
QR_JOB = "job"
1673
QR_EXPORT = "export"
1674

    
1675
#: List of resources which can be queried using L{opcodes.OpQuery}
1676
QR_VIA_OP = frozenset([
1677
  QR_CLUSTER,
1678
  QR_INSTANCE,
1679
  QR_NODE,
1680
  QR_GROUP,
1681
  QR_OS,
1682
  QR_EXPORT,
1683
  ])
1684

    
1685
#: List of resources which can be queried using Local UniX Interface
1686
QR_VIA_LUXI = QR_VIA_OP.union([
1687
  QR_LOCK,
1688
  QR_JOB,
1689
  ])
1690

    
1691
#: List of resources which can be queried using RAPI
1692
QR_VIA_RAPI = QR_VIA_LUXI
1693

    
1694
# Query field types
1695
QFT_UNKNOWN = "unknown"
1696
QFT_TEXT = "text"
1697
QFT_BOOL = "bool"
1698
QFT_NUMBER = "number"
1699
QFT_UNIT = "unit"
1700
QFT_TIMESTAMP = "timestamp"
1701
QFT_OTHER = "other"
1702

    
1703
#: All query field types
1704
QFT_ALL = frozenset([
1705
  QFT_UNKNOWN,
1706
  QFT_TEXT,
1707
  QFT_BOOL,
1708
  QFT_NUMBER,
1709
  QFT_UNIT,
1710
  QFT_TIMESTAMP,
1711
  QFT_OTHER,
1712
  ])
1713

    
1714
# Query result field status (don't change or reuse values as they're used by
1715
# clients)
1716
#: Normal field status
1717
RS_NORMAL = 0
1718
#: Unknown field
1719
RS_UNKNOWN = 1
1720
#: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1721
RS_NODATA = 2
1722
#: Value unavailable/unsupported for item; if this field is supported
1723
#: but we cannot get the data for the moment, RS_NODATA or
1724
#: RS_OFFLINE should be used
1725
RS_UNAVAIL = 3
1726
#: Resource marked offline
1727
RS_OFFLINE = 4
1728

    
1729
RS_ALL = frozenset([
1730
  RS_NORMAL,
1731
  RS_UNKNOWN,
1732
  RS_NODATA,
1733
  RS_UNAVAIL,
1734
  RS_OFFLINE,
1735
  ])
1736

    
1737
#: Dictionary with special field cases and their verbose/terse formatting
1738
RSS_DESCRIPTION = {
1739
  RS_UNKNOWN: ("(unknown)", "??"),
1740
  RS_NODATA: ("(nodata)", "?"),
1741
  RS_OFFLINE: ("(offline)", "*"),
1742
  RS_UNAVAIL: ("(unavail)", "-"),
1743
  }
1744

    
1745
# max dynamic devices
1746
MAX_NICS = 8
1747
MAX_DISKS = 16
1748

    
1749
# SSCONF file prefix
1750
SSCONF_FILEPREFIX = "ssconf_"
1751
# SSCONF keys
1752
SS_CLUSTER_NAME = "cluster_name"
1753
SS_CLUSTER_TAGS = "cluster_tags"
1754
SS_FILE_STORAGE_DIR = "file_storage_dir"
1755
SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1756
SS_MASTER_CANDIDATES = "master_candidates"
1757
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1758
SS_MASTER_IP = "master_ip"
1759
SS_MASTER_NETDEV = "master_netdev"
1760
SS_MASTER_NETMASK = "master_netmask"
1761
SS_MASTER_NODE = "master_node"
1762
SS_NODE_LIST = "node_list"
1763
SS_NODE_PRIMARY_IPS = "node_primary_ips"
1764
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1765
SS_OFFLINE_NODES = "offline_nodes"
1766
SS_ONLINE_NODES = "online_nodes"
1767
SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1768
SS_INSTANCE_LIST = "instance_list"
1769
SS_RELEASE_VERSION = "release_version"
1770
SS_HYPERVISOR_LIST = "hypervisor_list"
1771
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1772
SS_UID_POOL = "uid_pool"
1773
SS_NODEGROUPS = "nodegroups"
1774

    
1775
SS_FILE_PERMS = 0444
1776

    
1777
# cluster wide default parameters
1778
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1779

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

    
1871
HVC_GLOBALS = frozenset([
1872
  HV_MIGRATION_PORT,
1873
  HV_MIGRATION_BANDWIDTH,
1874
  HV_MIGRATION_MODE,
1875
  ])
1876

    
1877
BEC_DEFAULTS = {
1878
  BE_MINMEM: 128,
1879
  BE_MAXMEM: 128,
1880
  BE_VCPUS: 1,
1881
  BE_AUTO_BALANCE: True,
1882
  BE_ALWAYS_FAILOVER: False,
1883
  BE_SPINDLE_USE: 1,
1884
  }
1885

    
1886
NDC_DEFAULTS = {
1887
  ND_OOB_PROGRAM: "",
1888
  ND_SPINDLE_COUNT: 1,
1889
  }
1890

    
1891
DISK_LD_DEFAULTS = {
1892
  LD_DRBD8: {
1893
    LDP_RESYNC_RATE: CLASSIC_DRBD_SYNC_SPEED,
1894
    LDP_BARRIERS: _autoconf.DRBD_BARRIERS,
1895
    LDP_NO_META_FLUSH: _autoconf.DRBD_NO_META_FLUSH,
1896
    LDP_DEFAULT_METAVG: DEFAULT_VG,
1897
    LDP_DISK_CUSTOM: "",
1898
    LDP_NET_CUSTOM: "",
1899
    LDP_DYNAMIC_RESYNC: False,
1900

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

    
1922
# readability shortcuts
1923
_LV_DEFAULTS = DISK_LD_DEFAULTS[LD_LV]
1924
_DRBD_DEFAULTS = DISK_LD_DEFAULTS[LD_DRBD8]
1925

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

    
1955
# we don't want to export the shortcuts
1956
del _LV_DEFAULTS, _DRBD_DEFAULTS
1957

    
1958
NICC_DEFAULTS = {
1959
  NIC_MODE: NIC_MODE_BRIDGED,
1960
  NIC_LINK: DEFAULT_BRIDGE,
1961
  }
1962

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

    
1995
MASTER_POOL_SIZE_DEFAULT = 10
1996

    
1997
CONFD_PROTOCOL_VERSION = 1
1998

    
1999
CONFD_REQ_PING = 0
2000
CONFD_REQ_NODE_ROLE_BYNAME = 1
2001
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
2002
CONFD_REQ_CLUSTER_MASTER = 3
2003
CONFD_REQ_NODE_PIP_LIST = 4
2004
CONFD_REQ_MC_PIP_LIST = 5
2005
CONFD_REQ_INSTANCES_IPS_LIST = 6
2006
CONFD_REQ_NODE_DRBD = 7
2007

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

    
2016
CONFD_REQFIELD_NAME = "0"
2017
CONFD_REQFIELD_IP = "1"
2018
CONFD_REQFIELD_MNODE_PIP = "2"
2019

    
2020
CONFD_REQS = frozenset([
2021
  CONFD_REQ_PING,
2022
  CONFD_REQ_NODE_ROLE_BYNAME,
2023
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
2024
  CONFD_REQ_CLUSTER_MASTER,
2025
  CONFD_REQ_NODE_PIP_LIST,
2026
  CONFD_REQ_MC_PIP_LIST,
2027
  CONFD_REQ_INSTANCES_IPS_LIST,
2028
  CONFD_REQ_NODE_DRBD,
2029
  ])
2030

    
2031
CONFD_REPL_STATUS_OK = 0
2032
CONFD_REPL_STATUS_ERROR = 1
2033
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
2034

    
2035
CONFD_REPL_STATUSES = frozenset([
2036
  CONFD_REPL_STATUS_OK,
2037
  CONFD_REPL_STATUS_ERROR,
2038
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
2039
  ])
2040

    
2041
(CONFD_NODE_ROLE_MASTER,
2042
 CONFD_NODE_ROLE_CANDIDATE,
2043
 CONFD_NODE_ROLE_OFFLINE,
2044
 CONFD_NODE_ROLE_DRAINED,
2045
 CONFD_NODE_ROLE_REGULAR,
2046
 ) = range(5)
2047

    
2048
# A few common errors for confd
2049
CONFD_ERROR_UNKNOWN_ENTRY = 1
2050
CONFD_ERROR_INTERNAL = 2
2051
CONFD_ERROR_ARGUMENT = 3
2052

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

    
2058
# When we haven't reloaded the config for more than this amount of seconds, we
2059
# force a test to see if inotify is betraying us.
2060
CONFD_CONFIG_RELOAD_TIMEOUT = 60
2061

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

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

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

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

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

    
2090
# User-id pool minimum/maximum acceptable user-ids.
2091
UIDPOOL_UID_MIN = 0
2092
UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
2093

    
2094
# Name or path of the pgrep command
2095
PGREP = "pgrep"
2096

    
2097
# Name of the node group that gets created at cluster init or upgrade
2098
INITIAL_NODE_GROUP_NAME = "default"
2099

    
2100
# Possible values for NodeGroup.alloc_policy
2101
ALLOC_POLICY_PREFERRED = "preferred"
2102
ALLOC_POLICY_LAST_RESORT = "last_resort"
2103
ALLOC_POLICY_UNALLOCABLE = "unallocable"
2104
VALID_ALLOC_POLICIES = [
2105
  ALLOC_POLICY_PREFERRED,
2106
  ALLOC_POLICY_LAST_RESORT,
2107
  ALLOC_POLICY_UNALLOCABLE,
2108
  ]
2109

    
2110
# Temporary external/shared storage parameters
2111
BLOCKDEV_DRIVER_MANUAL = "manual"
2112

    
2113
# qemu-img path, required for ovfconverter
2114
QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
2115

    
2116
# Whether htools was enabled at compilation time
2117
HTOOLS = _autoconf.HTOOLS
2118
# The hail iallocator
2119
IALLOC_HAIL = "hail"
2120

    
2121
# Fake opcodes for functions that have hooks attached to them via
2122
# backend.RunLocalHooks
2123
FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
2124
FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
2125

    
2126
# Do not re-export imported modules
2127
del re, _vcsversion, _autoconf, socket