code.grnet.gr Git - ganeti-local/blob - lib/constants.py

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 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 import socket
  26
  27 from ganeti import _autoconf
  28 from ganeti import _vcsversion
  29 from ganeti import compat
  30 from ganeti import pathutils
  31
  32
  33 # various versions
  34 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
  35 OS_API_V10 = 10
  36 OS_API_V15 = 15
  37 OS_API_V20 = 20
  38 OS_API_VERSIONS = compat.UniqueFrozenset([
  39   OS_API_V10,
  40   OS_API_V15,
  41   OS_API_V20,
  42   ])
  43 VCS_VERSION = _vcsversion.VCS_VERSION
  44 EXPORT_VERSION = 0
  45 RAPI_VERSION = 2
  46
  47
  48 # Format for CONFIG_VERSION:
  49 #   01 03 0123 = 01030123
  50 #   ^^ ^^ ^^^^
  51 #   |  |  + Configuration version/revision
  52 #   |  + Minor version
  53 #   + Major version
  54 #
  55 # It is stored as an integer. Make sure not to write an octal number.
  56
  57 # BuildVersion and SplitVersion must be in here because we can't import other
  58 # modules. The cfgupgrade tool must be able to read and write version numbers
  59 # and thus requires these functions. To avoid code duplication, they're kept in
  60 # here.
  61
  62 def BuildVersion(major, minor, revision):
  63   """Calculates int version number from major, minor and revision numbers.
  64
  65   Returns: int representing version number
  66
  67   """
  68   assert isinstance(major, int)
  69   assert isinstance(minor, int)
  70   assert isinstance(revision, int)
  71   return (1000000 * major +
  72             10000 * minor +
  73                 1 * revision)
  74
  75
  76 def SplitVersion(version):
  77   """Splits version number stored in an int.
  78
  79   Returns: tuple; (major, minor, revision)
  80
  81   """
  82   assert isinstance(version, int)
  83
  84   (major, remainder) = divmod(version, 1000000)
  85   (minor, revision) = divmod(remainder, 10000)
  86
  87   return (major, minor, revision)
  88
  89
  90 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
  91 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
  92 CONFIG_REVISION = 0
  93 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
  94
  95 #: RPC protocol version
  96 PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)
  97
  98 # user separation
  99 DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
 100 ADMIN_GROUP = _autoconf.ADMIN_GROUP
 101 MASTERD_USER = _autoconf.MASTERD_USER
 102 MASTERD_GROUP = _autoconf.MASTERD_GROUP
 103 RAPI_USER = _autoconf.RAPI_USER
 104 RAPI_GROUP = _autoconf.RAPI_GROUP
 105 CONFD_USER = _autoconf.CONFD_USER
 106 CONFD_GROUP = _autoconf.CONFD_GROUP
 107 NODED_USER = _autoconf.NODED_USER
 108 NODED_GROUP = _autoconf.NODED_GROUP
 109 SSH_LOGIN_USER = _autoconf.SSH_LOGIN_USER
 110 SSH_CONSOLE_USER = _autoconf.SSH_CONSOLE_USER
 111
 112 # cpu pinning separators and constants
 113 CPU_PINNING_SEP = ":"
 114 CPU_PINNING_ALL = "all"
 115 # internal representation of "all"
 116 CPU_PINNING_ALL_VAL = -1
 117 # one "all" entry in a CPU list means CPU pinning is off
 118 CPU_PINNING_OFF = [CPU_PINNING_ALL_VAL]
 119
 120 # A Xen-specific implementation detail - there is no way to actually say
 121 # "use any cpu for pinning" in a Xen configuration file, as opposed to the
 122 # command line, where you can say "xm vcpu-pin <domain> <vcpu> all".
 123 # The workaround used in Xen is "0-63" (see source code function
 124 # xm_vcpu_pin in <xen-source>/tools/python/xen/xm/main.py).
 125 # To support future changes, the following constant is treated as a
 126 # blackbox string that simply means use-any-cpu-for-pinning-under-xen.
 127 CPU_PINNING_ALL_XEN = "0-63"
 128
 129 # A KVM-specific implementation detail - the following value is used
 130 # to set CPU affinity to all processors (#0 through #31), per taskset
 131 # man page.
 132 # FIXME: This only works for machines with up to 32 CPU cores
 133 CPU_PINNING_ALL_KVM = 0xFFFFFFFF
 134
 135 # Wipe
 136 DD_CMD = "dd"
 137 MAX_WIPE_CHUNK = 1024 # 1GB
 138 MIN_WIPE_CHUNK_PERCENT = 10
 139
 140 RUN_DIRS_MODE = 0775
 141 SECURE_DIR_MODE = 0700
 142 SECURE_FILE_MODE = 0600
 143 ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
 144 ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
 145 ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
 146 ENABLE_CONFD = _autoconf.ENABLE_CONFD
 147 ENABLE_SPLIT_QUERY = _autoconf.ENABLE_SPLIT_QUERY
 148 ENABLE_RESTRICTED_COMMANDS = _autoconf.ENABLE_RESTRICTED_COMMANDS
 149
 150 NODED = "ganeti-noded"
 151 CONFD = "ganeti-confd"
 152 RAPI = "ganeti-rapi"
 153 MASTERD = "ganeti-masterd"
 154
 155 DAEMONS_PORTS = {
 156   # daemon-name: ("proto", "default-port")
 157   NODED: ("tcp", 1811),
 158   CONFD: ("udp", 1814),
 159   RAPI: ("tcp", 5080),
 160   "ssh": ("tcp", 22),
 161 }
 162 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
 163 DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
 164 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
 165
 166 FIRST_DRBD_PORT = 11000
 167 LAST_DRBD_PORT = 14999
 168
 169 DAEMONS_LOGFILES = {
 170   NODED: pathutils.GetLogFilename("node-daemon"),
 171   CONFD: pathutils.GetLogFilename("conf-daemon"),
 172   RAPI: pathutils.GetLogFilename("rapi-daemon"),
 173   MASTERD: pathutils.GetLogFilename("master-daemon"),
 174   }
 175
 176 DEV_CONSOLE = "/dev/console"
 177
 178 PROC_MOUNTS = "/proc/mounts"
 179
 180 # Local UniX Interface related constants
 181 LUXI_EOM = "\3"
 182 LUXI_VERSION = CONFIG_VERSION
 183
 184 # one of "no", "yes", "only"
 185 SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
 186 SYSLOG_NO = "no"
 187 SYSLOG_YES = "yes"
 188 SYSLOG_ONLY = "only"
 189 SYSLOG_SOCKET = "/dev/log"
 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 XEN_CMD_XM = "xm"
 197 XEN_CMD_XL = "xl"
 198 # FIXME: This will be made configurable using hvparams in Ganeti 2.7
 199 XEN_CMD = _autoconf.XEN_CMD
 200 # When the Xen toolstack used is "xl", live migration requires the source host
 201 # to connect to the target host via ssh (xl runs this command). We need to pass
 202 # the command xl runs some extra info so that it can use Ganeti's key
 203 # verification and not fail. Note that this string is incomplete: it must be
 204 # filled with the cluster name before being used.
 205 XL_SSH_CMD = ("ssh -l %s -oGlobalKnownHostsFile=%s"
 206               " -oUserKnownHostsFile=/dev/null"
 207               " -oCheckHostIp=no -oStrictHostKeyChecking=yes"
 208               " -oHostKeyAlias=%%s") % (SSH_LOGIN_USER,
 209                                         pathutils.SSH_KNOWN_HOSTS_FILE)
 210
 211 KVM_PATH = _autoconf.KVM_PATH
 212 KVM_KERNEL = _autoconf.KVM_KERNEL
 213 SOCAT_PATH = _autoconf.SOCAT_PATH
 214 SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
 215 SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
 216 SOCAT_ESCAPE_CODE = "0x1d"
 217
 218 #: Console as SSH command
 219 CONS_SSH = "ssh"
 220
 221 #: Console as VNC server
 222 CONS_VNC = "vnc"
 223
 224 #: Console as SPICE server
 225 CONS_SPICE = "spice"
 226
 227 #: Display a message for console access
 228 CONS_MESSAGE = "msg"
 229
 230 #: All console types
 231 CONS_ALL = compat.UniqueFrozenset([
 232   CONS_SSH,
 233   CONS_VNC,
 234   CONS_SPICE,
 235   CONS_MESSAGE,
 236   ])
 237
 238 # For RSA keys more bits are better, but they also make operations more
 239 # expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
 240 # 2010 on.
 241 RSA_KEY_BITS = 2048
 242
 243 # Ciphers allowed for SSL connections. For the format, see ciphers(1). A better
 244 # way to disable ciphers would be to use the exclamation mark (!), but socat
 245 # versions below 1.5 can't parse exclamation marks in options properly. When
 246 # modifying the ciphers, ensure not to accidentially add something after it's
 247 # been removed. Use the "openssl" utility to check the allowed ciphers, e.g.
 248 # "openssl ciphers -v HIGH:-DES".
 249 OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"
 250
 251 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
 252 X509_CERT_SIGN_DIGEST = "SHA1"
 253
 254 # Default validity of certificates in days
 255 X509_CERT_DEFAULT_VALIDITY = 365 * 5
 256
 257 # commonName (CN) used in certificates
 258 X509_CERT_CN = "ganeti.example.com"
 259
 260 X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"
 261
 262 # Import/export daemon mode
 263 IEM_IMPORT = "import"
 264 IEM_EXPORT = "export"
 265
 266 # Import/export transport compression
 267 IEC_NONE = "none"
 268 IEC_GZIP = "gzip"
 269 IEC_ALL = compat.UniqueFrozenset([
 270   IEC_NONE,
 271   IEC_GZIP,
 272   ])
 273
 274 IE_CUSTOM_SIZE = "fd"
 275
 276 IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")
 277
 278 # Import/export I/O
 279 # Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'
 280 IEIO_FILE = "file"
 281 # Raw block device I/O using "dd"
 282 IEIO_RAW_DISK = "raw"
 283 # OS definition import/export script
 284 IEIO_SCRIPT = "script"
 285
 286 VALUE_DEFAULT = "default"
 287 VALUE_AUTO = "auto"
 288 VALUE_GENERATE = "generate"
 289 VALUE_NONE = "none"
 290 VALUE_TRUE = "true"
 291 VALUE_FALSE = "false"
 292
 293 # External script validation mask
 294 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
 295
 296 # hooks-related constants
 297 HOOKS_PHASE_PRE = "pre"
 298 HOOKS_PHASE_POST = "post"
 299 HOOKS_NAME_CFGUPDATE = "config-update"
 300 HOOKS_NAME_WATCHER = "watcher"
 301 HOOKS_VERSION = 2
 302 HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
 303
 304 # hooks subject type (what object type does the LU deal with)
 305 HTYPE_CLUSTER = "CLUSTER"
 306 HTYPE_NODE = "NODE"
 307 HTYPE_GROUP = "GROUP"
 308 HTYPE_INSTANCE = "INSTANCE"
 309 HTYPE_NETWORK = "NETWORK"
 310
 311 HKR_SKIP = 0
 312 HKR_FAIL = 1
 313 HKR_SUCCESS = 2
 314
 315 # Storage types
 316 ST_FILE = "file"
 317 ST_LVM_PV = "lvm-pv"
 318 ST_LVM_VG = "lvm-vg"
 319
 320 # Storage fields
 321 # first two are valid in LU context only, not passed to backend
 322 SF_NODE = "node"
 323 SF_TYPE = "type"
 324 # and the rest are valid in backend
 325 SF_NAME = "name"
 326 SF_SIZE = "size"
 327 SF_FREE = "free"
 328 SF_USED = "used"
 329 SF_ALLOCATABLE = "allocatable"
 330
 331 # Storage operations
 332 SO_FIX_CONSISTENCY = "fix-consistency"
 333
 334 # Available fields per storage type
 335 VALID_STORAGE_FIELDS = compat.UniqueFrozenset([
 336   SF_NAME,
 337   SF_TYPE,
 338   SF_SIZE,
 339   SF_USED,
 340   SF_FREE,
 341   SF_ALLOCATABLE,
 342   ])
 343
 344 VALID_STORAGE_TYPES = compat.UniqueFrozenset([
 345   ST_FILE,
 346   ST_LVM_PV,
 347   ST_LVM_VG,
 348   ])
 349
 350 MODIFIABLE_STORAGE_FIELDS = {
 351   ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
 352   }
 353
 354 VALID_STORAGE_OPERATIONS = {
 355   ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
 356   }
 357
 358 # Local disk status
 359 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
 360 (LDS_OKAY,
 361  LDS_UNKNOWN,
 362  LDS_FAULTY) = range(1, 4)
 363
 364 # disk template types
 365 DT_DISKLESS = "diskless"
 366 DT_PLAIN = "plain"
 367 DT_DRBD8 = "drbd"
 368 DT_FILE = "file"
 369 DT_SHARED_FILE = "sharedfile"
 370 DT_BLOCK = "blockdev"
 371 DT_RBD = "rbd"
 372 DT_EXT = "ext"
 373
 374 # the set of network-mirrored disk templates
 375 DTS_INT_MIRROR = compat.UniqueFrozenset([DT_DRBD8])
 376
 377 # the set of externally-mirrored disk templates (e.g. SAN, NAS)
 378 DTS_EXT_MIRROR = compat.UniqueFrozenset([
 379   DT_SHARED_FILE,
 380   DT_BLOCK,
 381   DT_RBD,
 382   DT_EXT,
 383   ])
 384
 385 # the set of non-lvm-based disk templates
 386 DTS_NOT_LVM = compat.UniqueFrozenset([
 387   DT_DISKLESS,
 388   DT_FILE,
 389   DT_SHARED_FILE,
 390   DT_BLOCK,
 391   DT_RBD,
 392   DT_EXT,
 393   ])
 394
 395 # the set of disk templates which can be grown
 396 DTS_GROWABLE = compat.UniqueFrozenset([
 397   DT_PLAIN,
 398   DT_DRBD8,
 399   DT_FILE,
 400   DT_SHARED_FILE,
 401   DT_RBD,
 402   DT_EXT,
 403   ])
 404
 405 # the set of disk templates that allow adoption
 406 DTS_MAY_ADOPT = compat.UniqueFrozenset([
 407   DT_PLAIN,
 408   DT_BLOCK,
 409   ])
 410
 411 # the set of disk templates that *must* use adoption
 412 DTS_MUST_ADOPT = compat.UniqueFrozenset([DT_BLOCK])
 413
 414 # the set of disk templates that allow migrations
 415 DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
 416
 417 # the set of file based disk templates
 418 DTS_FILEBASED = compat.UniqueFrozenset([
 419   DT_FILE,
 420   DT_SHARED_FILE,
 421   ])
 422
 423 # the set of disk templates that are supported by exclusive_storage
 424 DTS_EXCL_STORAGE = frozenset([DT_PLAIN])
 425
 426 # templates for which we don't perform checks on free space
 427 DTS_NO_FREE_SPACE_CHECK = compat.UniqueFrozenset([
 428   DT_FILE,
 429   DT_SHARED_FILE,
 430   DT_RBD,
 431   DT_EXT,
 432   ])
 433
 434 # logical disk types
 435 LD_LV = "lvm"
 436 LD_DRBD8 = "drbd8"
 437 LD_FILE = "file"
 438 LD_BLOCKDEV = "blockdev"
 439 LD_RBD = "rbd"
 440 LD_EXT = "ext"
 441 LOGICAL_DISK_TYPES = compat.UniqueFrozenset([
 442   LD_LV,
 443   LD_DRBD8,
 444   LD_FILE,
 445   LD_BLOCKDEV,
 446   LD_RBD,
 447   LD_EXT,
 448   ])
 449
 450 LDS_BLOCK = compat.UniqueFrozenset([
 451   LD_LV,
 452   LD_DRBD8,
 453   LD_BLOCKDEV,
 454   LD_RBD,
 455   LD_EXT,
 456   ])
 457
 458 # drbd constants
 459 DRBD_HMAC_ALG = "md5"
 460 DRBD_NET_PROTOCOL = "C"
 461 DRBD_STATUS_FILE = "/proc/drbd"
 462
 463 #: Size of DRBD meta block device
 464 DRBD_META_SIZE = 128
 465
 466 # drbd barrier types
 467 DRBD_B_NONE = "n"
 468 DRBD_B_DISK_BARRIERS = "b"
 469 DRBD_B_DISK_DRAIN = "d"
 470 DRBD_B_DISK_FLUSH = "f"
 471
 472 # Valid barrier combinations: "n" or any non-null subset of "bfd"
 473 DRBD_VALID_BARRIER_OPT = compat.UniqueFrozenset([
 474   frozenset([DRBD_B_NONE]),
 475   frozenset([DRBD_B_DISK_BARRIERS]),
 476   frozenset([DRBD_B_DISK_DRAIN]),
 477   frozenset([DRBD_B_DISK_FLUSH]),
 478   frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),
 479   frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_DRAIN]),
 480   frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH]),
 481   frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH, DRBD_B_DISK_DRAIN]),
 482   ])
 483
 484 # rbd tool command
 485 RBD_CMD = "rbd"
 486
 487 # file backend driver
 488 FD_LOOP = "loop"
 489 FD_BLKTAP = "blktap"
 490
 491 # the set of drbd-like disk types
 492 LDS_DRBD = compat.UniqueFrozenset([LD_DRBD8])
 493
 494 # disk access mode
 495 DISK_RDONLY = "ro"
 496 DISK_RDWR = "rw"
 497 DISK_ACCESS_SET = compat.UniqueFrozenset([DISK_RDONLY, DISK_RDWR])
 498
 499 # disk replacement mode
 500 REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
 501 REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
 502 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
 503 REPLACE_DISK_AUTO = "replace_auto"
 504 REPLACE_MODES = compat.UniqueFrozenset([
 505   REPLACE_DISK_PRI,
 506   REPLACE_DISK_SEC,
 507   REPLACE_DISK_CHG,
 508   REPLACE_DISK_AUTO,
 509   ])
 510
 511 # Instance export mode
 512 EXPORT_MODE_LOCAL = "local"
 513 EXPORT_MODE_REMOTE = "remote"
 514 EXPORT_MODES = compat.UniqueFrozenset([
 515   EXPORT_MODE_LOCAL,
 516   EXPORT_MODE_REMOTE,
 517   ])
 518
 519 # instance creation modes
 520 INSTANCE_CREATE = "create"
 521 INSTANCE_IMPORT = "import"
 522 INSTANCE_REMOTE_IMPORT = "remote-import"
 523 INSTANCE_CREATE_MODES = compat.UniqueFrozenset([
 524   INSTANCE_CREATE,
 525   INSTANCE_IMPORT,
 526   INSTANCE_REMOTE_IMPORT,
 527   ])
 528
 529 # Remote import/export handshake message and version
 530 RIE_VERSION = 0
 531 RIE_HANDSHAKE = "Hi, I'm Ganeti"
 532
 533 # Remote import/export certificate validity in seconds
 534 RIE_CERT_VALIDITY = 24 * 60 * 60
 535
 536 # Overall timeout for establishing connection
 537 RIE_CONNECT_TIMEOUT = 180
 538
 539 # Export only: how long to wait per connection attempt (seconds)
 540 RIE_CONNECT_ATTEMPT_TIMEOUT = 20
 541
 542 # Export only: number of attempts to connect
 543 RIE_CONNECT_RETRIES = 10
 544
 545 #: Give child process up to 5 seconds to exit after sending a signal
 546 CHILD_LINGER_TIMEOUT = 5.0
 547
 548 DISK_TEMPLATES = compat.UniqueFrozenset([
 549   DT_DISKLESS,
 550   DT_PLAIN,
 551   DT_DRBD8,
 552   DT_FILE,
 553   DT_SHARED_FILE,
 554   DT_BLOCK,
 555   DT_RBD,
 556   DT_EXT
 557   ])
 558
 559 FILE_DRIVER = compat.UniqueFrozenset([FD_LOOP, FD_BLKTAP])
 560
 561 # import/export config options
 562 INISECT_EXP = "export"
 563 INISECT_INS = "instance"
 564 INISECT_HYP = "hypervisor"
 565 INISECT_BEP = "backend"
 566 INISECT_OSP = "os"
 567
 568 # dynamic device modification
 569 DDM_ADD = "add"
 570 DDM_MODIFY = "modify"
 571 DDM_REMOVE = "remove"
 572 DDMS_VALUES = compat.UniqueFrozenset([DDM_ADD, DDM_REMOVE])
 573 DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
 574   DDM_MODIFY,
 575   ]))
 576 # TODO: DDM_SWAP, DDM_MOVE?
 577
 578 # common exit codes
 579 EXIT_SUCCESS = 0
 580 EXIT_FAILURE = 1
 581 EXIT_NOTCLUSTER = 5
 582 EXIT_NOTMASTER = 11
 583 EXIT_NODESETUP_ERROR = 12
 584 EXIT_CONFIRMATION = 13 # need user confirmation
 585
 586 #: Exit code for query operations with unknown fields
 587 EXIT_UNKNOWN_FIELD = 14
 588
 589 # tags
 590 TAG_CLUSTER = "cluster"
 591 TAG_NODEGROUP = "nodegroup"
 592 TAG_NODE = "node"
 593 TAG_INSTANCE = "instance"
 594 TAG_NETWORK = "network"
 595 VALID_TAG_TYPES = compat.UniqueFrozenset([
 596   TAG_CLUSTER,
 597   TAG_NODEGROUP,
 598   TAG_NODE,
 599   TAG_INSTANCE,
 600   TAG_NETWORK,
 601   ])
 602 MAX_TAG_LEN = 128
 603 MAX_TAGS_PER_OBJ = 4096
 604
 605 # others
 606 DEFAULT_BRIDGE = "xen-br0"
 607 CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
 608 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
 609 IP4_ADDRESS_ANY = "0.0.0.0"
 610 IP6_ADDRESS_LOCALHOST = "::1"
 611 IP6_ADDRESS_ANY = "::"
 612 IP4_VERSION = 4
 613 IP6_VERSION = 6
 614 VALID_IP_VERSIONS = compat.UniqueFrozenset([IP4_VERSION, IP6_VERSION])
 615 # for export to htools
 616 IP4_FAMILY = socket.AF_INET
 617 IP6_FAMILY = socket.AF_INET6
 618
 619 TCP_PING_TIMEOUT = 10
 620 DEFAULT_VG = "xenvg"
 621 DEFAULT_DRBD_HELPER = "/bin/true"
 622 MIN_VG_SIZE = 20480
 623 DEFAULT_MAC_PREFIX = "aa:00:00"
 624 # default maximum instance wait time, in seconds.
 625 DEFAULT_SHUTDOWN_TIMEOUT = 120
 626 NODE_MAX_CLOCK_SKEW = 150
 627 # Time for an intra-cluster disk transfer to wait for a connection
 628 DISK_TRANSFER_CONNECT_TIMEOUT = 60
 629 # Disk index separator
 630 DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
 631 IP_COMMAND_PATH = _autoconf.IP_PATH
 632
 633 #: Key for job IDs in opcode result
 634 JOB_IDS_KEY = "jobs"
 635
 636 # runparts results
 637 (RUNPARTS_SKIP,
 638  RUNPARTS_RUN,
 639  RUNPARTS_ERR) = range(3)
 640
 641 RUNPARTS_STATUS = compat.UniqueFrozenset([
 642   RUNPARTS_SKIP,
 643   RUNPARTS_RUN,
 644   RUNPARTS_ERR,
 645   ])
 646
 647 # RPC constants
 648 (RPC_ENCODING_NONE,
 649  RPC_ENCODING_ZLIB_BASE64) = range(2)
 650
 651 # Various time constants for the timeout table
 652 RPC_TMO_URGENT = 60 # one minute
 653 RPC_TMO_FAST = 5 * 60 # five minutes
 654 RPC_TMO_NORMAL = 15 * 60 # 15 minutes
 655 RPC_TMO_SLOW = 3600 # one hour
 656 RPC_TMO_4HRS = 4 * 3600
 657 RPC_TMO_1DAY = 86400
 658
 659 # Timeout for connecting to nodes (seconds)
 660 RPC_CONNECT_TIMEOUT = 5
 661
 662 # os related constants
 663 OS_SCRIPT_CREATE = "create"
 664 OS_SCRIPT_IMPORT = "import"
 665 OS_SCRIPT_EXPORT = "export"
 666 OS_SCRIPT_RENAME = "rename"
 667 OS_SCRIPT_VERIFY = "verify"
 668 OS_SCRIPTS = compat.UniqueFrozenset([
 669   OS_SCRIPT_CREATE,
 670   OS_SCRIPT_IMPORT,
 671   OS_SCRIPT_EXPORT,
 672   OS_SCRIPT_RENAME,
 673   OS_SCRIPT_VERIFY,
 674   ])
 675
 676 OS_API_FILE = "ganeti_api_version"
 677 OS_VARIANTS_FILE = "variants.list"
 678 OS_PARAMETERS_FILE = "parameters.list"
 679
 680 OS_VALIDATE_PARAMETERS = "parameters"
 681 OS_VALIDATE_CALLS = compat.UniqueFrozenset([OS_VALIDATE_PARAMETERS])
 682
 683 # External Storage (ES) related constants
 684 ES_ACTION_CREATE = "create"
 685 ES_ACTION_REMOVE = "remove"
 686 ES_ACTION_GROW = "grow"
 687 ES_ACTION_ATTACH = "attach"
 688 ES_ACTION_DETACH = "detach"
 689 ES_ACTION_SETINFO = "setinfo"
 690 ES_ACTION_VERIFY = "verify"
 691
 692 ES_SCRIPT_CREATE = ES_ACTION_CREATE
 693 ES_SCRIPT_REMOVE = ES_ACTION_REMOVE
 694 ES_SCRIPT_GROW = ES_ACTION_GROW
 695 ES_SCRIPT_ATTACH = ES_ACTION_ATTACH
 696 ES_SCRIPT_DETACH = ES_ACTION_DETACH
 697 ES_SCRIPT_SETINFO = ES_ACTION_SETINFO
 698 ES_SCRIPT_VERIFY = ES_ACTION_VERIFY
 699 ES_SCRIPTS = frozenset([
 700   ES_SCRIPT_CREATE,
 701   ES_SCRIPT_REMOVE,
 702   ES_SCRIPT_GROW,
 703   ES_SCRIPT_ATTACH,
 704   ES_SCRIPT_DETACH,
 705   ES_SCRIPT_SETINFO,
 706   ES_SCRIPT_VERIFY
 707   ])
 708
 709 ES_PARAMETERS_FILE = "parameters.list"
 710
 711 # ssh constants
 712 SSH = "ssh"
 713 SCP = "scp"
 714
 715 # reboot types
 716 INSTANCE_REBOOT_SOFT = "soft"
 717 INSTANCE_REBOOT_HARD = "hard"
 718 INSTANCE_REBOOT_FULL = "full"
 719
 720 REBOOT_TYPES = compat.UniqueFrozenset([
 721   INSTANCE_REBOOT_SOFT,
 722   INSTANCE_REBOOT_HARD,
 723   INSTANCE_REBOOT_FULL,
 724   ])
 725
 726 # instance reboot behaviors
 727 INSTANCE_REBOOT_ALLOWED = "reboot"
 728 INSTANCE_REBOOT_EXIT = "exit"
 729
 730 REBOOT_BEHAVIORS = compat.UniqueFrozenset([
 731   INSTANCE_REBOOT_ALLOWED,
 732   INSTANCE_REBOOT_EXIT,
 733   ])
 734
 735 VTYPE_STRING = "string"
 736 VTYPE_MAYBE_STRING = "maybe-string"
 737 VTYPE_BOOL = "bool"
 738 VTYPE_SIZE = "size" # size, in MiBs
 739 VTYPE_INT = "int"
 740 ENFORCEABLE_TYPES = compat.UniqueFrozenset([
 741   VTYPE_STRING,
 742   VTYPE_MAYBE_STRING,
 743   VTYPE_BOOL,
 744   VTYPE_SIZE,
 745   VTYPE_INT,
 746   ])
 747
 748 # Constant representing that the user does not specify any IP version
 749 IFACE_NO_IP_VERSION_SPECIFIED = 0
 750
 751 # HV parameter names (global namespace)
 752 HV_BOOT_ORDER = "boot_order"
 753 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
 754 HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
 755 HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
 756 HV_NIC_TYPE = "nic_type"
 757 HV_DISK_TYPE = "disk_type"
 758 HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
 759 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
 760 HV_VNC_PASSWORD_FILE = "vnc_password_file"
 761 HV_VNC_TLS = "vnc_tls"
 762 HV_VNC_X509 = "vnc_x509_path"
 763 HV_VNC_X509_VERIFY = "vnc_x509_verify"
 764 HV_KVM_SPICE_BIND = "spice_bind"
 765 HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
 766 HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
 767 HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
 768 HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
 769 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
 770 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
 771 HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
 772 HV_KVM_SPICE_USE_TLS = "spice_use_tls"
 773 HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
 774 HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
 775 HV_ACPI = "acpi"
 776 HV_PAE = "pae"
 777 HV_USE_BOOTLOADER = "use_bootloader"
 778 HV_BOOTLOADER_ARGS = "bootloader_args"
 779 HV_BOOTLOADER_PATH = "bootloader_path"
 780 HV_KERNEL_ARGS = "kernel_args"
 781 HV_KERNEL_PATH = "kernel_path"
 782 HV_INITRD_PATH = "initrd_path"
 783 HV_ROOT_PATH = "root_path"
 784 HV_SERIAL_CONSOLE = "serial_console"
 785 HV_USB_MOUSE = "usb_mouse"
 786 HV_KEYMAP = "keymap"
 787 HV_DEVICE_MODEL = "device_model"
 788 HV_INIT_SCRIPT = "init_script"
 789 HV_MIGRATION_PORT = "migration_port"
 790 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
 791 HV_MIGRATION_DOWNTIME = "migration_downtime"
 792 HV_MIGRATION_MODE = "migration_mode"
 793 HV_USE_LOCALTIME = "use_localtime"
 794 HV_DISK_CACHE = "disk_cache"
 795 HV_SECURITY_MODEL = "security_model"
 796 HV_SECURITY_DOMAIN = "security_domain"
 797 HV_KVM_FLAG = "kvm_flag"
 798 HV_VHOST_NET = "vhost_net"
 799 HV_KVM_USE_CHROOT = "use_chroot"
 800 HV_CPU_MASK = "cpu_mask"
 801 HV_MEM_PATH = "mem_path"
 802 HV_PASSTHROUGH = "pci_pass"
 803 HV_BLOCKDEV_PREFIX = "blockdev_prefix"
 804 HV_REBOOT_BEHAVIOR = "reboot_behavior"
 805 HV_CPU_TYPE = "cpu_type"
 806 HV_CPU_CAP = "cpu_cap"
 807 HV_CPU_WEIGHT = "cpu_weight"
 808
 809
 810 HVS_PARAMETER_TYPES = {
 811   HV_BOOT_ORDER: VTYPE_STRING,
 812   HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
 813   HV_CDROM_IMAGE_PATH: VTYPE_STRING,
 814   HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
 815   HV_NIC_TYPE: VTYPE_STRING,
 816   HV_DISK_TYPE: VTYPE_STRING,
 817   HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
 818   HV_VNC_PASSWORD_FILE: VTYPE_STRING,
 819   HV_VNC_BIND_ADDRESS: VTYPE_STRING,
 820   HV_VNC_TLS: VTYPE_BOOL,
 821   HV_VNC_X509: VTYPE_STRING,
 822   HV_VNC_X509_VERIFY: VTYPE_BOOL,
 823   HV_KVM_SPICE_BIND: VTYPE_STRING,
 824   HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
 825   HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
 826   HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
 827   HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
 828   HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
 829   HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
 830   HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
 831   HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
 832   HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
 833   HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
 834   HV_ACPI: VTYPE_BOOL,
 835   HV_PAE: VTYPE_BOOL,
 836   HV_USE_BOOTLOADER: VTYPE_BOOL,
 837   HV_BOOTLOADER_PATH: VTYPE_STRING,
 838   HV_BOOTLOADER_ARGS: VTYPE_STRING,
 839   HV_KERNEL_PATH: VTYPE_STRING,
 840   HV_KERNEL_ARGS: VTYPE_STRING,
 841   HV_INITRD_PATH: VTYPE_STRING,
 842   HV_ROOT_PATH: VTYPE_MAYBE_STRING,
 843   HV_SERIAL_CONSOLE: VTYPE_BOOL,
 844   HV_USB_MOUSE: VTYPE_STRING,
 845   HV_KEYMAP: VTYPE_STRING,
 846   HV_DEVICE_MODEL: VTYPE_STRING,
 847   HV_INIT_SCRIPT: VTYPE_STRING,
 848   HV_MIGRATION_PORT: VTYPE_INT,
 849   HV_MIGRATION_BANDWIDTH: VTYPE_INT,
 850   HV_MIGRATION_DOWNTIME: VTYPE_INT,
 851   HV_MIGRATION_MODE: VTYPE_STRING,
 852   HV_USE_LOCALTIME: VTYPE_BOOL,
 853   HV_DISK_CACHE: VTYPE_STRING,
 854   HV_SECURITY_MODEL: VTYPE_STRING,
 855   HV_SECURITY_DOMAIN: VTYPE_STRING,
 856   HV_KVM_FLAG: VTYPE_STRING,
 857   HV_VHOST_NET: VTYPE_BOOL,
 858   HV_KVM_USE_CHROOT: VTYPE_BOOL,
 859   HV_CPU_MASK: VTYPE_STRING,
 860   HV_MEM_PATH: VTYPE_STRING,
 861   HV_PASSTHROUGH: VTYPE_STRING,
 862   HV_BLOCKDEV_PREFIX: VTYPE_STRING,
 863   HV_REBOOT_BEHAVIOR: VTYPE_STRING,
 864   HV_CPU_TYPE: VTYPE_STRING,
 865   HV_CPU_CAP: VTYPE_INT,
 866   HV_CPU_WEIGHT: VTYPE_INT,
 867   }
 868
 869 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
 870
 871 HVS_PARAMETER_TITLES = {
 872   HV_ACPI: "ACPI",
 873   HV_BOOT_ORDER: "Boot_order",
 874   HV_CDROM_IMAGE_PATH: "CDROM_image_path",
 875   HV_DISK_TYPE: "Disk_type",
 876   HV_INITRD_PATH: "Initrd_path",
 877   HV_KERNEL_PATH: "Kernel_path",
 878   HV_NIC_TYPE: "NIC_type",
 879   HV_PAE: "PAE",
 880   HV_VNC_BIND_ADDRESS: "VNC_bind_address",
 881   HV_PASSTHROUGH: "pci_pass",
 882   HV_CPU_TYPE: "cpu_type",
 883   }
 884
 885 # Migration statuses
 886 HV_MIGRATION_COMPLETED = "completed"
 887 HV_MIGRATION_ACTIVE = "active"
 888 HV_MIGRATION_FAILED = "failed"
 889 HV_MIGRATION_CANCELLED = "cancelled"
 890
 891 HV_MIGRATION_VALID_STATUSES = compat.UniqueFrozenset([
 892   HV_MIGRATION_COMPLETED,
 893   HV_MIGRATION_ACTIVE,
 894   HV_MIGRATION_FAILED,
 895   HV_MIGRATION_CANCELLED,
 896   ])
 897
 898 HV_MIGRATION_FAILED_STATUSES = compat.UniqueFrozenset([
 899   HV_MIGRATION_FAILED,
 900   HV_MIGRATION_CANCELLED,
 901   ])
 902
 903 # KVM-specific statuses
 904 HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
 905
 906 # Node info keys
 907 HV_NODEINFO_KEY_VERSION = "hv_version"
 908
 909 # Hypervisor state
 910 HVST_MEMORY_TOTAL = "mem_total"
 911 HVST_MEMORY_NODE = "mem_node"
 912 HVST_MEMORY_HV = "mem_hv"
 913 HVST_CPU_TOTAL = "cpu_total"
 914 HVST_CPU_NODE = "cpu_node"
 915
 916 HVST_DEFAULTS = {
 917   HVST_MEMORY_TOTAL: 0,
 918   HVST_MEMORY_NODE: 0,
 919   HVST_MEMORY_HV: 0,
 920   HVST_CPU_TOTAL: 1,
 921   HVST_CPU_NODE: 1,
 922   }
 923
 924 HVSTS_PARAMETER_TYPES = {
 925   HVST_MEMORY_TOTAL: VTYPE_INT,
 926   HVST_MEMORY_NODE: VTYPE_INT,
 927   HVST_MEMORY_HV: VTYPE_INT,
 928   HVST_CPU_TOTAL: VTYPE_INT,
 929   HVST_CPU_NODE: VTYPE_INT,
 930   }
 931
 932 HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
 933
 934 # Disk state
 935 DS_DISK_TOTAL = "disk_total"
 936 DS_DISK_RESERVED = "disk_reserved"
 937 DS_DISK_OVERHEAD = "disk_overhead"
 938
 939 DS_DEFAULTS = {
 940   DS_DISK_TOTAL: 0,
 941   DS_DISK_RESERVED: 0,
 942   DS_DISK_OVERHEAD: 0,
 943   }
 944
 945 DSS_PARAMETER_TYPES = {
 946   DS_DISK_TOTAL: VTYPE_INT,
 947   DS_DISK_RESERVED: VTYPE_INT,
 948   DS_DISK_OVERHEAD: VTYPE_INT,
 949   }
 950
 951 DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
 952 DS_VALID_TYPES = compat.UniqueFrozenset([LD_LV])
 953
 954 # Backend parameter names
 955 BE_MEMORY = "memory" # deprecated and replaced by max and min mem
 956 BE_MAXMEM = "maxmem"
 957 BE_MINMEM = "minmem"
 958 BE_VCPUS = "vcpus"
 959 BE_AUTO_BALANCE = "auto_balance"
 960 BE_ALWAYS_FAILOVER = "always_failover"
 961 BE_SPINDLE_USE = "spindle_use"
 962
 963 BES_PARAMETER_TYPES = {
 964   BE_MAXMEM: VTYPE_SIZE,
 965   BE_MINMEM: VTYPE_SIZE,
 966   BE_VCPUS: VTYPE_INT,
 967   BE_AUTO_BALANCE: VTYPE_BOOL,
 968   BE_ALWAYS_FAILOVER: VTYPE_BOOL,
 969   BE_SPINDLE_USE: VTYPE_INT,
 970   }
 971
 972 BES_PARAMETER_TITLES = {
 973   BE_AUTO_BALANCE: "Auto_balance",
 974   BE_MAXMEM: "ConfigMaxMem",
 975   BE_MINMEM: "ConfigMinMem",
 976   BE_VCPUS: "ConfigVCPUs",
 977   }
 978
 979 BES_PARAMETER_COMPAT = {
 980   BE_MEMORY: VTYPE_SIZE,
 981   }
 982 BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)
 983
 984 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
 985
 986 # instance specs
 987 ISPEC_MEM_SIZE = "memory-size"
 988 ISPEC_CPU_COUNT = "cpu-count"
 989 ISPEC_DISK_COUNT = "disk-count"
 990 ISPEC_DISK_SIZE = "disk-size"
 991 ISPEC_NIC_COUNT = "nic-count"
 992 ISPEC_SPINDLE_USE = "spindle-use"
 993
 994 ISPECS_PARAMETER_TYPES = {
 995   ISPEC_MEM_SIZE: VTYPE_INT,
 996   ISPEC_CPU_COUNT: VTYPE_INT,
 997   ISPEC_DISK_COUNT: VTYPE_INT,
 998   ISPEC_DISK_SIZE: VTYPE_INT,
 999   ISPEC_NIC_COUNT: VTYPE_INT,
1000   ISPEC_SPINDLE_USE: VTYPE_INT,
1001   }
1002
1003 ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())
1004
1005 ISPECS_MIN = "min"
1006 ISPECS_MAX = "max"
1007 ISPECS_STD = "std"
1008 IPOLICY_DTS = "disk-templates"
1009 IPOLICY_VCPU_RATIO = "vcpu-ratio"
1010 IPOLICY_SPINDLE_RATIO = "spindle-ratio"
1011
1012 IPOLICY_ISPECS = compat.UniqueFrozenset([
1013   ISPECS_MIN,
1014   ISPECS_MAX,
1015   ISPECS_STD,
1016   ])
1017
1018 IPOLICY_PARAMETERS = compat.UniqueFrozenset([
1019   IPOLICY_VCPU_RATIO,
1020   IPOLICY_SPINDLE_RATIO,
1021   ])
1022
1023 IPOLICY_ALL_KEYS = (IPOLICY_ISPECS |
1024                     IPOLICY_PARAMETERS |
1025                     frozenset([IPOLICY_DTS]))
1026
1027 # Node parameter names
1028 ND_OOB_PROGRAM = "oob_program"
1029 ND_SPINDLE_COUNT = "spindle_count"
1030 ND_EXCLUSIVE_STORAGE = "exclusive_storage"
1031
1032 NDS_PARAMETER_TYPES = {
1033   ND_OOB_PROGRAM: VTYPE_STRING,
1034   ND_SPINDLE_COUNT: VTYPE_INT,
1035   ND_EXCLUSIVE_STORAGE: VTYPE_BOOL,
1036   }
1037
1038 NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
1039
1040 NDS_PARAMETER_TITLES = {
1041   ND_OOB_PROGRAM: "OutOfBandProgram",
1042   ND_SPINDLE_COUNT: "SpindleCount",
1043   ND_EXCLUSIVE_STORAGE: "ExclusiveStorage",
1044   }
1045
1046 # Logical Disks parameters
1047 LDP_RESYNC_RATE = "resync-rate"
1048 LDP_STRIPES = "stripes"
1049 LDP_BARRIERS = "disabled-barriers"
1050 LDP_NO_META_FLUSH = "disable-meta-flush"
1051 LDP_DEFAULT_METAVG = "default-metavg"
1052 LDP_DISK_CUSTOM = "disk-custom"
1053 LDP_NET_CUSTOM = "net-custom"
1054 LDP_DYNAMIC_RESYNC = "dynamic-resync"
1055 LDP_PLAN_AHEAD = "c-plan-ahead"
1056 LDP_FILL_TARGET = "c-fill-target"
1057 LDP_DELAY_TARGET = "c-delay-target"
1058 LDP_MAX_RATE = "c-max-rate"
1059 LDP_MIN_RATE = "c-min-rate"
1060 LDP_POOL = "pool"
1061 DISK_LD_TYPES = {
1062   LDP_RESYNC_RATE: VTYPE_INT,
1063   LDP_STRIPES: VTYPE_INT,
1064   LDP_BARRIERS: VTYPE_STRING,
1065   LDP_NO_META_FLUSH: VTYPE_BOOL,
1066   LDP_DEFAULT_METAVG: VTYPE_STRING,
1067   LDP_DISK_CUSTOM: VTYPE_STRING,
1068   LDP_NET_CUSTOM: VTYPE_STRING,
1069   LDP_DYNAMIC_RESYNC: VTYPE_BOOL,
1070   LDP_PLAN_AHEAD: VTYPE_INT,
1071   LDP_FILL_TARGET: VTYPE_INT,
1072   LDP_DELAY_TARGET: VTYPE_INT,
1073   LDP_MAX_RATE: VTYPE_INT,
1074   LDP_MIN_RATE: VTYPE_INT,
1075   LDP_POOL: VTYPE_STRING,
1076   }
1077 DISK_LD_PARAMETERS = frozenset(DISK_LD_TYPES.keys())
1078
1079 # Disk template parameters (can be set/changed by the user via gnt-cluster and
1080 # gnt-group)
1081 DRBD_RESYNC_RATE = "resync-rate"
1082 DRBD_DATA_STRIPES = "data-stripes"
1083 DRBD_META_STRIPES = "meta-stripes"
1084 DRBD_DISK_BARRIERS = "disk-barriers"
1085 DRBD_META_BARRIERS = "meta-barriers"
1086 DRBD_DEFAULT_METAVG = "metavg"
1087 DRBD_DISK_CUSTOM = "disk-custom"
1088 DRBD_NET_CUSTOM = "net-custom"
1089 DRBD_DYNAMIC_RESYNC = "dynamic-resync"
1090 DRBD_PLAN_AHEAD = "c-plan-ahead"
1091 DRBD_FILL_TARGET = "c-fill-target"
1092 DRBD_DELAY_TARGET = "c-delay-target"
1093 DRBD_MAX_RATE = "c-max-rate"
1094 DRBD_MIN_RATE = "c-min-rate"
1095 LV_STRIPES = "stripes"
1096 RBD_POOL = "pool"
1097 DISK_DT_TYPES = {
1098   DRBD_RESYNC_RATE: VTYPE_INT,
1099   DRBD_DATA_STRIPES: VTYPE_INT,
1100   DRBD_META_STRIPES: VTYPE_INT,
1101   DRBD_DISK_BARRIERS: VTYPE_STRING,
1102   DRBD_META_BARRIERS: VTYPE_BOOL,
1103   DRBD_DEFAULT_METAVG: VTYPE_STRING,
1104   DRBD_DISK_CUSTOM: VTYPE_STRING,
1105   DRBD_NET_CUSTOM: VTYPE_STRING,
1106   DRBD_DYNAMIC_RESYNC: VTYPE_BOOL,
1107   DRBD_PLAN_AHEAD: VTYPE_INT,
1108   DRBD_FILL_TARGET: VTYPE_INT,
1109   DRBD_DELAY_TARGET: VTYPE_INT,
1110   DRBD_MAX_RATE: VTYPE_INT,
1111   DRBD_MIN_RATE: VTYPE_INT,
1112   LV_STRIPES: VTYPE_INT,
1113   RBD_POOL: VTYPE_STRING,
1114   }
1115
1116 DISK_DT_PARAMETERS = frozenset(DISK_DT_TYPES.keys())
1117
1118 # OOB supported commands
1119 OOB_POWER_ON = "power-on"
1120 OOB_POWER_OFF = "power-off"
1121 OOB_POWER_CYCLE = "power-cycle"
1122 OOB_POWER_STATUS = "power-status"
1123 OOB_HEALTH = "health"
1124
1125 OOB_COMMANDS = compat.UniqueFrozenset([
1126   OOB_POWER_ON,
1127   OOB_POWER_OFF,
1128   OOB_POWER_CYCLE,
1129   OOB_POWER_STATUS,
1130   OOB_HEALTH,
1131   ])
1132
1133 OOB_POWER_STATUS_POWERED = "powered"
1134
1135 OOB_TIMEOUT = 60 # 60 seconds
1136 OOB_POWER_DELAY = 2.0 # 2 seconds
1137
1138 OOB_STATUS_OK = "OK"
1139 OOB_STATUS_WARNING = "WARNING"
1140 OOB_STATUS_CRITICAL = "CRITICAL"
1141 OOB_STATUS_UNKNOWN = "UNKNOWN"
1142
1143 OOB_STATUSES = compat.UniqueFrozenset([
1144   OOB_STATUS_OK,
1145   OOB_STATUS_WARNING,
1146   OOB_STATUS_CRITICAL,
1147   OOB_STATUS_UNKNOWN,
1148   ])
1149
1150 # Instance Parameters Profile
1151 PP_DEFAULT = "default"
1152
1153 # NIC_* constants are used inside the ganeti config
1154 NIC_MODE = "mode"
1155 NIC_LINK = "link"
1156
1157 NIC_MODE_BRIDGED = "bridged"
1158 NIC_MODE_ROUTED = "routed"
1159 NIC_MODE_OVS = "openvswitch"
1160 NIC_IP_POOL = "pool"
1161
1162 NIC_VALID_MODES = compat.UniqueFrozenset([
1163   NIC_MODE_BRIDGED,
1164   NIC_MODE_ROUTED,
1165   NIC_MODE_OVS,
1166   ])
1167
1168 RESERVE_ACTION = "reserve"
1169 RELEASE_ACTION = "release"
1170
1171 # An extra description of the network.
1172 # Can be used by hooks/kvm-vif-bridge to apply different rules
1173 NETWORK_TYPE_PRIVATE = "private"
1174 NETWORK_TYPE_PUBLIC = "public"
1175
1176 NETWORK_VALID_TYPES = compat.UniqueFrozenset([
1177   NETWORK_TYPE_PRIVATE,
1178   NETWORK_TYPE_PUBLIC,
1179   ])
1180
1181 NICS_PARAMETER_TYPES = {
1182   NIC_MODE: VTYPE_STRING,
1183   NIC_LINK: VTYPE_STRING,
1184   }
1185
1186 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
1187
1188 # IDISK_* constants are used in opcodes, to create/change disks
1189 IDISK_SIZE = "size"
1190 IDISK_MODE = "mode"
1191 IDISK_ADOPT = "adopt"
1192 IDISK_VG = "vg"
1193 IDISK_METAVG = "metavg"
1194 IDISK_PROVIDER = "provider"
1195 IDISK_PARAMS_TYPES = {
1196   IDISK_SIZE: VTYPE_SIZE,
1197   IDISK_MODE: VTYPE_STRING,
1198   IDISK_ADOPT: VTYPE_STRING,
1199   IDISK_VG: VTYPE_STRING,
1200   IDISK_METAVG: VTYPE_STRING,
1201   IDISK_PROVIDER: VTYPE_STRING,
1202   }
1203 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
1204
1205 # INIC_* constants are used in opcodes, to create/change nics
1206 INIC_MAC = "mac"
1207 INIC_IP = "ip"
1208 INIC_MODE = "mode"
1209 INIC_LINK = "link"
1210 INIC_NETWORK = "network"
1211 INIC_PARAMS_TYPES = {
1212   INIC_IP: VTYPE_MAYBE_STRING,
1213   INIC_LINK: VTYPE_STRING,
1214   INIC_MAC: VTYPE_STRING,
1215   INIC_MODE: VTYPE_STRING,
1216   INIC_NETWORK: VTYPE_MAYBE_STRING,
1217   }
1218 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
1219
1220 # Hypervisor constants
1221 HT_XEN_PVM = "xen-pvm"
1222 HT_FAKE = "fake"
1223 HT_XEN_HVM = "xen-hvm"
1224 HT_KVM = "kvm"
1225 HT_CHROOT = "chroot"
1226 HT_LXC = "lxc"
1227 HYPER_TYPES = compat.UniqueFrozenset([
1228   HT_XEN_PVM,
1229   HT_FAKE,
1230   HT_XEN_HVM,
1231   HT_KVM,
1232   HT_CHROOT,
1233   HT_LXC,
1234   ])
1235 HTS_REQ_PORT = compat.UniqueFrozenset([HT_XEN_HVM, HT_KVM])
1236
1237 VNC_BASE_PORT = 5900
1238 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
1239
1240 # NIC types
1241 HT_NIC_RTL8139 = "rtl8139"
1242 HT_NIC_NE2K_PCI = "ne2k_pci"
1243 HT_NIC_NE2K_ISA = "ne2k_isa"
1244 HT_NIC_I82551 = "i82551"
1245 HT_NIC_I85557B = "i82557b"
1246 HT_NIC_I8259ER = "i82559er"
1247 HT_NIC_PCNET = "pcnet"
1248 HT_NIC_E1000 = "e1000"
1249 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
1250
1251 HT_HVM_VALID_NIC_TYPES = compat.UniqueFrozenset([
1252   HT_NIC_RTL8139,
1253   HT_NIC_NE2K_PCI,
1254   HT_NIC_E1000,
1255   HT_NIC_NE2K_ISA,
1256   HT_NIC_PARAVIRTUAL,
1257   ])
1258 HT_KVM_VALID_NIC_TYPES = compat.UniqueFrozenset([
1259   HT_NIC_RTL8139,
1260   HT_NIC_NE2K_PCI,
1261   HT_NIC_NE2K_ISA,
1262   HT_NIC_I82551,
1263   HT_NIC_I85557B,
1264   HT_NIC_I8259ER,
1265   HT_NIC_PCNET,
1266   HT_NIC_E1000,
1267   HT_NIC_PARAVIRTUAL,
1268   ])
1269
1270 # Disk types
1271 HT_DISK_IOEMU = "ioemu"
1272 HT_DISK_IDE = "ide"
1273 HT_DISK_SCSI = "scsi"
1274 HT_DISK_SD = "sd"
1275 HT_DISK_MTD = "mtd"
1276 HT_DISK_PFLASH = "pflash"
1277
1278 HT_CACHE_DEFAULT = "default"
1279 HT_CACHE_NONE = "none"
1280 HT_CACHE_WTHROUGH = "writethrough"
1281 HT_CACHE_WBACK = "writeback"
1282 HT_VALID_CACHE_TYPES = compat.UniqueFrozenset([
1283   HT_CACHE_DEFAULT,
1284   HT_CACHE_NONE,
1285   HT_CACHE_WTHROUGH,
1286   HT_CACHE_WBACK,
1287   ])
1288
1289 HT_HVM_VALID_DISK_TYPES = compat.UniqueFrozenset([
1290   HT_DISK_PARAVIRTUAL,
1291   HT_DISK_IOEMU,
1292   ])
1293 HT_KVM_VALID_DISK_TYPES = compat.UniqueFrozenset([
1294   HT_DISK_PARAVIRTUAL,
1295   HT_DISK_IDE,
1296   HT_DISK_SCSI,
1297   HT_DISK_SD,
1298   HT_DISK_MTD,
1299   HT_DISK_PFLASH,
1300   ])
1301
1302 # Mouse types:
1303 HT_MOUSE_MOUSE = "mouse"
1304 HT_MOUSE_TABLET = "tablet"
1305
1306 HT_KVM_VALID_MOUSE_TYPES = compat.UniqueFrozenset([
1307   HT_MOUSE_MOUSE,
1308   HT_MOUSE_TABLET,
1309   ])
1310
1311 # Boot order
1312 HT_BO_FLOPPY = "floppy"
1313 HT_BO_CDROM = "cdrom"
1314 HT_BO_DISK = "disk"
1315 HT_BO_NETWORK = "network"
1316
1317 HT_KVM_VALID_BO_TYPES = compat.UniqueFrozenset([
1318   HT_BO_FLOPPY,
1319   HT_BO_CDROM,
1320   HT_BO_DISK,
1321   HT_BO_NETWORK,
1322   ])
1323
1324 # SPICE lossless image compression options
1325 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1326 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1327 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1328 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1329 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1330 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1331
1332 HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = compat.UniqueFrozenset([
1333   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1334   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1335   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1336   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1337   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1338   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1339   ])
1340
1341 # SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1342 HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1343 HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1344 HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1345
1346 HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = compat.UniqueFrozenset([
1347   HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1348   HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1349   HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1350   ])
1351
1352 # SPICE video stream detection
1353 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1354 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1355 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1356
1357 HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = compat.UniqueFrozenset([
1358   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1359   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1360   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1361   ])
1362
1363 # Security models
1364 HT_SM_NONE = "none"
1365 HT_SM_USER = "user"
1366 HT_SM_POOL = "pool"
1367
1368 HT_KVM_VALID_SM_TYPES = compat.UniqueFrozenset([
1369   HT_SM_NONE,
1370   HT_SM_USER,
1371   HT_SM_POOL,
1372   ])
1373
1374 # Kvm flag values
1375 HT_KVM_ENABLED = "enabled"
1376 HT_KVM_DISABLED = "disabled"
1377
1378 HT_KVM_FLAG_VALUES = compat.UniqueFrozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1379
1380 # Migration type
1381 HT_MIGRATION_LIVE = "live"
1382 HT_MIGRATION_NONLIVE = "non-live"
1383 HT_MIGRATION_MODES = compat.UniqueFrozenset([
1384   HT_MIGRATION_LIVE,
1385   HT_MIGRATION_NONLIVE,
1386   ])
1387
1388 # Cluster Verify steps
1389 VERIFY_NPLUSONE_MEM = "nplusone_mem"
1390 VERIFY_OPTIONAL_CHECKS = compat.UniqueFrozenset([VERIFY_NPLUSONE_MEM])
1391
1392 # Cluster Verify error classes
1393 CV_TCLUSTER = "cluster"
1394 CV_TNODE = "node"
1395 CV_TINSTANCE = "instance"
1396
1397 # Cluster Verify error codes and documentation
1398 CV_ECLUSTERCFG = \
1399   (CV_TCLUSTER, "ECLUSTERCFG", "Cluster configuration verification failure")
1400 CV_ECLUSTERCERT = \
1401   (CV_TCLUSTER, "ECLUSTERCERT",
1402    "Cluster certificate files verification failure")
1403 CV_ECLUSTERFILECHECK = \
1404   (CV_TCLUSTER, "ECLUSTERFILECHECK",
1405    "Cluster configuration verification failure")
1406 CV_ECLUSTERDANGLINGNODES = \
1407   (CV_TNODE, "ECLUSTERDANGLINGNODES",
1408    "Some nodes belong to non-existing groups")
1409 CV_ECLUSTERDANGLINGINST = \
1410   (CV_TNODE, "ECLUSTERDANGLINGINST",
1411    "Some instances have a non-existing primary node")
1412 CV_EINSTANCEBADNODE = \
1413   (CV_TINSTANCE, "EINSTANCEBADNODE",
1414    "Instance marked as running lives on an offline node")
1415 CV_EINSTANCEDOWN = \
1416   (CV_TINSTANCE, "EINSTANCEDOWN", "Instance not running on its primary node")
1417 CV_EINSTANCELAYOUT = \
1418   (CV_TINSTANCE, "EINSTANCELAYOUT", "Instance has multiple secondary nodes")
1419 CV_EINSTANCEMISSINGDISK = \
1420   (CV_TINSTANCE, "EINSTANCEMISSINGDISK", "Missing volume on an instance")
1421 CV_EINSTANCEFAULTYDISK = \
1422   (CV_TINSTANCE, "EINSTANCEFAULTYDISK",
1423    "Impossible to retrieve status for a disk")
1424 CV_EINSTANCEWRONGNODE = \
1425   (CV_TINSTANCE, "EINSTANCEWRONGNODE", "Instance running on the wrong node")
1426 CV_EINSTANCESPLITGROUPS = \
1427   (CV_TINSTANCE, "EINSTANCESPLITGROUPS",
1428    "Instance with primary and secondary nodes in different groups")
1429 CV_EINSTANCEPOLICY = \
1430   (CV_TINSTANCE, "EINSTANCEPOLICY",
1431    "Instance does not meet policy")
1432 CV_ENODEDRBD = \
1433   (CV_TNODE, "ENODEDRBD", "Error parsing the DRBD status file")
1434 CV_ENODEDRBDHELPER = \
1435   (CV_TNODE, "ENODEDRBDHELPER", "Error caused by the DRBD helper")
1436 CV_ENODEFILECHECK = \
1437   (CV_TNODE, "ENODEFILECHECK",
1438    "Error retrieving the checksum of the node files")
1439 CV_ENODEHOOKS = \
1440   (CV_TNODE, "ENODEHOOKS", "Communication failure in hooks execution")
1441 CV_ENODEHV = \
1442   (CV_TNODE, "ENODEHV", "Hypervisor parameters verification failure")
1443 CV_ENODELVM = \
1444   (CV_TNODE, "ENODELVM", "LVM-related node error")
1445 CV_ENODEN1 = \
1446   (CV_TNODE, "ENODEN1", "Not enough memory to accommodate instance failovers")
1447 CV_ENODENET = \
1448   (CV_TNODE, "ENODENET", "Network-related node error")
1449 CV_ENODEOS = \
1450   (CV_TNODE, "ENODEOS", "OS-related node error")
1451 CV_ENODEORPHANINSTANCE = \
1452   (CV_TNODE, "ENODEORPHANINSTANCE", "Unknown intance running on a node")
1453 CV_ENODEORPHANLV = \
1454   (CV_TNODE, "ENODEORPHANLV", "Unknown LVM logical volume")
1455 CV_ENODERPC = \
1456   (CV_TNODE, "ENODERPC",
1457    "Error during connection to the primary node of an instance")
1458 CV_ENODESSH = \
1459   (CV_TNODE, "ENODESSH", "SSH-related node error")
1460 CV_ENODEVERSION = \
1461   (CV_TNODE, "ENODEVERSION",
1462    "Protocol version mismatch or Ganeti version mismatch")
1463 CV_ENODESETUP = \
1464   (CV_TNODE, "ENODESETUP", "Node setup error")
1465 CV_ENODETIME = \
1466   (CV_TNODE, "ENODETIME", "Node returned invalid time")
1467 CV_ENODEOOBPATH = \
1468   (CV_TNODE, "ENODEOOBPATH", "Invalid Out Of Band path")
1469 CV_ENODEUSERSCRIPTS = \
1470   (CV_TNODE, "ENODEUSERSCRIPTS", "User scripts not present or not executable")
1471 CV_ENODEFILESTORAGEPATHS = \
1472   (CV_TNODE, "ENODEFILESTORAGEPATHS", "Detected bad file storage paths")
1473
1474 CV_ALL_ECODES = compat.UniqueFrozenset([
1475   CV_ECLUSTERCFG,
1476   CV_ECLUSTERCERT,
1477   CV_ECLUSTERFILECHECK,
1478   CV_ECLUSTERDANGLINGNODES,
1479   CV_ECLUSTERDANGLINGINST,
1480   CV_EINSTANCEBADNODE,
1481   CV_EINSTANCEDOWN,
1482   CV_EINSTANCELAYOUT,
1483   CV_EINSTANCEMISSINGDISK,
1484   CV_EINSTANCEFAULTYDISK,
1485   CV_EINSTANCEWRONGNODE,
1486   CV_EINSTANCESPLITGROUPS,
1487   CV_EINSTANCEPOLICY,
1488   CV_ENODEDRBD,
1489   CV_ENODEDRBDHELPER,
1490   CV_ENODEFILECHECK,
1491   CV_ENODEHOOKS,
1492   CV_ENODEHV,
1493   CV_ENODELVM,
1494   CV_ENODEN1,
1495   CV_ENODENET,
1496   CV_ENODEOS,
1497   CV_ENODEORPHANINSTANCE,
1498   CV_ENODEORPHANLV,
1499   CV_ENODERPC,
1500   CV_ENODESSH,
1501   CV_ENODEVERSION,
1502   CV_ENODESETUP,
1503   CV_ENODETIME,
1504   CV_ENODEOOBPATH,
1505   CV_ENODEUSERSCRIPTS,
1506   CV_ENODEFILESTORAGEPATHS,
1507   ])
1508
1509 CV_ALL_ECODES_STRINGS = \
1510   compat.UniqueFrozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1511
1512 # Node verify constants
1513 NV_DRBDHELPER = "drbd-helper"
1514 NV_DRBDLIST = "drbd-list"
1515 NV_FILELIST = "filelist"
1516 NV_HVINFO = "hvinfo"
1517 NV_HYPERVISOR = "hypervisor"
1518 NV_HVPARAMS = "hvparms"
1519 NV_INSTANCELIST = "instancelist"
1520 NV_LVLIST = "lvlist"
1521 NV_MASTERIP = "master-ip"
1522 NV_NODELIST = "nodelist"
1523 NV_NODENETTEST = "node-net-test"
1524 NV_NODESETUP = "nodesetup"
1525 NV_OSLIST = "oslist"
1526 NV_PVLIST = "pvlist"
1527 NV_TIME = "time"
1528 NV_VERSION = "version"
1529 NV_VGLIST = "vglist"
1530 NV_VMNODES = "vmnodes"
1531 NV_OOB_PATHS = "oob-paths"
1532 NV_BRIDGES = "bridges"
1533 NV_USERSCRIPTS = "user-scripts"
1534 NV_FILE_STORAGE_PATHS = "file-storage-paths"
1535
1536 # Instance status
1537 INSTST_RUNNING = "running"
1538 INSTST_ADMINDOWN = "ADMIN_down"
1539 INSTST_ADMINOFFLINE = "ADMIN_offline"
1540 INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1541 INSTST_NODEDOWN = "ERROR_nodedown"
1542 INSTST_WRONGNODE = "ERROR_wrongnode"
1543 INSTST_ERRORUP = "ERROR_up"
1544 INSTST_ERRORDOWN = "ERROR_down"
1545 INSTST_ALL = compat.UniqueFrozenset([
1546   INSTST_RUNNING,
1547   INSTST_ADMINDOWN,
1548   INSTST_ADMINOFFLINE,
1549   INSTST_NODEOFFLINE,
1550   INSTST_NODEDOWN,
1551   INSTST_WRONGNODE,
1552   INSTST_ERRORUP,
1553   INSTST_ERRORDOWN,
1554   ])
1555
1556 # Admin states
1557 ADMINST_UP = "up"
1558 ADMINST_DOWN = "down"
1559 ADMINST_OFFLINE = "offline"
1560 ADMINST_ALL = compat.UniqueFrozenset([
1561   ADMINST_UP,
1562   ADMINST_DOWN,
1563   ADMINST_OFFLINE,
1564   ])
1565
1566 # Node roles
1567 NR_REGULAR = "R"
1568 NR_MASTER = "M"
1569 NR_MCANDIDATE = "C"
1570 NR_DRAINED = "D"
1571 NR_OFFLINE = "O"
1572 NR_ALL = compat.UniqueFrozenset([
1573   NR_REGULAR,
1574   NR_MASTER,
1575   NR_MCANDIDATE,
1576   NR_DRAINED,
1577   NR_OFFLINE,
1578   ])
1579
1580 # SSL certificate check constants (in days)
1581 SSL_CERT_EXPIRATION_WARN = 30
1582 SSL_CERT_EXPIRATION_ERROR = 7
1583
1584 # Allocator framework constants
1585 IALLOCATOR_VERSION = 2
1586 IALLOCATOR_DIR_IN = "in"
1587 IALLOCATOR_DIR_OUT = "out"
1588 VALID_IALLOCATOR_DIRECTIONS = compat.UniqueFrozenset([
1589   IALLOCATOR_DIR_IN,
1590   IALLOCATOR_DIR_OUT,
1591   ])
1592 IALLOCATOR_MODE_ALLOC = "allocate"
1593 IALLOCATOR_MODE_RELOC = "relocate"
1594 IALLOCATOR_MODE_CHG_GROUP = "change-group"
1595 IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1596 IALLOCATOR_MODE_MULTI_ALLOC = "multi-allocate"
1597 VALID_IALLOCATOR_MODES = compat.UniqueFrozenset([
1598   IALLOCATOR_MODE_ALLOC,
1599   IALLOCATOR_MODE_RELOC,
1600   IALLOCATOR_MODE_CHG_GROUP,
1601   IALLOCATOR_MODE_NODE_EVAC,
1602   IALLOCATOR_MODE_MULTI_ALLOC,
1603   ])
1604 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1605 DEFAULT_IALLOCATOR_SHORTCUT = "."
1606
1607 IALLOCATOR_NEVAC_PRI = "primary-only"
1608 IALLOCATOR_NEVAC_SEC = "secondary-only"
1609 IALLOCATOR_NEVAC_ALL = "all"
1610 IALLOCATOR_NEVAC_MODES = compat.UniqueFrozenset([
1611   IALLOCATOR_NEVAC_PRI,
1612   IALLOCATOR_NEVAC_SEC,
1613   IALLOCATOR_NEVAC_ALL,
1614   ])
1615
1616 # Node evacuation
1617 NODE_EVAC_PRI = "primary-only"
1618 NODE_EVAC_SEC = "secondary-only"
1619 NODE_EVAC_ALL = "all"
1620 NODE_EVAC_MODES = compat.UniqueFrozenset([
1621   NODE_EVAC_PRI,
1622   NODE_EVAC_SEC,
1623   NODE_EVAC_ALL,
1624   ])
1625
1626 # Job queue
1627 JOB_QUEUE_VERSION = 1
1628 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1629
1630 JOB_ID_TEMPLATE = r"\d+"
1631 JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1632
1633 # unchanged job return
1634 JOB_NOTCHANGED = "nochange"
1635
1636 # Job status
1637 JOB_STATUS_QUEUED = "queued"
1638 JOB_STATUS_WAITING = "waiting"
1639 JOB_STATUS_CANCELING = "canceling"
1640 JOB_STATUS_RUNNING = "running"
1641 JOB_STATUS_CANCELED = "canceled"
1642 JOB_STATUS_SUCCESS = "success"
1643 JOB_STATUS_ERROR = "error"
1644 JOBS_PENDING = compat.UniqueFrozenset([
1645   JOB_STATUS_QUEUED,
1646   JOB_STATUS_WAITING,
1647   JOB_STATUS_CANCELING,
1648   ])
1649 JOBS_FINALIZED = compat.UniqueFrozenset([
1650   JOB_STATUS_CANCELED,
1651   JOB_STATUS_SUCCESS,
1652   JOB_STATUS_ERROR,
1653   ])
1654 JOB_STATUS_ALL = compat.UniqueFrozenset([
1655   JOB_STATUS_RUNNING,
1656   ]) | JOBS_PENDING | JOBS_FINALIZED
1657
1658 # OpCode status
1659 # not yet finalized
1660 OP_STATUS_QUEUED = "queued"
1661 OP_STATUS_WAITING = "waiting"
1662 OP_STATUS_CANCELING = "canceling"
1663 OP_STATUS_RUNNING = "running"
1664 # finalized
1665 OP_STATUS_CANCELED = "canceled"
1666 OP_STATUS_SUCCESS = "success"
1667 OP_STATUS_ERROR = "error"
1668 OPS_FINALIZED = compat.UniqueFrozenset([
1669   OP_STATUS_CANCELED,
1670   OP_STATUS_SUCCESS,
1671   OP_STATUS_ERROR,
1672   ])
1673
1674 # OpCode priority
1675 OP_PRIO_LOWEST = +19
1676 OP_PRIO_HIGHEST = -20
1677
1678 OP_PRIO_LOW = +10
1679 OP_PRIO_NORMAL = 0
1680 OP_PRIO_HIGH = -10
1681
1682 OP_PRIO_SUBMIT_VALID = compat.UniqueFrozenset([
1683   OP_PRIO_LOW,
1684   OP_PRIO_NORMAL,
1685   OP_PRIO_HIGH,
1686   ])
1687
1688 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1689
1690 # Lock recalculate mode
1691 LOCKS_REPLACE = "replace"
1692 LOCKS_APPEND = "append"
1693
1694 # Lock timeout (sum) before we should go into blocking acquire (still
1695 # can be reset by priority change); computed as max time (10 hours)
1696 # before we should actually go into blocking acquire given that we
1697 # start from default priority level; in seconds
1698 # TODO
1699 LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / (OP_PRIO_DEFAULT - OP_PRIO_HIGHEST)
1700 LOCK_ATTEMPTS_MAXWAIT = 15.0
1701 LOCK_ATTEMPTS_MINWAIT = 1.0
1702
1703 # Execution log types
1704 ELOG_MESSAGE = "message"
1705 ELOG_REMOTE_IMPORT = "remote-import"
1706 ELOG_JQUEUE_TEST = "jqueue-test"
1707
1708 # /etc/hosts modification
1709 ETC_HOSTS_ADD = "add"
1710 ETC_HOSTS_REMOVE = "remove"
1711
1712 # Job queue test
1713 JQT_MSGPREFIX = "TESTMSG="
1714 JQT_EXPANDNAMES = "expandnames"
1715 JQT_EXEC = "exec"
1716 JQT_LOGMSG = "logmsg"
1717 JQT_STARTMSG = "startmsg"
1718 JQT_ALL = compat.UniqueFrozenset([
1719   JQT_EXPANDNAMES,
1720   JQT_EXEC,
1721   JQT_LOGMSG,
1722   JQT_STARTMSG,
1723   ])
1724
1725 # Query resources
1726 QR_CLUSTER = "cluster"
1727 QR_INSTANCE = "instance"
1728 QR_NODE = "node"
1729 QR_LOCK = "lock"
1730 QR_GROUP = "group"
1731 QR_OS = "os"
1732 QR_JOB = "job"
1733 QR_EXPORT = "export"
1734 QR_NETWORK = "network"
1735 QR_EXTSTORAGE = "extstorage"
1736
1737 #: List of resources which can be queried using L{opcodes.OpQuery}
1738 QR_VIA_OP = compat.UniqueFrozenset([
1739   QR_CLUSTER,
1740   QR_INSTANCE,
1741   QR_NODE,
1742   QR_GROUP,
1743   QR_OS,
1744   QR_EXPORT,
1745   QR_NETWORK,
1746   QR_EXTSTORAGE,
1747   ])
1748
1749 #: List of resources which can be queried using Local UniX Interface
1750 QR_VIA_LUXI = QR_VIA_OP.union([
1751   QR_LOCK,
1752   QR_JOB,
1753   ])
1754
1755 #: List of resources which can be queried using RAPI
1756 QR_VIA_RAPI = QR_VIA_LUXI
1757
1758 # Query field types
1759 QFT_UNKNOWN = "unknown"
1760 QFT_TEXT = "text"
1761 QFT_BOOL = "bool"
1762 QFT_NUMBER = "number"
1763 QFT_UNIT = "unit"
1764 QFT_TIMESTAMP = "timestamp"
1765 QFT_OTHER = "other"
1766
1767 #: All query field types
1768 QFT_ALL = compat.UniqueFrozenset([
1769   QFT_UNKNOWN,
1770   QFT_TEXT,
1771   QFT_BOOL,
1772   QFT_NUMBER,
1773   QFT_UNIT,
1774   QFT_TIMESTAMP,
1775   QFT_OTHER,
1776   ])
1777
1778 # Query result field status (don't change or reuse values as they're used by
1779 # clients)
1780 #: Normal field status
1781 RS_NORMAL = 0
1782 #: Unknown field
1783 RS_UNKNOWN = 1
1784 #: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1785 RS_NODATA = 2
1786 #: Value unavailable/unsupported for item; if this field is supported
1787 #: but we cannot get the data for the moment, RS_NODATA or
1788 #: RS_OFFLINE should be used
1789 RS_UNAVAIL = 3
1790 #: Resource marked offline
1791 RS_OFFLINE = 4
1792
1793 RS_ALL = compat.UniqueFrozenset([
1794   RS_NORMAL,
1795   RS_UNKNOWN,
1796   RS_NODATA,
1797   RS_UNAVAIL,
1798   RS_OFFLINE,
1799   ])
1800
1801 #: Dictionary with special field cases and their verbose/terse formatting
1802 RSS_DESCRIPTION = {
1803   RS_UNKNOWN: ("(unknown)", "??"),
1804   RS_NODATA: ("(nodata)", "?"),
1805   RS_OFFLINE: ("(offline)", "*"),
1806   RS_UNAVAIL: ("(unavail)", "-"),
1807   }
1808
1809 # max dynamic devices
1810 MAX_NICS = 8
1811 MAX_DISKS = 16
1812
1813 # SSCONF file prefix
1814 SSCONF_FILEPREFIX = "ssconf_"
1815 # SSCONF keys
1816 SS_CLUSTER_NAME = "cluster_name"
1817 SS_CLUSTER_TAGS = "cluster_tags"
1818 SS_FILE_STORAGE_DIR = "file_storage_dir"
1819 SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1820 SS_MASTER_CANDIDATES = "master_candidates"
1821 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1822 SS_MASTER_IP = "master_ip"
1823 SS_MASTER_NETDEV = "master_netdev"
1824 SS_MASTER_NETMASK = "master_netmask"
1825 SS_MASTER_NODE = "master_node"
1826 SS_NODE_LIST = "node_list"
1827 SS_NODE_PRIMARY_IPS = "node_primary_ips"
1828 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1829 SS_OFFLINE_NODES = "offline_nodes"
1830 SS_ONLINE_NODES = "online_nodes"
1831 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1832 SS_INSTANCE_LIST = "instance_list"
1833 SS_RELEASE_VERSION = "release_version"
1834 SS_HYPERVISOR_LIST = "hypervisor_list"
1835 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1836 SS_UID_POOL = "uid_pool"
1837 SS_NODEGROUPS = "nodegroups"
1838 SS_NETWORKS = "networks"
1839
1840 SS_FILE_PERMS = 0444
1841
1842 # cluster wide default parameters
1843 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1844
1845 HVC_DEFAULTS = {
1846   HT_XEN_PVM: {
1847     HV_USE_BOOTLOADER: False,
1848     HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1849     HV_BOOTLOADER_ARGS: "",
1850     HV_KERNEL_PATH: XEN_KERNEL,
1851     HV_INITRD_PATH: "",
1852     HV_ROOT_PATH: "/dev/sda1",
1853     HV_KERNEL_ARGS: "ro",
1854     HV_MIGRATION_PORT: 8002,
1855     HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1856     HV_BLOCKDEV_PREFIX: "sd",
1857     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1858     HV_CPU_MASK: CPU_PINNING_ALL,
1859     HV_CPU_CAP: 0,
1860     HV_CPU_WEIGHT: 256,
1861     },
1862   HT_XEN_HVM: {
1863     HV_BOOT_ORDER: "cd",
1864     HV_CDROM_IMAGE_PATH: "",
1865     HV_NIC_TYPE: HT_NIC_RTL8139,
1866     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1867     HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1868     HV_VNC_PASSWORD_FILE: pathutils.VNC_PASSWORD_FILE,
1869     HV_ACPI: True,
1870     HV_PAE: True,
1871     HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1872     HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1873     HV_MIGRATION_PORT: 8002,
1874     HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1875     HV_USE_LOCALTIME: False,
1876     HV_BLOCKDEV_PREFIX: "hd",
1877     HV_PASSTHROUGH: "",
1878     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1879     HV_CPU_MASK: CPU_PINNING_ALL,
1880     HV_CPU_CAP: 0,
1881     HV_CPU_WEIGHT: 256,
1882     },
1883   HT_KVM: {
1884     HV_KERNEL_PATH: KVM_KERNEL,
1885     HV_INITRD_PATH: "",
1886     HV_KERNEL_ARGS: "ro",
1887     HV_ROOT_PATH: "/dev/vda1",
1888     HV_ACPI: True,
1889     HV_SERIAL_CONSOLE: True,
1890     HV_VNC_BIND_ADDRESS: "",
1891     HV_VNC_TLS: False,
1892     HV_VNC_X509: "",
1893     HV_VNC_X509_VERIFY: False,
1894     HV_VNC_PASSWORD_FILE: "",
1895     HV_KVM_SPICE_BIND: "",
1896     HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1897     HV_KVM_SPICE_PASSWORD_FILE: "",
1898     HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1899     HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1900     HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1901     HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1902     HV_KVM_SPICE_AUDIO_COMPR: True,
1903     HV_KVM_SPICE_USE_TLS: False,
1904     HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1905     HV_KVM_SPICE_USE_VDAGENT: True,
1906     HV_KVM_FLOPPY_IMAGE_PATH: "",
1907     HV_CDROM_IMAGE_PATH: "",
1908     HV_KVM_CDROM2_IMAGE_PATH: "",
1909     HV_BOOT_ORDER: HT_BO_DISK,
1910     HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1911     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1912     HV_KVM_CDROM_DISK_TYPE: "",
1913     HV_USB_MOUSE: "",
1914     HV_KEYMAP: "",
1915     HV_MIGRATION_PORT: 8102,
1916     HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1917     HV_MIGRATION_DOWNTIME: 30,  # ms
1918     HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1919     HV_USE_LOCALTIME: False,
1920     HV_DISK_CACHE: HT_CACHE_DEFAULT,
1921     HV_SECURITY_MODEL: HT_SM_NONE,
1922     HV_SECURITY_DOMAIN: "",
1923     HV_KVM_FLAG: "",
1924     HV_VHOST_NET: False,
1925     HV_KVM_USE_CHROOT: False,
1926     HV_MEM_PATH: "",
1927     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1928     HV_CPU_MASK: CPU_PINNING_ALL,
1929     HV_CPU_TYPE: "",
1930     },
1931   HT_FAKE: {},
1932   HT_CHROOT: {
1933     HV_INIT_SCRIPT: "/ganeti-chroot",
1934     },
1935   HT_LXC: {
1936     HV_CPU_MASK: "",
1937     },
1938   }
1939
1940 HVC_GLOBALS = compat.UniqueFrozenset([
1941   HV_MIGRATION_PORT,
1942   HV_MIGRATION_BANDWIDTH,
1943   HV_MIGRATION_MODE,
1944   ])
1945
1946 BEC_DEFAULTS = {
1947   BE_MINMEM: 128,
1948   BE_MAXMEM: 128,
1949   BE_VCPUS: 1,
1950   BE_AUTO_BALANCE: True,
1951   BE_ALWAYS_FAILOVER: False,
1952   BE_SPINDLE_USE: 1,
1953   }
1954
1955 NDC_DEFAULTS = {
1956   ND_OOB_PROGRAM: "",
1957   ND_SPINDLE_COUNT: 1,
1958   ND_EXCLUSIVE_STORAGE: False,
1959   }
1960
1961 DISK_LD_DEFAULTS = {
1962   LD_DRBD8: {
1963     LDP_RESYNC_RATE: CLASSIC_DRBD_SYNC_SPEED,
1964     LDP_BARRIERS: _autoconf.DRBD_BARRIERS,
1965     LDP_NO_META_FLUSH: _autoconf.DRBD_NO_META_FLUSH,
1966     LDP_DEFAULT_METAVG: DEFAULT_VG,
1967     LDP_DISK_CUSTOM: "",
1968     LDP_NET_CUSTOM: "",
1969     LDP_DYNAMIC_RESYNC: False,
1970
1971     # The default values for the DRBD dynamic resync speed algorithm are taken
1972     # from the drbsetup 8.3.11 man page, except for c-plan-ahead (that we
1973     # don't need to set to 0, because we have a separate option to enable it)
1974     # and for c-max-rate, that we cap to the default value for the static resync
1975     # rate.
1976     LDP_PLAN_AHEAD: 20, # ds
1977     LDP_FILL_TARGET: 0, # sectors
1978     LDP_DELAY_TARGET: 1, # ds
1979     LDP_MAX_RATE: CLASSIC_DRBD_SYNC_SPEED, # KiB/s
1980     LDP_MIN_RATE: 4 * 1024, # KiB/s
1981     },
1982   LD_LV: {
1983     LDP_STRIPES: _autoconf.LVM_STRIPECOUNT
1984     },
1985   LD_FILE: {},
1986   LD_BLOCKDEV: {},
1987   LD_RBD: {
1988     LDP_POOL: "rbd"
1989     },
1990   LD_EXT: {},
1991   }
1992
1993 # readability shortcuts
1994 _LV_DEFAULTS = DISK_LD_DEFAULTS[LD_LV]
1995 _DRBD_DEFAULTS = DISK_LD_DEFAULTS[LD_DRBD8]
1996
1997 DISK_DT_DEFAULTS = {
1998   DT_PLAIN: {
1999     LV_STRIPES: DISK_LD_DEFAULTS[LD_LV][LDP_STRIPES],
2000     },
2001   DT_DRBD8: {
2002     DRBD_RESYNC_RATE: _DRBD_DEFAULTS[LDP_RESYNC_RATE],
2003     DRBD_DATA_STRIPES: _LV_DEFAULTS[LDP_STRIPES],
2004     DRBD_META_STRIPES: _LV_DEFAULTS[LDP_STRIPES],
2005     DRBD_DISK_BARRIERS: _DRBD_DEFAULTS[LDP_BARRIERS],
2006     DRBD_META_BARRIERS: _DRBD_DEFAULTS[LDP_NO_META_FLUSH],
2007     DRBD_DEFAULT_METAVG: _DRBD_DEFAULTS[LDP_DEFAULT_METAVG],
2008     DRBD_DISK_CUSTOM: _DRBD_DEFAULTS[LDP_DISK_CUSTOM],
2009     DRBD_NET_CUSTOM: _DRBD_DEFAULTS[LDP_NET_CUSTOM],
2010     DRBD_DYNAMIC_RESYNC: _DRBD_DEFAULTS[LDP_DYNAMIC_RESYNC],
2011     DRBD_PLAN_AHEAD: _DRBD_DEFAULTS[LDP_PLAN_AHEAD],
2012     DRBD_FILL_TARGET: _DRBD_DEFAULTS[LDP_FILL_TARGET],
2013     DRBD_DELAY_TARGET: _DRBD_DEFAULTS[LDP_DELAY_TARGET],
2014     DRBD_MAX_RATE: _DRBD_DEFAULTS[LDP_MAX_RATE],
2015     DRBD_MIN_RATE: _DRBD_DEFAULTS[LDP_MIN_RATE],
2016     },
2017   DT_DISKLESS: {},
2018   DT_FILE: {},
2019   DT_SHARED_FILE: {},
2020   DT_BLOCK: {},
2021   DT_RBD: {
2022     RBD_POOL: DISK_LD_DEFAULTS[LD_RBD][LDP_POOL]
2023     },
2024   DT_EXT: {},
2025   }
2026
2027 # we don't want to export the shortcuts
2028 del _LV_DEFAULTS, _DRBD_DEFAULTS
2029
2030 NICC_DEFAULTS = {
2031   NIC_MODE: NIC_MODE_BRIDGED,
2032   NIC_LINK: DEFAULT_BRIDGE,
2033   }
2034
2035 # All of the following values are quite arbitrarily - there are no
2036 # "good" defaults, these must be customised per-site
2037 IPOLICY_DEFAULTS = {
2038   ISPECS_MIN: {
2039     ISPEC_MEM_SIZE: 128,
2040     ISPEC_CPU_COUNT: 1,
2041     ISPEC_DISK_COUNT: 1,
2042     ISPEC_DISK_SIZE: 1024,
2043     ISPEC_NIC_COUNT: 1,
2044     ISPEC_SPINDLE_USE: 1,
2045     },
2046   ISPECS_MAX: {
2047     ISPEC_MEM_SIZE: 32768,
2048     ISPEC_CPU_COUNT: 8,
2049     ISPEC_DISK_COUNT: MAX_DISKS,
2050     ISPEC_DISK_SIZE: 1024 * 1024,
2051     ISPEC_NIC_COUNT: MAX_NICS,
2052     ISPEC_SPINDLE_USE: 12,
2053     },
2054   ISPECS_STD: {
2055     ISPEC_MEM_SIZE: 128,
2056     ISPEC_CPU_COUNT: 1,
2057     ISPEC_DISK_COUNT: 1,
2058     ISPEC_DISK_SIZE: 1024,
2059     ISPEC_NIC_COUNT: 1,
2060     ISPEC_SPINDLE_USE: 1,
2061     },
2062   IPOLICY_DTS: DISK_TEMPLATES,
2063   IPOLICY_VCPU_RATIO: 4.0,
2064   IPOLICY_SPINDLE_RATIO: 32.0,
2065   }
2066
2067 MASTER_POOL_SIZE_DEFAULT = 10
2068
2069 # Exclusive storage:
2070 # Error margin used to compare physical disks
2071 PART_MARGIN = .01
2072 # Space reserved when creating instance disks
2073 PART_RESERVED = .02
2074
2075 CONFD_PROTOCOL_VERSION = 1
2076
2077 CONFD_REQ_PING = 0
2078 CONFD_REQ_NODE_ROLE_BYNAME = 1
2079 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
2080 CONFD_REQ_CLUSTER_MASTER = 3
2081 CONFD_REQ_NODE_PIP_LIST = 4
2082 CONFD_REQ_MC_PIP_LIST = 5
2083 CONFD_REQ_INSTANCES_IPS_LIST = 6
2084 CONFD_REQ_NODE_DRBD = 7
2085
2086 # Confd request query fields. These are used to narrow down queries.
2087 # These must be strings rather than integers, because json-encoding
2088 # converts them to strings anyway, as they're used as dict-keys.
2089 CONFD_REQQ_LINK = "0"
2090 CONFD_REQQ_IP = "1"
2091 CONFD_REQQ_IPLIST = "2"
2092 CONFD_REQQ_FIELDS = "3"
2093
2094 CONFD_REQFIELD_NAME = "0"
2095 CONFD_REQFIELD_IP = "1"
2096 CONFD_REQFIELD_MNODE_PIP = "2"
2097
2098 CONFD_REQS = compat.UniqueFrozenset([
2099   CONFD_REQ_PING,
2100   CONFD_REQ_NODE_ROLE_BYNAME,
2101   CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
2102   CONFD_REQ_CLUSTER_MASTER,
2103   CONFD_REQ_NODE_PIP_LIST,
2104   CONFD_REQ_MC_PIP_LIST,
2105   CONFD_REQ_INSTANCES_IPS_LIST,
2106   CONFD_REQ_NODE_DRBD,
2107   ])
2108
2109 CONFD_REPL_STATUS_OK = 0
2110 CONFD_REPL_STATUS_ERROR = 1
2111 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
2112
2113 CONFD_REPL_STATUSES = compat.UniqueFrozenset([
2114   CONFD_REPL_STATUS_OK,
2115   CONFD_REPL_STATUS_ERROR,
2116   CONFD_REPL_STATUS_NOTIMPLEMENTED,
2117   ])
2118
2119 (CONFD_NODE_ROLE_MASTER,
2120  CONFD_NODE_ROLE_CANDIDATE,
2121  CONFD_NODE_ROLE_OFFLINE,
2122  CONFD_NODE_ROLE_DRAINED,
2123  CONFD_NODE_ROLE_REGULAR,
2124  ) = range(5)
2125
2126 # A few common errors for confd
2127 CONFD_ERROR_UNKNOWN_ENTRY = 1
2128 CONFD_ERROR_INTERNAL = 2
2129 CONFD_ERROR_ARGUMENT = 3
2130
2131 # Each request is "salted" by the current timestamp.
2132 # This constants decides how many seconds of skew to accept.
2133 # TODO: make this a default and allow the value to be more configurable
2134 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
2135
2136 # When we haven't reloaded the config for more than this amount of seconds, we
2137 # force a test to see if inotify is betraying us.
2138 CONFD_CONFIG_RELOAD_TIMEOUT = 60
2139
2140 # If we receive more than one update in this amount of seconds, we move to
2141 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
2142 # to serve more requests.
2143 CONFD_CONFIG_RELOAD_RATELIMIT = 2
2144
2145 # Magic number prepended to all confd queries.
2146 # This allows us to distinguish different types of confd protocols and handle
2147 # them. For example by changing this we can move the whole payload to be
2148 # compressed, or move away from json.
2149 CONFD_MAGIC_FOURCC = "plj0"
2150
2151 # By default a confd request is sent to the minimum between this number and all
2152 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
2153 # we should have enough answers to be able to compare more than one.
2154 CONFD_DEFAULT_REQ_COVERAGE = 6
2155
2156 # Timeout in seconds to expire pending query request in the confd client
2157 # library. We don't actually expect any answer more than 10 seconds after we
2158 # sent a request.
2159 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
2160
2161 # Maximum UDP datagram size.
2162 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
2163 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
2164 #   (assuming we can't use jumbo frames)
2165 # We just set this to 60K, which should be enough
2166 MAX_UDP_DATA_SIZE = 61440
2167
2168 # User-id pool minimum/maximum acceptable user-ids.
2169 UIDPOOL_UID_MIN = 0
2170 UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
2171
2172 # Name or path of the pgrep command
2173 PGREP = "pgrep"
2174
2175 # Name of the node group that gets created at cluster init or upgrade
2176 INITIAL_NODE_GROUP_NAME = "default"
2177
2178 # Possible values for NodeGroup.alloc_policy
2179 ALLOC_POLICY_PREFERRED = "preferred"
2180 ALLOC_POLICY_LAST_RESORT = "last_resort"
2181 ALLOC_POLICY_UNALLOCABLE = "unallocable"
2182 VALID_ALLOC_POLICIES = [
2183   ALLOC_POLICY_PREFERRED,
2184   ALLOC_POLICY_LAST_RESORT,
2185   ALLOC_POLICY_UNALLOCABLE,
2186   ]
2187
2188 # Temporary external/shared storage parameters
2189 BLOCKDEV_DRIVER_MANUAL = "manual"
2190
2191 # qemu-img path, required for ovfconverter
2192 QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
2193
2194 # Whether htools was enabled at compilation time
2195 HTOOLS = _autoconf.HTOOLS
2196 # The hail iallocator
2197 IALLOC_HAIL = "hail"
2198
2199 # Fake opcodes for functions that have hooks attached to them via
2200 # backend.RunLocalHooks
2201 FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
2202 FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
2203
2204 # SSH key types
2205 SSHK_RSA = "rsa"
2206 SSHK_DSA = "dsa"
2207 SSHK_ALL = compat.UniqueFrozenset([SSHK_RSA, SSHK_DSA])
2208
2209 # SSH authorized key types
2210 SSHAK_RSA = "ssh-rsa"
2211 SSHAK_DSS = "ssh-dss"
2212 SSHAK_ALL = compat.UniqueFrozenset([SSHAK_RSA, SSHAK_DSS])
2213
2214 # SSH setup
2215 SSHS_CLUSTER_NAME = "cluster_name"
2216 SSHS_SSH_HOST_KEY = "ssh_host_key"
2217 SSHS_SSH_ROOT_KEY = "ssh_root_key"
2218 SSHS_NODE_DAEMON_CERTIFICATE = "node_daemon_certificate"
2219
2220 #: Key files for SSH daemon
2221 SSH_DAEMON_KEYFILES = {
2222   SSHK_RSA: (pathutils.SSH_HOST_RSA_PRIV, pathutils.SSH_HOST_RSA_PUB),
2223   SSHK_DSA: (pathutils.SSH_HOST_DSA_PRIV, pathutils.SSH_HOST_DSA_PUB),
2224   }
2225
2226 # Node daemon setup
2227 NDS_CLUSTER_NAME = "cluster_name"
2228 NDS_NODE_DAEMON_CERTIFICATE = "node_daemon_certificate"
2229 NDS_SSCONF = "ssconf"
2230 NDS_START_NODE_DAEMON = "start_node_daemon"
2231
2232 # Path generating random UUID
2233 RANDOM_UUID_FILE = "/proc/sys/kernel/random/uuid"
2234
2235 # Regex string for verifying a UUID
2236 UUID_REGEX = "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
2237
2238 # Do not re-export imported modules
2239 del re, _vcsversion, _autoconf, socket, pathutils, compat