Statistics
| Branch: | Tag: | Revision:

root / lib / constants.py @ 686d7433

History | View | Annotate | Download (9.6 kB)

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 = 5
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_RAPIACCESS = LOG_DIR + "rapi-access.log"
131
LOG_COMMANDS = LOG_DIR + "commands.log"
132
LOG_BURNIN = LOG_DIR + "burnin.log"
133

    
134
OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
135
EXPORT_DIR = _autoconf.EXPORT_DIR
136

    
137
EXPORT_CONF_FILE = "config.ini"
138

    
139
XEN_KERNEL = _autoconf.XEN_KERNEL
140
XEN_INITRD = _autoconf.XEN_INITRD
141

    
142
KVM_PATH = _autoconf.KVM_PATH
143

    
144
VALUE_DEFAULT = "default"
145
VALUE_NONE = "none"
146

    
147
# hooks-related constants
148
HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
149
HOOKS_PHASE_PRE = "pre"
150
HOOKS_PHASE_POST = "post"
151
HOOKS_NAME_CFGUPDATE = "config-update"
152
HOOKS_VERSION = 1
153

    
154
# hooks subject type (what object type does the LU deal with)
155
HTYPE_CLUSTER = "CLUSTER"
156
HTYPE_NODE = "NODE"
157
HTYPE_INSTANCE = "INSTANCE"
158

    
159
HKR_SKIP = 0
160
HKR_FAIL = 1
161
HKR_SUCCESS = 2
162

    
163
# disk template types
164
DT_DISKLESS = "diskless"
165
DT_PLAIN = "plain"
166
DT_DRBD8 = "drbd"
167
DT_FILE = "file"
168

    
169
# the set of network-mirrored disk templates
170
DTS_NET_MIRROR = frozenset([DT_DRBD8])
171

    
172
# the set of non-lvm-based disk templates
173
DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
174

    
175
# logical disk types
176
LD_LV = "lvm"
177
LD_DRBD8 = "drbd8"
178
LD_FILE = "file"
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
# valid os status
238
OS_VALID_STATUS = "VALID"
239

    
240
# ssh constants
241
SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
242
SSH_CONFIG_DIR = "/etc/ssh/"
243
SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
244
SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
245
SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
246
SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
247
SSH = "ssh"
248
SCP = "scp"
249

    
250
# reboot types
251
INSTANCE_REBOOT_SOFT = "soft"
252
INSTANCE_REBOOT_HARD = "hard"
253
INSTANCE_REBOOT_FULL = "full"
254

    
255
# HV parameter names (global namespace)
256
HV_BOOT_ORDER = "boot_order"
257
HV_CDROM_IMAGE_PATH = "cdrom_image_path"
258
HV_NIC_TYPE = "nic_type"
259
HV_DISK_TYPE = "disk_type"
260
HV_VNC_BIND_ADDRESS = "vnc_bind_address"
261
HV_ACPI = "acpi"
262
HV_PAE = "pae"
263
HV_KERNEL_PATH = "kernel_path"
264
HV_INITRD_PATH = "initrd_path"
265

    
266
HVS_PARAMETERS = frozenset([
267
  HV_BOOT_ORDER,
268
  HV_CDROM_IMAGE_PATH,
269
  HV_NIC_TYPE,
270
  HV_DISK_TYPE,
271
  HV_VNC_BIND_ADDRESS,
272
  HV_ACPI,
273
  HV_PAE,
274
  HV_KERNEL_PATH,
275
  HV_INITRD_PATH,
276
  ])
277

    
278
# BE parameter names
279
BE_MEMORY = "memory"
280
BE_VCPUS = "vcpus"
281
BE_AUTO_BALANCE = "auto_balance"
282

    
283
BES_PARAMETERS = frozenset([
284
  BE_MEMORY,
285
  BE_VCPUS,
286
  BE_AUTO_BALANCE,
287
  ])
288

    
289
# BE GROUP
290
BEGR_DEFAULT = "default"
291

    
292
# Hypervisor constants
293
HT_XEN_PVM = "xen-pvm"
294
HT_FAKE = "fake"
295
HT_XEN_HVM = "xen-hvm"
296
HT_KVM = "kvm"
297
HYPER_TYPES = frozenset([HT_XEN_PVM, HT_FAKE, HT_XEN_HVM, HT_KVM])
298
HTS_REQ_PORT = frozenset([HT_XEN_HVM])
299

    
300
HT_HVM_VNC_BASE_PORT = 5900
301
HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
302
VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
303
VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
304

    
305
# HVM NIC types
306
HT_HVM_NIC_RTL8139 = "rtl8139"
307
HT_HVM_NIC_NE2K_PCI = "ne2k_pci"
308
HT_HVM_NIC_NE2K_ISA = "ne2k_isa"
309
HT_HVM_DEV_PARAVIRTUAL = "paravirtual"
310
HT_HVM_DEV_IOEMU = "ioemu"
311
HT_HVM_VALID_NIC_TYPES = frozenset([HT_HVM_NIC_RTL8139, HT_HVM_NIC_NE2K_PCI,
312
                                    HT_HVM_NIC_NE2K_ISA,
313
                                    HT_HVM_DEV_PARAVIRTUAL])
314
HT_HVM_VALID_DISK_TYPES = frozenset([HT_HVM_DEV_PARAVIRTUAL, HT_HVM_DEV_IOEMU])
315

    
316
# Cluster Verify steps
317
VERIFY_NPLUSONE_MEM = 'nplusone_mem'
318
VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
319

    
320
# Allocator framework constants
321
IALLOCATOR_DIR_IN = "in"
322
IALLOCATOR_DIR_OUT = "out"
323
IALLOCATOR_MODE_ALLOC = "allocate"
324
IALLOCATOR_MODE_RELOC = "relocate"
325
IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
326
IARUN_NOTFOUND = 1
327
IARUN_FAILURE = 2
328
IARUN_SUCCESS = 3
329

    
330
# Job queue
331
JOB_QUEUE_VERSION = 1
332
JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
333
JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
334
JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
335
JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
336
JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
337

    
338
JOB_ID_TEMPLATE = r"\d+"
339

    
340
# unchanged job return
341
JOB_NOTCHANGED = "nochange"
342

    
343
# Job status
344
JOB_STATUS_QUEUED = "queued"
345
JOB_STATUS_WAITLOCK = "waiting"
346
JOB_STATUS_RUNNING = "running"
347
JOB_STATUS_CANCELED = "canceled"
348
JOB_STATUS_SUCCESS = "success"
349
JOB_STATUS_ERROR = "error"
350

    
351
OP_STATUS_QUEUED = "queued"
352
OP_STATUS_WAITLOCK = "waiting"
353
OP_STATUS_RUNNING = "running"
354
OP_STATUS_CANCELED = "canceled"
355
OP_STATUS_SUCCESS = "success"
356
OP_STATUS_ERROR = "error"
357

    
358
# Execution log types
359
ELOG_MESSAGE = "message"
360
ELOG_PROGRESS = "progress"
361

    
362
# Temporary RAPI constants until we have cluster parameters
363
RAPI_ENABLE = True
364
RAPI_PORT = 5080