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