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