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