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 RUN_DIRS_MODE = 0755
  88 SOCKET_DIR = RUN_GANETI_DIR + "/socket"
  89 SOCKET_DIR_MODE = 0700
  90 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
  91 # daemon is started (this takes care of RUN_DIR being tmpfs)
  92 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
  93 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
  94 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
  95 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
  96 SSL_CERT_FILE = DATA_DIR + "/server.pem"
  97 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
  98 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
  99 QUEUE_DIR = DATA_DIR + "/queue"
 100 ETC_HOSTS = "/etc/hosts"
 101 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
 102
 103 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
 104
 105 # PID files
 106 MASTERD_PID = "ganeti-masterd"
 107 NODED_PID = "ganeti-noded"
 108 RAPI_PID = "ganeti-rapi"
 109
 110 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
 111 DEFAULT_NODED_PORT = 1811
 112 FIRST_DRBD_PORT = 11000
 113 LAST_DRBD_PORT = 14999
 114 MASTER_SCRIPT = "ganeti-master"
 115
 116 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti/"
 117 LOG_OS_DIR = LOG_DIR + "os"
 118 LOG_NODESERVER = LOG_DIR + "node-daemon.log"
 119 LOG_WATCHER = LOG_DIR + "watcher.log"
 120 LOG_MASTERDAEMON = LOG_DIR + "master-daemon.log"
 121 LOG_RAPISERVER = LOG_DIR + "rapi-daemon.log"
 122 LOG_COMMANDS = LOG_DIR + "commands.log"
 123 LOG_BURNIN = LOG_DIR + "burnin.log"
 124
 125 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
 126 EXPORT_DIR = _autoconf.EXPORT_DIR
 127
 128 EXPORT_CONF_FILE = "config.ini"
 129
 130 XEN_KERNEL = _autoconf.XEN_KERNEL
 131 XEN_INITRD = _autoconf.XEN_INITRD
 132
 133 KVM_PATH = _autoconf.KVM_PATH
 134 SOCAT_PATH = _autoconf.SOCAT_PATH
 135
 136 VALUE_DEFAULT = "default"
 137 VALUE_AUTO = "auto"
 138 VALUE_GENERATE = "generate"
 139 VALUE_NONE = "none"
 140 VALUE_TRUE = "true"
 141 VALUE_FALSE = "false"
 142
 143 # hooks-related constants
 144 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
 145 HOOKS_PHASE_PRE = "pre"
 146 HOOKS_PHASE_POST = "post"
 147 HOOKS_NAME_CFGUPDATE = "config-update"
 148 HOOKS_VERSION = 1
 149
 150 # hooks subject type (what object type does the LU deal with)
 151 HTYPE_CLUSTER = "CLUSTER"
 152 HTYPE_NODE = "NODE"
 153 HTYPE_INSTANCE = "INSTANCE"
 154
 155 HKR_SKIP = 0
 156 HKR_FAIL = 1
 157 HKR_SUCCESS = 2
 158
 159 # disk template types
 160 DT_DISKLESS = "diskless"
 161 DT_PLAIN = "plain"
 162 DT_DRBD8 = "drbd"
 163 DT_FILE = "file"
 164
 165 # the set of network-mirrored disk templates
 166 DTS_NET_MIRROR = frozenset([DT_DRBD8])
 167
 168 # the set of non-lvm-based disk templates
 169 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
 170
 171 # logical disk types
 172 LD_LV = "lvm"
 173 LD_DRBD8 = "drbd8"
 174 LD_FILE = "file"
 175 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
 176
 177 # drbd constants
 178 DRBD_HMAC_ALG = "md5"
 179 DRBD_NET_PROTOCOL = "C"
 180
 181 # file backend driver
 182 FD_LOOP = "loop"
 183 FD_BLKTAP = "blktap"
 184
 185 # the set of drbd-like disk types
 186 LDS_DRBD = frozenset([LD_DRBD8])
 187
 188 # disk access mode
 189 DISK_RDONLY = "ro"
 190 DISK_RDWR = "rw"
 191 DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])
 192
 193 # disk replacement mode
 194 REPLACE_DISK_PRI = "replace_primary"
 195 REPLACE_DISK_SEC = "replace_secondary"
 196 REPLACE_DISK_ALL = "replace_all"
 197
 198 # lock recalculate mode
 199 LOCKS_REPLACE = 'replace'
 200 LOCKS_APPEND = 'append'
 201
 202 # instance creation modes
 203 INSTANCE_CREATE = "create"
 204 INSTANCE_IMPORT = "import"
 205
 206 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
 207                             DT_DRBD8, DT_FILE])
 208
 209 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
 210
 211 # import/export config options
 212 INISECT_EXP = "export"
 213 INISECT_INS = "instance"
 214
 215 # dynamic device modification
 216
 217 DDM_ADD = 'add'
 218 DDM_REMOVE = 'remove'
 219
 220 # common exit codes
 221 EXIT_SUCCESS = 0
 222 EXIT_FAILURE = 1
 223 EXIT_NOTMASTER = 11
 224 EXIT_NODESETUP_ERROR = 12
 225 EXIT_CONFIRMATION = 13 # need user confirmation
 226
 227 # tags
 228 TAG_CLUSTER = "cluster"
 229 TAG_NODE = "node"
 230 TAG_INSTANCE = "instance"
 231 MAX_TAG_LEN = 128
 232 MAX_TAGS_PER_OBJ = 4096
 233
 234 # others
 235 DEFAULT_BRIDGE = "xen-br0"
 236 SYNC_SPEED = 30 * 1024
 237 LOCALHOST_IP_ADDRESS = "127.0.0.1"
 238 TCP_PING_TIMEOUT = 10
 239 GANETI_RUNAS = "root"
 240 DEFAULT_VG = "xenvg"
 241 BIND_ADDRESS_GLOBAL = "0.0.0.0"
 242 MIN_VG_SIZE = 20480
 243
 244 # RPC constants
 245 (RPC_ENCODING_NONE,
 246  RPC_ENCODING_ZLIB_BASE64) = range(2)
 247
 248 # os related constants
 249 OS_VALID_STATUS = "VALID"
 250 OS_SCRIPT_CREATE = 'create'
 251 OS_SCRIPT_IMPORT = 'import'
 252 OS_SCRIPT_EXPORT = 'export'
 253 OS_SCRIPT_RENAME = 'rename'
 254 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
 255                         OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
 256
 257 # ssh constants
 258 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
 259 SSH_CONFIG_DIR = "/etc/ssh/"
 260 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
 261 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
 262 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
 263 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
 264 SSH = "ssh"
 265 SCP = "scp"
 266
 267 # reboot types
 268 INSTANCE_REBOOT_SOFT = "soft"
 269 INSTANCE_REBOOT_HARD = "hard"
 270 INSTANCE_REBOOT_FULL = "full"
 271
 272 REBOOT_TYPES = frozenset([INSTANCE_REBOOT_SOFT,
 273                           INSTANCE_REBOOT_HARD,
 274                           INSTANCE_REBOOT_FULL])
 275
 276 # HV parameter names (global namespace)
 277 HV_BOOT_ORDER = "boot_order"
 278 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
 279 HV_NIC_TYPE = "nic_type"
 280 HV_DISK_TYPE = "disk_type"
 281 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
 282 HV_ACPI = "acpi"
 283 HV_PAE = "pae"
 284 HV_KERNEL_PATH = "kernel_path"
 285 HV_INITRD_PATH = "initrd_path"
 286
 287 HVS_PARAMETERS = frozenset([
 288   HV_BOOT_ORDER,
 289   HV_CDROM_IMAGE_PATH,
 290   HV_NIC_TYPE,
 291   HV_DISK_TYPE,
 292   HV_VNC_BIND_ADDRESS,
 293   HV_ACPI,
 294   HV_PAE,
 295   HV_KERNEL_PATH,
 296   HV_INITRD_PATH,
 297   ])
 298
 299 # BE parameter names
 300 BE_MEMORY = "memory"
 301 BE_VCPUS = "vcpus"
 302 BE_AUTO_BALANCE = "auto_balance"
 303
 304 BES_PARAMETERS = frozenset([
 305   BE_MEMORY,
 306   BE_VCPUS,
 307   BE_AUTO_BALANCE,
 308   ])
 309
 310 # BE GROUP
 311 BEGR_DEFAULT = "default"
 312
 313 # Hypervisor constants
 314 HT_XEN_PVM = "xen-pvm"
 315 HT_FAKE = "fake"
 316 HT_XEN_HVM = "xen-hvm"
 317 HT_KVM = "kvm"
 318 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
 319 HTS_REQ_PORT = frozenset([HT_XEN_HVM])
 320
 321 HT_HVM_VNC_BASE_PORT = 5900
 322 HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
 323 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
 324 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
 325
 326 # HVM NIC types
 327 HT_HVM_NIC_RTL8139 = "rtl8139"
 328 HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
 329 HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
 330 HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
 331 HT_HVM_DEV_IOEMU = "ioemu"
 332 HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
 333                                     HT_HVM_NIC_NE2K_ISA,
 334                                     HT_HVM_DEV_PARAVIRTUAL])
 335 HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
 336
 337 # Cluster Verify steps
 338 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
 339 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
 340
 341 # Node verify constants
 342 NV_FILELIST = "filelist"
 343 NV_HVINFO = "hvinfo"
 344 NV_HYPERVISOR = "hypervisor"
 345 NV_INSTANCELIST = "instancelist"
 346 NV_LVLIST = "lvlist"
 347 NV_NODELIST = "nodelist"
 348 NV_NODENETTEST = "node-net-test"
 349 NV_VERSION = "version"
 350 NV_VGLIST = "vglist"
 351
 352 # Allocator framework constants
 353 IALLOCATOR_DIR_IN = "in"
 354 IALLOCATOR_DIR_OUT = "out"
 355 IALLOCATOR_MODE_ALLOC = "allocate"
 356 IALLOCATOR_MODE_RELOC = "relocate"
 357 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
 358 IARUN_NOTFOUND = 1
 359 IARUN_FAILURE = 2
 360 IARUN_SUCCESS = 3
 361
 362 # Job queue
 363 JOB_QUEUE_VERSION = 1
 364 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
 365 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
 366 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
 367 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
 368 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
 369 JOB_QUEUE_SIZE_HARD_LIMIT = 5000
 370 JOB_QUEUE_SIZE_SOFT_LIMIT = JOB_QUEUE_SIZE_HARD_LIMIT * 0.8
 371
 372 JOB_ID_TEMPLATE = r"\d+"
 373
 374 # unchanged job return
 375 JOB_NOTCHANGED = "nochange"
 376
 377 # Job status
 378 JOB_STATUS_QUEUED = "queued"
 379 JOB_STATUS_WAITLOCK = "waiting"
 380 JOB_STATUS_CANCELING = "canceling"
 381 JOB_STATUS_RUNNING = "running"
 382 JOB_STATUS_CANCELED = "canceled"
 383 JOB_STATUS_SUCCESS = "success"
 384 JOB_STATUS_ERROR = "error"
 385
 386 OP_STATUS_QUEUED = "queued"
 387 OP_STATUS_WAITLOCK = "waiting"
 388 OP_STATUS_CANCELING = "canceling"
 389 OP_STATUS_RUNNING = "running"
 390 OP_STATUS_CANCELED = "canceled"
 391 OP_STATUS_SUCCESS = "success"
 392 OP_STATUS_ERROR = "error"
 393
 394 # Execution log types
 395 ELOG_MESSAGE = "message"
 396 ELOG_PROGRESS = "progress"
 397
 398 # Temporary RAPI constants until we have cluster parameters
 399 RAPI_ENABLE = True
 400 RAPI_PORT = 5080
 401
 402 # max dynamnic devices
 403 MAX_NICS = 8
 404 MAX_DISKS = 16
 405
 406 # SSCONF keys
 407 SS_CLUSTER_NAME = "cluster_name"
 408 SS_FILE_STORAGE_DIR = "file_storage_dir"
 409 SS_MASTER_CANDIDATES = "master_candidates"
 410 SS_MASTER_IP = "master_ip"
 411 SS_MASTER_NETDEV = "master_netdev"
 412 SS_MASTER_NODE = "master_node"
 413 SS_NODE_LIST = "node_list"
 414 SS_OFFLINE_NODES = "offline_nodes"
 415
 416 # cluster wide default parameters
 417 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
 418
 419 HVC_DEFAULTS = {
 420     HT_XEN_PVM: {
 421         HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
 422         HV_INITRD_PATH: None,
 423         },
 424     HT_XEN_HVM: {
 425         HV_BOOT_ORDER: "cd",
 426         HV_CDROM_IMAGE_PATH: None,
 427         HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
 428         HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
 429         HV_VNC_BIND_ADDRESS: '0.0.0.0',
 430         HV_ACPI: True,
 431         HV_PAE: True,
 432         },
 433     HT_KVM: {
 434         HV_KERNEL_PATH: "/boot/vmlinuz-2.6-kvmU",
 435         HV_INITRD_PATH: None,
 436         HV_ACPI: True,
 437         },
 438     HT_FAKE: {
 439         },
 440     }
 441
 442 BEC_DEFAULTS = {
 443     BE_MEMORY: 128,
 444     BE_VCPUS: 1,
 445     BE_AUTO_BALANCE: True,
 446     }
 447
 448 MASTER_POOL_SIZE_DEFAULT = 10