constants: Add job and opcode status strings
[ganeti-local] / 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 = 5
30 EXPORT_VERSION = 0
31
32
33 # Format for CONFIG_VERSION:
34 #   01 03 0123 = 01030123
35 #   ^^ ^^ ^^^^
36 #   |  |  + Configuration version/revision
37 #   |  + Minor version
38 #   + Major version
39 #
40 # It stored as an integer. Make sure not to write an octal number.
41
42 # BuildVersion and SplitVersion must be in here because we can't import other
43 # modules. The cfgupgrade tool must be able to read and write version numbers
44 # and thus requires these functions. To avoid code duplication, they're kept in
45 # here.
46
47 def BuildVersion(major, minor, revision):
48   """Calculates int version number from major, minor and revision numbers.
49
50   Returns: int representing version number
51
52   """
53   assert isinstance(major, int)
54   assert isinstance(minor, int)
55   assert isinstance(revision, int)
56   return (1000000 * major +
57             10000 * minor +
58                 1 * revision)
59
60
61 def SplitVersion(version):
62   """Splits version number stored in an int.
63
64   Returns: tuple; (major, minor, revision)
65
66   """
67   assert isinstance(version, int)
68
69   (major, remainder) = divmod(version, 1000000)
70   (minor, revision) = divmod(remainder, 10000)
71
72   return (major, minor, revision)
73
74
75 CONFIG_MAJOR = int(_autoconf.VERSION_MAJOR)
76 CONFIG_MINOR = int(_autoconf.VERSION_MINOR)
77 CONFIG_REVISION = 0
78 CONFIG_VERSION = BuildVersion(CONFIG_MAJOR, CONFIG_MINOR, CONFIG_REVISION)
79
80 # file paths
81 DATA_DIR = _autoconf.LOCALSTATEDIR + "/lib/ganeti"
82 RUN_DIR = _autoconf.LOCALSTATEDIR + "/run"
83 RUN_GANETI_DIR = RUN_DIR + "/ganeti"
84 BDEV_CACHE_DIR = RUN_GANETI_DIR # TODO(2.0): move deeper
85 DISK_LINKS_DIR = RUN_GANETI_DIR + "/instance-disks"
86 # keep RUN_GANETI_DIR first here, to make sure all get created when the node
87 # daemon is started (this takes care of RUN_DIR being tmpfs)
88 SUB_RUN_DIRS = [ RUN_GANETI_DIR, BDEV_CACHE_DIR, DISK_LINKS_DIR ]
89 LOCK_DIR = _autoconf.LOCALSTATEDIR + "/lock"
90 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
91 SSL_CERT_FILE = DATA_DIR + "/server.pem"
92 WATCHER_STATEFILE = DATA_DIR + "/watcher.data"
93 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
94 ETC_HOSTS = "/etc/hosts"
95 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
96 MASTER_SOCKET = RUN_DIR + "/ganeti-master.sock"
97
98 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
99 DEFAULT_NODED_PORT = 1811
100 FIRST_DRBD_PORT = 11000
101 LAST_DRBD_PORT = 14999
102 MASTER_SCRIPT = "ganeti-master"
103
104 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti"
105 LOG_OS_DIR = LOG_DIR + "/os"
106 LOG_NODESERVER = LOG_DIR + "/node-daemon.log"
107 LOG_WATCHER = LOG_DIR + "/watcher.log"
108 LOG_MASTERDAEMON = LOG_DIR + "/master-daemon.log"
109
110 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
111 EXPORT_DIR = _autoconf.EXPORT_DIR
112
113 EXPORT_CONF_FILE = "config.ini"
114
115 XEN_KERNEL = _autoconf.XEN_KERNEL
116 XEN_INITRD = _autoconf.XEN_INITRD
117
118 VALUE_DEFAULT = "default"
119 VALUE_NONE = "none"
120
121 # hooks-related constants
122 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
123 HOOKS_PHASE_PRE = "pre"
124 HOOKS_PHASE_POST = "post"
125 HOOKS_NAME_CFGUPDATE = "config-update"
126 HOOKS_VERSION = 1
127
128 # hooks subject type (what object type does the LU deal with)
129 HTYPE_CLUSTER = "CLUSTER"
130 HTYPE_NODE = "NODE"
131 HTYPE_INSTANCE = "INSTANCE"
132
133 HKR_SKIP = 0
134 HKR_FAIL = 1
135 HKR_SUCCESS = 2
136
137 # disk template types
138 DT_DISKLESS = "diskless"
139 DT_PLAIN = "plain"
140 DT_DRBD8 = "drbd"
141 DT_FILE = "file"
142
143 # the set of network-mirrored disk templates
144 DTS_NET_MIRROR = frozenset([DT_DRBD8])
145
146 # the set of non-lvm-based disk templates
147 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
148
149 # logical disk types
150 LD_LV = "lvm"
151 LD_DRBD8 = "drbd8"
152 LD_FILE = "file"
153
154 # file backend driver
155 FD_LOOP = "loop"
156 FD_BLKTAP = "blktap"
157
158 # the set of drbd-like disk types
159 LDS_DRBD = frozenset([LD_DRBD8])
160
161 # disk replacement mode
162 REPLACE_DISK_PRI = "replace_primary"
163 REPLACE_DISK_SEC = "replace_secondary"
164 REPLACE_DISK_ALL = "replace_all"
165
166 # instance creation modes
167 INSTANCE_CREATE = "create"
168 INSTANCE_IMPORT = "import"
169
170 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
171                             DT_DRBD8, DT_FILE])
172
173 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
174
175 # import/export config options
176 INISECT_EXP = "export"
177 INISECT_INS = "instance"
178
179 # common exit codes
180 EXIT_SUCCESS = 0
181 EXIT_FAILURE = 1
182 EXIT_NOTMASTER = 11
183 EXIT_NODESETUP_ERROR = 12
184 EXIT_CONFIRMATION = 13 # need user confirmation
185
186 # tags
187 TAG_CLUSTER = "cluster"
188 TAG_NODE = "node"
189 TAG_INSTANCE = "instance"
190 MAX_TAG_LEN = 128
191 MAX_TAGS_PER_OBJ = 4096
192
193 # others
194 DEFAULT_BRIDGE = "xen-br0"
195 SYNC_SPEED = 30 * 1024
196 LOCALHOST_IP_ADDRESS = "127.0.0.1"
197 TCP_PING_TIMEOUT = 10
198 GANETI_RUNAS = "root"
199 DEFAULT_VG = "xenvg"
200 BIND_ADDRESS_GLOBAL = "0.0.0.0"
201 MIN_VG_SIZE = 20480
202
203 # valid os status
204 OS_VALID_STATUS = "VALID"
205
206 # ssh constants
207 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
208 SSH_CONFIG_DIR = "/etc/ssh/"
209 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
210 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
211 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
212 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
213 SSH = "ssh"
214 SCP = "scp"
215
216 # reboot types
217 INSTANCE_REBOOT_SOFT = "soft"
218 INSTANCE_REBOOT_HARD = "hard"
219 INSTANCE_REBOOT_FULL = "full"
220
221 # Hypervisor constants
222 HT_XEN_PVM30 = "xen-3.0"
223 HT_FAKE = "fake"
224 HT_XEN_HVM31 = "xen-hvm-3.1"
225 HYPER_TYPES = frozenset([HT_XEN_PVM30, HT_FAKE, HT_XEN_HVM31])
226 HTS_REQ_PORT = frozenset([HT_XEN_HVM31])
227
228 HT_HVM_VNC_BASE_PORT = 5900
229 HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
230 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
231 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
232
233 # Cluster Verify steps
234 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
235 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
236
237 # Allocator framework constants
238 IALLOCATOR_DIR_IN = "in"
239 IALLOCATOR_DIR_OUT = "out"
240 IALLOCATOR_MODE_ALLOC = "allocate"
241 IALLOCATOR_MODE_RELOC = "relocate"
242 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
243 IARUN_NOTFOUND = 1
244 IARUN_FAILURE = 2
245 IARUN_SUCCESS = 3
246
247 # Job status
248 JOB_STATUS_QUEUED = "queued"
249 JOB_STATUS_RUNNING = "running"
250 JOB_STATUS_CANCELED = "canceled"
251 JOB_STATUS_SUCCESS = "success"
252 JOB_STATUS_ERROR = "error"
253
254 OP_STATUS_QUEUED = "queued"
255 OP_STATUS_RUNNING = "running"
256 OP_STATUS_SUCCESS = "success"
257 OP_STATUS_ERROR = "error"