Synnefo » snf-ganeti

#

#

# Copyright (C) 2006, 2007 Google Inc.

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

# General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

# 02110-1301, USA.

"""Module holding different constants."""

import re

from ganeti import _autoconf

# various versions

PROTOCOL_VERSION = 40

RELEASE_VERSION = _autoconf.PACKAGE_VERSION

OS_API_V10 = 10

OS_API_V15 = 15

OS_API_V20 = 20

OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])

EXPORT_VERSION = 0

RAPI_VERSION = 2

# Format for CONFIG_VERSION:

#   01 03 0123 = 01030123

#   ^^ ^^ ^^^^

#   |  |  + Configuration version/revision

#   |  + Minor version

#   + Major version

#

# It stored as an integer. Make sure not to write an octal number.

# BuildVersion and SplitVersion must be in here because we can't import other

# modules. The cfgupgrade tool must be able to read and write version numbers

# and thus requires these functions. To avoid code duplication, they're kept in

# here.

def BuildVersion(major, minor, revision):

  """Calculates int version number from major, minor and revision numbers.

  Returns: int representing version number

  """

  assert isinstance(major, int)

  assert isinstance(minor, int)

  assert isinstance(revision, int)

  return (1000000 * major +

            10000 * minor +

                1 * revision)

def SplitVersion(version):

  """Splits version number stored in an int.

  Returns: tuple; (major, minor, revision)

  """

  assert isinstance(version, int)

  (major, remainder) = divmod(version, 1000000)

  (minor, revision) = divmod(remainder, 10000)

  return (major, minor, revision)

CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)

CONFIG_MINOR = int(_autoconf.VERSION_MINOR)

CONFIG_REVISION = 0

CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)

# user separation

DAEMONS_GROUP = _autoconf.DAEMONS_GROUP

MASTERD_USER = _autoconf.MASTERD_USER

RAPI_USER = _autoconf.RAPI_USER

# file paths

DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"

RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"

RUN_GANETI_DIR = RUN_DIR + "/ganeti"

BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"

DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"

RUN_DIRS_MODE = 0775

SOCKET_DIR = RUN_GANETI_DIR + "/socket"

SECURE_DIR_MODE = 0700

SOCKET_DIR_MODE = 0750

CRYPTO_KEYS_DIR = RUN_GANETI_DIR + "/crypto"

CRYPTO_KEYS_DIR_MODE = SECURE_DIR_MODE

IMPORT_EXPORT_DIR = RUN_GANETI_DIR + "/import-export"

IMPORT_EXPORT_DIR_MODE = 0755

# keep RUN_GANETI_DIR first here, to make sure all get created when the node

# daemon is started (this takes care of RUN_DIR being tmpfs)

SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]

LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"

SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"

# User-id pool lock directory

# The user-ids that are in use have a corresponding lock file in this directory

UIDPOOL_LOCKDIR = RUN_GANETI_DIR + "/uid-pool"

CLUSTER_CONF_FILE = DATA_DIR + "/config.data"

NODED_CERT_FILE = DATA_DIR + "/server.pem"

RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"

CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"

CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"

WATCHER_STATEFILE = DATA_DIR + "/watcher.data"

WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"

INSTANCE_UPFILE = RUN_GANETI_DIR + "/instance-status"

SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"

RAPI_USERS_FILE = DATA_DIR + "/rapi_users"

QUEUE_DIR = DATA_DIR + "/queue"

DAEMON_UTIL = _autoconf.PKGLIBDIR + "/daemon-util"

ETC_HOSTS = "/etc/hosts"

DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR

ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE

SYSCONFDIR = _autoconf.SYSCONFDIR

TOOLSDIR = _autoconf.TOOLSDIR

CONF_DIR = SYSCONFDIR + "/ganeti"

ALL_CERT_FILES = frozenset([NODED_CERT_FILE, RAPI_CERT_FILE])

MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"

NODED = "ganeti-noded"

CONFD = "ganeti-confd"

RAPI = "ganeti-rapi"

MASTERD = "ganeti-masterd"

# used in the ganeti-nbma project

NLD = "ganeti-nld"

DAEMONS_PORTS = {

  # daemon-name: ("proto", "default-port")

  NODED: ("tcp", 1811),

  CONFD: ("udp", 1814),

  RAPI: ("tcp", 5080),

  # used in the ganeti-nbma project

  NLD: ("udp", 1816),

}

DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]

DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]

DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]

# used in the ganeti-nbma project

DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]

FIRST_DRBD_PORT = 11000

LAST_DRBD_PORT = 14999

MASTER_SCRIPT = "ganeti-master"

LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"

DAEMONS_LOGFILES = {

  # "daemon-name": "logfile"

  NODED: LOG_DIR + "node-daemon.log",

  CONFD: LOG_DIR + "conf-daemon.log",

  RAPI: LOG_DIR + "rapi-daemon.log",

  MASTERD: LOG_DIR + "master-daemon.log",

  # used in the ganeti-nbma project

  NLD: LOG_DIR + "nl-daemon.log",

  }

LOG_OS_DIR = LOG_DIR + "os"

LOG_WATCHER = LOG_DIR + "watcher.log"

LOG_COMMANDS = LOG_DIR + "commands.log"

LOG_BURNIN = LOG_DIR + "burnin.log"

DEV_CONSOLE = "/dev/console"

# luxi related constants

LUXI_EOM = "\3"

# one of 'no', 'yes', 'only'

SYSLOG_USAGE = _autoconf.SYSLOG_USAGE

SYSLOG_NO = "no"

SYSLOG_YES = "yes"

SYSLOG_ONLY = "only"

SYSLOG_SOCKET = "/dev/log"

OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH

EXPORT_DIR = _autoconf.EXPORT_DIR

EXPORT_CONF_FILE = "config.ini"

XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER

XEN_KERNEL = _autoconf.XEN_KERNEL

XEN_INITRD = _autoconf.XEN_INITRD

KVM_PATH = _autoconf.KVM_PATH

SOCAT_PATH = _autoconf.SOCAT_PATH

SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE

SOCAT_ESCAPE_CODE = "0x1d"

# For RSA keys more bits are better, but they also make operations more

# expensive. NIST SP 800-131 recommends a minimum of 2048 bits from the year

# 2010 on.

RSA_KEY_BITS = 2048

# Ciphers allowed for SSL connections. For the format, see ciphers(1). A better

# way to disable ciphers would be to use the exclamation mark (!), but socat

# versions below 1.5 can't parse exclamation marks in options properly. When

# modifying the ciphers, ensure to not accidentially add something after it's

# been removed. Use the "openssl" utility to check the allowed ciphers, e.g.

# "openssl ciphers -v HIGH:-DES".

OPENSSL_CIPHERS = "HIGH:-DES:-3DES:-EXPORT:-ADH"

# Digest used to sign certificates ("openssl x509" uses SHA1 by default)

X509_CERT_SIGN_DIGEST = "SHA1"

X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

IMPORT_EXPORT_DAEMON = _autoconf.PKGLIBDIR + "/import-export"

# Import/export daemon mode

IEM_IMPORT = "import"

IEM_EXPORT = "export"

# Import/export transport compression

IEC_NONE = "none"

IEC_GZIP = "gzip"

IEC_ALL = frozenset([

  IEC_NONE,

  IEC_GZIP,

  ])

IE_CUSTOM_SIZE = "fd"

IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")

# Import/export I/O

# Direct file I/O, equivalent to a shell's I/O redirection using '<' or '>'

IEIO_FILE = "file"

# Raw block device I/O using "dd"

IEIO_RAW_DISK = "raw"

# OS definition import/export script

IEIO_SCRIPT = "script"

VALUE_DEFAULT = "default"

VALUE_AUTO = "auto"

VALUE_GENERATE = "generate"

VALUE_NONE = "none"

VALUE_TRUE = "true"

VALUE_FALSE = "false"

# External script validation mask

EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")

# hooks-related constants

HOOKS_BASE_DIR = CONF_DIR + "/hooks"

HOOKS_PHASE_PRE = "pre"

HOOKS_PHASE_POST = "post"

HOOKS_NAME_CFGUPDATE = "config-update"

HOOKS_NAME_WATCHER = "watcher"

HOOKS_VERSION = 2

# hooks subject type (what object type does the LU deal with)

HTYPE_CLUSTER = "CLUSTER"

HTYPE_NODE = "NODE"

HTYPE_INSTANCE = "INSTANCE"

HKR_SKIP = 0

HKR_FAIL = 1

HKR_SUCCESS = 2

# Storage types

ST_FILE = "file"

ST_LVM_PV = "lvm-pv"

ST_LVM_VG = "lvm-vg"

# Storage fields

# first two are valid in LU context only, not passed to backend

SF_NODE = "node"

SF_TYPE = "type"

# and the rest are valid in backend

SF_NAME = "name"

SF_SIZE = "size"

SF_FREE = "free"

SF_USED = "used"

SF_ALLOCATABLE = "allocatable"

# Storage operations

SO_FIX_CONSISTENCY = "fix-consistency"

# Available fields per storage type

VALID_STORAGE_FIELDS = frozenset([SF_NAME, SF_TYPE, SF_SIZE,

                                  SF_USED, SF_FREE, SF_ALLOCATABLE])

VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])

MODIFIABLE_STORAGE_FIELDS = {

  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),

  }

VALID_STORAGE_OPERATIONS = {

  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),

  }

# Local disk status

# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY

(LDS_OKAY,

 LDS_UNKNOWN,

 LDS_FAULTY) = range(1, 4)

# disk template types

DT_DISKLESS = "diskless"

DT_PLAIN = "plain"

DT_DRBD8 = "drbd"

DT_FILE = "file"

# the set of network-mirrored disk templates

DTS_NET_MIRROR = frozenset([DT_DRBD8])

# the set of non-lvm-based disk templates

DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])

# the set of disk templates which can be grown

DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE])

# logical disk types

LD_LV = "lvm"

LD_DRBD8 = "drbd8"

LD_FILE = "file"

LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])

# drbd constants

DRBD_HMAC_ALG = "md5"

DRBD_NET_PROTOCOL = "C"

DRBD_BARRIERS = _autoconf.DRBD_BARRIERS

# file backend driver

FD_LOOP = "loop"

FD_BLKTAP = "blktap"

# the set of drbd-like disk types

LDS_DRBD = frozenset([LD_DRBD8])

# disk access mode

DISK_RDONLY = "ro"

DISK_RDWR = "rw"

DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

# disk replacement mode

REPLACE_DISK_PRI = "replace_on_primary"    # replace disks on primary

REPLACE_DISK_SEC = "replace_on_secondary"  # replace disks on secondary

REPLACE_DISK_CHG = "replace_new_secondary" # change secondary node

REPLACE_DISK_AUTO = "replace_auto"

# Instance export mode

EXPORT_MODE_LOCAL = "local"

EXPORT_MODE_REMOTE = "remote"

EXPORT_MODES = frozenset([

  EXPORT_MODE_LOCAL,

  EXPORT_MODE_REMOTE,

  ])

# lock recalculate mode

LOCKS_REPLACE = 'replace'

LOCKS_APPEND = 'append'

# instance creation modes

INSTANCE_CREATE = "create"

INSTANCE_IMPORT = "import"

INSTANCE_REMOTE_IMPORT = "remote-import"

INSTANCE_CREATE_MODES = frozenset([

  INSTANCE_CREATE,

  INSTANCE_IMPORT,

  INSTANCE_REMOTE_IMPORT,

  ])

# Remote import/export handshake message and version

RIE_VERSION = 0

RIE_HANDSHAKE = "Hi, I'm Ganeti"

# Remote import/export certificate validity in seconds

RIE_CERT_VALIDITY = 24 * 60 * 60

# Remote import/export connect timeout for socat

RIE_CONNECT_TIMEOUT = 60

DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,

                            DT_DRBD8, DT_FILE])

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])

# import/export config options

INISECT_EXP = "export"

INISECT_INS = "instance"

INISECT_HYP = "hypervisor"

INISECT_BEP = "backend"

# dynamic device modification

DDM_ADD = 'add'

DDM_REMOVE = 'remove'

# common exit codes

EXIT_SUCCESS = 0

EXIT_FAILURE = 1

EXIT_NOTCLUSTER = 5

EXIT_NOTMASTER = 11

EXIT_NODESETUP_ERROR = 12

EXIT_CONFIRMATION = 13 # need user confirmation

# tags

TAG_CLUSTER = "cluster"

TAG_NODE = "node"

TAG_INSTANCE = "instance"

MAX_TAG_LEN = 128

MAX_TAGS_PER_OBJ = 4096

# others

DEFAULT_BRIDGE = "xen-br0"

SYNC_SPEED = 60 * 1024

LOCALHOST_IP_ADDRESS = "127.0.0.1"

TCP_PING_TIMEOUT = 10

GANETI_RUNAS = "root"

DEFAULT_VG = "xenvg"

BIND_ADDRESS_GLOBAL = "0.0.0.0"

MIN_VG_SIZE = 20480

DEFAULT_MAC_PREFIX = "aa:00:00"

LVM_STRIPECOUNT = _autoconf.LVM_STRIPECOUNT

# default maximum instance wait time, in seconds.

DEFAULT_SHUTDOWN_TIMEOUT = 120

NODE_MAX_CLOCK_SKEW = 150

# Time for an intra-cluster disk transfer to wait for a connection

DISK_TRANSFER_CONNECT_TIMEOUT = 30

# runparts results

(RUNPARTS_SKIP,

 RUNPARTS_RUN,

 RUNPARTS_ERR) = range(3)

RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])

# RPC constants

(RPC_ENCODING_NONE,

 RPC_ENCODING_ZLIB_BASE64) = range(2)

# os related constants

OS_SCRIPT_CREATE = 'create'

OS_SCRIPT_IMPORT = 'import'

OS_SCRIPT_EXPORT = 'export'

OS_SCRIPT_RENAME = 'rename'

OS_SCRIPT_VERIFY = 'verify'

OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,

                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME,

                        OS_SCRIPT_VERIFY])

OS_API_FILE = 'ganeti_api_version'

OS_VARIANTS_FILE = 'variants.list'

OS_PARAMETERS_FILE = 'parameters.list'

OS_VALIDATE_PARAMETERS = 'parameters'

# ssh constants

SSH_CONFIG_DIR = _autoconf.SSH_CONFIG_DIR

SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"

SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"

SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"

SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"

SSH = "ssh"

SCP = "scp"

# reboot types

INSTANCE_REBOOT_SOFT = "soft"

INSTANCE_REBOOT_HARD = "hard"

INSTANCE_REBOOT_FULL = "full"

REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,

                          INSTANCE_REBOOT_HARD,

                          INSTANCE_REBOOT_FULL])

VTYPE_STRING = 'string'

VTYPE_BOOL = 'bool'

VTYPE_SIZE = 'size' # size, in MiBs

VTYPE_INT = 'int'

ENFORCEABLE_TYPES = frozenset([

                      VTYPE_STRING,

                      VTYPE_BOOL,

                      VTYPE_SIZE,

                      VTYPE_INT,

                      ])

# HV parameter names (global namespace)

HV_BOOT_ORDER = "boot_order"

HV_CDROM_IMAGE_PATH = "cdrom_image_path"

HV_NIC_TYPE = "nic_type"

HV_DISK_TYPE = "disk_type"

HV_VNC_BIND_ADDRESS = "vnc_bind_address"

HV_VNC_PASSWORD_FILE = "vnc_password_file"

HV_VNC_TLS = "vnc_tls"

HV_VNC_X509 = "vnc_x509_path"

HV_VNC_X509_VERIFY = "vnc_x509_verify"

HV_ACPI = "acpi"

HV_PAE = "pae"

HV_USE_BOOTLOADER = "use_bootloader"

HV_BOOTLOADER_ARGS = "bootloader_args"

HV_BOOTLOADER_PATH = "bootloader_path"

HV_KERNEL_ARGS = "kernel_args"

HV_KERNEL_PATH = "kernel_path"

HV_INITRD_PATH = "initrd_path"

HV_ROOT_PATH = "root_path"

HV_SERIAL_CONSOLE = "serial_console"

HV_USB_MOUSE = "usb_mouse"

HV_DEVICE_MODEL = "device_model"

HV_INIT_SCRIPT = "init_script"

HV_MIGRATION_PORT = "migration_port"

HV_MIGRATION_BANDWIDTH = "migration_bandwidth"

HV_MIGRATION_DOWNTIME = "migration_downtime"

HV_USE_LOCALTIME = "use_localtime"

HV_DISK_CACHE = "disk_cache"

HV_SECURITY_MODEL = "security_model"

HV_SECURITY_DOMAIN = "security_domain"

HV_KVM_FLAG = "kvm_flag"

HV_VHOST_NET = "vhost_net"

HV_KVM_USE_CHROOT = "use_chroot"

HVS_PARAMETER_TYPES = {

  HV_BOOT_ORDER: VTYPE_STRING,

  HV_CDROM_IMAGE_PATH: VTYPE_STRING,

  HV_NIC_TYPE: VTYPE_STRING,

  HV_DISK_TYPE: VTYPE_STRING,

  HV_VNC_PASSWORD_FILE: VTYPE_STRING,

  HV_VNC_BIND_ADDRESS: VTYPE_STRING,

  HV_VNC_TLS: VTYPE_BOOL,

  HV_VNC_X509: VTYPE_STRING,

  HV_VNC_X509_VERIFY: VTYPE_BOOL,

  HV_ACPI: VTYPE_BOOL,

  HV_PAE: VTYPE_BOOL,

  HV_USE_BOOTLOADER: VTYPE_BOOL,

  HV_BOOTLOADER_PATH: VTYPE_STRING,

  HV_BOOTLOADER_ARGS: VTYPE_STRING,

  HV_KERNEL_PATH: VTYPE_STRING,

  HV_KERNEL_ARGS: VTYPE_STRING,

  HV_INITRD_PATH: VTYPE_STRING,

  HV_ROOT_PATH: VTYPE_STRING,

  HV_SERIAL_CONSOLE: VTYPE_BOOL,

  HV_USB_MOUSE: VTYPE_STRING,

  HV_DEVICE_MODEL: VTYPE_STRING,

  HV_INIT_SCRIPT: VTYPE_STRING,

  HV_MIGRATION_PORT: VTYPE_INT,

  HV_MIGRATION_BANDWIDTH: VTYPE_INT,

  HV_MIGRATION_DOWNTIME: VTYPE_INT,

  HV_USE_LOCALTIME: VTYPE_BOOL,

  HV_DISK_CACHE: VTYPE_STRING,

  HV_SECURITY_MODEL: VTYPE_STRING,

  HV_SECURITY_DOMAIN: VTYPE_STRING,

  HV_KVM_FLAG: VTYPE_STRING,

  HV_VHOST_NET: VTYPE_BOOL,

  HV_KVM_USE_CHROOT: VTYPE_BOOL,

  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())

# BE parameter names

BE_MEMORY = "memory"

BE_VCPUS = "vcpus"

BE_AUTO_BALANCE = "auto_balance"

BES_PARAMETER_TYPES = {

    BE_MEMORY: VTYPE_SIZE,

    BE_VCPUS: VTYPE_INT,

    BE_AUTO_BALANCE: VTYPE_BOOL,

    }

BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())

# Instance Parameters Profile

PP_DEFAULT = "default"

NIC_MODE = "mode"

NIC_LINK = "link"

NIC_MODE_BRIDGED = "bridged"

NIC_MODE_ROUTED = "routed"

NIC_VALID_MODES = frozenset([NIC_MODE_BRIDGED, NIC_MODE_ROUTED])

NICS_PARAMETER_TYPES = {

    NIC_MODE: VTYPE_STRING,

    NIC_LINK: VTYPE_STRING,

    }

NICS_PARAMETERS = frozenset(NICS_PARAMETER_TYPES.keys())

IDISK_SIZE = "size"

IDISK_MODE = "mode"

IDISK_ADOPT = "adopt"

IDISK_PARAMS = frozenset([IDISK_SIZE, IDISK_MODE, IDISK_ADOPT])

IDISK_PARAMS_TYPES = {

  IDISK_SIZE: VTYPE_SIZE,

  IDISK_MODE: VTYPE_STRING,

  IDISK_ADOPT: VTYPE_STRING,

  }

INIC_MAC = "mac"

INIC_IP = "ip"

INIC_MODE = "mode"

INIC_LINK = "link"

INIC_BRIDGE = "bridge"

INIC_PARAMS = frozenset([INIC_MAC, INIC_IP, INIC_MODE, INIC_LINK, INIC_BRIDGE])

INIC_PARAMS_TYPES = dict([(name, VTYPE_STRING) for name in INIC_PARAMS])

# Hypervisor constants

HT_XEN_PVM = "xen-pvm"

HT_FAKE = "fake"

HT_XEN_HVM = "xen-hvm"

HT_KVM = "kvm"

HT_CHROOT = "chroot"

HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM, HT_CHROOT])

HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])

VNC_BASE_PORT = 5900

VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"

VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'

# NIC types

HT_NIC_RTL8139 = "rtl8139"

HT_NIC_NE2K_PCI = "ne2k_pci"

HT_NIC_NE2K_ISA = "ne2k_isa"

HT_NIC_I82551 = "i82551"

HT_NIC_I85557B = "i82557b"

HT_NIC_I8259ER = "i82559er"

HT_NIC_PCNET = "pcnet"

HT_NIC_E1000 = "e1000"

HT_NIC_PARAVIRTUAL = HT_DISK_PARAVIRTUAL = "paravirtual"

HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,

                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])

HT_KVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,

                                    HT_NIC_NE2K_ISA, HT_NIC_I82551,

                                    HT_NIC_I85557B, HT_NIC_I8259ER,

                                    HT_NIC_PCNET, HT_NIC_E1000,

                                    HT_NIC_PARAVIRTUAL])

# Disk types

HT_DISK_IOEMU = "ioemu"

HT_DISK_IDE = "ide"

HT_DISK_SCSI = "scsi"

HT_DISK_SD = "sd"

HT_DISK_MTD = "mtd"

HT_DISK_PFLASH = "pflash"

HT_CACHE_DEFAULT = "default"

HT_CACHE_NONE = "none"

HT_CACHE_WTHROUGH = "writethrough"

HT_CACHE_WBACK = "writeback"

HT_VALID_CACHE_TYPES = frozenset([HT_CACHE_DEFAULT,

                                  HT_CACHE_NONE,

                                  HT_CACHE_WTHROUGH,

                                  HT_CACHE_WBACK])

HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])

HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,

                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,

                                     HT_DISK_PFLASH])

# Mouse types:

HT_MOUSE_MOUSE = "mouse"

HT_MOUSE_TABLET = "tablet"

HT_KVM_VALID_MOUSE_TYPES = frozenset([HT_MOUSE_MOUSE, HT_MOUSE_TABLET])

# Boot order

HT_BO_CDROM = "cdrom"

HT_BO_DISK = "disk"

HT_BO_NETWORK = "network"

HT_KVM_VALID_BO_TYPES = frozenset([HT_BO_CDROM, HT_BO_DISK, HT_BO_NETWORK])

# Security models

HT_SM_NONE = "none"

HT_SM_USER = "user"

HT_SM_POOL = "pool"

HT_KVM_VALID_SM_TYPES = frozenset([HT_SM_NONE, HT_SM_USER, HT_SM_POOL])

# Kvm flag values

HT_KVM_ENABLED = "enabled"

HT_KVM_DISABLED = "disabled"

HT_KVM_FLAG_VALUES = frozenset([HT_KVM_ENABLED, HT_KVM_DISABLED])

# Cluster Verify steps

VERIFY_NPLUSONE_MEM = 'nplusone_mem'

VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])

# Node verify constants

NV_FILELIST = "filelist"

NV_HVINFO = "hvinfo"

NV_HYPERVISOR = "hypervisor"

NV_INSTANCELIST = "instancelist"

NV_NODELIST = "nodelist"

NV_NODENETTEST = "node-net-test"

NV_VERSION = "version"

NV_VGLIST = "vglist"

NV_LVLIST = "lvlist"

NV_PVLIST = "pvlist"

NV_DRBDLIST = "drbd-list"

NV_NODESETUP = "nodesetup"

NV_TIME = "time"

NV_MASTERIP = "master-ip"

# SSL certificate check constants (in days)

SSL_CERT_EXPIRATION_WARN = 30

SSL_CERT_EXPIRATION_ERROR = 7

# Allocator framework constants

IALLOCATOR_VERSION = 2

IALLOCATOR_DIR_IN = "in"

IALLOCATOR_DIR_OUT = "out"

IALLOCATOR_MODE_ALLOC = "allocate"

IALLOCATOR_MODE_RELOC = "relocate"

IALLOCATOR_MODE_MEVAC = "multi-evacuate"

IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH

# Job queue

JOB_QUEUE_VERSION = 1

JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"

JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"

JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"

JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"

JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"

JOB_QUEUE_SIZE_HARD_LIMIT = 5000

JOB_QUEUE_DIRS = [QUEUE_DIR, JOB_QUEUE_ARCHIVE_DIR]

JOB_QUEUE_DIRS_MODE = SECURE_DIR_MODE

JOB_ID_TEMPLATE = r"\d+"

# unchanged job return

JOB_NOTCHANGED = "nochange"

# Job status

JOB_STATUS_QUEUED = "queued"

JOB_STATUS_WAITLOCK = "waiting"

JOB_STATUS_CANCELING = "canceling"

JOB_STATUS_RUNNING = "running"

JOB_STATUS_CANCELED = "canceled"

JOB_STATUS_SUCCESS = "success"

JOB_STATUS_ERROR = "error"

# OpCode status

# not yet finalized

OP_STATUS_QUEUED = "queued"

OP_STATUS_WAITLOCK = "waiting"

OP_STATUS_CANCELING = "canceling"

OP_STATUS_RUNNING = "running"

# finalized

OP_STATUS_CANCELED = "canceled"

OP_STATUS_SUCCESS = "success"

OP_STATUS_ERROR = "error"

OPS_FINALIZED = frozenset([OP_STATUS_CANCELED,

                           OP_STATUS_SUCCESS,

                           OP_STATUS_ERROR])

# Execution log types

ELOG_MESSAGE = "message"

ELOG_PROGRESS = "progress"

ELOG_REMOTE_IMPORT = "remote-import"

# max dynamic devices

MAX_NICS = 8

MAX_DISKS = 16

# SSCONF keys

SS_CLUSTER_NAME = "cluster_name"

SS_CLUSTER_TAGS = "cluster_tags"

SS_FILE_STORAGE_DIR = "file_storage_dir"

SS_MASTER_CANDIDATES = "master_candidates"

SS_MASTER_CANDIDATES_IPS = "master_candidates_ips"

SS_MASTER_IP = "master_ip"

SS_MASTER_NETDEV = "master_netdev"

SS_MASTER_NODE = "master_node"

SS_NODE_LIST = "node_list"

SS_NODE_PRIMARY_IPS = "node_primary_ips"

SS_NODE_SECONDARY_IPS = "node_secondary_ips"

SS_OFFLINE_NODES = "offline_nodes"

SS_ONLINE_NODES = "online_nodes"

SS_INSTANCE_LIST = "instance_list"

SS_RELEASE_VERSION = "release_version"

SS_HYPERVISOR_LIST = "hypervisor_list"

SS_MAINTAIN_NODE_HEALTH = "maintain_node_health"

SS_UID_POOL = "uid_pool"

# cluster wide default parameters

DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM

HVC_DEFAULTS = {

  HT_XEN_PVM: {

    HV_USE_BOOTLOADER: False,

    HV_BOOTLOADER_PATH: XEN_BOOTLOADER,

    HV_BOOTLOADER_ARGS: '',

    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",

    HV_INITRD_PATH: '',

    HV_ROOT_PATH: '/dev/sda1',

    HV_KERNEL_ARGS: 'ro',

    HV_MIGRATION_PORT: 8002,

    },

  HT_XEN_HVM: {

    HV_BOOT_ORDER: "cd",

    HV_CDROM_IMAGE_PATH: '',

    HV_NIC_TYPE: HT_NIC_RTL8139,

    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,

    HV_VNC_BIND_ADDRESS: '0.0.0.0',

    HV_VNC_PASSWORD_FILE: VNC_PASSWORD_FILE,

    HV_ACPI: True,

    HV_PAE: True,

    HV_KERNEL_PATH: "/usr/lib/xen/boot/hvmloader",

    HV_DEVICE_MODEL: "/usr/lib/xen/bin/qemu-dm",

    HV_MIGRATION_PORT: 8002,

    HV_USE_LOCALTIME: False,

    },

  HT_KVM: {

    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",

    HV_INITRD_PATH: '',

    HV_KERNEL_ARGS: 'ro',

    HV_ROOT_PATH: '/dev/vda1',

    HV_ACPI: True,

    HV_SERIAL_CONSOLE: True,

    HV_VNC_BIND_ADDRESS: '',

    HV_VNC_TLS: False,

    HV_VNC_X509: '',

    HV_VNC_X509_VERIFY: False,

    HV_VNC_PASSWORD_FILE: '',

    HV_CDROM_IMAGE_PATH: '',

    HV_BOOT_ORDER: HT_BO_DISK,

    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,

    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,

    HV_USB_MOUSE: '',

    HV_MIGRATION_PORT: 8102,

    HV_MIGRATION_BANDWIDTH: 32, # MiB/s

    HV_MIGRATION_DOWNTIME: 30,  # ms

    HV_USE_LOCALTIME: False,

    HV_DISK_CACHE: HT_CACHE_DEFAULT,

    HV_SECURITY_MODEL: HT_SM_NONE,

    HV_SECURITY_DOMAIN: '',

    HV_KVM_FLAG: "",

    HV_VHOST_NET: False,

    HV_KVM_USE_CHROOT: False,

    },

  HT_FAKE: {

    },

  HT_CHROOT: {

    HV_INIT_SCRIPT: "/ganeti-chroot",

    },

  }

HVC_GLOBALS = frozenset([

  HV_MIGRATION_PORT,

  HV_MIGRATION_BANDWIDTH,

  ])

BEC_DEFAULTS = {

  BE_MEMORY: 128,

  BE_VCPUS: 1,

  BE_AUTO_BALANCE: True,

  }

NICC_DEFAULTS = {

  NIC_MODE: NIC_MODE_BRIDGED,

  NIC_LINK: DEFAULT_BRIDGE,

  }

MASTER_POOL_SIZE_DEFAULT = 10

CONFD_PROTOCOL_VERSION = 1

CONFD_REQ_PING = 0

CONFD_REQ_NODE_ROLE_BYNAME = 1

CONFD_REQ_NODE_PIP_BY_INSTANCE_IP = 2

CONFD_REQ_CLUSTER_MASTER = 3

CONFD_REQ_NODE_PIP_LIST = 4

CONFD_REQ_MC_PIP_LIST = 5

CONFD_REQ_INSTANCES_IPS_LIST = 6

# Confd request query fields. These are used to narrow down queries.

# These must be strings rather than integers, because json-encoding

# converts them to strings anyway, as they're used as dict-keys.

CONFD_REQQ_LINK = "0"

CONFD_REQQ_IP = "1"

CONFD_REQQ_IPLIST = "2"

CONFD_REQQ_FIELDS = "3"

CONFD_REQFIELD_NAME = "0"

CONFD_REQFIELD_IP = "1"

CONFD_REQFIELD_MNODE_PIP = "2"

CONFD_REQS = frozenset([

  CONFD_REQ_PING,

  CONFD_REQ_NODE_ROLE_BYNAME,

  CONFD_REQ_NODE_PIP_BY_INSTANCE_IP,

  CONFD_REQ_CLUSTER_MASTER,

  CONFD_REQ_NODE_PIP_LIST,

  CONFD_REQ_MC_PIP_LIST,

  CONFD_REQ_INSTANCES_IPS_LIST,

  ])

CONFD_REPL_STATUS_OK = 0

CONFD_REPL_STATUS_ERROR = 1

CONFD_REPL_STATUS_NOTIMPLEMENTED = 2

CONFD_REPL_STATUSES = frozenset([

  CONFD_REPL_STATUS_OK,

  CONFD_REPL_STATUS_ERROR,

  CONFD_REPL_STATUS_NOTIMPLEMENTED,

  ])

(CONFD_NODE_ROLE_MASTER,

 CONFD_NODE_ROLE_CANDIDATE,

 CONFD_NODE_ROLE_OFFLINE,

 CONFD_NODE_ROLE_DRAINED,

 CONFD_NODE_ROLE_REGULAR,

 ) = range(5)

# A few common errors for confd

CONFD_ERROR_UNKNOWN_ENTRY = 1

CONFD_ERROR_INTERNAL = 2

CONFD_ERROR_ARGUMENT = 3

# Each request is "salted" by the current timestamp.

# This constants decides how many seconds of skew to accept.

# TODO: make this a default and allow the value to be more configurable

CONFD_MAX_CLOCK_SKEW = 2 * NODE_MAX_CLOCK_SKEW

# When we haven't reloaded the config for more than this amount of seconds, we

# force a test to see if inotify is betraying us.

CONFD_CONFIG_RELOAD_TIMEOUT = 60

# If we receive more than one update in this amount of seconds, we move to

# polling every RATELIMIT seconds, rather than relying on inotify, to be able

# to serve more requests.

CONFD_CONFIG_RELOAD_RATELIMIT = 2

# Magic number prepended to all confd queries.

# This allows us to distinguish different types of confd protocols and handle

# them. For example by changing this we can move the whole payload to be

# compressed, or move away from json.

CONFD_MAGIC_FOURCC = 'plj0'

# By default a confd request is sent to the minimum between this number and all

# MCs. 6 was chosen because even in the case of a disastrous 50% response rate,

# we should have enough answers to be able to compare more than one.

CONFD_DEFAULT_REQ_COVERAGE = 6

# Timeout in seconds to expire pending query request in the confd client

# library. We don't actually expect any answer more than 10 seconds after we

# sent a request.

CONFD_CLIENT_EXPIRE_TIMEOUT = 10

# Maximum UDP datagram size.

# On IPv4: 64K - 20 (ip header size) - 8 (udp header size) = 65507

# On IPv6: 64K - 40 (ip6 header size) - 8 (udp header size) = 65487

#   (assuming we can't use jumbo frames)

# We just set this to 60K, which should be enough

MAX_UDP_DATA_SIZE = 61440

# User-id pool minimum/maximum acceptable user-ids.

UIDPOOL_UID_MIN = 0

UIDPOOL_UID_MAX = 2**32-1 # Assuming 32 bit user-ids

# Name or path of the pgrep command

PGREP = "pgrep"