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_AUTO = "auto"
 145 VALUE_GENERATE = "generate"
 146 VALUE_NONE = "none"
 147
 148 # hooks-related constants
 149 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
 150 HOOKS_PHASE_PRE = "pre"
 151 HOOKS_PHASE_POST = "post"
 152 HOOKS_NAME_CFGUPDATE = "config-update"
 153 HOOKS_VERSION = 1
 154
 155 # hooks subject type (what object type does the LU deal with)
 156 HTYPE_CLUSTER = "CLUSTER"
 157 HTYPE_NODE = "NODE"
 158 HTYPE_INSTANCE = "INSTANCE"
 159
 160 HKR_SKIP = 0
 161 HKR_FAIL = 1
 162 HKR_SUCCESS = 2
 163
 164 # disk template types
 165 DT_DISKLESS = "diskless"
 166 DT_PLAIN = "plain"
 167 DT_DRBD8 = "drbd"
 168 DT_FILE = "file"
 169
 170 # the set of network-mirrored disk templates
 171 DTS_NET_MIRROR = frozenset([DT_DRBD8])
 172
 173 # the set of non-lvm-based disk templates
 174 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
 175
 176 # logical disk types
 177 LD_LV = "lvm"
 178 LD_DRBD8 = "drbd8"
 179 LD_FILE = "file"
 180 LDS_BLOCK = frozenset([LD_LV, LD_DRBD8])
 181
 182 # drbd constants
 183 DRBD_HMAC_ALG = "md5"
 184 DRBD_NET_PROTOCOL = "C"
 185
 186 # file backend driver
 187 FD_LOOP = "loop"
 188 FD_BLKTAP = "blktap"
 189
 190 # the set of drbd-like disk types
 191 LDS_DRBD = frozenset([LD_DRBD8])
 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 # common exit codes
 216 EXIT_SUCCESS = 0
 217 EXIT_FAILURE = 1
 218 EXIT_NOTMASTER = 11
 219 EXIT_NODESETUP_ERROR = 12
 220 EXIT_CONFIRMATION = 13 # need user confirmation
 221
 222 # tags
 223 TAG_CLUSTER = "cluster"
 224 TAG_NODE = "node"
 225 TAG_INSTANCE = "instance"
 226 MAX_TAG_LEN = 128
 227 MAX_TAGS_PER_OBJ = 4096
 228
 229 # others
 230 DEFAULT_BRIDGE = "xen-br0"
 231 SYNC_SPEED = 30 * 1024
 232 LOCALHOST_IP_ADDRESS = "127.0.0.1"
 233 TCP_PING_TIMEOUT = 10
 234 GANETI_RUNAS = "root"
 235 DEFAULT_VG = "xenvg"
 236 BIND_ADDRESS_GLOBAL = "0.0.0.0"
 237 MIN_VG_SIZE = 20480
 238
 239 # os related constants
 240 OS_VALID_STATUS = "VALID"
 241 OS_SCRIPT_CREATE = 'create'
 242 OS_SCRIPT_IMPORT = 'import'
 243 OS_SCRIPT_EXPORT = 'export'
 244 OS_SCRIPT_RENAME = 'rename'
 245 OS_SCRIPTS = frozenset([OS_SCRIPT_CREATE, OS_SCRIPT_IMPORT,
 246                         OS_SCRIPT_EXPORT, OS_SCRIPT_RENAME])
 247
 248 # ssh constants
 249 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
 250 SSH_CONFIG_DIR = "/etc/ssh/"
 251 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
 252 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
 253 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
 254 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
 255 SSH = "ssh"
 256 SCP = "scp"
 257
 258 # reboot types
 259 INSTANCE_REBOOT_SOFT = "soft"
 260 INSTANCE_REBOOT_HARD = "hard"
 261 INSTANCE_REBOOT_FULL = "full"
 262
 263 # HV parameter names (global namespace)
 264 HV_BOOT_ORDER = "boot_order"
 265 HV_CDROM_IMAGE_PATH = "cdrom_image_path"
 266 HV_NIC_TYPE = "nic_type"
 267 HV_DISK_TYPE = "disk_type"
 268 HV_VNC_BIND_ADDRESS = "vnc_bind_address"
 269 HV_ACPI = "acpi"
 270 HV_PAE = "pae"
 271 HV_KERNEL_PATH = "kernel_path"
 272 HV_INITRD_PATH = "initrd_path"
 273
 274 HVS_PARAMETERS = frozenset([
 275   HV_BOOT_ORDER,
 276   HV_CDROM_IMAGE_PATH,
 277   HV_NIC_TYPE,
 278   HV_DISK_TYPE,
 279   HV_VNC_BIND_ADDRESS,
 280   HV_ACPI,
 281   HV_PAE,
 282   HV_KERNEL_PATH,
 283   HV_INITRD_PATH,
 284   ])
 285
 286 # BE parameter names
 287 BE_MEMORY = "memory"
 288 BE_VCPUS = "vcpus"
 289 BE_AUTO_BALANCE = "auto_balance"
 290
 291 BES_PARAMETERS = frozenset([
 292   BE_MEMORY,
 293   BE_VCPUS,
 294   BE_AUTO_BALANCE,
 295   ])
 296
 297 # BE GROUP
 298 BEGR_DEFAULT = "default"
 299
 300 # Hypervisor constants
 301 HT_XEN_PVM = "xen-pvm"
 302 HT_FAKE = "fake"
 303 HT_XEN_HVM = "xen-hvm"
 304 HT_KVM = "kvm"
 305 HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
 306 HTS_REQ_PORT = frozenset([HT_XEN_HVM])
 307
 308 HT_HVM_VNC_BASE_PORT = 5900
 309 HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
 310 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
 311 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
 312
 313 # HVM NIC types
 314 HT_HVM_NIC_RTL8139 = "rtl8139"
 315 HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
 316 HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
 317 HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
 318 HT_HVM_DEV_IOEMU = "ioemu"
 319 HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
 320                                     HT_HVM_NIC_NE2K_ISA,
 321                                     HT_HVM_DEV_PARAVIRTUAL])
 322 HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
 323
 324 # Cluster Verify steps
 325 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
 326 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
 327
 328 # Allocator framework constants
 329 IALLOCATOR_DIR_IN = "in"
 330 IALLOCATOR_DIR_OUT = "out"
 331 IALLOCATOR_MODE_ALLOC = "allocate"
 332 IALLOCATOR_MODE_RELOC = "relocate"
 333 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
 334 IARUN_NOTFOUND = 1
 335 IARUN_FAILURE = 2
 336 IARUN_SUCCESS = 3
 337
 338 # Job queue
 339 JOB_QUEUE_VERSION = 1
 340 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
 341 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
 342 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
 343 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
 344 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
 345
 346 JOB_ID_TEMPLATE = r"\d+"
 347
 348 # unchanged job return
 349 JOB_NOTCHANGED = "nochange"
 350
 351 # Job status
 352 JOB_STATUS_QUEUED = "queued"
 353 JOB_STATUS_WAITLOCK = "waiting"
 354 JOB_STATUS_RUNNING = "running"
 355 JOB_STATUS_CANCELED = "canceled"
 356 JOB_STATUS_SUCCESS = "success"
 357 JOB_STATUS_ERROR = "error"
 358
 359 OP_STATUS_QUEUED = "queued"
 360 OP_STATUS_WAITLOCK = "waiting"
 361 OP_STATUS_RUNNING = "running"
 362 OP_STATUS_CANCELED = "canceled"
 363 OP_STATUS_SUCCESS = "success"
 364 OP_STATUS_ERROR = "error"
 365
 366 # Execution log types
 367 ELOG_MESSAGE = "message"
 368 ELOG_PROGRESS = "progress"
 369
 370 # Temporary RAPI constants until we have cluster parameters
 371 RAPI_ENABLE = True
 372 RAPI_PORT = 5080
 373
 374 # cluster wide default parameters
 375 DEFAULT_ENABLED_HYPERVISOR = HT_XEN_PVM
 376
 377 HVC_DEFAULTS = {
 378     HT_XEN_PVM: {
 379         HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
 380         HV_INITRD_PATH: None,
 381         },
 382     HT_XEN_HVM: {
 383         HV_BOOT_ORDER: "cd",
 384         HV_CDROM_IMAGE_PATH: None,
 385         HV_NIC_TYPE: HT_HVM_NIC_RTL8139,
 386         HV_DISK_TYPE: HT_HVM_DEV_PARAVIRTUAL,
 387         HV_VNC_BIND_ADDRESS: '0.0.0.0',
 388         HV_ACPI: True,
 389         HV_PAE: True,
 390         },
 391     HT_KVM: {
 392         HV_KERNEL_PATH: "/boot/vmlinuz-2.6-xenU",
 393         HV_INITRD_PATH: None,
 394         HV_ACPI: True,
 395         },
 396     HT_FAKE: {
 397         },
 398     }
 399
 400 BEC_DEFAULTS = {
 401     BE_MEMORY: 128,
 402     BE_VCPUS: 1,
 403     BE_AUTO_BALANCE: True,
 404     }