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