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

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007 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 PROTOCOL_VERSION = 30
  30 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
  31 OS_API_V10 = 10
  32 OS_API_V15 = 15
  33 OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15])
  34 EXPORT_VERSION = 0
  35 RAPI_VERSION = 2
  36
  37
  38 # Format for CONFIG_VERSION:
  39 #   01 03 0123 = 01030123
  40 #   ^^ ^^ ^^^^
  41 #   |  |  + Configuration version/revision
  42 #   |  + Minor version
  43 #   + Major version
  44 #
  45 # It stored as an integer. Make sure not to write an octal number.
  46
  47 # BuildVersion and SplitVersion must be in here because we can't import other
  48 # modules. The cfgupgrade tool must be able to read and write version numbers
  49 # and thus requires these functions. To avoid code duplication, they're kept in
  50 # here.
  51
  52 def BuildVersion(major, minor, revision):
  53   """Calculates int version number from major, minor and revision numbers.
  54
  55   Returns: int representing version number
  56
  57   """
  58   assert isinstance(major, int)
  59   assert isinstance(minor, int)
  60   assert isinstance(revision, int)
  61   return (1000000 * major +
  62             10000 * minor +
  63                 1 * revision)
  64
  65
  66 def SplitVersion(version):
  67   """Splits version number stored in an int.
  68
  69   Returns: tuple; (major, minor, revision)
  70
  71   """
  72   assert isinstance(version, int)
  73
  74   (major, remainder) = divmod(version, 1000000)
  75   (minor, revision) = divmod(remainder, 10000)
  76
  77   return (major, minor, revision)
  78
  79
  80 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
  81 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
  82 CONFIG_REVISION = 0
  83 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
  84
  85 # file paths
  86 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
  87 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
  88 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
  89 BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
  90 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
  91 RUN_DIRS_MODE = 0755
  92 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
  93 SOCKET_DIR_MODE = 0700
  94 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
  95 # daemon is started (this takes care of RUN_DIR being tmpfs)
  96 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
  97 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
  98 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
  99 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
 100 NODED_CERT_FILE = DATA_DIR + "/server.pem"
 101 RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
 102 CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
 103 CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
 104 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
 105 WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
 106 INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"
 107 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
 108 RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
 109 QUEUE_DIR = DATA_DIR + "/queue"
 110 DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"
 111 ETC_HOSTS = "/etc/hosts"
 112 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
 113 ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
 114 SYSCONFDIR = _autoconf.SYSCONFDIR
 115 TOOLSDIR = _autoconf.TOOLSDIR
 116 CONF_DIR = SYSCONFDIR + "/ganeti"
 117
 118 ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])
 119
 120 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
 121
 122 NODED = "ganeti-noded"
 123 CONFD = "ganeti-confd"
 124 RAPI = "ganeti-rapi"
 125 MASTERD = "ganeti-masterd"
 126 # used in the ganeti-nbma project
 127 NLD = "ganeti-nld"
 128
 129 DAEMONS_PORTS = {
 130   # daemon-name: ("proto", "default-port")
 131   NODED: ("tcp", 1811),
 132   CONFD: ("udp", 1814),
 133   RAPI: ("tcp", 5080),
 134   # used in the ganeti-nbma project
 135   NLD: ("udp", 1816),
 136 }
 137 DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
 138 DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
 139 DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
 140 # used in the ganeti-nbma project
 141 DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
 142
 143 FIRST_DRBD_PORT = 11000
 144 LAST_DRBD_PORT = 14999
 145 MASTER_SCRIPT = "ganeti-master"
 146
 147 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
 148 DAEMONS_LOGFILES = {
 149   # "daemon-name": "logfile"
 150   NODED: LOG_DIR + "node-daemon.log",
 151   CONFD: LOG_DIR + "conf-daemon.log",
 152   RAPI: LOG_DIR + "rapi-daemon.log",
 153   MASTERD: LOG_DIR + "master-daemon.log",
 154   # used in the ganeti-nbma project
 155   NLD: LOG_DIR + "nl-daemon.log",
 156   }
 157
 158 LOG_OS_DIR = LOG_DIR + "os"
 159 LOG_WATCHER = LOG_DIR + "watcher.log"
 160 LOG_COMMANDS = LOG_DIR + "commands.log"
 161 LOG_BURNIN = LOG_DIR + "burnin.log"
 162
 163 # one of 'no', 'yes', 'only'
 164 SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
 165 SYSLOG_NO = "no"
 166 SYSLOG_YES = "yes"
 167 SYSLOG_ONLY = "only"
 168 SYSLOG_SOCKET = "/dev/log"
 169
 170 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
 171 EXPORT_DIR = _autoconf.EXPORT_DIR
 172
 173 EXPORT_CONF_FILE = "config.ini"
 174
 175 XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
 176 XEN_KERNEL = _autoconf.XEN_KERNEL
 177 XEN_INITRD = _autoconf.XEN_INITRD
 178
 179 KVM_PATH = _autoconf.KVM_PATH
 180 SOCAT_PATH = _autoconf.SOCAT_PATH
 181 SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
 182 SOCAT_ESCAPE_CODE = "0x1d"
 183
 184 # For RSA keys more bits are better, but they also make operations more
 185 # expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year
 186 # 2010 on.
 187 RSA_KEY_BITS = 2048
 188
 189 # Digest used to sign certificates ("openssl x509" uses SHA1 by default)
 190 X509_CERT_SIGN_DIGEST = "SHA1"
 191
 192 VALUE_DEFAULT = "default"
 193 VALUE_AUTO = "auto"
 194 VALUE_GENERATE = "generate"
 195 VALUE_NONE = "none"
 196 VALUE_TRUE = "true"
 197 VALUE_FALSE = "false"
 198
 199 # External script validation mask
 200 EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")
 201
 202 # hooks-related constants
 203 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
 204 HOOKS_PHASE_PRE = "pre"
 205 HOOKS_PHASE_POST = "post"
 206 HOOKS_NAME_CFGUPDATE = "config-update"
 207 HOOKS_NAME_WATCHER = "watcher"
 208 HOOKS_VERSION = 2
 209
 210 # hooks subject type (what object type does the LU deal with)
 211 HTYPE_CLUSTER = "CLUSTER"
 212 HTYPE_NODE = "NODE"
 213 HTYPE_INSTANCE = "INSTANCE"
 214
 215 HKR_SKIP = 0
 216 HKR_FAIL = 1
 217 HKR_SUCCESS = 2
 218
 219 # Storage types
 220 ST_FILE = "file"
 221 ST_LVM_PV = "lvm-pv"
 222 ST_LVM_VG = "lvm-vg"
 223
 224 # Storage fields
 225 # first two are valid in LU context only, not passed to backend
 226 SF_NODE = "node"
 227 SF_TYPE = "type"
 228 # and the rest are valid in backend
 229 SF_NAME = "name"
 230 SF_SIZE = "size"
 231 SF_FREE = "free"
 232 SF_USED = "used"
 233 SF_ALLOCATABLE = "allocatable"
 234
 235 # Storage operations
 236 SO_FIX_CONSISTENCY = "fix-consistency"
 237
 238 # Available fields per storage type
 239 VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,
 240                                   SF_USED, SF_FREE, SF_ALLOCATABLE])
 241
 242 VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
 243
 244 MODIFIABLE_STORAGE_FIELDS = {
 245   ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
 246   }
 247
 248 VALID_STORAGE_OPERATIONS = {
 249   ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
 250   }
 251
 252 # Local disk status
 253 # Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
 254 (LDS_OKAY,
 255  LDS_UNKNOWN,
 256  LDS_FAULTY) = range(1, 4)
 257
 258 # disk template types
 259 DT_DISKLESS = "diskless"
 260 DT_PLAIN = "plain"
 261 DT_DRBD8 = "drbd"
 262 DT_FILE = "file"
 263
 264 # the set of network-mirrored disk templates
 265 DTS_NET_MIRROR = frozenset([DT_DRBD8])
 266
 267 # the set of non-lvm-based disk templates
 268 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
 269
 270 # logical disk types
 271 LD_LV = "lvm"
 272 LD_DRBD8 = "drbd8"
 273 LD_FILE = "file"
 274 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
 275
 276 # drbd constants
 277 DRBD_HMAC_ALG = "md5"
 278 DRBD_NET_PROTOCOL = "C"
 279 DRBD_BARRIERS = _autoconf.DRBD_BARRIERS
 280
 281 # file backend driver
 282 FD_LOOP = "loop"
 283 FD_BLKTAP = "blktap"
 284
 285 # the set of drbd-like disk types
 286 LDS_DRBD = frozenset([LD_DRBD8])
 287
 288 # disk access mode
 289 DISK_RDONLY = "ro"
 290 DISK_RDWR = "rw"
 291 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
 292
 293 # disk replacement mode
 294 REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary
 295 REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary
 296 REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node
 297 REPLACE_DISK_AUTO = "replace_auto"
 298
 299 # lock recalculate mode
 300 LOCKS_REPLACE = 'replace'
 301 LOCKS_APPEND = 'append'
 302
 303 # instance creation modes
 304 INSTANCE_CREATE = "create"
 305 INSTANCE_IMPORT = "import"
 306
 307 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
 308                             DT_DRBD8, DT_FILE])
 309
 310 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
 311
 312 # import/export config options
 313 INISECT_EXP = "export"
 314 INISECT_INS = "instance"
 315
 316 # dynamic device modification
 317
 318 DDM_ADD = 'add'
 319 DDM_REMOVE = 'remove'
 320
 321 # common exit codes
 322 EXIT_SUCCESS = 0
 323 EXIT_FAILURE = 1
 324 EXIT_NOTCLUSTER = 5
 325 EXIT_NOTMASTER = 11
 326 EXIT_NODESETUP_ERROR = 12
 327 EXIT_CONFIRMATION = 13 # need user confirmation
 328 EXIT_NOTCANDIDATE = 14
 329
 330 # tags
 331 TAG_CLUSTER = "cluster"
 332 TAG_NODE = "node"
 333 TAG_INSTANCE = "instance"
 334 MAX_TAG_LEN = 128
 335 MAX_TAGS_PER_OBJ = 4096
 336
 337 # others
 338 DEFAULT_BRIDGE = "xen-br0"
 339 SYNC_SPEED = 60 * 1024
 340 LOCALHOST_IP_ADDRESS = "127.0.0.1"
 341 TCP_PING_TIMEOUT = 10
 342 GANETI_RUNAS = "root"
 343 DEFAULT_VG = "xenvg"
 344 BIND_ADDRESS_GLOBAL = "0.0.0.0"
 345 MIN_VG_SIZE = 20480
 346 DEFAULT_MAC_PREFIX = "aa:00:00"
 347 LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT
 348 # default maximum instance wait time, in seconds.
 349 DEFAULT_SHUTDOWN_TIMEOUT = 120
 350 NODE_MAX_CLOCK_SKEW = 150
 351
 352 # runparts results
 353 (RUNPARTS_SKIP,
 354  RUNPARTS_RUN,
 355  RUNPARTS_ERR) = range(3)
 356
 357 RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])
 358
 359 # RPC constants
 360 (RPC_ENCODING_NONE,
 361  RPC_ENCODING_ZLIB_BASE64) = range(2)
 362
 363 # os related constants
 364 OS_SCRIPT_CREATE = 'create'
 365 OS_SCRIPT_IMPORT = 'import'
 366 OS_SCRIPT_EXPORT = 'export'
 367 OS_SCRIPT_RENAME = 'rename'
 368 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
 369                         OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
 370
 371 OS_API_FILE = 'ganeti_api_version'
 372 OS_VARIANTS_FILE = 'variants.list'
 373
 374 # ssh constants
 375 SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR
 376 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
 377 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
 378 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
 379 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
 380 SSH = "ssh"
 381 SCP = "scp"
 382
 383 # reboot types
 384 INSTANCE_REBOOT_SOFT = "soft"
 385 INSTANCE_REBOOT_HARD = "hard"
 386 INSTANCE_REBOOT_FULL = "full"
 387
 388 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
 389                           INSTANCE_REBOOT_HARD,
 390                           INSTANCE_REBOOT_FULL])
 391
 392 VTYPE_STRING = 'string'
 393 VTYPE_BOOL = 'bool'
 394 VTYPE_SIZE = 'size' # size, in MiBs
 395 VTYPE_INT = 'int'
 396 ENFORCEABLE_TYPES = frozenset([
 397                       VTYPE_STRING,
 398                       VTYPE_BOOL,
 399                       VTYPE_SIZE,
 400                       VTYPE_INT,
 401                       ])
 402
 403 # HV parameter names (global namespace)
 404 HV_BOOT_ORDER = "boot_order"
 405 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
 406 HV_NIC_TYPE = "nic_type"
 407 HV_DISK_TYPE = "disk_type"
 408 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
 409 HV_VNC_PASSWORD_FILE = "vnc_password_file"
 410 HV_VNC_TLS = "vnc_tls"
 411 HV_VNC_X509 = "vnc_x509_path"
 412 HV_VNC_X509_VERIFY = "vnc_x509_verify"
 413 HV_ACPI = "acpi"
 414 HV_PAE = "pae"
 415 HV_USE_BOOTLOADER = "use_bootloader"
 416 HV_BOOTLOADER_ARGS = "bootloader_args"
 417 HV_BOOTLOADER_PATH = "bootloader_path"
 418 HV_KERNEL_ARGS = "kernel_args"
 419 HV_KERNEL_PATH = "kernel_path"
 420 HV_INITRD_PATH = "initrd_path"
 421 HV_ROOT_PATH = "root_path"
 422 HV_SERIAL_CONSOLE = "serial_console"
 423 HV_USB_MOUSE = "usb_mouse"
 424 HV_DEVICE_MODEL = "device_model"
 425 HV_INIT_SCRIPT = "init_script"
 426 HV_MIGRATION_PORT = "migration_port"
 427 HV_USE_LOCALTIME = "use_localtime"
 428 HV_DISK_CACHE = "disk_cache"
 429 HV_SECURITY_MODEL = "security_model"
 430 HV_SECURITY_DOMAIN = "security_domain"
 431
 432 HVS_PARAMETER_TYPES = {
 433   HV_BOOT_ORDER: VTYPE_STRING,
 434   HV_CDROM_IMAGE_PATH: VTYPE_STRING,
 435   HV_NIC_TYPE: VTYPE_STRING,
 436   HV_DISK_TYPE: VTYPE_STRING,
 437   HV_VNC_PASSWORD_FILE: VTYPE_STRING,
 438   HV_VNC_BIND_ADDRESS: VTYPE_STRING,
 439   HV_VNC_TLS: VTYPE_BOOL,
 440   HV_VNC_X509: VTYPE_STRING,
 441   HV_VNC_X509_VERIFY: VTYPE_BOOL,
 442   HV_ACPI: VTYPE_BOOL,
 443   HV_PAE: VTYPE_BOOL,
 444   HV_USE_BOOTLOADER: VTYPE_BOOL,
 445   HV_BOOTLOADER_PATH: VTYPE_STRING,
 446   HV_BOOTLOADER_ARGS: VTYPE_STRING,
 447   HV_KERNEL_PATH: VTYPE_STRING,
 448   HV_KERNEL_ARGS: VTYPE_STRING,
 449   HV_INITRD_PATH: VTYPE_STRING,
 450   HV_ROOT_PATH: VTYPE_STRING,
 451   HV_SERIAL_CONSOLE: VTYPE_BOOL,
 452   HV_USB_MOUSE: VTYPE_STRING,
 453   HV_DEVICE_MODEL: VTYPE_STRING,
 454   HV_INIT_SCRIPT: VTYPE_STRING,
 455   HV_MIGRATION_PORT: VTYPE_INT,
 456   HV_USE_LOCALTIME: VTYPE_BOOL,
 457   HV_DISK_CACHE: VTYPE_STRING,
 458   HV_SECURITY_MODEL: VTYPE_STRING,
 459   HV_SECURITY_DOMAIN: VTYPE_STRING,
 460   }
 461
 462 HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
 463
 464 # BE parameter names
 465 BE_MEMORY = "memory"
 466 BE_VCPUS = "vcpus"
 467 BE_AUTO_BALANCE = "auto_balance"
 468
 469 BES_PARAMETER_TYPES = {
 470     BE_MEMORY: VTYPE_SIZE,
 471     BE_VCPUS: VTYPE_INT,
 472     BE_AUTO_BALANCE: VTYPE_BOOL,
 473     }
 474
 475 BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
 476
 477 # Instance Parameters Profile
 478 PP_DEFAULT = "default"
 479
 480 NIC_MODE = "mode"
 481 NIC_LINK = "link"
 482
 483 NIC_MODE_BRIDGED = "bridged"
 484 NIC_MODE_ROUTED = "routed"
 485
 486 NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])
 487
 488 NICS_PARAMETER_TYPES = {
 489     NIC_MODE: VTYPE_STRING,
 490     NIC_LINK: VTYPE_STRING,
 491     }
 492
 493 NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())
 494
 495 # Hypervisor constants
 496 HT_XEN_PVM = "xen-pvm"
 497 HT_FAKE = "fake"
 498 HT_XEN_HVM = "xen-hvm"
 499 HT_KVM = "kvm"
 500 HT_CHROOT = "chroot"
 501 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])
 502 HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
 503
 504 VNC_BASE_PORT = 5900
 505 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
 506 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
 507
 508 # NIC types
 509 HT_NIC_RTL8139 = "rtl8139"
 510 HT_NIC_NE2K_PCI = "ne2k_pci"
 511 HT_NIC_NE2K_ISA = "ne2k_isa"
 512 HT_NIC_I82551 = "i82551"
 513 HT_NIC_I85557B = "i82557b"
 514 HT_NIC_I8259ER = "i82559er"
 515 HT_NIC_PCNET = "pcnet"
 516 HT_NIC_E1000 = "e1000"
 517 HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"
 518
 519 HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
 520                                     HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
 521 HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
 522                                     HT_NIC_NE2K_ISA, HT_NIC_I82551,
 523                                     HT_NIC_I85557B, HT_NIC_I8259ER,
 524                                     HT_NIC_PCNET, HT_NIC_E1000,
 525                                     HT_NIC_PARAVIRTUAL])
 526 # Disk types
 527 HT_DISK_IOEMU = "ioemu"
 528 HT_DISK_IDE = "ide"
 529 HT_DISK_SCSI = "scsi"
 530 HT_DISK_SD = "sd"
 531 HT_DISK_MTD = "mtd"
 532 HT_DISK_PFLASH = "pflash"
 533
 534 HT_CACHE_DEFAULT = "default"
 535 HT_CACHE_NONE = "none"
 536 HT_CACHE_WTHROUGH = "writethrough"
 537 HT_CACHE_WBACK = "writeback"
 538 HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,
 539                                   HT_CACHE_NONE,
 540                                   HT_CACHE_WTHROUGH,
 541                                   HT_CACHE_WBACK])
 542
 543 HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
 544 HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
 545                                      HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
 546                                      HT_DISK_PFLASH])
 547
 548 # Mouse types:
 549 HT_MOUSE_MOUSE = "mouse"
 550 HT_MOUSE_TABLET = "tablet"
 551
 552 HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])
 553
 554 # Boot order
 555 HT_BO_CDROM = "cdrom"
 556 HT_BO_DISK = "disk"
 557 HT_BO_NETWORK = "network"
 558
 559 HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])
 560
 561 # Security models
 562 HT_SM_NONE = "none"
 563 HT_SM_USER = "user"
 564 HT_SM_POOL = "pool"
 565
 566 HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])
 567
 568 # Cluster Verify steps
 569 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
 570 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
 571
 572 # Node verify constants
 573 NV_FILELIST = "filelist"
 574 NV_HVINFO = "hvinfo"
 575 NV_HYPERVISOR = "hypervisor"
 576 NV_INSTANCELIST = "instancelist"
 577 NV_NODELIST = "nodelist"
 578 NV_NODENETTEST = "node-net-test"
 579 NV_VERSION = "version"
 580 NV_VGLIST = "vglist"
 581 NV_LVLIST = "lvlist"
 582 NV_PVLIST = "pvlist"
 583 NV_DRBDLIST = "drbd-list"
 584 NV_NODESETUP = "nodesetup"
 585 NV_TIME = "time"
 586
 587 # SSL certificate check constants (in days)
 588 SSL_CERT_EXPIRATION_WARN = 30
 589 SSL_CERT_EXPIRATION_ERROR = 7
 590
 591 # Allocator framework constants
 592 IALLOCATOR_VERSION = 2
 593 IALLOCATOR_DIR_IN = "in"
 594 IALLOCATOR_DIR_OUT = "out"
 595 IALLOCATOR_MODE_ALLOC = "allocate"
 596 IALLOCATOR_MODE_RELOC = "relocate"
 597 IALLOCATOR_MODE_MEVAC = "multi-evacuate"
 598 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
 599
 600 # Job queue
 601 JOB_QUEUE_VERSION = 1
 602 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
 603 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
 604 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
 605 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
 606 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
 607 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
 608 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
 609
 610 JOB_ID_TEMPLATE = r"\d+"
 611
 612 # unchanged job return
 613 JOB_NOTCHANGED = "nochange"
 614
 615 # Job status
 616 JOB_STATUS_QUEUED = "queued"
 617 JOB_STATUS_WAITLOCK = "waiting"
 618 JOB_STATUS_CANCELING = "canceling"
 619 JOB_STATUS_RUNNING = "running"
 620 JOB_STATUS_CANCELED = "canceled"
 621 JOB_STATUS_SUCCESS = "success"
 622 JOB_STATUS_ERROR = "error"
 623
 624 # OpCode status
 625 # not yet finalized
 626 OP_STATUS_QUEUED = "queued"
 627 OP_STATUS_WAITLOCK = "waiting"
 628 OP_STATUS_CANCELING = "canceling"
 629 OP_STATUS_RUNNING = "running"
 630 # finalized
 631 OP_STATUS_CANCELED = "canceled"
 632 OP_STATUS_SUCCESS = "success"
 633 OP_STATUS_ERROR = "error"
 634 OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,
 635                            OP_STATUS_SUCCESS,
 636                            OP_STATUS_ERROR])
 637
 638 # Execution log types
 639 ELOG_MESSAGE = "message"
 640 ELOG_PROGRESS = "progress"
 641
 642 # max dynamic devices
 643 MAX_NICS = 8
 644 MAX_DISKS = 16
 645
 646 # SSCONF keys
 647 SS_CLUSTER_NAME = "cluster_name"
 648 SS_CLUSTER_TAGS = "cluster_tags"
 649 SS_FILE_STORAGE_DIR = "file_storage_dir"
 650 SS_MASTER_CANDIDATES = "master_candidates"
 651 SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"
 652 SS_MASTER_IP = "master_ip"
 653 SS_MASTER_NETDEV = "master_netdev"
 654 SS_MASTER_NODE = "master_node"
 655 SS_NODE_LIST = "node_list"
 656 SS_NODE_PRIMARY_IPS = "node_primary_ips"
 657 SS_NODE_SECONDARY_IPS = "node_secondary_ips"
 658 SS_OFFLINE_NODES = "offline_nodes"
 659 SS_ONLINE_NODES = "online_nodes"
 660 SS_INSTANCE_LIST = "instance_list"
 661 SS_RELEASE_VERSION = "release_version"
 662
 663 # cluster wide default parameters
 664 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
 665
 666 HVC_DEFAULTS = {
 667   HT_XEN_PVM: {
 668     HV_USE_BOOTLOADER: False,
 669     HV_BOOTLOADER_PATH: XEN_BOOTLOADER,
 670     HV_BOOTLOADER_ARGS: '',
 671     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
 672     HV_INITRD_PATH: '',
 673     HV_ROOT_PATH: '/dev/sda1',
 674     HV_KERNEL_ARGS: 'ro',
 675     HV_MIGRATION_PORT: 8002,
 676     },
 677   HT_XEN_HVM: {
 678     HV_BOOT_ORDER: "cd",
 679     HV_CDROM_IMAGE_PATH: '',
 680     HV_NIC_TYPE: HT_NIC_RTL8139,
 681     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
 682     HV_VNC_BIND_ADDRESS: '0.0.0.0',
 683     HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,
 684     HV_ACPI: True,
 685     HV_PAE: True,
 686     HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",
 687     HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",
 688     HV_MIGRATION_PORT: 8002,
 689     HV_USE_LOCALTIME: False,
 690     },
 691   HT_KVM: {
 692     HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
 693     HV_INITRD_PATH: '',
 694     HV_KERNEL_ARGS: 'ro',
 695     HV_ROOT_PATH: '/dev/vda1',
 696     HV_ACPI: True,
 697     HV_SERIAL_CONSOLE: True,
 698     HV_VNC_BIND_ADDRESS: '',
 699     HV_VNC_TLS: False,
 700     HV_VNC_X509: '',
 701     HV_VNC_X509_VERIFY: False,
 702     HV_VNC_PASSWORD_FILE: '',
 703     HV_CDROM_IMAGE_PATH: '',
 704     HV_BOOT_ORDER: HT_BO_DISK,
 705     HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
 706     HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
 707     HV_USB_MOUSE: '',
 708     HV_MIGRATION_PORT: 8102,
 709     HV_USE_LOCALTIME: False,
 710     HV_DISK_CACHE: HT_CACHE_DEFAULT,
 711     HV_SECURITY_MODEL: HT_SM_NONE,
 712     HV_SECURITY_DOMAIN: '',
 713     },
 714   HT_FAKE: {
 715     },
 716   HT_CHROOT: {
 717     HV_INIT_SCRIPT: "/ganeti-chroot",
 718     },
 719   }
 720
 721 HVC_GLOBALS = frozenset([
 722   HV_MIGRATION_PORT,
 723   ])
 724
 725 BEC_DEFAULTS = {
 726   BE_MEMORY: 128,
 727   BE_VCPUS: 1,
 728   BE_AUTO_BALANCE: True,
 729   }
 730
 731 NICC_DEFAULTS = {
 732   NIC_MODE: NIC_MODE_BRIDGED,
 733   NIC_LINK: DEFAULT_BRIDGE,
 734   }
 735
 736 MASTER_POOL_SIZE_DEFAULT = 10
 737
 738 CONFD_PROTOCOL_VERSION = 1
 739
 740 CONFD_REQ_PING = 0
 741 CONFD_REQ_NODE_ROLE_BYNAME = 1
 742 CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2
 743 CONFD_REQ_CLUSTER_MASTER = 3
 744 CONFD_REQ_NODE_PIP_LIST = 4
 745 CONFD_REQ_MC_PIP_LIST = 5
 746 CONFD_REQ_INSTANCES_IPS_LIST = 6
 747
 748 # Confd request query fields. These are used to narrow down queries.
 749 # These must be strings rather than integers, because json-encoding
 750 # converts them to strings anyway, as they're used as dict-keys.
 751 CONFD_REQQ_LINK = "0"
 752 CONFD_REQQ_IP = "1"
 753 CONFD_REQQ_IPLIST = "2"
 754 CONFD_REQQ_FIELDS = "3"
 755
 756 CONFD_REQFIELD_NAME = "0"
 757 CONFD_REQFIELD_IP = "1"
 758 CONFD_REQFIELD_MNODE_PIP = "2"
 759
 760 CONFD_REQS = frozenset([
 761   CONFD_REQ_PING,
 762   CONFD_REQ_NODE_ROLE_BYNAME,
 763   CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,
 764   CONFD_REQ_CLUSTER_MASTER,
 765   CONFD_REQ_NODE_PIP_LIST,
 766   CONFD_REQ_MC_PIP_LIST,
 767   CONFD_REQ_INSTANCES_IPS_LIST,
 768   ])
 769
 770 CONFD_REPL_STATUS_OK = 0
 771 CONFD_REPL_STATUS_ERROR = 1
 772 CONFD_REPL_STATUS_NOTIMPLEMENTED = 2
 773
 774 CONFD_REPL_STATUSES = frozenset([
 775   CONFD_REPL_STATUS_OK,
 776   CONFD_REPL_STATUS_ERROR,
 777   CONFD_REPL_STATUS_NOTIMPLEMENTED,
 778   ])
 779
 780 (CONFD_NODE_ROLE_MASTER,
 781  CONFD_NODE_ROLE_CANDIDATE,
 782  CONFD_NODE_ROLE_OFFLINE,
 783  CONFD_NODE_ROLE_DRAINED,
 784  CONFD_NODE_ROLE_REGULAR,
 785  ) = range(5)
 786
 787 # A few common errors for confd
 788 CONFD_ERROR_UNKNOWN_ENTRY = 1
 789 CONFD_ERROR_INTERNAL = 2
 790 CONFD_ERROR_ARGUMENT = 3
 791
 792 # Each request is "salted" by the current timestamp.
 793 # This constants decides how many seconds of skew to accept.
 794 # TODO: make this a default and allow the value to be more configurable
 795 CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW
 796
 797 # When we haven't reloaded the config for more than this amount of seconds, we
 798 # force a test to see if inotify is betraying us.
 799 CONFD_CONFIG_RELOAD_TIMEOUT = 60
 800
 801 # If we receive more than one update in this amount of seconds, we move to
 802 # polling every RATELIMIT seconds, rather than relying on inotify, to be able
 803 # to serve more requests.
 804 CONFD_CONFIG_RELOAD_RATELIMIT = 2
 805
 806 # Magic number prepended to all confd queries.
 807 # This allows us to distinguish different types of confd protocols and handle
 808 # them. For example by changing this we can move the whole payload to be
 809 # compressed, or move away from json.
 810 CONFD_MAGIC_FOURCC = 'plj0'
 811
 812 # By default a confd request is sent to the minimum between this number and all
 813 # MCs. 6 was chosen because even in the case of a disastrous 50% response rate,
 814 # we should have enough answers to be able to compare more than one.
 815 CONFD_DEFAULT_REQ_COVERAGE = 6
 816
 817 # Timeout in seconds to expire pending query request in the confd client
 818 # library. We don't actually expect any answer more than 10 seconds after we
 819 # sent a request.
 820 CONFD_CLIENT_EXPIRE_TIMEOUT = 10
 821
 822 # Maximum UDP datagram size.
 823 # On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507
 824 # On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487
 825 #   (assuming we can't use jumbo frames)
 826 # We just set this to 60K, which should be enough
 827 MAX_UDP_DATA_SIZE = 61440