Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 43e11798

History | View | Annotate | Download (48.6 kB)

1
#
2
#
3

    
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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

    
26
from ganeti import _autoconf
27
from ganeti import _vcsversion
28

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

    
39

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

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

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

57
  Returns: int representing version number
58

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

    
67

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

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

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

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

    
79
  return (major, minor, revision)
80

    
81

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

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

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

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

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

    
119
# A KVM-specific implementation detail - the following value is used
120
# to set CPU affinity to all processors (#0 through #31), per taskset
121
# man page.
122
CPU_PINNING_ALL_KVM = 0xFFFFFFFF
123

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

    
130

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

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

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

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

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

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

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

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

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

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

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

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

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

    
256
DEV_CONSOLE = "/dev/console"
257

    
258
PROC_MOUNTS = "/proc/mounts"
259

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

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

    
271
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
272
EXPORT_DIR = _autoconf.EXPORT_DIR
273

    
274
EXPORT_CONF_FILE = "config.ini"
275

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

    
281
KVM_PATH = _autoconf.KVM_PATH
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

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

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

    
440
# the set of non-lvm-based disk templates
441
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE, DT_BLOCK])
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

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

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

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

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

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

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

    
472
# drbd constants
473
DRBD_HMAC_ALG = "md5"
474
DRBD_NET_PROTOCOL = "C"
475
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
476

    
477
# file backend driver
478
FD_LOOP = "loop"
479
FD_BLKTAP = "blktap"
480

    
481
# the set of drbd-like disk types
482
LDS_DRBD = frozenset([LD_DRBD8])
483

    
484
# disk access mode
485
DISK_RDONLY = "ro"
486
DISK_RDWR = "rw"
487
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
488

    
489
# disk replacement mode
490
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
491
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
492
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
493
REPLACE_DISK_AUTO = "replace_auto"
494
REPLACE_MODES = frozenset([
495
  REPLACE_DISK_PRI,
496
  REPLACE_DISK_SEC,
497
  REPLACE_DISK_CHG,
498
  REPLACE_DISK_AUTO,
499
  ])
500

    
501
# Instance export mode
502
EXPORT_MODE_LOCAL = "local"
503
EXPORT_MODE_REMOTE = "remote"
504
EXPORT_MODES = frozenset([
505
  EXPORT_MODE_LOCAL,
506
  EXPORT_MODE_REMOTE,
507
  ])
508

    
509
# Lock recalculate mode
510
LOCKS_REPLACE = "replace"
511
LOCKS_APPEND = "append"
512

    
513
# Lock timeout (sum) before we should go into blocking acquire (still
514
# can be reset by priority change); computed as max time (10 hours)
515
# before we should actually go into blocking acquire given that we
516
# start from default priority level; in seconds
517
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
518
LOCK_ATTEMPTS_MAXWAIT = 15.0
519
LOCK_ATTEMPTS_MINWAIT = 1.0
520

    
521
# instance creation modes
522
INSTANCE_CREATE = "create"
523
INSTANCE_IMPORT = "import"
524
INSTANCE_REMOTE_IMPORT = "remote-import"
525
INSTANCE_CREATE_MODES = frozenset([
526
  INSTANCE_CREATE,
527
  INSTANCE_IMPORT,
528
  INSTANCE_REMOTE_IMPORT,
529
  ])
530

    
531
# Remote import/export handshake message and version
532
RIE_VERSION = 0
533
RIE_HANDSHAKE = "Hi, I'm Ganeti"
534

    
535
# Remote import/export certificate validity in seconds
536
RIE_CERT_VALIDITY = 24 * 60 * 60
537

    
538
# Overall timeout for establishing connection
539
RIE_CONNECT_TIMEOUT = 180
540

    
541
# Export only: how long to wait per connection attempt (seconds)
542
RIE_CONNECT_ATTEMPT_TIMEOUT = 20
543

    
544
# Export only: number of attempts to connect
545
RIE_CONNECT_RETRIES = 10
546

    
547
#: Give child process up to 5 seconds to exit after sending a signal
548
CHILD_LINGER_TIMEOUT = 5.0
549

    
550
DISK_TEMPLATES = frozenset([
551
  DT_DISKLESS,
552
  DT_PLAIN,
553
  DT_DRBD8,
554
  DT_FILE,
555
  DT_SHARED_FILE,
556
  DT_BLOCK
557
  ])
558

    
559
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
560

    
561
# import/export config options
562
INISECT_EXP = "export"
563
INISECT_INS = "instance"
564
INISECT_HYP = "hypervisor"
565
INISECT_BEP = "backend"
566
INISECT_OSP = "os"
567

    
568
# dynamic device modification
569
DDM_ADD = "add"
570
DDM_REMOVE = "remove"
571
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
572

    
573
# common exit codes
574
EXIT_SUCCESS = 0
575
EXIT_FAILURE = 1
576
EXIT_NOTCLUSTER = 5
577
EXIT_NOTMASTER = 11
578
EXIT_NODESETUP_ERROR = 12
579
EXIT_CONFIRMATION = 13 # need user confirmation
580

    
581
#: Exit code for query operations with unknown fields
582
EXIT_UNKNOWN_FIELD = 14
583

    
584
# tags
585
TAG_CLUSTER = "cluster"
586
TAG_NODEGROUP = "nodegroup"
587
TAG_NODE = "node"
588
TAG_INSTANCE = "instance"
589
VALID_TAG_TYPES = frozenset([
590
  TAG_CLUSTER,
591
  TAG_NODEGROUP,
592
  TAG_NODE,
593
  TAG_INSTANCE,
594
  ])
595
MAX_TAG_LEN = 128
596
MAX_TAGS_PER_OBJ = 4096
597

    
598
# others
599
DEFAULT_BRIDGE = "xen-br0"
600
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
601
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
602
IP4_ADDRESS_ANY = "0.0.0.0"
603
IP6_ADDRESS_LOCALHOST = "::1"
604
IP6_ADDRESS_ANY = "::"
605
IP4_VERSION = 4
606
IP6_VERSION = 6
607
VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
608
TCP_PING_TIMEOUT = 10
609
GANETI_RUNAS = "root"
610
DEFAULT_VG = "xenvg"
611
DEFAULT_DRBD_HELPER = "/bin/true"
612
MIN_VG_SIZE = 20480
613
DEFAULT_MAC_PREFIX = "aa:00:00"
614
# default maximum instance wait time, in seconds.
615
DEFAULT_SHUTDOWN_TIMEOUT = 120
616
NODE_MAX_CLOCK_SKEW = 150
617
# Time for an intra-cluster disk transfer to wait for a connection
618
DISK_TRANSFER_CONNECT_TIMEOUT = 60
619
# Disk index separator
620
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
621
IP_COMMAND_PATH = _autoconf.IP_PATH
622

    
623
#: Key for job IDs in opcode result
624
JOB_IDS_KEY = "jobs"
625

    
626
# runparts results
627
(RUNPARTS_SKIP,
628
 RUNPARTS_RUN,
629
 RUNPARTS_ERR) = range(3)
630

    
631
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
632

    
633
# RPC constants
634
(RPC_ENCODING_NONE,
635
 RPC_ENCODING_ZLIB_BASE64) = range(2)
636

    
637
# os related constants
638
OS_SCRIPT_CREATE = "create"
639
OS_SCRIPT_IMPORT = "import"
640
OS_SCRIPT_EXPORT = "export"
641
OS_SCRIPT_RENAME = "rename"
642
OS_SCRIPT_VERIFY = "verify"
643
OS_SCRIPTS = frozenset([
644
  OS_SCRIPT_CREATE,
645
  OS_SCRIPT_IMPORT,
646
  OS_SCRIPT_EXPORT,
647
  OS_SCRIPT_RENAME,
648
  OS_SCRIPT_VERIFY
649
  ])
650

    
651
OS_API_FILE = "ganeti_api_version"
652
OS_VARIANTS_FILE = "variants.list"
653
OS_PARAMETERS_FILE = "parameters.list"
654

    
655
OS_VALIDATE_PARAMETERS = "parameters"
656
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
657

    
658
# ssh constants
659
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
660
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
661
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
662
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
663
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
664
SSH = "ssh"
665
SCP = "scp"
666

    
667
# reboot types
668
INSTANCE_REBOOT_SOFT = "soft"
669
INSTANCE_REBOOT_HARD = "hard"
670
INSTANCE_REBOOT_FULL = "full"
671

    
672
REBOOT_TYPES = frozenset([
673
  INSTANCE_REBOOT_SOFT,
674
  INSTANCE_REBOOT_HARD,
675
  INSTANCE_REBOOT_FULL
676
  ])
677

    
678
# instance reboot behaviors
679
INSTANCE_REBOOT_ALLOWED = "reboot"
680
INSTANCE_REBOOT_EXIT = "exit"
681

    
682
REBOOT_BEHAVIORS = frozenset([
683
  INSTANCE_REBOOT_ALLOWED,
684
  INSTANCE_REBOOT_EXIT
685
  ])
686

    
687
VTYPE_STRING = "string"
688
VTYPE_MAYBE_STRING = "maybe-string"
689
VTYPE_BOOL = "bool"
690
VTYPE_SIZE = "size" # size, in MiBs
691
VTYPE_INT = "int"
692
ENFORCEABLE_TYPES = frozenset([
693
  VTYPE_STRING,
694
  VTYPE_MAYBE_STRING,
695
  VTYPE_BOOL,
696
  VTYPE_SIZE,
697
  VTYPE_INT,
698
  ])
699

    
700
# Constant representing that the user does not specify any IP version
701
IFACE_NO_IP_VERSION_SPECIFIED = 0
702

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

    
757
HVS_PARAMETER_TYPES = {
758
  HV_BOOT_ORDER: VTYPE_STRING,
759
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
760
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
761
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
762
  HV_NIC_TYPE: VTYPE_STRING,
763
  HV_DISK_TYPE: VTYPE_STRING,
764
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
765
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
766
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
767
  HV_VNC_TLS: VTYPE_BOOL,
768
  HV_VNC_X509: VTYPE_STRING,
769
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
770
  HV_KVM_SPICE_BIND: VTYPE_STRING,
771
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
772
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
773
  HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
774
  HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
775
  HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
776
  HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
777
  HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
778
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
779
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
780
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
781
  HV_ACPI: VTYPE_BOOL,
782
  HV_PAE: VTYPE_BOOL,
783
  HV_USE_BOOTLOADER: VTYPE_BOOL,
784
  HV_BOOTLOADER_PATH: VTYPE_STRING,
785
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
786
  HV_KERNEL_PATH: VTYPE_STRING,
787
  HV_KERNEL_ARGS: VTYPE_STRING,
788
  HV_INITRD_PATH: VTYPE_STRING,
789
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
790
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
791
  HV_USB_MOUSE: VTYPE_STRING,
792
  HV_KEYMAP: VTYPE_STRING,
793
  HV_DEVICE_MODEL: VTYPE_STRING,
794
  HV_INIT_SCRIPT: VTYPE_STRING,
795
  HV_MIGRATION_PORT: VTYPE_INT,
796
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
797
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
798
  HV_MIGRATION_MODE: VTYPE_STRING,
799
  HV_USE_LOCALTIME: VTYPE_BOOL,
800
  HV_DISK_CACHE: VTYPE_STRING,
801
  HV_SECURITY_MODEL: VTYPE_STRING,
802
  HV_SECURITY_DOMAIN: VTYPE_STRING,
803
  HV_KVM_FLAG: VTYPE_STRING,
804
  HV_VHOST_NET: VTYPE_BOOL,
805
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
806
  HV_CPU_MASK: VTYPE_STRING,
807
  HV_MEM_PATH: VTYPE_STRING,
808
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
809
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
810
  }
811

    
812
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
813

    
814
# Migration statuses
815
HV_MIGRATION_COMPLETED = "completed"
816
HV_MIGRATION_ACTIVE = "active"
817
HV_MIGRATION_FAILED = "failed"
818
HV_MIGRATION_CANCELLED = "cancelled"
819

    
820
HV_MIGRATION_VALID_STATUSES = frozenset([
821
  HV_MIGRATION_COMPLETED,
822
  HV_MIGRATION_ACTIVE,
823
  HV_MIGRATION_FAILED,
824
  HV_MIGRATION_CANCELLED,
825
  ])
826

    
827
HV_MIGRATION_FAILED_STATUSES = frozenset([
828
  HV_MIGRATION_FAILED,
829
  HV_MIGRATION_CANCELLED,
830
  ])
831

    
832
# KVM-specific statuses
833
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
834

    
835
# Node info keys
836
HV_NODEINFO_KEY_VERSION = "hv_version"
837

    
838
# Hypervisor state
839
HVST_MEMORY_TOTAL = "mem_total"
840
HVST_MEMORY_NODE = "mem_node"
841
HVST_MEMORY_HV = "mem_hv"
842
HVST_CPU_TOTAL = "cpu_total"
843
HVST_CPU_NODE = "cpu_node"
844

    
845
HVSTS_PARAMETER_TYPES = {
846
  HVST_MEMORY_TOTAL: VTYPE_INT,
847
  HVST_MEMORY_NODE: VTYPE_INT,
848
  HVST_MEMORY_HV: VTYPE_INT,
849
  HVST_CPU_TOTAL: VTYPE_INT,
850
  HVST_CPU_NODE: VTYPE_INT,
851
  }
852

    
853
HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
854

    
855
# Disk state
856
DS_DISK_TOTAL = "disk_total"
857
DS_DISK_RESERVED = "disk_reserved"
858
DS_DISK_OVERHEAD = "disk_overhead"
859

    
860
DSS_PARAMETER_TYPES = {
861
  DS_DISK_TOTAL: VTYPE_INT,
862
  DS_DISK_RESERVED: VTYPE_INT,
863
  DS_DISK_OVERHEAD: VTYPE_INT,
864
  }
865

    
866
DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
867

    
868
# Backend parameter names
869
BE_MEMORY = "memory" # deprecated and replaced by max and min mem
870
BE_MAXMEM = "maxmem"
871
BE_MINMEM = "minmem"
872
BE_VCPUS = "vcpus"
873
BE_AUTO_BALANCE = "auto_balance"
874

    
875
BES_PARAMETER_TYPES = {
876
  BE_MAXMEM: VTYPE_SIZE,
877
  BE_MINMEM: VTYPE_SIZE,
878
  BE_VCPUS: VTYPE_INT,
879
  BE_AUTO_BALANCE: VTYPE_BOOL,
880
  }
881

    
882
BES_PARAMETER_COMPAT = {
883
  BE_MEMORY: VTYPE_SIZE,
884
  }
885
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)
886

    
887
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
888

    
889
# Node parameter names
890
ND_OOB_PROGRAM = "oob_program"
891

    
892
NDS_PARAMETER_TYPES = {
893
  ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
894
  }
895

    
896
NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
897

    
898
# Logical Disks parameters
899
RESYNC_RATE = "resync-rate"
900
STRIPES = "stripes"
901
DISK_LD_TYPES = {
902
  RESYNC_RATE: VTYPE_INT,
903
  STRIPES: VTYPE_INT,
904
  }
905
DISK_LD_PARAMETERS = frozenset(DISK_LD_TYPES.keys())
906

    
907
# Disk template parameters
908
DRBD_RESYNC_RATE = "resync-rate"
909
DRBD_DATA_STRIPES = "data-stripes"
910
DRBD_META_STRIPES = "meta-stripes"
911
LV_STRIPES = "stripes"
912
DISK_DT_TYPES = {
913
  DRBD_RESYNC_RATE: VTYPE_INT,
914
  DRBD_DATA_STRIPES: VTYPE_INT,
915
  DRBD_META_STRIPES: VTYPE_INT,
916
  LV_STRIPES: VTYPE_INT,
917
  }
918

    
919
DISK_DT_PARAMETERS = frozenset(DISK_DT_TYPES.keys())
920

    
921
# OOB supported commands
922
OOB_POWER_ON = "power-on"
923
OOB_POWER_OFF = "power-off"
924
OOB_POWER_CYCLE = "power-cycle"
925
OOB_POWER_STATUS = "power-status"
926
OOB_HEALTH = "health"
927

    
928
OOB_COMMANDS = frozenset([
929
  OOB_POWER_ON,
930
  OOB_POWER_OFF,
931
  OOB_POWER_CYCLE,
932
  OOB_POWER_STATUS,
933
  OOB_HEALTH
934
  ])
935

    
936
OOB_POWER_STATUS_POWERED = "powered"
937

    
938
OOB_TIMEOUT = 60 # 60 seconds
939
OOB_POWER_DELAY = 2.0 # 2 seconds
940

    
941
OOB_STATUS_OK = "OK"
942
OOB_STATUS_WARNING = "WARNING"
943
OOB_STATUS_CRITICAL = "CRITICAL"
944
OOB_STATUS_UNKNOWN = "UNKNOWN"
945

    
946
OOB_STATUSES = frozenset([
947
  OOB_STATUS_OK,
948
  OOB_STATUS_WARNING,
949
  OOB_STATUS_CRITICAL,
950
  OOB_STATUS_UNKNOWN,
951
  ])
952

    
953
# Instance Parameters Profile
954
PP_DEFAULT = "default"
955

    
956
# NIC_* constants are used inside the ganeti config
957
NIC_MODE = "mode"
958
NIC_LINK = "link"
959

    
960
NIC_MODE_BRIDGED = "bridged"
961
NIC_MODE_ROUTED = "routed"
962

    
963
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
964

    
965
NICS_PARAMETER_TYPES = {
966
  NIC_MODE: VTYPE_STRING,
967
  NIC_LINK: VTYPE_STRING,
968
  }
969

    
970
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
971

    
972
# IDISK_* constants are used in opcodes, to create/change disks
973
IDISK_SIZE = "size"
974
IDISK_MODE = "mode"
975
IDISK_ADOPT = "adopt"
976
IDISK_VG = "vg"
977
IDISK_METAVG = "metavg"
978
IDISK_PARAMS_TYPES = {
979
  IDISK_SIZE: VTYPE_SIZE,
980
  IDISK_MODE: VTYPE_STRING,
981
  IDISK_ADOPT: VTYPE_STRING,
982
  IDISK_VG: VTYPE_STRING,
983
  IDISK_METAVG: VTYPE_STRING,
984
  }
985
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
986

    
987
# INIC_* constants are used in opcodes, to create/change nics
988
INIC_MAC = "mac"
989
INIC_IP = "ip"
990
INIC_MODE = "mode"
991
INIC_LINK = "link"
992
INIC_PARAMS_TYPES = {
993
  INIC_IP: VTYPE_MAYBE_STRING,
994
  INIC_LINK: VTYPE_STRING,
995
  INIC_MAC: VTYPE_STRING,
996
  INIC_MODE: VTYPE_STRING,
997
  }
998
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
999

    
1000
# Hypervisor constants
1001
HT_XEN_PVM = "xen-pvm"
1002
HT_FAKE = "fake"
1003
HT_XEN_HVM = "xen-hvm"
1004
HT_KVM = "kvm"
1005
HT_CHROOT = "chroot"
1006
HT_LXC = "lxc"
1007
HYPER_TYPES = frozenset([
1008
  HT_XEN_PVM,
1009
  HT_FAKE,
1010
  HT_XEN_HVM,
1011
  HT_KVM,
1012
  HT_CHROOT,
1013
  HT_LXC,
1014
  ])
1015
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
1016

    
1017
VNC_BASE_PORT = 5900
1018
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
1019
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
1020

    
1021
# NIC types
1022
HT_NIC_RTL8139 = "rtl8139"
1023
HT_NIC_NE2K_PCI = "ne2k_pci"
1024
HT_NIC_NE2K_ISA = "ne2k_isa"
1025
HT_NIC_I82551 = "i82551"
1026
HT_NIC_I85557B = "i82557b"
1027
HT_NIC_I8259ER = "i82559er"
1028
HT_NIC_PCNET = "pcnet"
1029
HT_NIC_E1000 = "e1000"
1030
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
1031

    
1032
HT_HVM_VALID_NIC_TYPES = frozenset([
1033
  HT_NIC_RTL8139,
1034
  HT_NIC_NE2K_PCI,
1035
  HT_NIC_E1000,
1036
  HT_NIC_NE2K_ISA,
1037
  HT_NIC_PARAVIRTUAL
1038
  ])
1039
HT_KVM_VALID_NIC_TYPES = frozenset([
1040
  HT_NIC_RTL8139,
1041
  HT_NIC_NE2K_PCI,
1042
  HT_NIC_NE2K_ISA,
1043
  HT_NIC_I82551,
1044
  HT_NIC_I85557B,
1045
  HT_NIC_I8259ER,
1046
  HT_NIC_PCNET,
1047
  HT_NIC_E1000,
1048
  HT_NIC_PARAVIRTUAL
1049
  ])
1050

    
1051
# Disk types
1052
HT_DISK_IOEMU = "ioemu"
1053
HT_DISK_IDE = "ide"
1054
HT_DISK_SCSI = "scsi"
1055
HT_DISK_SD = "sd"
1056
HT_DISK_MTD = "mtd"
1057
HT_DISK_PFLASH = "pflash"
1058

    
1059
HT_CACHE_DEFAULT = "default"
1060
HT_CACHE_NONE = "none"
1061
HT_CACHE_WTHROUGH = "writethrough"
1062
HT_CACHE_WBACK = "writeback"
1063
HT_VALID_CACHE_TYPES = frozenset([
1064
  HT_CACHE_DEFAULT,
1065
  HT_CACHE_NONE,
1066
  HT_CACHE_WTHROUGH,
1067
  HT_CACHE_WBACK
1068
  ])
1069

    
1070
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1071
HT_KVM_VALID_DISK_TYPES = frozenset([
1072
  HT_DISK_PARAVIRTUAL,
1073
  HT_DISK_IDE,
1074
  HT_DISK_SCSI,
1075
  HT_DISK_SD,
1076
  HT_DISK_MTD,
1077
  HT_DISK_PFLASH
1078
  ])
1079

    
1080
# Mouse types:
1081
HT_MOUSE_MOUSE = "mouse"
1082
HT_MOUSE_TABLET = "tablet"
1083

    
1084
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1085

    
1086
# Boot order
1087
HT_BO_FLOPPY = "floppy"
1088
HT_BO_CDROM = "cdrom"
1089
HT_BO_DISK = "disk"
1090
HT_BO_NETWORK = "network"
1091

    
1092
HT_KVM_VALID_BO_TYPES = frozenset([
1093
  HT_BO_FLOPPY,
1094
  HT_BO_CDROM,
1095
  HT_BO_DISK,
1096
  HT_BO_NETWORK
1097
  ])
1098

    
1099
# SPICE lossless image compression options
1100
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1101
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1102
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1103
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1104
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1105
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1106

    
1107
HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1108
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1109
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1110
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1111
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1112
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1113
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1114
  ])
1115

    
1116
# SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1117
HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1118
HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1119
HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1120

    
1121
HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1122
  HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1123
  HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1124
  HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1125
  ])
1126

    
1127
# SPICE video stream detection
1128
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1129
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1130
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1131

    
1132
HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1133
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1134
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1135
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1136
  ])
1137

    
1138
# Security models
1139
HT_SM_NONE = "none"
1140
HT_SM_USER = "user"
1141
HT_SM_POOL = "pool"
1142

    
1143
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1144

    
1145
# Kvm flag values
1146
HT_KVM_ENABLED = "enabled"
1147
HT_KVM_DISABLED = "disabled"
1148

    
1149
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1150

    
1151
# Migration type
1152
HT_MIGRATION_LIVE = "live"
1153
HT_MIGRATION_NONLIVE = "non-live"
1154
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1155

    
1156
# Cluster Verify steps
1157
VERIFY_NPLUSONE_MEM = "nplusone_mem"
1158
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1159

    
1160
# Cluster Verify error classes
1161
CV_TCLUSTER = "cluster"
1162
CV_TNODE = "node"
1163
CV_TINSTANCE = "instance"
1164

    
1165
# Cluster Verify error codes and documentation
1166
CV_ECLUSTERCFG = \
1167
  (CV_TCLUSTER, "ECLUSTERCFG", "Cluster configuration verification failure")
1168
CV_ECLUSTERCERT = \
1169
  (CV_TCLUSTER, "ECLUSTERCERT",
1170
   "Cluster certificate files verification failure")
1171
CV_ECLUSTERFILECHECK = \
1172
  (CV_TCLUSTER, "ECLUSTERFILECHECK",
1173
   "Cluster configuration verification failure")
1174
CV_ECLUSTERDANGLINGNODES = \
1175
  (CV_TNODE, "ECLUSTERDANGLINGNODES",
1176
   "Some nodes belong to non-existing groups")
1177
CV_ECLUSTERDANGLINGINST = \
1178
  (CV_TNODE, "ECLUSTERDANGLINGINST",
1179
   "Some instances have a non-existing primary node")
1180
CV_EINSTANCEBADNODE = \
1181
  (CV_TINSTANCE, "EINSTANCEBADNODE",
1182
   "Instance marked as running lives on an offline node")
1183
CV_EINSTANCEDOWN = \
1184
  (CV_TINSTANCE, "EINSTANCEDOWN", "Instance not running on its primary node")
1185
CV_EINSTANCELAYOUT = \
1186
  (CV_TINSTANCE, "EINSTANCELAYOUT", "Instance has multiple secondary nodes")
1187
CV_EINSTANCEMISSINGDISK = \
1188
  (CV_TINSTANCE, "EINSTANCEMISSINGDISK", "Missing volume on an instance")
1189
CV_EINSTANCEFAULTYDISK = \
1190
  (CV_TINSTANCE, "EINSTANCEFAULTYDISK",
1191
   "Impossible to retrieve status for a disk")
1192
CV_EINSTANCEWRONGNODE = \
1193
  (CV_TINSTANCE, "EINSTANCEWRONGNODE", "Instance running on the wrong node")
1194
CV_EINSTANCESPLITGROUPS = \
1195
  (CV_TINSTANCE, "EINSTANCESPLITGROUPS",
1196
   "Instance with primary and secondary nodes in different groups")
1197
CV_ENODEDRBD = \
1198
  (CV_TNODE, "ENODEDRBD", "Error parsing the DRBD status file")
1199
CV_ENODEDRBDHELPER = \
1200
  (CV_TNODE, "ENODEDRBDHELPER", "Error caused by the DRBD helper")
1201
CV_ENODEFILECHECK = \
1202
  (CV_TNODE, "ENODEFILECHECK",
1203
   "Error retrieving the checksum of the node files")
1204
CV_ENODEHOOKS = \
1205
  (CV_TNODE, "ENODEHOOKS", "Communication failure in hooks execution")
1206
CV_ENODEHV = \
1207
  (CV_TNODE, "ENODEHV", "Hypervisor parameters verification failure")
1208
CV_ENODELVM = \
1209
  (CV_TNODE, "ENODELVM", "LVM-related node error")
1210
CV_ENODEN1 = \
1211
  (CV_TNODE, "ENODEN1", "Not enough memory to accommodate instance failovers")
1212
CV_ENODENET = \
1213
  (CV_TNODE, "ENODENET", "Network-related node error")
1214
CV_ENODEOS = \
1215
  (CV_TNODE, "ENODEOS", "OS-related node error")
1216
CV_ENODEORPHANINSTANCE = \
1217
  (CV_TNODE, "ENODEORPHANINSTANCE", "Unknown intance running on a node")
1218
CV_ENODEORPHANLV = \
1219
  (CV_TNODE, "ENODEORPHANLV", "Unknown LVM logical volume")
1220
CV_ENODERPC = \
1221
  (CV_TNODE, "ENODERPC",
1222
   "Error during connection to the primary node of an instance")
1223
CV_ENODESSH = \
1224
  (CV_TNODE, "ENODESSH", "SSH-related node error")
1225
CV_ENODEVERSION = \
1226
  (CV_TNODE, "ENODEVERSION",
1227
   "Protocol version mismatch or Ganeti version mismatch")
1228
CV_ENODESETUP = \
1229
  (CV_TNODE, "ENODESETUP", "Node setup error")
1230
CV_ENODETIME = \
1231
  (CV_TNODE, "ENODETIME", "Node returned invalid time")
1232
CV_ENODEOOBPATH = \
1233
  (CV_TNODE, "ENODEOOBPATH", "Invalid Out Of Band path")
1234
CV_ENODEUSERSCRIPTS = \
1235
  (CV_TNODE, "ENODEUSERSCRIPTS", "User scripts not present or not executable")
1236

    
1237
CV_ALL_ECODES = frozenset([
1238
  CV_ECLUSTERCFG,
1239
  CV_ECLUSTERCERT,
1240
  CV_ECLUSTERFILECHECK,
1241
  CV_ECLUSTERDANGLINGNODES,
1242
  CV_ECLUSTERDANGLINGINST,
1243
  CV_EINSTANCEBADNODE,
1244
  CV_EINSTANCEDOWN,
1245
  CV_EINSTANCELAYOUT,
1246
  CV_EINSTANCEMISSINGDISK,
1247
  CV_EINSTANCEFAULTYDISK,
1248
  CV_EINSTANCEWRONGNODE,
1249
  CV_EINSTANCESPLITGROUPS,
1250
  CV_ENODEDRBD,
1251
  CV_ENODEDRBDHELPER,
1252
  CV_ENODEFILECHECK,
1253
  CV_ENODEHOOKS,
1254
  CV_ENODEHV,
1255
  CV_ENODELVM,
1256
  CV_ENODEN1,
1257
  CV_ENODENET,
1258
  CV_ENODEOS,
1259
  CV_ENODEORPHANINSTANCE,
1260
  CV_ENODEORPHANLV,
1261
  CV_ENODERPC,
1262
  CV_ENODESSH,
1263
  CV_ENODEVERSION,
1264
  CV_ENODESETUP,
1265
  CV_ENODETIME,
1266
  CV_ENODEOOBPATH,
1267
  CV_ENODEUSERSCRIPTS,
1268
  ])
1269

    
1270
CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1271

    
1272
# Node verify constants
1273
NV_DRBDHELPER = "drbd-helper"
1274
NV_DRBDLIST = "drbd-list"
1275
NV_FILELIST = "filelist"
1276
NV_HVINFO = "hvinfo"
1277
NV_HYPERVISOR = "hypervisor"
1278
NV_HVPARAMS = "hvparms"
1279
NV_INSTANCELIST = "instancelist"
1280
NV_LVLIST = "lvlist"
1281
NV_MASTERIP = "master-ip"
1282
NV_NODELIST = "nodelist"
1283
NV_NODENETTEST = "node-net-test"
1284
NV_NODESETUP = "nodesetup"
1285
NV_OSLIST = "oslist"
1286
NV_PVLIST = "pvlist"
1287
NV_TIME = "time"
1288
NV_VERSION = "version"
1289
NV_VGLIST = "vglist"
1290
NV_VMNODES = "vmnodes"
1291
NV_OOB_PATHS = "oob-paths"
1292
NV_BRIDGES = "bridges"
1293
NV_USERSCRIPTS = "user-scripts"
1294

    
1295
# Instance status
1296
INSTST_RUNNING = "running"
1297
INSTST_ADMINDOWN = "ADMIN_down"
1298
INSTST_ADMINOFFLINE = "ADMIN_offline"
1299
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1300
INSTST_NODEDOWN = "ERROR_nodedown"
1301
INSTST_WRONGNODE = "ERROR_wrongnode"
1302
INSTST_ERRORUP = "ERROR_up"
1303
INSTST_ERRORDOWN = "ERROR_down"
1304
INSTST_ALL = frozenset([
1305
  INSTST_RUNNING,
1306
  INSTST_ADMINDOWN,
1307
  INSTST_ADMINOFFLINE,
1308
  INSTST_NODEOFFLINE,
1309
  INSTST_NODEDOWN,
1310
  INSTST_WRONGNODE,
1311
  INSTST_ERRORUP,
1312
  INSTST_ERRORDOWN,
1313
  ])
1314

    
1315
# Admin states
1316
ADMINST_UP = "up"
1317
ADMINST_DOWN = "down"
1318
ADMINST_OFFLINE = "offline"
1319
ADMINST_ALL = frozenset([
1320
  ADMINST_UP,
1321
  ADMINST_DOWN,
1322
  ADMINST_OFFLINE,
1323
  ])
1324

    
1325
# Node roles
1326
NR_REGULAR = "R"
1327
NR_MASTER = "M"
1328
NR_MCANDIDATE = "C"
1329
NR_DRAINED = "D"
1330
NR_OFFLINE = "O"
1331
NR_ALL = frozenset([
1332
  NR_REGULAR,
1333
  NR_MASTER,
1334
  NR_MCANDIDATE,
1335
  NR_DRAINED,
1336
  NR_OFFLINE,
1337
  ])
1338

    
1339
# SSL certificate check constants (in days)
1340
SSL_CERT_EXPIRATION_WARN = 30
1341
SSL_CERT_EXPIRATION_ERROR = 7
1342

    
1343
# Allocator framework constants
1344
IALLOCATOR_VERSION = 2
1345
IALLOCATOR_DIR_IN = "in"
1346
IALLOCATOR_DIR_OUT = "out"
1347
VALID_IALLOCATOR_DIRECTIONS = frozenset([
1348
  IALLOCATOR_DIR_IN,
1349
  IALLOCATOR_DIR_OUT,
1350
  ])
1351
IALLOCATOR_MODE_ALLOC = "allocate"
1352
IALLOCATOR_MODE_RELOC = "relocate"
1353
IALLOCATOR_MODE_CHG_GROUP = "change-group"
1354
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1355
VALID_IALLOCATOR_MODES = frozenset([
1356
  IALLOCATOR_MODE_ALLOC,
1357
  IALLOCATOR_MODE_RELOC,
1358
  IALLOCATOR_MODE_CHG_GROUP,
1359
  IALLOCATOR_MODE_NODE_EVAC,
1360
  ])
1361
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1362

    
1363
IALLOCATOR_NEVAC_PRI = "primary-only"
1364
IALLOCATOR_NEVAC_SEC = "secondary-only"
1365
IALLOCATOR_NEVAC_ALL = "all"
1366
IALLOCATOR_NEVAC_MODES = frozenset([
1367
  IALLOCATOR_NEVAC_PRI,
1368
  IALLOCATOR_NEVAC_SEC,
1369
  IALLOCATOR_NEVAC_ALL,
1370
  ])
1371

    
1372
# Node evacuation
1373
NODE_EVAC_PRI = "primary-only"
1374
NODE_EVAC_SEC = "secondary-only"
1375
NODE_EVAC_ALL = "all"
1376
NODE_EVAC_MODES = frozenset([
1377
  NODE_EVAC_PRI,
1378
  NODE_EVAC_SEC,
1379
  NODE_EVAC_ALL,
1380
  ])
1381

    
1382
# Job queue
1383
JOB_QUEUE_VERSION = 1
1384
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1385
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1386
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1387
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1388
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1389
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1390
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
1391
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
1392

    
1393
JOB_ID_TEMPLATE = r"\d+"
1394
JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1395

    
1396
# unchanged job return
1397
JOB_NOTCHANGED = "nochange"
1398

    
1399
# Job status
1400
JOB_STATUS_QUEUED = "queued"
1401
JOB_STATUS_WAITING = "waiting"
1402
JOB_STATUS_CANCELING = "canceling"
1403
JOB_STATUS_RUNNING = "running"
1404
JOB_STATUS_CANCELED = "canceled"
1405
JOB_STATUS_SUCCESS = "success"
1406
JOB_STATUS_ERROR = "error"
1407
JOBS_FINALIZED = frozenset([
1408
  JOB_STATUS_CANCELED,
1409
  JOB_STATUS_SUCCESS,
1410
  JOB_STATUS_ERROR,
1411
  ])
1412
JOB_STATUS_ALL = frozenset([
1413
  JOB_STATUS_QUEUED,
1414
  JOB_STATUS_WAITING,
1415
  JOB_STATUS_CANCELING,
1416
  JOB_STATUS_RUNNING,
1417
  ]) | JOBS_FINALIZED
1418

    
1419
# OpCode status
1420
# not yet finalized
1421
OP_STATUS_QUEUED = "queued"
1422
OP_STATUS_WAITING = "waiting"
1423
OP_STATUS_CANCELING = "canceling"
1424
OP_STATUS_RUNNING = "running"
1425
# finalized
1426
OP_STATUS_CANCELED = "canceled"
1427
OP_STATUS_SUCCESS = "success"
1428
OP_STATUS_ERROR = "error"
1429
OPS_FINALIZED = frozenset([
1430
  OP_STATUS_CANCELED,
1431
  OP_STATUS_SUCCESS,
1432
  OP_STATUS_ERROR
1433
  ])
1434

    
1435
# OpCode priority
1436
OP_PRIO_LOWEST = +19
1437
OP_PRIO_HIGHEST = -20
1438

    
1439
OP_PRIO_LOW = +10
1440
OP_PRIO_NORMAL = 0
1441
OP_PRIO_HIGH = -10
1442

    
1443
OP_PRIO_SUBMIT_VALID = frozenset([
1444
  OP_PRIO_LOW,
1445
  OP_PRIO_NORMAL,
1446
  OP_PRIO_HIGH,
1447
  ])
1448

    
1449
OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1450

    
1451
# Execution log types
1452
ELOG_MESSAGE = "message"
1453
ELOG_PROGRESS = "progress"
1454
ELOG_REMOTE_IMPORT = "remote-import"
1455
ELOG_JQUEUE_TEST = "jqueue-test"
1456

    
1457
# /etc/hosts modification
1458
ETC_HOSTS_ADD = "add"
1459
ETC_HOSTS_REMOVE = "remove"
1460

    
1461
# Job queue test
1462
JQT_MSGPREFIX = "TESTMSG="
1463
JQT_EXPANDNAMES = "expandnames"
1464
JQT_EXEC = "exec"
1465
JQT_LOGMSG = "logmsg"
1466
JQT_STARTMSG = "startmsg"
1467
JQT_ALL = frozenset([
1468
  JQT_EXPANDNAMES,
1469
  JQT_EXEC,
1470
  JQT_LOGMSG,
1471
  JQT_STARTMSG,
1472
  ])
1473

    
1474
# Query resources
1475
QR_INSTANCE = "instance"
1476
QR_NODE = "node"
1477
QR_LOCK = "lock"
1478
QR_GROUP = "group"
1479
QR_OS = "os"
1480

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

    
1484
#: List of resources which can be queried using Local UniX Interface
1485
QR_VIA_LUXI = QR_VIA_OP.union([
1486
  QR_LOCK,
1487
  ])
1488

    
1489
#: List of resources which can be queried using RAPI
1490
QR_VIA_RAPI = QR_VIA_LUXI
1491

    
1492
# Query field types
1493
QFT_UNKNOWN = "unknown"
1494
QFT_TEXT = "text"
1495
QFT_BOOL = "bool"
1496
QFT_NUMBER = "number"
1497
QFT_UNIT = "unit"
1498
QFT_TIMESTAMP = "timestamp"
1499
QFT_OTHER = "other"
1500

    
1501
#: All query field types
1502
QFT_ALL = frozenset([
1503
  QFT_UNKNOWN,
1504
  QFT_TEXT,
1505
  QFT_BOOL,
1506
  QFT_NUMBER,
1507
  QFT_UNIT,
1508
  QFT_TIMESTAMP,
1509
  QFT_OTHER,
1510
  ])
1511

    
1512
# Query result field status (don't change or reuse values as they're used by
1513
# clients)
1514
#: Normal field status
1515
RS_NORMAL = 0
1516
#: Unknown field
1517
RS_UNKNOWN = 1
1518
#: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1519
RS_NODATA = 2
1520
#: Value unavailable/unsupported for item; if this field is supported
1521
#: but we cannot get the data for the moment, RS_NODATA or
1522
#: RS_OFFLINE should be used
1523
RS_UNAVAIL = 3
1524
#: Resource marked offline
1525
RS_OFFLINE = 4
1526

    
1527
RS_ALL = frozenset([
1528
  RS_NORMAL,
1529
  RS_UNKNOWN,
1530
  RS_NODATA,
1531
  RS_UNAVAIL,
1532
  RS_OFFLINE,
1533
  ])
1534

    
1535
#: Dictionary with special field cases and their verbose/terse formatting
1536
RSS_DESCRIPTION = {
1537
  RS_UNKNOWN: ("(unknown)", "??"),
1538
  RS_NODATA: ("(nodata)", "?"),
1539
  RS_OFFLINE: ("(offline)", "*"),
1540
  RS_UNAVAIL: ("(unavail)", "-"),
1541
  }
1542

    
1543
# max dynamic devices
1544
MAX_NICS = 8
1545
MAX_DISKS = 16
1546

    
1547
# SSCONF keys
1548
SS_CLUSTER_NAME = "cluster_name"
1549
SS_CLUSTER_TAGS = "cluster_tags"
1550
SS_FILE_STORAGE_DIR = "file_storage_dir"
1551
SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1552
SS_MASTER_CANDIDATES = "master_candidates"
1553
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1554
SS_MASTER_IP = "master_ip"
1555
SS_MASTER_NETDEV = "master_netdev"
1556
SS_MASTER_NETMASK = "master_netmask"
1557
SS_MASTER_NODE = "master_node"
1558
SS_NODE_LIST = "node_list"
1559
SS_NODE_PRIMARY_IPS = "node_primary_ips"
1560
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1561
SS_OFFLINE_NODES = "offline_nodes"
1562
SS_ONLINE_NODES = "online_nodes"
1563
SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1564
SS_INSTANCE_LIST = "instance_list"
1565
SS_RELEASE_VERSION = "release_version"
1566
SS_HYPERVISOR_LIST = "hypervisor_list"
1567
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1568
SS_UID_POOL = "uid_pool"
1569
SS_NODEGROUPS = "nodegroups"
1570

    
1571
SS_FILE_PERMS = 0444
1572

    
1573
# cluster wide default parameters
1574
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1575

    
1576
HVC_DEFAULTS = {
1577
  HT_XEN_PVM: {
1578
    HV_USE_BOOTLOADER: False,
1579
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1580
    HV_BOOTLOADER_ARGS: "",
1581
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1582
    HV_INITRD_PATH: "",
1583
    HV_ROOT_PATH: "/dev/sda1",
1584
    HV_KERNEL_ARGS: "ro",
1585
    HV_MIGRATION_PORT: 8002,
1586
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1587
    HV_BLOCKDEV_PREFIX: "sd",
1588
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1589
    HV_CPU_MASK: CPU_PINNING_ALL,
1590
    },
1591
  HT_XEN_HVM: {
1592
    HV_BOOT_ORDER: "cd",
1593
    HV_CDROM_IMAGE_PATH: "",
1594
    HV_NIC_TYPE: HT_NIC_RTL8139,
1595
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1596
    HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1597
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1598
    HV_ACPI: True,
1599
    HV_PAE: True,
1600
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1601
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1602
    HV_MIGRATION_PORT: 8002,
1603
    HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1604
    HV_USE_LOCALTIME: False,
1605
    HV_BLOCKDEV_PREFIX: "hd",
1606
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1607
    HV_CPU_MASK: CPU_PINNING_ALL,
1608
    },
1609
  HT_KVM: {
1610
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1611
    HV_INITRD_PATH: "",
1612
    HV_KERNEL_ARGS: "ro",
1613
    HV_ROOT_PATH: "/dev/vda1",
1614
    HV_ACPI: True,
1615
    HV_SERIAL_CONSOLE: True,
1616
    HV_VNC_BIND_ADDRESS: "",
1617
    HV_VNC_TLS: False,
1618
    HV_VNC_X509: "",
1619
    HV_VNC_X509_VERIFY: False,
1620
    HV_VNC_PASSWORD_FILE: "",
1621
    HV_KVM_SPICE_BIND: "",
1622
    HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1623
    HV_KVM_SPICE_PASSWORD_FILE: "",
1624
    HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1625
    HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1626
    HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1627
    HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1628
    HV_KVM_SPICE_AUDIO_COMPR: True,
1629
    HV_KVM_SPICE_USE_TLS: False,
1630
    HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1631
    HV_KVM_SPICE_USE_VDAGENT: True,
1632
    HV_KVM_FLOPPY_IMAGE_PATH: "",
1633
    HV_CDROM_IMAGE_PATH: "",
1634
    HV_KVM_CDROM2_IMAGE_PATH: "",
1635
    HV_BOOT_ORDER: HT_BO_DISK,
1636
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1637
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1638
    HV_KVM_CDROM_DISK_TYPE: "",
1639
    HV_USB_MOUSE: "",
1640
    HV_KEYMAP: "",
1641
    HV_MIGRATION_PORT: 8102,
1642
    HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1643
    HV_MIGRATION_DOWNTIME: 30,  # ms
1644
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1645
    HV_USE_LOCALTIME: False,
1646
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
1647
    HV_SECURITY_MODEL: HT_SM_NONE,
1648
    HV_SECURITY_DOMAIN: "",
1649
    HV_KVM_FLAG: "",
1650
    HV_VHOST_NET: False,
1651
    HV_KVM_USE_CHROOT: False,
1652
    HV_MEM_PATH: "",
1653
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1654
    HV_CPU_MASK: CPU_PINNING_ALL,
1655
    },
1656
  HT_FAKE: {
1657
    },
1658
  HT_CHROOT: {
1659
    HV_INIT_SCRIPT: "/ganeti-chroot",
1660
    },
1661
  HT_LXC: {
1662
    HV_CPU_MASK: "",
1663
    },
1664
  }
1665

    
1666
HVC_GLOBALS = frozenset([
1667
  HV_MIGRATION_PORT,
1668
  HV_MIGRATION_BANDWIDTH,
1669
  HV_MIGRATION_MODE,
1670
  ])
1671

    
1672
BEC_DEFAULTS = {
1673
  BE_MINMEM: 128,
1674
  BE_MAXMEM: 128,
1675
  BE_VCPUS: 1,
1676
  BE_AUTO_BALANCE: True,
1677
  }
1678

    
1679
NDC_DEFAULTS = {
1680
  ND_OOB_PROGRAM: None,
1681
  }
1682

    
1683
DISK_LD_DEFAULTS = {
1684
  LD_DRBD8: {
1685
    RESYNC_RATE: CLASSIC_DRBD_SYNC_SPEED,
1686
    },
1687
  LD_LV: {
1688
    STRIPES: _autoconf.LVM_STRIPECOUNT
1689
    },
1690
  LD_FILE: {
1691
    },
1692
  LD_BLOCKDEV: {
1693
    },
1694
  }
1695

    
1696
DISK_DT_DEFAULTS = {
1697
  DT_PLAIN: {
1698
    LV_STRIPES: DISK_LD_DEFAULTS[LD_LV][STRIPES],
1699
    },
1700
  DT_DRBD8: {
1701
    DRBD_RESYNC_RATE: DISK_LD_DEFAULTS[LD_DRBD8][RESYNC_RATE],
1702
    DRBD_DATA_STRIPES: DISK_LD_DEFAULTS[LD_LV][STRIPES],
1703
    DRBD_META_STRIPES: DISK_LD_DEFAULTS[LD_LV][STRIPES],
1704
    },
1705
  DT_DISKLESS: {
1706
    },
1707
  DT_FILE: {
1708
    },
1709
  DT_SHARED_FILE: {
1710
    },
1711
  DT_BLOCK: {
1712
    },
1713
  }
1714

    
1715
NICC_DEFAULTS = {
1716
  NIC_MODE: NIC_MODE_BRIDGED,
1717
  NIC_LINK: DEFAULT_BRIDGE,
1718
  }
1719

    
1720
MASTER_POOL_SIZE_DEFAULT = 10
1721

    
1722
CONFD_PROTOCOL_VERSION = 1
1723

    
1724
CONFD_REQ_PING = 0
1725
CONFD_REQ_NODE_ROLE_BYNAME = 1
1726
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1727
CONFD_REQ_CLUSTER_MASTER = 3
1728
CONFD_REQ_NODE_PIP_LIST = 4
1729
CONFD_REQ_MC_PIP_LIST = 5
1730
CONFD_REQ_INSTANCES_IPS_LIST = 6
1731

    
1732
# Confd request query fields. These are used to narrow down queries.
1733
# These must be strings rather than integers, because json-encoding
1734
# converts them to strings anyway, as they're used as dict-keys.
1735
CONFD_REQQ_LINK = "0"
1736
CONFD_REQQ_IP = "1"
1737
CONFD_REQQ_IPLIST = "2"
1738
CONFD_REQQ_FIELDS = "3"
1739

    
1740
CONFD_REQFIELD_NAME = "0"
1741
CONFD_REQFIELD_IP = "1"
1742
CONFD_REQFIELD_MNODE_PIP = "2"
1743

    
1744
CONFD_REQS = frozenset([
1745
  CONFD_REQ_PING,
1746
  CONFD_REQ_NODE_ROLE_BYNAME,
1747
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1748
  CONFD_REQ_CLUSTER_MASTER,
1749
  CONFD_REQ_NODE_PIP_LIST,
1750
  CONFD_REQ_MC_PIP_LIST,
1751
  CONFD_REQ_INSTANCES_IPS_LIST,
1752
  ])
1753

    
1754
CONFD_REPL_STATUS_OK = 0
1755
CONFD_REPL_STATUS_ERROR = 1
1756
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1757

    
1758
CONFD_REPL_STATUSES = frozenset([
1759
  CONFD_REPL_STATUS_OK,
1760
  CONFD_REPL_STATUS_ERROR,
1761
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
1762
  ])
1763

    
1764
(CONFD_NODE_ROLE_MASTER,
1765
 CONFD_NODE_ROLE_CANDIDATE,
1766
 CONFD_NODE_ROLE_OFFLINE,
1767
 CONFD_NODE_ROLE_DRAINED,
1768
 CONFD_NODE_ROLE_REGULAR,
1769
 ) = range(5)
1770

    
1771
# A few common errors for confd
1772
CONFD_ERROR_UNKNOWN_ENTRY = 1
1773
CONFD_ERROR_INTERNAL = 2
1774
CONFD_ERROR_ARGUMENT = 3
1775

    
1776
# Each request is "salted" by the current timestamp.
1777
# This constants decides how many seconds of skew to accept.
1778
# TODO: make this a default and allow the value to be more configurable
1779
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1780

    
1781
# When we haven't reloaded the config for more than this amount of seconds, we
1782
# force a test to see if inotify is betraying us.
1783
CONFD_CONFIG_RELOAD_TIMEOUT = 60
1784

    
1785
# If we receive more than one update in this amount of seconds, we move to
1786
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
1787
# to serve more requests.
1788
CONFD_CONFIG_RELOAD_RATELIMIT = 2
1789

    
1790
# Magic number prepended to all confd queries.
1791
# This allows us to distinguish different types of confd protocols and handle
1792
# them. For example by changing this we can move the whole payload to be
1793
# compressed, or move away from json.
1794
CONFD_MAGIC_FOURCC = "plj0"
1795

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

    
1801
# Timeout in seconds to expire pending query request in the confd client
1802
# library. We don't actually expect any answer more than 10 seconds after we
1803
# sent a request.
1804
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1805

    
1806
# Maximum UDP datagram size.
1807
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1808
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1809
#   (assuming we can't use jumbo frames)
1810
# We just set this to 60K, which should be enough
1811
MAX_UDP_DATA_SIZE = 61440
1812

    
1813
# User-id pool minimum/maximum acceptable user-ids.
1814
UIDPOOL_UID_MIN = 0
1815
UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
1816

    
1817
# Name or path of the pgrep command
1818
PGREP = "pgrep"
1819

    
1820
# Name of the node group that gets created at cluster init or upgrade
1821
INITIAL_NODE_GROUP_NAME = "default"
1822

    
1823
# Possible values for NodeGroup.alloc_policy
1824
ALLOC_POLICY_PREFERRED = "preferred"
1825
ALLOC_POLICY_LAST_RESORT = "last_resort"
1826
ALLOC_POLICY_UNALLOCABLE = "unallocable"
1827
VALID_ALLOC_POLICIES = [
1828
  ALLOC_POLICY_PREFERRED,
1829
  ALLOC_POLICY_LAST_RESORT,
1830
  ALLOC_POLICY_UNALLOCABLE,
1831
  ]
1832

    
1833
# Temporary external/shared storage parameters
1834
BLOCKDEV_DRIVER_MANUAL = "manual"
1835

    
1836
# qemu-img path, required for ovfconverter
1837
QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
1838

    
1839
# Whether htools was enabled at compilation time
1840
HTOOLS = _autoconf.HTOOLS
1841
# The hail iallocator
1842
IALLOC_HAIL = "hail"
1843

    
1844
# Fake opcodes for functions that have hooks attached to them via
1845
# backend.RunLocalHooks
1846
FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
1847
FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
1848

    
1849
# Do not re-export imported modules
1850
del re, _vcsversion, _autoconf