constants.py 54.9 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2 3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Module holding different constants."""

24 25
import re

26
from ganeti import _autoconf
27
from ganeti import _vcsversion
28

Iustin Pop's avatar
Iustin Pop committed
29
# various versions
30
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
Guido Trotter's avatar
Guido Trotter committed
31 32
OS_API_V10 = 10
OS_API_V15 = 15
33 34
OS_API_V20 = 20
OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
35
VCS_VERSION = _vcsversion.VCS_VERSION
Iustin Pop's avatar
Iustin Pop committed
36
EXPORT_VERSION = 0
37
RAPI_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
38

39

40 41 42 43 44 45 46 47
# Format for CONFIG_VERSION:
#   01 03 0123 = 01030123
#   ^^ ^^ ^^^^
#   |  |  + Configuration version/revision
#   |  + Minor version
#   + Major version
#
# It stored as an integer. Make sure not to write an octal number.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

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

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

  Returns: int representing version number

  """
  assert isinstance(major, int)
  assert isinstance(minor, int)
  assert isinstance(revision, int)
  return (1000000 * major +
            10000 * minor +
                1 * revision)


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

  Returns: tuple; (major, minor, revision)

  """
  assert isinstance(version, int)

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

  return (major, minor, revision)


82 83 84
CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
CONFIG_REVISION = 0
85
CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
Iustin Pop's avatar
Iustin Pop committed
86

87 88 89
#: RPC protocol version
PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)

90 91
# user separation
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
92
ADMIN_GROUP = _autoconf.ADMIN_GROUP
93
MASTERD_USER = _autoconf.MASTERD_USER
94
MASTERD_GROUP = _autoconf.MASTERD_GROUP
95
RAPI_USER = _autoconf.RAPI_USER
96 97 98 99
RAPI_GROUP = _autoconf.RAPI_GROUP
CONFD_USER = _autoconf.CONFD_USER
CONFD_GROUP = _autoconf.CONFD_GROUP
NODED_USER = _autoconf.NODED_USER
René Nussbaumer's avatar
René Nussbaumer committed
100
NODED_GROUP = _autoconf.NODED_GROUP
101

Tsachy Shacham's avatar
Tsachy Shacham committed
102 103 104 105 106
# cpu pinning separators and constants
CPU_PINNING_SEP = ":"
CPU_PINNING_ALL = "all"
# internal representation of "all"
CPU_PINNING_ALL_VAL = -1
107 108
# one "all" entry in a CPU list means CPU pinning is off
CPU_PINNING_OFF = [CPU_PINNING_ALL_VAL]
Tsachy Shacham's avatar
Tsachy Shacham committed
109 110 111 112 113 114 115 116 117

# A Xen-specific implementation detail - there is no way to actually say
# "use any cpu for pinning" in a Xen configuration file, as opposed to the
# command line, where you can say "xm vcpu-pin <domain> <vcpu> all".
# The workaround used in Xen is "0-63" (see source code function
# xm_vcpu_pin in <xen-source>/tools/python/xen/xm/main.py).
# To support future changes, the following constant is treated as a
# blackbox string that simply means use-any-cpu-for-pinning-under-xen.
CPU_PINNING_ALL_XEN = "0-63"
118

119 120 121 122 123
# A KVM-specific implementation detail - the following value is used
# to set CPU affinity to all processors (#0 through #31), per taskset
# man page.
CPU_PINNING_ALL_KVM = 0xFFFFFFFF

124
# Wipe
125
DD_CMD = "dd"
Michael Hanselmann's avatar
Michael Hanselmann committed
126
WIPE_BLOCK_SIZE = 1024 ** 2
127 128 129
MAX_WIPE_CHUNK = 1024 # 1GB
MIN_WIPE_CHUNK_PERCENT = 10

130

Iustin Pop's avatar
Iustin Pop committed
131
# file paths
132
DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
133
RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
134
RUN_GANETI_DIR = RUN_DIR + "/ganeti"
135
BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
136
DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
137
RUN_DIRS_MODE = 0775
Guido Trotter's avatar
Guido Trotter committed
138
SOCKET_DIR = RUN_GANETI_DIR + "/socket"
139
SECURE_DIR_MODE = 0700
140
SECURE_FILE_MODE = 0600
141
SOCKET_DIR_MODE = 0750
142
CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"
Guido Trotter's avatar
Guido Trotter committed
143
CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE
144 145
IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"
IMPORT_EXPORT_DIR_MODE = 0755
146
ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
147 148
# keep RUN_GANETI_DIR first here, to make sure all get created when the node
# daemon is started (this takes care of RUN_DIR being tmpfs)
Michael Hanselmann's avatar
Michael Hanselmann committed
149 150 151 152 153
SUB_RUN_DIRS = [
  RUN_GANETI_DIR,
  BDEV_CACHE_DIR,
  DISK_LINKS_DIR,
  ]
Iustin Pop's avatar
Iustin Pop committed
154
LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
155
SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
156 157 158
# User-id pool lock directory
# The user-ids that are in use have a corresponding lock file in this directory
UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"
Iustin Pop's avatar
Iustin Pop committed
159
CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
160
NODED_CERT_FILE = DATA_DIR + "/server.pem"
161
RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
162
CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
163 164
SPICE_CERT_FILE = DATA_DIR + "/spice.pem"
SPICE_CACERT_FILE = DATA_DIR + "/spice-ca.pem"
Michael Hanselmann's avatar
Michael Hanselmann committed
165
CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
166
INSTANCE_STATUS_FILE = RUN_GANETI_DIR + "/instance-status"
Iustin Pop's avatar
Iustin Pop committed
167
SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
168
RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
169
QUEUE_DIR = DATA_DIR + "/queue"
170
DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
171
SETUP_SSH = _autoconf.TOOLSDIR + "/setup-ssh"
172
KVM_IFUP = _autoconf.PKGLIBDIR + "/kvm-ifup"
173
KVM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/kvm-console-wrapper"
174
XM_CONSOLE_WRAPPER = _autoconf.PKGLIBDIR + "/tools/xm-console-wrapper"
175
ETC_HOSTS = "/etc/hosts"
176
DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
177
DEFAULT_SHARED_FILE_STORAGE_DIR = _autoconf.SHARED_FILE_STORAGE_DIR
178
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
179
ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
180
SYSCONFDIR = _autoconf.SYSCONFDIR
181
TOOLSDIR = _autoconf.TOOLSDIR
182
CONF_DIR = SYSCONFDIR + "/ganeti"
183
USER_SCRIPTS_DIR = CONF_DIR + "/scripts"
184
ENABLE_CONFD = _autoconf.ENABLE_CONFD
185

Michael Hanselmann's avatar
Michael Hanselmann committed
186 187 188 189 190 191 192
#: Lock file for watcher, locked in shared mode by watcher; lock in exclusive
# mode to block watcher (see L{cli._RunWhileClusterStoppedHelper.Call}
WATCHER_LOCK_FILE = LOCK_DIR + "/ganeti-watcher.lock"

#: Status file for per-group watcher, locked in exclusive mode by watcher
WATCHER_GROUP_STATE_FILE = DATA_DIR + "/watcher.%s.data"

193 194 195 196
#: File for per-group instance status, merged into L{INSTANCE_STATUS_FILE} by
#: per-group processes
WATCHER_GROUP_INSTANCE_STATUS_FILE = DATA_DIR + "/watcher.%s.instance-status"

Michael Hanselmann's avatar
Michael Hanselmann committed
197 198 199
#: File containing Unix timestamp until which watcher should be paused
WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"

200 201 202 203
# Master IP address setup scripts paths (default and user-provided)
DEFAULT_MASTER_SETUP_SCRIPT = TOOLSDIR + "/master-ip-setup"
EXTERNAL_MASTER_SETUP_SCRIPT = USER_SCRIPTS_DIR + "/master-ip-setup"

204 205 206 207 208 209
ALL_CERT_FILES = frozenset([
  NODED_CERT_FILE,
  RAPI_CERT_FILE,
  SPICE_CERT_FILE,
  SPICE_CACERT_FILE,
  ])
210

211
MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
212

213
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
214
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
215
RAPI = "ganeti-rapi"
216
MASTERD = "ganeti-masterd"
Guido Trotter's avatar
Guido Trotter committed
217 218
# used in the ganeti-nbma project
NLD = "ganeti-nld"
219 220 221 222

DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
223
  CONFD: ("udp", 1814),
Guido Trotter's avatar
Guido Trotter committed
224
  RAPI: ("tcp", 5080),
225
  "ssh": ("tcp", 22),
Guido Trotter's avatar
Guido Trotter committed
226 227
  # used in the ganeti-nbma project
  NLD: ("udp", 1816),
228 229
}
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
230
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
Guido Trotter's avatar
Guido Trotter committed
231
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
Guido Trotter's avatar
Guido Trotter committed
232 233
# used in the ganeti-nbma project
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
234

Iustin Pop's avatar
Iustin Pop committed
235 236
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999
237
MASTER_SCRIPT = "ganeti-master"
Iustin Pop's avatar
Iustin Pop committed
238

239
LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
240
DAEMONS_LOGFILES = {
Michael Hanselmann's avatar
Michael Hanselmann committed
241 242 243 244 245
  # "daemon-name": "logfile"
  NODED: LOG_DIR + "node-daemon.log",
  CONFD: LOG_DIR + "conf-daemon.log",
  RAPI: LOG_DIR + "rapi-daemon.log",
  MASTERD: LOG_DIR + "master-daemon.log",
Guido Trotter's avatar
Guido Trotter committed
246 247
  # used in the ganeti-nbma project
  NLD: LOG_DIR + "nl-daemon.log",
Michael Hanselmann's avatar
Michael Hanselmann committed
248
  }
Michael Hanselmann's avatar
Michael Hanselmann committed
249

250 251 252
LOG_OS_DIR = LOG_DIR + "os"
LOG_WATCHER = LOG_DIR + "watcher.log"
LOG_COMMANDS = LOG_DIR + "commands.log"
Iustin Pop's avatar
Iustin Pop committed
253
LOG_BURNIN = LOG_DIR + "burnin.log"
254
LOG_SETUP_SSH = LOG_DIR + "setup-ssh.log"
Iustin Pop's avatar
Iustin Pop committed
255

Luca Bigliardi's avatar
Luca Bigliardi committed
256 257
DEV_CONSOLE = "/dev/console"

Balazs Lecz's avatar
Balazs Lecz committed
258 259
PROC_MOUNTS = "/proc/mounts"

260
# Local UniX Interface related constants
261
LUXI_EOM = "\3"
262
LUXI_VERSION = CONFIG_VERSION
263

Iustin Pop's avatar
Iustin Pop committed
264
# one of "no", "yes", "only"
265 266 267 268 269 270
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

271
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
272
EXPORT_DIR = _autoconf.EXPORT_DIR
Iustin Pop's avatar
Iustin Pop committed
273 274 275

EXPORT_CONF_FILE = "config.ini"

276
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
277 278
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD
279
XEN_CMD = "xm"
280

281
KVM_PATH = _autoconf.KVM_PATH
Guido Trotter's avatar
Guido Trotter committed
282
SOCAT_PATH = _autoconf.SOCAT_PATH
283
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
284
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
285
SOCAT_ESCAPE_CODE = "0x1d"
286

287 288 289 290 291 292
#: Console as SSH command
CONS_SSH = "ssh"

#: Console as VNC server
CONS_VNC = "vnc"

293 294 295
#: Console as SPICE server
CONS_SPICE = "spice"

296 297 298 299
#: Display a message for console access
CONS_MESSAGE = "msg"

#: All console types
300
CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_SPICE, CONS_MESSAGE])
301

302 303 304 305 306
# For RSA keys more bits are better, but they also make operations more
# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
# 2010 on.
RSA_KEY_BITS = 2048

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

315 316 317
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
X509_CERT_SIGN_DIGEST = "SHA1"

318 319 320 321 322 323
# Default validity of certificates in days
X509_CERT_DEFAULT_VALIDITY = 365 * 5

# commonName (CN) used in certificates
X509_CERT_CN = "ganeti.example.com"

324 325
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

326 327 328 329 330 331
IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"

# Import/export daemon mode
IEM_IMPORT = "import"
IEM_EXPORT = "export"

332 333 334 335 336 337 338 339
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
IEC_ALL = frozenset([
  IEC_NONE,
  IEC_GZIP,
  ])

340 341
IE_CUSTOM_SIZE = "fd"

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

344 345 346 347 348 349 350 351
# Import/export I/O
# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
IEIO_FILE = "file"
# Raw block device I/O using "dd"
IEIO_RAW_DISK = "raw"
# OS definition import/export script
IEIO_SCRIPT = "script"

352
VALUE_DEFAULT = "default"
353 354
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
355
VALUE_NONE = "none"
356 357
VALUE_TRUE = "true"
VALUE_FALSE = "false"
358

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

Iustin Pop's avatar
Iustin Pop committed
362
# hooks-related constants
363
HOOKS_BASE_DIR = CONF_DIR + "/hooks"
Iustin Pop's avatar
Iustin Pop committed
364 365
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
366
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
367
HOOKS_NAME_WATCHER = "watcher"
368
HOOKS_VERSION = 2
369
HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
Iustin Pop's avatar
Iustin Pop committed
370 371 372 373

# hooks subject type (what object type does the LU deal with)
HTYPE_CLUSTER = "CLUSTER"
HTYPE_NODE = "NODE"
374
HTYPE_GROUP = "GROUP"
Iustin Pop's avatar
Iustin Pop committed
375 376 377 378 379 380
HTYPE_INSTANCE = "INSTANCE"

HKR_SKIP = 0
HKR_FAIL = 1
HKR_SUCCESS = 2

381 382 383 384
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
385 386

# Storage fields
387 388 389 390
# first two are valid in LU context only, not passed to backend
SF_NODE = "node"
SF_TYPE = "type"
# and the rest are valid in backend
391 392 393 394 395 396
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

397 398 399
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

400
# Available fields per storage type
Stephen Shirley's avatar
Stephen Shirley committed
401 402 403 404 405 406 407 408
VALID_STORAGE_FIELDS = frozenset([
  SF_NAME,
  SF_TYPE,
  SF_SIZE,
  SF_USED,
  SF_FREE,
  SF_ALLOCATABLE
  ])
409 410

VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
Iustin Pop's avatar
Iustin Pop committed
411

412 413 414 415
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

416
VALID_STORAGE_OPERATIONS = {
417
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
418 419
  }

420 421 422 423 424 425
# Local disk status
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
(LDS_OKAY,
 LDS_UNKNOWN,
 LDS_FAULTY) = range(1, 4)

Iustin Pop's avatar
Iustin Pop committed
426 427 428
# disk template types
DT_DISKLESS = "diskless"
DT_PLAIN = "plain"
429
DT_DRBD8 = "drbd"
430
DT_FILE = "file"
431
DT_SHARED_FILE = "sharedfile"
432
DT_BLOCK = "blockdev"
433
DT_RBD = "rbd"
434 435

# the set of network-mirrored disk templates
436
DTS_INT_MIRROR = frozenset([DT_DRBD8])
Iustin Pop's avatar
Iustin Pop committed
437

438
# the set of externally-mirrored disk templates (e.g. SAN, NAS)
439
DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK, DT_RBD])
440

441
# the set of non-lvm-based disk templates
442 443
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE,
                         DT_BLOCK, DT_RBD])
444

445
# the set of disk templates which can be grown
446
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE, DT_RBD])
447

448
# the set of disk templates that allow adoption
449 450 451 452
DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])

# the set of disk templates that *must* use adoption
DTS_MUST_ADOPT = frozenset([DT_BLOCK])
453

454
# the set of disk templates that allow migrations
455
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
456

Guido Trotter's avatar
Guido Trotter committed
457 458
# the set of file based disk templates
DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
459

460 461
# logical disk types
LD_LV = "lvm"
462
LD_DRBD8 = "drbd8"
463
LD_FILE = "file"
464
LD_BLOCKDEV = "blockdev"
465
LD_RBD = "rbd"
466 467 468 469 470
LOGICAL_DISK_TYPES = frozenset([
  LD_LV,
  LD_DRBD8,
  LD_FILE,
  LD_BLOCKDEV,
471
  LD_RBD,
472 473
  ])

474
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV, LD_RBD])
475

Iustin Pop's avatar
Iustin Pop committed
476 477
# drbd constants
DRBD_HMAC_ALG = "md5"
478
DRBD_NET_PROTOCOL = "C"
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

# drbd barrier types
DRBD_B_NONE = "n"
DRBD_B_DISK_BARRIERS = "b"
DRBD_B_DISK_DRAIN = "d"
DRBD_B_DISK_FLUSH = "f"

# Valid barrier combinations: "n" or any non-null subset of "bfd"
DRBD_VALID_BARRIER_OPT = frozenset([
  frozenset([DRBD_B_NONE]),
  frozenset([DRBD_B_DISK_BARRIERS]),
  frozenset([DRBD_B_DISK_DRAIN]),
  frozenset([DRBD_B_DISK_FLUSH]),
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_DRAIN]),
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH]),
  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH, DRBD_B_DISK_DRAIN]),
  ])
Iustin Pop's avatar
Iustin Pop committed
498

499 500 501
# rbd tool command
RBD_CMD = "rbd"

502 503 504
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
505 506

# the set of drbd-like disk types
507
LDS_DRBD = frozenset([LD_DRBD8])
508

509
# disk access mode
510 511
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
512 513
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

514
# disk replacement mode
515 516 517
REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
518
REPLACE_DISK_AUTO = "replace_auto"
519 520 521 522 523 524
REPLACE_MODES = frozenset([
  REPLACE_DISK_PRI,
  REPLACE_DISK_SEC,
  REPLACE_DISK_CHG,
  REPLACE_DISK_AUTO,
  ])
525

526 527 528 529 530 531 532 533
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
EXPORT_MODES = frozenset([
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

534
# Lock recalculate mode
Iustin Pop's avatar
Iustin Pop committed
535 536
LOCKS_REPLACE = "replace"
LOCKS_APPEND = "append"
537

538 539 540 541 542 543 544 545
# Lock timeout (sum) before we should go into blocking acquire (still
# can be reset by priority change); computed as max time (10 hours)
# before we should actually go into blocking acquire given that we
# start from default priority level; in seconds
LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
LOCK_ATTEMPTS_MAXWAIT = 15.0
LOCK_ATTEMPTS_MINWAIT = 1.0

546
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
547 548
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
549 550 551 552 553 554
INSTANCE_REMOTE_IMPORT = "remote-import"
INSTANCE_CREATE_MODES = frozenset([
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
555

556 557 558 559 560 561 562
# Remote import/export handshake message and version
RIE_VERSION = 0
RIE_HANDSHAKE = "Hi, I'm Ganeti"

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

563
# Overall timeout for establishing connection
564
RIE_CONNECT_TIMEOUT = 180
565

566 567 568 569 570 571
# Export only: how long to wait per connection attempt (seconds)
RIE_CONNECT_ATTEMPT_TIMEOUT = 20

# Export only: number of attempts to connect
RIE_CONNECT_RETRIES = 10

René Nussbaumer's avatar
René Nussbaumer committed
572 573
#: Give child process up to 5 seconds to exit after sending a signal
CHILD_LINGER_TIMEOUT = 5.0
574

Stephen Shirley's avatar
Stephen Shirley committed
575 576 577 578 579 580
DISK_TEMPLATES = frozenset([
  DT_DISKLESS,
  DT_PLAIN,
  DT_DRBD8,
  DT_FILE,
  DT_SHARED_FILE,
581 582
  DT_BLOCK,
  DT_RBD
Stephen Shirley's avatar
Stephen Shirley committed
583
  ])
584 585

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
586 587 588 589

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
590 591
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
592
INISECT_OSP = "os"
593

594
# dynamic device modification
595
DDM_ADD = "add"
596
DDM_MODIFY = "modify"
597 598
DDM_REMOVE = "remove"
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
599 600 601 602
DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
  DDM_MODIFY,
  ]))
# TODO: DDM_SWAP, DDM_MOVE?
603

604
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
605
EXIT_SUCCESS = 0
606
EXIT_FAILURE = 1
607
EXIT_NOTCLUSTER = 5
608
EXIT_NOTMASTER = 11
609
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
610
EXIT_CONFIRMATION = 13 # need user confirmation
611

612 613 614
#: Exit code for query operations with unknown fields
EXIT_UNKNOWN_FIELD = 14

615 616
# tags
TAG_CLUSTER = "cluster"
617
TAG_NODEGROUP = "nodegroup"
618 619
TAG_NODE = "node"
TAG_INSTANCE = "instance"
620 621
VALID_TAG_TYPES = frozenset([
  TAG_CLUSTER,
622
  TAG_NODEGROUP,
623 624 625
  TAG_NODE,
  TAG_INSTANCE,
  ])
626 627 628
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

629 630
# others
DEFAULT_BRIDGE = "xen-br0"
631
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
632 633
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
IP4_ADDRESS_ANY = "0.0.0.0"
Manuel Franceschini's avatar
Manuel Franceschini committed
634 635
IP6_ADDRESS_LOCALHOST = "::1"
IP6_ADDRESS_ANY = "::"
636 637
IP4_VERSION = 4
IP6_VERSION = 6
638
VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
639
TCP_PING_TIMEOUT = 10
640
GANETI_RUNAS = "root"
641
DEFAULT_VG = "xenvg"
642
DEFAULT_DRBD_HELPER = "/bin/true"
643
MIN_VG_SIZE = 20480
644
DEFAULT_MAC_PREFIX = "aa:00:00"
645 646
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
647
NODE_MAX_CLOCK_SKEW = 150
648
# Time for an intra-cluster disk transfer to wait for a connection
649
DISK_TRANSFER_CONNECT_TIMEOUT = 60
650 651
# Disk index separator
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
652
IP_COMMAND_PATH = _autoconf.IP_PATH
653

654 655 656
#: Key for job IDs in opcode result
JOB_IDS_KEY = "jobs"

657 658 659 660 661 662 663
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

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

664 665 666 667
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

668
# os related constants
Iustin Pop's avatar
Iustin Pop committed
669 670 671 672 673
OS_SCRIPT_CREATE = "create"
OS_SCRIPT_IMPORT = "import"
OS_SCRIPT_EXPORT = "export"
OS_SCRIPT_RENAME = "rename"
OS_SCRIPT_VERIFY = "verify"
Stephen Shirley's avatar
Stephen Shirley committed
674 675 676 677 678 679 680
OS_SCRIPTS = frozenset([
  OS_SCRIPT_CREATE,
  OS_SCRIPT_IMPORT,
  OS_SCRIPT_EXPORT,
  OS_SCRIPT_RENAME,
  OS_SCRIPT_VERIFY
  ])
681

Iustin Pop's avatar
Iustin Pop committed
682 683 684
OS_API_FILE = "ganeti_api_version"
OS_VARIANTS_FILE = "variants.list"
OS_PARAMETERS_FILE = "parameters.list"
685

Iustin Pop's avatar
Iustin Pop committed
686
OS_VALIDATE_PARAMETERS = "parameters"
687
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
688

689
# ssh constants
690 691
SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
692
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
693
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
694
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
695 696
SSH = "ssh"
SCP = "scp"
697 698 699 700 701

# reboot types
INSTANCE_REBOOT_SOFT = "soft"
INSTANCE_REBOOT_HARD = "hard"
INSTANCE_REBOOT_FULL = "full"
702

703 704 705 706 707 708 709 710 711 712 713 714 715 716
REBOOT_TYPES = frozenset([
  INSTANCE_REBOOT_SOFT,
  INSTANCE_REBOOT_HARD,
  INSTANCE_REBOOT_FULL
  ])

# instance reboot behaviors
INSTANCE_REBOOT_ALLOWED = "reboot"
INSTANCE_REBOOT_EXIT = "exit"

REBOOT_BEHAVIORS = frozenset([
  INSTANCE_REBOOT_ALLOWED,
  INSTANCE_REBOOT_EXIT
  ])
717

Iustin Pop's avatar
Iustin Pop committed
718
VTYPE_STRING = "string"
719
VTYPE_MAYBE_STRING = "maybe-string"
Iustin Pop's avatar
Iustin Pop committed
720 721 722
VTYPE_BOOL = "bool"
VTYPE_SIZE = "size" # size, in MiBs
VTYPE_INT = "int"
723
ENFORCEABLE_TYPES = frozenset([
Stephen Shirley's avatar
Stephen Shirley committed
724 725 726 727 728 729
  VTYPE_STRING,
  VTYPE_MAYBE_STRING,
  VTYPE_BOOL,
  VTYPE_SIZE,
  VTYPE_INT,
  ])
730

731 732 733
# Constant representing that the user does not specify any IP version
IFACE_NO_IP_VERSION_SPECIFIED = 0

734 735 736
# HV parameter names (global namespace)
HV_BOOT_ORDER = "boot_order"
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
737 738
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
739 740
HV_NIC_TYPE = "nic_type"
HV_DISK_TYPE = "disk_type"
741
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
742
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
743
HV_VNC_PASSWORD_FILE = "vnc_password_file"
744 745 746
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
747 748
HV_KVM_SPICE_BIND = "spice_bind"
HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
749
HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
750 751 752 753 754
HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
755
HV_KVM_SPICE_USE_TLS = "spice_use_tls"
756 757
HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
758 759
HV_ACPI = "acpi"
HV_PAE = "pae"
760 761 762
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
763
HV_KERNEL_ARGS = "kernel_args"
764 765
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
766
HV_ROOT_PATH = "root_path"
767
HV_SERIAL_CONSOLE = "serial_console"
768
HV_USB_MOUSE = "usb_mouse"
769
HV_KEYMAP = "keymap"
770
HV_DEVICE_MODEL = "device_model"
771
HV_INIT_SCRIPT = "init_script"
772
HV_MIGRATION_PORT = "migration_port"
773 774
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
775
HV_MIGRATION_MODE = "migration_mode"
776
HV_USE_LOCALTIME = "use_localtime"
777
HV_DISK_CACHE = "disk_cache"
778 779
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
780
HV_KVM_FLAG = "kvm_flag"
781
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
782
HV_KVM_USE_CHROOT = "use_chroot"
783
HV_CPU_MASK = "cpu_mask"
784
HV_MEM_PATH = "mem_path"
785
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
786
HV_REBOOT_BEHAVIOR = "reboot_behavior"
787

788 789
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
790
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
791
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
792
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
793 794
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
795
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
796
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
797 798 799 800
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
  HV_VNC_TLS: VTYPE_BOOL,
  HV_VNC_X509: VTYPE_STRING,
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
801 802
  HV_KVM_SPICE_BIND: VTYPE_STRING,
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
803
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
804 805 806 807 808
  HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
  HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
  HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
  HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
  HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
809
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
810 811
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
812 813
  HV_ACPI: VTYPE_BOOL,
  HV_PAE: VTYPE_BOOL,
814 815 816
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
817
  HV_KERNEL_PATH: VTYPE_STRING,
818
  HV_KERNEL_ARGS: VTYPE_STRING,
819
  HV_INITRD_PATH: VTYPE_STRING,
820
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
821 822
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
823
  HV_KEYMAP: VTYPE_STRING,
824
  HV_DEVICE_MODEL: VTYPE_STRING,
825
  HV_INIT_SCRIPT: VTYPE_STRING,
826
  HV_MIGRATION_PORT: VTYPE_INT,
827 828
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
829
  HV_MIGRATION_MODE: VTYPE_STRING,
830
  HV_USE_LOCALTIME: VTYPE_BOOL,
831
  HV_DISK_CACHE: VTYPE_STRING,
832 833
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
834
  HV_KVM_FLAG: VTYPE_STRING,
835
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
836
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
837
  HV_CPU_MASK: VTYPE_STRING,
838
  HV_MEM_PATH: VTYPE_STRING,
839
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
840
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
841 842 843
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
844

845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
# Migration statuses
HV_MIGRATION_COMPLETED = "completed"
HV_MIGRATION_ACTIVE = "active"
HV_MIGRATION_FAILED = "failed"
HV_MIGRATION_CANCELLED = "cancelled"

HV_MIGRATION_VALID_STATUSES = frozenset([
  HV_MIGRATION_COMPLETED,
  HV_MIGRATION_ACTIVE,
  HV_MIGRATION_FAILED,
  HV_MIGRATION_CANCELLED,
  ])

HV_MIGRATION_FAILED_STATUSES = frozenset([
  HV_MIGRATION_FAILED,
  HV_MIGRATION_CANCELLED,
  ])

# KVM-specific statuses
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES

866 867 868
# Node info keys
HV_NODEINFO_KEY_VERSION = "hv_version"

869 870 871 872 873 874 875
# Hypervisor state
HVST_MEMORY_TOTAL = "mem_total"
HVST_MEMORY_NODE = "mem_node"
HVST_MEMORY_HV = "mem_hv"
HVST_CPU_TOTAL = "cpu_total"
HVST_CPU_NODE = "cpu_node"

876 877 878 879 880 881 882 883
HVST_DEFAULTS = {
  HVST_MEMORY_TOTAL: 0,
  HVST_MEMORY_NODE: 0,
  HVST_MEMORY_HV: 0,
  HVST_CPU_TOTAL: 1,
  HVST_CPU_NODE: 1,
  }

884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
HVSTS_PARAMETER_TYPES = {
  HVST_MEMORY_TOTAL: VTYPE_INT,
  HVST_MEMORY_NODE: VTYPE_INT,
  HVST_MEMORY_HV: VTYPE_INT,
  HVST_CPU_TOTAL: VTYPE_INT,
  HVST_CPU_NODE: VTYPE_INT,
  }

HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())

# Disk state
DS_DISK_TOTAL = "disk_total"
DS_DISK_RESERVED = "disk_reserved"
DS_DISK_OVERHEAD = "disk_overhead"

899 900 901 902 903 904
DS_DEFAULTS = {
  DS_DISK_TOTAL: 0,
  DS_DISK_RESERVED: 0,
  DS_DISK_OVERHEAD: 0,
  }

905 906 907 908 909 910 911
DSS_PARAMETER_TYPES = {
  DS_DISK_TOTAL: VTYPE_INT,
  DS_DISK_RESERVED: VTYPE_INT,
  DS_DISK_OVERHEAD: VTYPE_INT,
  }

DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
912
DS_VALID_TYPES = frozenset([LD_LV])
913

914
# Backend parameter names
915 916 917
BE_MEMORY = "memory" # deprecated and replaced by max and min mem
BE_MAXMEM = "maxmem"
BE_MINMEM = "minmem"
918
BE_VCPUS = "vcpus"
919
BE_AUTO_BALANCE = "auto_balance"
920
BE_ALWAYS_FAILOVER = "always_failover"
921
BE_SPINDLE_USE = "spindle_use"
922

923
BES_PARAMETER_TYPES = {
924 925 926 927
  BE_MAXMEM: VTYPE_SIZE,
  BE_MINMEM: VTYPE_SIZE,
  BE_VCPUS: VTYPE_INT,
  BE_AUTO_BALANCE: VTYPE_BOOL,
928
  BE_ALWAYS_FAILOVER: VTYPE_BOOL,
929
  BE_SPINDLE_USE: VTYPE_INT,
930
  }
931

932 933 934 935 936
BES_PARAMETER_COMPAT = {
  BE_MEMORY: VTYPE_SIZE,
  }
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)

937
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
Iustin Pop's avatar
Iustin Pop committed
938

939
# instance specs
940 941 942 943 944
ISPEC_MEM_SIZE = "memory-size"
ISPEC_CPU_COUNT = "cpu-count"
ISPEC_DISK_COUNT = "disk-count"
ISPEC_DISK_SIZE = "disk-size"
ISPEC_NIC_COUNT =