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