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

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007 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 from ganeti import _autoconf
  25
  26 # various versions
  27 PROTOCOL_VERSION = 13
  28 RELEASE_VERSION = _autoconf.PACKAGE_VERSION
  29 OS_API_VERSION = 10
  30 EXPORT_VERSION = 0
  31 RAPI_VERSION = 2
  32
  33
  34 # Format for CONFIG_VERSION:
  35 #   01 03 0123 = 01030123
  36 #   ^^ ^^ ^^^^
  37 #   |  |  + Configuration version/revision
  38 #   |  + Minor version
  39 #   + Major version
  40 #
  41 # It stored as an integer. Make sure not to write an octal number.
  42
  43 # BuildVersion and SplitVersion must be in here because we can't import other
  44 # modules. The cfgupgrade tool must be able to read and write version numbers
  45 # and thus requires these functions. To avoid code duplication, they're kept in
  46 # here.
  47
  48 def BuildVersion(major, minor, revision):
  49   """Calculates int version number from major, minor and revision numbers.
  50
  51   Returns: int representing version number
  52
  53   """
  54   assert isinstance(major, int)
  55   assert isinstance(minor, int)
  56   assert isinstance(revision, int)
  57   return (1000000 * major +
  58             10000 * minor +
  59                 1 * revision)
  60
  61
  62 def SplitVersion(version):
  63   """Splits version number stored in an int.
  64
  65   Returns: tuple; (major, minor, revision)
  66
  67   """
  68   assert isinstance(version, int)
  69
  70   (major, remainder) = divmod(version, 1000000)
  71   (minor, revision) = divmod(remainder, 10000)
  72
  73   return (major, minor, revision)
  74
  75
  76 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
  77 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
  78 CONFIG_REVISION = 0
  79 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
  80
  81 # file paths
  82 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
  83 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
  84 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
  85 BDEV_CACHE_DIR = RUN_GANETI_DIR + "/bdev-cache"
  86 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
  87 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
  88 # daemon is started (this takes care of RUN_DIR being tmpfs)
  89 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
  90 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
  91 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
  92 SSL_CERT_FILE = DATA_DIR + "/server.pem"
  93 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
  94 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
  95 CLUSTER_PASSWORD_FILE = DATA_DIR + "/ssconf_node_pass"
  96 QUEUE_DIR = DATA_DIR + "/queue"
  97 ETC_HOSTS = "/etc/hosts"
  98 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
  99
 100 # Quoting unix(7) on Linux:
 101 #   Linux also supports an abstract namespace which is independent of the file
 102 #   system. [...] If sun_path starts with a null byte ('\0'), then it refers to
 103 #   the abstract namespace maintained by the Unix protocol module. The socket's
 104 #   address in this namespace is given by the rest of the bytes in sun_path.
 105 #
 106 # By using this Linux-specific way we don't have to care about removing the
 107 # socket file when quitting or starting (after an unclean shutdown).
 108 #
 109 # Sample output for "netstat -nlp":
 110 #   unix 2 [ ACC ] STREAM LISTENING 247919 1234/python @ganeti-master
 111 MASTER_SOCKET = "\0ganeti-master"
 112
 113 # PID files
 114 MASTERD_PID = "ganeti-masterd"
 115 NODED_PID = "ganeti-noded"
 116 RAPI_PID = "ganeti-rapi"
 117
 118 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
 119 DEFAULT_NODED_PORT = 1811
 120 FIRST_DRBD_PORT = 11000
 121 LAST_DRBD_PORT = 14999
 122 MASTER_SCRIPT = "ganeti-master"
 123
 124 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
 125 LOG_OS_DIR = LOG_DIR + "os"
 126 LOG_NODESERVER = LOG_DIR + "node-daemon.log"
 127 LOG_WATCHER = LOG_DIR + "watcher.log"
 128 LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
 129 LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
 130 LOG_COMMANDS = LOG_DIR + "commands.log"
 131 LOG_BURNIN = LOG_DIR + "burnin.log"
 132
 133 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
 134 EXPORT_DIR = _autoconf.EXPORT_DIR
 135
 136 EXPORT_CONF_FILE = "config.ini"
 137
 138 XEN_KERNEL = _autoconf.XEN_KERNEL
 139 XEN_INITRD = _autoconf.XEN_INITRD
 140
 141 KVM_PATH = _autoconf.KVM_PATH
 142
 143 VALUE_DEFAULT = "default"
 144 VALUE_NONE = "none"
 145
 146 # hooks-related constants
 147 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
 148 HOOKS_PHASE_PRE = "pre"
 149 HOOKS_PHASE_POST = "post"
 150 HOOKS_NAME_CFGUPDATE = "config-update"
 151 HOOKS_VERSION = 1
 152
 153 # hooks subject type (what object type does the LU deal with)
 154 HTYPE_CLUSTER = "CLUSTER"
 155 HTYPE_NODE = "NODE"
 156 HTYPE_INSTANCE = "INSTANCE"
 157
 158 HKR_SKIP = 0
 159 HKR_FAIL = 1
 160 HKR_SUCCESS = 2
 161
 162 # disk template types
 163 DT_DISKLESS = "diskless"
 164 DT_PLAIN = "plain"
 165 DT_DRBD8 = "drbd"
 166 DT_FILE = "file"
 167
 168 # the set of network-mirrored disk templates
 169 DTS_NET_MIRROR = frozenset([DT_DRBD8])
 170
 171 # the set of non-lvm-based disk templates
 172 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
 173
 174 # logical disk types
 175 LD_LV = "lvm"
 176 LD_DRBD8 = "drbd8"
 177 LD_FILE = "file"
 178 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
 179
 180 # drbd constants
 181 DRBD_HMAC_ALG = "md5"
 182 DRBD_NET_PROTOCOL = "C"
 183
 184 # file backend driver
 185 FD_LOOP = "loop"
 186 FD_BLKTAP = "blktap"
 187
 188 # the set of drbd-like disk types
 189 LDS_DRBD = frozenset([LD_DRBD8])
 190
 191 # disk replacement mode
 192 REPLACE_DISK_PRI = "replace_primary"
 193 REPLACE_DISK_SEC = "replace_secondary"
 194 REPLACE_DISK_ALL = "replace_all"
 195
 196 # lock recalculate mode
 197 LOCKS_REPLACE = 'replace'
 198 LOCKS_APPEND = 'append'
 199
 200 # instance creation modes
 201 INSTANCE_CREATE = "create"
 202 INSTANCE_IMPORT = "import"
 203
 204 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
 205                             DT_DRBD8, DT_FILE])
 206
 207 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
 208
 209 # import/export config options
 210 INISECT_EXP = "export"
 211 INISECT_INS = "instance"
 212
 213 # common exit codes
 214 EXIT_SUCCESS = 0
 215 EXIT_FAILURE = 1
 216 EXIT_NOTMASTER = 11
 217 EXIT_NODESETUP_ERROR = 12
 218 EXIT_CONFIRMATION = 13 # need user confirmation
 219
 220 # tags
 221 TAG_CLUSTER = "cluster"
 222 TAG_NODE = "node"
 223 TAG_INSTANCE = "instance"
 224 MAX_TAG_LEN = 128
 225 MAX_TAGS_PER_OBJ = 4096
 226
 227 # others
 228 DEFAULT_BRIDGE = "xen-br0"
 229 SYNC_SPEED = 30 * 1024
 230 LOCALHOST_IP_ADDRESS = "127.0.0.1"
 231 TCP_PING_TIMEOUT = 10
 232 GANETI_RUNAS = "root"
 233 DEFAULT_VG = "xenvg"
 234 BIND_ADDRESS_GLOBAL = "0.0.0.0"
 235 MIN_VG_SIZE = 20480
 236
 237 # os related constants
 238 OS_VALID_STATUS = "VALID"
 239 OS_SCRIPT_CREATE = 'create'
 240 OS_SCRIPT_IMPORT = 'import'
 241 OS_SCRIPT_EXPORT = 'export'
 242 OS_SCRIPT_RENAME = 'rename'
 243 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
 244                         OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
 245
 246 # ssh constants
 247 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
 248 SSH_CONFIG_DIR = "/etc/ssh/"
 249 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
 250 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
 251 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
 252 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
 253 SSH = "ssh"
 254 SCP = "scp"
 255
 256 # reboot types
 257 INSTANCE_REBOOT_SOFT = "soft"
 258 INSTANCE_REBOOT_HARD = "hard"
 259 INSTANCE_REBOOT_FULL = "full"
 260
 261 # HV parameter names (global namespace)
 262 HV_BOOT_ORDER = "boot_order"
 263 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
 264 HV_NIC_TYPE = "nic_type"
 265 HV_DISK_TYPE = "disk_type"
 266 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
 267 HV_ACPI = "acpi"
 268 HV_PAE = "pae"
 269 HV_KERNEL_PATH = "kernel_path"
 270 HV_INITRD_PATH = "initrd_path"
 271
 272 HVS_PARAMETERS = frozenset([
 273   HV_BOOT_ORDER,
 274   HV_CDROM_IMAGE_PATH,
 275   HV_NIC_TYPE,
 276   HV_DISK_TYPE,
 277   HV_VNC_BIND_ADDRESS,
 278   HV_ACPI,
 279   HV_PAE,
 280   HV_KERNEL_PATH,
 281   HV_INITRD_PATH,
 282   ])
 283
 284 # BE parameter names
 285 BE_MEMORY = "memory"
 286 BE_VCPUS = "vcpus"
 287 BE_AUTO_BALANCE = "auto_balance"
 288
 289 BES_PARAMETERS = frozenset([
 290   BE_MEMORY,
 291   BE_VCPUS,
 292   BE_AUTO_BALANCE,
 293   ])
 294
 295 # BE GROUP
 296 BEGR_DEFAULT = "default"
 297
 298 # Hypervisor constants
 299 HT_XEN_PVM = "xen-pvm"
 300 HT_FAKE = "fake"
 301 HT_XEN_HVM = "xen-hvm"
 302 HT_KVM = "kvm"
 303 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
 304 HTS_REQ_PORT = frozenset([HT_XEN_HVM])
 305
 306 HT_HVM_VNC_BASE_PORT = 5900
 307 HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
 308 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
 309 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
 310
 311 # HVM NIC types
 312 HT_HVM_NIC_RTL8139 = "rtl8139"
 313 HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
 314 HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
 315 HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
 316 HT_HVM_DEV_IOEMU = "ioemu"
 317 HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
 318                                     HT_HVM_NIC_NE2K_ISA,
 319                                     HT_HVM_DEV_PARAVIRTUAL])
 320 HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
 321
 322 # Cluster Verify steps
 323 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
 324 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
 325
 326 # Allocator framework constants
 327 IALLOCATOR_DIR_IN = "in"
 328 IALLOCATOR_DIR_OUT = "out"
 329 IALLOCATOR_MODE_ALLOC = "allocate"
 330 IALLOCATOR_MODE_RELOC = "relocate"
 331 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
 332 IARUN_NOTFOUND = 1
 333 IARUN_FAILURE = 2
 334 IARUN_SUCCESS = 3
 335
 336 # Job queue
 337 JOB_QUEUE_VERSION = 1
 338 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
 339 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
 340 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
 341 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
 342 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
 343
 344 JOB_ID_TEMPLATE = r"\d+"
 345
 346 # unchanged job return
 347 JOB_NOTCHANGED = "nochange"
 348
 349 # Job status
 350 JOB_STATUS_QUEUED = "queued"
 351 JOB_STATUS_WAITLOCK = "waiting"
 352 JOB_STATUS_RUNNING = "running"
 353 JOB_STATUS_CANCELED = "canceled"
 354 JOB_STATUS_SUCCESS = "success"
 355 JOB_STATUS_ERROR = "error"
 356
 357 OP_STATUS_QUEUED = "queued"
 358 OP_STATUS_WAITLOCK = "waiting"
 359 OP_STATUS_RUNNING = "running"
 360 OP_STATUS_CANCELED = "canceled"
 361 OP_STATUS_SUCCESS = "success"
 362 OP_STATUS_ERROR = "error"
 363
 364 # Execution log types
 365 ELOG_MESSAGE = "message"
 366 ELOG_PROGRESS = "progress"
 367
 368 # Temporary RAPI constants until we have cluster parameters
 369 RAPI_ENABLE = True
 370 RAPI_PORT = 5080