Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 033a1d00

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

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

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

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

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

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

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

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

    
170
# one of 'no', 'yes', 'only'
171
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
172
SYSLOG_NO = "no"
173
SYSLOG_YES = "yes"
174
SYSLOG_ONLY = "only"
175
SYSLOG_SOCKET = "/dev/log"
176

    
177
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
178
EXPORT_DIR = _autoconf.EXPORT_DIR
179

    
180
EXPORT_CONF_FILE = "config.ini"
181

    
182
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
183
XEN_KERNEL = _autoconf.XEN_KERNEL
184
XEN_INITRD = _autoconf.XEN_INITRD
185

    
186
KVM_PATH = _autoconf.KVM_PATH
187
SOCAT_PATH = _autoconf.SOCAT_PATH
188
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
189
SOCAT_ESCAPE_CODE = "0x1d"
190

    
191
# For RSA keys more bits are better, but they also make operations more
192
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
193
# 2010 on.
194
RSA_KEY_BITS = 2048
195

    
196
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
197
X509_CERT_SIGN_DIGEST = "SHA1"
198

    
199
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
200

    
201
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
202

    
203
# Import/export daemon mode
204
IEM_IMPORT = "import"
205
IEM_EXPORT = "export"
206

    
207
# Import/export I/O
208
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
209
IEIO_FILE = "file"
210
# Raw block device I/O using "dd"
211
IEIO_RAW_DISK = "raw"
212
# OS definition import/export script
213
IEIO_SCRIPT = "script"
214

    
215
VALUE_DEFAULT = "default"
216
VALUE_AUTO = "auto"
217
VALUE_GENERATE = "generate"
218
VALUE_NONE = "none"
219
VALUE_TRUE = "true"
220
VALUE_FALSE = "false"
221

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

    
225
# hooks-related constants
226
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
227
HOOKS_PHASE_PRE = "pre"
228
HOOKS_PHASE_POST = "post"
229
HOOKS_NAME_CFGUPDATE = "config-update"
230
HOOKS_NAME_WATCHER = "watcher"
231
HOOKS_VERSION = 2
232

    
233
# hooks subject type (what object type does the LU deal with)
234
HTYPE_CLUSTER = "CLUSTER"
235
HTYPE_NODE = "NODE"
236
HTYPE_INSTANCE = "INSTANCE"
237

    
238
HKR_SKIP = 0
239
HKR_FAIL = 1
240
HKR_SUCCESS = 2
241

    
242
# Storage types
243
ST_FILE = "file"
244
ST_LVM_PV = "lvm-pv"
245
ST_LVM_VG = "lvm-vg"
246

    
247
# Storage fields
248
# first two are valid in LU context only, not passed to backend
249
SF_NODE = "node"
250
SF_TYPE = "type"
251
# and the rest are valid in backend
252
SF_NAME = "name"
253
SF_SIZE = "size"
254
SF_FREE = "free"
255
SF_USED = "used"
256
SF_ALLOCATABLE = "allocatable"
257

    
258
# Storage operations
259
SO_FIX_CONSISTENCY = "fix-consistency"
260

    
261
# Available fields per storage type
262
VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
263
                                  SF_USED, SF_FREE, SF_ALLOCATABLE])
264

    
265
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
266

    
267
MODIFIABLE_STORAGE_FIELDS = {
268
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
269
  }
270

    
271
VALID_STORAGE_OPERATIONS = {
272
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
273
  }
274

    
275
# Local disk status
276
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
277
(LDS_OKAY,
278
 LDS_UNKNOWN,
279
 LDS_FAULTY) = range(1, 4)
280

    
281
# disk template types
282
DT_DISKLESS = "diskless"
283
DT_PLAIN = "plain"
284
DT_DRBD8 = "drbd"
285
DT_FILE = "file"
286

    
287
# the set of network-mirrored disk templates
288
DTS_NET_MIRROR = frozenset([DT_DRBD8])
289

    
290
# the set of non-lvm-based disk templates
291
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
292

    
293
# the set of disk templates which can be grown
294
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
295

    
296
# logical disk types
297
LD_LV = "lvm"
298
LD_DRBD8 = "drbd8"
299
LD_FILE = "file"
300
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
301

    
302
# drbd constants
303
DRBD_HMAC_ALG = "md5"
304
DRBD_NET_PROTOCOL = "C"
305
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
306

    
307
# file backend driver
308
FD_LOOP = "loop"
309
FD_BLKTAP = "blktap"
310

    
311
# the set of drbd-like disk types
312
LDS_DRBD = frozenset([LD_DRBD8])
313

    
314
# disk access mode
315
DISK_RDONLY = "ro"
316
DISK_RDWR = "rw"
317
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
318

    
319
# disk replacement mode
320
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
321
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
322
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
323
REPLACE_DISK_AUTO = "replace_auto"
324

    
325
# lock recalculate mode
326
LOCKS_REPLACE = 'replace'
327
LOCKS_APPEND = 'append'
328

    
329
# instance creation modes
330
INSTANCE_CREATE = "create"
331
INSTANCE_IMPORT = "import"
332

    
333
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
334
                            DT_DRBD8, DT_FILE])
335

    
336
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
337

    
338
# import/export config options
339
INISECT_EXP = "export"
340
INISECT_INS = "instance"
341
INISECT_HYP = "hypervisor"
342
INISECT_BEP = "backend"
343

    
344
# dynamic device modification
345

    
346
DDM_ADD = 'add'
347
DDM_REMOVE = 'remove'
348

    
349
# common exit codes
350
EXIT_SUCCESS = 0
351
EXIT_FAILURE = 1
352
EXIT_NOTCLUSTER = 5
353
EXIT_NOTMASTER = 11
354
EXIT_NODESETUP_ERROR = 12
355
EXIT_CONFIRMATION = 13 # need user confirmation
356
EXIT_NOTCANDIDATE = 14
357

    
358
# tags
359
TAG_CLUSTER = "cluster"
360
TAG_NODE = "node"
361
TAG_INSTANCE = "instance"
362
MAX_TAG_LEN = 128
363
MAX_TAGS_PER_OBJ = 4096
364

    
365
# others
366
DEFAULT_BRIDGE = "xen-br0"
367
SYNC_SPEED = 60 * 1024
368
LOCALHOST_IP_ADDRESS = "127.0.0.1"
369
TCP_PING_TIMEOUT = 10
370
GANETI_RUNAS = "root"
371
DEFAULT_VG = "xenvg"
372
BIND_ADDRESS_GLOBAL = "0.0.0.0"
373
MIN_VG_SIZE = 20480
374
DEFAULT_MAC_PREFIX = "aa:00:00"
375
LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
376
# default maximum instance wait time, in seconds.
377
DEFAULT_SHUTDOWN_TIMEOUT = 120
378
NODE_MAX_CLOCK_SKEW = 150
379
# Time for an intra-cluster disk transfer to wait for a connection
380
DISK_TRANSFER_CONNECT_TIMEOUT = 30
381

    
382
# runparts results
383
(RUNPARTS_SKIP,
384
 RUNPARTS_RUN,
385
 RUNPARTS_ERR) = range(3)
386

    
387
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
388

    
389
# RPC constants
390
(RPC_ENCODING_NONE,
391
 RPC_ENCODING_ZLIB_BASE64) = range(2)
392

    
393
# os related constants
394
OS_SCRIPT_CREATE = 'create'
395
OS_SCRIPT_IMPORT = 'import'
396
OS_SCRIPT_EXPORT = 'export'
397
OS_SCRIPT_RENAME = 'rename'
398
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
399
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
400

    
401
OS_API_FILE = 'ganeti_api_version'
402
OS_VARIANTS_FILE = 'variants.list'
403

    
404
# ssh constants
405
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
406
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
407
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
408
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
409
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
410
SSH = "ssh"
411
SCP = "scp"
412

    
413
# reboot types
414
INSTANCE_REBOOT_SOFT = "soft"
415
INSTANCE_REBOOT_HARD = "hard"
416
INSTANCE_REBOOT_FULL = "full"
417

    
418
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
419
                          INSTANCE_REBOOT_HARD,
420
                          INSTANCE_REBOOT_FULL])
421

    
422
VTYPE_STRING = 'string'
423
VTYPE_BOOL = 'bool'
424
VTYPE_SIZE = 'size' # size, in MiBs
425
VTYPE_INT = 'int'
426
ENFORCEABLE_TYPES = frozenset([
427
                      VTYPE_STRING,
428
                      VTYPE_BOOL,
429
                      VTYPE_SIZE,
430
                      VTYPE_INT,
431
                      ])
432

    
433
# HV parameter names (global namespace)
434
HV_BOOT_ORDER = "boot_order"
435
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
436
HV_NIC_TYPE = "nic_type"
437
HV_DISK_TYPE = "disk_type"
438
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
439
HV_VNC_PASSWORD_FILE = "vnc_password_file"
440
HV_VNC_TLS = "vnc_tls"
441
HV_VNC_X509 = "vnc_x509_path"
442
HV_VNC_X509_VERIFY = "vnc_x509_verify"
443
HV_ACPI = "acpi"
444
HV_PAE = "pae"
445
HV_USE_BOOTLOADER = "use_bootloader"
446
HV_BOOTLOADER_ARGS = "bootloader_args"
447
HV_BOOTLOADER_PATH = "bootloader_path"
448
HV_KERNEL_ARGS = "kernel_args"
449
HV_KERNEL_PATH = "kernel_path"
450
HV_INITRD_PATH = "initrd_path"
451
HV_ROOT_PATH = "root_path"
452
HV_SERIAL_CONSOLE = "serial_console"
453
HV_USB_MOUSE = "usb_mouse"
454
HV_DEVICE_MODEL = "device_model"
455
HV_INIT_SCRIPT = "init_script"
456
HV_MIGRATION_PORT = "migration_port"
457
HV_USE_LOCALTIME = "use_localtime"
458
HV_DISK_CACHE = "disk_cache"
459
HV_SECURITY_MODEL = "security_model"
460
HV_SECURITY_DOMAIN = "security_domain"
461
HV_KVM_FLAG = "kvm_flag"
462

    
463
HVS_PARAMETER_TYPES = {
464
  HV_BOOT_ORDER: VTYPE_STRING,
465
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
466
  HV_NIC_TYPE: VTYPE_STRING,
467
  HV_DISK_TYPE: VTYPE_STRING,
468
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
469
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
470
  HV_VNC_TLS: VTYPE_BOOL,
471
  HV_VNC_X509: VTYPE_STRING,
472
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
473
  HV_ACPI: VTYPE_BOOL,
474
  HV_PAE: VTYPE_BOOL,
475
  HV_USE_BOOTLOADER: VTYPE_BOOL,
476
  HV_BOOTLOADER_PATH: VTYPE_STRING,
477
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
478
  HV_KERNEL_PATH: VTYPE_STRING,
479
  HV_KERNEL_ARGS: VTYPE_STRING,
480
  HV_INITRD_PATH: VTYPE_STRING,
481
  HV_ROOT_PATH: VTYPE_STRING,
482
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
483
  HV_USB_MOUSE: VTYPE_STRING,
484
  HV_DEVICE_MODEL: VTYPE_STRING,
485
  HV_INIT_SCRIPT: VTYPE_STRING,
486
  HV_MIGRATION_PORT: VTYPE_INT,
487
  HV_USE_LOCALTIME: VTYPE_BOOL,
488
  HV_DISK_CACHE: VTYPE_STRING,
489
  HV_SECURITY_MODEL: VTYPE_STRING,
490
  HV_SECURITY_DOMAIN: VTYPE_STRING,
491
  HV_KVM_FLAG: VTYPE_STRING,
492
  }
493

    
494
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
495

    
496
# BE parameter names
497
BE_MEMORY = "memory"
498
BE_VCPUS = "vcpus"
499
BE_AUTO_BALANCE = "auto_balance"
500

    
501
BES_PARAMETER_TYPES = {
502
    BE_MEMORY: VTYPE_SIZE,
503
    BE_VCPUS: VTYPE_INT,
504
    BE_AUTO_BALANCE: VTYPE_BOOL,
505
    }
506

    
507
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
508

    
509
# Instance Parameters Profile
510
PP_DEFAULT = "default"
511

    
512
NIC_MODE = "mode"
513
NIC_LINK = "link"
514

    
515
NIC_MODE_BRIDGED = "bridged"
516
NIC_MODE_ROUTED = "routed"
517

    
518
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
519

    
520
NICS_PARAMETER_TYPES = {
521
    NIC_MODE: VTYPE_STRING,
522
    NIC_LINK: VTYPE_STRING,
523
    }
524

    
525
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
526

    
527
# Hypervisor constants
528
HT_XEN_PVM = "xen-pvm"
529
HT_FAKE = "fake"
530
HT_XEN_HVM = "xen-hvm"
531
HT_KVM = "kvm"
532
HT_CHROOT = "chroot"
533
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
534
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
535

    
536
VNC_BASE_PORT = 5900
537
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
538
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
539

    
540
# NIC types
541
HT_NIC_RTL8139 = "rtl8139"
542
HT_NIC_NE2K_PCI = "ne2k_pci"
543
HT_NIC_NE2K_ISA = "ne2k_isa"
544
HT_NIC_I82551 = "i82551"
545
HT_NIC_I85557B = "i82557b"
546
HT_NIC_I8259ER = "i82559er"
547
HT_NIC_PCNET = "pcnet"
548
HT_NIC_E1000 = "e1000"
549
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
550

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

    
566
HT_CACHE_DEFAULT = "default"
567
HT_CACHE_NONE = "none"
568
HT_CACHE_WTHROUGH = "writethrough"
569
HT_CACHE_WBACK = "writeback"
570
HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
571
                                  HT_CACHE_NONE,
572
                                  HT_CACHE_WTHROUGH,
573
                                  HT_CACHE_WBACK])
574

    
575
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
576
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
577
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
578
                                     HT_DISK_PFLASH])
579

    
580
# Mouse types:
581
HT_MOUSE_MOUSE = "mouse"
582
HT_MOUSE_TABLET = "tablet"
583

    
584
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
585

    
586
# Boot order
587
HT_BO_CDROM = "cdrom"
588
HT_BO_DISK = "disk"
589
HT_BO_NETWORK = "network"
590

    
591
HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
592

    
593
# Security models
594
HT_SM_NONE = "none"
595
HT_SM_USER = "user"
596
HT_SM_POOL = "pool"
597

    
598
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
599

    
600
# Kvm flag values
601
HT_KVM_ENABLED = "enabled"
602
HT_KVM_DISABLED = "disabled"
603

    
604
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
605

    
606
# Cluster Verify steps
607
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
608
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
609

    
610
# Node verify constants
611
NV_FILELIST = "filelist"
612
NV_HVINFO = "hvinfo"
613
NV_HYPERVISOR = "hypervisor"
614
NV_INSTANCELIST = "instancelist"
615
NV_NODELIST = "nodelist"
616
NV_NODENETTEST = "node-net-test"
617
NV_VERSION = "version"
618
NV_VGLIST = "vglist"
619
NV_LVLIST = "lvlist"
620
NV_PVLIST = "pvlist"
621
NV_DRBDLIST = "drbd-list"
622
NV_NODESETUP = "nodesetup"
623
NV_TIME = "time"
624

    
625
# SSL certificate check constants (in days)
626
SSL_CERT_EXPIRATION_WARN = 30
627
SSL_CERT_EXPIRATION_ERROR = 7
628

    
629
# Allocator framework constants
630
IALLOCATOR_VERSION = 2
631
IALLOCATOR_DIR_IN = "in"
632
IALLOCATOR_DIR_OUT = "out"
633
IALLOCATOR_MODE_ALLOC = "allocate"
634
IALLOCATOR_MODE_RELOC = "relocate"
635
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
636
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
637

    
638
# Job queue
639
JOB_QUEUE_VERSION = 1
640
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
641
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
642
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
643
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
644
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
645
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
646
JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
647

    
648
JOB_ID_TEMPLATE = r"\d+"
649

    
650
# unchanged job return
651
JOB_NOTCHANGED = "nochange"
652

    
653
# Job status
654
JOB_STATUS_QUEUED = "queued"
655
JOB_STATUS_WAITLOCK = "waiting"
656
JOB_STATUS_CANCELING = "canceling"
657
JOB_STATUS_RUNNING = "running"
658
JOB_STATUS_CANCELED = "canceled"
659
JOB_STATUS_SUCCESS = "success"
660
JOB_STATUS_ERROR = "error"
661

    
662
# OpCode status
663
# not yet finalized
664
OP_STATUS_QUEUED = "queued"
665
OP_STATUS_WAITLOCK = "waiting"
666
OP_STATUS_CANCELING = "canceling"
667
OP_STATUS_RUNNING = "running"
668
# finalized
669
OP_STATUS_CANCELED = "canceled"
670
OP_STATUS_SUCCESS = "success"
671
OP_STATUS_ERROR = "error"
672
OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
673
                           OP_STATUS_SUCCESS,
674
                           OP_STATUS_ERROR])
675

    
676
# Execution log types
677
ELOG_MESSAGE = "message"
678
ELOG_PROGRESS = "progress"
679

    
680
# max dynamic devices
681
MAX_NICS = 8
682
MAX_DISKS = 16
683

    
684
# SSCONF keys
685
SS_CLUSTER_NAME = "cluster_name"
686
SS_CLUSTER_TAGS = "cluster_tags"
687
SS_FILE_STORAGE_DIR = "file_storage_dir"
688
SS_MASTER_CANDIDATES = "master_candidates"
689
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
690
SS_MASTER_IP = "master_ip"
691
SS_MASTER_NETDEV = "master_netdev"
692
SS_MASTER_NODE = "master_node"
693
SS_NODE_LIST = "node_list"
694
SS_NODE_PRIMARY_IPS = "node_primary_ips"
695
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
696
SS_OFFLINE_NODES = "offline_nodes"
697
SS_ONLINE_NODES = "online_nodes"
698
SS_INSTANCE_LIST = "instance_list"
699
SS_RELEASE_VERSION = "release_version"
700
SS_HYPERVISOR_LIST = "hypervisor_list"
701
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
702
SS_UID_POOL = "uid_pool"
703

    
704
# cluster wide default parameters
705
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
706

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

    
763
HVC_GLOBALS = frozenset([
764
  HV_MIGRATION_PORT,
765
  ])
766

    
767
BEC_DEFAULTS = {
768
  BE_MEMORY: 128,
769
  BE_VCPUS: 1,
770
  BE_AUTO_BALANCE: True,
771
  }
772

    
773
NICC_DEFAULTS = {
774
  NIC_MODE: NIC_MODE_BRIDGED,
775
  NIC_LINK: DEFAULT_BRIDGE,
776
  }
777

    
778
MASTER_POOL_SIZE_DEFAULT = 10
779

    
780
CONFD_PROTOCOL_VERSION = 1
781

    
782
CONFD_REQ_PING = 0
783
CONFD_REQ_NODE_ROLE_BYNAME = 1
784
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
785
CONFD_REQ_CLUSTER_MASTER = 3
786
CONFD_REQ_NODE_PIP_LIST = 4
787
CONFD_REQ_MC_PIP_LIST = 5
788
CONFD_REQ_INSTANCES_IPS_LIST = 6
789

    
790
# Confd request query fields. These are used to narrow down queries.
791
# These must be strings rather than integers, because json-encoding
792
# converts them to strings anyway, as they're used as dict-keys.
793
CONFD_REQQ_LINK = "0"
794
CONFD_REQQ_IP = "1"
795
CONFD_REQQ_IPLIST = "2"
796
CONFD_REQQ_FIELDS = "3"
797

    
798
CONFD_REQFIELD_NAME = "0"
799
CONFD_REQFIELD_IP = "1"
800
CONFD_REQFIELD_MNODE_PIP = "2"
801

    
802
CONFD_REQS = frozenset([
803
  CONFD_REQ_PING,
804
  CONFD_REQ_NODE_ROLE_BYNAME,
805
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
806
  CONFD_REQ_CLUSTER_MASTER,
807
  CONFD_REQ_NODE_PIP_LIST,
808
  CONFD_REQ_MC_PIP_LIST,
809
  CONFD_REQ_INSTANCES_IPS_LIST,
810
  ])
811

    
812
CONFD_REPL_STATUS_OK = 0
813
CONFD_REPL_STATUS_ERROR = 1
814
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
815

    
816
CONFD_REPL_STATUSES = frozenset([
817
  CONFD_REPL_STATUS_OK,
818
  CONFD_REPL_STATUS_ERROR,
819
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
820
  ])
821

    
822
(CONFD_NODE_ROLE_MASTER,
823
 CONFD_NODE_ROLE_CANDIDATE,
824
 CONFD_NODE_ROLE_OFFLINE,
825
 CONFD_NODE_ROLE_DRAINED,
826
 CONFD_NODE_ROLE_REGULAR,
827
 ) = range(5)
828

    
829
# A few common errors for confd
830
CONFD_ERROR_UNKNOWN_ENTRY = 1
831
CONFD_ERROR_INTERNAL = 2
832
CONFD_ERROR_ARGUMENT = 3
833

    
834
# Each request is "salted" by the current timestamp.
835
# This constants decides how many seconds of skew to accept.
836
# TODO: make this a default and allow the value to be more configurable
837
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
838

    
839
# When we haven't reloaded the config for more than this amount of seconds, we
840
# force a test to see if inotify is betraying us.
841
CONFD_CONFIG_RELOAD_TIMEOUT = 60
842

    
843
# If we receive more than one update in this amount of seconds, we move to
844
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
845
# to serve more requests.
846
CONFD_CONFIG_RELOAD_RATELIMIT = 2
847

    
848
# Magic number prepended to all confd queries.
849
# This allows us to distinguish different types of confd protocols and handle
850
# them. For example by changing this we can move the whole payload to be
851
# compressed, or move away from json.
852
CONFD_MAGIC_FOURCC = 'plj0'
853

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

    
859
# Timeout in seconds to expire pending query request in the confd client
860
# library. We don't actually expect any answer more than 10 seconds after we
861
# sent a request.
862
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
863

    
864
# Maximum UDP datagram size.
865
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
866
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
867
#   (assuming we can't use jumbo frames)
868
# We just set this to 60K, which should be enough
869
MAX_UDP_DATA_SIZE = 61440
870

    
871
# User-id pool minimum/maximum acceptable user-ids.
872
UIDPOOL_UID_MIN = 0
873
UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
874

    
875
# Name or path of the pgrep command
876
PGREP = "pgrep"