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