Update the iallocator documentation
[ganeti-local] / lib / constants.py
index 1236b79..a77544d 100644 (file)
 from ganeti import _autoconf
 
 # various versions
-PROTOCOL_VERSION = 12
+PROTOCOL_VERSION = 20
 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
-OS_API_VERSION = 5
+OS_API_VERSION = 10
 EXPORT_VERSION = 0
+RAPI_VERSION = 2
+
 
 # Format for CONFIG_VERSION:
 #   01 03 0123 = 01030123
@@ -37,27 +39,75 @@ EXPORT_VERSION = 0
 #   + 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 = (
-  1000000 * CONFIG_MAJOR +
-    10000 * CONFIG_MINOR +
-        1 * CONFIG_REVISION)
+CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
 
 # file paths
 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
-BDEV_CACHE_DIR = RUN_DIR + "/ganeti"
+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 = 0755
+SOCKET_DIR = RUN_GANETI_DIR + "/socket"
+SOCKET_DIR_MODE = 0700
+# 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"
 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
 SSL_CERT_FILE = DATA_DIR + "/server.pem"
+RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
+RAPI_USERS_FILE = DATA_DIR + "/rapi_users"
+QUEUE_DIR = DATA_DIR + "/queue"
 ETC_HOSTS = "/etc/hosts"
 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
-MASTER_SOCKET = RUN_DIR + "/master.sock"
+
+MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
+
+# PID files
+MASTERD_PID = "ganeti-masterd"
+NODED_PID = "ganeti-noded"
+RAPI_PID = "ganeti-rapi"
 
 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
 DEFAULT_NODED_PORT = 1811
@@ -65,11 +115,14 @@ FIRST_DRBD_PORT = 11000
 LAST_DRBD_PORT = 14999
 MASTER_SCRIPT = "ganeti-master"
 
-LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti"
-LOG_OS_DIR = LOG_DIR + "/os"
-LOG_NODESERVER = LOG_DIR + "/node-daemon.log"
-LOG_WATCHER = LOG_DIR + "/watcher.log"
-LOG_MASTERDAEMON = LOG_DIR + "/master-daemon.log"
+LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
+LOG_OS_DIR = LOG_DIR + "os"
+LOG_NODESERVER = LOG_DIR + "node-daemon.log"
+LOG_WATCHER = LOG_DIR + "watcher.log"
+LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
+LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
+LOG_COMMANDS = LOG_DIR + "commands.log"
+LOG_BURNIN = LOG_DIR + "burnin.log"
 
 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
 EXPORT_DIR = _autoconf.EXPORT_DIR
@@ -79,15 +132,23 @@ EXPORT_CONF_FILE = "config.ini"
 XEN_KERNEL = _autoconf.XEN_KERNEL
 XEN_INITRD = _autoconf.XEN_INITRD
 
+KVM_PATH = _autoconf.KVM_PATH
+SOCAT_PATH = _autoconf.SOCAT_PATH
+KVM_MIGRATION_PORT = _autoconf.KVM_MIGRATION_PORT
+
 VALUE_DEFAULT = "default"
+VALUE_AUTO = "auto"
+VALUE_GENERATE = "generate"
 VALUE_NONE = "none"
+VALUE_TRUE = "true"
+VALUE_FALSE = "false"
 
 # hooks-related constants
 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
 HOOKS_PHASE_PRE = "pre"
 HOOKS_PHASE_POST = "post"
 HOOKS_NAME_CFGUPDATE = "config-update"
-HOOKS_VERSION = 1
+HOOKS_VERSION = 2
 
 # hooks subject type (what object type does the LU deal with)
 HTYPE_CLUSTER = "CLUSTER"
@@ -114,6 +175,11 @@ DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
 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"
 
 # file backend driver
 FD_LOOP = "loop"
@@ -122,10 +188,19 @@ 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_primary"
-REPLACE_DISK_SEC = "replace_secondary"
-REPLACE_DISK_ALL = "replace_all"
+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
+
+# lock recalculate mode
+LOCKS_REPLACE = 'replace'
+LOCKS_APPEND = 'append'
 
 # instance creation modes
 INSTANCE_CREATE = "create"
@@ -140,8 +215,14 @@ FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
 INISECT_EXP = "export"
 INISECT_INS = "instance"
 
+# dynamic device modification
+
+DDM_ADD = 'add'
+DDM_REMOVE = 'remove'
+
 # common exit codes
 EXIT_SUCCESS = 0
+EXIT_FAILURE = 1
 EXIT_NOTMASTER = 11
 EXIT_NODESETUP_ERROR = 12
 EXIT_CONFIRMATION = 13 # need user confirmation
@@ -155,15 +236,27 @@ MAX_TAGS_PER_OBJ = 4096
 
 # others
 DEFAULT_BRIDGE = "xen-br0"
-SYNC_SPEED = 30 * 1024
+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"
+
+# RPC constants
+(RPC_ENCODING_NONE,
+ RPC_ENCODING_ZLIB_BASE64) = range(2)
 
-# valid os status
+# os related constants
 OS_VALID_STATUS = "VALID"
+OS_SCRIPT_CREATE = 'create'
+OS_SCRIPT_IMPORT = 'import'
+OS_SCRIPT_EXPORT = 'export'
+OS_SCRIPT_RENAME = 'rename'
+OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
+                        OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
 
 # ssh constants
 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
@@ -180,23 +273,136 @@ 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_TLS = "vnc_tls"
+HV_VNC_X509 = "vnc_x509_path"
+HV_VNC_X509_VERIFY = "vnc_x509_verify"
+HV_ACPI = "acpi"
+HV_PAE = "pae"
+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"
+
+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_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_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,
+  }
+
+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())
+
+# BE GROUP
+BEGR_DEFAULT = "default"
+
 # Hypervisor constants
-HT_XEN_PVM30 = "xen-3.0"
+HT_XEN_PVM = "xen-pvm"
 HT_FAKE = "fake"
-HT_XEN_HVM31 = "xen-hvm-3.1"
-HYPER_TYPES = frozenset([HT_XEN_PVM30, HT_FAKE, HT_XEN_HVM31])
-HTS_REQ_PORT = frozenset([HT_XEN_HVM31])
+HT_XEN_HVM = "xen-hvm"
+HT_KVM = "kvm"
+HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
+HTS_REQ_PORT = frozenset([HT_XEN_HVM, HT_KVM])
+HTS_COPY_VNC_PASSWORD = frozenset([HT_XEN_HVM])
 
-HT_HVM_VNC_BASE_PORT = 5900
-HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
+VNC_BASE_PORT = 5900
 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
 
+# Device 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_DISK_IOEMU = "ioemu"
+HT_DISK_IDE = "ide"
+HT_DISK_SCSI = "scsi"
+HT_DISK_SD = "sd"
+HT_DISK_MTD = "mtd"
+HT_DISK_PFLASH = "pflash"
+
+HT_HVM_VALID_NIC_TYPES = frozenset([HT_NIC_RTL8139, HT_NIC_NE2K_PCI,
+                                    HT_NIC_NE2K_ISA, HT_NIC_PARAVIRTUAL])
+HT_HVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IOEMU])
+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])
+HT_KVM_VALID_DISK_TYPES = frozenset([HT_DISK_PARAVIRTUAL, HT_DISK_IDE,
+                                     HT_DISK_SCSI, HT_DISK_SD, HT_DISK_MTD,
+                                     HT_DISK_PFLASH])
+
 # 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_LVLIST = "lvlist"
+NV_NODELIST = "nodelist"
+NV_NODENETTEST = "node-net-test"
+NV_VERSION = "version"
+NV_VGLIST = "vglist"
+NV_DRBDLIST = "drbd-list"
+
 # Allocator framework constants
+IALLOCATOR_VERSION = 2
 IALLOCATOR_DIR_IN = "in"
 IALLOCATOR_DIR_OUT = "out"
 IALLOCATOR_MODE_ALLOC = "allocate"
@@ -205,3 +411,108 @@ IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
 IARUN_NOTFOUND = 1
 IARUN_FAILURE = 2
 IARUN_SUCCESS = 3
+
+# 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_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
+
+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"
+
+OP_STATUS_QUEUED = "queued"
+OP_STATUS_WAITLOCK = "waiting"
+OP_STATUS_CANCELING = "canceling"
+OP_STATUS_RUNNING = "running"
+OP_STATUS_CANCELED = "canceled"
+OP_STATUS_SUCCESS = "success"
+OP_STATUS_ERROR = "error"
+
+# Execution log types
+ELOG_MESSAGE = "message"
+ELOG_PROGRESS = "progress"
+
+# Temporary RAPI constants until we have cluster parameters
+RAPI_ENABLE = True
+RAPI_PORT = 5080
+
+# max dynamic devices
+MAX_NICS = 8
+MAX_DISKS = 16
+
+# SSCONF keys
+SS_CLUSTER_NAME = "cluster_name"
+SS_FILE_STORAGE_DIR = "file_storage_dir"
+SS_MASTER_CANDIDATES = "master_candidates"
+SS_MASTER_IP = "master_ip"
+SS_MASTER_NETDEV = "master_netdev"
+SS_MASTER_NODE = "master_node"
+SS_NODE_LIST = "node_list"
+SS_OFFLINE_NODES = "offline_nodes"
+SS_ONLINE_NODES = "online_nodes"
+SS_INSTANCE_LIST = "instance_list"
+SS_RELEASE_VERSION = "release_version"
+
+# cluster wide default parameters
+DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
+
+HVC_DEFAULTS = {
+  HT_XEN_PVM: {
+    HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
+    HV_INITRD_PATH: '',
+    HV_ROOT_PATH: '/dev/sda1',
+    HV_KERNEL_ARGS: 'ro',
+    },
+  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_ACPI: True,
+    HV_PAE: True,
+    },
+  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_CDROM_IMAGE_PATH: '',
+    HV_BOOT_ORDER: "disk",
+    HV_NIC_TYPE: HT_NIC_PARAVIRTUAL,
+    HV_DISK_TYPE: HT_DISK_PARAVIRTUAL,
+    HV_USB_MOUSE: '',
+    },
+  HT_FAKE: {
+    },
+  }
+
+BEC_DEFAULTS = {
+  BE_MEMORY: 128,
+  BE_VCPUS: 1,
+  BE_AUTO_BALANCE: True,
+  }
+
+MASTER_POOL_SIZE_DEFAULT = 10