Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 971bbd84

History | View | Annotate | Download (25.8 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
# user separation
86
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
87
MASTERD_USER = _autoconf.MASTERD_USER
88
RAPI_USER = _autoconf.RAPI_USER
89

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

    
131
ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
132

    
133
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
134

    
135
NODED = "ganeti-noded"
136
CONFD = "ganeti-confd"
137
RAPI = "ganeti-rapi"
138
MASTERD = "ganeti-masterd"
139
# used in the ganeti-nbma project
140
NLD = "ganeti-nld"
141

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

    
156
FIRST_DRBD_PORT = 11000
157
LAST_DRBD_PORT = 14999
158
MASTER_SCRIPT = "ganeti-master"
159

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

    
171
LOG_OS_DIR = LOG_DIR + "os"
172
LOG_WATCHER = LOG_DIR + "watcher.log"
173
LOG_COMMANDS = LOG_DIR + "commands.log"
174
LOG_BURNIN = LOG_DIR + "burnin.log"
175

    
176
DEV_CONSOLE = "/dev/console"
177

    
178
# luxi related constants
179
LUXI_EOM = "\3"
180

    
181
# one of 'no', 'yes', 'only'
182
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
183
SYSLOG_NO = "no"
184
SYSLOG_YES = "yes"
185
SYSLOG_ONLY = "only"
186
SYSLOG_SOCKET = "/dev/log"
187

    
188
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
189
EXPORT_DIR = _autoconf.EXPORT_DIR
190

    
191
EXPORT_CONF_FILE = "config.ini"
192

    
193
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
194
XEN_KERNEL = _autoconf.XEN_KERNEL
195
XEN_INITRD = _autoconf.XEN_INITRD
196

    
197
KVM_PATH = _autoconf.KVM_PATH
198
SOCAT_PATH = _autoconf.SOCAT_PATH
199
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
200
SOCAT_ESCAPE_CODE = "0x1d"
201

    
202
# For RSA keys more bits are better, but they also make operations more
203
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
204
# 2010 on.
205
RSA_KEY_BITS = 2048
206

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

    
215
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
216
X509_CERT_SIGN_DIGEST = "SHA1"
217

    
218
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
219

    
220
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
221

    
222
# Import/export daemon mode
223
IEM_IMPORT = "import"
224
IEM_EXPORT = "export"
225

    
226
# Import/export transport compression
227
IEC_NONE = "none"
228
IEC_GZIP = "gzip"
229
IEC_ALL = frozenset([
230
  IEC_NONE,
231
  IEC_GZIP,
232
  ])
233

    
234
IE_CUSTOM_SIZE = "fd"
235

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

    
238
# Import/export I/O
239
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
240
IEIO_FILE = "file"
241
# Raw block device I/O using "dd"
242
IEIO_RAW_DISK = "raw"
243
# OS definition import/export script
244
IEIO_SCRIPT = "script"
245

    
246
VALUE_DEFAULT = "default"
247
VALUE_AUTO = "auto"
248
VALUE_GENERATE = "generate"
249
VALUE_NONE = "none"
250
VALUE_TRUE = "true"
251
VALUE_FALSE = "false"
252

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

    
256
# hooks-related constants
257
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
258
HOOKS_PHASE_PRE = "pre"
259
HOOKS_PHASE_POST = "post"
260
HOOKS_NAME_CFGUPDATE = "config-update"
261
HOOKS_NAME_WATCHER = "watcher"
262
HOOKS_VERSION = 2
263

    
264
# hooks subject type (what object type does the LU deal with)
265
HTYPE_CLUSTER = "CLUSTER"
266
HTYPE_NODE = "NODE"
267
HTYPE_INSTANCE = "INSTANCE"
268

    
269
HKR_SKIP = 0
270
HKR_FAIL = 1
271
HKR_SUCCESS = 2
272

    
273
# Storage types
274
ST_FILE = "file"
275
ST_LVM_PV = "lvm-pv"
276
ST_LVM_VG = "lvm-vg"
277

    
278
# Storage fields
279
# first two are valid in LU context only, not passed to backend
280
SF_NODE = "node"
281
SF_TYPE = "type"
282
# and the rest are valid in backend
283
SF_NAME = "name"
284
SF_SIZE = "size"
285
SF_FREE = "free"
286
SF_USED = "used"
287
SF_ALLOCATABLE = "allocatable"
288

    
289
# Storage operations
290
SO_FIX_CONSISTENCY = "fix-consistency"
291

    
292
# Available fields per storage type
293
VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
294
                                  SF_USED, SF_FREE, SF_ALLOCATABLE])
295

    
296
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
297

    
298
MODIFIABLE_STORAGE_FIELDS = {
299
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
300
  }
301

    
302
VALID_STORAGE_OPERATIONS = {
303
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
304
  }
305

    
306
# Local disk status
307
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
308
(LDS_OKAY,
309
 LDS_UNKNOWN,
310
 LDS_FAULTY) = range(1, 4)
311

    
312
# disk template types
313
DT_DISKLESS = "diskless"
314
DT_PLAIN = "plain"
315
DT_DRBD8 = "drbd"
316
DT_FILE = "file"
317

    
318
# the set of network-mirrored disk templates
319
DTS_NET_MIRROR = frozenset([DT_DRBD8])
320

    
321
# the set of non-lvm-based disk templates
322
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
323

    
324
# the set of disk templates which can be grown
325
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
326

    
327
# logical disk types
328
LD_LV = "lvm"
329
LD_DRBD8 = "drbd8"
330
LD_FILE = "file"
331
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
332

    
333
# drbd constants
334
DRBD_HMAC_ALG = "md5"
335
DRBD_NET_PROTOCOL = "C"
336
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
337

    
338
# file backend driver
339
FD_LOOP = "loop"
340
FD_BLKTAP = "blktap"
341

    
342
# the set of drbd-like disk types
343
LDS_DRBD = frozenset([LD_DRBD8])
344

    
345
# disk access mode
346
DISK_RDONLY = "ro"
347
DISK_RDWR = "rw"
348
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
349

    
350
# disk replacement mode
351
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
352
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
353
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
354
REPLACE_DISK_AUTO = "replace_auto"
355

    
356
# Instance export mode
357
EXPORT_MODE_LOCAL = "local"
358
EXPORT_MODE_REMOTE = "remote"
359
EXPORT_MODES = frozenset([
360
  EXPORT_MODE_LOCAL,
361
  EXPORT_MODE_REMOTE,
362
  ])
363

    
364
# lock recalculate mode
365
LOCKS_REPLACE = 'replace'
366
LOCKS_APPEND = 'append'
367

    
368
# instance creation modes
369
INSTANCE_CREATE = "create"
370
INSTANCE_IMPORT = "import"
371
INSTANCE_REMOTE_IMPORT = "remote-import"
372
INSTANCE_CREATE_MODES = frozenset([
373
  INSTANCE_CREATE,
374
  INSTANCE_IMPORT,
375
  INSTANCE_REMOTE_IMPORT,
376
  ])
377

    
378
# Remote import/export handshake message and version
379
RIE_VERSION = 0
380
RIE_HANDSHAKE = "Hi, I'm Ganeti"
381

    
382
# Remote import/export certificate validity in seconds
383
RIE_CERT_VALIDITY = 24 * 60 * 60
384

    
385
# Remote import/export connect timeout for socat
386
RIE_CONNECT_TIMEOUT = 60
387

    
388
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
389
                            DT_DRBD8, DT_FILE])
390

    
391
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
392

    
393
# import/export config options
394
INISECT_EXP = "export"
395
INISECT_INS = "instance"
396
INISECT_HYP = "hypervisor"
397
INISECT_BEP = "backend"
398

    
399
# dynamic device modification
400
DDM_ADD = 'add'
401
DDM_REMOVE = 'remove'
402

    
403
# common exit codes
404
EXIT_SUCCESS = 0
405
EXIT_FAILURE = 1
406
EXIT_NOTCLUSTER = 5
407
EXIT_NOTMASTER = 11
408
EXIT_NODESETUP_ERROR = 12
409
EXIT_CONFIRMATION = 13 # need user confirmation
410

    
411
# tags
412
TAG_CLUSTER = "cluster"
413
TAG_NODE = "node"
414
TAG_INSTANCE = "instance"
415
MAX_TAG_LEN = 128
416
MAX_TAGS_PER_OBJ = 4096
417

    
418
# others
419
DEFAULT_BRIDGE = "xen-br0"
420
SYNC_SPEED = 60 * 1024
421
LOCALHOST_IP_ADDRESS = "127.0.0.1"
422
TCP_PING_TIMEOUT = 10
423
GANETI_RUNAS = "root"
424
DEFAULT_VG = "xenvg"
425
BIND_ADDRESS_GLOBAL = "0.0.0.0"
426
MIN_VG_SIZE = 20480
427
DEFAULT_MAC_PREFIX = "aa:00:00"
428
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
429
# default maximum instance wait time, in seconds.
430
DEFAULT_SHUTDOWN_TIMEOUT = 120
431
NODE_MAX_CLOCK_SKEW = 150
432
# Time for an intra-cluster disk transfer to wait for a connection
433
DISK_TRANSFER_CONNECT_TIMEOUT = 30
434

    
435
# runparts results
436
(RUNPARTS_SKIP,
437
 RUNPARTS_RUN,
438
 RUNPARTS_ERR) = range(3)
439

    
440
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
441

    
442
# RPC constants
443
(RPC_ENCODING_NONE,
444
 RPC_ENCODING_ZLIB_BASE64) = range(2)
445

    
446
# os related constants
447
OS_SCRIPT_CREATE = 'create'
448
OS_SCRIPT_IMPORT = 'import'
449
OS_SCRIPT_EXPORT = 'export'
450
OS_SCRIPT_RENAME = 'rename'
451
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
452
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
453

    
454
OS_API_FILE = 'ganeti_api_version'
455
OS_VARIANTS_FILE = 'variants.list'
456

    
457
# ssh constants
458
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
459
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
460
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
461
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
462
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
463
SSH = "ssh"
464
SCP = "scp"
465

    
466
# reboot types
467
INSTANCE_REBOOT_SOFT = "soft"
468
INSTANCE_REBOOT_HARD = "hard"
469
INSTANCE_REBOOT_FULL = "full"
470

    
471
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
472
                          INSTANCE_REBOOT_HARD,
473
                          INSTANCE_REBOOT_FULL])
474

    
475
VTYPE_STRING = 'string'
476
VTYPE_BOOL = 'bool'
477
VTYPE_SIZE = 'size' # size, in MiBs
478
VTYPE_INT = 'int'
479
ENFORCEABLE_TYPES = frozenset([
480
                      VTYPE_STRING,
481
                      VTYPE_BOOL,
482
                      VTYPE_SIZE,
483
                      VTYPE_INT,
484
                      ])
485

    
486
# HV parameter names (global namespace)
487
HV_BOOT_ORDER = "boot_order"
488
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
489
HV_NIC_TYPE = "nic_type"
490
HV_DISK_TYPE = "disk_type"
491
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
492
HV_VNC_PASSWORD_FILE = "vnc_password_file"
493
HV_VNC_TLS = "vnc_tls"
494
HV_VNC_X509 = "vnc_x509_path"
495
HV_VNC_X509_VERIFY = "vnc_x509_verify"
496
HV_ACPI = "acpi"
497
HV_PAE = "pae"
498
HV_USE_BOOTLOADER = "use_bootloader"
499
HV_BOOTLOADER_ARGS = "bootloader_args"
500
HV_BOOTLOADER_PATH = "bootloader_path"
501
HV_KERNEL_ARGS = "kernel_args"
502
HV_KERNEL_PATH = "kernel_path"
503
HV_INITRD_PATH = "initrd_path"
504
HV_ROOT_PATH = "root_path"
505
HV_SERIAL_CONSOLE = "serial_console"
506
HV_USB_MOUSE = "usb_mouse"
507
HV_DEVICE_MODEL = "device_model"
508
HV_INIT_SCRIPT = "init_script"
509
HV_MIGRATION_PORT = "migration_port"
510
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
511
HV_MIGRATION_DOWNTIME = "migration_downtime"
512
HV_USE_LOCALTIME = "use_localtime"
513
HV_DISK_CACHE = "disk_cache"
514
HV_SECURITY_MODEL = "security_model"
515
HV_SECURITY_DOMAIN = "security_domain"
516
HV_KVM_FLAG = "kvm_flag"
517
HV_VHOST_NET = "vhost_net"
518
HV_KVM_USE_CHROOT = "use_chroot"
519

    
520
HVS_PARAMETER_TYPES = {
521
  HV_BOOT_ORDER: VTYPE_STRING,
522
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
523
  HV_NIC_TYPE: VTYPE_STRING,
524
  HV_DISK_TYPE: VTYPE_STRING,
525
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
526
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
527
  HV_VNC_TLS: VTYPE_BOOL,
528
  HV_VNC_X509: VTYPE_STRING,
529
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
530
  HV_ACPI: VTYPE_BOOL,
531
  HV_PAE: VTYPE_BOOL,
532
  HV_USE_BOOTLOADER: VTYPE_BOOL,
533
  HV_BOOTLOADER_PATH: VTYPE_STRING,
534
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
535
  HV_KERNEL_PATH: VTYPE_STRING,
536
  HV_KERNEL_ARGS: VTYPE_STRING,
537
  HV_INITRD_PATH: VTYPE_STRING,
538
  HV_ROOT_PATH: VTYPE_STRING,
539
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
540
  HV_USB_MOUSE: VTYPE_STRING,
541
  HV_DEVICE_MODEL: VTYPE_STRING,
542
  HV_INIT_SCRIPT: VTYPE_STRING,
543
  HV_MIGRATION_PORT: VTYPE_INT,
544
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
545
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
546
  HV_USE_LOCALTIME: VTYPE_BOOL,
547
  HV_DISK_CACHE: VTYPE_STRING,
548
  HV_SECURITY_MODEL: VTYPE_STRING,
549
  HV_SECURITY_DOMAIN: VTYPE_STRING,
550
  HV_KVM_FLAG: VTYPE_STRING,
551
  HV_VHOST_NET: VTYPE_BOOL,
552
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
553
  }
554

    
555
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
556

    
557
# BE parameter names
558
BE_MEMORY = "memory"
559
BE_VCPUS = "vcpus"
560
BE_AUTO_BALANCE = "auto_balance"
561

    
562
BES_PARAMETER_TYPES = {
563
    BE_MEMORY: VTYPE_SIZE,
564
    BE_VCPUS: VTYPE_INT,
565
    BE_AUTO_BALANCE: VTYPE_BOOL,
566
    }
567

    
568
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
569

    
570
# Instance Parameters Profile
571
PP_DEFAULT = "default"
572

    
573
NIC_MODE = "mode"
574
NIC_LINK = "link"
575

    
576
NIC_MODE_BRIDGED = "bridged"
577
NIC_MODE_ROUTED = "routed"
578

    
579
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
580

    
581
NICS_PARAMETER_TYPES = {
582
    NIC_MODE: VTYPE_STRING,
583
    NIC_LINK: VTYPE_STRING,
584
    }
585

    
586
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
587

    
588
# Hypervisor constants
589
HT_XEN_PVM = "xen-pvm"
590
HT_FAKE = "fake"
591
HT_XEN_HVM = "xen-hvm"
592
HT_KVM = "kvm"
593
HT_CHROOT = "chroot"
594
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
595
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
596

    
597
VNC_BASE_PORT = 5900
598
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
599
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
600

    
601
# NIC types
602
HT_NIC_RTL8139 = "rtl8139"
603
HT_NIC_NE2K_PCI = "ne2k_pci"
604
HT_NIC_NE2K_ISA = "ne2k_isa"
605
HT_NIC_I82551 = "i82551"
606
HT_NIC_I85557B = "i82557b"
607
HT_NIC_I8259ER = "i82559er"
608
HT_NIC_PCNET = "pcnet"
609
HT_NIC_E1000 = "e1000"
610
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
611

    
612
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
613
                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
614
HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
615
                                    HT_NIC_NE2K_ISA, HT_NIC_I82551,
616
                                    HT_NIC_I85557B, HT_NIC_I8259ER,
617
                                    HT_NIC_PCNET, HT_NIC_E1000,
618
                                    HT_NIC_PARAVIRTUAL])
619
# Disk types
620
HT_DISK_IOEMU = "ioemu"
621
HT_DISK_IDE = "ide"
622
HT_DISK_SCSI = "scsi"
623
HT_DISK_SD = "sd"
624
HT_DISK_MTD = "mtd"
625
HT_DISK_PFLASH = "pflash"
626

    
627
HT_CACHE_DEFAULT = "default"
628
HT_CACHE_NONE = "none"
629
HT_CACHE_WTHROUGH = "writethrough"
630
HT_CACHE_WBACK = "writeback"
631
HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
632
                                  HT_CACHE_NONE,
633
                                  HT_CACHE_WTHROUGH,
634
                                  HT_CACHE_WBACK])
635

    
636
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
637
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
638
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
639
                                     HT_DISK_PFLASH])
640

    
641
# Mouse types:
642
HT_MOUSE_MOUSE = "mouse"
643
HT_MOUSE_TABLET = "tablet"
644

    
645
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
646

    
647
# Boot order
648
HT_BO_CDROM = "cdrom"
649
HT_BO_DISK = "disk"
650
HT_BO_NETWORK = "network"
651

    
652
HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
653

    
654
# Security models
655
HT_SM_NONE = "none"
656
HT_SM_USER = "user"
657
HT_SM_POOL = "pool"
658

    
659
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
660

    
661
# Kvm flag values
662
HT_KVM_ENABLED = "enabled"
663
HT_KVM_DISABLED = "disabled"
664

    
665
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
666

    
667
# Cluster Verify steps
668
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
669
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
670

    
671
# Node verify constants
672
NV_FILELIST = "filelist"
673
NV_HVINFO = "hvinfo"
674
NV_HYPERVISOR = "hypervisor"
675
NV_INSTANCELIST = "instancelist"
676
NV_NODELIST = "nodelist"
677
NV_NODENETTEST = "node-net-test"
678
NV_VERSION = "version"
679
NV_VGLIST = "vglist"
680
NV_LVLIST = "lvlist"
681
NV_PVLIST = "pvlist"
682
NV_DRBDLIST = "drbd-list"
683
NV_NODESETUP = "nodesetup"
684
NV_TIME = "time"
685
NV_MASTERIP = "master-ip"
686

    
687
# SSL certificate check constants (in days)
688
SSL_CERT_EXPIRATION_WARN = 30
689
SSL_CERT_EXPIRATION_ERROR = 7
690

    
691
# Allocator framework constants
692
IALLOCATOR_VERSION = 2
693
IALLOCATOR_DIR_IN = "in"
694
IALLOCATOR_DIR_OUT = "out"
695
IALLOCATOR_MODE_ALLOC = "allocate"
696
IALLOCATOR_MODE_RELOC = "relocate"
697
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
698
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
699

    
700
# Job queue
701
JOB_QUEUE_VERSION = 1
702
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
703
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
704
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
705
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
706
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
707
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
708
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
709
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
710

    
711
JOB_ID_TEMPLATE = r"\d+"
712

    
713
# unchanged job return
714
JOB_NOTCHANGED = "nochange"
715

    
716
# Job status
717
JOB_STATUS_QUEUED = "queued"
718
JOB_STATUS_WAITLOCK = "waiting"
719
JOB_STATUS_CANCELING = "canceling"
720
JOB_STATUS_RUNNING = "running"
721
JOB_STATUS_CANCELED = "canceled"
722
JOB_STATUS_SUCCESS = "success"
723
JOB_STATUS_ERROR = "error"
724

    
725
# OpCode status
726
# not yet finalized
727
OP_STATUS_QUEUED = "queued"
728
OP_STATUS_WAITLOCK = "waiting"
729
OP_STATUS_CANCELING = "canceling"
730
OP_STATUS_RUNNING = "running"
731
# finalized
732
OP_STATUS_CANCELED = "canceled"
733
OP_STATUS_SUCCESS = "success"
734
OP_STATUS_ERROR = "error"
735
OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
736
                           OP_STATUS_SUCCESS,
737
                           OP_STATUS_ERROR])
738

    
739
# Execution log types
740
ELOG_MESSAGE = "message"
741
ELOG_PROGRESS = "progress"
742
ELOG_REMOTE_IMPORT = "remote-import"
743

    
744
# max dynamic devices
745
MAX_NICS = 8
746
MAX_DISKS = 16
747

    
748
# SSCONF keys
749
SS_CLUSTER_NAME = "cluster_name"
750
SS_CLUSTER_TAGS = "cluster_tags"
751
SS_FILE_STORAGE_DIR = "file_storage_dir"
752
SS_MASTER_CANDIDATES = "master_candidates"
753
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
754
SS_MASTER_IP = "master_ip"
755
SS_MASTER_NETDEV = "master_netdev"
756
SS_MASTER_NODE = "master_node"
757
SS_NODE_LIST = "node_list"
758
SS_NODE_PRIMARY_IPS = "node_primary_ips"
759
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
760
SS_OFFLINE_NODES = "offline_nodes"
761
SS_ONLINE_NODES = "online_nodes"
762
SS_INSTANCE_LIST = "instance_list"
763
SS_RELEASE_VERSION = "release_version"
764
SS_HYPERVISOR_LIST = "hypervisor_list"
765
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
766
SS_UID_POOL = "uid_pool"
767

    
768
# cluster wide default parameters
769
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
770

    
771
HVC_DEFAULTS = {
772
  HT_XEN_PVM: {
773
    HV_USE_BOOTLOADER: False,
774
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
775
    HV_BOOTLOADER_ARGS: '',
776
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
777
    HV_INITRD_PATH: '',
778
    HV_ROOT_PATH: '/dev/sda1',
779
    HV_KERNEL_ARGS: 'ro',
780
    HV_MIGRATION_PORT: 8002,
781
    },
782
  HT_XEN_HVM: {
783
    HV_BOOT_ORDER: "cd",
784
    HV_CDROM_IMAGE_PATH: '',
785
    HV_NIC_TYPE: HT_NIC_RTL8139,
786
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
787
    HV_VNC_BIND_ADDRESS: '0.0.0.0',
788
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
789
    HV_ACPI: True,
790
    HV_PAE: True,
791
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
792
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
793
    HV_MIGRATION_PORT: 8002,
794
    HV_USE_LOCALTIME: False,
795
    },
796
  HT_KVM: {
797
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
798
    HV_INITRD_PATH: '',
799
    HV_KERNEL_ARGS: 'ro',
800
    HV_ROOT_PATH: '/dev/vda1',
801
    HV_ACPI: True,
802
    HV_SERIAL_CONSOLE: True,
803
    HV_VNC_BIND_ADDRESS: '',
804
    HV_VNC_TLS: False,
805
    HV_VNC_X509: '',
806
    HV_VNC_X509_VERIFY: False,
807
    HV_VNC_PASSWORD_FILE: '',
808
    HV_CDROM_IMAGE_PATH: '',
809
    HV_BOOT_ORDER: HT_BO_DISK,
810
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
811
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
812
    HV_USB_MOUSE: '',
813
    HV_MIGRATION_PORT: 8102,
814
    HV_MIGRATION_BANDWIDTH: 32, # MiB/s
815
    HV_MIGRATION_DOWNTIME: 30,  # ms
816
    HV_USE_LOCALTIME: False,
817
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
818
    HV_SECURITY_MODEL: HT_SM_NONE,
819
    HV_SECURITY_DOMAIN: '',
820
    HV_KVM_FLAG: "",
821
    HV_VHOST_NET: False,
822
    HV_KVM_USE_CHROOT: False,
823
    },
824
  HT_FAKE: {
825
    },
826
  HT_CHROOT: {
827
    HV_INIT_SCRIPT: "/ganeti-chroot",
828
    },
829
  }
830

    
831
HVC_GLOBALS = frozenset([
832
  HV_MIGRATION_PORT,
833
  HV_MIGRATION_BANDWIDTH,
834
  ])
835

    
836
BEC_DEFAULTS = {
837
  BE_MEMORY: 128,
838
  BE_VCPUS: 1,
839
  BE_AUTO_BALANCE: True,
840
  }
841

    
842
NICC_DEFAULTS = {
843
  NIC_MODE: NIC_MODE_BRIDGED,
844
  NIC_LINK: DEFAULT_BRIDGE,
845
  }
846

    
847
MASTER_POOL_SIZE_DEFAULT = 10
848

    
849
CONFD_PROTOCOL_VERSION = 1
850

    
851
CONFD_REQ_PING = 0
852
CONFD_REQ_NODE_ROLE_BYNAME = 1
853
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
854
CONFD_REQ_CLUSTER_MASTER = 3
855
CONFD_REQ_NODE_PIP_LIST = 4
856
CONFD_REQ_MC_PIP_LIST = 5
857
CONFD_REQ_INSTANCES_IPS_LIST = 6
858

    
859
# Confd request query fields. These are used to narrow down queries.
860
# These must be strings rather than integers, because json-encoding
861
# converts them to strings anyway, as they're used as dict-keys.
862
CONFD_REQQ_LINK = "0"
863
CONFD_REQQ_IP = "1"
864
CONFD_REQQ_IPLIST = "2"
865
CONFD_REQQ_FIELDS = "3"
866

    
867
CONFD_REQFIELD_NAME = "0"
868
CONFD_REQFIELD_IP = "1"
869
CONFD_REQFIELD_MNODE_PIP = "2"
870

    
871
CONFD_REQS = frozenset([
872
  CONFD_REQ_PING,
873
  CONFD_REQ_NODE_ROLE_BYNAME,
874
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
875
  CONFD_REQ_CLUSTER_MASTER,
876
  CONFD_REQ_NODE_PIP_LIST,
877
  CONFD_REQ_MC_PIP_LIST,
878
  CONFD_REQ_INSTANCES_IPS_LIST,
879
  ])
880

    
881
CONFD_REPL_STATUS_OK = 0
882
CONFD_REPL_STATUS_ERROR = 1
883
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
884

    
885
CONFD_REPL_STATUSES = frozenset([
886
  CONFD_REPL_STATUS_OK,
887
  CONFD_REPL_STATUS_ERROR,
888
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
889
  ])
890

    
891
(CONFD_NODE_ROLE_MASTER,
892
 CONFD_NODE_ROLE_CANDIDATE,
893
 CONFD_NODE_ROLE_OFFLINE,
894
 CONFD_NODE_ROLE_DRAINED,
895
 CONFD_NODE_ROLE_REGULAR,
896
 ) = range(5)
897

    
898
# A few common errors for confd
899
CONFD_ERROR_UNKNOWN_ENTRY = 1
900
CONFD_ERROR_INTERNAL = 2
901
CONFD_ERROR_ARGUMENT = 3
902

    
903
# Each request is "salted" by the current timestamp.
904
# This constants decides how many seconds of skew to accept.
905
# TODO: make this a default and allow the value to be more configurable
906
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
907

    
908
# When we haven't reloaded the config for more than this amount of seconds, we
909
# force a test to see if inotify is betraying us.
910
CONFD_CONFIG_RELOAD_TIMEOUT = 60
911

    
912
# If we receive more than one update in this amount of seconds, we move to
913
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
914
# to serve more requests.
915
CONFD_CONFIG_RELOAD_RATELIMIT = 2
916

    
917
# Magic number prepended to all confd queries.
918
# This allows us to distinguish different types of confd protocols and handle
919
# them. For example by changing this we can move the whole payload to be
920
# compressed, or move away from json.
921
CONFD_MAGIC_FOURCC = 'plj0'
922

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

    
928
# Timeout in seconds to expire pending query request in the confd client
929
# library. We don't actually expect any answer more than 10 seconds after we
930
# sent a request.
931
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
932

    
933
# Maximum UDP datagram size.
934
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
935
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
936
#   (assuming we can't use jumbo frames)
937
# We just set this to 60K, which should be enough
938
MAX_UDP_DATA_SIZE = 61440
939

    
940
# User-id pool minimum/maximum acceptable user-ids.
941
UIDPOOL_UID_MIN = 0
942
UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
943

    
944
# Name or path of the pgrep command
945
PGREP = "pgrep"