constants.py 55 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
import re
25
import socket
26

27
from ganeti import _autoconf
28
from ganeti import _vcsversion
29
from ganeti import pathutils
30

31

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

42

43 44 45 46 47 48 49
# Format for CONFIG_VERSION:
#   01 03 0123 = 01030123
#   ^^ ^^ ^^^^
#   |  |  + Configuration version/revision
#   |  + Minor version
#   + Major version
#
50
# It is stored as an integer. Make sure not to write an octal number.
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 82 83 84

# 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)


85 86 87
CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
CONFIG_REVISION = 0
88
CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
Iustin Pop's avatar
Iustin Pop committed
89

90 91 92
#: RPC protocol version
PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)

93 94
# user separation
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
95
ADMIN_GROUP = _autoconf.ADMIN_GROUP
96
MASTERD_USER = _autoconf.MASTERD_USER
97
MASTERD_GROUP = _autoconf.MASTERD_GROUP
98
RAPI_USER = _autoconf.RAPI_USER
99 100 101 102
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
103
NODED_GROUP = _autoconf.NODED_GROUP
Michael Hanselmann's avatar
Michael Hanselmann committed
104 105
SSH_LOGIN_USER = _autoconf.SSH_LOGIN_USER
SSH_CONSOLE_USER = _autoconf.SSH_CONSOLE_USER
106

Tsachy Shacham's avatar
Tsachy Shacham committed
107 108 109 110 111
# cpu pinning separators and constants
CPU_PINNING_SEP = ":"
CPU_PINNING_ALL = "all"
# internal representation of "all"
CPU_PINNING_ALL_VAL = -1
112 113
# 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
114 115 116 117 118 119 120 121 122

# 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"
123

124 125 126
# A KVM-specific implementation detail - the following value is used
# to set CPU affinity to all processors (#0 through #31), per taskset
# man page.
127
# FIXME: This only works for machines with up to 32 CPU cores
128 129
CPU_PINNING_ALL_KVM = 0xFFFFFFFF

130
# Wipe
131
DD_CMD = "dd"
132 133 134
MAX_WIPE_CHUNK = 1024 # 1GB
MIN_WIPE_CHUNK_PERCENT = 10

135
RUN_DIRS_MODE = 0775
136
SECURE_DIR_MODE = 0700
137
SECURE_FILE_MODE = 0600
138
ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
139
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
140
ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
141
ENABLE_CONFD = _autoconf.ENABLE_CONFD
142
ENABLE_SPLIT_QUERY = _autoconf.ENABLE_SPLIT_QUERY
143
ENABLE_RESTRICTED_COMMANDS = _autoconf.ENABLE_RESTRICTED_COMMANDS
144

145
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
146
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
147
RAPI = "ganeti-rapi"
148
MASTERD = "ganeti-masterd"
149 150 151 152

DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
153
  CONFD: ("udp", 1814),
Guido Trotter's avatar
Guido Trotter committed
154
  RAPI: ("tcp", 5080),
155
  "ssh": ("tcp", 22),
156 157
}
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
158
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
Guido Trotter's avatar
Guido Trotter committed
159
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
160

Iustin Pop's avatar
Iustin Pop committed
161 162 163
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999

164 165 166 167 168 169 170
DAEMONS_LOGFILES = {
  NODED: pathutils.GetLogFilename("node-daemon"),
  CONFD: pathutils.GetLogFilename("conf-daemon"),
  RAPI: pathutils.GetLogFilename("rapi-daemon"),
  MASTERD: pathutils.GetLogFilename("master-daemon"),
  }

Luca Bigliardi's avatar
Luca Bigliardi committed
171 172
DEV_CONSOLE = "/dev/console"

Balazs Lecz's avatar
Balazs Lecz committed
173 174
PROC_MOUNTS = "/proc/mounts"

175
# Local UniX Interface related constants
176
LUXI_EOM = "\3"
177
LUXI_VERSION = CONFIG_VERSION
178

Iustin Pop's avatar
Iustin Pop committed
179
# one of "no", "yes", "only"
180 181 182 183 184 185
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

Iustin Pop's avatar
Iustin Pop committed
186 187
EXPORT_CONF_FILE = "config.ini"

188
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
189 190
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD
191 192 193 194
XEN_CMD_XM = "xm"
XEN_CMD_XL = "xl"
# FIXME: This will be made configurable using hvparams in Ganeti 2.7
XEN_CMD = _autoconf.XEN_CMD
Guido Trotter's avatar
Guido Trotter committed
195 196 197 198 199
# When the Xen toolstack used is "xl", live migration requires the source host
# to connect to the target host via ssh (xl runs this command). We need to pass
# the command xl runs some extra info so that it can use Ganeti's key
# verification and not fail. Note that this string is incomplete: it must be
# filled with the cluster name before being used.
200
XL_SSH_CMD = ("ssh -l %s -oGlobalKnownHostsFile=%s"
Guido Trotter's avatar
Guido Trotter committed
201 202
              " -oUserKnownHostsFile=/dev/null"
              " -oCheckHostIp=no -oStrictHostKeyChecking=yes"
203 204
              " -oHostKeyAlias=%%s") % (SSH_LOGIN_USER,
                                        pathutils.SSH_KNOWN_HOSTS_FILE)
205

206
KVM_PATH = _autoconf.KVM_PATH
207
KVM_KERNEL = _autoconf.KVM_KERNEL
Guido Trotter's avatar
Guido Trotter committed
208
SOCAT_PATH = _autoconf.SOCAT_PATH
209
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
210
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
211
SOCAT_ESCAPE_CODE = "0x1d"
212

213 214 215 216 217 218
#: Console as SSH command
CONS_SSH = "ssh"

#: Console as VNC server
CONS_VNC = "vnc"

219 220 221
#: Console as SPICE server
CONS_SPICE = "spice"

222 223 224 225
#: Display a message for console access
CONS_MESSAGE = "msg"

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

228 229 230 231 232
# 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

233 234 235
# 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
236
# modifying the ciphers, ensure not to accidentially add something after it's
237 238 239 240
# 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"

241 242 243
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
X509_CERT_SIGN_DIGEST = "SHA1"

244 245 246 247 248 249
# Default validity of certificates in days
X509_CERT_DEFAULT_VALIDITY = 365 * 5

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

250 251
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

252 253 254 255
# Import/export daemon mode
IEM_IMPORT = "import"
IEM_EXPORT = "export"

256 257 258 259 260 261 262 263
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
IEC_ALL = frozenset([
  IEC_NONE,
  IEC_GZIP,
  ])

264 265
IE_CUSTOM_SIZE = "fd"

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

268 269 270 271 272 273 274 275
# 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"

276
VALUE_DEFAULT = "default"
277 278
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
279
VALUE_NONE = "none"
280 281
VALUE_TRUE = "true"
VALUE_FALSE = "false"
282

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

Iustin Pop's avatar
Iustin Pop committed
286 287 288
# hooks-related constants
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
289
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
290
HOOKS_NAME_WATCHER = "watcher"
291
HOOKS_VERSION = 2
292
HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
Iustin Pop's avatar
Iustin Pop committed
293 294 295 296

# hooks subject type (what object type does the LU deal with)
HTYPE_CLUSTER = "CLUSTER"
HTYPE_NODE = "NODE"
297
HTYPE_GROUP = "GROUP"
Iustin Pop's avatar
Iustin Pop committed
298
HTYPE_INSTANCE = "INSTANCE"
299
HTYPE_NETWORK = "NETWORK"
Iustin Pop's avatar
Iustin Pop committed
300 301 302 303 304

HKR_SKIP = 0
HKR_FAIL = 1
HKR_SUCCESS = 2

305 306 307 308
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
309 310

# Storage fields
311 312 313 314
# 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
315 316 317 318 319 320
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

321 322 323
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

324
# Available fields per storage type
Stephen Shirley's avatar
Stephen Shirley committed
325 326 327 328 329 330
VALID_STORAGE_FIELDS = frozenset([
  SF_NAME,
  SF_TYPE,
  SF_SIZE,
  SF_USED,
  SF_FREE,
331
  SF_ALLOCATABLE,
Stephen Shirley's avatar
Stephen Shirley committed
332
  ])
333 334

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

336 337 338 339
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

340
VALID_STORAGE_OPERATIONS = {
341
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
342 343
  }

344 345 346 347 348 349
# 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
350 351 352
# disk template types
DT_DISKLESS = "diskless"
DT_PLAIN = "plain"
353
DT_DRBD8 = "drbd"
354
DT_FILE = "file"
355
DT_SHARED_FILE = "sharedfile"
356
DT_BLOCK = "blockdev"
357
DT_RBD = "rbd"
358 359

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

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

365
# the set of non-lvm-based disk templates
366 367
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE,
                         DT_BLOCK, DT_RBD])
368

369
# the set of disk templates which can be grown
370
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE, DT_RBD])
371

372
# the set of disk templates that allow adoption
373 374 375 376
DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])

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

378
# the set of disk templates that allow migrations
379
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
380

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

384 385
# logical disk types
LD_LV = "lvm"
386
LD_DRBD8 = "drbd8"
387
LD_FILE = "file"
388
LD_BLOCKDEV = "blockdev"
389
LD_RBD = "rbd"
390 391 392 393 394
LOGICAL_DISK_TYPES = frozenset([
  LD_LV,
  LD_DRBD8,
  LD_FILE,
  LD_BLOCKDEV,
395
  LD_RBD,
396 397
  ])

398
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV, LD_RBD])
399

Iustin Pop's avatar
Iustin Pop committed
400 401
# drbd constants
DRBD_HMAC_ALG = "md5"
402
DRBD_NET_PROTOCOL = "C"
403
DRBD_STATUS_FILE = "/proc/drbd"
404

405 406 407
#: Size of DRBD meta block device
DRBD_META_SIZE = 128

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
# 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_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
425

426 427 428
# rbd tool command
RBD_CMD = "rbd"

429 430 431
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
432 433

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

436
# disk access mode
437 438
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
439 440
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

441
# disk replacement mode
442 443 444
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
445
REPLACE_DISK_AUTO = "replace_auto"
446 447 448 449 450 451
REPLACE_MODES = frozenset([
  REPLACE_DISK_PRI,
  REPLACE_DISK_SEC,
  REPLACE_DISK_CHG,
  REPLACE_DISK_AUTO,
  ])
452

453 454 455 456 457 458 459 460
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
EXPORT_MODES = frozenset([
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

461
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
462 463
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
464 465 466 467 468 469
INSTANCE_REMOTE_IMPORT = "remote-import"
INSTANCE_CREATE_MODES = frozenset([
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
470

471 472 473 474 475 476 477
# 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

478
# Overall timeout for establishing connection
479
RIE_CONNECT_TIMEOUT = 180
480

481 482 483 484 485 486
# 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
487 488
#: Give child process up to 5 seconds to exit after sending a signal
CHILD_LINGER_TIMEOUT = 5.0
489

Stephen Shirley's avatar
Stephen Shirley committed
490 491 492 493 494 495
DISK_TEMPLATES = frozenset([
  DT_DISKLESS,
  DT_PLAIN,
  DT_DRBD8,
  DT_FILE,
  DT_SHARED_FILE,
496
  DT_BLOCK,
497
  DT_RBD,
Stephen Shirley's avatar
Stephen Shirley committed
498
  ])
499 500

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
501 502 503 504

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
505 506
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
507
INISECT_OSP = "os"
508

509
# dynamic device modification
510
DDM_ADD = "add"
511
DDM_MODIFY = "modify"
512 513
DDM_REMOVE = "remove"
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
514 515 516 517
DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
  DDM_MODIFY,
  ]))
# TODO: DDM_SWAP, DDM_MOVE?
518

519
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
520
EXIT_SUCCESS = 0
521
EXIT_FAILURE = 1
522
EXIT_NOTCLUSTER = 5
523
EXIT_NOTMASTER = 11
524
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
525
EXIT_CONFIRMATION = 13 # need user confirmation
526

527 528 529
#: Exit code for query operations with unknown fields
EXIT_UNKNOWN_FIELD = 14

530 531
# tags
TAG_CLUSTER = "cluster"
532
TAG_NODEGROUP = "nodegroup"
533 534
TAG_NODE = "node"
TAG_INSTANCE = "instance"
535
TAG_NETWORK = "network"
536 537
VALID_TAG_TYPES = frozenset([
  TAG_CLUSTER,
538
  TAG_NODEGROUP,
539 540
  TAG_NODE,
  TAG_INSTANCE,
541
  TAG_NETWORK,
542
  ])
543 544 545
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

546 547
# others
DEFAULT_BRIDGE = "xen-br0"
548
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
549 550
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
IP4_ADDRESS_ANY = "0.0.0.0"
Manuel Franceschini's avatar
Manuel Franceschini committed
551 552
IP6_ADDRESS_LOCALHOST = "::1"
IP6_ADDRESS_ANY = "::"
553 554
IP4_VERSION = 4
IP6_VERSION = 6
555
VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
556 557 558 559
# for export to htools
IP4_FAMILY = socket.AF_INET
IP6_FAMILY = socket.AF_INET6

560
TCP_PING_TIMEOUT = 10
561
DEFAULT_VG = "xenvg"
562
DEFAULT_DRBD_HELPER = "/bin/true"
563
MIN_VG_SIZE = 20480
564
DEFAULT_MAC_PREFIX = "aa:00:00"
565 566
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
567
NODE_MAX_CLOCK_SKEW = 150
568
# Time for an intra-cluster disk transfer to wait for a connection
569
DISK_TRANSFER_CONNECT_TIMEOUT = 60
570 571
# Disk index separator
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
572
IP_COMMAND_PATH = _autoconf.IP_PATH
573

574 575 576
#: Key for job IDs in opcode result
JOB_IDS_KEY = "jobs"

577 578 579 580 581 582 583
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

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

584 585 586 587
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

588 589 590 591 592 593 594 595 596 597 598
# Various time constants for the timeout table
RPC_TMO_URGENT = 60 # one minute
RPC_TMO_FAST = 5 * 60 # five minutes
RPC_TMO_NORMAL = 15 * 60 # 15 minutes
RPC_TMO_SLOW = 3600 # one hour
RPC_TMO_4HRS = 4 * 3600
RPC_TMO_1DAY = 86400

# Timeout for connecting to nodes (seconds)
RPC_CONNECT_TIMEOUT = 5

599
# os related constants
Iustin Pop's avatar
Iustin Pop committed
600 601 602 603 604
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
605 606 607 608 609
OS_SCRIPTS = frozenset([
  OS_SCRIPT_CREATE,
  OS_SCRIPT_IMPORT,
  OS_SCRIPT_EXPORT,
  OS_SCRIPT_RENAME,
610
  OS_SCRIPT_VERIFY,
Stephen Shirley's avatar
Stephen Shirley committed
611
  ])
612

Iustin Pop's avatar
Iustin Pop committed
613 614 615
OS_API_FILE = "ganeti_api_version"
OS_VARIANTS_FILE = "variants.list"
OS_PARAMETERS_FILE = "parameters.list"
616

Iustin Pop's avatar
Iustin Pop committed
617
OS_VALIDATE_PARAMETERS = "parameters"
618
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
619

620
# ssh constants
621 622
SSH = "ssh"
SCP = "scp"
623 624 625 626 627

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

629 630 631
REBOOT_TYPES = frozenset([
  INSTANCE_REBOOT_SOFT,
  INSTANCE_REBOOT_HARD,
632
  INSTANCE_REBOOT_FULL,
633 634 635 636 637 638 639 640
  ])

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

REBOOT_BEHAVIORS = frozenset([
  INSTANCE_REBOOT_ALLOWED,
641
  INSTANCE_REBOOT_EXIT,
642
  ])
643

Iustin Pop's avatar
Iustin Pop committed
644
VTYPE_STRING = "string"
645
VTYPE_MAYBE_STRING = "maybe-string"
Iustin Pop's avatar
Iustin Pop committed
646 647 648
VTYPE_BOOL = "bool"
VTYPE_SIZE = "size" # size, in MiBs
VTYPE_INT = "int"
649
ENFORCEABLE_TYPES = frozenset([
Stephen Shirley's avatar
Stephen Shirley committed
650 651 652 653 654 655
  VTYPE_STRING,
  VTYPE_MAYBE_STRING,
  VTYPE_BOOL,
  VTYPE_SIZE,
  VTYPE_INT,
  ])
656

657 658 659
# Constant representing that the user does not specify any IP version
IFACE_NO_IP_VERSION_SPECIFIED = 0

660 661 662
# HV parameter names (global namespace)
HV_BOOT_ORDER = "boot_order"
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
663 664
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
665 666
HV_NIC_TYPE = "nic_type"
HV_DISK_TYPE = "disk_type"
667
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
668
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
669
HV_VNC_PASSWORD_FILE = "vnc_password_file"
670 671 672
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
673 674
HV_KVM_SPICE_BIND = "spice_bind"
HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
675
HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
676 677 678 679 680
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"
681
HV_KVM_SPICE_USE_TLS = "spice_use_tls"
682 683
HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
684 685
HV_ACPI = "acpi"
HV_PAE = "pae"
686 687 688
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
689
HV_KERNEL_ARGS = "kernel_args"
690 691
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
692
HV_ROOT_PATH = "root_path"
693
HV_SERIAL_CONSOLE = "serial_console"
694
HV_USB_MOUSE = "usb_mouse"
695
HV_KEYMAP = "keymap"
696
HV_DEVICE_MODEL = "device_model"
697
HV_INIT_SCRIPT = "init_script"
698
HV_MIGRATION_PORT = "migration_port"
699 700
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
701
HV_MIGRATION_MODE = "migration_mode"
702
HV_USE_LOCALTIME = "use_localtime"
703
HV_DISK_CACHE = "disk_cache"
704 705
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
706
HV_KVM_FLAG = "kvm_flag"
707
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
708
HV_KVM_USE_CHROOT = "use_chroot"
709
HV_CPU_MASK = "cpu_mask"
710
HV_MEM_PATH = "mem_path"
Jack's avatar
Jack committed
711
HV_PASSTHROUGH = "pci_pass"
712
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
713
HV_REBOOT_BEHAVIOR = "reboot_behavior"
714
HV_CPU_TYPE = "cpu_type"
715 716 717
HV_CPU_CAP = "cpu_cap"
HV_CPU_WEIGHT = "cpu_weight"

718

719 720
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
721
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
722
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
723
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
724 725
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
726
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
727
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
728 729 730 731
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
  HV_VNC_TLS: VTYPE_BOOL,
  HV_VNC_X509: VTYPE_STRING,
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
732 733
  HV_KVM_SPICE_BIND: VTYPE_STRING,
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
734
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
735 736 737 738 739
  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,
740
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
741 742
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
743 744
  HV_ACPI: VTYPE_BOOL,
  HV_PAE: VTYPE_BOOL,
745 746 747
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
748
  HV_KERNEL_PATH: VTYPE_STRING,
749
  HV_KERNEL_ARGS: VTYPE_STRING,
750
  HV_INITRD_PATH: VTYPE_STRING,
751
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
752 753
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
754
  HV_KEYMAP: VTYPE_STRING,
755
  HV_DEVICE_MODEL: VTYPE_STRING,
756
  HV_INIT_SCRIPT: VTYPE_STRING,
757
  HV_MIGRATION_PORT: VTYPE_INT,
758 759
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
760
  HV_MIGRATION_MODE: VTYPE_STRING,
761
  HV_USE_LOCALTIME: VTYPE_BOOL,
762
  HV_DISK_CACHE: VTYPE_STRING,
763 764
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
765
  HV_KVM_FLAG: VTYPE_STRING,
766
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
767
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
768
  HV_CPU_MASK: VTYPE_STRING,
769
  HV_MEM_PATH: VTYPE_STRING,
Jack's avatar
Jack committed
770
  HV_PASSTHROUGH: VTYPE_STRING,
771
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
772
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
773
  HV_CPU_TYPE: VTYPE_STRING,
774 775
  HV_CPU_CAP: VTYPE_INT,
  HV_CPU_WEIGHT: VTYPE_INT,
776 777 778
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
779

780 781 782 783 784 785 786 787 788 789 790 791 792 793
HVS_PARAMETER_TITLES = {
  HV_ACPI: "ACPI",
  HV_BOOT_ORDER: "Boot_order",
  HV_CDROM_IMAGE_PATH: "CDROM_image_path",
  HV_DISK_TYPE: "Disk_type",
  HV_INITRD_PATH: "Initrd_path",
  HV_KERNEL_PATH: "Kernel_path",
  HV_NIC_TYPE: "NIC_type",
  HV_PAE: "PAE",
  HV_VNC_BIND_ADDRESS: "VNC_bind_address",
  HV_PASSTHROUGH: "pci_pass",
  HV_CPU_TYPE: "cpu_type",
  }

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
# 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

815 816 817
# Node info keys
HV_NODEINFO_KEY_VERSION = "hv_version"

818 819 820 821 822 823 824
# 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"

825 826 827 828 829 830 831 832
HVST_DEFAULTS = {
  HVST_MEMORY_TOTAL: 0,
  HVST_MEMORY_NODE: 0,
  HVST_MEMORY_HV: 0,
  HVST_CPU_TOTAL: 1,
  HVST_CPU_NODE: 1,
  }

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
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"

848 849 850 851 852 853
DS_DEFAULTS = {
  DS_DISK_TOTAL: 0,
  DS_DISK_RESERVED: 0,
  DS_DISK_OVERHEAD: 0,
  }

854 855 856 857 858 859 860
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())
861
DS_VALID_TYPES = frozenset([LD_LV])
862

863
# Backend parameter names
864 865 866
BE_MEMORY = "memory" # deprecated and replaced by max and min mem
BE_MAXMEM = "maxmem"
BE_MINMEM = "minmem"
867
BE_VCPUS = "vcpus"
868
BE_AUTO_BALANCE = "auto_balance"
869
BE_ALWAYS_FAILOVER = "always_failover"
870
BE_SPINDLE_USE = "spindle_use"
871

872
BES_PARAMETER_TYPES = {
873 874 875 876
  BE_MAXMEM: VTYPE_SIZE,
  BE_MINMEM: VTYPE_SIZE,
  BE_VCPUS: VTYPE_INT,
  BE_AUTO_BALANCE: VTYPE_BOOL,
877
  BE_ALWAYS_FAILOVER: VTYPE_BOOL,
878
  BE_SPINDLE_USE: VTYPE_INT,
879
  }
880

881 882 883 884 885 886 887
BES_PARAMETER_TITLES = {
  BE_AUTO_BALANCE: "Auto_balance",
  BE_MAXMEM: "ConfigMaxMem",
  BE_MINMEM: "ConfigMinMem",
  BE_VCPUS: "ConfigVCPUs",
  }

888 889 890 891 892
BES_PARAMETER_COMPAT = {
  BE_MEMORY: VTYPE_SIZE,
  }
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)

893
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
Iustin Pop's avatar
Iustin Pop committed
894

895
# instance specs
896 897 898 899 900
ISPEC_MEM_SIZE = "memory-size"
ISPEC_CPU_COUNT = "cpu-count"
ISPEC_DISK_COUNT = "disk-count"
ISPEC_DISK_SIZE = "disk-size"
ISPEC_NIC_COUNT = "nic-count"
901
ISPEC_SPINDLE_USE = "spindle-use"
902 903

ISPECS_PARAMETER_TYPES = {
904 905 906 907 908
  ISPEC_MEM_SIZE: VTYPE_INT,
  ISPEC_CPU_COUNT: VTYPE_INT,
  ISPEC_DISK_COUNT: VTYPE_INT,
  ISPEC_DISK_SIZE: VTYPE_INT,
  ISPEC_NIC_COUNT: VTYPE_INT,
909
  ISPEC_SPINDLE_USE: VTYPE_INT,
910 911 912 913
  }

ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())

914 915 916
ISPECS_MIN = "min"
ISPECS_MAX = "max"
ISPECS_STD = "std"
917 918
IPOLICY_DTS = "disk-templates"
IPOLICY_VCPU_RATIO = "vcpu-ratio"
919
IPOLICY_SPINDLE_RATIO = "spindle-ratio"
920

921
IPOLICY_ISPECS = frozenset([
922 923 924
  ISPECS_MIN,
  ISPECS_MAX,
  ISPECS_STD,
925
  ])
926 927 928

IPOLICY_PARAMETERS = frozenset([
  IPOLICY_VCPU_RATIO,
929
  IPOLICY_SPINDLE_RATIO,
930 931 932 933 934
  ])

IPOLICY_ALL_KEYS = (IPOLICY_ISPECS |
                    IPOLICY_PARAMETERS |
                    frozenset([IPOLICY_DTS]))
935

936 937
# Node parameter names
ND_OOB_PROGRAM = "oob_program"
938
ND_SPINDLE_COUNT = "spindle_count"
939
ND_EXCLUSIVE_STORAGE = "exclusive_storage"
940 941

NDS_PARAMETER_TYPES = {
942
  ND_OOB_PROGRAM: VTYPE_STRING,
943
  ND_SPINDLE_COUNT: VTYPE_INT,
944
  ND_EXCLUSIVE_STORAGE: VTYPE_BOOL,
945
  }
946 947 948

NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())

949 950 951
NDS_PARAMETER_TITLES = {
  ND_OOB_PROGRAM: "OutOfBandProgram",
  ND_SPINDLE_COUNT: "SpindleCount",
952
  ND_EXCLUSIVE_STORAGE: "ExclusiveStorage",
953 954
  }

955
# Logical Disks parameters
956 957 958 959
LDP_RESYNC_RATE = "resync-rate"
LDP_STRIPES = "stripes"
LDP_BARRIERS = "disabled-barriers"
LDP_NO_META_FLUSH = "disable-meta-flush"