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