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 HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
 370
 371 # hooks subject type (what object type does the LU deal with)
 372 HTYPE_CLUSTER = "CLUSTER"
 373 HTYPE_NODE = "NODE"
 374 HTYPE_GROUP = "GROUP"
 375 HTYPE_INSTANCE = "INSTANCE"
 376
 377 HKR_SKIP = 0
 378 HKR_FAIL = 1
 379 HKR_SUCCESS = 2
 380
 381 # Storage types
 382 ST_FILE = "file"
 383 ST_LVM_PV = "lvm-pv"
 384 ST_LVM_VG = "lvm-vg"
 385
 386 # Storage fields
 387 # first two are valid in LU context only, not passed to backend
 388 SF_NODE = "node"
 389 SF_TYPE = "type"
 390 # and the rest are valid in backend
 391 SF_NAME = "name"
 392 SF_SIZE = "size"
 393 SF_FREE = "free"
 394 SF_USED = "used"
 395 SF_ALLOCATABLE = "allocatable"
 396
 397 # Storage operations
 398 SO_FIX_CONSISTENCY = "fix-consistency"
 399
 400 # Available fields per storage type
 401 VALID_STORAGE_FIELDS = frozenset([
 402   SF_NAME,
 403   SF_TYPE,
 404   SF_SIZE,
 405   SF_USED,
 406   SF_FREE,
 407   SF_ALLOCATABLE
 408   ])
 409
 410 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
 411
 412 MODIFIABLE_STORAGE_FIELDS = {
 413   ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
 414   }
 415
 416 VALID_STORAGE_OPERATIONS = {
 417   ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
 418   }
 419
 420 # Local disk status
 421 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
 422 (LDS_OKAY,
 423  LDS_UNKNOWN,
 424  LDS_FAULTY) = range(1, 4)
 425
 426 # disk template types
 427 DT_DISKLESS = "diskless"
 428 DT_PLAIN = "plain"
 429 DT_DRBD8 = "drbd"
 430 DT_FILE = "file"
 431 DT_SHARED_FILE = "sharedfile"
 432 DT_BLOCK = "blockdev"
 433
 434 # the set of network-mirrored disk templates
 435 DTS_INT_MIRROR = frozenset([DT_DRBD8])
 436
 437 # the set of externally-mirrored disk templates (e.g. SAN, NAS)
 438 DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK])
 439
 440 # the set of non-lvm-based disk templates
 441 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE, DT_BLOCK])
 442
 443 # the set of disk templates which can be grown
 444 DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE])
 445
 446 # the set of disk templates that allow adoption
 447 DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])
 448
 449 # the set of disk templates that *must* use adoption
 450 DTS_MUST_ADOPT = frozenset([DT_BLOCK])
 451
 452 # the set of disk templates that allow migrations
 453 DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
 454
 455 # the set of file based disk templates
 456 DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
 457
 458 # logical disk types
 459 LD_LV = "lvm"
 460 LD_DRBD8 = "drbd8"
 461 LD_FILE = "file"
 462 LD_BLOCKDEV = "blockdev"
 463 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV])
 464
 465 # drbd constants
 466 DRBD_HMAC_ALG = "md5"
 467 DRBD_NET_PROTOCOL = "C"
 468 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
 469
 470 # file backend driver
 471 FD_LOOP = "loop"
 472 FD_BLKTAP = "blktap"
 473
 474 # the set of drbd-like disk types
 475 LDS_DRBD = frozenset([LD_DRBD8])
 476
 477 # disk access mode
 478 DISK_RDONLY = "ro"
 479 DISK_RDWR = "rw"
 480 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
 481
 482 # disk replacement mode
 483 REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
 484 REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
 485 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
 486 REPLACE_DISK_AUTO = "replace_auto"
 487 REPLACE_MODES = frozenset([
 488   REPLACE_DISK_PRI,
 489   REPLACE_DISK_SEC,
 490   REPLACE_DISK_CHG,
 491   REPLACE_DISK_AUTO,
 492   ])
 493
 494 # Instance export mode
 495 EXPORT_MODE_LOCAL = "local"
 496 EXPORT_MODE_REMOTE = "remote"
 497 EXPORT_MODES = frozenset([
 498   EXPORT_MODE_LOCAL,
 499   EXPORT_MODE_REMOTE,
 500   ])
 501
 502 # Lock recalculate mode
 503 LOCKS_REPLACE = "replace"
 504 LOCKS_APPEND = "append"
 505
 506 # Lock timeout (sum) before we should go into blocking acquire (still
 507 # can be reset by priority change); computed as max time (10 hours)
 508 # before we should actually go into blocking acquire given that we
 509 # start from default priority level; in seconds
 510 LOCK_ATTEMPTS_TIMEOUT = 10 * 3600 / 20.0
 511 LOCK_ATTEMPTS_MAXWAIT = 15.0
 512 LOCK_ATTEMPTS_MINWAIT = 1.0
 513
 514 # instance creation modes
 515 INSTANCE_CREATE = "create"
 516 INSTANCE_IMPORT = "import"
 517 INSTANCE_REMOTE_IMPORT = "remote-import"
 518 INSTANCE_CREATE_MODES = frozenset([
 519   INSTANCE_CREATE,
 520   INSTANCE_IMPORT,
 521   INSTANCE_REMOTE_IMPORT,
 522   ])
 523
 524 # Remote import/export handshake message and version
 525 RIE_VERSION = 0
 526 RIE_HANDSHAKE = "Hi, I'm Ganeti"
 527
 528 # Remote import/export certificate validity in seconds
 529 RIE_CERT_VALIDITY = 24 * 60 * 60
 530
 531 # Overall timeout for establishing connection
 532 RIE_CONNECT_TIMEOUT = 180
 533
 534 # Export only: how long to wait per connection attempt (seconds)
 535 RIE_CONNECT_ATTEMPT_TIMEOUT = 20
 536
 537 # Export only: number of attempts to connect
 538 RIE_CONNECT_RETRIES = 10
 539
 540 #: Give child process up to 5 seconds to exit after sending a signal
 541 CHILD_LINGER_TIMEOUT = 5.0
 542
 543 DISK_TEMPLATES = frozenset([
 544   DT_DISKLESS,
 545   DT_PLAIN,
 546   DT_DRBD8,
 547   DT_FILE,
 548   DT_SHARED_FILE,
 549   DT_BLOCK
 550   ])
 551
 552 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
 553
 554 # import/export config options
 555 INISECT_EXP = "export"
 556 INISECT_INS = "instance"
 557 INISECT_HYP = "hypervisor"
 558 INISECT_BEP = "backend"
 559 INISECT_OSP = "os"
 560
 561 # dynamic device modification
 562 DDM_ADD = "add"
 563 DDM_REMOVE = "remove"
 564 DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
 565
 566 # common exit codes
 567 EXIT_SUCCESS = 0
 568 EXIT_FAILURE = 1
 569 EXIT_NOTCLUSTER = 5
 570 EXIT_NOTMASTER = 11
 571 EXIT_NODESETUP_ERROR = 12
 572 EXIT_CONFIRMATION = 13 # need user confirmation
 573
 574 #: Exit code for query operations with unknown fields
 575 EXIT_UNKNOWN_FIELD = 14
 576
 577 # tags
 578 TAG_CLUSTER = "cluster"
 579 TAG_NODEGROUP = "nodegroup"
 580 TAG_NODE = "node"
 581 TAG_INSTANCE = "instance"
 582 VALID_TAG_TYPES = frozenset([
 583   TAG_CLUSTER,
 584   TAG_NODEGROUP,
 585   TAG_NODE,
 586   TAG_INSTANCE,
 587   ])
 588 MAX_TAG_LEN = 128
 589 MAX_TAGS_PER_OBJ = 4096
 590
 591 # others
 592 DEFAULT_BRIDGE = "xen-br0"
 593 SYNC_SPEED = 60 * 1024
 594 IP4_ADDRESS_LOCALHOST = "127.0.0.1"
 595 IP4_ADDRESS_ANY = "0.0.0.0"
 596 IP6_ADDRESS_LOCALHOST = "::1"
 597 IP6_ADDRESS_ANY = "::"
 598 IP4_VERSION = 4
 599 IP6_VERSION = 6
 600 VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
 601 TCP_PING_TIMEOUT = 10
 602 GANETI_RUNAS = "root"
 603 DEFAULT_VG = "xenvg"
 604 DEFAULT_DRBD_HELPER = "/bin/true"
 605 MIN_VG_SIZE = 20480
 606 DEFAULT_MAC_PREFIX = "aa:00:00"
 607 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
 608 # default maximum instance wait time, in seconds.
 609 DEFAULT_SHUTDOWN_TIMEOUT = 120
 610 NODE_MAX_CLOCK_SKEW = 150
 611 # Time for an intra-cluster disk transfer to wait for a connection
 612 DISK_TRANSFER_CONNECT_TIMEOUT = 60
 613 # Disk index separator
 614 DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
 615 IP_COMMAND_PATH = _autoconf.IP_PATH
 616
 617 #: Key for job IDs in opcode result
 618 JOB_IDS_KEY = "jobs"
 619
 620 # runparts results
 621 (RUNPARTS_SKIP,
 622  RUNPARTS_RUN,
 623  RUNPARTS_ERR) = range(3)
 624
 625 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
 626
 627 # RPC constants
 628 (RPC_ENCODING_NONE,
 629  RPC_ENCODING_ZLIB_BASE64) = range(2)
 630
 631 # os related constants
 632 OS_SCRIPT_CREATE = "create"
 633 OS_SCRIPT_IMPORT = "import"
 634 OS_SCRIPT_EXPORT = "export"
 635 OS_SCRIPT_RENAME = "rename"
 636 OS_SCRIPT_VERIFY = "verify"
 637 OS_SCRIPTS = frozenset([
 638   OS_SCRIPT_CREATE,
 639   OS_SCRIPT_IMPORT,
 640   OS_SCRIPT_EXPORT,
 641   OS_SCRIPT_RENAME,
 642   OS_SCRIPT_VERIFY
 643   ])
 644
 645 OS_API_FILE = "ganeti_api_version"
 646 OS_VARIANTS_FILE = "variants.list"
 647 OS_PARAMETERS_FILE = "parameters.list"
 648
 649 OS_VALIDATE_PARAMETERS = "parameters"
 650 OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
 651
 652 # ssh constants
 653 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
 654 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
 655 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
 656 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
 657 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
 658 SSH = "ssh"
 659 SCP = "scp"
 660
 661 # reboot types
 662 INSTANCE_REBOOT_SOFT = "soft"
 663 INSTANCE_REBOOT_HARD = "hard"
 664 INSTANCE_REBOOT_FULL = "full"
 665
 666 REBOOT_TYPES = frozenset([
 667   INSTANCE_REBOOT_SOFT,
 668   INSTANCE_REBOOT_HARD,
 669   INSTANCE_REBOOT_FULL
 670   ])
 671
 672 # instance reboot behaviors
 673 INSTANCE_REBOOT_ALLOWED = "reboot"
 674 INSTANCE_REBOOT_EXIT = "exit"
 675
 676 REBOOT_BEHAVIORS = frozenset([
 677   INSTANCE_REBOOT_ALLOWED,
 678   INSTANCE_REBOOT_EXIT
 679   ])
 680
 681 VTYPE_STRING = "string"
 682 VTYPE_MAYBE_STRING = "maybe-string"
 683 VTYPE_BOOL = "bool"
 684 VTYPE_SIZE = "size" # size, in MiBs
 685 VTYPE_INT = "int"
 686 ENFORCEABLE_TYPES = frozenset([
 687   VTYPE_STRING,
 688   VTYPE_MAYBE_STRING,
 689   VTYPE_BOOL,
 690   VTYPE_SIZE,
 691   VTYPE_INT,
 692   ])
 693
 694 # Constant representing that the user does not specify any IP version
 695 IFACE_NO_IP_VERSION_SPECIFIED = 0
 696
 697 # HV parameter names (global namespace)
 698 HV_BOOT_ORDER = "boot_order"
 699 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
 700 HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
 701 HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
 702 HV_NIC_TYPE = "nic_type"
 703 HV_DISK_TYPE = "disk_type"
 704 HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
 705 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
 706 HV_VNC_PASSWORD_FILE = "vnc_password_file"
 707 HV_VNC_TLS = "vnc_tls"
 708 HV_VNC_X509 = "vnc_x509_path"
 709 HV_VNC_X509_VERIFY = "vnc_x509_verify"
 710 HV_KVM_SPICE_BIND = "spice_bind"
 711 HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
 712 HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
 713 HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"
 714 HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"
 715 HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"
 716 HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"
 717 HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"
 718 HV_KVM_SPICE_USE_TLS = "spice_use_tls"
 719 HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
 720 HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
 721 HV_ACPI = "acpi"
 722 HV_PAE = "pae"
 723 HV_USE_BOOTLOADER = "use_bootloader"
 724 HV_BOOTLOADER_ARGS = "bootloader_args"
 725 HV_BOOTLOADER_PATH = "bootloader_path"
 726 HV_KERNEL_ARGS = "kernel_args"
 727 HV_KERNEL_PATH = "kernel_path"
 728 HV_INITRD_PATH = "initrd_path"
 729 HV_ROOT_PATH = "root_path"
 730 HV_SERIAL_CONSOLE = "serial_console"
 731 HV_USB_MOUSE = "usb_mouse"
 732 HV_KEYMAP = "keymap"
 733 HV_DEVICE_MODEL = "device_model"
 734 HV_INIT_SCRIPT = "init_script"
 735 HV_MIGRATION_PORT = "migration_port"
 736 HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
 737 HV_MIGRATION_DOWNTIME = "migration_downtime"
 738 HV_MIGRATION_MODE = "migration_mode"
 739 HV_USE_LOCALTIME = "use_localtime"
 740 HV_DISK_CACHE = "disk_cache"
 741 HV_SECURITY_MODEL = "security_model"
 742 HV_SECURITY_DOMAIN = "security_domain"
 743 HV_KVM_FLAG = "kvm_flag"
 744 HV_VHOST_NET = "vhost_net"
 745 HV_KVM_USE_CHROOT = "use_chroot"
 746 HV_CPU_MASK = "cpu_mask"
 747 HV_MEM_PATH = "mem_path"
 748 HV_BLOCKDEV_PREFIX = "blockdev_prefix"
 749 HV_REBOOT_BEHAVIOR = "reboot_behavior"
 750
 751 HVS_PARAMETER_TYPES = {
 752   HV_BOOT_ORDER: VTYPE_STRING,
 753   HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
 754   HV_CDROM_IMAGE_PATH: VTYPE_STRING,
 755   HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
 756   HV_NIC_TYPE: VTYPE_STRING,
 757   HV_DISK_TYPE: VTYPE_STRING,
 758   HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
 759   HV_VNC_PASSWORD_FILE: VTYPE_STRING,
 760   HV_VNC_BIND_ADDRESS: VTYPE_STRING,
 761   HV_VNC_TLS: VTYPE_BOOL,
 762   HV_VNC_X509: VTYPE_STRING,
 763   HV_VNC_X509_VERIFY: VTYPE_BOOL,
 764   HV_KVM_SPICE_BIND: VTYPE_STRING,
 765   HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
 766   HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
 767   HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,
 768   HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,
 769   HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,
 770   HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,
 771   HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,
 772   HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
 773   HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
 774   HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
 775   HV_ACPI: VTYPE_BOOL,
 776   HV_PAE: VTYPE_BOOL,
 777   HV_USE_BOOTLOADER: VTYPE_BOOL,
 778   HV_BOOTLOADER_PATH: VTYPE_STRING,
 779   HV_BOOTLOADER_ARGS: VTYPE_STRING,
 780   HV_KERNEL_PATH: VTYPE_STRING,
 781   HV_KERNEL_ARGS: VTYPE_STRING,
 782   HV_INITRD_PATH: VTYPE_STRING,
 783   HV_ROOT_PATH: VTYPE_MAYBE_STRING,
 784   HV_SERIAL_CONSOLE: VTYPE_BOOL,
 785   HV_USB_MOUSE: VTYPE_STRING,
 786   HV_KEYMAP: VTYPE_STRING,
 787   HV_DEVICE_MODEL: VTYPE_STRING,
 788   HV_INIT_SCRIPT: VTYPE_STRING,
 789   HV_MIGRATION_PORT: VTYPE_INT,
 790   HV_MIGRATION_BANDWIDTH: VTYPE_INT,
 791   HV_MIGRATION_DOWNTIME: VTYPE_INT,
 792   HV_MIGRATION_MODE: VTYPE_STRING,
 793   HV_USE_LOCALTIME: VTYPE_BOOL,
 794   HV_DISK_CACHE: VTYPE_STRING,
 795   HV_SECURITY_MODEL: VTYPE_STRING,
 796   HV_SECURITY_DOMAIN: VTYPE_STRING,
 797   HV_KVM_FLAG: VTYPE_STRING,
 798   HV_VHOST_NET: VTYPE_BOOL,
 799   HV_KVM_USE_CHROOT: VTYPE_BOOL,
 800   HV_CPU_MASK: VTYPE_STRING,
 801   HV_MEM_PATH: VTYPE_STRING,
 802   HV_BLOCKDEV_PREFIX: VTYPE_STRING,
 803   HV_REBOOT_BEHAVIOR: VTYPE_STRING,
 804   }
 805
 806 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
 807
 808 # Migration statuses
 809 HV_MIGRATION_COMPLETED = "completed"
 810 HV_MIGRATION_ACTIVE = "active"
 811 HV_MIGRATION_FAILED = "failed"
 812 HV_MIGRATION_CANCELLED = "cancelled"
 813
 814 HV_MIGRATION_VALID_STATUSES = frozenset([
 815   HV_MIGRATION_COMPLETED,
 816   HV_MIGRATION_ACTIVE,
 817   HV_MIGRATION_FAILED,
 818   HV_MIGRATION_CANCELLED,
 819   ])
 820
 821 HV_MIGRATION_FAILED_STATUSES = frozenset([
 822   HV_MIGRATION_FAILED,
 823   HV_MIGRATION_CANCELLED,
 824   ])
 825
 826 # KVM-specific statuses
 827 HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES
 828
 829 # Node info keys
 830 HV_NODEINFO_KEY_VERSION = "hv_version"
 831
 832 # Hypervisor state
 833 HVST_MEMORY_TOTAL = "mem_total"
 834 HVST_MEMORY_NODE = "mem_node"
 835 HVST_MEMORY_HV = "mem_hv"
 836 HVST_CPU_TOTAL = "cpu_total"
 837 HVST_CPU_NODE = "cpu_node"
 838
 839 HVSTS_PARAMETER_TYPES = {
 840   HVST_MEMORY_TOTAL: VTYPE_INT,
 841   HVST_MEMORY_NODE: VTYPE_INT,
 842   HVST_MEMORY_HV: VTYPE_INT,
 843   HVST_CPU_TOTAL: VTYPE_INT,
 844   HVST_CPU_NODE: VTYPE_INT,
 845   }
 846
 847 HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())
 848
 849 # Disk state
 850 DS_DISK_TOTAL = "disk_total"
 851 DS_DISK_RESERVED = "disk_reserved"
 852 DS_DISK_OVERHEAD = "disk_overhead"
 853
 854 DSS_PARAMETER_TYPES = {
 855   DS_DISK_TOTAL: VTYPE_INT,
 856   DS_DISK_RESERVED: VTYPE_INT,
 857   DS_DISK_OVERHEAD: VTYPE_INT,
 858   }
 859
 860 DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())
 861
 862 # Backend parameter names
 863 BE_MEMORY = "memory" # deprecated and replaced by max and min mem
 864 BE_MAXMEM = "maxmem"
 865 BE_MINMEM = "minmem"
 866 BE_VCPUS = "vcpus"
 867 BE_AUTO_BALANCE = "auto_balance"
 868
 869 BES_PARAMETER_TYPES = {
 870     BE_MEMORY: VTYPE_SIZE,
 871     BE_MAXMEM: VTYPE_SIZE,
 872     BE_MINMEM: VTYPE_SIZE,
 873     BE_VCPUS: VTYPE_INT,
 874     BE_AUTO_BALANCE: VTYPE_BOOL,
 875     }
 876
 877 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
 878
 879 # Node parameter names
 880 ND_OOB_PROGRAM = "oob_program"
 881
 882 NDS_PARAMETER_TYPES = {
 883     ND_OOB_PROGRAM: VTYPE_MAYBE_STRING,
 884     }
 885
 886 NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())
 887
 888 # OOB supported commands
 889 OOB_POWER_ON = "power-on"
 890 OOB_POWER_OFF = "power-off"
 891 OOB_POWER_CYCLE = "power-cycle"
 892 OOB_POWER_STATUS = "power-status"
 893 OOB_HEALTH = "health"
 894
 895 OOB_COMMANDS = frozenset([
 896   OOB_POWER_ON,
 897   OOB_POWER_OFF,
 898   OOB_POWER_CYCLE,
 899   OOB_POWER_STATUS,
 900   OOB_HEALTH
 901   ])
 902
 903 OOB_POWER_STATUS_POWERED = "powered"
 904
 905 OOB_TIMEOUT = 60 # 60 seconds
 906 OOB_POWER_DELAY = 2.0 # 2 seconds
 907
 908 OOB_STATUS_OK = "OK"
 909 OOB_STATUS_WARNING = "WARNING"
 910 OOB_STATUS_CRITICAL = "CRITICAL"
 911 OOB_STATUS_UNKNOWN = "UNKNOWN"
 912
 913 OOB_STATUSES = frozenset([
 914   OOB_STATUS_OK,
 915   OOB_STATUS_WARNING,
 916   OOB_STATUS_CRITICAL,
 917   OOB_STATUS_UNKNOWN,
 918   ])
 919
 920 # Instance Parameters Profile
 921 PP_DEFAULT = "default"
 922
 923 # NIC_* constants are used inside the ganeti config
 924 NIC_MODE = "mode"
 925 NIC_LINK = "link"
 926
 927 NIC_MODE_BRIDGED = "bridged"
 928 NIC_MODE_ROUTED = "routed"
 929
 930 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
 931
 932 NICS_PARAMETER_TYPES = {
 933     NIC_MODE: VTYPE_STRING,
 934     NIC_LINK: VTYPE_STRING,
 935     }
 936
 937 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
 938
 939 # IDISK_* constants are used in opcodes, to create/change disks
 940 IDISK_SIZE = "size"
 941 IDISK_MODE = "mode"
 942 IDISK_ADOPT = "adopt"
 943 IDISK_VG = "vg"
 944 IDISK_METAVG = "metavg"
 945 IDISK_PARAMS_TYPES = {
 946   IDISK_SIZE: VTYPE_SIZE,
 947   IDISK_MODE: VTYPE_STRING,
 948   IDISK_ADOPT: VTYPE_STRING,
 949   IDISK_VG: VTYPE_STRING,
 950   IDISK_METAVG: VTYPE_STRING,
 951   }
 952 IDISK_PARAMS = frozenset(IDISK_PARAMS_TYPES.keys())
 953
 954 # INIC_* constants are used in opcodes, to create/change nics
 955 INIC_MAC = "mac"
 956 INIC_IP = "ip"
 957 INIC_MODE = "mode"
 958 INIC_LINK = "link"
 959 INIC_PARAMS_TYPES = {
 960   INIC_IP: VTYPE_MAYBE_STRING,
 961   INIC_LINK: VTYPE_STRING,
 962   INIC_MAC: VTYPE_STRING,
 963   INIC_MODE: VTYPE_STRING,
 964   }
 965 INIC_PARAMS = frozenset(INIC_PARAMS_TYPES.keys())
 966
 967 # Hypervisor constants
 968 HT_XEN_PVM = "xen-pvm"
 969 HT_FAKE = "fake"
 970 HT_XEN_HVM = "xen-hvm"
 971 HT_KVM = "kvm"
 972 HT_CHROOT = "chroot"
 973 HT_LXC = "lxc"
 974 HYPER_TYPES = frozenset([
 975   HT_XEN_PVM,
 976   HT_FAKE,
 977   HT_XEN_HVM,
 978   HT_KVM,
 979   HT_CHROOT,
 980   HT_LXC,
 981   ])
 982 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
 983
 984 VNC_BASE_PORT = 5900
 985 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
 986 VNC_DEFAULT_BIND_ADDRESS = IP4_ADDRESS_ANY
 987
 988 # NIC types
 989 HT_NIC_RTL8139 = "rtl8139"
 990 HT_NIC_NE2K_PCI = "ne2k_pci"
 991 HT_NIC_NE2K_ISA = "ne2k_isa"
 992 HT_NIC_I82551 = "i82551"
 993 HT_NIC_I85557B = "i82557b"
 994 HT_NIC_I8259ER = "i82559er"
 995 HT_NIC_PCNET = "pcnet"
 996 HT_NIC_E1000 = "e1000"
 997 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
 998
 999 HT_HVM_VALID_NIC_TYPES = frozenset([
1000   HT_NIC_RTL8139,
1001   HT_NIC_NE2K_PCI,
1002   HT_NIC_E1000,
1003   HT_NIC_NE2K_ISA,
1004   HT_NIC_PARAVIRTUAL
1005   ])
1006 HT_KVM_VALID_NIC_TYPES = frozenset([
1007   HT_NIC_RTL8139,
1008   HT_NIC_NE2K_PCI,
1009   HT_NIC_NE2K_ISA,
1010   HT_NIC_I82551,
1011   HT_NIC_I85557B,
1012   HT_NIC_I8259ER,
1013   HT_NIC_PCNET,
1014   HT_NIC_E1000,
1015   HT_NIC_PARAVIRTUAL
1016   ])
1017
1018 # Disk types
1019 HT_DISK_IOEMU = "ioemu"
1020 HT_DISK_IDE = "ide"
1021 HT_DISK_SCSI = "scsi"
1022 HT_DISK_SD = "sd"
1023 HT_DISK_MTD = "mtd"
1024 HT_DISK_PFLASH = "pflash"
1025
1026 HT_CACHE_DEFAULT = "default"
1027 HT_CACHE_NONE = "none"
1028 HT_CACHE_WTHROUGH = "writethrough"
1029 HT_CACHE_WBACK = "writeback"
1030 HT_VALID_CACHE_TYPES = frozenset([
1031   HT_CACHE_DEFAULT,
1032   HT_CACHE_NONE,
1033   HT_CACHE_WTHROUGH,
1034   HT_CACHE_WBACK
1035   ])
1036
1037 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
1038 HT_KVM_VALID_DISK_TYPES = frozenset([
1039   HT_DISK_PARAVIRTUAL,
1040   HT_DISK_IDE,
1041   HT_DISK_SCSI,
1042   HT_DISK_SD,
1043   HT_DISK_MTD,
1044   HT_DISK_PFLASH
1045   ])
1046
1047 # Mouse types:
1048 HT_MOUSE_MOUSE = "mouse"
1049 HT_MOUSE_TABLET = "tablet"
1050
1051 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
1052
1053 # Boot order
1054 HT_BO_FLOPPY = "floppy"
1055 HT_BO_CDROM = "cdrom"
1056 HT_BO_DISK = "disk"
1057 HT_BO_NETWORK = "network"
1058
1059 HT_KVM_VALID_BO_TYPES = frozenset([
1060   HT_BO_FLOPPY,
1061   HT_BO_CDROM,
1062   HT_BO_DISK,
1063   HT_BO_NETWORK
1064   ])
1065
1066 # SPICE lossless image compression options
1067 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ = "auto_glz"
1068 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ = "auto_lz"
1069 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC = "quic"
1070 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ = "glz"
1071 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ = "lz"
1072 HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF = "off"
1073
1074 HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS = frozenset([
1075   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_GLZ,
1076   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_AUTO_LZ,
1077   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_QUIC,
1078   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_GLZ,
1079   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_LZ,
1080   HT_KVM_SPICE_LOSSLESS_IMG_COMPR_OFF,
1081   ])
1082
1083 # SPICE lossy image compression options (valid for both jpeg and zlib-glz)
1084 HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO = "auto"
1085 HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER = "never"
1086 HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS = "always"
1087
1088 HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS = frozenset([
1089   HT_KVM_SPICE_LOSSY_IMG_COMPR_AUTO,
1090   HT_KVM_SPICE_LOSSY_IMG_COMPR_NEVER,
1091   HT_KVM_SPICE_LOSSY_IMG_COMPR_ALWAYS,
1092   ])
1093
1094 # SPICE video stream detection
1095 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF = "off"
1096 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL = "all"
1097 HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER = "filter"
1098
1099 HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS = frozenset([
1100   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_OFF,
1101   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_ALL,
1102   HT_KVM_SPICE_VIDEO_STREAM_DETECTION_FILTER,
1103   ])
1104
1105 # Security models
1106 HT_SM_NONE = "none"
1107 HT_SM_USER = "user"
1108 HT_SM_POOL = "pool"
1109
1110 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
1111
1112 # Kvm flag values
1113 HT_KVM_ENABLED = "enabled"
1114 HT_KVM_DISABLED = "disabled"
1115
1116 HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])
1117
1118 # Migration type
1119 HT_MIGRATION_LIVE = "live"
1120 HT_MIGRATION_NONLIVE = "non-live"
1121 HT_MIGRATION_MODES = frozenset([HT_MIGRATION_LIVE, HT_MIGRATION_NONLIVE])
1122
1123 # Cluster Verify steps
1124 VERIFY_NPLUSONE_MEM = "nplusone_mem"
1125 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
1126
1127 # Cluster Verify error classes
1128 CV_TCLUSTER = "cluster"
1129 CV_TNODE = "node"
1130 CV_TINSTANCE = "instance"
1131
1132 # Cluster Verify error codes and documentation
1133 CV_ECLUSTERCFG = \
1134   (CV_TCLUSTER, "ECLUSTERCFG", "Cluster configuration verification failure")
1135 CV_ECLUSTERCERT = \
1136   (CV_TCLUSTER, "ECLUSTERCERT",
1137    "Cluster certificate files verification failure")
1138 CV_ECLUSTERFILECHECK = \
1139   (CV_TCLUSTER, "ECLUSTERFILECHECK",
1140    "Cluster configuration verification failure")
1141 CV_ECLUSTERDANGLINGNODES = \
1142   (CV_TNODE, "ECLUSTERDANGLINGNODES",
1143    "Some nodes belong to non-existing groups")
1144 CV_ECLUSTERDANGLINGINST = \
1145   (CV_TNODE, "ECLUSTERDANGLINGINST",
1146    "Some instances have a non-existing primary node")
1147 CV_EINSTANCEBADNODE = \
1148   (CV_TINSTANCE, "EINSTANCEBADNODE",
1149    "Instance marked as running lives on an offline node")
1150 CV_EINSTANCEDOWN = \
1151   (CV_TINSTANCE, "EINSTANCEDOWN", "Instance not running on its primary node")
1152 CV_EINSTANCELAYOUT = \
1153   (CV_TINSTANCE, "EINSTANCELAYOUT", "Instance has multiple secondary nodes")
1154 CV_EINSTANCEMISSINGDISK = \
1155   (CV_TINSTANCE, "EINSTANCEMISSINGDISK", "Missing volume on an instance")
1156 CV_EINSTANCEFAULTYDISK = \
1157   (CV_TINSTANCE, "EINSTANCEFAULTYDISK",
1158    "Impossible to retrieve status for a disk")
1159 CV_EINSTANCEWRONGNODE = \
1160   (CV_TINSTANCE, "EINSTANCEWRONGNODE", "Instance running on the wrong node")
1161 CV_EINSTANCESPLITGROUPS = \
1162   (CV_TINSTANCE, "EINSTANCESPLITGROUPS",
1163    "Instance with primary and secondary nodes in different groups")
1164 CV_ENODEDRBD = \
1165   (CV_TNODE, "ENODEDRBD", "Error parsing the DRBD status file")
1166 CV_ENODEDRBDHELPER = \
1167   (CV_TNODE, "ENODEDRBDHELPER", "Error caused by the DRBD helper")
1168 CV_ENODEFILECHECK = \
1169   (CV_TNODE, "ENODEFILECHECK",
1170    "Error retrieving the checksum of the node files")
1171 CV_ENODEHOOKS = \
1172   (CV_TNODE, "ENODEHOOKS", "Communication failure in hooks execution")
1173 CV_ENODEHV = \
1174   (CV_TNODE, "ENODEHV", "Hypervisor parameters verification failure")
1175 CV_ENODELVM = \
1176   (CV_TNODE, "ENODELVM", "LVM-related node error")
1177 CV_ENODEN1 = \
1178   (CV_TNODE, "ENODEN1", "Not enough memory to accommodate instance failovers")
1179 CV_ENODENET = \
1180   (CV_TNODE, "ENODENET", "Network-related node error")
1181 CV_ENODEOS = \
1182   (CV_TNODE, "ENODEOS", "OS-related node error")
1183 CV_ENODEORPHANINSTANCE = \
1184   (CV_TNODE, "ENODEORPHANINSTANCE", "Unknown intance running on a node")
1185 CV_ENODEORPHANLV = \
1186   (CV_TNODE, "ENODEORPHANLV", "Unknown LVM logical volume")
1187 CV_ENODERPC = \
1188   (CV_TNODE, "ENODERPC",
1189    "Error during connection to the primary node of an instance")
1190 CV_ENODESSH = \
1191   (CV_TNODE, "ENODESSH", "SSH-related node error")
1192 CV_ENODEVERSION = \
1193   (CV_TNODE, "ENODEVERSION",
1194    "Protocol version mismatch or Ganeti version mismatch")
1195 CV_ENODESETUP = \
1196   (CV_TNODE, "ENODESETUP", "Node setup error")
1197 CV_ENODETIME = \
1198   (CV_TNODE, "ENODETIME", "Node returned invalid time")
1199 CV_ENODEOOBPATH = \
1200   (CV_TNODE, "ENODEOOBPATH", "Invalid Out Of Band path")
1201 CV_ENODEUSERSCRIPTS = \
1202   (CV_TNODE, "ENODEUSERSCRIPTS", "User scripts not present or not executable")
1203
1204 CV_ALL_ECODES = frozenset([
1205   CV_ECLUSTERCFG,
1206   CV_ECLUSTERCERT,
1207   CV_ECLUSTERFILECHECK,
1208   CV_ECLUSTERDANGLINGNODES,
1209   CV_ECLUSTERDANGLINGINST,
1210   CV_EINSTANCEBADNODE,
1211   CV_EINSTANCEDOWN,
1212   CV_EINSTANCELAYOUT,
1213   CV_EINSTANCEMISSINGDISK,
1214   CV_EINSTANCEFAULTYDISK,
1215   CV_EINSTANCEWRONGNODE,
1216   CV_EINSTANCESPLITGROUPS,
1217   CV_ENODEDRBD,
1218   CV_ENODEDRBDHELPER,
1219   CV_ENODEFILECHECK,
1220   CV_ENODEHOOKS,
1221   CV_ENODEHV,
1222   CV_ENODELVM,
1223   CV_ENODEN1,
1224   CV_ENODENET,
1225   CV_ENODEOS,
1226   CV_ENODEORPHANINSTANCE,
1227   CV_ENODEORPHANLV,
1228   CV_ENODERPC,
1229   CV_ENODESSH,
1230   CV_ENODEVERSION,
1231   CV_ENODESETUP,
1232   CV_ENODETIME,
1233   CV_ENODEOOBPATH,
1234   CV_ENODEUSERSCRIPTS,
1235   ])
1236
1237 CV_ALL_ECODES_STRINGS = frozenset(estr for (_, estr, _) in CV_ALL_ECODES)
1238
1239 # Node verify constants
1240 NV_DRBDHELPER = "drbd-helper"
1241 NV_DRBDLIST = "drbd-list"
1242 NV_FILELIST = "filelist"
1243 NV_HVINFO = "hvinfo"
1244 NV_HYPERVISOR = "hypervisor"
1245 NV_HVPARAMS = "hvparms"
1246 NV_INSTANCELIST = "instancelist"
1247 NV_LVLIST = "lvlist"
1248 NV_MASTERIP = "master-ip"
1249 NV_NODELIST = "nodelist"
1250 NV_NODENETTEST = "node-net-test"
1251 NV_NODESETUP = "nodesetup"
1252 NV_OSLIST = "oslist"
1253 NV_PVLIST = "pvlist"
1254 NV_TIME = "time"
1255 NV_VERSION = "version"
1256 NV_VGLIST = "vglist"
1257 NV_VMNODES = "vmnodes"
1258 NV_OOB_PATHS = "oob-paths"
1259 NV_BRIDGES = "bridges"
1260 NV_USERSCRIPTS = "user-scripts"
1261
1262 # Instance status
1263 INSTST_RUNNING = "running"
1264 INSTST_ADMINDOWN = "ADMIN_down"
1265 INSTST_ADMINOFFLINE = "ADMIN_offline"
1266 INSTST_NODEOFFLINE = "ERROR_nodeoffline"
1267 INSTST_NODEDOWN = "ERROR_nodedown"
1268 INSTST_WRONGNODE = "ERROR_wrongnode"
1269 INSTST_ERRORUP = "ERROR_up"
1270 INSTST_ERRORDOWN = "ERROR_down"
1271 INSTST_ALL = frozenset([
1272   INSTST_RUNNING,
1273   INSTST_ADMINDOWN,
1274   INSTST_ADMINOFFLINE,
1275   INSTST_NODEOFFLINE,
1276   INSTST_NODEDOWN,
1277   INSTST_WRONGNODE,
1278   INSTST_ERRORUP,
1279   INSTST_ERRORDOWN,
1280   ])
1281
1282 # Admin states
1283 ADMINST_UP = "up"
1284 ADMINST_DOWN = "down"
1285 ADMINST_OFFLINE = "offline"
1286 ADMINST_ALL = frozenset([
1287   ADMINST_UP,
1288   ADMINST_DOWN,
1289   ADMINST_OFFLINE,
1290   ])
1291
1292 # Node roles
1293 NR_REGULAR = "R"
1294 NR_MASTER = "M"
1295 NR_MCANDIDATE = "C"
1296 NR_DRAINED = "D"
1297 NR_OFFLINE = "O"
1298 NR_ALL = frozenset([
1299   NR_REGULAR,
1300   NR_MASTER,
1301   NR_MCANDIDATE,
1302   NR_DRAINED,
1303   NR_OFFLINE,
1304   ])
1305
1306 # SSL certificate check constants (in days)
1307 SSL_CERT_EXPIRATION_WARN = 30
1308 SSL_CERT_EXPIRATION_ERROR = 7
1309
1310 # Allocator framework constants
1311 IALLOCATOR_VERSION = 2
1312 IALLOCATOR_DIR_IN = "in"
1313 IALLOCATOR_DIR_OUT = "out"
1314 VALID_IALLOCATOR_DIRECTIONS = frozenset([
1315   IALLOCATOR_DIR_IN,
1316   IALLOCATOR_DIR_OUT,
1317   ])
1318 IALLOCATOR_MODE_ALLOC = "allocate"
1319 IALLOCATOR_MODE_RELOC = "relocate"
1320 IALLOCATOR_MODE_CHG_GROUP = "change-group"
1321 IALLOCATOR_MODE_NODE_EVAC = "node-evacuate"
1322 VALID_IALLOCATOR_MODES = frozenset([
1323   IALLOCATOR_MODE_ALLOC,
1324   IALLOCATOR_MODE_RELOC,
1325   IALLOCATOR_MODE_CHG_GROUP,
1326   IALLOCATOR_MODE_NODE_EVAC,
1327   ])
1328 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
1329
1330 IALLOCATOR_NEVAC_PRI = "primary-only"
1331 IALLOCATOR_NEVAC_SEC = "secondary-only"
1332 IALLOCATOR_NEVAC_ALL = "all"
1333 IALLOCATOR_NEVAC_MODES = frozenset([
1334   IALLOCATOR_NEVAC_PRI,
1335   IALLOCATOR_NEVAC_SEC,
1336   IALLOCATOR_NEVAC_ALL,
1337   ])
1338
1339 # Job queue
1340 JOB_QUEUE_VERSION = 1
1341 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
1342 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
1343 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
1344 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
1345 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
1346 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
1347 JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]
1348 JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE
1349
1350 JOB_ID_TEMPLATE = r"\d+"
1351 JOB_FILE_RE = re.compile(r"^job-(%s)$" % JOB_ID_TEMPLATE)
1352
1353 # unchanged job return
1354 JOB_NOTCHANGED = "nochange"
1355
1356 # Job status
1357 JOB_STATUS_QUEUED = "queued"
1358 JOB_STATUS_WAITING = "waiting"
1359 JOB_STATUS_CANCELING = "canceling"
1360 JOB_STATUS_RUNNING = "running"
1361 JOB_STATUS_CANCELED = "canceled"
1362 JOB_STATUS_SUCCESS = "success"
1363 JOB_STATUS_ERROR = "error"
1364 JOBS_FINALIZED = frozenset([
1365   JOB_STATUS_CANCELED,
1366   JOB_STATUS_SUCCESS,
1367   JOB_STATUS_ERROR,
1368   ])
1369 JOB_STATUS_ALL = frozenset([
1370   JOB_STATUS_QUEUED,
1371   JOB_STATUS_WAITING,
1372   JOB_STATUS_CANCELING,
1373   JOB_STATUS_RUNNING,
1374   ]) | JOBS_FINALIZED
1375
1376 # OpCode status
1377 # not yet finalized
1378 OP_STATUS_QUEUED = "queued"
1379 OP_STATUS_WAITING = "waiting"
1380 OP_STATUS_CANCELING = "canceling"
1381 OP_STATUS_RUNNING = "running"
1382 # finalized
1383 OP_STATUS_CANCELED = "canceled"
1384 OP_STATUS_SUCCESS = "success"
1385 OP_STATUS_ERROR = "error"
1386 OPS_FINALIZED = frozenset([
1387   OP_STATUS_CANCELED,
1388   OP_STATUS_SUCCESS,
1389   OP_STATUS_ERROR
1390   ])
1391
1392 # OpCode priority
1393 OP_PRIO_LOWEST = +19
1394 OP_PRIO_HIGHEST = -20
1395
1396 OP_PRIO_LOW = +10
1397 OP_PRIO_NORMAL = 0
1398 OP_PRIO_HIGH = -10
1399
1400 OP_PRIO_SUBMIT_VALID = frozenset([
1401   OP_PRIO_LOW,
1402   OP_PRIO_NORMAL,
1403   OP_PRIO_HIGH,
1404   ])
1405
1406 OP_PRIO_DEFAULT = OP_PRIO_NORMAL
1407
1408 # Execution log types
1409 ELOG_MESSAGE = "message"
1410 ELOG_PROGRESS = "progress"
1411 ELOG_REMOTE_IMPORT = "remote-import"
1412 ELOG_JQUEUE_TEST = "jqueue-test"
1413
1414 # /etc/hosts modification
1415 ETC_HOSTS_ADD = "add"
1416 ETC_HOSTS_REMOVE = "remove"
1417
1418 # Job queue test
1419 JQT_MSGPREFIX = "TESTMSG="
1420 JQT_EXPANDNAMES = "expandnames"
1421 JQT_EXEC = "exec"
1422 JQT_LOGMSG = "logmsg"
1423 JQT_STARTMSG = "startmsg"
1424 JQT_ALL = frozenset([
1425   JQT_EXPANDNAMES,
1426   JQT_EXEC,
1427   JQT_LOGMSG,
1428   JQT_STARTMSG,
1429   ])
1430
1431 # Query resources
1432 QR_INSTANCE = "instance"
1433 QR_NODE = "node"
1434 QR_LOCK = "lock"
1435 QR_GROUP = "group"
1436 QR_OS = "os"
1437
1438 #: List of resources which can be queried using L{opcodes.OpQuery}
1439 QR_VIA_OP = frozenset([QR_INSTANCE, QR_NODE, QR_GROUP, QR_OS])
1440
1441 #: List of resources which can be queried using Local UniX Interface
1442 QR_VIA_LUXI = QR_VIA_OP.union([
1443   QR_LOCK,
1444   ])
1445
1446 #: List of resources which can be queried using RAPI
1447 QR_VIA_RAPI = QR_VIA_LUXI
1448
1449 # Query field types
1450 QFT_UNKNOWN = "unknown"
1451 QFT_TEXT = "text"
1452 QFT_BOOL = "bool"
1453 QFT_NUMBER = "number"
1454 QFT_UNIT = "unit"
1455 QFT_TIMESTAMP = "timestamp"
1456 QFT_OTHER = "other"
1457
1458 #: All query field types
1459 QFT_ALL = frozenset([
1460   QFT_UNKNOWN,
1461   QFT_TEXT,
1462   QFT_BOOL,
1463   QFT_NUMBER,
1464   QFT_UNIT,
1465   QFT_TIMESTAMP,
1466   QFT_OTHER,
1467   ])
1468
1469 # Query result field status (don't change or reuse values as they're used by
1470 # clients)
1471 #: Normal field status
1472 RS_NORMAL = 0
1473 #: Unknown field
1474 RS_UNKNOWN = 1
1475 #: No data (e.g. RPC error), can be used instead of L{RS_OFFLINE}
1476 RS_NODATA = 2
1477 #: Value unavailable/unsupported for item; if this field is supported
1478 #: but we cannot get the data for the moment, RS_NODATA or
1479 #: RS_OFFLINE should be used
1480 RS_UNAVAIL = 3
1481 #: Resource marked offline
1482 RS_OFFLINE = 4
1483
1484 RS_ALL = frozenset([
1485   RS_NORMAL,
1486   RS_UNKNOWN,
1487   RS_NODATA,
1488   RS_UNAVAIL,
1489   RS_OFFLINE,
1490   ])
1491
1492 #: Dictionary with special field cases and their verbose/terse formatting
1493 RSS_DESCRIPTION = {
1494   RS_UNKNOWN: ("(unknown)", "??"),
1495   RS_NODATA: ("(nodata)", "?"),
1496   RS_OFFLINE: ("(offline)", "*"),
1497   RS_UNAVAIL: ("(unavail)", "-"),
1498   }
1499
1500 # max dynamic devices
1501 MAX_NICS = 8
1502 MAX_DISKS = 16
1503
1504 # SSCONF keys
1505 SS_CLUSTER_NAME = "cluster_name"
1506 SS_CLUSTER_TAGS = "cluster_tags"
1507 SS_FILE_STORAGE_DIR = "file_storage_dir"
1508 SS_SHARED_FILE_STORAGE_DIR = "shared_file_storage_dir"
1509 SS_MASTER_CANDIDATES = "master_candidates"
1510 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
1511 SS_MASTER_IP = "master_ip"
1512 SS_MASTER_NETDEV = "master_netdev"
1513 SS_MASTER_NETMASK = "master_netmask"
1514 SS_MASTER_NODE = "master_node"
1515 SS_NODE_LIST = "node_list"
1516 SS_NODE_PRIMARY_IPS = "node_primary_ips"
1517 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
1518 SS_OFFLINE_NODES = "offline_nodes"
1519 SS_ONLINE_NODES = "online_nodes"
1520 SS_PRIMARY_IP_FAMILY = "primary_ip_family"
1521 SS_INSTANCE_LIST = "instance_list"
1522 SS_RELEASE_VERSION = "release_version"
1523 SS_HYPERVISOR_LIST = "hypervisor_list"
1524 SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"
1525 SS_UID_POOL = "uid_pool"
1526 SS_NODEGROUPS = "nodegroups"
1527
1528 SS_FILE_PERMS = 0444
1529
1530 # cluster wide default parameters
1531 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
1532
1533 HVC_DEFAULTS = {
1534   HT_XEN_PVM: {
1535     HV_USE_BOOTLOADER: False,
1536     HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
1537     HV_BOOTLOADER_ARGS: "",
1538     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
1539     HV_INITRD_PATH: "",
1540     HV_ROOT_PATH: "/dev/sda1",
1541     HV_KERNEL_ARGS: "ro",
1542     HV_MIGRATION_PORT: 8002,
1543     HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1544     HV_BLOCKDEV_PREFIX: "sd",
1545     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1546     HV_CPU_MASK: CPU_PINNING_ALL,
1547     },
1548   HT_XEN_HVM: {
1549     HV_BOOT_ORDER: "cd",
1550     HV_CDROM_IMAGE_PATH: "",
1551     HV_NIC_TYPE: HT_NIC_RTL8139,
1552     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1553     HV_VNC_BIND_ADDRESS: IP4_ADDRESS_ANY,
1554     HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
1555     HV_ACPI: True,
1556     HV_PAE: True,
1557     HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
1558     HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
1559     HV_MIGRATION_PORT: 8002,
1560     HV_MIGRATION_MODE: HT_MIGRATION_NONLIVE,
1561     HV_USE_LOCALTIME: False,
1562     HV_BLOCKDEV_PREFIX: "hd",
1563     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1564     HV_CPU_MASK: CPU_PINNING_ALL,
1565     },
1566   HT_KVM: {
1567     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
1568     HV_INITRD_PATH: "",
1569     HV_KERNEL_ARGS: "ro",
1570     HV_ROOT_PATH: "/dev/vda1",
1571     HV_ACPI: True,
1572     HV_SERIAL_CONSOLE: True,
1573     HV_VNC_BIND_ADDRESS: "",
1574     HV_VNC_TLS: False,
1575     HV_VNC_X509: "",
1576     HV_VNC_X509_VERIFY: False,
1577     HV_VNC_PASSWORD_FILE: "",
1578     HV_KVM_SPICE_BIND: "",
1579     HV_KVM_SPICE_IP_VERSION: IFACE_NO_IP_VERSION_SPECIFIED,
1580     HV_KVM_SPICE_PASSWORD_FILE: "",
1581     HV_KVM_SPICE_LOSSLESS_IMG_COMPR: "",
1582     HV_KVM_SPICE_JPEG_IMG_COMPR: "",
1583     HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: "",
1584     HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: "",
1585     HV_KVM_SPICE_AUDIO_COMPR: True,
1586     HV_KVM_SPICE_USE_TLS: False,
1587     HV_KVM_SPICE_TLS_CIPHERS: OPENSSL_CIPHERS,
1588     HV_KVM_SPICE_USE_VDAGENT: True,
1589     HV_KVM_FLOPPY_IMAGE_PATH: "",
1590     HV_CDROM_IMAGE_PATH: "",
1591     HV_KVM_CDROM2_IMAGE_PATH: "",
1592     HV_BOOT_ORDER: HT_BO_DISK,
1593     HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
1594     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
1595     HV_KVM_CDROM_DISK_TYPE: "",
1596     HV_USB_MOUSE: "",
1597     HV_KEYMAP: "",
1598     HV_MIGRATION_PORT: 8102,
1599     HV_MIGRATION_BANDWIDTH: 32, # MiB/s
1600     HV_MIGRATION_DOWNTIME: 30,  # ms
1601     HV_MIGRATION_MODE: HT_MIGRATION_LIVE,
1602     HV_USE_LOCALTIME: False,
1603     HV_DISK_CACHE: HT_CACHE_DEFAULT,
1604     HV_SECURITY_MODEL: HT_SM_NONE,
1605     HV_SECURITY_DOMAIN: "",
1606     HV_KVM_FLAG: "",
1607     HV_VHOST_NET: False,
1608     HV_KVM_USE_CHROOT: False,
1609     HV_MEM_PATH: "",
1610     HV_REBOOT_BEHAVIOR: INSTANCE_REBOOT_ALLOWED,
1611     HV_CPU_MASK: CPU_PINNING_ALL,
1612     },
1613   HT_FAKE: {
1614     },
1615   HT_CHROOT: {
1616     HV_INIT_SCRIPT: "/ganeti-chroot",
1617     },
1618   HT_LXC: {
1619     HV_CPU_MASK: "",
1620     },
1621   }
1622
1623 HVC_GLOBALS = frozenset([
1624   HV_MIGRATION_PORT,
1625   HV_MIGRATION_BANDWIDTH,
1626   HV_MIGRATION_MODE,
1627   ])
1628
1629 BEC_DEFAULTS = {
1630   BE_MEMORY: 128,
1631   BE_MINMEM: 128,
1632   BE_MAXMEM: 128,
1633   BE_VCPUS: 1,
1634   BE_AUTO_BALANCE: True,
1635   }
1636
1637 NDC_DEFAULTS = {
1638   ND_OOB_PROGRAM: None,
1639   }
1640
1641 NICC_DEFAULTS = {
1642   NIC_MODE: NIC_MODE_BRIDGED,
1643   NIC_LINK: DEFAULT_BRIDGE,
1644   }
1645
1646 MASTER_POOL_SIZE_DEFAULT = 10
1647
1648 CONFD_PROTOCOL_VERSION = 1
1649
1650 CONFD_REQ_PING = 0
1651 CONFD_REQ_NODE_ROLE_BYNAME = 1
1652 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
1653 CONFD_REQ_CLUSTER_MASTER = 3
1654 CONFD_REQ_NODE_PIP_LIST = 4
1655 CONFD_REQ_MC_PIP_LIST = 5
1656 CONFD_REQ_INSTANCES_IPS_LIST = 6
1657
1658 # Confd request query fields. These are used to narrow down queries.
1659 # These must be strings rather than integers, because json-encoding
1660 # converts them to strings anyway, as they're used as dict-keys.
1661 CONFD_REQQ_LINK = "0"
1662 CONFD_REQQ_IP = "1"
1663 CONFD_REQQ_IPLIST = "2"
1664 CONFD_REQQ_FIELDS = "3"
1665
1666 CONFD_REQFIELD_NAME = "0"
1667 CONFD_REQFIELD_IP = "1"
1668 CONFD_REQFIELD_MNODE_PIP = "2"
1669
1670 CONFD_REQS = frozenset([
1671   CONFD_REQ_PING,
1672   CONFD_REQ_NODE_ROLE_BYNAME,
1673   CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
1674   CONFD_REQ_CLUSTER_MASTER,
1675   CONFD_REQ_NODE_PIP_LIST,
1676   CONFD_REQ_MC_PIP_LIST,
1677   CONFD_REQ_INSTANCES_IPS_LIST,
1678   ])
1679
1680 CONFD_REPL_STATUS_OK = 0
1681 CONFD_REPL_STATUS_ERROR = 1
1682 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
1683
1684 CONFD_REPL_STATUSES = frozenset([
1685   CONFD_REPL_STATUS_OK,
1686   CONFD_REPL_STATUS_ERROR,
1687   CONFD_REPL_STATUS_NOTIMPLEMENTED,
1688   ])
1689
1690 (CONFD_NODE_ROLE_MASTER,
1691  CONFD_NODE_ROLE_CANDIDATE,
1692  CONFD_NODE_ROLE_OFFLINE,
1693  CONFD_NODE_ROLE_DRAINED,
1694  CONFD_NODE_ROLE_REGULAR,
1695  ) = range(5)
1696
1697 # A few common errors for confd
1698 CONFD_ERROR_UNKNOWN_ENTRY = 1
1699 CONFD_ERROR_INTERNAL = 2
1700 CONFD_ERROR_ARGUMENT = 3
1701
1702 # Each request is "salted" by the current timestamp.
1703 # This constants decides how many seconds of skew to accept.
1704 # TODO: make this a default and allow the value to be more configurable
1705 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
1706
1707 # When we haven't reloaded the config for more than this amount of seconds, we
1708 # force a test to see if inotify is betraying us.
1709 CONFD_CONFIG_RELOAD_TIMEOUT = 60
1710
1711 # If we receive more than one update in this amount of seconds, we move to
1712 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
1713 # to serve more requests.
1714 CONFD_CONFIG_RELOAD_RATELIMIT = 2
1715
1716 # Magic number prepended to all confd queries.
1717 # This allows us to distinguish different types of confd protocols and handle
1718 # them. For example by changing this we can move the whole payload to be
1719 # compressed, or move away from json.
1720 CONFD_MAGIC_FOURCC = "plj0"
1721
1722 # By default a confd request is sent to the minimum between this number and all
1723 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
1724 # we should have enough answers to be able to compare more than one.
1725 CONFD_DEFAULT_REQ_COVERAGE = 6
1726
1727 # Timeout in seconds to expire pending query request in the confd client
1728 # library. We don't actually expect any answer more than 10 seconds after we
1729 # sent a request.
1730 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
1731
1732 # Maximum UDP datagram size.
1733 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
1734 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
1735 #   (assuming we can't use jumbo frames)
1736 # We just set this to 60K, which should be enough
1737 MAX_UDP_DATA_SIZE = 61440
1738
1739 # User-id pool minimum/maximum acceptable user-ids.
1740 UIDPOOL_UID_MIN = 0
1741 UIDPOOL_UID_MAX = 2 ** 32 - 1 # Assuming 32 bit user-ids
1742
1743 # Name or path of the pgrep command
1744 PGREP = "pgrep"
1745
1746 # Name of the node group that gets created at cluster init or upgrade
1747 INITIAL_NODE_GROUP_NAME = "default"
1748
1749 # Possible values for NodeGroup.alloc_policy
1750 ALLOC_POLICY_PREFERRED = "preferred"
1751 ALLOC_POLICY_LAST_RESORT = "last_resort"
1752 ALLOC_POLICY_UNALLOCABLE = "unallocable"
1753 VALID_ALLOC_POLICIES = [
1754   ALLOC_POLICY_PREFERRED,
1755   ALLOC_POLICY_LAST_RESORT,
1756   ALLOC_POLICY_UNALLOCABLE,
1757   ]
1758
1759 # Temporary external/shared storage parameters
1760 BLOCKDEV_DRIVER_MANUAL = "manual"
1761
1762 # qemu-img path, required for ovfconverter
1763 QEMUIMG_PATH = _autoconf.QEMUIMG_PATH
1764
1765 # Whether htools was enabled at compilation time
1766 HTOOLS = _autoconf.HTOOLS
1767 # The hail iallocator
1768 IALLOC_HAIL = "hail"
1769
1770 # Fake opcodes for functions that have hooks attached to them via
1771 # backend.RunLocalHooks
1772 FAKE_OP_MASTER_TURNUP = "OP_CLUSTER_IP_TURNUP"
1773 FAKE_OP_MASTER_TURNDOWN = "OP_CLUSTER_IP_TURNDOWN"
1774
1775 # Do not re-export imported modules
1776 del re, _vcsversion, _autoconf