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