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