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