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