Add “canceled” status for opcodes
[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 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 QUEUE_DIR = DATA_DIR + "/queue"
96 ETC_HOSTS = "/etc/hosts"
97 DEFAULT_FILE_STORAGE_DIR = _autoconf.FILE_STORAGE_DIR
98 MASTER_SOCKET = RUN_GANETI_DIR + "/master.sock"
99
100 NODE_INITD_SCRIPT = _autoconf.SYSCONFDIR + "/init.d/ganeti"
101 DEFAULT_NODED_PORT = 1811
102 FIRST_DRBD_PORT = 11000
103 LAST_DRBD_PORT = 14999
104 MASTER_SCRIPT = "ganeti-master"
105
106 LOG_DIR = _autoconf.LOCALSTATEDIR + "/log/ganeti"
107 LOG_OS_DIR = LOG_DIR + "/os"
108 LOG_NODESERVER = LOG_DIR + "/node-daemon.log"
109 LOG_WATCHER = LOG_DIR + "/watcher.log"
110 LOG_MASTERDAEMON = LOG_DIR + "/master-daemon.log"
111 LOG_RAPISERVER = LOG_DIR + "/rapi-daemon.log"
112 LOG_RAPIACCESS = LOG_DIR + "/rapi-access.log"
113
114 OS_SEARCH_PATH = _autoconf.OS_SEARCH_PATH
115 EXPORT_DIR = _autoconf.EXPORT_DIR
116
117 EXPORT_CONF_FILE = "config.ini"
118
119 XEN_KERNEL = _autoconf.XEN_KERNEL
120 XEN_INITRD = _autoconf.XEN_INITRD
121
122 VALUE_DEFAULT = "default"
123 VALUE_NONE = "none"
124
125 # hooks-related constants
126 HOOKS_BASE_DIR = _autoconf.SYSCONFDIR + "/ganeti/hooks"
127 HOOKS_PHASE_PRE = "pre"
128 HOOKS_PHASE_POST = "post"
129 HOOKS_NAME_CFGUPDATE = "config-update"
130 HOOKS_VERSION = 1
131
132 # hooks subject type (what object type does the LU deal with)
133 HTYPE_CLUSTER = "CLUSTER"
134 HTYPE_NODE = "NODE"
135 HTYPE_INSTANCE = "INSTANCE"
136
137 HKR_SKIP = 0
138 HKR_FAIL = 1
139 HKR_SUCCESS = 2
140
141 # disk template types
142 DT_DISKLESS = "diskless"
143 DT_PLAIN = "plain"
144 DT_DRBD8 = "drbd"
145 DT_FILE = "file"
146
147 # the set of network-mirrored disk templates
148 DTS_NET_MIRROR = frozenset([DT_DRBD8])
149
150 # the set of non-lvm-based disk templates
151 DTS_NOT_LVM = frozenset([DT_DISKLESS, DT_FILE])
152
153 # logical disk types
154 LD_LV = "lvm"
155 LD_DRBD8 = "drbd8"
156 LD_FILE = "file"
157
158 # file backend driver
159 FD_LOOP = "loop"
160 FD_BLKTAP = "blktap"
161
162 # the set of drbd-like disk types
163 LDS_DRBD = frozenset([LD_DRBD8])
164
165 # disk replacement mode
166 REPLACE_DISK_PRI = "replace_primary"
167 REPLACE_DISK_SEC = "replace_secondary"
168 REPLACE_DISK_ALL = "replace_all"
169
170 # instance creation modes
171 INSTANCE_CREATE = "create"
172 INSTANCE_IMPORT = "import"
173
174 DISK_TEMPLATES = frozenset([DT_DISKLESS, DT_PLAIN,
175                             DT_DRBD8, DT_FILE])
176
177 FILE_DRIVER = frozenset([FD_LOOP, FD_BLKTAP])
178
179 # import/export config options
180 INISECT_EXP = "export"
181 INISECT_INS = "instance"
182
183 # common exit codes
184 EXIT_SUCCESS = 0
185 EXIT_FAILURE = 1
186 EXIT_NOTMASTER = 11
187 EXIT_NODESETUP_ERROR = 12
188 EXIT_CONFIRMATION = 13 # need user confirmation
189
190 # tags
191 TAG_CLUSTER = "cluster"
192 TAG_NODE = "node"
193 TAG_INSTANCE = "instance"
194 MAX_TAG_LEN = 128
195 MAX_TAGS_PER_OBJ = 4096
196
197 # others
198 DEFAULT_BRIDGE = "xen-br0"
199 SYNC_SPEED = 30 * 1024
200 LOCALHOST_IP_ADDRESS = "127.0.0.1"
201 TCP_PING_TIMEOUT = 10
202 GANETI_RUNAS = "root"
203 DEFAULT_VG = "xenvg"
204 BIND_ADDRESS_GLOBAL = "0.0.0.0"
205 MIN_VG_SIZE = 20480
206
207 # valid os status
208 OS_VALID_STATUS = "VALID"
209
210 # ssh constants
211 SSH_INITD_SCRIPT = _autoconf.SSH_INITD_SCRIPT
212 SSH_CONFIG_DIR = "/etc/ssh/"
213 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "ssh_host_dsa_key"
214 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
215 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "ssh_host_rsa_key"
216 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
217 SSH = "ssh"
218 SCP = "scp"
219
220 # reboot types
221 INSTANCE_REBOOT_SOFT = "soft"
222 INSTANCE_REBOOT_HARD = "hard"
223 INSTANCE_REBOOT_FULL = "full"
224
225 # Hypervisor constants
226 HT_XEN_PVM30 = "xen-3.0"
227 HT_FAKE = "fake"
228 HT_XEN_HVM31 = "xen-hvm-3.1"
229 HYPER_TYPES = frozenset([HT_XEN_PVM30, HT_FAKE, HT_XEN_HVM31])
230 HTS_REQ_PORT = frozenset([HT_XEN_HVM31])
231
232 HT_HVM_VNC_BASE_PORT = 5900
233 HT_HVM_DEFAULT_BOOT_ORDER = 'dc'
234 VNC_PASSWORD_FILE = _autoconf.SYSCONFDIR + "/ganeti/vnc-cluster-password"
235 VNC_DEFAULT_BIND_ADDRESS = '0.0.0.0'
236
237 # Cluster Verify steps
238 VERIFY_NPLUSONE_MEM = 'nplusone_mem'
239 VERIFY_OPTIONAL_CHECKS = frozenset([VERIFY_NPLUSONE_MEM])
240
241 # Allocator framework constants
242 IALLOCATOR_DIR_IN = "in"
243 IALLOCATOR_DIR_OUT = "out"
244 IALLOCATOR_MODE_ALLOC = "allocate"
245 IALLOCATOR_MODE_RELOC = "relocate"
246 IALLOCATOR_SEARCH_PATH = _autoconf.IALLOCATOR_SEARCH_PATH
247 IARUN_NOTFOUND = 1
248 IARUN_FAILURE = 2
249 IARUN_SUCCESS = 3
250
251 # Job queue
252 JOB_QUEUE_VERSION = 1
253 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
254 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
255 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
256 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
257
258 JOB_ID_TEMPLATE = r"\d+"
259
260 # Job status
261 JOB_STATUS_QUEUED = "queued"
262 JOB_STATUS_RUNNING = "running"
263 JOB_STATUS_CANCELED = "canceled"
264 JOB_STATUS_SUCCESS = "success"
265 JOB_STATUS_ERROR = "error"
266
267 OP_STATUS_QUEUED = "queued"
268 OP_STATUS_RUNNING = "running"
269 OP_STATUS_CANCELED = "canceled"
270 OP_STATUS_SUCCESS = "success"
271 OP_STATUS_ERROR = "error"
272
273 # Execution log types
274 ELOG_MESSAGE = "message"
275 ELOG_PROGRESS = "progress"
276
277 # Temporary RAPI constants until we have cluster parameters
278 RAPI_ENABLE = True
279 RAPI_PORT = 5080