constants.py 52.5 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2 3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
#
# 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."""

24
import re
25
import socket
26

27
from ganeti import _autoconf
28
from ganeti import _vcsversion
29 30
from ganeti.pathutils import * # pylint: disable=W0401,W0614

31

Iustin Pop's avatar
Iustin Pop committed
32
# various versions
33
RELEASE_VERSION = _autoconf.PACKAGE_VERSION
Guido Trotter's avatar
Guido Trotter committed
34 35
OS_API_V10 = 10
OS_API_V15 = 15
36 37
OS_API_V20 = 20
OS_API_VERSIONS = frozenset([OS_API_V10, OS_API_V15, OS_API_V20])
38
VCS_VERSION = _vcsversion.VCS_VERSION
Iustin Pop's avatar
Iustin Pop committed
39
EXPORT_VERSION = 0
40
RAPI_VERSION = 2
Iustin Pop's avatar
Iustin Pop committed
41

42

43 44 45 46 47 48 49
# Format for CONFIG_VERSION:
#   01 03 0123 = 01030123
#   ^^ ^^ ^^^^
#   |  |  + Configuration version/revision
#   |  + Minor version
#   + Major version
#
50
# It is stored as an integer. Make sure not to write an octal number.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

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


85 86 87
CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
CONFIG_REVISION = 0
88
CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
Iustin Pop's avatar
Iustin Pop committed
89

90 91 92
#: RPC protocol version
PROTOCOL_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, 0)

93 94
# user separation
DAEMONS_GROUP = _autoconf.DAEMONS_GROUP
95
ADMIN_GROUP = _autoconf.ADMIN_GROUP
96
MASTERD_USER = _autoconf.MASTERD_USER
97
MASTERD_GROUP = _autoconf.MASTERD_GROUP
98
RAPI_USER = _autoconf.RAPI_USER
99 100 101 102
RAPI_GROUP = _autoconf.RAPI_GROUP
CONFD_USER = _autoconf.CONFD_USER
CONFD_GROUP = _autoconf.CONFD_GROUP
NODED_USER = _autoconf.NODED_USER
René Nussbaumer's avatar
René Nussbaumer committed
103
NODED_GROUP = _autoconf.NODED_GROUP
104

Tsachy Shacham's avatar
Tsachy Shacham committed
105 106 107 108 109
# cpu pinning separators and constants
CPU_PINNING_SEP = ":"
CPU_PINNING_ALL = "all"
# internal representation of "all"
CPU_PINNING_ALL_VAL = -1
110 111
# one "all" entry in a CPU list means CPU pinning is off
CPU_PINNING_OFF = [CPU_PINNING_ALL_VAL]
Tsachy Shacham's avatar
Tsachy Shacham committed
112 113 114 115 116 117 118 119 120

# 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"
121

122 123 124
# A KVM-specific implementation detail - the following value is used
# to set CPU affinity to all processors (#0 through #31), per taskset
# man page.
125
# FIXME: This only works for machines with up to 32 CPU cores
126 127
CPU_PINNING_ALL_KVM = 0xFFFFFFFF

128
# Wipe
129
DD_CMD = "dd"
Michael Hanselmann's avatar
Michael Hanselmann committed
130
WIPE_BLOCK_SIZE = 1024 ** 2
131 132 133
MAX_WIPE_CHUNK = 1024 # 1GB
MIN_WIPE_CHUNK_PERCENT = 10

134
RUN_DIRS_MODE = 0775
135
SECURE_DIR_MODE = 0700
136
SECURE_FILE_MODE = 0600
137
ADOPTABLE_BLOCKDEV_ROOT = "/dev/disk/"
138
ETC_HOSTS = "/etc/hosts"
139
ENABLE_FILE_STORAGE = _autoconf.ENABLE_FILE_STORAGE
140
ENABLE_SHARED_FILE_STORAGE = _autoconf.ENABLE_SHARED_FILE_STORAGE
141
ENABLE_CONFD = _autoconf.ENABLE_CONFD
142
HS_CONFD = _autoconf.HS_CONFD
143
ENABLE_SPLIT_QUERY = _autoconf.ENABLE_SPLIT_QUERY
144

145
NODED = "ganeti-noded"
Guido Trotter's avatar
Guido Trotter committed
146
CONFD = "ganeti-confd"
Guido Trotter's avatar
Guido Trotter committed
147
RAPI = "ganeti-rapi"
148
MASTERD = "ganeti-masterd"
Guido Trotter's avatar
Guido Trotter committed
149 150
# used in the ganeti-nbma project
NLD = "ganeti-nld"
151 152 153 154

DAEMONS_PORTS = {
  # daemon-name: ("proto", "default-port")
  NODED: ("tcp", 1811),
Guido Trotter's avatar
Guido Trotter committed
155
  CONFD: ("udp", 1814),
Guido Trotter's avatar
Guido Trotter committed
156
  RAPI: ("tcp", 5080),
157
  "ssh": ("tcp", 22),
Guido Trotter's avatar
Guido Trotter committed
158 159
  # used in the ganeti-nbma project
  NLD: ("udp", 1816),
160 161
}
DEFAULT_NODED_PORT = DAEMONS_PORTS[NODED][1]
Guido Trotter's avatar
Guido Trotter committed
162
DEFAULT_CONFD_PORT = DAEMONS_PORTS[CONFD][1]
Guido Trotter's avatar
Guido Trotter committed
163
DEFAULT_RAPI_PORT = DAEMONS_PORTS[RAPI][1]
Guido Trotter's avatar
Guido Trotter committed
164 165
# used in the ganeti-nbma project
DEFAULT_NLD_PORT = DAEMONS_PORTS[NLD][1]
166

Iustin Pop's avatar
Iustin Pop committed
167 168 169
FIRST_DRBD_PORT = 11000
LAST_DRBD_PORT = 14999

Luca Bigliardi's avatar
Luca Bigliardi committed
170 171
DEV_CONSOLE = "/dev/console"

Balazs Lecz's avatar
Balazs Lecz committed
172 173
PROC_MOUNTS = "/proc/mounts"

174
# Local UniX Interface related constants
175
LUXI_EOM = "\3"
176
LUXI_VERSION = CONFIG_VERSION
177

Iustin Pop's avatar
Iustin Pop committed
178
# one of "no", "yes", "only"
179 180 181 182 183 184
SYSLOG_USAGE = _autoconf.SYSLOG_USAGE
SYSLOG_NO = "no"
SYSLOG_YES = "yes"
SYSLOG_ONLY = "only"
SYSLOG_SOCKET = "/dev/log"

Iustin Pop's avatar
Iustin Pop committed
185 186
EXPORT_CONF_FILE = "config.ini"

187
XEN_BOOTLOADER = _autoconf.XEN_BOOTLOADER
188 189
XEN_KERNEL = _autoconf.XEN_KERNEL
XEN_INITRD = _autoconf.XEN_INITRD
190 191 192 193
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
194

195
KVM_PATH = _autoconf.KVM_PATH
196
KVM_KERNEL = _autoconf.KVM_KERNEL
Guido Trotter's avatar
Guido Trotter committed
197
SOCAT_PATH = _autoconf.SOCAT_PATH
198
SOCAT_USE_ESCAPE = _autoconf.SOCAT_USE_ESCAPE
199
SOCAT_USE_COMPRESS = _autoconf.SOCAT_USE_COMPRESS
200
SOCAT_ESCAPE_CODE = "0x1d"
201

202 203 204 205 206 207
#: Console as SSH command
CONS_SSH = "ssh"

#: Console as VNC server
CONS_VNC = "vnc"

208 209 210
#: Console as SPICE server
CONS_SPICE = "spice"

211 212 213 214
#: Display a message for console access
CONS_MESSAGE = "msg"

#: All console types
215
CONS_ALL = frozenset([CONS_SSH, CONS_VNC, CONS_SPICE, CONS_MESSAGE])
216

217 218 219 220 221
# 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

222 223 224
# 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
225
# modifying the ciphers, ensure not to accidentially add something after it's
226 227 228 229
# 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"

230 231 232
# Digest used to sign certificates ("openssl x509" uses SHA1 by default)
X509_CERT_SIGN_DIGEST = "SHA1"

233 234 235 236 237 238
# Default validity of certificates in days
X509_CERT_DEFAULT_VALIDITY = 365 * 5

# commonName (CN) used in certificates
X509_CERT_CN = "ganeti.example.com"

239 240
X509_CERT_SIGNATURE_HEADER = "X-Ganeti-Signature"

241 242 243 244
# Import/export daemon mode
IEM_IMPORT = "import"
IEM_EXPORT = "export"

245 246 247 248 249 250 251 252
# Import/export transport compression
IEC_NONE = "none"
IEC_GZIP = "gzip"
IEC_ALL = frozenset([
  IEC_NONE,
  IEC_GZIP,
  ])

253 254
IE_CUSTOM_SIZE = "fd"

255 256
IE_MAGIC_RE = re.compile(r"^[-_.a-zA-Z0-9]{5,100}$")

257 258 259 260 261 262 263 264
# 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"

265
VALUE_DEFAULT = "default"
266 267
VALUE_AUTO = "auto"
VALUE_GENERATE = "generate"
268
VALUE_NONE = "none"
269 270
VALUE_TRUE = "true"
VALUE_FALSE = "false"
271

272 273 274
# External script validation mask
EXT_PLUGIN_MASK = re.compile("^[a-zA-Z0-9_-]+$")

Iustin Pop's avatar
Iustin Pop committed
275 276 277
# hooks-related constants
HOOKS_PHASE_PRE = "pre"
HOOKS_PHASE_POST = "post"
278
HOOKS_NAME_CFGUPDATE = "config-update"
Guido Trotter's avatar
Guido Trotter committed
279
HOOKS_NAME_WATCHER = "watcher"
280
HOOKS_VERSION = 2
281
HOOKS_PATH = "/sbin:/bin:/usr/sbin:/usr/bin"
Iustin Pop's avatar
Iustin Pop committed
282 283 284 285

# hooks subject type (what object type does the LU deal with)
HTYPE_CLUSTER = "CLUSTER"
HTYPE_NODE = "NODE"
286
HTYPE_GROUP = "GROUP"
Iustin Pop's avatar
Iustin Pop committed
287 288 289 290 291 292
HTYPE_INSTANCE = "INSTANCE"

HKR_SKIP = 0
HKR_FAIL = 1
HKR_SUCCESS = 2

293 294 295 296
# Storage types
ST_FILE = "file"
ST_LVM_PV = "lvm-pv"
ST_LVM_VG = "lvm-vg"
297 298

# Storage fields
299 300 301 302
# 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
303 304 305 306 307 308
SF_NAME = "name"
SF_SIZE = "size"
SF_FREE = "free"
SF_USED = "used"
SF_ALLOCATABLE = "allocatable"

309 310 311
# Storage operations
SO_FIX_CONSISTENCY = "fix-consistency"

312
# Available fields per storage type
Stephen Shirley's avatar
Stephen Shirley committed
313 314 315 316 317 318 319 320
VALID_STORAGE_FIELDS = frozenset([
  SF_NAME,
  SF_TYPE,
  SF_SIZE,
  SF_USED,
  SF_FREE,
  SF_ALLOCATABLE
  ])
321 322

VALID_STORAGE_TYPES = frozenset([ST_FILE, ST_LVM_PV, ST_LVM_VG])
Iustin Pop's avatar
Iustin Pop committed
323

324 325 326 327
MODIFIABLE_STORAGE_FIELDS = {
  ST_LVM_PV: frozenset([SF_ALLOCATABLE]),
  }

328
VALID_STORAGE_OPERATIONS = {
329
  ST_LVM_VG: frozenset([SO_FIX_CONSISTENCY]),
330 331
  }

332 333 334 335 336 337
# Local disk status
# Note: Code depends on LDS_OKAY < LDS_UNKNOWN < LDS_FAULTY
(LDS_OKAY,
 LDS_UNKNOWN,
 LDS_FAULTY) = range(1, 4)

Iustin Pop's avatar
Iustin Pop committed
338 339 340
# disk template types
DT_DISKLESS = "diskless"
DT_PLAIN = "plain"
341
DT_DRBD8 = "drbd"
342
DT_FILE = "file"
343
DT_SHARED_FILE = "sharedfile"
344
DT_BLOCK = "blockdev"
345
DT_RBD = "rbd"
346 347

# the set of network-mirrored disk templates
348
DTS_INT_MIRROR = frozenset([DT_DRBD8])
Iustin Pop's avatar
Iustin Pop committed
349

350
# the set of externally-mirrored disk templates (e.g. SAN, NAS)
351
DTS_EXT_MIRROR = frozenset([DT_SHARED_FILE, DT_BLOCK, DT_RBD])
352

353
# the set of non-lvm-based disk templates
354 355
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE, DT_SHARED_FILE,
                         DT_BLOCK, DT_RBD])
356

357
# the set of disk templates which can be grown
358
DTS_GROWABLE = frozenset([DT_PLAIN, DT_DRBD8, DT_FILE, DT_SHARED_FILE, DT_RBD])
359

360
# the set of disk templates that allow adoption
361 362 363 364
DTS_MAY_ADOPT = frozenset([DT_PLAIN, DT_BLOCK])

# the set of disk templates that *must* use adoption
DTS_MUST_ADOPT = frozenset([DT_BLOCK])
365

366
# the set of disk templates that allow migrations
367
DTS_MIRRORED = frozenset.union(DTS_INT_MIRROR, DTS_EXT_MIRROR)
368

Guido Trotter's avatar
Guido Trotter committed
369 370
# the set of file based disk templates
DTS_FILEBASED = frozenset([DT_FILE, DT_SHARED_FILE])
371

372 373
# logical disk types
LD_LV = "lvm"
374
LD_DRBD8 = "drbd8"
375
LD_FILE = "file"
376
LD_BLOCKDEV = "blockdev"
377
LD_RBD = "rbd"
378 379 380 381 382
LOGICAL_DISK_TYPES = frozenset([
  LD_LV,
  LD_DRBD8,
  LD_FILE,
  LD_BLOCKDEV,
383
  LD_RBD,
384 385
  ])

386
LDS_BLOCK = frozenset([LD_LV, LD_DRBD8, LD_BLOCKDEV, LD_RBD])
387

Iustin Pop's avatar
Iustin Pop committed
388 389
# drbd constants
DRBD_HMAC_ALG = "md5"
390
DRBD_NET_PROTOCOL = "C"
391

392 393 394
#: Size of DRBD meta block device
DRBD_META_SIZE = 128

395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
# 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 = frozenset([
  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_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]),
  ])
Iustin Pop's avatar
Iustin Pop committed
413

414 415 416
# rbd tool command
RBD_CMD = "rbd"

417 418 419
# file backend driver
FD_LOOP = "loop"
FD_BLKTAP = "blktap"
420 421

# the set of drbd-like disk types
422
LDS_DRBD = frozenset([LD_DRBD8])
423

424
# disk access mode
425 426
DISK_RDONLY = "ro"
DISK_RDWR = "rw"
427 428
DISK_ACCESS_SET = frozenset([DISK_RDONLY, DISK_RDWR])

429
# disk replacement mode
430 431 432
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
433
REPLACE_DISK_AUTO = "replace_auto"
434 435 436 437 438 439
REPLACE_MODES = frozenset([
  REPLACE_DISK_PRI,
  REPLACE_DISK_SEC,
  REPLACE_DISK_CHG,
  REPLACE_DISK_AUTO,
  ])
440

441 442 443 444 445 446 447 448
# Instance export mode
EXPORT_MODE_LOCAL = "local"
EXPORT_MODE_REMOTE = "remote"
EXPORT_MODES = frozenset([
  EXPORT_MODE_LOCAL,
  EXPORT_MODE_REMOTE,
  ])

449
# instance creation modes
Iustin Pop's avatar
Iustin Pop committed
450 451
INSTANCE_CREATE = "create"
INSTANCE_IMPORT = "import"
452 453 454 455 456 457
INSTANCE_REMOTE_IMPORT = "remote-import"
INSTANCE_CREATE_MODES = frozenset([
  INSTANCE_CREATE,
  INSTANCE_IMPORT,
  INSTANCE_REMOTE_IMPORT,
  ])
Iustin Pop's avatar
Iustin Pop committed
458

459 460 461 462 463 464 465
# 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

466
# Overall timeout for establishing connection
467
RIE_CONNECT_TIMEOUT = 180
468

469 470 471 472 473 474
# 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

René Nussbaumer's avatar
René Nussbaumer committed
475 476
#: Give child process up to 5 seconds to exit after sending a signal
CHILD_LINGER_TIMEOUT = 5.0
477

Stephen Shirley's avatar
Stephen Shirley committed
478 479 480 481 482 483
DISK_TEMPLATES = frozenset([
  DT_DISKLESS,
  DT_PLAIN,
  DT_DRBD8,
  DT_FILE,
  DT_SHARED_FILE,
484 485
  DT_BLOCK,
  DT_RBD
Stephen Shirley's avatar
Stephen Shirley committed
486
  ])
487 488

FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
Iustin Pop's avatar
Iustin Pop committed
489 490 491 492

# import/export config options
INISECT_EXP = "export"
INISECT_INS = "instance"
493 494
INISECT_HYP = "hypervisor"
INISECT_BEP = "backend"
495
INISECT_OSP = "os"
496

497
# dynamic device modification
498
DDM_ADD = "add"
499
DDM_MODIFY = "modify"
500 501
DDM_REMOVE = "remove"
DDMS_VALUES = frozenset([DDM_ADD, DDM_REMOVE])
502 503 504 505
DDMS_VALUES_WITH_MODIFY = (DDMS_VALUES | frozenset([
  DDM_MODIFY,
  ]))
# TODO: DDM_SWAP, DDM_MOVE?
506

507
# common exit codes
Iustin Pop's avatar
Iustin Pop committed
508
EXIT_SUCCESS = 0
509
EXIT_FAILURE = 1
510
EXIT_NOTCLUSTER = 5
511
EXIT_NOTMASTER = 11
512
EXIT_NODESETUP_ERROR = 12
Iustin Pop's avatar
Iustin Pop committed
513
EXIT_CONFIRMATION = 13 # need user confirmation
514

515 516 517
#: Exit code for query operations with unknown fields
EXIT_UNKNOWN_FIELD = 14

518 519
# tags
TAG_CLUSTER = "cluster"
520
TAG_NODEGROUP = "nodegroup"
521 522
TAG_NODE = "node"
TAG_INSTANCE = "instance"
523 524
VALID_TAG_TYPES = frozenset([
  TAG_CLUSTER,
525
  TAG_NODEGROUP,
526 527 528
  TAG_NODE,
  TAG_INSTANCE,
  ])
529 530 531
MAX_TAG_LEN = 128
MAX_TAGS_PER_OBJ = 4096

532 533
# others
DEFAULT_BRIDGE = "xen-br0"
534
CLASSIC_DRBD_SYNC_SPEED = 60 * 1024  # 60 MiB, expressed in KiB
535 536
IP4_ADDRESS_LOCALHOST = "127.0.0.1"
IP4_ADDRESS_ANY = "0.0.0.0"
Manuel Franceschini's avatar
Manuel Franceschini committed
537 538
IP6_ADDRESS_LOCALHOST = "::1"
IP6_ADDRESS_ANY = "::"
539 540
IP4_VERSION = 4
IP6_VERSION = 6
541
VALID_IP_VERSIONS = frozenset([IP4_VERSION, IP6_VERSION])
542 543 544 545
# for export to htools
IP4_FAMILY = socket.AF_INET
IP6_FAMILY = socket.AF_INET6

546
TCP_PING_TIMEOUT = 10
547
GANETI_RUNAS = "root"
548
DEFAULT_VG = "xenvg"
549
DEFAULT_DRBD_HELPER = "/bin/true"
550
MIN_VG_SIZE = 20480
551
DEFAULT_MAC_PREFIX = "aa:00:00"
552 553
# default maximum instance wait time, in seconds.
DEFAULT_SHUTDOWN_TIMEOUT = 120
554
NODE_MAX_CLOCK_SKEW = 150
555
# Time for an intra-cluster disk transfer to wait for a connection
556
DISK_TRANSFER_CONNECT_TIMEOUT = 60
557 558
# Disk index separator
DISK_SEPARATOR = _autoconf.DISK_SEPARATOR
559
IP_COMMAND_PATH = _autoconf.IP_PATH
560

561 562 563
#: Key for job IDs in opcode result
JOB_IDS_KEY = "jobs"

564 565 566 567 568 569 570
# runparts results
(RUNPARTS_SKIP,
 RUNPARTS_RUN,
 RUNPARTS_ERR) = range(3)

RUNPARTS_STATUS = frozenset([RUNPARTS_SKIP, RUNPARTS_RUN, RUNPARTS_ERR])

571 572 573 574
# RPC constants
(RPC_ENCODING_NONE,
 RPC_ENCODING_ZLIB_BASE64) = range(2)

575 576 577 578 579 580 581 582 583 584 585
# 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

586
# os related constants
Iustin Pop's avatar
Iustin Pop committed
587 588 589 590 591
OS_SCRIPT_CREATE = "create"
OS_SCRIPT_IMPORT = "import"
OS_SCRIPT_EXPORT = "export"
OS_SCRIPT_RENAME = "rename"
OS_SCRIPT_VERIFY = "verify"
Stephen Shirley's avatar
Stephen Shirley committed
592 593 594 595 596 597 598
OS_SCRIPTS = frozenset([
  OS_SCRIPT_CREATE,
  OS_SCRIPT_IMPORT,
  OS_SCRIPT_EXPORT,
  OS_SCRIPT_RENAME,
  OS_SCRIPT_VERIFY
  ])
599

Iustin Pop's avatar
Iustin Pop committed
600 601 602
OS_API_FILE = "ganeti_api_version"
OS_VARIANTS_FILE = "variants.list"
OS_PARAMETERS_FILE = "parameters.list"
603

Iustin Pop's avatar
Iustin Pop committed
604
OS_VALIDATE_PARAMETERS = "parameters"
605
OS_VALIDATE_CALLS = frozenset([OS_VALIDATE_PARAMETERS])
606

607
# ssh constants
608 609
SSH = "ssh"
SCP = "scp"
610 611 612 613 614

# reboot types
INSTANCE_REBOOT_SOFT = "soft"
INSTANCE_REBOOT_HARD = "hard"
INSTANCE_REBOOT_FULL = "full"
615

616 617 618 619 620 621 622 623 624 625 626 627 628 629
REBOOT_TYPES = frozenset([
  INSTANCE_REBOOT_SOFT,
  INSTANCE_REBOOT_HARD,
  INSTANCE_REBOOT_FULL
  ])

# instance reboot behaviors
INSTANCE_REBOOT_ALLOWED = "reboot"
INSTANCE_REBOOT_EXIT = "exit"

REBOOT_BEHAVIORS = frozenset([
  INSTANCE_REBOOT_ALLOWED,
  INSTANCE_REBOOT_EXIT
  ])
630

Iustin Pop's avatar
Iustin Pop committed
631
VTYPE_STRING = "string"
632
VTYPE_MAYBE_STRING = "maybe-string"
Iustin Pop's avatar
Iustin Pop committed
633 634 635
VTYPE_BOOL = "bool"
VTYPE_SIZE = "size" # size, in MiBs
VTYPE_INT = "int"
636
ENFORCEABLE_TYPES = frozenset([
Stephen Shirley's avatar
Stephen Shirley committed
637 638 639 640 641 642
  VTYPE_STRING,
  VTYPE_MAYBE_STRING,
  VTYPE_BOOL,
  VTYPE_SIZE,
  VTYPE_INT,
  ])
643

644 645 646
# Constant representing that the user does not specify any IP version
IFACE_NO_IP_VERSION_SPECIFIED = 0

647 648 649
# HV parameter names (global namespace)
HV_BOOT_ORDER = "boot_order"
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
650 651
HV_KVM_CDROM2_IMAGE_PATH = "cdrom2_image_path"
HV_KVM_FLOPPY_IMAGE_PATH = "floppy_image_path"
652 653
HV_NIC_TYPE = "nic_type"
HV_DISK_TYPE = "disk_type"
654
HV_KVM_CDROM_DISK_TYPE = "cdrom_disk_type"
655
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
656
HV_VNC_PASSWORD_FILE = "vnc_password_file"
657 658 659
HV_VNC_TLS = "vnc_tls"
HV_VNC_X509 = "vnc_x509_path"
HV_VNC_X509_VERIFY = "vnc_x509_verify"
660 661
HV_KVM_SPICE_BIND = "spice_bind"
HV_KVM_SPICE_IP_VERSION = "spice_ip_version"
662
HV_KVM_SPICE_PASSWORD_FILE = "spice_password_file"
663 664 665 666 667
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"
668
HV_KVM_SPICE_USE_TLS = "spice_use_tls"
669 670
HV_KVM_SPICE_TLS_CIPHERS = "spice_tls_ciphers"
HV_KVM_SPICE_USE_VDAGENT = "spice_use_vdagent"
671 672
HV_ACPI = "acpi"
HV_PAE = "pae"
673 674 675
HV_USE_BOOTLOADER = "use_bootloader"
HV_BOOTLOADER_ARGS = "bootloader_args"
HV_BOOTLOADER_PATH = "bootloader_path"
676
HV_KERNEL_ARGS = "kernel_args"
677 678
HV_KERNEL_PATH = "kernel_path"
HV_INITRD_PATH = "initrd_path"
679
HV_ROOT_PATH = "root_path"
680
HV_SERIAL_CONSOLE = "serial_console"
681
HV_USB_MOUSE = "usb_mouse"
682
HV_KEYMAP = "keymap"
683
HV_DEVICE_MODEL = "device_model"
684
HV_INIT_SCRIPT = "init_script"
685
HV_MIGRATION_PORT = "migration_port"
686 687
HV_MIGRATION_BANDWIDTH = "migration_bandwidth"
HV_MIGRATION_DOWNTIME = "migration_downtime"
688
HV_MIGRATION_MODE = "migration_mode"
689
HV_USE_LOCALTIME = "use_localtime"
690
HV_DISK_CACHE = "disk_cache"
691 692
HV_SECURITY_MODEL = "security_model"
HV_SECURITY_DOMAIN = "security_domain"
Guido Trotter's avatar
Guido Trotter committed
693
HV_KVM_FLAG = "kvm_flag"
694
HV_VHOST_NET = "vhost_net"
Balazs Lecz's avatar
Balazs Lecz committed
695
HV_KVM_USE_CHROOT = "use_chroot"
696
HV_CPU_MASK = "cpu_mask"
697
HV_MEM_PATH = "mem_path"
Jack's avatar
Jack committed
698
HV_PASSTHROUGH = "pci_pass"
699
HV_BLOCKDEV_PREFIX = "blockdev_prefix"
700
HV_REBOOT_BEHAVIOR = "reboot_behavior"
701
HV_CPU_TYPE = "cpu_type"
702

703 704
HVS_PARAMETER_TYPES = {
  HV_BOOT_ORDER: VTYPE_STRING,
705
  HV_KVM_FLOPPY_IMAGE_PATH: VTYPE_STRING,
706
  HV_CDROM_IMAGE_PATH: VTYPE_STRING,
707
  HV_KVM_CDROM2_IMAGE_PATH: VTYPE_STRING,
708 709
  HV_NIC_TYPE: VTYPE_STRING,
  HV_DISK_TYPE: VTYPE_STRING,
710
  HV_KVM_CDROM_DISK_TYPE: VTYPE_STRING,
711
  HV_VNC_PASSWORD_FILE: VTYPE_STRING,
712 713 714 715
  HV_VNC_BIND_ADDRESS: VTYPE_STRING,
  HV_VNC_TLS: VTYPE_BOOL,
  HV_VNC_X509: VTYPE_STRING,
  HV_VNC_X509_VERIFY: VTYPE_BOOL,
716 717
  HV_KVM_SPICE_BIND: VTYPE_STRING,
  HV_KVM_SPICE_IP_VERSION: VTYPE_INT,
718
  HV_KVM_SPICE_PASSWORD_FILE: VTYPE_STRING,
719 720 721 722 723
  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,
724
  HV_KVM_SPICE_USE_TLS: VTYPE_BOOL,
725 726
  HV_KVM_SPICE_TLS_CIPHERS: VTYPE_STRING,
  HV_KVM_SPICE_USE_VDAGENT: VTYPE_BOOL,
727 728
  HV_ACPI: VTYPE_BOOL,
  HV_PAE: VTYPE_BOOL,
729 730 731
  HV_USE_BOOTLOADER: VTYPE_BOOL,
  HV_BOOTLOADER_PATH: VTYPE_STRING,
  HV_BOOTLOADER_ARGS: VTYPE_STRING,
732
  HV_KERNEL_PATH: VTYPE_STRING,
733
  HV_KERNEL_ARGS: VTYPE_STRING,
734
  HV_INITRD_PATH: VTYPE_STRING,
735
  HV_ROOT_PATH: VTYPE_MAYBE_STRING,
736 737
  HV_SERIAL_CONSOLE: VTYPE_BOOL,
  HV_USB_MOUSE: VTYPE_STRING,
738
  HV_KEYMAP: VTYPE_STRING,
739
  HV_DEVICE_MODEL: VTYPE_STRING,
740
  HV_INIT_SCRIPT: VTYPE_STRING,
741
  HV_MIGRATION_PORT: VTYPE_INT,
742 743
  HV_MIGRATION_BANDWIDTH: VTYPE_INT,
  HV_MIGRATION_DOWNTIME: VTYPE_INT,
744
  HV_MIGRATION_MODE: VTYPE_STRING,
745
  HV_USE_LOCALTIME: VTYPE_BOOL,
746
  HV_DISK_CACHE: VTYPE_STRING,
747 748
  HV_SECURITY_MODEL: VTYPE_STRING,
  HV_SECURITY_DOMAIN: VTYPE_STRING,
Guido Trotter's avatar
Guido Trotter committed
749
  HV_KVM_FLAG: VTYPE_STRING,
750
  HV_VHOST_NET: VTYPE_BOOL,
Balazs Lecz's avatar
Balazs Lecz committed
751
  HV_KVM_USE_CHROOT: VTYPE_BOOL,
752
  HV_CPU_MASK: VTYPE_STRING,
753
  HV_MEM_PATH: VTYPE_STRING,
Jack's avatar
Jack committed
754
  HV_PASSTHROUGH: VTYPE_STRING,
755
  HV_BLOCKDEV_PREFIX: VTYPE_STRING,
756
  HV_REBOOT_BEHAVIOR: VTYPE_STRING,
757
  HV_CPU_TYPE: VTYPE_STRING,
758 759 760
  }

HVS_PARAMETERS = frozenset(HVS_PARAMETER_TYPES.keys())
761

762 763 764 765 766 767 768 769 770 771 772 773 774 775
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",
  }

776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
# Migration statuses
HV_MIGRATION_COMPLETED = "completed"
HV_MIGRATION_ACTIVE = "active"
HV_MIGRATION_FAILED = "failed"
HV_MIGRATION_CANCELLED = "cancelled"

HV_MIGRATION_VALID_STATUSES = frozenset([
  HV_MIGRATION_COMPLETED,
  HV_MIGRATION_ACTIVE,
  HV_MIGRATION_FAILED,
  HV_MIGRATION_CANCELLED,
  ])

HV_MIGRATION_FAILED_STATUSES = frozenset([
  HV_MIGRATION_FAILED,
  HV_MIGRATION_CANCELLED,
  ])

# KVM-specific statuses
HV_KVM_MIGRATION_VALID_STATUSES = HV_MIGRATION_VALID_STATUSES

797 798 799
# Node info keys
HV_NODEINFO_KEY_VERSION = "hv_version"

800 801 802 803 804 805 806
# 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"

807 808 809 810 811 812 813 814
HVST_DEFAULTS = {
  HVST_MEMORY_TOTAL: 0,
  HVST_MEMORY_NODE: 0,
  HVST_MEMORY_HV: 0,
  HVST_CPU_TOTAL: 1,
  HVST_CPU_NODE: 1,
  }

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
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"

830 831 832 833 834 835
DS_DEFAULTS = {
  DS_DISK_TOTAL: 0,
  DS_DISK_RESERVED: 0,
  DS_DISK_OVERHEAD: 0,
  }

836 837 838 839 840 841 842
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())
843
DS_VALID_TYPES = frozenset([LD_LV])
844

845
# Backend parameter names
846 847 848
BE_MEMORY = "memory" # deprecated and replaced by max and min mem
BE_MAXMEM = "maxmem"
BE_MINMEM = "minmem"
849
BE_VCPUS = "vcpus"
850
BE_AUTO_BALANCE = "auto_balance"
851
BE_ALWAYS_FAILOVER = "always_failover"
852
BE_SPINDLE_USE = "spindle_use"
853

854
BES_PARAMETER_TYPES = {
855 856 857 858
  BE_MAXMEM: VTYPE_SIZE,
  BE_MINMEM: VTYPE_SIZE,
  BE_VCPUS: VTYPE_INT,
  BE_AUTO_BALANCE: VTYPE_BOOL,
859
  BE_ALWAYS_FAILOVER: VTYPE_BOOL,
860
  BE_SPINDLE_USE: VTYPE_INT,
861
  }
862

863 864 865 866 867 868 869
BES_PARAMETER_TITLES = {
  BE_AUTO_BALANCE: "Auto_balance",
  BE_MAXMEM: "ConfigMaxMem",
  BE_MINMEM: "ConfigMinMem",
  BE_VCPUS: "ConfigVCPUs",
  }

870 871 872 873 874
BES_PARAMETER_COMPAT = {
  BE_MEMORY: VTYPE_SIZE,
  }
BES_PARAMETER_COMPAT.update(BES_PARAMETER_TYPES)

875
BES_PARAMETERS = frozenset(BES_PARAMETER_TYPES.keys())
Iustin Pop's avatar
Iustin Pop committed
876

877
# instance specs
878 879 880 881 882
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"
883
ISPEC_SPINDLE_USE = "spindle-use"
884 885

ISPECS_PARAMETER_TYPES = {
886 887 888 889 890
  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,
891
  ISPEC_SPINDLE_USE: VTYPE_INT,
892 893 894 895
  }

ISPECS_PARAMETERS = frozenset(ISPECS_PARAMETER_TYPES.keys())

896 897 898
ISPECS_MIN = "min"
ISPECS_MAX = "max"
ISPECS_STD = "std"
899 900
IPOLICY_DTS = "disk-templates"
IPOLICY_VCPU_RATIO = "vcpu-ratio"
901
IPOLICY_SPINDLE_RATIO = "spindle-ratio"
902

903
IPOLICY_ISPECS = frozenset([
904 905 906
  ISPECS_MIN,
  ISPECS_MAX,
  ISPECS_STD,
907
  ])
908 909 910

IPOLICY_PARAMETERS = frozenset([
  IPOLICY_VCPU_RATIO,
911
  IPOLICY_SPINDLE_RATIO,
912 913 914 915 916
  ])

IPOLICY_ALL_KEYS = (IPOLICY_ISPECS |
                    IPOLICY_PARAMETERS |
                    frozenset([IPOLICY_DTS]))
917

918 919
# Node parameter names
ND_OOB_PROGRAM = "oob_program"
920
ND_SPINDLE_COUNT = "spindle_count"
921 922

NDS_PARAMETER_TYPES = {
923
  ND_OOB_PROGRAM: VTYPE_STRING,
924
  ND_SPINDLE_COUNT: VTYPE_INT,
925
  }
926 927 928

NDS_PARAMETERS = frozenset(NDS_PARAMETER_TYPES.keys())

929 930 931 932 933
NDS_PARAMETER_TITLES = {
  ND_OOB_PROGRAM: "OutOfBandProgram",
  ND_SPINDLE_COUNT: "SpindleCount",
  }

934
# Logical Disks parameters
935 936 937 938
LDP_RESYNC_RATE = "resync-rate"
LDP_STRIPES = "stripes"
LDP_BARRIERS = "disabled-barriers"
LDP_NO_META_FLUSH = "disable-meta-flush"
939
LDP_DEFAULT_METAVG = "default-metavg"
940 941
LDP_DISK_CUSTOM = "disk-custom"
LDP_NET_CUSTOM = "net-custom"
942
LDP_DYNAMIC_RESYNC = "dynamic-resync"
943 944 945 946 947
LDP_PLAN_AHEAD = "c-plan-ahead"
LDP_FILL_TARGET = "c-fill-target"
LDP_DELAY_TARGET = "c-delay-target"
LDP_MAX_RATE = "c-max-rate"
LDP_MIN_RATE = "c-min-rate"
948
LDP_POOL = "pool"
949
DISK_LD_TYPES = {
950 951 952 953
  LDP_RESYNC_RATE: VTYPE_INT,
  LDP_STRIPES: VTYPE_INT,
  LDP_BARRIERS: VTYPE_STRING,
  LDP_NO_META_FLUSH: VTYPE_BOOL,
954
  LDP_DEFAULT_METAVG: VTYPE_STRING,
955 956
  LDP_DISK_CUSTOM: VTYPE_STRING,
  LDP_NET_CUSTOM: VTYPE_STRING,
957
  LDP_DYNAMIC_RESYNC: VTYPE_BOOL,
958 959 960 961 962
  LDP_PLAN_AHEAD: VTYPE_INT,
  LDP_FILL_TARGET: VTYPE_INT,
  LDP_DELAY_TARGET: VTYPE_INT,
  LDP_MAX_RATE: VTYPE_INT,
  LDP_MIN_RATE: VTYPE_INT,
963
  LDP_POOL: VTYPE_STRING,
964 965 966
  }
DISK_LD_PARAMETERS = frozenset(DISK_LD_TYPES.keys())

967 968
# Disk template parameters (can be set/changed by the user via gnt-cluster and
# gnt-group)
969
DRBD_RESYNC_RATE = "resync-rate"
970 971
DRBD_DATA_STRIPES = "data-stripes"
DRBD_META_STRIPES = "meta-stripes"
972 973
DRBD_DISK_BARRIERS = "disk-barriers"
DRBD_META_BARRIERS = "meta-barriers"
974
DRBD_DEFAULT_METAVG = "metavg"