Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 1d3dfa29

History | View | Annotate | Download (25.3 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
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
208
X509_CERT_SIGN_DIGEST = "SHA1"
209

    
210
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
211

    
212
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"
213

    
214
# Import/export daemon mode
215
IEM_IMPORT = "import"
216
IEM_EXPORT = "export"
217

    
218
# Import/export transport compression
219
IEC_NONE = "none"
220
IEC_GZIP = "gzip"
221
IEC_ALL = frozenset([
222
  IEC_NONE,
223
  IEC_GZIP,
224
  ])
225

    
226
IE_CUSTOM_SIZE = "fd"
227

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

    
230
# Import/export I/O
231
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
232
IEIO_FILE = "file"
233
# Raw block device I/O using "dd"
234
IEIO_RAW_DISK = "raw"
235
# OS definition import/export script
236
IEIO_SCRIPT = "script"
237

    
238
VALUE_DEFAULT = "default"
239
VALUE_AUTO = "auto"
240
VALUE_GENERATE = "generate"
241
VALUE_NONE = "none"
242
VALUE_TRUE = "true"
243
VALUE_FALSE = "false"
244

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

    
248
# hooks-related constants
249
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
250
HOOKS_PHASE_PRE = "pre"
251
HOOKS_PHASE_POST = "post"
252
HOOKS_NAME_CFGUPDATE = "config-update"
253
HOOKS_NAME_WATCHER = "watcher"
254
HOOKS_VERSION = 2
255

    
256
# hooks subject type (what object type does the LU deal with)
257
HTYPE_CLUSTER = "CLUSTER"
258
HTYPE_NODE = "NODE"
259
HTYPE_INSTANCE = "INSTANCE"
260

    
261
HKR_SKIP = 0
262
HKR_FAIL = 1
263
HKR_SUCCESS = 2
264

    
265
# Storage types
266
ST_FILE = "file"
267
ST_LVM_PV = "lvm-pv"
268
ST_LVM_VG = "lvm-vg"
269

    
270
# Storage fields
271
# first two are valid in LU context only, not passed to backend
272
SF_NODE = "node"
273
SF_TYPE = "type"
274
# and the rest are valid in backend
275
SF_NAME = "name"
276
SF_SIZE = "size"
277
SF_FREE = "free"
278
SF_USED = "used"
279
SF_ALLOCATABLE = "allocatable"
280

    
281
# Storage operations
282
SO_FIX_CONSISTENCY = "fix-consistency"
283

    
284
# Available fields per storage type
285
VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
286
                                  SF_USED, SF_FREE, SF_ALLOCATABLE])
287

    
288
VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
289

    
290
MODIFIABLE_STORAGE_FIELDS = {
291
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
292
  }
293

    
294
VALID_STORAGE_OPERATIONS = {
295
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
296
  }
297

    
298
# Local disk status
299
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
300
(LDS_OKAY,
301
 LDS_UNKNOWN,
302
 LDS_FAULTY) = range(1, 4)
303

    
304
# disk template types
305
DT_DISKLESS = "diskless"
306
DT_PLAIN = "plain"
307
DT_DRBD8 = "drbd"
308
DT_FILE = "file"
309

    
310
# the set of network-mirrored disk templates
311
DTS_NET_MIRROR = frozenset([DT_DRBD8])
312

    
313
# the set of non-lvm-based disk templates
314
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
315

    
316
# the set of disk templates which can be grown
317
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])
318

    
319
# logical disk types
320
LD_LV = "lvm"
321
LD_DRBD8 = "drbd8"
322
LD_FILE = "file"
323
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
324

    
325
# drbd constants
326
DRBD_HMAC_ALG = "md5"
327
DRBD_NET_PROTOCOL = "C"
328
DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
329

    
330
# file backend driver
331
FD_LOOP = "loop"
332
FD_BLKTAP = "blktap"
333

    
334
# the set of drbd-like disk types
335
LDS_DRBD = frozenset([LD_DRBD8])
336

    
337
# disk access mode
338
DISK_RDONLY = "ro"
339
DISK_RDWR = "rw"
340
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
341

    
342
# disk replacement mode
343
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
344
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
345
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
346
REPLACE_DISK_AUTO = "replace_auto"
347

    
348
# Instance export mode
349
EXPORT_MODE_LOCAL = "local"
350
EXPORT_MODE_REMOTE = "remote"
351
EXPORT_MODES = frozenset([
352
  EXPORT_MODE_LOCAL,
353
  EXPORT_MODE_REMOTE,
354
  ])
355

    
356
# lock recalculate mode
357
LOCKS_REPLACE = 'replace'
358
LOCKS_APPEND = 'append'
359

    
360
# instance creation modes
361
INSTANCE_CREATE = "create"
362
INSTANCE_IMPORT = "import"
363
INSTANCE_REMOTE_IMPORT = "remote-import"
364
INSTANCE_CREATE_MODES = frozenset([
365
  INSTANCE_CREATE,
366
  INSTANCE_IMPORT,
367
  INSTANCE_REMOTE_IMPORT,
368
  ])
369

    
370
# Remote import/export handshake message and version
371
RIE_VERSION = 0
372
RIE_HANDSHAKE = "Hi, I'm Ganeti"
373

    
374
# Remote import/export certificate validity in seconds
375
RIE_CERT_VALIDITY = 24 * 60 * 60
376

    
377
# Remote import/export connect timeout for socat
378
RIE_CONNECT_TIMEOUT = 60
379

    
380
DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
381
                            DT_DRBD8, DT_FILE])
382

    
383
FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
384

    
385
# import/export config options
386
INISECT_EXP = "export"
387
INISECT_INS = "instance"
388
INISECT_HYP = "hypervisor"
389
INISECT_BEP = "backend"
390

    
391
# dynamic device modification
392
DDM_ADD = 'add'
393
DDM_REMOVE = 'remove'
394

    
395
# common exit codes
396
EXIT_SUCCESS = 0
397
EXIT_FAILURE = 1
398
EXIT_NOTCLUSTER = 5
399
EXIT_NOTMASTER = 11
400
EXIT_NODESETUP_ERROR = 12
401
EXIT_CONFIRMATION = 13 # need user confirmation
402

    
403
# tags
404
TAG_CLUSTER = "cluster"
405
TAG_NODE = "node"
406
TAG_INSTANCE = "instance"
407
MAX_TAG_LEN = 128
408
MAX_TAGS_PER_OBJ = 4096
409

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

    
427
# runparts results
428
(RUNPARTS_SKIP,
429
 RUNPARTS_RUN,
430
 RUNPARTS_ERR) = range(3)
431

    
432
RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
433

    
434
# RPC constants
435
(RPC_ENCODING_NONE,
436
 RPC_ENCODING_ZLIB_BASE64) = range(2)
437

    
438
# os related constants
439
OS_SCRIPT_CREATE = 'create'
440
OS_SCRIPT_IMPORT = 'import'
441
OS_SCRIPT_EXPORT = 'export'
442
OS_SCRIPT_RENAME = 'rename'
443
OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
444
                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
445

    
446
OS_API_FILE = 'ganeti_api_version'
447
OS_VARIANTS_FILE = 'variants.list'
448

    
449
# ssh constants
450
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
451
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
452
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
453
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
454
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
455
SSH = "ssh"
456
SCP = "scp"
457

    
458
# reboot types
459
INSTANCE_REBOOT_SOFT = "soft"
460
INSTANCE_REBOOT_HARD = "hard"
461
INSTANCE_REBOOT_FULL = "full"
462

    
463
REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
464
                          INSTANCE_REBOOT_HARD,
465
                          INSTANCE_REBOOT_FULL])
466

    
467
VTYPE_STRING = 'string'
468
VTYPE_BOOL = 'bool'
469
VTYPE_SIZE = 'size' # size, in MiBs
470
VTYPE_INT = 'int'
471
ENFORCEABLE_TYPES = frozenset([
472
                      VTYPE_STRING,
473
                      VTYPE_BOOL,
474
                      VTYPE_SIZE,
475
                      VTYPE_INT,
476
                      ])
477

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

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

    
547
HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
548

    
549
# BE parameter names
550
BE_MEMORY = "memory"
551
BE_VCPUS = "vcpus"
552
BE_AUTO_BALANCE = "auto_balance"
553

    
554
BES_PARAMETER_TYPES = {
555
    BE_MEMORY: VTYPE_SIZE,
556
    BE_VCPUS: VTYPE_INT,
557
    BE_AUTO_BALANCE: VTYPE_BOOL,
558
    }
559

    
560
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
561

    
562
# Instance Parameters Profile
563
PP_DEFAULT = "default"
564

    
565
NIC_MODE = "mode"
566
NIC_LINK = "link"
567

    
568
NIC_MODE_BRIDGED = "bridged"
569
NIC_MODE_ROUTED = "routed"
570

    
571
NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
572

    
573
NICS_PARAMETER_TYPES = {
574
    NIC_MODE: VTYPE_STRING,
575
    NIC_LINK: VTYPE_STRING,
576
    }
577

    
578
NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
579

    
580
# Hypervisor constants
581
HT_XEN_PVM = "xen-pvm"
582
HT_FAKE = "fake"
583
HT_XEN_HVM = "xen-hvm"
584
HT_KVM = "kvm"
585
HT_CHROOT = "chroot"
586
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
587
HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
588

    
589
VNC_BASE_PORT = 5900
590
VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
591
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
592

    
593
# NIC types
594
HT_NIC_RTL8139 = "rtl8139"
595
HT_NIC_NE2K_PCI = "ne2k_pci"
596
HT_NIC_NE2K_ISA = "ne2k_isa"
597
HT_NIC_I82551 = "i82551"
598
HT_NIC_I85557B = "i82557b"
599
HT_NIC_I8259ER = "i82559er"
600
HT_NIC_PCNET = "pcnet"
601
HT_NIC_E1000 = "e1000"
602
HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
603

    
604
HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
605
                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
606
HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
607
                                    HT_NIC_NE2K_ISA, HT_NIC_I82551,
608
                                    HT_NIC_I85557B, HT_NIC_I8259ER,
609
                                    HT_NIC_PCNET, HT_NIC_E1000,
610
                                    HT_NIC_PARAVIRTUAL])
611
# Disk types
612
HT_DISK_IOEMU = "ioemu"
613
HT_DISK_IDE = "ide"
614
HT_DISK_SCSI = "scsi"
615
HT_DISK_SD = "sd"
616
HT_DISK_MTD = "mtd"
617
HT_DISK_PFLASH = "pflash"
618

    
619
HT_CACHE_DEFAULT = "default"
620
HT_CACHE_NONE = "none"
621
HT_CACHE_WTHROUGH = "writethrough"
622
HT_CACHE_WBACK = "writeback"
623
HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
624
                                  HT_CACHE_NONE,
625
                                  HT_CACHE_WTHROUGH,
626
                                  HT_CACHE_WBACK])
627

    
628
HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
629
HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
630
                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
631
                                     HT_DISK_PFLASH])
632

    
633
# Mouse types:
634
HT_MOUSE_MOUSE = "mouse"
635
HT_MOUSE_TABLET = "tablet"
636

    
637
HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
638

    
639
# Boot order
640
HT_BO_CDROM = "cdrom"
641
HT_BO_DISK = "disk"
642
HT_BO_NETWORK = "network"
643

    
644
HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
645

    
646
# Security models
647
HT_SM_NONE = "none"
648
HT_SM_USER = "user"
649
HT_SM_POOL = "pool"
650

    
651
HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
652

    
653
# Kvm flag values
654
HT_KVM_ENABLED = "enabled"
655
HT_KVM_DISABLED = "disabled"
656

    
657
HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
658

    
659
# Cluster Verify steps
660
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
661
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
662

    
663
# Node verify constants
664
NV_FILELIST = "filelist"
665
NV_HVINFO = "hvinfo"
666
NV_HYPERVISOR = "hypervisor"
667
NV_INSTANCELIST = "instancelist"
668
NV_NODELIST = "nodelist"
669
NV_NODENETTEST = "node-net-test"
670
NV_VERSION = "version"
671
NV_VGLIST = "vglist"
672
NV_LVLIST = "lvlist"
673
NV_PVLIST = "pvlist"
674
NV_DRBDLIST = "drbd-list"
675
NV_NODESETUP = "nodesetup"
676
NV_TIME = "time"
677
NV_MASTERIP = "master-ip"
678

    
679
# SSL certificate check constants (in days)
680
SSL_CERT_EXPIRATION_WARN = 30
681
SSL_CERT_EXPIRATION_ERROR = 7
682

    
683
# Allocator framework constants
684
IALLOCATOR_VERSION = 2
685
IALLOCATOR_DIR_IN = "in"
686
IALLOCATOR_DIR_OUT = "out"
687
IALLOCATOR_MODE_ALLOC = "allocate"
688
IALLOCATOR_MODE_RELOC = "relocate"
689
IALLOCATOR_MODE_MEVAC = "multi-evacuate"
690
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
691

    
692
# Job queue
693
JOB_QUEUE_VERSION = 1
694
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
695
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
696
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
697
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
698
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
699
JOB_QUEUE_SIZE_HARD_LIMIT = 5000
700
JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
701
JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
702

    
703
JOB_ID_TEMPLATE = r"\d+"
704

    
705
# unchanged job return
706
JOB_NOTCHANGED = "nochange"
707

    
708
# Job status
709
JOB_STATUS_QUEUED = "queued"
710
JOB_STATUS_WAITLOCK = "waiting"
711
JOB_STATUS_CANCELING = "canceling"
712
JOB_STATUS_RUNNING = "running"
713
JOB_STATUS_CANCELED = "canceled"
714
JOB_STATUS_SUCCESS = "success"
715
JOB_STATUS_ERROR = "error"
716

    
717
# OpCode status
718
# not yet finalized
719
OP_STATUS_QUEUED = "queued"
720
OP_STATUS_WAITLOCK = "waiting"
721
OP_STATUS_CANCELING = "canceling"
722
OP_STATUS_RUNNING = "running"
723
# finalized
724
OP_STATUS_CANCELED = "canceled"
725
OP_STATUS_SUCCESS = "success"
726
OP_STATUS_ERROR = "error"
727
OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
728
                           OP_STATUS_SUCCESS,
729
                           OP_STATUS_ERROR])
730

    
731
# Execution log types
732
ELOG_MESSAGE = "message"
733
ELOG_PROGRESS = "progress"
734
ELOG_REMOTE_IMPORT = "remote-import"
735

    
736
# max dynamic devices
737
MAX_NICS = 8
738
MAX_DISKS = 16
739

    
740
# SSCONF keys
741
SS_CLUSTER_NAME = "cluster_name"
742
SS_CLUSTER_TAGS = "cluster_tags"
743
SS_FILE_STORAGE_DIR = "file_storage_dir"
744
SS_MASTER_CANDIDATES = "master_candidates"
745
SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
746
SS_MASTER_IP = "master_ip"
747
SS_MASTER_NETDEV = "master_netdev"
748
SS_MASTER_NODE = "master_node"
749
SS_NODE_LIST = "node_list"
750
SS_NODE_PRIMARY_IPS = "node_primary_ips"
751
SS_NODE_SECONDARY_IPS = "node_secondary_ips"
752
SS_OFFLINE_NODES = "offline_nodes"
753
SS_ONLINE_NODES = "online_nodes"
754
SS_INSTANCE_LIST = "instance_list"
755
SS_RELEASE_VERSION = "release_version"
756
SS_HYPERVISOR_LIST = "hypervisor_list"
757
SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
758
SS_UID_POOL = "uid_pool"
759

    
760
# cluster wide default parameters
761
DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
762

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

    
823
HVC_GLOBALS = frozenset([
824
  HV_MIGRATION_PORT,
825
  HV_MIGRATION_BANDWIDTH,
826
  ])
827

    
828
BEC_DEFAULTS = {
829
  BE_MEMORY: 128,
830
  BE_VCPUS: 1,
831
  BE_AUTO_BALANCE: True,
832
  }
833

    
834
NICC_DEFAULTS = {
835
  NIC_MODE: NIC_MODE_BRIDGED,
836
  NIC_LINK: DEFAULT_BRIDGE,
837
  }
838

    
839
MASTER_POOL_SIZE_DEFAULT = 10
840

    
841
CONFD_PROTOCOL_VERSION = 1
842

    
843
CONFD_REQ_PING = 0
844
CONFD_REQ_NODE_ROLE_BYNAME = 1
845
CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
846
CONFD_REQ_CLUSTER_MASTER = 3
847
CONFD_REQ_NODE_PIP_LIST = 4
848
CONFD_REQ_MC_PIP_LIST = 5
849
CONFD_REQ_INSTANCES_IPS_LIST = 6
850

    
851
# Confd request query fields. These are used to narrow down queries.
852
# These must be strings rather than integers, because json-encoding
853
# converts them to strings anyway, as they're used as dict-keys.
854
CONFD_REQQ_LINK = "0"
855
CONFD_REQQ_IP = "1"
856
CONFD_REQQ_IPLIST = "2"
857
CONFD_REQQ_FIELDS = "3"
858

    
859
CONFD_REQFIELD_NAME = "0"
860
CONFD_REQFIELD_IP = "1"
861
CONFD_REQFIELD_MNODE_PIP = "2"
862

    
863
CONFD_REQS = frozenset([
864
  CONFD_REQ_PING,
865
  CONFD_REQ_NODE_ROLE_BYNAME,
866
  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
867
  CONFD_REQ_CLUSTER_MASTER,
868
  CONFD_REQ_NODE_PIP_LIST,
869
  CONFD_REQ_MC_PIP_LIST,
870
  CONFD_REQ_INSTANCES_IPS_LIST,
871
  ])
872

    
873
CONFD_REPL_STATUS_OK = 0
874
CONFD_REPL_STATUS_ERROR = 1
875
CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
876

    
877
CONFD_REPL_STATUSES = frozenset([
878
  CONFD_REPL_STATUS_OK,
879
  CONFD_REPL_STATUS_ERROR,
880
  CONFD_REPL_STATUS_NOTIMPLEMENTED,
881
  ])
882

    
883
(CONFD_NODE_ROLE_MASTER,
884
 CONFD_NODE_ROLE_CANDIDATE,
885
 CONFD_NODE_ROLE_OFFLINE,
886
 CONFD_NODE_ROLE_DRAINED,
887
 CONFD_NODE_ROLE_REGULAR,
888
 ) = range(5)
889

    
890
# A few common errors for confd
891
CONFD_ERROR_UNKNOWN_ENTRY = 1
892
CONFD_ERROR_INTERNAL = 2
893
CONFD_ERROR_ARGUMENT = 3
894

    
895
# Each request is "salted" by the current timestamp.
896
# This constants decides how many seconds of skew to accept.
897
# TODO: make this a default and allow the value to be more configurable
898
CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
899

    
900
# When we haven't reloaded the config for more than this amount of seconds, we
901
# force a test to see if inotify is betraying us.
902
CONFD_CONFIG_RELOAD_TIMEOUT = 60
903

    
904
# If we receive more than one update in this amount of seconds, we move to
905
# polling every RATELIMIT seconds, rather than relying on inotify, to be able
906
# to serve more requests.
907
CONFD_CONFIG_RELOAD_RATELIMIT = 2
908

    
909
# Magic number prepended to all confd queries.
910
# This allows us to distinguish different types of confd protocols and handle
911
# them. For example by changing this we can move the whole payload to be
912
# compressed, or move away from json.
913
CONFD_MAGIC_FOURCC = 'plj0'
914

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

    
920
# Timeout in seconds to expire pending query request in the confd client
921
# library. We don't actually expect any answer more than 10 seconds after we
922
# sent a request.
923
CONFD_CLIENT_EXPIRE_TIMEOUT = 10
924

    
925
# Maximum UDP datagram size.
926
# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
927
# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
928
#   (assuming we can't use jumbo frames)
929
# We just set this to 60K, which should be enough
930
MAX_UDP_DATA_SIZE = 61440
931

    
932
# User-id pool minimum/maximum acceptable user-ids.
933
UIDPOOL_UID_MIN = 0
934
UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids
935

    
936
# Name or path of the pgrep command
937
PGREP = "pgrep"