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