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

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