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

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