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