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