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