Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 17b0b812

History | View | Annotate | Download (46.7 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

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

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

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

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

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

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

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

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

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

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

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

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

    
255
DEV_CONSOLE = "/dev/console"
256

    
257
PROC_MOUNTS = "/proc/mounts"
258

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

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

    
270
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
271
EXPORT_DIR = _autoconf.EXPORT_DIR
272

    
273
EXPORT_CONF_FILE = "config.ini"
274

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

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

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

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

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

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

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

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

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

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

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

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

    
323
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
324

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

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

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

    
339
IE_CUSTOM_SIZE = "fd"
340

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

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

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

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

    
361
# hooks-related constants
362
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
363
HOOKS_PHASE_PRE = "pre"
364
HOOKS_PHASE_POST = "post"
365
HOOKS_NAME_CFGUPDATE = "config-update"
366
HOOKS_NAME_WATCHER = "watcher"
367
HOOKS_VERSION = 2
368

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
456
# logical disk types
457
LD_LV = "lvm"
458
LD_DRBD8 = "drbd8"
459
LD_FILE = "file"
460
LD_BLOCKDEV = "blockdev"
461
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV])
462

    
463
# drbd constants
464
DRBD_HMAC_ALG = "md5"
465
DRBD_NET_PROTOCOL = "C"
466
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
467

    
468
# file backend driver
469
FD_LOOP = "loop"
470
FD_BLKTAP = "blktap"
471

    
472
# the set of drbd-like disk types
473
LDS_DRBD = frozenset([LD_DRBD8])
474

    
475
# disk access mode
476
DISK_RDONLY = "ro"
477
DISK_RDWR = "rw"
478
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
479

    
480
# disk replacement mode
481
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
482
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
483
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
484
REPLACE_DISK_AUTO = "replace_auto"
485
REPLACE_MODES = frozenset([
486
  REPLACE_DISK_PRI,
487
  REPLACE_DISK_SEC,
488
  REPLACE_DISK_CHG,
489
  REPLACE_DISK_AUTO,
490
  ])
491

    
492
# Instance export mode
493
EXPORT_MODE_LOCAL = "local"
494
EXPORT_MODE_REMOTE = "remote"
495
EXPORT_MODES = frozenset([
496
  EXPORT_MODE_LOCAL,
497
  EXPORT_MODE_REMOTE,
498
  ])
499

    
500
# Lock recalculate mode
501
LOCKS_REPLACE = "replace"
502
LOCKS_APPEND = "append"
503

    
504
# Lock timeout (sum) before we should go into blocking acquire (still
505
# can be reset by priority change); computed as max time (10 hours)
506
# before we should actually go into blocking acquire given that we
507
# start from default priority level; in seconds
508
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
509
LOCK_ATTEMPTS_MAXWAIT = 15.0
510
LOCK_ATTEMPTS_MINWAIT = 1.0
511

    
512
# instance creation modes
513
INSTANCE_CREATE = "create"
514
INSTANCE_IMPORT = "import"
515
INSTANCE_REMOTE_IMPORT = "remote-import"
516
INSTANCE_CREATE_MODES = frozenset([
517
  INSTANCE_CREATE,
518
  INSTANCE_IMPORT,
519
  INSTANCE_REMOTE_IMPORT,
520
  ])
521

    
522
# Remote import/export handshake message and version
523
RIE_VERSION = 0
524
RIE_HANDSHAKE = "Hi, I'm Ganeti"
525

    
526
# Remote import/export certificate validity in seconds
527
RIE_CERT_VALIDITY = 24 * 60 * 60
528

    
529
# Overall timeout for establishing connection
530
RIE_CONNECT_TIMEOUT = 180
531

    
532
# Export only: how long to wait per connection attempt (seconds)
533
RIE_CONNECT_ATTEMPT_TIMEOUT = 20
534

    
535
# Export only: number of attempts to connect
536
RIE_CONNECT_RETRIES = 10
537

    
538
#: Give child process up to 5 seconds to exit after sending a signal
539
CHILD_LINGER_TIMEOUT = 5.0
540

    
541
DISK_TEMPLATES = frozenset([
542
  DT_DISKLESS,
543
  DT_PLAIN,
544
  DT_DRBD8,
545
  DT_FILE,
546
  DT_SHARED_FILE,
547
  DT_BLOCK
548
  ])
549

    
550
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
551

    
552
# import/export config options
553
INISECT_EXP = "export"
554
INISECT_INS = "instance"
555
INISECT_HYP = "hypervisor"
556
INISECT_BEP = "backend"
557
INISECT_OSP = "os"
558

    
559
# dynamic device modification
560
DDM_ADD = "add"
561
DDM_REMOVE = "remove"
562
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
563

    
564
# common exit codes
565
EXIT_SUCCESS = 0
566
EXIT_FAILURE = 1
567
EXIT_NOTCLUSTER = 5
568
EXIT_NOTMASTER = 11
569
EXIT_NODESETUP_ERROR = 12
570
EXIT_CONFIRMATION = 13 # need user confirmation
571

    
572
#: Exit code for query operations with unknown fields
573
EXIT_UNKNOWN_FIELD = 14
574

    
575
# tags
576
TAG_CLUSTER = "cluster"
577
TAG_NODEGROUP = "nodegroup"
578
TAG_NODE = "node"
579
TAG_INSTANCE = "instance"
580
VALID_TAG_TYPES = frozenset([
581
  TAG_CLUSTER,
582
  TAG_NODEGROUP,
583
  TAG_NODE,
584
  TAG_INSTANCE,
585
  ])
586
MAX_TAG_LEN = 128
587
MAX_TAGS_PER_OBJ = 4096
588

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

    
615
#: Key for job IDs in opcode result
616
JOB_IDS_KEY = "jobs"
617

    
618
# runparts results
619
(RUNPARTS_SKIP,
620
 RUNPARTS_RUN,
621
 RUNPARTS_ERR) = range(3)
622

    
623
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
624

    
625
# RPC constants
626
(RPC_ENCODING_NONE,
627
 RPC_ENCODING_ZLIB_BASE64) = range(2)
628

    
629
# os related constants
630
OS_SCRIPT_CREATE = "create"
631
OS_SCRIPT_IMPORT = "import"
632
OS_SCRIPT_EXPORT = "export"
633
OS_SCRIPT_RENAME = "rename"
634
OS_SCRIPT_VERIFY = "verify"
635
OS_SCRIPTS = frozenset([
636
  OS_SCRIPT_CREATE,
637
  OS_SCRIPT_IMPORT,
638
  OS_SCRIPT_EXPORT,
639
  OS_SCRIPT_RENAME,
640
  OS_SCRIPT_VERIFY
641
  ])
642

    
643
OS_API_FILE = "ganeti_api_version"
644
OS_VARIANTS_FILE = "variants.list"
645
OS_PARAMETERS_FILE = "parameters.list"
646

    
647
OS_VALIDATE_PARAMETERS = "parameters"
648
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
649

    
650
# ssh constants
651
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
652
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
653
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
654
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
655
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
656
SSH = "ssh"
657
SCP = "scp"
658

    
659
# reboot types
660
INSTANCE_REBOOT_SOFT = "soft"
661
INSTANCE_REBOOT_HARD = "hard"
662
INSTANCE_REBOOT_FULL = "full"
663

    
664
REBOOT_TYPES = frozenset([
665
  INSTANCE_REBOOT_SOFT,
666
  INSTANCE_REBOOT_HARD,
667
  INSTANCE_REBOOT_FULL
668
  ])
669

    
670
# instance reboot behaviors
671
INSTANCE_REBOOT_ALLOWED = "reboot"
672
INSTANCE_REBOOT_EXIT = "exit"
673

    
674
REBOOT_BEHAVIORS = frozenset([
675
  INSTANCE_REBOOT_ALLOWED,
676
  INSTANCE_REBOOT_EXIT
677
  ])
678

    
679
VTYPE_STRING = "string"
680
VTYPE_MAYBE_STRING = "maybe-string"
681
VTYPE_BOOL = "bool"
682
VTYPE_SIZE = "size" # size, in MiBs
683
VTYPE_INT = "int"
684
ENFORCEABLE_TYPES = frozenset([
685
  VTYPE_STRING,
686
  VTYPE_MAYBE_STRING,
687
  VTYPE_BOOL,
688
  VTYPE_SIZE,
689
  VTYPE_INT,
690
  ])
691

    
692
# Constant representing that the user does not specify any IP version
693
IFACE_NO_IP_VERSION_SPECIFIED = 0
694

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

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

    
804
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
805

    
806
# Migration statuses
807
HV_MIGRATION_COMPLETED = "completed"
808
HV_MIGRATION_ACTIVE = "active"
809
HV_MIGRATION_FAILED = "failed"
810
HV_MIGRATION_CANCELLED = "cancelled"
811

    
812
HV_MIGRATION_VALID_STATUSES = frozenset([
813
  HV_MIGRATION_COMPLETED,
814
  HV_MIGRATION_ACTIVE,
815
  HV_MIGRATION_FAILED,
816
  HV_MIGRATION_CANCELLED,
817
  ])
818

    
819
HV_MIGRATION_FAILED_STATUSES = frozenset([
820
  HV_MIGRATION_FAILED,
821
  HV_MIGRATION_CANCELLED,
822
  ])
823

    
824
# KVM-specific statuses
825
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
826

    
827
# Node info keys
828
HV_NODEINFO_KEY_VERSION = "hv_version"
829

    
830
# Hypervisor state
831
HVST_MEMORY_TOTAL = "mem_total"
832
HVST_MEMORY_NODE = "mem_node"
833
HVST_MEMORY_HV = "mem_hv"
834
HVST_CPU_TOTAL = "cpu_total"
835
HVST_CPU_NODE = "cpu_node"
836

    
837
HVSTS_PARAMETER_TYPES = {
838
  HVST_MEMORY_TOTAL: VTYPE_INT,
839
  HVST_MEMORY_NODE: VTYPE_INT,
840
  HVST_MEMORY_HV: VTYPE_INT,
841
  HVST_CPU_TOTAL: VTYPE_INT,
842
  HVST_CPU_NODE: VTYPE_INT,
843
  }
844

    
845
HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
846

    
847
# Disk state
848
DS_DISK_TOTAL = "disk_total"
849
DS_DISK_RESERVED = "disk_reserved"
850
DS_DISK_OVERHEAD = "disk_overhead"
851

    
852
DSS_PARAMETER_TYPES = {
853
  DS_DISK_TOTAL: VTYPE_INT,
854
  DS_DISK_RESERVED: VTYPE_INT,
855
  DS_DISK_OVERHEAD: VTYPE_INT,
856
  }
857

    
858
DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
859

    
860
# Backend parameter names
861
BE_MEMORY = "memory"
862
BE_VCPUS = "vcpus"
863
BE_AUTO_BALANCE = "auto_balance"
864

    
865
BES_PARAMETER_TYPES = {
866
    BE_MEMORY: VTYPE_SIZE,
867
    BE_VCPUS: VTYPE_INT,
868
    BE_AUTO_BALANCE: VTYPE_BOOL,
869
    }
870

    
871
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
872

    
873
# Node parameter names
874
ND_OOB_PROGRAM = "oob_program"
875

    
876
NDS_PARAMETER_TYPES = {
877
    ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
878
    }
879

    
880
NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
881

    
882
# OOB supported commands
883
OOB_POWER_ON = "power-on"
884
OOB_POWER_OFF = "power-off"
885
OOB_POWER_CYCLE = "power-cycle"
886
OOB_POWER_STATUS = "power-status"
887
OOB_HEALTH = "health"
888

    
889
OOB_COMMANDS = frozenset([
890
  OOB_POWER_ON,
891
  OOB_POWER_OFF,
892
  OOB_POWER_CYCLE,
893
  OOB_POWER_STATUS,
894
  OOB_HEALTH
895
  ])
896

    
897
OOB_POWER_STATUS_POWERED = "powered"
898

    
899
OOB_TIMEOUT = 60 # 60 seconds
900
OOB_POWER_DELAY = 2.0 # 2 seconds
901

    
902
OOB_STATUS_OK = "OK"
903
OOB_STATUS_WARNING = "WARNING"
904
OOB_STATUS_CRITICAL = "CRITICAL"
905
OOB_STATUS_UNKNOWN = "UNKNOWN"
906

    
907
OOB_STATUSES = frozenset([
908
  OOB_STATUS_OK,
909
  OOB_STATUS_WARNING,
910
  OOB_STATUS_CRITICAL,
911
  OOB_STATUS_UNKNOWN,
912
  ])
913

    
914
# Instance Parameters Profile
915
PP_DEFAULT = "default"
916

    
917
# NIC_* constants are used inside the ganeti config
918
NIC_MODE = "mode"
919
NIC_LINK = "link"
920

    
921
NIC_MODE_BRIDGED = "bridged"
922
NIC_MODE_ROUTED = "routed"
923

    
924
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
925

    
926
NICS_PARAMETER_TYPES = {
927
    NIC_MODE: VTYPE_STRING,
928
    NIC_LINK: VTYPE_STRING,
929
    }
930

    
931
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
932

    
933
# IDISK_* constants are used in opcodes, to create/change disks
934
IDISK_SIZE = "size"
935
IDISK_MODE = "mode"
936
IDISK_ADOPT = "adopt"
937
IDISK_VG = "vg"
938
IDISK_METAVG = "metavg"
939
IDISK_PARAMS_TYPES = {
940
  IDISK_SIZE: VTYPE_SIZE,
941
  IDISK_MODE: VTYPE_STRING,
942
  IDISK_ADOPT: VTYPE_STRING,
943
  IDISK_VG: VTYPE_STRING,
944
  IDISK_METAVG: VTYPE_STRING,
945
  }
946
IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
947

    
948
# INIC_* constants are used in opcodes, to create/change nics
949
INIC_MAC = "mac"
950
INIC_IP = "ip"
951
INIC_MODE = "mode"
952
INIC_LINK = "link"
953
INIC_PARAMS_TYPES = {
954
  INIC_IP: VTYPE_MAYBE_STRING,
955
  INIC_LINK: VTYPE_STRING,
956
  INIC_MAC: VTYPE_STRING,
957
  INIC_MODE: VTYPE_STRING,
958
  }
959
INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
960

    
961
# Hypervisor constants
962
HT_XEN_PVM = "xen-pvm"
963
HT_FAKE = "fake"
964
HT_XEN_HVM = "xen-hvm"
965
HT_KVM = "kvm"
966
HT_CHROOT = "chroot"
967
HT_LXC = "lxc"
968
HYPER_TYPES = frozenset([
969
  HT_XEN_PVM,
970
  HT_FAKE,
971
  HT_XEN_HVM,
972
  HT_KVM,
973
  HT_CHROOT,
974
  HT_LXC,
975
  ])
976
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
977

    
978
VNC_BASE_PORT = 5900
979
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
980
VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
981

    
982
# NIC types
983
HT_NIC_RTL8139 = "rtl8139"
984
HT_NIC_NE2K_PCI = "ne2k_pci"
985
HT_NIC_NE2K_ISA = "ne2k_isa"
986
HT_NIC_I82551 = "i82551"
987
HT_NIC_I85557B = "i82557b"
988
HT_NIC_I8259ER = "i82559er"
989
HT_NIC_PCNET = "pcnet"
990
HT_NIC_E1000 = "e1000"
991
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
992

    
993
HT_HVM_VALID_NIC_TYPES = frozenset([
994
  HT_NIC_RTL8139,
995
  HT_NIC_NE2K_PCI,
996
  HT_NIC_E1000,
997
  HT_NIC_NE2K_ISA,
998
  HT_NIC_PARAVIRTUAL
999
  ])
1000
HT_KVM_VALID_NIC_TYPES = frozenset([
1001
  HT_NIC_RTL8139,
1002
  HT_NIC_NE2K_PCI,
1003
  HT_NIC_NE2K_ISA,
1004
  HT_NIC_I82551,
1005
  HT_NIC_I85557B,
1006
  HT_NIC_I8259ER,
1007
  HT_NIC_PCNET,
1008
  HT_NIC_E1000,
1009
  HT_NIC_PARAVIRTUAL
1010
  ])
1011

    
1012
# Disk types
1013
HT_DISK_IOEMU = "ioemu"
1014
HT_DISK_IDE = "ide"
1015
HT_DISK_SCSI = "scsi"
1016
HT_DISK_SD = "sd"
1017
HT_DISK_MTD = "mtd"
1018
HT_DISK_PFLASH = "pflash"
1019

    
1020
HT_CACHE_DEFAULT = "default"
1021
HT_CACHE_NONE = "none"
1022
HT_CACHE_WTHROUGH = "writethrough"
1023
HT_CACHE_WBACK = "writeback"
1024
HT_VALID_CACHE_TYPES = frozenset([
1025
  HT_CACHE_DEFAULT,
1026
  HT_CACHE_NONE,
1027
  HT_CACHE_WTHROUGH,
1028
  HT_CACHE_WBACK
1029
  ])
1030

    
1031
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1032
HT_KVM_VALID_DISK_TYPES = frozenset([
1033
  HT_DISK_PARAVIRTUAL,
1034
  HT_DISK_IDE,
1035
  HT_DISK_SCSI,
1036
  HT_DISK_SD,
1037
  HT_DISK_MTD,
1038
  HT_DISK_PFLASH
1039
  ])
1040

    
1041
# Mouse types:
1042
HT_MOUSE_MOUSE = "mouse"
1043
HT_MOUSE_TABLET = "tablet"
1044

    
1045
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1046

    
1047
# Boot order
1048
HT_BO_FLOPPY = "floppy"
1049
HT_BO_CDROM = "cdrom"
1050
HT_BO_DISK = "disk"
1051
HT_BO_NETWORK = "network"
1052

    
1053
HT_KVM_VALID_BO_TYPES = frozenset([
1054
  HT_BO_FLOPPY,
1055
  HT_BO_CDROM,
1056
  HT_BO_DISK,
1057
  HT_BO_NETWORK
1058
  ])
1059

    
1060
# SPICE lossless image compression options
1061
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1062
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1063
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1064
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1065
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1066
HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1067

    
1068
HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1069
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1070
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1071
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1072
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1073
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1074
  HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1075
  ])
1076

    
1077
# SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1078
HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1079
HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1080
HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1081

    
1082
HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1083
  HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1084
  HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1085
  HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1086
  ])
1087

    
1088
# SPICE video stream detection
1089
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1090
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1091
HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1092

    
1093
HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1094
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1095
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1096
  HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1097
  ])
1098

    
1099
# Security models
1100
HT_SM_NONE = "none"
1101
HT_SM_USER = "user"
1102
HT_SM_POOL = "pool"
1103

    
1104
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1105

    
1106
# Kvm flag values
1107
HT_KVM_ENABLED = "enabled"
1108
HT_KVM_DISABLED = "disabled"
1109

    
1110
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1111

    
1112
# Migration type
1113
HT_MIGRATION_LIVE = "live"
1114
HT_MIGRATION_NONLIVE = "non-live"
1115
HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1116

    
1117
# Cluster Verify steps
1118
VERIFY_NPLUSONE_MEM = "nplusone_mem"
1119
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1120

    
1121
# Cluster Verify error classes
1122
CV_TCLUSTER = "cluster"
1123
CV_TNODE = "node"
1124
CV_TINSTANCE = "instance"
1125

    
1126
# Cluster Verify error codes and documentation
1127
CV_ECLUSTERCFG = \
1128
  (CV_TCLUSTER, "ECLUSTERCFG", "Cluster configuration verification failure")
1129
CV_ECLUSTERCERT = \
1130
  (CV_TCLUSTER, "ECLUSTERCERT",
1131
   "Cluster certificate files verification failure")
1132
CV_ECLUSTERFILECHECK = \
1133
  (CV_TCLUSTER, "ECLUSTERFILECHECK",
1134
   "Cluster configuration verification failure")
1135
CV_ECLUSTERDANGLINGNODES = \
1136
  (CV_TNODE, "ECLUSTERDANGLINGNODES",
1137
   "Some nodes belong to non-existing groups")
1138
CV_ECLUSTERDANGLINGINST = \
1139
  (CV_TNODE, "ECLUSTERDANGLINGINST",
1140
   "Some instances have a non-existing primary node")
1141
CV_EINSTANCEBADNODE = \
1142
  (CV_TINSTANCE, "EINSTANCEBADNODE",
1143
   "Instance marked as running lives on an offline node")
1144
CV_EINSTANCEDOWN = \
1145
  (CV_TINSTANCE, "EINSTANCEDOWN", "Instance not running on its primary node")
1146
CV_EINSTANCELAYOUT = \
1147
  (CV_TINSTANCE, "EINSTANCELAYOUT", "Instance has multiple secondary nodes")
1148
CV_EINSTANCEMISSINGDISK = \
1149
  (CV_TINSTANCE, "EINSTANCEMISSINGDISK", "Missing volume on an instance")
1150
CV_EINSTANCEFAULTYDISK = \
1151
  (CV_TINSTANCE, "EINSTANCEFAULTYDISK",
1152
   "Impossible to retrieve status for a disk")
1153
CV_EINSTANCEWRONGNODE = \
1154
  (CV_TINSTANCE, "EINSTANCEWRONGNODE", "Instance running on the wrong node")
1155
CV_EINSTANCESPLITGROUPS = \
1156
  (CV_TINSTANCE, "EINSTANCESPLITGROUPS",
1157
   "Instance with primary and secondary nodes in different groups")
1158
CV_ENODEDRBD = \
1159
  (CV_TNODE, "ENODEDRBD", "Error parsing the DRBD status file")
1160
CV_ENODEDRBDHELPER = \
1161
  (CV_TNODE, "ENODEDRBDHELPER", "Error caused by the DRBD helper")
1162
CV_ENODEFILECHECK = \
1163
  (CV_TNODE, "ENODEFILECHECK",
1164
   "Error retrieving the checksum of the node files")
1165
CV_ENODEHOOKS = \
1166
  (CV_TNODE, "ENODEHOOKS", "Communication failure in hooks execution")
1167
CV_ENODEHV = \
1168
  (CV_TNODE, "ENODEHV", "Hypervisor parameters verification failure")
1169
CV_ENODELVM = \
1170
  (CV_TNODE, "ENODELVM", "LVM-related node error")
1171
CV_ENODEN1 = \
1172
  (CV_TNODE, "ENODEN1", "Not enough memory to accommodate instance failovers")
1173
CV_ENODENET = \
1174
  (CV_TNODE, "ENODENET", "Network-related node error")
1175
CV_ENODEOS = \
1176
  (CV_TNODE, "ENODEOS", "OS-related node error")
1177
CV_ENODEORPHANINSTANCE = \
1178
  (CV_TNODE, "ENODEORPHANINSTANCE", "Unknown intance running on a node")
1179
CV_ENODEORPHANLV = \
1180
  (CV_TNODE, "ENODEORPHANLV", "Unknown LVM logical volume")
1181
CV_ENODERPC = \
1182
  (CV_TNODE, "ENODERPC",
1183
   "Error during connection to the primary node of an instance")
1184
CV_ENODESSH = \
1185
  (CV_TNODE, "ENODESSH", "SSH-related node error")
1186
CV_ENODEVERSION = \
1187
  (CV_TNODE, "ENODEVERSION",
1188
   "Protocol version mismatch or Ganeti version mismatch")
1189
CV_ENODESETUP = \
1190
  (CV_TNODE, "ENODESETUP", "Node setup error")
1191
CV_ENODETIME = \
1192
  (CV_TNODE, "ENODETIME", "Node returned invalid time")
1193
CV_ENODEOOBPATH = \
1194
  (CV_TNODE, "ENODEOOBPATH", "Invalid Out Of Band path")
1195
CV_ENODEUSERSCRIPTS = \
1196
  (CV_TNODE, "ENODEUSERSCRIPTS", "User scripts not present or not executable")
1197

    
1198
CV_ALL_ECODES = frozenset([
1199
  CV_ECLUSTERCFG,
1200
  CV_ECLUSTERCERT,
1201
  CV_ECLUSTERFILECHECK,
1202
  CV_ECLUSTERDANGLINGNODES,
1203
  CV_ECLUSTERDANGLINGINST,
1204
  CV_EINSTANCEBADNODE,
1205
  CV_EINSTANCEDOWN,
1206
  CV_EINSTANCELAYOUT,
1207
  CV_EINSTANCEMISSINGDISK,
1208
  CV_EINSTANCEFAULTYDISK,
1209
  CV_EINSTANCEWRONGNODE,
1210
  CV_EINSTANCESPLITGROUPS,
1211
  CV_ENODEDRBD,
1212
  CV_ENODEDRBDHELPER,
1213
  CV_ENODEFILECHECK,
1214
  CV_ENODEHOOKS,
1215
  CV_ENODEHV,
1216
  CV_ENODELVM,
1217
  CV_ENODEN1,
1218
  CV_ENODENET,
1219
  CV_ENODEOS,
1220
  CV_ENODEORPHANINSTANCE,
1221
  CV_ENODEORPHANLV,
1222
  CV_ENODERPC,
1223
  CV_ENODESSH,
1224
  CV_ENODEVERSION,
1225
  CV_ENODESETUP,
1226
  CV_ENODETIME,
1227
  CV_ENODEOOBPATH,
1228
  CV_ENODEUSERSCRIPTS,
1229
  ])
1230

    
1231
CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1232

    
1233
# Node verify constants
1234
NV_DRBDHELPER = "drbd-helper"
1235
NV_DRBDLIST = "drbd-list"
1236
NV_FILELIST = "filelist"
1237
NV_HVINFO = "hvinfo"
1238
NV_HYPERVISOR = "hypervisor"
1239
NV_HVPARAMS = "hvparms"
1240
NV_INSTANCELIST = "instancelist"
1241
NV_LVLIST = "lvlist"
1242
NV_MASTERIP = "master-ip"
1243
NV_NODELIST = "nodelist"
1244
NV_NODENETTEST = "node-net-test"
1245
NV_NODESETUP = "nodesetup"
1246
NV_OSLIST = "oslist"
1247
NV_PVLIST = "pvlist"
1248
NV_TIME = "time"
1249
NV_VERSION = "version"
1250
NV_VGLIST = "vglist"
1251
NV_VMNODES = "vmnodes"
1252
NV_OOB_PATHS = "oob-paths"
1253
NV_BRIDGES = "bridges"
1254
NV_USERSCRIPTS = "user-scripts"
1255

    
1256
# Instance status
1257
INSTST_RUNNING = "running"
1258
INSTST_ADMINDOWN = "ADMIN_down"
1259
INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1260
INSTST_NODEDOWN = "ERROR_nodedown"
1261
INSTST_WRONGNODE = "ERROR_wrongnode"
1262
INSTST_ERRORUP = "ERROR_up"
1263
INSTST_ERRORDOWN = "ERROR_down"
1264
INSTST_ALL = frozenset([
1265
  INSTST_RUNNING,
1266
  INSTST_ADMINDOWN,
1267
  INSTST_NODEOFFLINE,
1268
  INSTST_NODEDOWN,
1269
  INSTST_WRONGNODE,
1270
  INSTST_ERRORUP,
1271
  INSTST_ERRORDOWN,
1272
  ])
1273

    
1274
# Node roles
1275
NR_REGULAR = "R"
1276
NR_MASTER = "M"
1277
NR_MCANDIDATE = "C"
1278
NR_DRAINED = "D"
1279
NR_OFFLINE = "O"
1280
NR_ALL = frozenset([
1281
  NR_REGULAR,
1282
  NR_MASTER,
1283
  NR_MCANDIDATE,
1284
  NR_DRAINED,
1285
  NR_OFFLINE,
1286
  ])
1287

    
1288
# SSL certificate check constants (in days)
1289
SSL_CERT_EXPIRATION_WARN = 30
1290
SSL_CERT_EXPIRATION_ERROR = 7
1291

    
1292
# Allocator framework constants
1293
IALLOCATOR_VERSION = 2
1294
IALLOCATOR_DIR_IN = "in"
1295
IALLOCATOR_DIR_OUT = "out"
1296
VALID_IALLOCATOR_DIRECTIONS = frozenset([
1297
  IALLOCATOR_DIR_IN,
1298
  IALLOCATOR_DIR_OUT,
1299
  ])
1300
IALLOCATOR_MODE_ALLOC = "allocate"
1301
IALLOCATOR_MODE_RELOC = "relocate"
1302
IALLOCATOR_MODE_CHG_GROUP = "change-group"
1303
IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1304
VALID_IALLOCATOR_MODES = frozenset([
1305
  IALLOCATOR_MODE_ALLOC,
1306
  IALLOCATOR_MODE_RELOC,
1307
  IALLOCATOR_MODE_CHG_GROUP,
1308
  IALLOCATOR_MODE_NODE_EVAC,
1309
  ])
1310
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1311

    
1312
IALLOCATOR_NEVAC_PRI = "primary-only"
1313
IALLOCATOR_NEVAC_SEC = "secondary-only"
1314
IALLOCATOR_NEVAC_ALL = "all"
1315
IALLOCATOR_NEVAC_MODES = frozenset([
1316
  IALLOCATOR_NEVAC_PRI,
1317
  IALLOCATOR_NEVAC_SEC,
1318
  IALLOCATOR_NEVAC_ALL,
1319
  ])
1320

    
1321
# Job queue
1322
JOB_QUEUE_VERSION = 1
1323
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1324
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1325
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1326
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1327
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1328
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1329
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
1330
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
1331

    
1332
JOB_ID_TEMPLATE = r"\d+"
1333
JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1334

    
1335
# unchanged job return
1336
JOB_NOTCHANGED = "nochange"
1337

    
1338
# Job status
1339
JOB_STATUS_QUEUED = "queued"
1340
JOB_STATUS_WAITING = "waiting"
1341
JOB_STATUS_CANCELING = "canceling"
1342
JOB_STATUS_RUNNING = "running"
1343
JOB_STATUS_CANCELED = "canceled"
1344
JOB_STATUS_SUCCESS = "success"
1345
JOB_STATUS_ERROR = "error"
1346
JOBS_FINALIZED = frozenset([
1347
  JOB_STATUS_CANCELED,
1348
  JOB_STATUS_SUCCESS,
1349
  JOB_STATUS_ERROR,
1350
  ])
1351
JOB_STATUS_ALL = frozenset([
1352
  JOB_STATUS_QUEUED,
1353
  JOB_STATUS_WAITING,
1354
  JOB_STATUS_CANCELING,
1355
  JOB_STATUS_RUNNING,
1356
  ]) | JOBS_FINALIZED
1357

    
1358
# OpCode status
1359
# not yet finalized
1360
OP_STATUS_QUEUED = "queued"
1361
OP_STATUS_WAITING = "waiting"
1362
OP_STATUS_CANCELING = "canceling"
1363
OP_STATUS_RUNNING = "running"
1364
# finalized
1365
OP_STATUS_CANCELED = "canceled"
1366
OP_STATUS_SUCCESS = "success"
1367
OP_STATUS_ERROR = "error"
1368
OPS_FINALIZED = frozenset([
1369
  OP_STATUS_CANCELED,
1370
  OP_STATUS_SUCCESS,
1371
  OP_STATUS_ERROR
1372
  ])
1373

    
1374
# OpCode priority
1375
OP_PRIO_LOWEST = +19
1376
OP_PRIO_HIGHEST = -20
1377

    
1378
OP_PRIO_LOW = +10
1379
OP_PRIO_NORMAL = 0
1380
OP_PRIO_HIGH = -10
1381

    
1382
OP_PRIO_SUBMIT_VALID = frozenset([
1383
  OP_PRIO_LOW,
1384
  OP_PRIO_NORMAL,
1385
  OP_PRIO_HIGH,
1386
  ])
1387

    
1388
OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1389

    
1390
# Execution log types
1391
ELOG_MESSAGE = "message"
1392
ELOG_PROGRESS = "progress"
1393
ELOG_REMOTE_IMPORT = "remote-import"
1394
ELOG_JQUEUE_TEST = "jqueue-test"
1395

    
1396
# /etc/hosts modification
1397
ETC_HOSTS_ADD = "add"
1398
ETC_HOSTS_REMOVE = "remove"
1399

    
1400
# Job queue test
1401
JQT_MSGPREFIX = "TESTMSG="
1402
JQT_EXPANDNAMES = "expandnames"
1403
JQT_EXEC = "exec"
1404
JQT_LOGMSG = "logmsg"
1405
JQT_STARTMSG = "startmsg"
1406
JQT_ALL = frozenset([
1407
  JQT_EXPANDNAMES,
1408
  JQT_EXEC,
1409
  JQT_LOGMSG,
1410
  JQT_STARTMSG,
1411
  ])
1412

    
1413
# Query resources
1414
QR_INSTANCE = "instance"
1415
QR_NODE = "node"
1416
QR_LOCK = "lock"
1417
QR_GROUP = "group"
1418
QR_OS = "os"
1419

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

    
1423
#: List of resources which can be queried using Local UniX Interface
1424
QR_VIA_LUXI = QR_VIA_OP.union([
1425
  QR_LOCK,
1426
  ])
1427

    
1428
#: List of resources which can be queried using RAPI
1429
QR_VIA_RAPI = QR_VIA_LUXI
1430

    
1431
# Query field types
1432
QFT_UNKNOWN = "unknown"
1433
QFT_TEXT = "text"
1434
QFT_BOOL = "bool"
1435
QFT_NUMBER = "number"
1436
QFT_UNIT = "unit"
1437
QFT_TIMESTAMP = "timestamp"
1438
QFT_OTHER = "other"
1439

    
1440
#: All query field types
1441
QFT_ALL = frozenset([
1442
  QFT_UNKNOWN,
1443
  QFT_TEXT,
1444
  QFT_BOOL,
1445
  QFT_NUMBER,
1446
  QFT_UNIT,
1447
  QFT_TIMESTAMP,
1448
  QFT_OTHER,
1449
  ])
1450

    
1451
# Query result field status (don't change or reuse values as they're used by
1452
# clients)
1453
#: Normal field status
1454
RS_NORMAL = 0
1455
#: Unknown field
1456
RS_UNKNOWN = 1
1457
#: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1458
RS_NODATA = 2
1459
#: Value unavailable/unsupported for item; if this field is supported
1460
#: but we cannot get the data for the moment, RS_NODATA or
1461
#: RS_OFFLINE should be used
1462
RS_UNAVAIL = 3
1463
#: Resource marked offline
1464
RS_OFFLINE = 4
1465

    
1466
RS_ALL = frozenset([
1467
  RS_NORMAL,
1468
  RS_UNKNOWN,
1469
  RS_NODATA,
1470
  RS_UNAVAIL,
1471
  RS_OFFLINE,
1472
  ])
1473

    
1474
#: Dictionary with special field cases and their verbose/terse formatting
1475
RSS_DESCRIPTION = {
1476
  RS_UNKNOWN: ("(unknown)", "??"),
1477
  RS_NODATA: ("(nodata)", "?"),
1478
  RS_OFFLINE: ("(offline)", "*"),
1479
  RS_UNAVAIL: ("(unavail)", "-"),
1480
  }
1481

    
1482
# max dynamic devices
1483
MAX_NICS = 8
1484
MAX_DISKS = 16
1485

    
1486
# SSCONF keys
1487
SS_CLUSTER_NAME = "cluster_name"
1488
SS_CLUSTER_TAGS = "cluster_tags"
1489
SS_FILE_STORAGE_DIR = "file_storage_dir"
1490
SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1491
SS_MASTER_CANDIDATES = "master_candidates"
1492
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1493
SS_MASTER_IP = "master_ip"
1494
SS_MASTER_NETDEV = "master_netdev"
1495
SS_MASTER_NETMASK = "master_netmask"
1496
SS_MASTER_NODE = "master_node"
1497
SS_NODE_LIST = "node_list"
1498
SS_NODE_PRIMARY_IPS = "node_primary_ips"
1499
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1500
SS_OFFLINE_NODES = "offline_nodes"
1501
SS_ONLINE_NODES = "online_nodes"
1502
SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1503
SS_INSTANCE_LIST = "instance_list"
1504
SS_RELEASE_VERSION = "release_version"
1505
SS_HYPERVISOR_LIST = "hypervisor_list"
1506
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1507
SS_UID_POOL = "uid_pool"
1508
SS_NODEGROUPS = "nodegroups"
1509

    
1510
SS_FILE_PERMS = 0444
1511

    
1512
# cluster wide default parameters
1513
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1514

    
1515
HVC_DEFAULTS = {
1516
  HT_XEN_PVM: {
1517
    HV_USE_BOOTLOADER: False,
1518
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1519
    HV_BOOTLOADER_ARGS: "",
1520
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1521
    HV_INITRD_PATH: "",
1522
    HV_ROOT_PATH: "/dev/sda1",
1523
    HV_KERNEL_ARGS: "ro",
1524
    HV_MIGRATION_PORT: 8002,
1525
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1526
    HV_BLOCKDEV_PREFIX: "sd",
1527
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1528
    HV_CPU_MASK: CPU_PINNING_ALL,
1529
    },
1530
  HT_XEN_HVM: {
1531
    HV_BOOT_ORDER: "cd",
1532
    HV_CDROM_IMAGE_PATH: "",
1533
    HV_NIC_TYPE: HT_NIC_RTL8139,
1534
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1535
    HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1536
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1537
    HV_ACPI: True,
1538
    HV_PAE: True,
1539
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1540
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1541
    HV_MIGRATION_PORT: 8002,
1542
    HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1543
    HV_USE_LOCALTIME: False,
1544
    HV_BLOCKDEV_PREFIX: "hd",
1545
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1546
    HV_CPU_MASK: CPU_PINNING_ALL,
1547
    },
1548
  HT_KVM: {
1549
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1550
    HV_INITRD_PATH: "",
1551
    HV_KERNEL_ARGS: "ro",
1552
    HV_ROOT_PATH: "/dev/vda1",
1553
    HV_ACPI: True,
1554
    HV_SERIAL_CONSOLE: True,
1555
    HV_VNC_BIND_ADDRESS: "",
1556
    HV_VNC_TLS: False,
1557
    HV_VNC_X509: "",
1558
    HV_VNC_X509_VERIFY: False,
1559
    HV_VNC_PASSWORD_FILE: "",
1560
    HV_KVM_SPICE_BIND: "",
1561
    HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1562
    HV_KVM_SPICE_PASSWORD_FILE: "",
1563
    HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1564
    HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1565
    HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1566
    HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1567
    HV_KVM_SPICE_AUDIO_COMPR: True,
1568
    HV_KVM_SPICE_USE_TLS: False,
1569
    HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1570
    HV_KVM_SPICE_USE_VDAGENT: True,
1571
    HV_KVM_FLOPPY_IMAGE_PATH: "",
1572
    HV_CDROM_IMAGE_PATH: "",
1573
    HV_KVM_CDROM2_IMAGE_PATH: "",
1574
    HV_BOOT_ORDER: HT_BO_DISK,
1575
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1576
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1577
    HV_KVM_CDROM_DISK_TYPE: "",
1578
    HV_USB_MOUSE: "",
1579
    HV_KEYMAP: "",
1580
    HV_MIGRATION_PORT: 8102,
1581
    HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1582
    HV_MIGRATION_DOWNTIME: 30,  # ms
1583
    HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1584
    HV_USE_LOCALTIME: False,
1585
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
1586
    HV_SECURITY_MODEL: HT_SM_NONE,
1587
    HV_SECURITY_DOMAIN: "",
1588
    HV_KVM_FLAG: "",
1589
    HV_VHOST_NET: False,
1590
    HV_KVM_USE_CHROOT: False,
1591
    HV_MEM_PATH: "",
1592
    HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1593
    HV_CPU_MASK: CPU_PINNING_ALL,
1594
    },
1595
  HT_FAKE: {
1596
    },
1597
  HT_CHROOT: {
1598
    HV_INIT_SCRIPT: "/ganeti-chroot",
1599
    },
1600
  HT_LXC: {
1601
    HV_CPU_MASK: "",
1602
    },
1603
  }
1604

    
1605
HVC_GLOBALS = frozenset([
1606
  HV_MIGRATION_PORT,
1607
  HV_MIGRATION_BANDWIDTH,
1608
  HV_MIGRATION_MODE,
1609
  ])
1610

    
1611
BEC_DEFAULTS = {
1612
  BE_MEMORY: 128,
1613
  BE_VCPUS: 1,
1614
  BE_AUTO_BALANCE: True,
1615
  }
1616

    
1617
NDC_DEFAULTS = {
1618
  ND_OOB_PROGRAM: None,
1619
  }
1620

    
1621
NICC_DEFAULTS = {
1622
  NIC_MODE: NIC_MODE_BRIDGED,
1623
  NIC_LINK: DEFAULT_BRIDGE,
1624
  }
1625

    
1626
MASTER_POOL_SIZE_DEFAULT = 10
1627

    
1628
CONFD_PROTOCOL_VERSION = 1
1629

    
1630
CONFD_REQ_PING = 0
1631
CONFD_REQ_NODE_ROLE_BYNAME = 1
1632
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1633
CONFD_REQ_CLUSTER_MASTER = 3
1634
CONFD_REQ_NODE_PIP_LIST = 4
1635
CONFD_REQ_MC_PIP_LIST = 5
1636
CONFD_REQ_INSTANCES_IPS_LIST = 6
1637

    
1638
# Confd request query fields. These are used to narrow down queries.
1639
# These must be strings rather than integers, because json-encoding
1640
# converts them to strings anyway, as they're used as dict-keys.
1641
CONFD_REQQ_LINK = "0"
1642
CONFD_REQQ_IP = "1"
1643
CONFD_REQQ_IPLIST = "2"
1644
CONFD_REQQ_FIELDS = "3"
1645

    
1646
CONFD_REQFIELD_NAME = "0"
1647
CONFD_REQFIELD_IP = "1"
1648
CONFD_REQFIELD_MNODE_PIP = "2"
1649

    
1650
CONFD_REQS = frozenset([
1651
  CONFD_REQ_PING,
1652
  CONFD_REQ_NODE_ROLE_BYNAME,
1653
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1654
  CONFD_REQ_CLUSTER_MASTER,
1655
  CONFD_REQ_NODE_PIP_LIST,
1656
  CONFD_REQ_MC_PIP_LIST,
1657
  CONFD_REQ_INSTANCES_IPS_LIST,
1658
  ])
1659

    
1660
CONFD_REPL_STATUS_OK = 0
1661
CONFD_REPL_STATUS_ERROR = 1
1662
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1663

    
1664
CONFD_REPL_STATUSES = frozenset([
1665
  CONFD_REPL_STATUS_OK,
1666
  CONFD_REPL_STATUS_ERROR,
1667
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
1668
  ])
1669

    
1670
(CONFD_NODE_ROLE_MASTER,
1671
 CONFD_NODE_ROLE_CANDIDATE,
1672
 CONFD_NODE_ROLE_OFFLINE,
1673
 CONFD_NODE_ROLE_DRAINED,
1674
 CONFD_NODE_ROLE_REGULAR,
1675
 ) = range(5)
1676

    
1677
# A few common errors for confd
1678
CONFD_ERROR_UNKNOWN_ENTRY = 1
1679
CONFD_ERROR_INTERNAL = 2
1680
CONFD_ERROR_ARGUMENT = 3
1681

    
1682
# Each request is "salted" by the current timestamp.
1683
# This constants decides how many seconds of skew to accept.
1684
# TODO: make this a default and allow the value to be more configurable
1685
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1686

    
1687
# When we haven't reloaded the config for more than this amount of seconds, we
1688
# force a test to see if inotify is betraying us.
1689
CONFD_CONFIG_RELOAD_TIMEOUT = 60
1690

    
1691
# If we receive more than one update in this amount of seconds, we move to
1692
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
1693
# to serve more requests.
1694
CONFD_CONFIG_RELOAD_RATELIMIT = 2
1695

    
1696
# Magic number prepended to all confd queries.
1697
# This allows us to distinguish different types of confd protocols and handle
1698
# them. For example by changing this we can move the whole payload to be
1699
# compressed, or move away from json.
1700
CONFD_MAGIC_FOURCC = "plj0"
1701

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

    
1707
# Timeout in seconds to expire pending query request in the confd client
1708
# library. We don't actually expect any answer more than 10 seconds after we
1709
# sent a request.
1710
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1711

    
1712
# Maximum UDP datagram size.
1713
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1714
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1715
#   (assuming we can't use jumbo frames)
1716
# We just set this to 60K, which should be enough
1717
MAX_UDP_DATA_SIZE = 61440
1718

    
1719
# User-id pool minimum/maximum acceptable user-ids.
1720
UIDPOOL_UID_MIN = 0
1721
UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
1722

    
1723
# Name or path of the pgrep command
1724
PGREP = "pgrep"
1725

    
1726
# Name of the node group that gets created at cluster init or upgrade
1727
INITIAL_NODE_GROUP_NAME = "default"
1728

    
1729
# Possible values for NodeGroup.alloc_policy
1730
ALLOC_POLICY_PREFERRED = "preferred"
1731
ALLOC_POLICY_LAST_RESORT = "last_resort"
1732
ALLOC_POLICY_UNALLOCABLE = "unallocable"
1733
VALID_ALLOC_POLICIES = [
1734
  ALLOC_POLICY_PREFERRED,
1735
  ALLOC_POLICY_LAST_RESORT,
1736
  ALLOC_POLICY_UNALLOCABLE,
1737
  ]
1738

    
1739
# Temporary external/shared storage parameters
1740
BLOCKDEV_DRIVER_MANUAL = "manual"
1741

    
1742
# qemu-img path, required for ovfconverter
1743
QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
1744

    
1745
# Whether htools was enabled at compilation time
1746
HTOOLS = _autoconf.HTOOLS
1747
# The hail iallocator
1748
IALLOC_HAIL = "hail"
1749

    
1750
# Fake opcodes for functions that have hooks attached to them via
1751
# backend.RunLocalHooks
1752
FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
1753
FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
1754

    
1755
# Do not re-export imported modules
1756
del re, _vcsversion, _autoconf