code.grnet.gr Git - ganeti-local/blob - lib/constants.py

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