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