Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 1afea34a

History | View | Annotate | Download (24.2 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
# keep RUN_GANETI_DIR first here, to make sure all get created when the node
96
# daemon is started (this takes care of RUN_DIR being tmpfs)
97
SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
98
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
99
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
100
# User-id pool lock directory
101
# The user-ids that are in use have a corresponding lock file in this directory
102
UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
103
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
104
NODED_CERT_FILE = DATA_DIR + "/server.pem"
105
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
106
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
107
WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
108
WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
109
INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
110
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
111
RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
112
QUEUE_DIR = DATA_DIR + "/queue"
113
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
114
ETC_HOSTS = "/etc/hosts"
115
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
116
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
117
SYSCONFDIR = _autoconf.SYSCONFDIR
118
TOOLSDIR = _autoconf.TOOLSDIR
119
CONF_DIR = SYSCONFDIR + "/ganeti"
120

    
121
ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
122

    
123
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
124

    
125
NODED = "ganeti-noded"
126
CONFD = "ganeti-confd"
127
RAPI = "ganeti-rapi"
128
MASTERD = "ganeti-masterd"
129
# used in the ganeti-nbma project
130
NLD = "ganeti-nld"
131

    
132
MULTITHREADED_DAEMONS = frozenset([MASTERD])
133

    
134
DAEMONS_SSL = {
135
  # daemon-name: (default-cert-path, default-key-path)
136
  NODED: (NODED_CERT_FILE, NODED_CERT_FILE),
137
  RAPI: (RAPI_CERT_FILE, RAPI_CERT_FILE),
138
}
139

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

    
154
FIRST_DRBD_PORT = 11000
155
LAST_DRBD_PORT = 14999
156
MASTER_SCRIPT = "ganeti-master"
157

    
158
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
159
DAEMONS_LOGFILES = {
160
  # "daemon-name": "logfile"
161
  NODED: LOG_DIR + "node-daemon.log",
162
  CONFD: LOG_DIR + "conf-daemon.log",
163
  RAPI: LOG_DIR + "rapi-daemon.log",
164
  MASTERD: LOG_DIR + "master-daemon.log",
165
  # used in the ganeti-nbma project
166
  NLD: LOG_DIR + "nl-daemon.log",
167
  }
168
LOG_OS_DIR = LOG_DIR + "os"
169
LOG_WATCHER = LOG_DIR + "watcher.log"
170
LOG_COMMANDS = LOG_DIR + "commands.log"
171
LOG_BURNIN = LOG_DIR + "burnin.log"
172

    
173
DEV_CONSOLE = "/dev/console"
174

    
175
# luxi related constants
176
LUXI_EOM = "\3"
177

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

    
185
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
186
EXPORT_DIR = _autoconf.EXPORT_DIR
187

    
188
EXPORT_CONF_FILE = "config.ini"
189

    
190
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
191
XEN_KERNEL = _autoconf.XEN_KERNEL
192
XEN_INITRD = _autoconf.XEN_INITRD
193

    
194
KVM_PATH = _autoconf.KVM_PATH
195
SOCAT_PATH = _autoconf.SOCAT_PATH
196
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
197
SOCAT_ESCAPE_CODE = "0x1d"
198

    
199
VALUE_DEFAULT = "default"
200
VALUE_AUTO = "auto"
201
VALUE_GENERATE = "generate"
202
VALUE_NONE = "none"
203
VALUE_TRUE = "true"
204
VALUE_FALSE = "false"
205

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

    
209
# hooks-related constants
210
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
211
HOOKS_PHASE_PRE = "pre"
212
HOOKS_PHASE_POST = "post"
213
HOOKS_NAME_CFGUPDATE = "config-update"
214
HOOKS_NAME_WATCHER = "watcher"
215
HOOKS_VERSION = 2
216

    
217
# hooks subject type (what object type does the LU deal with)
218
HTYPE_CLUSTER = "CLUSTER"
219
HTYPE_NODE = "NODE"
220
HTYPE_INSTANCE = "INSTANCE"
221

    
222
HKR_SKIP = 0
223
HKR_FAIL = 1
224
HKR_SUCCESS = 2
225

    
226
# Storage types
227
ST_FILE = "file"
228
ST_LVM_PV = "lvm-pv"
229
ST_LVM_VG = "lvm-vg"
230

    
231
# Storage fields
232
# first two are valid in LU context only, not passed to backend
233
SF_NODE = "node"
234
SF_TYPE = "type"
235
# and the rest are valid in backend
236
SF_NAME = "name"
237
SF_SIZE = "size"
238
SF_FREE = "free"
239
SF_USED = "used"
240
SF_ALLOCATABLE = "allocatable"
241

    
242
# Storage operations
243
SO_FIX_CONSISTENCY = "fix-consistency"
244

    
245
# Available fields per storage type
246
VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
247
                                  SF_USED, SF_FREE, SF_ALLOCATABLE])
248

    
249
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
250

    
251
MODIFIABLE_STORAGE_FIELDS = {
252
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
253
  }
254

    
255
VALID_STORAGE_OPERATIONS = {
256
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
257
  }
258

    
259
# Local disk status
260
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
261
(LDS_OKAY,
262
 LDS_UNKNOWN,
263
 LDS_FAULTY) = range(1, 4)
264

    
265
# disk template types
266
DT_DISKLESS = "diskless"
267
DT_PLAIN = "plain"
268
DT_DRBD8 = "drbd"
269
DT_FILE = "file"
270

    
271
# the set of network-mirrored disk templates
272
DTS_NET_MIRROR = frozenset([DT_DRBD8])
273

    
274
# the set of non-lvm-based disk templates
275
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
276

    
277
# the set of disk templates which can be grown
278
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
279

    
280
# logical disk types
281
LD_LV = "lvm"
282
LD_DRBD8 = "drbd8"
283
LD_FILE = "file"
284
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
285

    
286
# drbd constants
287
DRBD_HMAC_ALG = "md5"
288
DRBD_NET_PROTOCOL = "C"
289
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
290

    
291
# file backend driver
292
FD_LOOP = "loop"
293
FD_BLKTAP = "blktap"
294

    
295
# the set of drbd-like disk types
296
LDS_DRBD = frozenset([LD_DRBD8])
297

    
298
# disk access mode
299
DISK_RDONLY = "ro"
300
DISK_RDWR = "rw"
301
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
302

    
303
# disk replacement mode
304
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
305
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
306
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
307
REPLACE_DISK_AUTO = "replace_auto"
308

    
309
# lock recalculate mode
310
LOCKS_REPLACE = 'replace'
311
LOCKS_APPEND = 'append'
312

    
313
# instance creation modes
314
INSTANCE_CREATE = "create"
315
INSTANCE_IMPORT = "import"
316

    
317
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
318
                            DT_DRBD8, DT_FILE])
319

    
320
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
321

    
322
# import/export config options
323
INISECT_EXP = "export"
324
INISECT_INS = "instance"
325
INISECT_HYP = "hypervisor"
326
INISECT_BEP = "backend"
327

    
328
# dynamic device modification
329
DDM_ADD = 'add'
330
DDM_REMOVE = 'remove'
331

    
332
# common exit codes
333
EXIT_SUCCESS = 0
334
EXIT_FAILURE = 1
335
EXIT_NOTCLUSTER = 5
336
EXIT_NOTMASTER = 11
337
EXIT_NODESETUP_ERROR = 12
338
EXIT_CONFIRMATION = 13 # need user confirmation
339

    
340
# tags
341
TAG_CLUSTER = "cluster"
342
TAG_NODE = "node"
343
TAG_INSTANCE = "instance"
344
MAX_TAG_LEN = 128
345
MAX_TAGS_PER_OBJ = 4096
346

    
347
# others
348
DEFAULT_BRIDGE = "xen-br0"
349
SYNC_SPEED = 60 * 1024
350
LOCALHOST_IP_ADDRESS = "127.0.0.1"
351
TCP_PING_TIMEOUT = 10
352
GANETI_RUNAS = "root"
353
DEFAULT_VG = "xenvg"
354
BIND_ADDRESS_GLOBAL = "0.0.0.0"
355
MIN_VG_SIZE = 20480
356
DEFAULT_MAC_PREFIX = "aa:00:00"
357
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
358
# default maximum instance wait time, in seconds.
359
DEFAULT_SHUTDOWN_TIMEOUT = 120
360
NODE_MAX_CLOCK_SKEW = 150
361

    
362
# runparts results
363
(RUNPARTS_SKIP,
364
 RUNPARTS_RUN,
365
 RUNPARTS_ERR) = range(3)
366

    
367
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
368

    
369
# RPC constants
370
(RPC_ENCODING_NONE,
371
 RPC_ENCODING_ZLIB_BASE64) = range(2)
372

    
373
# os related constants
374
OS_SCRIPT_CREATE = 'create'
375
OS_SCRIPT_IMPORT = 'import'
376
OS_SCRIPT_EXPORT = 'export'
377
OS_SCRIPT_RENAME = 'rename'
378
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
379
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
380

    
381
OS_API_FILE = 'ganeti_api_version'
382
OS_VARIANTS_FILE = 'variants.list'
383

    
384
# ssh constants
385
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
386
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
387
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
388
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
389
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
390
SSH = "ssh"
391
SCP = "scp"
392

    
393
# reboot types
394
INSTANCE_REBOOT_SOFT = "soft"
395
INSTANCE_REBOOT_HARD = "hard"
396
INSTANCE_REBOOT_FULL = "full"
397

    
398
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
399
                          INSTANCE_REBOOT_HARD,
400
                          INSTANCE_REBOOT_FULL])
401

    
402
VTYPE_STRING = 'string'
403
VTYPE_BOOL = 'bool'
404
VTYPE_SIZE = 'size' # size, in MiBs
405
VTYPE_INT = 'int'
406
ENFORCEABLE_TYPES = frozenset([
407
                      VTYPE_STRING,
408
                      VTYPE_BOOL,
409
                      VTYPE_SIZE,
410
                      VTYPE_INT,
411
                      ])
412

    
413
# HV parameter names (global namespace)
414
HV_BOOT_ORDER = "boot_order"
415
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
416
HV_NIC_TYPE = "nic_type"
417
HV_DISK_TYPE = "disk_type"
418
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
419
HV_VNC_PASSWORD_FILE = "vnc_password_file"
420
HV_VNC_TLS = "vnc_tls"
421
HV_VNC_X509 = "vnc_x509_path"
422
HV_VNC_X509_VERIFY = "vnc_x509_verify"
423
HV_ACPI = "acpi"
424
HV_PAE = "pae"
425
HV_USE_BOOTLOADER = "use_bootloader"
426
HV_BOOTLOADER_ARGS = "bootloader_args"
427
HV_BOOTLOADER_PATH = "bootloader_path"
428
HV_KERNEL_ARGS = "kernel_args"
429
HV_KERNEL_PATH = "kernel_path"
430
HV_INITRD_PATH = "initrd_path"
431
HV_ROOT_PATH = "root_path"
432
HV_SERIAL_CONSOLE = "serial_console"
433
HV_USB_MOUSE = "usb_mouse"
434
HV_DEVICE_MODEL = "device_model"
435
HV_INIT_SCRIPT = "init_script"
436
HV_MIGRATION_PORT = "migration_port"
437
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
438
HV_MIGRATION_DOWNTIME = "migration_downtime"
439
HV_USE_LOCALTIME = "use_localtime"
440
HV_DISK_CACHE = "disk_cache"
441
HV_SECURITY_MODEL = "security_model"
442
HV_SECURITY_DOMAIN = "security_domain"
443
HV_KVM_FLAG = "kvm_flag"
444
HV_VHOST_NET = "vhost_net"
445
HV_KVM_USE_CHROOT = "use_chroot"
446

    
447
HVS_PARAMETER_TYPES = {
448
  HV_BOOT_ORDER: VTYPE_STRING,
449
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
450
  HV_NIC_TYPE: VTYPE_STRING,
451
  HV_DISK_TYPE: VTYPE_STRING,
452
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
453
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
454
  HV_VNC_TLS: VTYPE_BOOL,
455
  HV_VNC_X509: VTYPE_STRING,
456
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
457
  HV_ACPI: VTYPE_BOOL,
458
  HV_PAE: VTYPE_BOOL,
459
  HV_USE_BOOTLOADER: VTYPE_BOOL,
460
  HV_BOOTLOADER_PATH: VTYPE_STRING,
461
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
462
  HV_KERNEL_PATH: VTYPE_STRING,
463
  HV_KERNEL_ARGS: VTYPE_STRING,
464
  HV_INITRD_PATH: VTYPE_STRING,
465
  HV_ROOT_PATH: VTYPE_STRING,
466
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
467
  HV_USB_MOUSE: VTYPE_STRING,
468
  HV_DEVICE_MODEL: VTYPE_STRING,
469
  HV_INIT_SCRIPT: VTYPE_STRING,
470
  HV_MIGRATION_PORT: VTYPE_INT,
471
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
472
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
473
  HV_USE_LOCALTIME: VTYPE_BOOL,
474
  HV_DISK_CACHE: VTYPE_STRING,
475
  HV_SECURITY_MODEL: VTYPE_STRING,
476
  HV_SECURITY_DOMAIN: VTYPE_STRING,
477
  HV_KVM_FLAG: VTYPE_STRING,
478
  HV_VHOST_NET: VTYPE_BOOL,
479
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
480
  }
481

    
482
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
483

    
484
# BE parameter names
485
BE_MEMORY = "memory"
486
BE_VCPUS = "vcpus"
487
BE_AUTO_BALANCE = "auto_balance"
488

    
489
BES_PARAMETER_TYPES = {
490
    BE_MEMORY: VTYPE_SIZE,
491
    BE_VCPUS: VTYPE_INT,
492
    BE_AUTO_BALANCE: VTYPE_BOOL,
493
    }
494

    
495
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
496

    
497
# Instance Parameters Profile
498
PP_DEFAULT = "default"
499

    
500
NIC_MODE = "mode"
501
NIC_LINK = "link"
502

    
503
NIC_MODE_BRIDGED = "bridged"
504
NIC_MODE_ROUTED = "routed"
505

    
506
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
507

    
508
NICS_PARAMETER_TYPES = {
509
    NIC_MODE: VTYPE_STRING,
510
    NIC_LINK: VTYPE_STRING,
511
    }
512

    
513
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
514

    
515
IDISK_SIZE = "size"
516
IDISK_MODE = "mode"
517
IDISK_ADOPT = "adopt"
518
IDISK_PARAMS = frozenset([IDISK_SIZE, IDISK_MODE, IDISK_ADOPT])
519
IDISK_PARAMS_TYPES = {
520
  IDISK_SIZE: VTYPE_SIZE,
521
  IDISK_MODE: VTYPE_STRING,
522
  IDISK_ADOPT: VTYPE_STRING,
523
  }
524
INIC_MAC = "mac"
525
INIC_IP = "ip"
526
INIC_MODE = "mode"
527
INIC_LINK = "link"
528
INIC_BRIDGE = "bridge"
529
INIC_PARAMS = frozenset([INIC_MAC, INIC_IP, INIC_MODE, INIC_LINK, INIC_BRIDGE])
530
INIC_PARAMS_TYPES = dict([(name, VTYPE_STRING) for name in INIC_PARAMS])
531

    
532
# Hypervisor constants
533
HT_XEN_PVM = "xen-pvm"
534
HT_FAKE = "fake"
535
HT_XEN_HVM = "xen-hvm"
536
HT_KVM = "kvm"
537
HT_CHROOT = "chroot"
538
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
539
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
540

    
541
VNC_BASE_PORT = 5900
542
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
543
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
544

    
545
# NIC types
546
HT_NIC_RTL8139 = "rtl8139"
547
HT_NIC_NE2K_PCI = "ne2k_pci"
548
HT_NIC_NE2K_ISA = "ne2k_isa"
549
HT_NIC_I82551 = "i82551"
550
HT_NIC_I85557B = "i82557b"
551
HT_NIC_I8259ER = "i82559er"
552
HT_NIC_PCNET = "pcnet"
553
HT_NIC_E1000 = "e1000"
554
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
555

    
556
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
557
                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
558
HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
559
                                    HT_NIC_NE2K_ISA, HT_NIC_I82551,
560
                                    HT_NIC_I85557B, HT_NIC_I8259ER,
561
                                    HT_NIC_PCNET, HT_NIC_E1000,
562
                                    HT_NIC_PARAVIRTUAL])
563
# Disk types
564
HT_DISK_IOEMU = "ioemu"
565
HT_DISK_IDE = "ide"
566
HT_DISK_SCSI = "scsi"
567
HT_DISK_SD = "sd"
568
HT_DISK_MTD = "mtd"
569
HT_DISK_PFLASH = "pflash"
570

    
571
HT_CACHE_DEFAULT = "default"
572
HT_CACHE_NONE = "none"
573
HT_CACHE_WTHROUGH = "writethrough"
574
HT_CACHE_WBACK = "writeback"
575
HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
576
                                  HT_CACHE_NONE,
577
                                  HT_CACHE_WTHROUGH,
578
                                  HT_CACHE_WBACK])
579

    
580
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
581
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
582
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
583
                                     HT_DISK_PFLASH])
584

    
585
# Mouse types:
586
HT_MOUSE_MOUSE = "mouse"
587
HT_MOUSE_TABLET = "tablet"
588

    
589
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
590

    
591
# Boot order
592
HT_BO_CDROM = "cdrom"
593
HT_BO_DISK = "disk"
594
HT_BO_NETWORK = "network"
595

    
596
HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
597

    
598
# Security models
599
HT_SM_NONE = "none"
600
HT_SM_USER = "user"
601
HT_SM_POOL = "pool"
602

    
603
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
604

    
605
# Kvm flag values
606
HT_KVM_ENABLED = "enabled"
607
HT_KVM_DISABLED = "disabled"
608

    
609
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
610

    
611
# Cluster Verify steps
612
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
613
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
614

    
615
# Node verify constants
616
NV_FILELIST = "filelist"
617
NV_HVINFO = "hvinfo"
618
NV_HYPERVISOR = "hypervisor"
619
NV_INSTANCELIST = "instancelist"
620
NV_NODELIST = "nodelist"
621
NV_NODENETTEST = "node-net-test"
622
NV_VERSION = "version"
623
NV_VGLIST = "vglist"
624
NV_LVLIST = "lvlist"
625
NV_PVLIST = "pvlist"
626
NV_DRBDLIST = "drbd-list"
627
NV_NODESETUP = "nodesetup"
628
NV_TIME = "time"
629
NV_MASTERIP = "master-ip"
630

    
631
# SSL certificate check constants (in days)
632
SSL_CERT_EXPIRATION_WARN = 30
633
SSL_CERT_EXPIRATION_ERROR = 7
634

    
635
# Allocator framework constants
636
IALLOCATOR_VERSION = 2
637
IALLOCATOR_DIR_IN = "in"
638
IALLOCATOR_DIR_OUT = "out"
639
IALLOCATOR_MODE_ALLOC = "allocate"
640
IALLOCATOR_MODE_RELOC = "relocate"
641
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
642
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
643

    
644
# Job queue
645
JOB_QUEUE_VERSION = 1
646
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
647
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
648
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
649
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
650
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
651
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
652
JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
653
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
654
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
655

    
656
JOB_ID_TEMPLATE = r"\d+"
657

    
658
# unchanged job return
659
JOB_NOTCHANGED = "nochange"
660

    
661
# Job status
662
JOB_STATUS_QUEUED = "queued"
663
JOB_STATUS_WAITLOCK = "waiting"
664
JOB_STATUS_CANCELING = "canceling"
665
JOB_STATUS_RUNNING = "running"
666
JOB_STATUS_CANCELED = "canceled"
667
JOB_STATUS_SUCCESS = "success"
668
JOB_STATUS_ERROR = "error"
669

    
670
# OpCode status
671
# not yet finalized
672
OP_STATUS_QUEUED = "queued"
673
OP_STATUS_WAITLOCK = "waiting"
674
OP_STATUS_CANCELING = "canceling"
675
OP_STATUS_RUNNING = "running"
676
# finalized
677
OP_STATUS_CANCELED = "canceled"
678
OP_STATUS_SUCCESS = "success"
679
OP_STATUS_ERROR = "error"
680
OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
681
                           OP_STATUS_SUCCESS,
682
                           OP_STATUS_ERROR])
683

    
684
# Execution log types
685
ELOG_MESSAGE = "message"
686
ELOG_PROGRESS = "progress"
687

    
688
# max dynamic devices
689
MAX_NICS = 8
690
MAX_DISKS = 16
691

    
692
# SSCONF keys
693
SS_CLUSTER_NAME = "cluster_name"
694
SS_CLUSTER_TAGS = "cluster_tags"
695
SS_FILE_STORAGE_DIR = "file_storage_dir"
696
SS_MASTER_CANDIDATES = "master_candidates"
697
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
698
SS_MASTER_IP = "master_ip"
699
SS_MASTER_NETDEV = "master_netdev"
700
SS_MASTER_NODE = "master_node"
701
SS_NODE_LIST = "node_list"
702
SS_NODE_PRIMARY_IPS = "node_primary_ips"
703
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
704
SS_OFFLINE_NODES = "offline_nodes"
705
SS_ONLINE_NODES = "online_nodes"
706
SS_INSTANCE_LIST = "instance_list"
707
SS_RELEASE_VERSION = "release_version"
708
SS_HYPERVISOR_LIST = "hypervisor_list"
709
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
710
SS_UID_POOL = "uid_pool"
711

    
712
# cluster wide default parameters
713
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
714

    
715
HVC_DEFAULTS = {
716
  HT_XEN_PVM: {
717
    HV_USE_BOOTLOADER: False,
718
    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
719
    HV_BOOTLOADER_ARGS: '',
720
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
721
    HV_INITRD_PATH: '',
722
    HV_ROOT_PATH: '/dev/sda1',
723
    HV_KERNEL_ARGS: 'ro',
724
    HV_MIGRATION_PORT: 8002,
725
    },
726
  HT_XEN_HVM: {
727
    HV_BOOT_ORDER: "cd",
728
    HV_CDROM_IMAGE_PATH: '',
729
    HV_NIC_TYPE: HT_NIC_RTL8139,
730
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
731
    HV_VNC_BIND_ADDRESS: '0.0.0.0',
732
    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
733
    HV_ACPI: True,
734
    HV_PAE: True,
735
    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
736
    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
737
    HV_MIGRATION_PORT: 8002,
738
    HV_USE_LOCALTIME: False,
739
    },
740
  HT_KVM: {
741
    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
742
    HV_INITRD_PATH: '',
743
    HV_KERNEL_ARGS: 'ro',
744
    HV_ROOT_PATH: '/dev/vda1',
745
    HV_ACPI: True,
746
    HV_SERIAL_CONSOLE: True,
747
    HV_VNC_BIND_ADDRESS: '',
748
    HV_VNC_TLS: False,
749
    HV_VNC_X509: '',
750
    HV_VNC_X509_VERIFY: False,
751
    HV_VNC_PASSWORD_FILE: '',
752
    HV_CDROM_IMAGE_PATH: '',
753
    HV_BOOT_ORDER: HT_BO_DISK,
754
    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
755
    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
756
    HV_USB_MOUSE: '',
757
    HV_MIGRATION_PORT: 8102,
758
    HV_MIGRATION_BANDWIDTH: 32, # MiB/s
759
    HV_MIGRATION_DOWNTIME: 30,  # ms
760
    HV_USE_LOCALTIME: False,
761
    HV_DISK_CACHE: HT_CACHE_DEFAULT,
762
    HV_SECURITY_MODEL: HT_SM_NONE,
763
    HV_SECURITY_DOMAIN: '',
764
    HV_KVM_FLAG: "",
765
    HV_VHOST_NET: False,
766
    HV_KVM_USE_CHROOT: False,
767
    },
768
  HT_FAKE: {
769
    },
770
  HT_CHROOT: {
771
    HV_INIT_SCRIPT: "/ganeti-chroot",
772
    },
773
  }
774

    
775
HVC_GLOBALS = frozenset([
776
  HV_MIGRATION_PORT,
777
  HV_MIGRATION_BANDWIDTH,
778
  ])
779

    
780
BEC_DEFAULTS = {
781
  BE_MEMORY: 128,
782
  BE_VCPUS: 1,
783
  BE_AUTO_BALANCE: True,
784
  }
785

    
786
NICC_DEFAULTS = {
787
  NIC_MODE: NIC_MODE_BRIDGED,
788
  NIC_LINK: DEFAULT_BRIDGE,
789
  }
790

    
791
MASTER_POOL_SIZE_DEFAULT = 10
792

    
793
CONFD_PROTOCOL_VERSION = 1
794

    
795
CONFD_REQ_PING = 0
796
CONFD_REQ_NODE_ROLE_BYNAME = 1
797
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
798
CONFD_REQ_CLUSTER_MASTER = 3
799
CONFD_REQ_NODE_PIP_LIST = 4
800
CONFD_REQ_MC_PIP_LIST = 5
801
CONFD_REQ_INSTANCES_IPS_LIST = 6
802

    
803
# Confd request query fields. These are used to narrow down queries.
804
# These must be strings rather than integers, because json-encoding
805
# converts them to strings anyway, as they're used as dict-keys.
806
CONFD_REQQ_LINK = "0"
807
CONFD_REQQ_IP = "1"
808
CONFD_REQQ_IPLIST = "2"
809
CONFD_REQQ_FIELDS = "3"
810

    
811
CONFD_REQFIELD_NAME = "0"
812
CONFD_REQFIELD_IP = "1"
813
CONFD_REQFIELD_MNODE_PIP = "2"
814

    
815
CONFD_REQS = frozenset([
816
  CONFD_REQ_PING,
817
  CONFD_REQ_NODE_ROLE_BYNAME,
818
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
819
  CONFD_REQ_CLUSTER_MASTER,
820
  CONFD_REQ_NODE_PIP_LIST,
821
  CONFD_REQ_MC_PIP_LIST,
822
  CONFD_REQ_INSTANCES_IPS_LIST,
823
  ])
824

    
825
CONFD_REPL_STATUS_OK = 0
826
CONFD_REPL_STATUS_ERROR = 1
827
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
828

    
829
CONFD_REPL_STATUSES = frozenset([
830
  CONFD_REPL_STATUS_OK,
831
  CONFD_REPL_STATUS_ERROR,
832
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
833
  ])
834

    
835
(CONFD_NODE_ROLE_MASTER,
836
 CONFD_NODE_ROLE_CANDIDATE,
837
 CONFD_NODE_ROLE_OFFLINE,
838
 CONFD_NODE_ROLE_DRAINED,
839
 CONFD_NODE_ROLE_REGULAR,
840
 ) = range(5)
841

    
842
# A few common errors for confd
843
CONFD_ERROR_UNKNOWN_ENTRY = 1
844
CONFD_ERROR_INTERNAL = 2
845
CONFD_ERROR_ARGUMENT = 3
846

    
847
# Each request is "salted" by the current timestamp.
848
# This constants decides how many seconds of skew to accept.
849
# TODO: make this a default and allow the value to be more configurable
850
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
851

    
852
# When we haven't reloaded the config for more than this amount of seconds, we
853
# force a test to see if inotify is betraying us.
854
CONFD_CONFIG_RELOAD_TIMEOUT = 60
855

    
856
# If we receive more than one update in this amount of seconds, we move to
857
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
858
# to serve more requests.
859
CONFD_CONFIG_RELOAD_RATELIMIT = 2
860

    
861
# Magic number prepended to all confd queries.
862
# This allows us to distinguish different types of confd protocols and handle
863
# them. For example by changing this we can move the whole payload to be
864
# compressed, or move away from json.
865
CONFD_MAGIC_FOURCC = 'plj0'
866

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

    
872
# Timeout in seconds to expire pending query request in the confd client
873
# library. We don't actually expect any answer more than 10 seconds after we
874
# sent a request.
875
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
876

    
877
# Maximum UDP datagram size.
878
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
879
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
880
#   (assuming we can't use jumbo frames)
881
# We just set this to 60K, which should be enough
882
MAX_UDP_DATA_SIZE = 61440
883

    
884
# User-id pool minimum/maximum acceptable user-ids.
885
UIDPOOL_UID_MIN = 0
886
UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
887

    
888
# Name or path of the pgrep command
889
PGREP = "pgrep"