Synnefo » snf-ganeti » ganeti-local

#

#

# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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

import socket

from ganeti import _autoconf

from ganeti import _vcsversion

from ganeti import compat

from ganeti import pathutils

# various versions

RELEASE_VERSION = _autoconf.PACKAGE_VERSION

OS_API_V10 = 10

OS_API_V15 = 15

OS_API_V20 = 20

OS_API_VERSIONS = compat.UniqueFrozenset([

  OS_API_V10,

  OS_API_V15,

  OS_API_V20,

  ])

VCS_VERSION = _vcsversion.VCS_VERSION

EXPORT_VERSION = 0

RAPI_VERSION = 2

# Format for CONFIG_VERSION:

#   01 03 0123 = 01030123

#   ^^ ^^ ^^^^

#   |  |  + Configuration version/revision

#   |  + Minor version

#   + Major version

#

# It is 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)

#: RPC protocol version

PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)

# user separation

DAEMONS_GROUP = _autoconf.DAEMONS_GROUP

ADMIN_GROUP = _autoconf.ADMIN_GROUP

MASTERD_USER = _autoconf.MASTERD_USER

MASTERD_GROUP = _autoconf.MASTERD_GROUP

RAPI_USER = _autoconf.RAPI_USER

RAPI_GROUP = _autoconf.RAPI_GROUP

CONFD_USER = _autoconf.CONFD_USER

CONFD_GROUP = _autoconf.CONFD_GROUP

LUXID_USER = _autoconf.LUXID_USER

LUXID_GROUP = _autoconf.LUXID_GROUP

NODED_USER = _autoconf.NODED_USER

NODED_GROUP = _autoconf.NODED_GROUP

MOND_USER = _autoconf.MOND_USER

MOND_GROUP = _autoconf.MOND_GROUP

SSH_LOGIN_USER = _autoconf.SSH_LOGIN_USER

SSH_CONSOLE_USER = _autoconf.SSH_CONSOLE_USER

# cpu pinning separators and constants

CPU_PINNING_SEP = ":"

CPU_PINNING_ALL = "all"

# internal representation of "all"

CPU_PINNING_ALL_VAL = -1

# one "all" entry in a CPU list means CPU pinning is off

CPU_PINNING_OFF = [CPU_PINNING_ALL_VAL]

# A Xen-specific implementation detail - there is no way to actually say

# "use any cpu for pinning" in a Xen configuration file, as opposed to the

# command line, where you can say "xm vcpu-pin <domain> <vcpu> all".

# The workaround used in Xen is "0-63" (see source code function

# xm_vcpu_pin in <xen-source>/tools/python/xen/xm/main.py).

# To support future changes, the following constant is treated as a

# blackbox string that simply means use-any-cpu-for-pinning-under-xen.

CPU_PINNING_ALL_XEN = "0-63"

# A KVM-specific implementation detail - the following value is used

# to set CPU affinity to all processors (#0 through #31), per taskset

# man page.

# FIXME: This only works for machines with up to 32 CPU cores

CPU_PINNING_ALL_KVM = 0xFFFFFFFF

# Wipe

DD_CMD = "dd"

MAX_WIPE_CHUNK = 1024 # 1GB

MIN_WIPE_CHUNK_PERCENT = 10

RUN_DIRS_MODE = 0775

SECURE_DIR_MODE = 0700

SECURE_FILE_MODE = 0600

ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"

ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE

ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE

ENABLE_CONFD = _autoconf.ENABLE_CONFD

ENABLE_MOND = _autoconf.ENABLE_MOND

ENABLE_SPLIT_QUERY = _autoconf.ENABLE_SPLIT_QUERY

ENABLE_RESTRICTED_COMMANDS = _autoconf.ENABLE_RESTRICTED_COMMANDS

# SSH constants

SSH = "ssh"

SCP = "scp"

NODED = "ganeti-noded"

CONFD = "ganeti-confd"

LUXID = "ganeti-luxid"

RAPI = "ganeti-rapi"

MASTERD = "ganeti-masterd"

MOND = "ganeti-mond"

DAEMONS = compat.UniqueFrozenset([

  NODED,

  CONFD,

  LUXID,

  RAPI,

  MASTERD,

  MOND,

  ])

DAEMONS_PORTS = {

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

  NODED: ("tcp", 1811),

  CONFD: ("udp", 1814),

  MOND: ("tcp", 1815),

  RAPI: ("tcp", 5080),

  SSH: ("tcp", 22),

}

DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]

DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]

DEFAULT_MOND_PORT = DAEMONS_PORTS[MOND][1]

DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]

FIRST_DRBD_PORT = 11000

LAST_DRBD_PORT = 14999

DAEMONS_LOGBASE = {

  NODED: "node-daemon",

  CONFD: "conf-daemon",

  LUXID: "luxi-daemon",

  RAPI: "rapi-daemon",

  MASTERD: "master-daemon",

  MOND: "monitoring-daemon",

  }

DAEMONS_LOGFILES = \

    dict((daemon, pathutils.GetLogFilename(DAEMONS_LOGBASE[daemon]))

         for daemon in DAEMONS_LOGBASE)

# Some daemons might require more than one logfile.

# Specifically, right now only the Haskell http library "snap", used by the

# monitoring daemon, requires multiple log files.

# These are the only valid reasons for having an extra logfile

EXTRA_LOGREASON_ACCESS = "access"

EXTRA_LOGREASON_ERROR = "error"

VALID_EXTRA_LOGREASONS = compat.UniqueFrozenset([

  EXTRA_LOGREASON_ACCESS,

  EXTRA_LOGREASON_ERROR,

  ])

# These are the extra logfiles, grouped by daemon

DAEMONS_EXTRA_LOGBASE = {

  MOND: {

    EXTRA_LOGREASON_ACCESS: "monitoring-daemon-access",

    EXTRA_LOGREASON_ERROR: "monitoring-daemon-error",

    }

  }

DAEMONS_EXTRA_LOGFILES = \

  dict((daemon, dict((extra,

       pathutils.GetLogFilename(DAEMONS_EXTRA_LOGBASE[daemon][extra]))

       for extra in DAEMONS_EXTRA_LOGBASE[daemon]))

         for daemon in DAEMONS_EXTRA_LOGBASE)

DEV_CONSOLE = "/dev/console"

PROC_MOUNTS = "/proc/mounts"

# Local UniX Interface related constants

LUXI_EOM = "\3"

LUXI_VERSION = CONFIG_VERSION

#: Environment variable for the luxi override socket

LUXI_OVERRIDE = "FORCE_LUXI_SOCKET"

LUXI_OVERRIDE_MASTER = "master"

LUXI_OVERRIDE_QUERY = "query"

LUXI_SOCKET_PERMS = 0660

# one of "no", "yes", "only"

SYSLOG_USAGE = _autoconf.SYSLOG_USAGE

SYSLOG_NO = "no"

SYSLOG_YES = "yes"

SYSLOG_ONLY = "only"

SYSLOG_SOCKET = "/dev/log"

EXPORT_CONF_FILE = "config.ini"

XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER

XEN_KERNEL = _autoconf.XEN_KERNEL

XEN_INITRD = _autoconf.XEN_INITRD

XEN_CMD_XM = "xm"

XEN_CMD_XL = "xl"

# FIXME: This will be made configurable using hvparams in Ganeti 2.7

XEN_CMD = _autoconf.XEN_CMD

KNOWN_XEN_COMMANDS = compat.UniqueFrozenset([

  XEN_CMD_XM,

  XEN_CMD_XL,

  ])

# When the Xen toolstack used is "xl", live migration requires the source host

# to connect to the target host via ssh (xl runs this command). We need to pass

# the command xl runs some extra info so that it can use Ganeti's key

# verification and not fail. Note that this string is incomplete: it must be

# filled with the cluster name before being used.

XL_SSH_CMD = ("ssh -l %s -oGlobalKnownHostsFile=%s"

              " -oUserKnownHostsFile=/dev/null"

              " -oCheckHostIp=no -oStrictHostKeyChecking=yes"

              " -oHostKeyAlias=%%s") % (SSH_LOGIN_USER,

                                        pathutils.SSH_KNOWN_HOSTS_FILE)

KVM_PATH = _autoconf.KVM_PATH

KVM_KERNEL = _autoconf.KVM_KERNEL

SOCAT_PATH = _autoconf.SOCAT_PATH

SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE

SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS

SOCAT_ESCAPE_CODE = "0x1d"

#: Console as SSH command

CONS_SSH = "ssh"

#: Console as VNC server

CONS_VNC = "vnc"

#: Console as SPICE server

CONS_SPICE = "spice"

#: Display a message for console access

CONS_MESSAGE = "msg"

#: All console types

CONS_ALL = compat.UniqueFrozenset([

  CONS_SSH,

  CONS_VNC,

  CONS_SPICE,

  CONS_MESSAGE,

  ])

# 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 not to 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"

# Default validity of certificates in days

X509_CERT_DEFAULT_VALIDITY = 365 * 5

# commonName (CN) used in certificates

X509_CERT_CN = "ganeti.example.com"

X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

# Import/export daemon mode

IEM_IMPORT = "import"

IEM_EXPORT = "export"

# Import/export transport compression

IEC_NONE = "none"

IEC_GZIP = "gzip"

IEC_ALL = compat.UniqueFrozenset([

  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_PHASE_PRE = "pre"

HOOKS_PHASE_POST = "post"

HOOKS_NAME_CFGUPDATE = "config-update"

HOOKS_NAME_WATCHER = "watcher"

HOOKS_VERSION = 2

HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"

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

HTYPE_CLUSTER = "CLUSTER"

HTYPE_NODE = "NODE"

HTYPE_GROUP = "GROUP"

HTYPE_INSTANCE = "INSTANCE"

HTYPE_NETWORK = "NETWORK"

HKR_SKIP = 0

HKR_FAIL = 1

HKR_SUCCESS = 2

# Storage types

ST_BLOCK = "blockdev"

ST_DISKLESS = "diskless"

ST_EXT = "ext"

ST_FILE = "file"

ST_LVM_PV = "lvm-pv"

ST_LVM_VG = "lvm-vg"

ST_RADOS = "rados"

VALID_STORAGE_TYPES = compat.UniqueFrozenset([

  ST_BLOCK,

  ST_DISKLESS,

  ST_EXT,

  ST_FILE,

  ST_LVM_PV,

  ST_LVM_VG,

  ST_RADOS,

  ])

# 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 = compat.UniqueFrozenset([

  SF_NAME,

  SF_TYPE,

  SF_SIZE,

  SF_USED,

  SF_FREE,

  SF_ALLOCATABLE,

  ])

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_BLOCK = "blockdev"

DT_DISKLESS = "diskless"

DT_DRBD8 = "drbd"

DT_EXT = "ext"

DT_FILE = "file"

DT_PLAIN = "plain"

DT_RBD = "rbd"

DT_SHARED_FILE = "sharedfile"

# This is used to order determine the default disk template when the list

# of enabled disk templates is inferred from the current state of the cluster.

# This only happens on an upgrade from a version of Ganeti that did not

# support the 'enabled_disk_templates' so far.

DISK_TEMPLATE_PREFERENCE = [

  DT_DRBD8,

  DT_PLAIN,

  DT_FILE,

  DT_SHARED_FILE,

  DT_RBD,

  DT_BLOCK,

  DT_DISKLESS,

  DT_EXT

  ]

DISK_TEMPLATES = compat.UniqueFrozenset([

  DT_DISKLESS,

  DT_PLAIN,

  DT_DRBD8,

  DT_FILE,

  DT_SHARED_FILE,

  DT_BLOCK,

  DT_RBD,

  DT_EXT

  ])

# disk templates that are enabled by default

DEFAULT_ENABLED_DISK_TEMPLATES = compat.UniqueFrozenset([

  DT_DRBD8,

  DT_PLAIN,

  ])

# mapping of disk templates to storage types

DISK_TEMPLATES_STORAGE_TYPE = {

  DT_BLOCK: ST_BLOCK,

  DT_DISKLESS: ST_DISKLESS,

  DT_DRBD8: ST_LVM_VG,

  DT_EXT: ST_EXT,

  DT_FILE: ST_FILE,

  DT_PLAIN: ST_LVM_VG,

  DT_RBD: ST_RADOS,

  DT_SHARED_FILE: ST_FILE,

  }

# the set of network-mirrored disk templates

DTS_INT_MIRROR = compat.UniqueFrozenset([DT_DRBD8])

# the set of externally-mirrored disk templates (e.g. SAN, NAS)

DTS_EXT_MIRROR = compat.UniqueFrozenset([

  DT_DISKLESS, # 'trivially' externally mirrored

  DT_SHARED_FILE,

  DT_BLOCK,

  DT_RBD,

  DT_EXT,

  ])

# the set of non-lvm-based disk templates

DTS_NOT_LVM = compat.UniqueFrozenset([

  DT_DISKLESS,

  DT_FILE,

  DT_SHARED_FILE,

  DT_BLOCK,

  DT_RBD,

  DT_EXT,

  ])

# the set of disk templates which can be grown

DTS_GROWABLE = compat.UniqueFrozenset([

  DT_PLAIN,

  DT_DRBD8,

  DT_FILE,

  DT_SHARED_FILE,

  DT_RBD,

  DT_EXT,

  ])

# the set of disk templates that allow adoption

DTS_MAY_ADOPT = compat.UniqueFrozenset([

  DT_PLAIN,

  DT_BLOCK,

  ])

# the set of disk templates that *must* use adoption

DTS_MUST_ADOPT = compat.UniqueFrozenset([DT_BLOCK])

# the set of disk templates that allow migrations

DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)

# the set of file based disk templates

DTS_FILEBASED = compat.UniqueFrozenset([

  DT_FILE,

  DT_SHARED_FILE,

  ])

# the set of disk templates that can be moved by copying

# Note: a requirement is that they're not accessed externally or shared between

# nodes; in particular, sharedfile is not suitable.

DTS_COPYABLE = compat.UniqueFrozenset([

  DT_FILE,

  DT_PLAIN,

  ])

# the set of disk templates that are supported by exclusive_storage

DTS_EXCL_STORAGE = compat.UniqueFrozenset([DT_PLAIN])

# templates for which we don't perform checks on free space

DTS_NO_FREE_SPACE_CHECK = compat.UniqueFrozenset([

  DT_FILE,

  DT_SHARED_FILE,

  DT_RBD,

  DT_EXT,

  ])

# logical disk types

LD_LV = "lvm"

LD_DRBD8 = "drbd8"

LD_FILE = "file"

LD_BLOCKDEV = "blockdev"

LD_RBD = "rbd"

LD_EXT = "ext"

LOGICAL_DISK_TYPES = compat.UniqueFrozenset([

  LD_LV,

  LD_DRBD8,

  LD_FILE,

  LD_BLOCKDEV,

  LD_RBD,

  LD_EXT,

  ])

LDS_BLOCK = compat.UniqueFrozenset([

  LD_LV,

  LD_DRBD8,

  LD_BLOCKDEV,

  LD_RBD,

  LD_EXT,

  ])

# drbd constants

DRBD_HMAC_ALG = "md5"

DRBD_NET_PROTOCOL = "C"

DRBD_STATUS_FILE = "/proc/drbd"

#: Size of DRBD meta block device

DRBD_META_SIZE = 128

# drbd barrier types

DRBD_B_NONE = "n"

DRBD_B_DISK_BARRIERS = "b"

DRBD_B_DISK_DRAIN = "d"

DRBD_B_DISK_FLUSH = "f"

# Valid barrier combinations: "n" or any non-null subset of "bfd"

DRBD_VALID_BARRIER_OPT = compat.UniqueFrozenset([

  frozenset([DRBD_B_NONE]),

  frozenset([DRBD_B_DISK_BARRIERS]),

  frozenset([DRBD_B_DISK_DRAIN]),

  frozenset([DRBD_B_DISK_FLUSH]),

  frozenset([DRBD_B_DISK_DRAIN, DRBD_B_DISK_FLUSH]),

  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_DRAIN]),

  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH]),

  frozenset([DRBD_B_DISK_BARRIERS, DRBD_B_DISK_FLUSH, DRBD_B_DISK_DRAIN]),

  ])

# rbd tool command

RBD_CMD = "rbd"

# file backend driver

FD_LOOP = "loop"

FD_BLKTAP = "blktap"

FD_BLKTAP2 = "blktap2"

FD_DEFAULT = FD_LOOP

# the set of drbd-like disk types

LDS_DRBD = compat.UniqueFrozenset([LD_DRBD8])

# disk access mode

DISK_RDONLY = "ro"

DISK_RDWR = "rw"

DISK_ACCESS_SET = compat.UniqueFrozenset([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"

REPLACE_MODES = compat.UniqueFrozenset([

  REPLACE_DISK_PRI,

  REPLACE_DISK_SEC,

  REPLACE_DISK_CHG,

  REPLACE_DISK_AUTO,

  ])

# Instance export mode

EXPORT_MODE_LOCAL = "local"

EXPORT_MODE_REMOTE = "remote"

EXPORT_MODES = compat.UniqueFrozenset([

  EXPORT_MODE_LOCAL,

  EXPORT_MODE_REMOTE,

  ])

# instance creation modes

INSTANCE_CREATE = "create"

INSTANCE_IMPORT = "import"

INSTANCE_REMOTE_IMPORT = "remote-import"

INSTANCE_CREATE_MODES = compat.UniqueFrozenset([

  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

# Overall timeout for establishing connection

RIE_CONNECT_TIMEOUT = 180

# Export only: how long to wait per connection attempt (seconds)

RIE_CONNECT_ATTEMPT_TIMEOUT = 20

# Export only: number of attempts to connect

RIE_CONNECT_RETRIES = 10

#: Give child process up to 5 seconds to exit after sending a signal

CHILD_LINGER_TIMEOUT = 5.0

FILE_DRIVER = compat.UniqueFrozenset([FD_LOOP, FD_BLKTAP, FD_BLKTAP2])

# import/export config options

INISECT_EXP = "export"

INISECT_INS = "instance"

INISECT_HYP = "hypervisor"

INISECT_BEP = "backend"

INISECT_OSP = "os"

# dynamic device modification

DDM_ADD = "add"

DDM_MODIFY = "modify"

DDM_REMOVE = "remove"

DDMS_VALUES = compat.UniqueFrozenset([DDM_ADD, DDM_REMOVE])

DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([

  DDM_MODIFY,

  ]))

# TODO: DDM_SWAP, DDM_MOVE?

# device types to hotplug

HOTPLUG_TARGET_DISK = "hotdisk"

HOTPLUG_TARGET_NIC = "hotnic"

HOTPLUG_ALL_TARGETS = frozenset([

  HOTPLUG_TARGET_DISK,

  HOTPLUG_TARGET_NIC

  ])

# hotplug actions

HOTPLUG_ACTION_ADD = "hotadd"

HOTPLUG_ACTION_REMOVE = "hotremove"

HOTPLUG_ACTION_MODIFY = "hotmod"

HOTPLUG_ALL_ACTIONS = frozenset([

  HOTPLUG_ACTION_ADD,

  HOTPLUG_ACTION_REMOVE,

  HOTPLUG_ACTION_MODIFY

  ])

# 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

#: Exit code for query operations with unknown fields

EXIT_UNKNOWN_FIELD = 14

# tags

TAG_CLUSTER = "cluster"

TAG_NODEGROUP = "nodegroup"

TAG_NODE = "node"

TAG_INSTANCE = "instance"

TAG_NETWORK = "network"

VALID_TAG_TYPES = compat.UniqueFrozenset([

  TAG_CLUSTER,

  TAG_NODEGROUP,

  TAG_NODE,

  TAG_INSTANCE,

  TAG_NETWORK,

  ])

MAX_TAG_LEN = 128

MAX_TAGS_PER_OBJ = 4096

# others

DEFAULT_BRIDGE = "xen-br0"

CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB

IP4_ADDRESS_LOCALHOST = "127.0.0.1"

IP4_ADDRESS_ANY = "0.0.0.0"

IP6_ADDRESS_LOCALHOST = "::1"

IP6_ADDRESS_ANY = "::"

IP4_VERSION = 4

IP6_VERSION = 6

VALID_IP_VERSIONS = compat.UniqueFrozenset([IP4_VERSION, IP6_VERSION])

# for export to htools

IP4_FAMILY = socket.AF_INET

IP6_FAMILY = socket.AF_INET6

TCP_PING_TIMEOUT = 10

DEFAULT_VG = "xenvg"

DEFAULT_DRBD_HELPER = "/bin/true"

MIN_VG_SIZE = 20480

DEFAULT_MAC_PREFIX = "aa:00:00"

# 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 = 60

# Disk index separator

DISK_SEPARATOR = _autoconf.DISK_SEPARATOR

IP_COMMAND_PATH = _autoconf.IP_PATH

#: Key for job IDs in opcode result

JOB_IDS_KEY = "jobs"

# runparts results

(RUNPARTS_SKIP,

 RUNPARTS_RUN,

 RUNPARTS_ERR) = range(3)

RUNPARTS_STATUS = compat.UniqueFrozenset([

  RUNPARTS_SKIP,

  RUNPARTS_RUN,

  RUNPARTS_ERR,

  ])

# RPC constants

(RPC_ENCODING_NONE,

 RPC_ENCODING_ZLIB_BASE64) = range(2)

# Various time constants for the timeout table

RPC_TMO_URGENT = 60 # one minute

RPC_TMO_FAST = 5 * 60 # five minutes

RPC_TMO_NORMAL = 15 * 60 # 15 minutes

RPC_TMO_SLOW = 3600 # one hour

RPC_TMO_4HRS = 4 * 3600

RPC_TMO_1DAY = 86400

# Timeout for connecting to nodes (seconds)

RPC_CONNECT_TIMEOUT = 5

# 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 = compat.UniqueFrozenset([

  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"

OS_VALIDATE_CALLS = compat.UniqueFrozenset([OS_VALIDATE_PARAMETERS])

# External Storage (ES) related constants

ES_ACTION_CREATE = "create"

ES_ACTION_REMOVE = "remove"

ES_ACTION_GROW = "grow"

ES_ACTION_ATTACH = "attach"

ES_ACTION_DETACH = "detach"

ES_ACTION_SETINFO = "setinfo"

ES_ACTION_VERIFY = "verify"

ES_SCRIPT_CREATE = ES_ACTION_CREATE

ES_SCRIPT_REMOVE = ES_ACTION_REMOVE

ES_SCRIPT_GROW = ES_ACTION_GROW

ES_SCRIPT_ATTACH = ES_ACTION_ATTACH

ES_SCRIPT_DETACH = ES_ACTION_DETACH

ES_SCRIPT_SETINFO = ES_ACTION_SETINFO

ES_SCRIPT_VERIFY = ES_ACTION_VERIFY

ES_SCRIPTS = frozenset([

  ES_SCRIPT_CREATE,

  ES_SCRIPT_REMOVE,

  ES_SCRIPT_GROW,

  ES_SCRIPT_ATTACH,

  ES_SCRIPT_DETACH,

  ES_SCRIPT_SETINFO,

  ES_SCRIPT_VERIFY

  ])

ES_PARAMETERS_FILE = "parameters.list"

# reboot types

INSTANCE_REBOOT_SOFT = "soft"

INSTANCE_REBOOT_HARD = "hard"

INSTANCE_REBOOT_FULL = "full"

REBOOT_TYPES = compat.UniqueFrozenset([

  INSTANCE_REBOOT_SOFT,

  INSTANCE_REBOOT_HARD,

  INSTANCE_REBOOT_FULL,

  ])

# instance reboot behaviors

INSTANCE_REBOOT_ALLOWED = "reboot"

INSTANCE_REBOOT_EXIT = "exit"

REBOOT_BEHAVIORS = compat.UniqueFrozenset([

  INSTANCE_REBOOT_ALLOWED,

  INSTANCE_REBOOT_EXIT,

  ])

VTYPE_STRING = "string"

VTYPE_MAYBE_STRING = "maybe-string"

VTYPE_BOOL = "bool"

VTYPE_SIZE = "size" # size, in MiBs

VTYPE_INT = "int"

ENFORCEABLE_TYPES = compat.UniqueFrozenset([

  VTYPE_STRING,

  VTYPE_MAYBE_STRING,

  VTYPE_BOOL,

  VTYPE_SIZE,

  VTYPE_INT,

  ])

# Constant representing that the user does not specify any IP version

IFACE_NO_IP_VERSION_SPECIFIED = 0

VALID_SERIAL_SPEEDS = compat.UniqueFrozenset([

  75,

  110,

  300,

  600,

  1200,

  1800,

  2400,

  4800,

  9600,

  14400,

  19200,

  28800,

  38400,

  57600,

  115200,

  230400,

  345600,

  460800,

  ])

# HV parameter names (global namespace)

HV_BOOT_ORDER = "boot_order"

HV_CDROM_IMAGE_PATH = "cdrom_image_path"

HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"

HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"

HV_NIC_TYPE = "nic_type"

HV_DISK_TYPE = "disk_type"

HV_KVM_CDROM_DISK_TYPE = "cdrom_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_KVM_SPICE_BIND = "spice_bind"

HV_KVM_SPICE_IP_VERSION = "spice_ip_version"

HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"

HV_KVM_SPICE_LOSSLESS_IMG_COMPR = "spice_image_compression"

HV_KVM_SPICE_JPEG_IMG_COMPR = "spice_jpeg_wan_compression"

HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR = "spice_zlib_glz_wan_compression"

HV_KVM_SPICE_STREAMING_VIDEO_DETECTION = "spice_streaming_video"

HV_KVM_SPICE_AUDIO_COMPR = "spice_playback_compression"

HV_KVM_SPICE_USE_TLS = "spice_use_tls"

HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"

HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"

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_SERIAL_SPEED = "serial_speed"

HV_USB_MOUSE = "usb_mouse"

HV_KEYMAP = "keymap"

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_MIGRATION_MODE = "migration_mode"

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"

HV_CPU_MASK = "cpu_mask"

HV_MEM_PATH = "mem_path"

HV_PASSTHROUGH = "pci_pass"

HV_BLOCKDEV_PREFIX = "blockdev_prefix"

HV_REBOOT_BEHAVIOR = "reboot_behavior"

HV_CPU_TYPE = "cpu_type"

HV_CPU_CAP = "cpu_cap"

HV_CPU_WEIGHT = "cpu_weight"

HV_CPU_CORES = "cpu_cores"

HV_CPU_THREADS = "cpu_threads"

HV_CPU_SOCKETS = "cpu_sockets"

HV_SOUNDHW = "soundhw"

HV_USB_DEVICES = "usb_devices"

HV_VGA = "vga"

HV_KVM_EXTRA = "kvm_extra"

HV_KVM_MACHINE_VERSION = "machine_version"

HV_KVM_PATH = "kvm_path"

HV_VIF_TYPE = "vif_type"

HV_VNET_HDR = "vnet_hdr"

HV_VIRIDIAN = "viridian"

HV_VIF_SCRIPT = "vif_script"

HVS_PARAMETER_TYPES = {

  HV_KVM_PATH: VTYPE_STRING,

  HV_BOOT_ORDER: VTYPE_STRING,

  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,

  HV_CDROM_IMAGE_PATH: VTYPE_STRING,

  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,

  HV_NIC_TYPE: VTYPE_STRING,

  HV_DISK_TYPE: VTYPE_STRING,

  HV_KVM_CDROM_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_KVM_SPICE_BIND: VTYPE_STRING,

  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,

  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,

  HV_KVM_SPICE_LOSSLESS_IMG_COMPR: VTYPE_STRING,

  HV_KVM_SPICE_JPEG_IMG_COMPR: VTYPE_STRING,

  HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR: VTYPE_STRING,

  HV_KVM_SPICE_STREAMING_VIDEO_DETECTION: VTYPE_STRING,

  HV_KVM_SPICE_AUDIO_COMPR: VTYPE_BOOL,

  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,

  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,

  HV_KVM_SPICE_USE_VDAGENT: 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_MAYBE_STRING,

  HV_SERIAL_CONSOLE: VTYPE_BOOL,

  HV_SERIAL_SPEED: VTYPE_INT,

  HV_USB_MOUSE: VTYPE_STRING,

  HV_KEYMAP: 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_MIGRATION_MODE: VTYPE_STRING,

  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,

  HV_CPU_MASK: VTYPE_STRING,

  HV_MEM_PATH: VTYPE_STRING,

  HV_PASSTHROUGH: VTYPE_STRING,

  HV_BLOCKDEV_PREFIX: VTYPE_STRING,

  HV_REBOOT_BEHAVIOR: VTYPE_STRING,

  HV_CPU_TYPE: VTYPE_STRING,

  HV_CPU_CAP: VTYPE_INT,

  HV_CPU_WEIGHT: VTYPE_INT,

  HV_CPU_CORES: VTYPE_INT,

  HV_CPU_THREADS: VTYPE_INT,

  HV_CPU_SOCKETS: VTYPE_INT,

  HV_SOUNDHW: VTYPE_STRING,

  HV_USB_DEVICES: VTYPE_STRING,

  HV_VGA: VTYPE_STRING,

  HV_KVM_EXTRA: VTYPE_STRING,

  HV_KVM_MACHINE_VERSION: VTYPE_STRING,

  HV_VIF_TYPE: VTYPE_STRING,

  HV_VNET_HDR: VTYPE_BOOL,

  HV_VIRIDIAN: VTYPE_BOOL,

  HV_VIF_SCRIPT: VTYPE_STRING,

  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())

HVS_PARAMETER_TITLES = {

  HV_ACPI: "ACPI",

  HV_BOOT_ORDER: "Boot_order",

  HV_CDROM_IMAGE_PATH: "CDROM_image_path",

  HV_DISK_TYPE: "Disk_type",

  HV_INITRD_PATH: "Initrd_path",

  HV_KERNEL_PATH: "Kernel_path",

  HV_NIC_TYPE: "NIC_type",

  HV_PAE: "PAE",

  HV_VNC_BIND_ADDRESS: "VNC_bind_address",

  HV_PASSTHROUGH: "pci_pass",

  HV_CPU_TYPE: "cpu_type",

  }

# Migration statuses

HV_MIGRATION_COMPLETED = "completed"

HV_MIGRATION_ACTIVE = "active"

HV_MIGRATION_FAILED = "failed"

HV_MIGRATION_CANCELLED = "cancelled"

HV_MIGRATION_VALID_STATUSES = compat.UniqueFrozenset([

  HV_MIGRATION_COMPLETED,

  HV_MIGRATION_ACTIVE,

  HV_MIGRATION_FAILED,

  HV_MIGRATION_CANCELLED,

  ])

HV_MIGRATION_FAILED_STATUSES = compat.UniqueFrozenset([

  HV_MIGRATION_FAILED,

  HV_MIGRATION_CANCELLED,

  ])

# KVM-specific statuses

HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES

# Node info keys

HV_NODEINFO_KEY_VERSION = "hv_version"

# Hypervisor state

HVST_MEMORY_TOTAL = "mem_total"

HVST_MEMORY_NODE = "mem_node"

HVST_MEMORY_HV = "mem_hv"

HVST_CPU_TOTAL = "cpu_total"

HVST_CPU_NODE = "cpu_node"

HVST_DEFAULTS = {

  HVST_MEMORY_TOTAL: 0,

  HVST_MEMORY_NODE: 0,

  HVST_MEMORY_HV: 0,

  HVST_CPU_TOTAL: 1,

  HVST_CPU_NODE: 1,

  }

HVSTS_PARAMETER_TYPES = {

  HVST_MEMORY_TOTAL: VTYPE_INT,

  HVST_MEMORY_NODE: VTYPE_INT,

  HVST_MEMORY_HV: VTYPE_INT,

  HVST_CPU_TOTAL: VTYPE_INT,

  HVST_CPU_NODE: VTYPE_INT,

  }

HVSTS_PARAMETERS = frozenset(HVSTS_PARAMETER_TYPES.keys())

# Disk state

DS_DISK_TOTAL = "disk_total"

DS_DISK_RESERVED = "disk_reserved"

DS_DISK_OVERHEAD = "disk_overhead"

DS_DEFAULTS = {

  DS_DISK_TOTAL: 0,

  DS_DISK_RESERVED: 0,

  DS_DISK_OVERHEAD: 0,

  }

DSS_PARAMETER_TYPES = {

  DS_DISK_TOTAL: VTYPE_INT,

  DS_DISK_RESERVED: VTYPE_INT,

  DS_DISK_OVERHEAD: VTYPE_INT,

  }

DSS_PARAMETERS = frozenset(DSS_PARAMETER_TYPES.keys())

DS_VALID_TYPES = compat.UniqueFrozenset([LD_LV])

# Backend parameter names

BE_MEMORY = "memory" # deprecated and replaced by max and min mem

BE_MAXMEM = "maxmem"

BE_MINMEM = "minmem"

BE_VCPUS = "vcpus"

BE_AUTO_BALANCE = "auto_balance"

BE_ALWAYS_FAILOVER = "always_failover"

BE_SPINDLE_USE = "spindle_use"

BES_PARAMETER_TYPES = {

  BE_MAXMEM: VTYPE_SIZE,

  BE_MINMEM: VTYPE_SIZE,

  BE_VCPUS: VTYPE_INT,

  BE_AUTO_BALANCE: VTYPE_BOOL,

  BE_ALWAYS_FAILOVER: VTYPE_BOOL,

  BE_SPINDLE_USE: VTYPE_INT,

  }

BES_PARAMETER_TITLES = {

  BE_AUTO_BALANCE: "Auto_balance",

  BE_MAXMEM: "ConfigMaxMem",

  BE_MINMEM: "ConfigMinMem",

  BE_VCPUS: "ConfigVCPUs",

  }

BES_PARAMETER_COMPAT = {

  BE_MEMORY: VTYPE_SIZE,

  }

BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)

BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())

# instance specs

ISPEC_MEM_SIZE = "memory-size"

ISPEC_CPU_COUNT = "cpu-count"

ISPEC_DISK_COUNT = "disk-count"

ISPEC_DISK_SIZE = "disk-size"

ISPEC_NIC_COUNT = "nic-count"

ISPEC_SPINDLE_USE = "spindle-use"

ISPECS_PARAMETER_TYPES = {

  ISPEC_MEM_SIZE: VTYPE_INT,

  ISPEC_CPU_COUNT: VTYPE_INT,

  ISPEC_DISK_COUNT: VTYPE_INT,

  ISPEC_DISK_SIZE: VTYPE_INT,

  ISPEC_NIC_COUNT: VTYPE_INT,

  ISPEC_SPINDLE_USE: VTYPE_INT,

  }

ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())

ISPECS_MINMAX = "minmax"

ISPECS_MIN = "min"

ISPECS_MAX = "max"

ISPECS_STD = "std"

IPOLICY_DTS = "disk-templates"

IPOLICY_VCPU_RATIO = "vcpu-ratio"

IPOLICY_SPINDLE_RATIO = "spindle-ratio"

ISPECS_MINMAX_KEYS = compat.UniqueFrozenset([

  ISPECS_MIN,

  ISPECS_MAX,

  ])

IPOLICY_PARAMETERS = compat.UniqueFrozenset([

  IPOLICY_VCPU_RATIO,

  IPOLICY_SPINDLE_RATIO,

  ])

IPOLICY_ALL_KEYS = (IPOLICY_PARAMETERS |

                    frozenset([ISPECS_MINMAX, ISPECS_STD, IPOLICY_DTS]))

# Node parameter names

ND_OOB_PROGRAM = "oob_program"

ND_SPINDLE_COUNT = "spindle_count"

ND_EXCLUSIVE_STORAGE = "exclusive_storage"

NDS_PARAMETER_TYPES = {

  ND_OOB_PROGRAM: VTYPE_STRING,

  ND_SPINDLE_COUNT: VTYPE_INT,

  ND_EXCLUSIVE_STORAGE: VTYPE_BOOL,

  }

NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())

NDS_PARAMETER_TITLES = {

  ND_OOB_PROGRAM: "OutOfBandProgram",

  ND_SPINDLE_COUNT: "SpindleCount",

  ND_EXCLUSIVE_STORAGE: "ExclusiveStorage",