Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 7e3c1da6

History | View | Annotate | Download (24.9 kB)

1
#
2
#
3

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

    
28
# various versions
29
PROTOCOL_VERSION = 30
30
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
31
OS_API_V10 = 10
32
OS_API_V15 = 15
33
OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15])
34
EXPORT_VERSION = 0
35
RAPI_VERSION = 2
36

    
37

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

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

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

55
  Returns: int representing version number
56

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

    
65

    
66
def SplitVersion(version):
67
  """Splits version number stored in an int.
68

69
  Returns: tuple; (major, minor, revision)
70

71
  """
72
  assert isinstance(version, int)
73

    
74
  (major, remainder) = divmod(version, 1000000)
75
  (minor, revision) = divmod(remainder, 10000)
76

    
77
  return (major, minor, revision)
78

    
79

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

    
85
# file paths
86
DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
87
RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
88
RUN_GANETI_DIR = RUN_DIR + "/ganeti"
89
BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
90
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
91
RUN_DIRS_MODE = 0755
92
SOCKET_DIR = RUN_GANETI_DIR + "/socket"
93
SECURE_DIR_MODE = 0700
94
SOCKET_DIR_MODE = SECURE_DIR_MODE
95
CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
96
CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE
97
IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
98
IMPORT_EXPORT_DIR_MODE = 0755
99
# keep RUN_GANETI_DIR first here, to make sure all get created when the node
100
# daemon is started (this takes care of RUN_DIR being tmpfs)
101
SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
102
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
103
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
104
# User-id pool lock directory
105
# The user-ids that are in use have a corresponding lock file in this directory
106
UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
107
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
108
NODED_CERT_FILE = DATA_DIR + "/server.pem"
109
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
110
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
111
CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
112
WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
113
WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
114
INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
115
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
116
RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
117
QUEUE_DIR = DATA_DIR + "/queue"
118
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
119
ETC_HOSTS = "/etc/hosts"
120
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
121
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
122
SYSCONFDIR = _autoconf.SYSCONFDIR
123
TOOLSDIR = _autoconf.TOOLSDIR
124
CONF_DIR = SYSCONFDIR + "/ganeti"
125

    
126
ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
127

    
128
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
129

    
130
NODED = "ganeti-noded"
131
CONFD = "ganeti-confd"
132
RAPI = "ganeti-rapi"
133
MASTERD = "ganeti-masterd"
134
# used in the ganeti-nbma project
135
NLD = "ganeti-nld"
136

    
137
DAEMONS_PORTS = {
138
  # daemon-name: ("proto", "default-port")
139
  NODED: ("tcp", 1811),
140
  CONFD: ("udp", 1814),
141
  RAPI: ("tcp", 5080),
142
  # used in the ganeti-nbma project
143
  NLD: ("udp", 1816),
144
}
145
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
146
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
147
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
148
# used in the ganeti-nbma project
149
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
150

    
151
FIRST_DRBD_PORT = 11000
152
LAST_DRBD_PORT = 14999
153
MASTER_SCRIPT = "ganeti-master"
154

    
155
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
156
DAEMONS_LOGFILES = {
157
  # "daemon-name": "logfile"
158
  NODED: LOG_DIR + "node-daemon.log",
159
  CONFD: LOG_DIR + "conf-daemon.log",
160
  RAPI: LOG_DIR + "rapi-daemon.log",
161
  MASTERD: LOG_DIR + "master-daemon.log",
162
  # used in the ganeti-nbma project
163
  NLD: LOG_DIR + "nl-daemon.log",
164
  }
165

    
166
LOG_OS_DIR = LOG_DIR + "os"
167
LOG_WATCHER = LOG_DIR + "watcher.log"
168
LOG_COMMANDS = LOG_DIR + "commands.log"
169
LOG_BURNIN = LOG_DIR + "burnin.log"
170

    
171
DEV_CONSOLE = "/dev/console"
172

    
173
# luxi related constants
174
LUXI_EOM = "\3"
175

    
176
# one of 'no', 'yes', 'only'
177
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
178
SYSLOG_NO = "no"
179
SYSLOG_YES = "yes"
180
SYSLOG_ONLY = "only"
181
SYSLOG_SOCKET = "/dev/log"
182

    
183
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
184
EXPORT_DIR = _autoconf.EXPORT_DIR
185

    
186
EXPORT_CONF_FILE = "config.ini"
187

    
188
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
189
XEN_KERNEL = _autoconf.XEN_KERNEL
190
XEN_INITRD = _autoconf.XEN_INITRD
191

    
192
KVM_PATH = _autoconf.KVM_PATH
193
SOCAT_PATH = _autoconf.SOCAT_PATH
194
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
195
SOCAT_ESCAPE_CODE = "0x1d"
196

    
197
# For RSA keys more bits are better, but they also make operations more
198
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
199
# 2010 on.
200
RSA_KEY_BITS = 2048
201

    
202
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
203
X509_CERT_SIGN_DIGEST = "SHA1"
204

    
205
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
206

    
207
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
208

    
209
# Import/export daemon mode
210
IEM_IMPORT = "import"
211
IEM_EXPORT = "export"
212

    
213
# Import/export transport compression
214
IEC_NONE = "none"
215
IEC_GZIP = "gzip"
216
IEC_ALL = frozenset([
217
  IEC_NONE,
218
  IEC_GZIP,
219
  ])
220

    
221
# Import/export I/O
222
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
223
IEIO_FILE = "file"
224
# Raw block device I/O using "dd"
225
IEIO_RAW_DISK = "raw"
226
# OS definition import/export script
227
IEIO_SCRIPT = "script"
228

    
229
VALUE_DEFAULT = "default"
230
VALUE_AUTO = "auto"
231
VALUE_GENERATE = "generate"
232
VALUE_NONE = "none"
233
VALUE_TRUE = "true"
234
VALUE_FALSE = "false"
235

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

    
239
# hooks-related constants
240
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
241
HOOKS_PHASE_PRE = "pre"
242
HOOKS_PHASE_POST = "post"
243
HOOKS_NAME_CFGUPDATE = "config-update"
244
HOOKS_NAME_WATCHER = "watcher"
245
HOOKS_VERSION = 2
246

    
247
# hooks subject type (what object type does the LU deal with)
248
HTYPE_CLUSTER = "CLUSTER"
249
HTYPE_NODE = "NODE"
250
HTYPE_INSTANCE = "INSTANCE"
251

    
252
HKR_SKIP = 0
253
HKR_FAIL = 1
254
HKR_SUCCESS = 2
255

    
256
# Storage types
257
ST_FILE = "file"
258
ST_LVM_PV = "lvm-pv"
259
ST_LVM_VG = "lvm-vg"
260

    
261
# Storage fields
262
# first two are valid in LU context only, not passed to backend
263
SF_NODE = "node"
264
SF_TYPE = "type"
265
# and the rest are valid in backend
266
SF_NAME = "name"
267
SF_SIZE = "size"
268
SF_FREE = "free"
269
SF_USED = "used"
270
SF_ALLOCATABLE = "allocatable"
271

    
272
# Storage operations
273
SO_FIX_CONSISTENCY = "fix-consistency"
274

    
275
# Available fields per storage type
276
VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
277
                                  SF_USED, SF_FREE, SF_ALLOCATABLE])
278

    
279
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
280

    
281
MODIFIABLE_STORAGE_FIELDS = {
282
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
283
  }
284

    
285
VALID_STORAGE_OPERATIONS = {
286
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
287
  }
288

    
289
# Local disk status
290
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
291
(LDS_OKAY,
292
 LDS_UNKNOWN,
293
 LDS_FAULTY) = range(1, 4)
294

    
295
# disk template types
296
DT_DISKLESS = "diskless"
297
DT_PLAIN = "plain"
298
DT_DRBD8 = "drbd"
299
DT_FILE = "file"
300

    
301
# the set of network-mirrored disk templates
302
DTS_NET_MIRROR = frozenset([DT_DRBD8])
303

    
304
# the set of non-lvm-based disk templates
305
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
306

    
307
# the set of disk templates which can be grown
308
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
309

    
310
# logical disk types
311
LD_LV = "lvm"
312
LD_DRBD8 = "drbd8"
313
LD_FILE = "file"
314
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
315

    
316
# drbd constants
317
DRBD_HMAC_ALG = "md5"
318
DRBD_NET_PROTOCOL = "C"
319
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
320

    
321
# file backend driver
322
FD_LOOP = "loop"
323
FD_BLKTAP = "blktap"
324

    
325
# the set of drbd-like disk types
326
LDS_DRBD = frozenset([LD_DRBD8])
327

    
328
# disk access mode
329
DISK_RDONLY = "ro"
330
DISK_RDWR = "rw"
331
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
332

    
333
# disk replacement mode
334
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
335
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
336
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
337
REPLACE_DISK_AUTO = "replace_auto"
338

    
339
# Instance export mode
340
EXPORT_MODE_LOCAL = "local"
341
EXPORT_MODE_REMOTE = "remote"
342
EXPORT_MODES = frozenset([
343
  EXPORT_MODE_LOCAL,
344
  EXPORT_MODE_REMOTE,
345
  ])
346

    
347
# lock recalculate mode
348
LOCKS_REPLACE = 'replace'
349
LOCKS_APPEND = 'append'
350

    
351
# instance creation modes
352
INSTANCE_CREATE = "create"
353
INSTANCE_IMPORT = "import"
354
INSTANCE_REMOTE_IMPORT = "remote-import"
355
INSTANCE_CREATE_MODES = frozenset([
356
  INSTANCE_CREATE,
357
  INSTANCE_IMPORT,
358
  INSTANCE_REMOTE_IMPORT,
359
  ])
360

    
361
# Remote import/export handshake message and version
362
RIE_VERSION = 0
363
RIE_HANDSHAKE = "Hi, I'm Ganeti"
364

    
365
# Remote import/export certificate validity in seconds
366
RIE_CERT_VALIDITY = 24 * 60 * 60
367

    
368
# Remote import/export connect timeout for socat
369
RIE_CONNECT_TIMEOUT = 60
370

    
371
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
372
                            DT_DRBD8, DT_FILE])
373

    
374
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
375

    
376
# import/export config options
377
INISECT_EXP = "export"
378
INISECT_INS = "instance"
379
INISECT_HYP = "hypervisor"
380
INISECT_BEP = "backend"
381

    
382
# dynamic device modification
383
DDM_ADD = 'add'
384
DDM_REMOVE = 'remove'
385

    
386
# common exit codes
387
EXIT_SUCCESS = 0
388
EXIT_FAILURE = 1
389
EXIT_NOTCLUSTER = 5
390
EXIT_NOTMASTER = 11
391
EXIT_NODESETUP_ERROR = 12
392
EXIT_CONFIRMATION = 13 # need user confirmation
393

    
394
# tags
395
TAG_CLUSTER = "cluster"
396
TAG_NODE = "node"
397
TAG_INSTANCE = "instance"
398
MAX_TAG_LEN = 128
399
MAX_TAGS_PER_OBJ = 4096
400

    
401
# others
402
DEFAULT_BRIDGE = "xen-br0"
403
SYNC_SPEED = 60 * 1024
404
LOCALHOST_IP_ADDRESS = "127.0.0.1"
405
TCP_PING_TIMEOUT = 10
406
GANETI_RUNAS = "root"
407
DEFAULT_VG = "xenvg"
408
BIND_ADDRESS_GLOBAL = "0.0.0.0"
409
MIN_VG_SIZE = 20480
410
DEFAULT_MAC_PREFIX = "aa:00:00"
411
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
412
# default maximum instance wait time, in seconds.
413
DEFAULT_SHUTDOWN_TIMEOUT = 120
414
NODE_MAX_CLOCK_SKEW = 150
415
# Time for an intra-cluster disk transfer to wait for a connection
416
DISK_TRANSFER_CONNECT_TIMEOUT = 30
417

    
418
# runparts results
419
(RUNPARTS_SKIP,
420
 RUNPARTS_RUN,
421
 RUNPARTS_ERR) = range(3)
422

    
423
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
424

    
425
# RPC constants
426
(RPC_ENCODING_NONE,
427
 RPC_ENCODING_ZLIB_BASE64) = range(2)
428

    
429
# os related constants
430
OS_SCRIPT_CREATE = 'create'
431
OS_SCRIPT_IMPORT = 'import'
432
OS_SCRIPT_EXPORT = 'export'
433
OS_SCRIPT_RENAME = 'rename'
434
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
435
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
436

    
437
OS_API_FILE = 'ganeti_api_version'
438
OS_VARIANTS_FILE = 'variants.list'
439

    
440
# ssh constants
441
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
442
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
443
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
444
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
445
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
446
SSH = "ssh"
447
SCP = "scp"
448

    
449
# reboot types
450
INSTANCE_REBOOT_SOFT = "soft"
451
INSTANCE_REBOOT_HARD = "hard"
452
INSTANCE_REBOOT_FULL = "full"
453

    
454
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
455
                          INSTANCE_REBOOT_HARD,
456
                          INSTANCE_REBOOT_FULL])
457

    
458
VTYPE_STRING = 'string'
459
VTYPE_BOOL = 'bool'
460
VTYPE_SIZE = 'size' # size, in MiBs
461
VTYPE_INT = 'int'
462
ENFORCEABLE_TYPES = frozenset([
463
                      VTYPE_STRING,
464
                      VTYPE_BOOL,
465
                      VTYPE_SIZE,
466
                      VTYPE_INT,
467
                      ])
468

    
469
# HV parameter names (global namespace)
470
HV_BOOT_ORDER = "boot_order"
471
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
472
HV_NIC_TYPE = "nic_type"
473
HV_DISK_TYPE = "disk_type"
474
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
475
HV_VNC_PASSWORD_FILE = "vnc_password_file"
476
HV_VNC_TLS = "vnc_tls"
477
HV_VNC_X509 = "vnc_x509_path"
478
HV_VNC_X509_VERIFY = "vnc_x509_verify"
479
HV_ACPI = "acpi"
480
HV_PAE = "pae"
481
HV_USE_BOOTLOADER = "use_bootloader"
482
HV_BOOTLOADER_ARGS = "bootloader_args"
483
HV_BOOTLOADER_PATH = "bootloader_path"
484
HV_KERNEL_ARGS = "kernel_args"
485
HV_KERNEL_PATH = "kernel_path"
486
HV_INITRD_PATH = "initrd_path"
487
HV_ROOT_PATH = "root_path"
488
HV_SERIAL_CONSOLE = "serial_console"
489
HV_USB_MOUSE = "usb_mouse"
490
HV_DEVICE_MODEL = "device_model"
491
HV_INIT_SCRIPT = "init_script"
492
HV_MIGRATION_PORT = "migration_port"
493
HV_USE_LOCALTIME = "use_localtime"
494
HV_DISK_CACHE = "disk_cache"
495
HV_SECURITY_MODEL = "security_model"
496
HV_SECURITY_DOMAIN = "security_domain"
497
HV_KVM_FLAG = "kvm_flag"
498
HV_VHOST_NET = "vhost_net"
499

    
500
HVS_PARAMETER_TYPES = {
501
  HV_BOOT_ORDER: VTYPE_STRING,
502
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
503
  HV_NIC_TYPE: VTYPE_STRING,
504
  HV_DISK_TYPE: VTYPE_STRING,
505
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
506
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
507
  HV_VNC_TLS: VTYPE_BOOL,
508
  HV_VNC_X509: VTYPE_STRING,
509
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
510
  HV_ACPI: VTYPE_BOOL,
511
  HV_PAE: VTYPE_BOOL,
512
  HV_USE_BOOTLOADER: VTYPE_BOOL,
513
  HV_BOOTLOADER_PATH: VTYPE_STRING,
514
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
515
  HV_KERNEL_PATH: VTYPE_STRING,
516
  HV_KERNEL_ARGS: VTYPE_STRING,
517
  HV_INITRD_PATH: VTYPE_STRING,
518
  HV_ROOT_PATH: VTYPE_STRING,
519
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
520
  HV_USB_MOUSE: VTYPE_STRING,
521
  HV_DEVICE_MODEL: VTYPE_STRING,
522
  HV_INIT_SCRIPT: VTYPE_STRING,
523
  HV_MIGRATION_PORT: VTYPE_INT,
524
  HV_USE_LOCALTIME: VTYPE_BOOL,
525
  HV_DISK_CACHE: VTYPE_STRING,
526
  HV_SECURITY_MODEL: VTYPE_STRING,
527
  HV_SECURITY_DOMAIN: VTYPE_STRING,
528
  HV_KVM_FLAG: VTYPE_STRING,
529
  HV_VHOST_NET: VTYPE_BOOL,
530
  }
531

    
532
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
533

    
534
# BE parameter names
535
BE_MEMORY = "memory"
536
BE_VCPUS = "vcpus"
537
BE_AUTO_BALANCE = "auto_balance"
538

    
539
BES_PARAMETER_TYPES = {
540
    BE_MEMORY: VTYPE_SIZE,
541
    BE_VCPUS: VTYPE_INT,
542
    BE_AUTO_BALANCE: VTYPE_BOOL,
543
    }
544

    
545
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
546

    
547
# Instance Parameters Profile
548
PP_DEFAULT = "default"
549

    
550
NIC_MODE = "mode"
551
NIC_LINK = "link"
552

    
553
NIC_MODE_BRIDGED = "bridged"
554
NIC_MODE_ROUTED = "routed"
555

    
556
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
557

    
558
NICS_PARAMETER_TYPES = {
559
    NIC_MODE: VTYPE_STRING,
560
    NIC_LINK: VTYPE_STRING,
561
    }
562

    
563
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
564

    
565
# Hypervisor constants
566
HT_XEN_PVM = "xen-pvm"
567
HT_FAKE = "fake"
568
HT_XEN_HVM = "xen-hvm"
569
HT_KVM = "kvm"
570
HT_CHROOT = "chroot"
571
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
572
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
573

    
574
VNC_BASE_PORT = 5900
575
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
576
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
577

    
578
# NIC types
579
HT_NIC_RTL8139 = "rtl8139"
580
HT_NIC_NE2K_PCI = "ne2k_pci"
581
HT_NIC_NE2K_ISA = "ne2k_isa"
582
HT_NIC_I82551 = "i82551"
583
HT_NIC_I85557B = "i82557b"
584
HT_NIC_I8259ER = "i82559er"
585
HT_NIC_PCNET = "pcnet"
586
HT_NIC_E1000 = "e1000"
587
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
588

    
589
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
590
                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
591
HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
592
                                    HT_NIC_NE2K_ISA, HT_NIC_I82551,
593
                                    HT_NIC_I85557B, HT_NIC_I8259ER,
594
                                    HT_NIC_PCNET, HT_NIC_E1000,
595
                                    HT_NIC_PARAVIRTUAL])
596
# Disk types
597
HT_DISK_IOEMU = "ioemu"
598
HT_DISK_IDE = "ide"
599
HT_DISK_SCSI = "scsi"
600
HT_DISK_SD = "sd"
601
HT_DISK_MTD = "mtd"
602
HT_DISK_PFLASH = "pflash"
603

    
604
HT_CACHE_DEFAULT = "default"
605
HT_CACHE_NONE = "none"
606
HT_CACHE_WTHROUGH = "writethrough"
607
HT_CACHE_WBACK = "writeback"
608
HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
609
                                  HT_CACHE_NONE,
610
                                  HT_CACHE_WTHROUGH,
611
                                  HT_CACHE_WBACK])
612

    
613
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
614
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
615
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
616
                                     HT_DISK_PFLASH])
617

    
618
# Mouse types:
619
HT_MOUSE_MOUSE = "mouse"
620
HT_MOUSE_TABLET = "tablet"
621

    
622
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
623

    
624
# Boot order
625
HT_BO_CDROM = "cdrom"
626
HT_BO_DISK = "disk"
627
HT_BO_NETWORK = "network"
628

    
629
HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
630

    
631
# Security models
632
HT_SM_NONE = "none"
633
HT_SM_USER = "user"
634
HT_SM_POOL = "pool"
635

    
636
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
637

    
638
# Kvm flag values
639
HT_KVM_ENABLED = "enabled"
640
HT_KVM_DISABLED = "disabled"
641

    
642
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
643

    
644
# Cluster Verify steps
645
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
646
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
647

    
648
# Node verify constants
649
NV_FILELIST = "filelist"
650
NV_HVINFO = "hvinfo"
651
NV_HYPERVISOR = "hypervisor"
652
NV_INSTANCELIST = "instancelist"
653
NV_NODELIST = "nodelist"
654
NV_NODENETTEST = "node-net-test"
655
NV_VERSION = "version"
656
NV_VGLIST = "vglist"
657
NV_LVLIST = "lvlist"
658
NV_PVLIST = "pvlist"
659
NV_DRBDLIST = "drbd-list"
660
NV_NODESETUP = "nodesetup"
661
NV_TIME = "time"
662
NV_MASTERIP = "master-ip"
663

    
664
# SSL certificate check constants (in days)
665
SSL_CERT_EXPIRATION_WARN = 30
666
SSL_CERT_EXPIRATION_ERROR = 7
667

    
668
# Allocator framework constants
669
IALLOCATOR_VERSION = 2
670
IALLOCATOR_DIR_IN = "in"
671
IALLOCATOR_DIR_OUT = "out"
672
IALLOCATOR_MODE_ALLOC = "allocate"
673
IALLOCATOR_MODE_RELOC = "relocate"
674
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
675
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
676

    
677
# Job queue
678
JOB_QUEUE_VERSION = 1
679
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
680
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
681
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
682
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
683
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
684
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
685
JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
686
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
687
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
688

    
689
JOB_ID_TEMPLATE = r"\d+"
690

    
691
# unchanged job return
692
JOB_NOTCHANGED = "nochange"
693

    
694
# Job status
695
JOB_STATUS_QUEUED = "queued"
696
JOB_STATUS_WAITLOCK = "waiting"
697
JOB_STATUS_CANCELING = "canceling"
698
JOB_STATUS_RUNNING = "running"
699
JOB_STATUS_CANCELED = "canceled"
700
JOB_STATUS_SUCCESS = "success"
701
JOB_STATUS_ERROR = "error"
702

    
703
# OpCode status
704
# not yet finalized
705
OP_STATUS_QUEUED = "queued"
706
OP_STATUS_WAITLOCK = "waiting"
707
OP_STATUS_CANCELING = "canceling"
708
OP_STATUS_RUNNING = "running"
709
# finalized
710
OP_STATUS_CANCELED = "canceled"
711
OP_STATUS_SUCCESS = "success"
712
OP_STATUS_ERROR = "error"
713
OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
714
                           OP_STATUS_SUCCESS,
715
                           OP_STATUS_ERROR])
716

    
717
# Execution log types
718
ELOG_MESSAGE = "message"
719
ELOG_PROGRESS = "progress"
720
ELOG_REMOTE_IMPORT = "remote-import"
721

    
722
# max dynamic devices
723
MAX_NICS = 8
724
MAX_DISKS = 16
725

    
726
# SSCONF keys
727
SS_CLUSTER_NAME = "cluster_name"
728
SS_CLUSTER_TAGS = "cluster_tags"
729
SS_FILE_STORAGE_DIR = "file_storage_dir"
730
SS_MASTER_CANDIDATES = "master_candidates"
731
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
732
SS_MASTER_IP = "master_ip"
733
SS_MASTER_NETDEV = "master_netdev"
734
SS_MASTER_NODE = "master_node"
735
SS_NODE_LIST = "node_list"
736
SS_NODE_PRIMARY_IPS = "node_primary_ips"
737
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
738
SS_OFFLINE_NODES = "offline_nodes"
739
SS_ONLINE_NODES = "online_nodes"
740
SS_INSTANCE_LIST = "instance_list"
741
SS_RELEASE_VERSION = "release_version"
742
SS_HYPERVISOR_LIST = "hypervisor_list"
743
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
744
SS_UID_POOL = "uid_pool"
745

    
746
# cluster wide default parameters
747
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
748

    
749
HVC_DEFAULTS = {
750
  HT_XEN_PVM: {
751
    HV_USE_BOOTLOADER: False,
752
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
753
    HV_BOOTLOADER_ARGS: '',
754
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
755
    HV_INITRD_PATH: '',
756
    HV_ROOT_PATH: '/dev/sda1',
757
    HV_KERNEL_ARGS: 'ro',
758
    HV_MIGRATION_PORT: 8002,
759
    },
760
  HT_XEN_HVM: {
761
    HV_BOOT_ORDER: "cd",
762
    HV_CDROM_IMAGE_PATH: '',
763
    HV_NIC_TYPE: HT_NIC_RTL8139,
764
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
765
    HV_VNC_BIND_ADDRESS: '0.0.0.0',
766
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
767
    HV_ACPI: True,
768
    HV_PAE: True,
769
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
770
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
771
    HV_MIGRATION_PORT: 8002,
772
    HV_USE_LOCALTIME: False,
773
    },
774
  HT_KVM: {
775
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
776
    HV_INITRD_PATH: '',
777
    HV_KERNEL_ARGS: 'ro',
778
    HV_ROOT_PATH: '/dev/vda1',
779
    HV_ACPI: True,
780
    HV_SERIAL_CONSOLE: True,
781
    HV_VNC_BIND_ADDRESS: '',
782
    HV_VNC_TLS: False,
783
    HV_VNC_X509: '',
784
    HV_VNC_X509_VERIFY: False,
785
    HV_VNC_PASSWORD_FILE: '',
786
    HV_CDROM_IMAGE_PATH: '',
787
    HV_BOOT_ORDER: HT_BO_DISK,
788
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
789
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
790
    HV_USB_MOUSE: '',
791
    HV_MIGRATION_PORT: 8102,
792
    HV_USE_LOCALTIME: False,
793
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
794
    HV_SECURITY_MODEL: HT_SM_NONE,
795
    HV_SECURITY_DOMAIN: '',
796
    HV_KVM_FLAG: "",
797
    HV_VHOST_NET: False,
798
    },
799
  HT_FAKE: {
800
    },
801
  HT_CHROOT: {
802
    HV_INIT_SCRIPT: "/ganeti-chroot",
803
    },
804
  }
805

    
806
HVC_GLOBALS = frozenset([
807
  HV_MIGRATION_PORT,
808
  ])
809

    
810
BEC_DEFAULTS = {
811
  BE_MEMORY: 128,
812
  BE_VCPUS: 1,
813
  BE_AUTO_BALANCE: True,
814
  }
815

    
816
NICC_DEFAULTS = {
817
  NIC_MODE: NIC_MODE_BRIDGED,
818
  NIC_LINK: DEFAULT_BRIDGE,
819
  }
820

    
821
MASTER_POOL_SIZE_DEFAULT = 10
822

    
823
CONFD_PROTOCOL_VERSION = 1
824

    
825
CONFD_REQ_PING = 0
826
CONFD_REQ_NODE_ROLE_BYNAME = 1
827
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
828
CONFD_REQ_CLUSTER_MASTER = 3
829
CONFD_REQ_NODE_PIP_LIST = 4
830
CONFD_REQ_MC_PIP_LIST = 5
831
CONFD_REQ_INSTANCES_IPS_LIST = 6
832

    
833
# Confd request query fields. These are used to narrow down queries.
834
# These must be strings rather than integers, because json-encoding
835
# converts them to strings anyway, as they're used as dict-keys.
836
CONFD_REQQ_LINK = "0"
837
CONFD_REQQ_IP = "1"
838
CONFD_REQQ_IPLIST = "2"
839
CONFD_REQQ_FIELDS = "3"
840

    
841
CONFD_REQFIELD_NAME = "0"
842
CONFD_REQFIELD_IP = "1"
843
CONFD_REQFIELD_MNODE_PIP = "2"
844

    
845
CONFD_REQS = frozenset([
846
  CONFD_REQ_PING,
847
  CONFD_REQ_NODE_ROLE_BYNAME,
848
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
849
  CONFD_REQ_CLUSTER_MASTER,
850
  CONFD_REQ_NODE_PIP_LIST,
851
  CONFD_REQ_MC_PIP_LIST,
852
  CONFD_REQ_INSTANCES_IPS_LIST,
853
  ])
854

    
855
CONFD_REPL_STATUS_OK = 0
856
CONFD_REPL_STATUS_ERROR = 1
857
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
858

    
859
CONFD_REPL_STATUSES = frozenset([
860
  CONFD_REPL_STATUS_OK,
861
  CONFD_REPL_STATUS_ERROR,
862
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
863
  ])
864

    
865
(CONFD_NODE_ROLE_MASTER,
866
 CONFD_NODE_ROLE_CANDIDATE,
867
 CONFD_NODE_ROLE_OFFLINE,
868
 CONFD_NODE_ROLE_DRAINED,
869
 CONFD_NODE_ROLE_REGULAR,
870
 ) = range(5)
871

    
872
# A few common errors for confd
873
CONFD_ERROR_UNKNOWN_ENTRY = 1
874
CONFD_ERROR_INTERNAL = 2
875
CONFD_ERROR_ARGUMENT = 3
876

    
877
# Each request is "salted" by the current timestamp.
878
# This constants decides how many seconds of skew to accept.
879
# TODO: make this a default and allow the value to be more configurable
880
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
881

    
882
# When we haven't reloaded the config for more than this amount of seconds, we
883
# force a test to see if inotify is betraying us.
884
CONFD_CONFIG_RELOAD_TIMEOUT = 60
885

    
886
# If we receive more than one update in this amount of seconds, we move to
887
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
888
# to serve more requests.
889
CONFD_CONFIG_RELOAD_RATELIMIT = 2
890

    
891
# Magic number prepended to all confd queries.
892
# This allows us to distinguish different types of confd protocols and handle
893
# them. For example by changing this we can move the whole payload to be
894
# compressed, or move away from json.
895
CONFD_MAGIC_FOURCC = 'plj0'
896

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

    
902
# Timeout in seconds to expire pending query request in the confd client
903
# library. We don't actually expect any answer more than 10 seconds after we
904
# sent a request.
905
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
906

    
907
# Maximum UDP datagram size.
908
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
909
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
910
#   (assuming we can't use jumbo frames)
911
# We just set this to 60K, which should be enough
912
MAX_UDP_DATA_SIZE = 61440
913

    
914
# User-id pool minimum/maximum acceptable user-ids.
915
UIDPOOL_UID_MIN = 0
916
UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
917

    
918
# Name or path of the pgrep command
919
PGREP = "pgrep"