root / lib / cli.py @ 225e2544
History | View | Annotate | Download (95.3 kB)
1 | 2f31098c | Iustin Pop | #
|
---|---|---|---|
2 | a8083063 | Iustin Pop | #
|
3 | a8083063 | Iustin Pop | |
4 | 18009c1e | Iustin Pop | # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
|
5 | a8083063 | Iustin Pop | #
|
6 | a8083063 | Iustin Pop | # This program is free software; you can redistribute it and/or modify
|
7 | a8083063 | Iustin Pop | # it under the terms of the GNU General Public License as published by
|
8 | a8083063 | Iustin Pop | # the Free Software Foundation; either version 2 of the License, or
|
9 | a8083063 | Iustin Pop | # (at your option) any later version.
|
10 | a8083063 | Iustin Pop | #
|
11 | a8083063 | Iustin Pop | # This program is distributed in the hope that it will be useful, but
|
12 | a8083063 | Iustin Pop | # WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 | a8083063 | Iustin Pop | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
14 | a8083063 | Iustin Pop | # General Public License for more details.
|
15 | a8083063 | Iustin Pop | #
|
16 | a8083063 | Iustin Pop | # You should have received a copy of the GNU General Public License
|
17 | a8083063 | Iustin Pop | # along with this program; if not, write to the Free Software
|
18 | a8083063 | Iustin Pop | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
19 | a8083063 | Iustin Pop | # 02110-1301, USA.
|
20 | a8083063 | Iustin Pop | |
21 | a8083063 | Iustin Pop | |
22 | a8083063 | Iustin Pop | """Module dealing with command line parsing"""
|
23 | a8083063 | Iustin Pop | |
24 | a8083063 | Iustin Pop | |
25 | a8083063 | Iustin Pop | import sys |
26 | a8083063 | Iustin Pop | import textwrap |
27 | a8083063 | Iustin Pop | import os.path |
28 | 685ee993 | Iustin Pop | import time |
29 | 46fbdd04 | Iustin Pop | import logging |
30 | 225e2544 | Iustin Pop | import errno |
31 | 73702ee7 | Iustin Pop | from cStringIO import StringIO |
32 | a8083063 | Iustin Pop | |
33 | a8083063 | Iustin Pop | from ganeti import utils |
34 | a8083063 | Iustin Pop | from ganeti import errors |
35 | a8083063 | Iustin Pop | from ganeti import constants |
36 | 846baef9 | Iustin Pop | from ganeti import opcodes |
37 | ceab32dd | Iustin Pop | from ganeti import luxi |
38 | b33e986b | Iustin Pop | from ganeti import ssconf |
39 | 4331f6cd | Michael Hanselmann | from ganeti import rpc |
40 | 7e49b6ce | Michael Hanselmann | from ganeti import ssh |
41 | cea881e5 | Michael Hanselmann | from ganeti import compat |
42 | a744b676 | Manuel Franceschini | from ganeti import netutils |
43 | ee3aedff | Michael Hanselmann | from ganeti import qlang |
44 | a8083063 | Iustin Pop | |
45 | c38c44ad | Michael Hanselmann | from optparse import (OptionParser, TitledHelpFormatter, |
46 | 38206f3c | Iustin Pop | Option, OptionValueError) |
47 | a8083063 | Iustin Pop | |
48 | 03298ebe | Michael Hanselmann | |
49 | 4abc4f1e | Iustin Pop | __all__ = [ |
50 | 4abc4f1e | Iustin Pop | # Command line options
|
51 | fdad8c4d | Balazs Lecz | "ADD_UIDS_OPT",
|
52 | e7e09483 | Iustin Pop | "ALLOCATABLE_OPT",
|
53 | 90e99856 | Adeodato Simo | "ALLOC_POLICY_OPT",
|
54 | 2d5e7ae1 | Iustin Pop | "ALL_OPT",
|
55 | 4c61d894 | Iustin Pop | "AUTO_PROMOTE_OPT",
|
56 | e00f7a05 | Iustin Pop | "AUTO_REPLACE_OPT",
|
57 | 087ed2ed | Iustin Pop | "BACKEND_OPT",
|
58 | 61a14bb3 | Iustin Pop | "BLK_OS_OPT",
|
59 | f91e255a | Iustin Pop | "CAPAB_MASTER_OPT",
|
60 | 53919782 | Iustin Pop | "CAPAB_VM_OPT",
|
61 | baef337d | Iustin Pop | "CLEANUP_OPT",
|
62 | 3db3eb2a | Michael Hanselmann | "CLUSTER_DOMAIN_SECRET_OPT",
|
63 | 4abc4f1e | Iustin Pop | "CONFIRM_OPT",
|
64 | e32df528 | Iustin Pop | "CP_SIZE_OPT",
|
65 | 4abc4f1e | Iustin Pop | "DEBUG_OPT",
|
66 | a0c9776a | Iustin Pop | "DEBUG_SIMERR_OPT",
|
67 | 4b038a1e | Iustin Pop | "DISKIDX_OPT",
|
68 | e3876ccb | Iustin Pop | "DISK_OPT",
|
69 | 4b038a1e | Iustin Pop | "DISK_TEMPLATE_OPT",
|
70 | 771734c9 | Iustin Pop | "DRAINED_OPT",
|
71 | a0a6ff34 | Iustin Pop | "DRY_RUN_OPT",
|
72 | 26591bfd | Luca Bigliardi | "DRBD_HELPER_OPT",
|
73 | 7ea7bcf6 | Iustin Pop | "EARLY_RELEASE_OPT",
|
74 | 383a3591 | Iustin Pop | "ENABLED_HV_OPT",
|
75 | 14e9e7f3 | Iustin Pop | "ERROR_CODES_OPT",
|
76 | 4abc4f1e | Iustin Pop | "FIELDS_OPT",
|
77 | 4a25828c | Iustin Pop | "FILESTORE_DIR_OPT",
|
78 | 0f87c43e | Iustin Pop | "FILESTORE_DRIVER_OPT",
|
79 | 06073e85 | Guido Trotter | "FORCE_OPT",
|
80 | 06073e85 | Guido Trotter | "FORCE_VARIANT_OPT",
|
81 | 29392516 | Iustin Pop | "GLOBAL_FILEDIR_OPT",
|
82 | 61a14bb3 | Iustin Pop | "HID_OS_OPT",
|
83 | 073271f6 | Iustin Pop | "HVLIST_OPT",
|
84 | 48f212d7 | Iustin Pop | "HVOPTS_OPT",
|
85 | 236fd9c4 | Iustin Pop | "HYPERVISOR_OPT",
|
86 | 4eb62659 | Iustin Pop | "IALLOCATOR_OPT",
|
87 | bf4af505 | Apollon Oikonomopoulos | "DEFAULT_IALLOCATOR_OPT",
|
88 | e588764d | Iustin Pop | "IDENTIFY_DEFAULTS_OPT",
|
89 | 82a786d5 | Iustin Pop | "IGNORE_CONSIST_OPT",
|
90 | b6e841a8 | Iustin Pop | "IGNORE_FAILURES_OPT",
|
91 | b44bd844 | Michael Hanselmann | "IGNORE_OFFLINE_OPT",
|
92 | 8d8d650c | Michael Hanselmann | "IGNORE_REMOVE_FAILURES_OPT",
|
93 | ee3f9578 | Iustin Pop | "IGNORE_SECONDARIES_OPT",
|
94 | 05586c90 | Iustin Pop | "IGNORE_SIZE_OPT",
|
95 | 19b9ba9a | Michael Hanselmann | "INTERVAL_OPT",
|
96 | e3646f22 | Iustin Pop | "MAC_PREFIX_OPT",
|
97 | 3953242f | Iustin Pop | "MAINTAIN_NODE_HEALTH_OPT",
|
98 | 29392516 | Iustin Pop | "MASTER_NETDEV_OPT",
|
99 | 771734c9 | Iustin Pop | "MC_OPT",
|
100 | 783a6c0b | Iustin Pop | "MIGRATION_MODE_OPT",
|
101 | 7d3a9fab | Iustin Pop | "NET_OPT",
|
102 | 6d4a1656 | Michael Hanselmann | "NEW_CLUSTER_CERT_OPT",
|
103 | 3db3eb2a | Michael Hanselmann | "NEW_CLUSTER_DOMAIN_SECRET_OPT",
|
104 | 6b7d5878 | Michael Hanselmann | "NEW_CONFD_HMAC_KEY_OPT",
|
105 | 6d4a1656 | Michael Hanselmann | "NEW_RAPI_CERT_OPT",
|
106 | a14db5ff | Iustin Pop | "NEW_SECONDARY_OPT",
|
107 | 4fbc93dd | Iustin Pop | "NIC_PARAMS_OPT",
|
108 | 61413377 | Stephen Shirley | "NODE_FORCE_JOIN_OPT",
|
109 | 7edc4637 | Iustin Pop | "NODE_LIST_OPT",
|
110 | 990b7886 | Iustin Pop | "NODE_PLACEMENT_OPT",
|
111 | 5fbbd028 | Guido Trotter | "NODEGROUP_OPT",
|
112 | a535cef7 | René Nussbaumer | "NODE_PARAMS_OPT",
|
113 | dd94e9f6 | René Nussbaumer | "NODE_POWERED_OPT",
|
114 | 26591bfd | Luca Bigliardi | "NODRBD_STORAGE_OPT",
|
115 | 4abc4f1e | Iustin Pop | "NOHDR_OPT",
|
116 | 91e0748c | Iustin Pop | "NOIPCHECK_OPT",
|
117 | 25a8792c | Iustin Pop | "NO_INSTALL_OPT",
|
118 | 460d22be | Iustin Pop | "NONAMECHECK_OPT",
|
119 | 831040bf | Iustin Pop | "NOLVM_STORAGE_OPT",
|
120 | 29392516 | Iustin Pop | "NOMODIFY_ETCHOSTS_OPT",
|
121 | b989b9d9 | Ken Wehr | "NOMODIFY_SSH_SETUP_OPT",
|
122 | 26023ecd | Iustin Pop | "NONICS_OPT",
|
123 | f2a0828c | Iustin Pop | "NONLIVE_OPT",
|
124 | 14e9e7f3 | Iustin Pop | "NONPLUS1_OPT",
|
125 | 44c44832 | Iustin Pop | "NOSHUTDOWN_OPT",
|
126 | edeb878a | Iustin Pop | "NOSTART_OPT",
|
127 | fcdde7f2 | Iustin Pop | "NOSSH_KEYCHECK_OPT",
|
128 | 58371861 | Iustin Pop | "NOVOTING_OPT",
|
129 | 3f75b4f3 | Iustin Pop | "NWSYNC_OPT",
|
130 | a72d0a79 | Iustin Pop | "ON_PRIMARY_OPT",
|
131 | feb09e6a | Iustin Pop | "ON_SECONDARY_OPT",
|
132 | 771734c9 | Iustin Pop | "OFFLINE_OPT",
|
133 | 062a7100 | Iustin Pop | "OSPARAMS_OPT",
|
134 | d3ed23ff | Iustin Pop | "OS_OPT",
|
135 | ff00c1a7 | Iustin Pop | "OS_SIZE_OPT",
|
136 | b883637f | René Nussbaumer | "PREALLOC_WIPE_DISKS_OPT",
|
137 | e7323b5e | Manuel Franceschini | "PRIMARY_IP_VERSION_OPT",
|
138 | 84a5b33c | Michael Hanselmann | "PRIORITY_OPT",
|
139 | 6d4a1656 | Michael Hanselmann | "RAPI_CERT_OPT",
|
140 | b8d0f938 | Iustin Pop | "READD_OPT",
|
141 | 12054861 | Iustin Pop | "REBOOT_TYPE_OPT",
|
142 | 8d8d650c | Michael Hanselmann | "REMOVE_INSTANCE_OPT",
|
143 | fdad8c4d | Balazs Lecz | "REMOVE_UIDS_OPT",
|
144 | f38ea602 | Iustin Pop | "RESERVED_LVS_OPT",
|
145 | 31d97b2a | Guido Trotter | "ROMAN_OPT",
|
146 | 8d823629 | Iustin Pop | "SECONDARY_IP_OPT",
|
147 | 67840b40 | Iustin Pop | "SELECT_OS_OPT",
|
148 | 4abc4f1e | Iustin Pop | "SEP_OPT",
|
149 | fdcf4d84 | Iustin Pop | "SHOWCMD_OPT",
|
150 | 7e5eaaa8 | Guido Trotter | "SHUTDOWN_TIMEOUT_OPT",
|
151 | f36d7d81 | Iustin Pop | "SINGLE_NODE_OPT",
|
152 | df62e5db | Iustin Pop | "SRC_DIR_OPT",
|
153 | df62e5db | Iustin Pop | "SRC_NODE_OPT",
|
154 | 4abc4f1e | Iustin Pop | "SUBMIT_OPT",
|
155 | 99a8c799 | Iustin Pop | "STATIC_OPT",
|
156 | 4abc4f1e | Iustin Pop | "SYNC_OPT",
|
157 | 4abc4f1e | Iustin Pop | "TAG_SRC_OPT",
|
158 | b5762e2a | Guido Trotter | "TIMEOUT_OPT",
|
159 | 1338f2b4 | Balazs Lecz | "UIDPOOL_OPT",
|
160 | 4abc4f1e | Iustin Pop | "USEUNITS_OPT",
|
161 | 74adc100 | Iustin Pop | "USE_REPL_NET_OPT",
|
162 | 9cdb9578 | Iustin Pop | "VERBOSE_OPT",
|
163 | b58726e8 | Iustin Pop | "VG_NAME_OPT",
|
164 | 1f587d3d | Iustin Pop | "YES_DOIT_OPT",
|
165 | 4abc4f1e | Iustin Pop | # Generic functions for CLI programs
|
166 | 4abc4f1e | Iustin Pop | "GenericMain",
|
167 | d77490c5 | Iustin Pop | "GenericInstanceCreate",
|
168 | ee3aedff | Michael Hanselmann | "GenericList",
|
169 | ee3aedff | Michael Hanselmann | "GenericListFields",
|
170 | 4abc4f1e | Iustin Pop | "GetClient",
|
171 | 4abc4f1e | Iustin Pop | "GetOnlineNodes",
|
172 | 4abc4f1e | Iustin Pop | "JobExecutor",
|
173 | 4abc4f1e | Iustin Pop | "JobSubmittedException",
|
174 | 4abc4f1e | Iustin Pop | "ParseTimespec",
|
175 | 7e49b6ce | Michael Hanselmann | "RunWhileClusterStopped",
|
176 | 4abc4f1e | Iustin Pop | "SubmitOpCode",
|
177 | 4abc4f1e | Iustin Pop | "SubmitOrSend",
|
178 | 4abc4f1e | Iustin Pop | "UsesRPC",
|
179 | 4abc4f1e | Iustin Pop | # Formatting functions
|
180 | 4abc4f1e | Iustin Pop | "ToStderr", "ToStdout", |
181 | 4abc4f1e | Iustin Pop | "FormatError",
|
182 | ee3aedff | Michael Hanselmann | "FormatQueryResult",
|
183 | acd19189 | René Nussbaumer | "FormatParameterDict",
|
184 | 4abc4f1e | Iustin Pop | "GenerateTable",
|
185 | 4abc4f1e | Iustin Pop | "AskUser",
|
186 | 4abc4f1e | Iustin Pop | "FormatTimestamp",
|
187 | 8a7f1c61 | Michael Hanselmann | "FormatLogMessage",
|
188 | 4abc4f1e | Iustin Pop | # Tags functions
|
189 | 4abc4f1e | Iustin Pop | "ListTags",
|
190 | 4abc4f1e | Iustin Pop | "AddTags",
|
191 | 4abc4f1e | Iustin Pop | "RemoveTags",
|
192 | 4abc4f1e | Iustin Pop | # command line options support infrastructure
|
193 | 4abc4f1e | Iustin Pop | "ARGS_MANY_INSTANCES",
|
194 | 4abc4f1e | Iustin Pop | "ARGS_MANY_NODES",
|
195 | 667dbd6b | Adeodato Simo | "ARGS_MANY_GROUPS",
|
196 | 4abc4f1e | Iustin Pop | "ARGS_NONE",
|
197 | 4abc4f1e | Iustin Pop | "ARGS_ONE_INSTANCE",
|
198 | 4abc4f1e | Iustin Pop | "ARGS_ONE_NODE",
|
199 | 667dbd6b | Adeodato Simo | "ARGS_ONE_GROUP",
|
200 | f9faf9c3 | René Nussbaumer | "ARGS_ONE_OS",
|
201 | 4abc4f1e | Iustin Pop | "ArgChoice",
|
202 | 4abc4f1e | Iustin Pop | "ArgCommand",
|
203 | 4abc4f1e | Iustin Pop | "ArgFile",
|
204 | 667dbd6b | Adeodato Simo | "ArgGroup",
|
205 | 4abc4f1e | Iustin Pop | "ArgHost",
|
206 | 4abc4f1e | Iustin Pop | "ArgInstance",
|
207 | 4abc4f1e | Iustin Pop | "ArgJobId",
|
208 | 4abc4f1e | Iustin Pop | "ArgNode",
|
209 | f9faf9c3 | René Nussbaumer | "ArgOs",
|
210 | 4abc4f1e | Iustin Pop | "ArgSuggest",
|
211 | 4abc4f1e | Iustin Pop | "ArgUnknown",
|
212 | 4abc4f1e | Iustin Pop | "OPT_COMPL_INST_ADD_NODES",
|
213 | 4abc4f1e | Iustin Pop | "OPT_COMPL_MANY_NODES",
|
214 | 4abc4f1e | Iustin Pop | "OPT_COMPL_ONE_IALLOCATOR",
|
215 | 4abc4f1e | Iustin Pop | "OPT_COMPL_ONE_INSTANCE",
|
216 | 4abc4f1e | Iustin Pop | "OPT_COMPL_ONE_NODE",
|
217 | 36e247e1 | Guido Trotter | "OPT_COMPL_ONE_NODEGROUP",
|
218 | 4abc4f1e | Iustin Pop | "OPT_COMPL_ONE_OS",
|
219 | 4abc4f1e | Iustin Pop | "cli_option",
|
220 | 4abc4f1e | Iustin Pop | "SplitNodeOption",
|
221 | 07150497 | Guido Trotter | "CalculateOSNames",
|
222 | a4ebd726 | Michael Hanselmann | "ParseFields",
|
223 | eb28ecf6 | Guido Trotter | "COMMON_CREATE_OPTS",
|
224 | 4abc4f1e | Iustin Pop | ] |
225 | 846baef9 | Iustin Pop | |
226 | 8b46606c | Guido Trotter | NO_PREFIX = "no_"
|
227 | 8b46606c | Guido Trotter | UN_PREFIX = "-"
|
228 | 846baef9 | Iustin Pop | |
229 | 84a5b33c | Michael Hanselmann | #: Priorities (sorted)
|
230 | 84a5b33c | Michael Hanselmann | _PRIORITY_NAMES = [ |
231 | 84a5b33c | Michael Hanselmann | ("low", constants.OP_PRIO_LOW),
|
232 | 84a5b33c | Michael Hanselmann | ("normal", constants.OP_PRIO_NORMAL),
|
233 | 84a5b33c | Michael Hanselmann | ("high", constants.OP_PRIO_HIGH),
|
234 | 84a5b33c | Michael Hanselmann | ] |
235 | 84a5b33c | Michael Hanselmann | |
236 | 84a5b33c | Michael Hanselmann | #: Priority dictionary for easier lookup
|
237 | 84a5b33c | Michael Hanselmann | # TODO: Replace this and _PRIORITY_NAMES with a single sorted dictionary once
|
238 | 84a5b33c | Michael Hanselmann | # we migrate to Python 2.6
|
239 | 84a5b33c | Michael Hanselmann | _PRIONAME_TO_VALUE = dict(_PRIORITY_NAMES)
|
240 | 84a5b33c | Michael Hanselmann | |
241 | ee3aedff | Michael Hanselmann | # Query result status for clients
|
242 | ee3aedff | Michael Hanselmann | (QR_NORMAL, |
243 | ee3aedff | Michael Hanselmann | QR_UNKNOWN, |
244 | ee3aedff | Michael Hanselmann | QR_INCOMPLETE) = range(3) |
245 | ee3aedff | Michael Hanselmann | |
246 | 03298ebe | Michael Hanselmann | |
247 | 863d7f46 | Michael Hanselmann | class _Argument: |
248 | 7260cfbe | Iustin Pop | def __init__(self, min=0, max=None): # pylint: disable-msg=W0622 |
249 | 863d7f46 | Michael Hanselmann | self.min = min |
250 | 863d7f46 | Michael Hanselmann | self.max = max |
251 | 863d7f46 | Michael Hanselmann | |
252 | 863d7f46 | Michael Hanselmann | def __repr__(self): |
253 | 863d7f46 | Michael Hanselmann | return ("<%s min=%s max=%s>" % |
254 | 863d7f46 | Michael Hanselmann | (self.__class__.__name__, self.min, self.max)) |
255 | 863d7f46 | Michael Hanselmann | |
256 | 863d7f46 | Michael Hanselmann | |
257 | 863d7f46 | Michael Hanselmann | class ArgSuggest(_Argument): |
258 | 863d7f46 | Michael Hanselmann | """Suggesting argument.
|
259 | 863d7f46 | Michael Hanselmann |
|
260 | 863d7f46 | Michael Hanselmann | Value can be any of the ones passed to the constructor.
|
261 | 863d7f46 | Michael Hanselmann |
|
262 | 863d7f46 | Michael Hanselmann | """
|
263 | 7260cfbe | Iustin Pop | # pylint: disable-msg=W0622
|
264 | 863d7f46 | Michael Hanselmann | def __init__(self, min=0, max=None, choices=None): |
265 | 863d7f46 | Michael Hanselmann | _Argument.__init__(self, min=min, max=max) |
266 | 863d7f46 | Michael Hanselmann | self.choices = choices
|
267 | 863d7f46 | Michael Hanselmann | |
268 | 863d7f46 | Michael Hanselmann | def __repr__(self): |
269 | 863d7f46 | Michael Hanselmann | return ("<%s min=%s max=%s choices=%r>" % |
270 | 863d7f46 | Michael Hanselmann | (self.__class__.__name__, self.min, self.max, self.choices)) |
271 | 863d7f46 | Michael Hanselmann | |
272 | 863d7f46 | Michael Hanselmann | |
273 | 863d7f46 | Michael Hanselmann | class ArgChoice(ArgSuggest): |
274 | 863d7f46 | Michael Hanselmann | """Choice argument.
|
275 | 863d7f46 | Michael Hanselmann |
|
276 | 863d7f46 | Michael Hanselmann | Value can be any of the ones passed to the constructor. Like L{ArgSuggest},
|
277 | 863d7f46 | Michael Hanselmann | but value must be one of the choices.
|
278 | 863d7f46 | Michael Hanselmann |
|
279 | 863d7f46 | Michael Hanselmann | """
|
280 | 863d7f46 | Michael Hanselmann | |
281 | 863d7f46 | Michael Hanselmann | |
282 | 863d7f46 | Michael Hanselmann | class ArgUnknown(_Argument): |
283 | 863d7f46 | Michael Hanselmann | """Unknown argument to program (e.g. determined at runtime).
|
284 | 863d7f46 | Michael Hanselmann |
|
285 | 863d7f46 | Michael Hanselmann | """
|
286 | 863d7f46 | Michael Hanselmann | |
287 | 863d7f46 | Michael Hanselmann | |
288 | 863d7f46 | Michael Hanselmann | class ArgInstance(_Argument): |
289 | 863d7f46 | Michael Hanselmann | """Instances argument.
|
290 | 863d7f46 | Michael Hanselmann |
|
291 | 863d7f46 | Michael Hanselmann | """
|
292 | 863d7f46 | Michael Hanselmann | |
293 | 863d7f46 | Michael Hanselmann | |
294 | 863d7f46 | Michael Hanselmann | class ArgNode(_Argument): |
295 | 863d7f46 | Michael Hanselmann | """Node argument.
|
296 | 863d7f46 | Michael Hanselmann |
|
297 | 863d7f46 | Michael Hanselmann | """
|
298 | 863d7f46 | Michael Hanselmann | |
299 | 667dbd6b | Adeodato Simo | |
300 | 667dbd6b | Adeodato Simo | class ArgGroup(_Argument): |
301 | 667dbd6b | Adeodato Simo | """Node group argument.
|
302 | 667dbd6b | Adeodato Simo |
|
303 | 667dbd6b | Adeodato Simo | """
|
304 | 667dbd6b | Adeodato Simo | |
305 | 667dbd6b | Adeodato Simo | |
306 | 863d7f46 | Michael Hanselmann | class ArgJobId(_Argument): |
307 | 863d7f46 | Michael Hanselmann | """Job ID argument.
|
308 | 863d7f46 | Michael Hanselmann |
|
309 | 863d7f46 | Michael Hanselmann | """
|
310 | 863d7f46 | Michael Hanselmann | |
311 | 863d7f46 | Michael Hanselmann | |
312 | 863d7f46 | Michael Hanselmann | class ArgFile(_Argument): |
313 | 863d7f46 | Michael Hanselmann | """File path argument.
|
314 | 863d7f46 | Michael Hanselmann |
|
315 | 863d7f46 | Michael Hanselmann | """
|
316 | 863d7f46 | Michael Hanselmann | |
317 | 863d7f46 | Michael Hanselmann | |
318 | 863d7f46 | Michael Hanselmann | class ArgCommand(_Argument): |
319 | 863d7f46 | Michael Hanselmann | """Command argument.
|
320 | 863d7f46 | Michael Hanselmann |
|
321 | 863d7f46 | Michael Hanselmann | """
|
322 | 863d7f46 | Michael Hanselmann | |
323 | 863d7f46 | Michael Hanselmann | |
324 | 83ec7961 | Michael Hanselmann | class ArgHost(_Argument): |
325 | 83ec7961 | Michael Hanselmann | """Host argument.
|
326 | 83ec7961 | Michael Hanselmann |
|
327 | 83ec7961 | Michael Hanselmann | """
|
328 | 83ec7961 | Michael Hanselmann | |
329 | 83ec7961 | Michael Hanselmann | |
330 | f9faf9c3 | René Nussbaumer | class ArgOs(_Argument): |
331 | f9faf9c3 | René Nussbaumer | """OS argument.
|
332 | f9faf9c3 | René Nussbaumer |
|
333 | f9faf9c3 | René Nussbaumer | """
|
334 | f9faf9c3 | René Nussbaumer | |
335 | f9faf9c3 | René Nussbaumer | |
336 | 4a265c08 | Michael Hanselmann | ARGS_NONE = [] |
337 | 4a265c08 | Michael Hanselmann | ARGS_MANY_INSTANCES = [ArgInstance()] |
338 | 4a265c08 | Michael Hanselmann | ARGS_MANY_NODES = [ArgNode()] |
339 | 667dbd6b | Adeodato Simo | ARGS_MANY_GROUPS = [ArgGroup()] |
340 | 4a265c08 | Michael Hanselmann | ARGS_ONE_INSTANCE = [ArgInstance(min=1, max=1)] |
341 | 4a265c08 | Michael Hanselmann | ARGS_ONE_NODE = [ArgNode(min=1, max=1)] |
342 | dadf6b7d | Michael Hanselmann | # TODO
|
343 | dadf6b7d | Michael Hanselmann | ARGS_ONE_GROUP = [ArgGroup(min=1, max=1)] |
344 | f9faf9c3 | René Nussbaumer | ARGS_ONE_OS = [ArgOs(min=1, max=1)] |
345 | 4a265c08 | Michael Hanselmann | |
346 | 4a265c08 | Michael Hanselmann | |
347 | 846baef9 | Iustin Pop | def _ExtractTagsObject(opts, args): |
348 | 846baef9 | Iustin Pop | """Extract the tag type object.
|
349 | 846baef9 | Iustin Pop |
|
350 | 846baef9 | Iustin Pop | Note that this function will modify its args parameter.
|
351 | 846baef9 | Iustin Pop |
|
352 | 846baef9 | Iustin Pop | """
|
353 | 846baef9 | Iustin Pop | if not hasattr(opts, "tag_type"): |
354 | 846baef9 | Iustin Pop | raise errors.ProgrammerError("tag_type not passed to _ExtractTagsObject") |
355 | 846baef9 | Iustin Pop | kind = opts.tag_type |
356 | 846baef9 | Iustin Pop | if kind == constants.TAG_CLUSTER:
|
357 | 846baef9 | Iustin Pop | retval = kind, kind |
358 | 846baef9 | Iustin Pop | elif kind == constants.TAG_NODE or kind == constants.TAG_INSTANCE: |
359 | 846baef9 | Iustin Pop | if not args: |
360 | 0c434948 | Iustin Pop | raise errors.OpPrereqError("no arguments passed to the command") |
361 | 846baef9 | Iustin Pop | name = args.pop(0)
|
362 | 846baef9 | Iustin Pop | retval = kind, name |
363 | 846baef9 | Iustin Pop | else:
|
364 | 846baef9 | Iustin Pop | raise errors.ProgrammerError("Unhandled tag type '%s'" % kind) |
365 | 846baef9 | Iustin Pop | return retval
|
366 | 846baef9 | Iustin Pop | |
367 | 846baef9 | Iustin Pop | |
368 | 810c50b7 | Iustin Pop | def _ExtendTags(opts, args): |
369 | 810c50b7 | Iustin Pop | """Extend the args if a source file has been given.
|
370 | 810c50b7 | Iustin Pop |
|
371 | 810c50b7 | Iustin Pop | This function will extend the tags with the contents of the file
|
372 | 810c50b7 | Iustin Pop | passed in the 'tags_source' attribute of the opts parameter. A file
|
373 | 810c50b7 | Iustin Pop | named '-' will be replaced by stdin.
|
374 | 810c50b7 | Iustin Pop |
|
375 | 810c50b7 | Iustin Pop | """
|
376 | 810c50b7 | Iustin Pop | fname = opts.tags_source |
377 | 810c50b7 | Iustin Pop | if fname is None: |
378 | 810c50b7 | Iustin Pop | return
|
379 | 810c50b7 | Iustin Pop | if fname == "-": |
380 | 810c50b7 | Iustin Pop | new_fh = sys.stdin |
381 | 810c50b7 | Iustin Pop | else:
|
382 | 810c50b7 | Iustin Pop | new_fh = open(fname, "r") |
383 | 810c50b7 | Iustin Pop | new_data = [] |
384 | 810c50b7 | Iustin Pop | try:
|
385 | 810c50b7 | Iustin Pop | # we don't use the nice 'new_data = [line.strip() for line in fh]'
|
386 | 810c50b7 | Iustin Pop | # because of python bug 1633941
|
387 | 810c50b7 | Iustin Pop | while True: |
388 | 810c50b7 | Iustin Pop | line = new_fh.readline() |
389 | 810c50b7 | Iustin Pop | if not line: |
390 | 810c50b7 | Iustin Pop | break
|
391 | 810c50b7 | Iustin Pop | new_data.append(line.strip()) |
392 | 810c50b7 | Iustin Pop | finally:
|
393 | 810c50b7 | Iustin Pop | new_fh.close() |
394 | 810c50b7 | Iustin Pop | args.extend(new_data) |
395 | 810c50b7 | Iustin Pop | |
396 | 810c50b7 | Iustin Pop | |
397 | 846baef9 | Iustin Pop | def ListTags(opts, args): |
398 | 846baef9 | Iustin Pop | """List the tags on a given object.
|
399 | 846baef9 | Iustin Pop |
|
400 | 846baef9 | Iustin Pop | This is a generic implementation that knows how to deal with all
|
401 | 846baef9 | Iustin Pop | three cases of tag objects (cluster, node, instance). The opts
|
402 | 846baef9 | Iustin Pop | argument is expected to contain a tag_type field denoting what
|
403 | 846baef9 | Iustin Pop | object type we work on.
|
404 | 846baef9 | Iustin Pop |
|
405 | 846baef9 | Iustin Pop | """
|
406 | 846baef9 | Iustin Pop | kind, name = _ExtractTagsObject(opts, args) |
407 | 7699c3af | Iustin Pop | cl = GetClient() |
408 | 7699c3af | Iustin Pop | result = cl.QueryTags(kind, name) |
409 | 846baef9 | Iustin Pop | result = list(result)
|
410 | 846baef9 | Iustin Pop | result.sort() |
411 | 846baef9 | Iustin Pop | for tag in result: |
412 | 03298ebe | Michael Hanselmann | ToStdout(tag) |
413 | 846baef9 | Iustin Pop | |
414 | 846baef9 | Iustin Pop | |
415 | 846baef9 | Iustin Pop | def AddTags(opts, args): |
416 | 846baef9 | Iustin Pop | """Add tags on a given object.
|
417 | 846baef9 | Iustin Pop |
|
418 | 846baef9 | Iustin Pop | This is a generic implementation that knows how to deal with all
|
419 | 846baef9 | Iustin Pop | three cases of tag objects (cluster, node, instance). The opts
|
420 | 846baef9 | Iustin Pop | argument is expected to contain a tag_type field denoting what
|
421 | 846baef9 | Iustin Pop | object type we work on.
|
422 | 846baef9 | Iustin Pop |
|
423 | 846baef9 | Iustin Pop | """
|
424 | 846baef9 | Iustin Pop | kind, name = _ExtractTagsObject(opts, args) |
425 | 810c50b7 | Iustin Pop | _ExtendTags(opts, args) |
426 | 846baef9 | Iustin Pop | if not args: |
427 | 846baef9 | Iustin Pop | raise errors.OpPrereqError("No tags to be added") |
428 | d1602edc | Iustin Pop | op = opcodes.OpTagsSet(kind=kind, name=name, tags=args) |
429 | af1a81d1 | Michael Hanselmann | SubmitOpCode(op, opts=opts) |
430 | 846baef9 | Iustin Pop | |
431 | 846baef9 | Iustin Pop | |
432 | 846baef9 | Iustin Pop | def RemoveTags(opts, args): |
433 | 846baef9 | Iustin Pop | """Remove tags from a given object.
|
434 | 846baef9 | Iustin Pop |
|
435 | 846baef9 | Iustin Pop | This is a generic implementation that knows how to deal with all
|
436 | 846baef9 | Iustin Pop | three cases of tag objects (cluster, node, instance). The opts
|
437 | 846baef9 | Iustin Pop | argument is expected to contain a tag_type field denoting what
|
438 | 846baef9 | Iustin Pop | object type we work on.
|
439 | 846baef9 | Iustin Pop |
|
440 | 846baef9 | Iustin Pop | """
|
441 | 846baef9 | Iustin Pop | kind, name = _ExtractTagsObject(opts, args) |
442 | 810c50b7 | Iustin Pop | _ExtendTags(opts, args) |
443 | 846baef9 | Iustin Pop | if not args: |
444 | 846baef9 | Iustin Pop | raise errors.OpPrereqError("No tags to be removed") |
445 | 3f0ab95f | Iustin Pop | op = opcodes.OpTagsDel(kind=kind, name=name, tags=args) |
446 | af1a81d1 | Michael Hanselmann | SubmitOpCode(op, opts=opts) |
447 | 846baef9 | Iustin Pop | |
448 | a8083063 | Iustin Pop | |
449 | 8929d28c | Iustin Pop | def check_unit(option, opt, value): # pylint: disable-msg=W0613 |
450 | 65fe4693 | Iustin Pop | """OptParsers custom converter for units.
|
451 | 65fe4693 | Iustin Pop |
|
452 | 65fe4693 | Iustin Pop | """
|
453 | a8083063 | Iustin Pop | try:
|
454 | a8083063 | Iustin Pop | return utils.ParseUnit(value)
|
455 | a8083063 | Iustin Pop | except errors.UnitParseError, err:
|
456 | 3ecf6786 | Iustin Pop | raise OptionValueError("option %s: %s" % (opt, err)) |
457 | a8083063 | Iustin Pop | |
458 | a8083063 | Iustin Pop | |
459 | a8469393 | Iustin Pop | def _SplitKeyVal(opt, data): |
460 | a8469393 | Iustin Pop | """Convert a KeyVal string into a dict.
|
461 | a8469393 | Iustin Pop |
|
462 | a8469393 | Iustin Pop | This function will convert a key=val[,...] string into a dict. Empty
|
463 | a8469393 | Iustin Pop | values will be converted specially: keys which have the prefix 'no_'
|
464 | a8469393 | Iustin Pop | will have the value=False and the prefix stripped, the others will
|
465 | a8469393 | Iustin Pop | have value=True.
|
466 | a8469393 | Iustin Pop |
|
467 | a8469393 | Iustin Pop | @type opt: string
|
468 | a8469393 | Iustin Pop | @param opt: a string holding the option name for which we process the
|
469 | a8469393 | Iustin Pop | data, used in building error messages
|
470 | a8469393 | Iustin Pop | @type data: string
|
471 | a8469393 | Iustin Pop | @param data: a string of the format key=val,key=val,...
|
472 | a8469393 | Iustin Pop | @rtype: dict
|
473 | a8469393 | Iustin Pop | @return: {key=val, key=val}
|
474 | a8469393 | Iustin Pop | @raises errors.ParameterError: if there are duplicate keys
|
475 | a8469393 | Iustin Pop |
|
476 | a8469393 | Iustin Pop | """
|
477 | a8469393 | Iustin Pop | kv_dict = {} |
478 | 4f31882e | Guido Trotter | if data:
|
479 | 1b3a7656 | Iustin Pop | for elem in utils.UnescapeAndSplit(data, sep=","): |
480 | 4f31882e | Guido Trotter | if "=" in elem: |
481 | 4f31882e | Guido Trotter | key, val = elem.split("=", 1) |
482 | a8469393 | Iustin Pop | else:
|
483 | 4f31882e | Guido Trotter | if elem.startswith(NO_PREFIX):
|
484 | 4f31882e | Guido Trotter | key, val = elem[len(NO_PREFIX):], False |
485 | 4f31882e | Guido Trotter | elif elem.startswith(UN_PREFIX):
|
486 | 4f31882e | Guido Trotter | key, val = elem[len(UN_PREFIX):], None |
487 | 4f31882e | Guido Trotter | else:
|
488 | 4f31882e | Guido Trotter | key, val = elem, True
|
489 | 4f31882e | Guido Trotter | if key in kv_dict: |
490 | 4f31882e | Guido Trotter | raise errors.ParameterError("Duplicate key '%s' in option %s" % |
491 | 4f31882e | Guido Trotter | (key, opt)) |
492 | 4f31882e | Guido Trotter | kv_dict[key] = val |
493 | a8469393 | Iustin Pop | return kv_dict
|
494 | a8469393 | Iustin Pop | |
495 | a8469393 | Iustin Pop | |
496 | 8929d28c | Iustin Pop | def check_ident_key_val(option, opt, value): # pylint: disable-msg=W0613 |
497 | 552c8dff | Michael Hanselmann | """Custom parser for ident:key=val,key=val options.
|
498 | 552c8dff | Michael Hanselmann |
|
499 | 552c8dff | Michael Hanselmann | This will store the parsed values as a tuple (ident, {key: val}). As such,
|
500 | 552c8dff | Michael Hanselmann | multiple uses of this option via action=append is possible.
|
501 | a8469393 | Iustin Pop |
|
502 | a8469393 | Iustin Pop | """
|
503 | a8469393 | Iustin Pop | if ":" not in value: |
504 | 8b46606c | Guido Trotter | ident, rest = value, ''
|
505 | a8469393 | Iustin Pop | else:
|
506 | a8469393 | Iustin Pop | ident, rest = value.split(":", 1) |
507 | 8b46606c | Guido Trotter | |
508 | 8b46606c | Guido Trotter | if ident.startswith(NO_PREFIX):
|
509 | 8b46606c | Guido Trotter | if rest:
|
510 | 8b46606c | Guido Trotter | msg = "Cannot pass options when removing parameter groups: %s" % value
|
511 | 8b46606c | Guido Trotter | raise errors.ParameterError(msg)
|
512 | 8b46606c | Guido Trotter | retval = (ident[len(NO_PREFIX):], False) |
513 | 8b46606c | Guido Trotter | elif ident.startswith(UN_PREFIX):
|
514 | 8b46606c | Guido Trotter | if rest:
|
515 | 8b46606c | Guido Trotter | msg = "Cannot pass options when removing parameter groups: %s" % value
|
516 | 8b46606c | Guido Trotter | raise errors.ParameterError(msg)
|
517 | 8b46606c | Guido Trotter | retval = (ident[len(UN_PREFIX):], None) |
518 | 8b46606c | Guido Trotter | else:
|
519 | a8469393 | Iustin Pop | kv_dict = _SplitKeyVal(opt, rest) |
520 | a8469393 | Iustin Pop | retval = (ident, kv_dict) |
521 | a8469393 | Iustin Pop | return retval
|
522 | a8469393 | Iustin Pop | |
523 | a8469393 | Iustin Pop | |
524 | 8929d28c | Iustin Pop | def check_key_val(option, opt, value): # pylint: disable-msg=W0613 |
525 | 552c8dff | Michael Hanselmann | """Custom parser class for key=val,key=val options.
|
526 | 552c8dff | Michael Hanselmann |
|
527 | 552c8dff | Michael Hanselmann | This will store the parsed values as a dict {key: val}.
|
528 | a8469393 | Iustin Pop |
|
529 | a8469393 | Iustin Pop | """
|
530 | a8469393 | Iustin Pop | return _SplitKeyVal(opt, value)
|
531 | a8469393 | Iustin Pop | |
532 | a8469393 | Iustin Pop | |
533 | e7b61bb0 | Iustin Pop | def check_bool(option, opt, value): # pylint: disable-msg=W0613 |
534 | e7b61bb0 | Iustin Pop | """Custom parser for yes/no options.
|
535 | e7b61bb0 | Iustin Pop |
|
536 | e7b61bb0 | Iustin Pop | This will store the parsed value as either True or False.
|
537 | e7b61bb0 | Iustin Pop |
|
538 | e7b61bb0 | Iustin Pop | """
|
539 | e7b61bb0 | Iustin Pop | value = value.lower() |
540 | e7b61bb0 | Iustin Pop | if value == constants.VALUE_FALSE or value == "no": |
541 | e7b61bb0 | Iustin Pop | return False |
542 | e7b61bb0 | Iustin Pop | elif value == constants.VALUE_TRUE or value == "yes": |
543 | e7b61bb0 | Iustin Pop | return True |
544 | e7b61bb0 | Iustin Pop | else:
|
545 | e7b61bb0 | Iustin Pop | raise errors.ParameterError("Invalid boolean value '%s'" % value) |
546 | e7b61bb0 | Iustin Pop | |
547 | e7b61bb0 | Iustin Pop | |
548 | 63d44c55 | Michael Hanselmann | # completion_suggestion is normally a list. Using numeric values not evaluating
|
549 | 63d44c55 | Michael Hanselmann | # to False for dynamic completion.
|
550 | 63d44c55 | Michael Hanselmann | (OPT_COMPL_MANY_NODES, |
551 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_NODE, |
552 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_INSTANCE, |
553 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_OS, |
554 | 2d3ed64b | Michael Hanselmann | OPT_COMPL_ONE_IALLOCATOR, |
555 | 36e247e1 | Guido Trotter | OPT_COMPL_INST_ADD_NODES, |
556 | 36e247e1 | Guido Trotter | OPT_COMPL_ONE_NODEGROUP) = range(100, 107) |
557 | 63d44c55 | Michael Hanselmann | |
558 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ALL = frozenset([
|
559 | 63d44c55 | Michael Hanselmann | OPT_COMPL_MANY_NODES, |
560 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_NODE, |
561 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_INSTANCE, |
562 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_OS, |
563 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_IALLOCATOR, |
564 | 2d3ed64b | Michael Hanselmann | OPT_COMPL_INST_ADD_NODES, |
565 | 36e247e1 | Guido Trotter | OPT_COMPL_ONE_NODEGROUP, |
566 | 63d44c55 | Michael Hanselmann | ]) |
567 | 63d44c55 | Michael Hanselmann | |
568 | 63d44c55 | Michael Hanselmann | |
569 | 552c8dff | Michael Hanselmann | class CliOption(Option): |
570 | 552c8dff | Michael Hanselmann | """Custom option class for optparse.
|
571 | a8469393 | Iustin Pop |
|
572 | a8469393 | Iustin Pop | """
|
573 | 863d7f46 | Michael Hanselmann | ATTRS = Option.ATTRS + [ |
574 | 863d7f46 | Michael Hanselmann | "completion_suggest",
|
575 | 863d7f46 | Michael Hanselmann | ] |
576 | 552c8dff | Michael Hanselmann | TYPES = Option.TYPES + ( |
577 | 552c8dff | Michael Hanselmann | "identkeyval",
|
578 | 552c8dff | Michael Hanselmann | "keyval",
|
579 | 552c8dff | Michael Hanselmann | "unit",
|
580 | e7b61bb0 | Iustin Pop | "bool",
|
581 | 552c8dff | Michael Hanselmann | ) |
582 | 552c8dff | Michael Hanselmann | TYPE_CHECKER = Option.TYPE_CHECKER.copy() |
583 | 552c8dff | Michael Hanselmann | TYPE_CHECKER["identkeyval"] = check_ident_key_val
|
584 | a8469393 | Iustin Pop | TYPE_CHECKER["keyval"] = check_key_val
|
585 | 552c8dff | Michael Hanselmann | TYPE_CHECKER["unit"] = check_unit
|
586 | e7b61bb0 | Iustin Pop | TYPE_CHECKER["bool"] = check_bool
|
587 | a8469393 | Iustin Pop | |
588 | a8469393 | Iustin Pop | |
589 | a8083063 | Iustin Pop | # optparse.py sets make_option, so we do it for our own option class, too
|
590 | a8083063 | Iustin Pop | cli_option = CliOption |
591 | a8083063 | Iustin Pop | |
592 | a8083063 | Iustin Pop | |
593 | 771734c9 | Iustin Pop | _YORNO = "yes|no"
|
594 | 771734c9 | Iustin Pop | |
595 | ea34193f | Iustin Pop | DEBUG_OPT = cli_option("-d", "--debug", default=0, action="count", |
596 | ea34193f | Iustin Pop | help="Increase debugging level")
|
597 | c38c44ad | Michael Hanselmann | |
598 | c38c44ad | Michael Hanselmann | NOHDR_OPT = cli_option("--no-headers", default=False, |
599 | c38c44ad | Michael Hanselmann | action="store_true", dest="no_headers", |
600 | c38c44ad | Michael Hanselmann | help="Don't display column headers")
|
601 | c38c44ad | Michael Hanselmann | |
602 | c38c44ad | Michael Hanselmann | SEP_OPT = cli_option("--separator", default=None, |
603 | c38c44ad | Michael Hanselmann | action="store", dest="separator", |
604 | c38c44ad | Michael Hanselmann | help=("Separator between output fields"
|
605 | c38c44ad | Michael Hanselmann | " (defaults to one space)"))
|
606 | c38c44ad | Michael Hanselmann | |
607 | c38c44ad | Michael Hanselmann | USEUNITS_OPT = cli_option("--units", default=None, |
608 | c38c44ad | Michael Hanselmann | dest="units", choices=('h', 'm', 'g', 't'), |
609 | b714765a | Adeodato Simo | help="Specify units for output (one of h/m/g/t)")
|
610 | c38c44ad | Michael Hanselmann | |
611 | c38c44ad | Michael Hanselmann | FIELDS_OPT = cli_option("-o", "--output", dest="output", action="store", |
612 | c38c44ad | Michael Hanselmann | type="string", metavar="FIELDS", |
613 | c38c44ad | Michael Hanselmann | help="Comma separated list of output fields")
|
614 | c38c44ad | Michael Hanselmann | |
615 | c38c44ad | Michael Hanselmann | FORCE_OPT = cli_option("-f", "--force", dest="force", action="store_true", |
616 | c38c44ad | Michael Hanselmann | default=False, help="Force the operation") |
617 | c38c44ad | Michael Hanselmann | |
618 | c38c44ad | Michael Hanselmann | CONFIRM_OPT = cli_option("--yes", dest="confirm", action="store_true", |
619 | c38c44ad | Michael Hanselmann | default=False, help="Do not require confirmation") |
620 | c38c44ad | Michael Hanselmann | |
621 | b44bd844 | Michael Hanselmann | IGNORE_OFFLINE_OPT = cli_option("--ignore-offline", dest="ignore_offline", |
622 | b44bd844 | Michael Hanselmann | action="store_true", default=False, |
623 | b44bd844 | Michael Hanselmann | help=("Ignore offline nodes and do as much"
|
624 | b44bd844 | Michael Hanselmann | " as possible"))
|
625 | b44bd844 | Michael Hanselmann | |
626 | c38c44ad | Michael Hanselmann | TAG_SRC_OPT = cli_option("--from", dest="tags_source", |
627 | c38c44ad | Michael Hanselmann | default=None, help="File with tag names") |
628 | c38c44ad | Michael Hanselmann | |
629 | c38c44ad | Michael Hanselmann | SUBMIT_OPT = cli_option("--submit", dest="submit_only", |
630 | c38c44ad | Michael Hanselmann | default=False, action="store_true", |
631 | c38c44ad | Michael Hanselmann | help=("Submit the job and return the job ID, but"
|
632 | c38c44ad | Michael Hanselmann | " don't wait for the job to finish"))
|
633 | c38c44ad | Michael Hanselmann | |
634 | c38c44ad | Michael Hanselmann | SYNC_OPT = cli_option("--sync", dest="do_locking", |
635 | c38c44ad | Michael Hanselmann | default=False, action="store_true", |
636 | c38c44ad | Michael Hanselmann | help=("Grab locks while doing the queries"
|
637 | c38c44ad | Michael Hanselmann | " in order to ensure more consistent results"))
|
638 | c38c44ad | Michael Hanselmann | |
639 | a0a6ff34 | Iustin Pop | DRY_RUN_OPT = cli_option("--dry-run", default=False, |
640 | a0a6ff34 | Iustin Pop | action="store_true",
|
641 | a0a6ff34 | Iustin Pop | help=("Do not execute the operation, just run the"
|
642 | a0a6ff34 | Iustin Pop | " check steps and verify it it could be"
|
643 | a0a6ff34 | Iustin Pop | " executed"))
|
644 | c38c44ad | Michael Hanselmann | |
645 | 9cdb9578 | Iustin Pop | VERBOSE_OPT = cli_option("-v", "--verbose", default=False, |
646 | 9cdb9578 | Iustin Pop | action="store_true",
|
647 | 9cdb9578 | Iustin Pop | help="Increase the verbosity of the operation")
|
648 | 9cdb9578 | Iustin Pop | |
649 | a0c9776a | Iustin Pop | DEBUG_SIMERR_OPT = cli_option("--debug-simulate-errors", default=False, |
650 | a0c9776a | Iustin Pop | action="store_true", dest="simulate_errors", |
651 | a0c9776a | Iustin Pop | help="Debugging option that makes the operation"
|
652 | a0c9776a | Iustin Pop | " treat most runtime checks as failed")
|
653 | a0c9776a | Iustin Pop | |
654 | 3f75b4f3 | Iustin Pop | NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync", |
655 | 3f75b4f3 | Iustin Pop | default=True, action="store_false", |
656 | 3f75b4f3 | Iustin Pop | help="Don't wait for sync (DANGEROUS!)")
|
657 | 3f75b4f3 | Iustin Pop | |
658 | 4f365444 | Iustin Pop | DISK_TEMPLATE_OPT = cli_option("-t", "--disk-template", dest="disk_template", |
659 | 4f365444 | Iustin Pop | help="Custom disk setup (diskless, file,"
|
660 | 4f365444 | Iustin Pop | " plain or drbd)",
|
661 | 4f365444 | Iustin Pop | default=None, metavar="TEMPL", |
662 | 4f365444 | Iustin Pop | choices=list(constants.DISK_TEMPLATES))
|
663 | 4f365444 | Iustin Pop | |
664 | 26023ecd | Iustin Pop | NONICS_OPT = cli_option("--no-nics", default=False, action="store_true", |
665 | 26023ecd | Iustin Pop | help="Do not create any network cards for"
|
666 | 26023ecd | Iustin Pop | " the instance")
|
667 | 26023ecd | Iustin Pop | |
668 | 4a25828c | Iustin Pop | FILESTORE_DIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir", |
669 | 4a25828c | Iustin Pop | help="Relative path under default cluster-wide"
|
670 | 4a25828c | Iustin Pop | " file storage dir to store file-based disks",
|
671 | 4a25828c | Iustin Pop | default=None, metavar="<DIR>") |
672 | 4a25828c | Iustin Pop | |
673 | 0f87c43e | Iustin Pop | FILESTORE_DRIVER_OPT = cli_option("--file-driver", dest="file_driver", |
674 | 0f87c43e | Iustin Pop | help="Driver to use for image files",
|
675 | 0f87c43e | Iustin Pop | default="loop", metavar="<DRIVER>", |
676 | 0f87c43e | Iustin Pop | choices=list(constants.FILE_DRIVER))
|
677 | 0f87c43e | Iustin Pop | |
678 | 4eb62659 | Iustin Pop | IALLOCATOR_OPT = cli_option("-I", "--iallocator", metavar="<NAME>", |
679 | 4eb62659 | Iustin Pop | help="Select nodes for the instance automatically"
|
680 | 4eb62659 | Iustin Pop | " using the <NAME> iallocator plugin",
|
681 | 4eb62659 | Iustin Pop | default=None, type="string", |
682 | 4eb62659 | Iustin Pop | completion_suggest=OPT_COMPL_ONE_IALLOCATOR) |
683 | 4eb62659 | Iustin Pop | |
684 | bf4af505 | Apollon Oikonomopoulos | DEFAULT_IALLOCATOR_OPT = cli_option("-I", "--default-iallocator", |
685 | bf4af505 | Apollon Oikonomopoulos | metavar="<NAME>",
|
686 | bf4af505 | Apollon Oikonomopoulos | help="Set the default instance allocator plugin",
|
687 | bf4af505 | Apollon Oikonomopoulos | default=None, type="string", |
688 | bf4af505 | Apollon Oikonomopoulos | completion_suggest=OPT_COMPL_ONE_IALLOCATOR) |
689 | bf4af505 | Apollon Oikonomopoulos | |
690 | d3ed23ff | Iustin Pop | OS_OPT = cli_option("-o", "--os-type", dest="os", help="What OS to run", |
691 | d3ed23ff | Iustin Pop | metavar="<os>",
|
692 | d3ed23ff | Iustin Pop | completion_suggest=OPT_COMPL_ONE_OS) |
693 | d3ed23ff | Iustin Pop | |
694 | 062a7100 | Iustin Pop | OSPARAMS_OPT = cli_option("-O", "--os-parameters", dest="osparams", |
695 | 062a7100 | Iustin Pop | type="keyval", default={},
|
696 | 062a7100 | Iustin Pop | help="OS parameters")
|
697 | 062a7100 | Iustin Pop | |
698 | 06073e85 | Guido Trotter | FORCE_VARIANT_OPT = cli_option("--force-variant", dest="force_variant", |
699 | 06073e85 | Guido Trotter | action="store_true", default=False, |
700 | 06073e85 | Guido Trotter | help="Force an unknown variant")
|
701 | 06073e85 | Guido Trotter | |
702 | 25a8792c | Iustin Pop | NO_INSTALL_OPT = cli_option("--no-install", dest="no_install", |
703 | 25a8792c | Iustin Pop | action="store_true", default=False, |
704 | 25a8792c | Iustin Pop | help="Do not install the OS (will"
|
705 | 25a8792c | Iustin Pop | " enable no-start)")
|
706 | 25a8792c | Iustin Pop | |
707 | 087ed2ed | Iustin Pop | BACKEND_OPT = cli_option("-B", "--backend-parameters", dest="beparams", |
708 | 087ed2ed | Iustin Pop | type="keyval", default={},
|
709 | 087ed2ed | Iustin Pop | help="Backend parameters")
|
710 | 48f212d7 | Iustin Pop | |
711 | 48f212d7 | Iustin Pop | HVOPTS_OPT = cli_option("-H", "--hypervisor-parameters", type="keyval", |
712 | 48f212d7 | Iustin Pop | default={}, dest="hvparams",
|
713 | 48f212d7 | Iustin Pop | help="Hypervisor parameters")
|
714 | 087ed2ed | Iustin Pop | |
715 | 236fd9c4 | Iustin Pop | HYPERVISOR_OPT = cli_option("-H", "--hypervisor-parameters", dest="hypervisor", |
716 | 236fd9c4 | Iustin Pop | help="Hypervisor and hypervisor options, in the"
|
717 | 236fd9c4 | Iustin Pop | " format hypervisor:option=value,option=value,...",
|
718 | 236fd9c4 | Iustin Pop | default=None, type="identkeyval") |
719 | 073271f6 | Iustin Pop | |
720 | 073271f6 | Iustin Pop | HVLIST_OPT = cli_option("-H", "--hypervisor-parameters", dest="hvparams", |
721 | 073271f6 | Iustin Pop | help="Hypervisor and hypervisor options, in the"
|
722 | 073271f6 | Iustin Pop | " format hypervisor:option=value,option=value,...",
|
723 | 073271f6 | Iustin Pop | default=[], action="append", type="identkeyval") |
724 | 236fd9c4 | Iustin Pop | |
725 | 91e0748c | Iustin Pop | NOIPCHECK_OPT = cli_option("--no-ip-check", dest="ip_check", default=True, |
726 | 91e0748c | Iustin Pop | action="store_false",
|
727 | 91e0748c | Iustin Pop | help="Don't check that the instance's IP"
|
728 | 91e0748c | Iustin Pop | " is alive")
|
729 | 91e0748c | Iustin Pop | |
730 | 460d22be | Iustin Pop | NONAMECHECK_OPT = cli_option("--no-name-check", dest="name_check", |
731 | 460d22be | Iustin Pop | default=True, action="store_false", |
732 | 460d22be | Iustin Pop | help="Don't check that the instance's name"
|
733 | 460d22be | Iustin Pop | " is resolvable")
|
734 | 460d22be | Iustin Pop | |
735 | 7d3a9fab | Iustin Pop | NET_OPT = cli_option("--net",
|
736 | 7d3a9fab | Iustin Pop | help="NIC parameters", default=[],
|
737 | 7d3a9fab | Iustin Pop | dest="nics", action="append", type="identkeyval") |
738 | e3876ccb | Iustin Pop | |
739 | e3876ccb | Iustin Pop | DISK_OPT = cli_option("--disk", help="Disk parameters", default=[], |
740 | e3876ccb | Iustin Pop | dest="disks", action="append", type="identkeyval") |
741 | 91e0748c | Iustin Pop | |
742 | 4b038a1e | Iustin Pop | DISKIDX_OPT = cli_option("--disks", dest="disks", default=None, |
743 | 4b038a1e | Iustin Pop | help="Comma-separated list of disks"
|
744 | 4b038a1e | Iustin Pop | " indices to act on (e.g. 0,2) (optional,"
|
745 | 4b038a1e | Iustin Pop | " defaults to all disks)")
|
746 | 4b038a1e | Iustin Pop | |
747 | ff00c1a7 | Iustin Pop | OS_SIZE_OPT = cli_option("-s", "--os-size", dest="sd_size", |
748 | ff00c1a7 | Iustin Pop | help="Enforces a single-disk configuration using the"
|
749 | ff00c1a7 | Iustin Pop | " given disk size, in MiB unless a suffix is used",
|
750 | ff00c1a7 | Iustin Pop | default=None, type="unit", metavar="<size>") |
751 | ff00c1a7 | Iustin Pop | |
752 | 82a786d5 | Iustin Pop | IGNORE_CONSIST_OPT = cli_option("--ignore-consistency",
|
753 | 82a786d5 | Iustin Pop | dest="ignore_consistency",
|
754 | 82a786d5 | Iustin Pop | action="store_true", default=False, |
755 | 82a786d5 | Iustin Pop | help="Ignore the consistency of the disks on"
|
756 | 82a786d5 | Iustin Pop | " the secondary")
|
757 | 82a786d5 | Iustin Pop | |
758 | f2a0828c | Iustin Pop | NONLIVE_OPT = cli_option("--non-live", dest="live", |
759 | f2a0828c | Iustin Pop | default=True, action="store_false", |
760 | f2a0828c | Iustin Pop | help="Do a non-live migration (this usually means"
|
761 | f2a0828c | Iustin Pop | " freeze the instance, save the state, transfer and"
|
762 | f2a0828c | Iustin Pop | " only then resume running on the secondary node)")
|
763 | f2a0828c | Iustin Pop | |
764 | 783a6c0b | Iustin Pop | MIGRATION_MODE_OPT = cli_option("--migration-mode", dest="migration_mode", |
765 | e71b9ef4 | Iustin Pop | default=None,
|
766 | 783a6c0b | Iustin Pop | choices=list(constants.HT_MIGRATION_MODES),
|
767 | 783a6c0b | Iustin Pop | help="Override default migration mode (choose"
|
768 | e71b9ef4 | Iustin Pop | " either live or non-live")
|
769 | e71b9ef4 | Iustin Pop | |
770 | 990b7886 | Iustin Pop | NODE_PLACEMENT_OPT = cli_option("-n", "--node", dest="node", |
771 | 990b7886 | Iustin Pop | help="Target node and optional secondary node",
|
772 | 990b7886 | Iustin Pop | metavar="<pnode>[:<snode>]",
|
773 | 990b7886 | Iustin Pop | completion_suggest=OPT_COMPL_INST_ADD_NODES) |
774 | 990b7886 | Iustin Pop | |
775 | 7edc4637 | Iustin Pop | NODE_LIST_OPT = cli_option("-n", "--node", dest="nodes", default=[], |
776 | 7edc4637 | Iustin Pop | action="append", metavar="<node>", |
777 | 7edc4637 | Iustin Pop | help="Use only this node (can be used multiple"
|
778 | 7edc4637 | Iustin Pop | " times, if not given defaults to all nodes)",
|
779 | 7edc4637 | Iustin Pop | completion_suggest=OPT_COMPL_ONE_NODE) |
780 | f36d7d81 | Iustin Pop | |
781 | a285fcfd | Iustin Pop | NODEGROUP_OPT = cli_option("-g", "--node-group", |
782 | 5fbbd028 | Guido Trotter | dest="nodegroup",
|
783 | 5fbbd028 | Guido Trotter | help="Node group (name or uuid)",
|
784 | 5fbbd028 | Guido Trotter | metavar="<nodegroup>",
|
785 | 5fbbd028 | Guido Trotter | default=None, type="string", |
786 | 5fbbd028 | Guido Trotter | completion_suggest=OPT_COMPL_ONE_NODEGROUP) |
787 | 5fbbd028 | Guido Trotter | |
788 | f36d7d81 | Iustin Pop | SINGLE_NODE_OPT = cli_option("-n", "--node", dest="node", help="Target node", |
789 | f36d7d81 | Iustin Pop | metavar="<node>",
|
790 | f36d7d81 | Iustin Pop | completion_suggest=OPT_COMPL_ONE_NODE) |
791 | 7edc4637 | Iustin Pop | |
792 | edeb878a | Iustin Pop | NOSTART_OPT = cli_option("--no-start", dest="start", default=True, |
793 | edeb878a | Iustin Pop | action="store_false",
|
794 | edeb878a | Iustin Pop | help="Don't start the instance after creation")
|
795 | edeb878a | Iustin Pop | |
796 | fdcf4d84 | Iustin Pop | SHOWCMD_OPT = cli_option("--show-cmd", dest="show_command", |
797 | fdcf4d84 | Iustin Pop | action="store_true", default=False, |
798 | fdcf4d84 | Iustin Pop | help="Show command instead of executing it")
|
799 | fdcf4d84 | Iustin Pop | |
800 | baef337d | Iustin Pop | CLEANUP_OPT = cli_option("--cleanup", dest="cleanup", |
801 | baef337d | Iustin Pop | default=False, action="store_true", |
802 | baef337d | Iustin Pop | help="Instead of performing the migration, try to"
|
803 | baef337d | Iustin Pop | " recover from a failed cleanup. This is safe"
|
804 | baef337d | Iustin Pop | " to run even if the instance is healthy, but it"
|
805 | baef337d | Iustin Pop | " will create extra replication traffic and "
|
806 | baef337d | Iustin Pop | " disrupt briefly the replication (like during the"
|
807 | baef337d | Iustin Pop | " migration")
|
808 | baef337d | Iustin Pop | |
809 | 99a8c799 | Iustin Pop | STATIC_OPT = cli_option("-s", "--static", dest="static", |
810 | 99a8c799 | Iustin Pop | action="store_true", default=False, |
811 | 99a8c799 | Iustin Pop | help="Only show configuration data, not runtime data")
|
812 | 99a8c799 | Iustin Pop | |
813 | 2d5e7ae1 | Iustin Pop | ALL_OPT = cli_option("--all", dest="show_all", |
814 | 2d5e7ae1 | Iustin Pop | default=False, action="store_true", |
815 | 2d5e7ae1 | Iustin Pop | help="Show info on all instances on the cluster."
|
816 | 2d5e7ae1 | Iustin Pop | " This can take a long time to run, use wisely")
|
817 | 2d5e7ae1 | Iustin Pop | |
818 | 67840b40 | Iustin Pop | SELECT_OS_OPT = cli_option("--select-os", dest="select_os", |
819 | 67840b40 | Iustin Pop | action="store_true", default=False, |
820 | 67840b40 | Iustin Pop | help="Interactive OS reinstall, lists available"
|
821 | 67840b40 | Iustin Pop | " OS templates for selection")
|
822 | 2d5e7ae1 | Iustin Pop | |
823 | b6e841a8 | Iustin Pop | IGNORE_FAILURES_OPT = cli_option("--ignore-failures", dest="ignore_failures", |
824 | b6e841a8 | Iustin Pop | action="store_true", default=False, |
825 | b6e841a8 | Iustin Pop | help="Remove the instance from the cluster"
|
826 | b6e841a8 | Iustin Pop | " configuration even if there are failures"
|
827 | b6e841a8 | Iustin Pop | " during the removal process")
|
828 | b6e841a8 | Iustin Pop | |
829 | 8d8d650c | Michael Hanselmann | IGNORE_REMOVE_FAILURES_OPT = cli_option("--ignore-remove-failures",
|
830 | 8d8d650c | Michael Hanselmann | dest="ignore_remove_failures",
|
831 | 8d8d650c | Michael Hanselmann | action="store_true", default=False, |
832 | 8d8d650c | Michael Hanselmann | help="Remove the instance from the"
|
833 | 8d8d650c | Michael Hanselmann | " cluster configuration even if there"
|
834 | 8d8d650c | Michael Hanselmann | " are failures during the removal"
|
835 | 8d8d650c | Michael Hanselmann | " process")
|
836 | 8d8d650c | Michael Hanselmann | |
837 | 8d8d650c | Michael Hanselmann | REMOVE_INSTANCE_OPT = cli_option("--remove-instance", dest="remove_instance", |
838 | 8d8d650c | Michael Hanselmann | action="store_true", default=False, |
839 | 8d8d650c | Michael Hanselmann | help="Remove the instance from the cluster")
|
840 | 8d8d650c | Michael Hanselmann | |
841 | a14db5ff | Iustin Pop | NEW_SECONDARY_OPT = cli_option("-n", "--new-secondary", dest="dst_node", |
842 | a14db5ff | Iustin Pop | help="Specifies the new secondary node",
|
843 | a14db5ff | Iustin Pop | metavar="NODE", default=None, |
844 | a14db5ff | Iustin Pop | completion_suggest=OPT_COMPL_ONE_NODE) |
845 | a14db5ff | Iustin Pop | |
846 | a72d0a79 | Iustin Pop | ON_PRIMARY_OPT = cli_option("-p", "--on-primary", dest="on_primary", |
847 | a72d0a79 | Iustin Pop | default=False, action="store_true", |
848 | a72d0a79 | Iustin Pop | help="Replace the disk(s) on the primary"
|
849 | a72d0a79 | Iustin Pop | " node (only for the drbd template)")
|
850 | feb09e6a | Iustin Pop | |
851 | feb09e6a | Iustin Pop | ON_SECONDARY_OPT = cli_option("-s", "--on-secondary", dest="on_secondary", |
852 | feb09e6a | Iustin Pop | default=False, action="store_true", |
853 | feb09e6a | Iustin Pop | help="Replace the disk(s) on the secondary"
|
854 | feb09e6a | Iustin Pop | " node (only for the drbd template)")
|
855 | e00f7a05 | Iustin Pop | |
856 | 4c61d894 | Iustin Pop | AUTO_PROMOTE_OPT = cli_option("--auto-promote", dest="auto_promote", |
857 | 4c61d894 | Iustin Pop | default=False, action="store_true", |
858 | 4c61d894 | Iustin Pop | help="Lock all nodes and auto-promote as needed"
|
859 | 4c61d894 | Iustin Pop | " to MC status")
|
860 | 4c61d894 | Iustin Pop | |
861 | e00f7a05 | Iustin Pop | AUTO_REPLACE_OPT = cli_option("-a", "--auto", dest="auto", |
862 | e00f7a05 | Iustin Pop | default=False, action="store_true", |
863 | e00f7a05 | Iustin Pop | help="Automatically replace faulty disks"
|
864 | e00f7a05 | Iustin Pop | " (only for the drbd template)")
|
865 | a72d0a79 | Iustin Pop | |
866 | 05586c90 | Iustin Pop | IGNORE_SIZE_OPT = cli_option("--ignore-size", dest="ignore_size", |
867 | 05586c90 | Iustin Pop | default=False, action="store_true", |
868 | 05586c90 | Iustin Pop | help="Ignore current recorded size"
|
869 | 05586c90 | Iustin Pop | " (useful for forcing activation when"
|
870 | 05586c90 | Iustin Pop | " the recorded size is wrong)")
|
871 | 05586c90 | Iustin Pop | |
872 | df62e5db | Iustin Pop | SRC_NODE_OPT = cli_option("--src-node", dest="src_node", help="Source node", |
873 | df62e5db | Iustin Pop | metavar="<node>",
|
874 | df62e5db | Iustin Pop | completion_suggest=OPT_COMPL_ONE_NODE) |
875 | df62e5db | Iustin Pop | |
876 | df62e5db | Iustin Pop | SRC_DIR_OPT = cli_option("--src-dir", dest="src_dir", help="Source directory", |
877 | df62e5db | Iustin Pop | metavar="<dir>")
|
878 | df62e5db | Iustin Pop | |
879 | 8d823629 | Iustin Pop | SECONDARY_IP_OPT = cli_option("-s", "--secondary-ip", dest="secondary_ip", |
880 | 8d823629 | Iustin Pop | help="Specify the secondary ip for the node",
|
881 | 8d823629 | Iustin Pop | metavar="ADDRESS", default=None) |
882 | 8d823629 | Iustin Pop | |
883 | b8d0f938 | Iustin Pop | READD_OPT = cli_option("--readd", dest="readd", |
884 | b8d0f938 | Iustin Pop | default=False, action="store_true", |
885 | b8d0f938 | Iustin Pop | help="Readd old node after replacing it")
|
886 | b8d0f938 | Iustin Pop | |
887 | fcdde7f2 | Iustin Pop | NOSSH_KEYCHECK_OPT = cli_option("--no-ssh-key-check", dest="ssh_key_check", |
888 | fcdde7f2 | Iustin Pop | default=True, action="store_false", |
889 | fcdde7f2 | Iustin Pop | help="Disable SSH key fingerprint checking")
|
890 | fcdde7f2 | Iustin Pop | |
891 | 61413377 | Stephen Shirley | NODE_FORCE_JOIN_OPT = cli_option("--force-join", dest="force_join", |
892 | 61413377 | Stephen Shirley | default=False, action="store_true", |
893 | 50769215 | Stephen Shirley | help="Force the joining of a node")
|
894 | 61413377 | Stephen Shirley | |
895 | 771734c9 | Iustin Pop | MC_OPT = cli_option("-C", "--master-candidate", dest="master_candidate", |
896 | e7b61bb0 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
897 | 771734c9 | Iustin Pop | help="Set the master_candidate flag on the node")
|
898 | 771734c9 | Iustin Pop | |
899 | 771734c9 | Iustin Pop | OFFLINE_OPT = cli_option("-O", "--offline", dest="offline", metavar=_YORNO, |
900 | e7b61bb0 | Iustin Pop | type="bool", default=None, |
901 | 34616379 | Michael Hanselmann | help=("Set the offline flag on the node"
|
902 | 34616379 | Michael Hanselmann | " (cluster does not communicate with offline"
|
903 | 34616379 | Michael Hanselmann | " nodes)"))
|
904 | 771734c9 | Iustin Pop | |
905 | 771734c9 | Iustin Pop | DRAINED_OPT = cli_option("-D", "--drained", dest="drained", metavar=_YORNO, |
906 | e7b61bb0 | Iustin Pop | type="bool", default=None, |
907 | 34616379 | Michael Hanselmann | help=("Set the drained flag on the node"
|
908 | 34616379 | Michael Hanselmann | " (excluded from allocation operations)"))
|
909 | 771734c9 | Iustin Pop | |
910 | f91e255a | Iustin Pop | CAPAB_MASTER_OPT = cli_option("--master-capable", dest="master_capable", |
911 | f91e255a | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
912 | f91e255a | Iustin Pop | help="Set the master_capable flag on the node")
|
913 | f91e255a | Iustin Pop | |
914 | 53919782 | Iustin Pop | CAPAB_VM_OPT = cli_option("--vm-capable", dest="vm_capable", |
915 | 53919782 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
916 | 53919782 | Iustin Pop | help="Set the vm_capable flag on the node")
|
917 | 53919782 | Iustin Pop | |
918 | e7e09483 | Iustin Pop | ALLOCATABLE_OPT = cli_option("--allocatable", dest="allocatable", |
919 | e7b61bb0 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
920 | e7e09483 | Iustin Pop | help="Set the allocatable flag on a volume")
|
921 | e7e09483 | Iustin Pop | |
922 | 831040bf | Iustin Pop | NOLVM_STORAGE_OPT = cli_option("--no-lvm-storage", dest="lvm_storage", |
923 | 831040bf | Iustin Pop | help="Disable support for lvm based instances"
|
924 | 831040bf | Iustin Pop | " (cluster-wide)",
|
925 | 831040bf | Iustin Pop | action="store_false", default=True) |
926 | 831040bf | Iustin Pop | |
927 | 383a3591 | Iustin Pop | ENABLED_HV_OPT = cli_option("--enabled-hypervisors",
|
928 | 383a3591 | Iustin Pop | dest="enabled_hypervisors",
|
929 | 383a3591 | Iustin Pop | help="Comma-separated list of hypervisors",
|
930 | 383a3591 | Iustin Pop | type="string", default=None) |
931 | 383a3591 | Iustin Pop | |
932 | 4fbc93dd | Iustin Pop | NIC_PARAMS_OPT = cli_option("-N", "--nic-parameters", dest="nicparams", |
933 | 4fbc93dd | Iustin Pop | type="keyval", default={},
|
934 | 4fbc93dd | Iustin Pop | help="NIC parameters")
|
935 | 4fbc93dd | Iustin Pop | |
936 | e32df528 | Iustin Pop | CP_SIZE_OPT = cli_option("-C", "--candidate-pool-size", default=None, |
937 | e32df528 | Iustin Pop | dest="candidate_pool_size", type="int", |
938 | e32df528 | Iustin Pop | help="Set the candidate pool size")
|
939 | e32df528 | Iustin Pop | |
940 | 04367e70 | Guido Trotter | VG_NAME_OPT = cli_option("--vg-name", dest="vg_name", |
941 | 34616379 | Michael Hanselmann | help=("Enables LVM and specifies the volume group"
|
942 | 34616379 | Michael Hanselmann | " name (cluster-wide) for disk allocation"
|
943 | 34616379 | Michael Hanselmann | " [%s]" % constants.DEFAULT_VG),
|
944 | b58726e8 | Iustin Pop | metavar="VG", default=None) |
945 | b58726e8 | Iustin Pop | |
946 | 1f587d3d | Iustin Pop | YES_DOIT_OPT = cli_option("--yes-do-it", dest="yes_do_it", |
947 | 1f587d3d | Iustin Pop | help="Destroy cluster", action="store_true") |
948 | b58726e8 | Iustin Pop | |
949 | 58371861 | Iustin Pop | NOVOTING_OPT = cli_option("--no-voting", dest="no_voting", |
950 | 58371861 | Iustin Pop | help="Skip node agreement check (dangerous)",
|
951 | 58371861 | Iustin Pop | action="store_true", default=False) |
952 | 58371861 | Iustin Pop | |
953 | e3646f22 | Iustin Pop | MAC_PREFIX_OPT = cli_option("-m", "--mac-prefix", dest="mac_prefix", |
954 | e3646f22 | Iustin Pop | help="Specify the mac prefix for the instance IP"
|
955 | e3646f22 | Iustin Pop | " addresses, in the format XX:XX:XX",
|
956 | e3646f22 | Iustin Pop | metavar="PREFIX",
|
957 | e3646f22 | Iustin Pop | default=None)
|
958 | e3646f22 | Iustin Pop | |
959 | 29392516 | Iustin Pop | MASTER_NETDEV_OPT = cli_option("--master-netdev", dest="master_netdev", |
960 | 29392516 | Iustin Pop | help="Specify the node interface (cluster-wide)"
|
961 | 25be0c75 | Guido Trotter | " on which the master IP address will be added"
|
962 | 25be0c75 | Guido Trotter | " (cluster init default: %s)" %
|
963 | 25be0c75 | Guido Trotter | constants.DEFAULT_BRIDGE, |
964 | 29392516 | Iustin Pop | metavar="NETDEV",
|
965 | 25be0c75 | Guido Trotter | default=None)
|
966 | 29392516 | Iustin Pop | |
967 | 29392516 | Iustin Pop | GLOBAL_FILEDIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir", |
968 | 29392516 | Iustin Pop | help="Specify the default directory (cluster-"
|
969 | 29392516 | Iustin Pop | "wide) for storing the file-based disks [%s]" %
|
970 | 29392516 | Iustin Pop | constants.DEFAULT_FILE_STORAGE_DIR, |
971 | 29392516 | Iustin Pop | metavar="DIR",
|
972 | 29392516 | Iustin Pop | default=constants.DEFAULT_FILE_STORAGE_DIR) |
973 | 29392516 | Iustin Pop | |
974 | 29392516 | Iustin Pop | NOMODIFY_ETCHOSTS_OPT = cli_option("--no-etc-hosts", dest="modify_etc_hosts", |
975 | 29392516 | Iustin Pop | help="Don't modify /etc/hosts",
|
976 | 29392516 | Iustin Pop | action="store_false", default=True) |
977 | 29392516 | Iustin Pop | |
978 | b989b9d9 | Ken Wehr | NOMODIFY_SSH_SETUP_OPT = cli_option("--no-ssh-init", dest="modify_ssh_setup", |
979 | b989b9d9 | Ken Wehr | help="Don't initialize SSH keys",
|
980 | b989b9d9 | Ken Wehr | action="store_false", default=True) |
981 | b989b9d9 | Ken Wehr | |
982 | 14e9e7f3 | Iustin Pop | ERROR_CODES_OPT = cli_option("--error-codes", dest="error_codes", |
983 | 14e9e7f3 | Iustin Pop | help="Enable parseable error messages",
|
984 | 14e9e7f3 | Iustin Pop | action="store_true", default=False) |
985 | 14e9e7f3 | Iustin Pop | |
986 | 14e9e7f3 | Iustin Pop | NONPLUS1_OPT = cli_option("--no-nplus1-mem", dest="skip_nplusone_mem", |
987 | 14e9e7f3 | Iustin Pop | help="Skip N+1 memory redundancy tests",
|
988 | 14e9e7f3 | Iustin Pop | action="store_true", default=False) |
989 | 14e9e7f3 | Iustin Pop | |
990 | 12054861 | Iustin Pop | REBOOT_TYPE_OPT = cli_option("-t", "--type", dest="reboot_type", |
991 | 12054861 | Iustin Pop | help="Type of reboot: soft/hard/full",
|
992 | 12054861 | Iustin Pop | default=constants.INSTANCE_REBOOT_HARD, |
993 | 12054861 | Iustin Pop | metavar="<REBOOT>",
|
994 | 12054861 | Iustin Pop | choices=list(constants.REBOOT_TYPES))
|
995 | 12054861 | Iustin Pop | |
996 | ee3f9578 | Iustin Pop | IGNORE_SECONDARIES_OPT = cli_option("--ignore-secondaries",
|
997 | ee3f9578 | Iustin Pop | dest="ignore_secondaries",
|
998 | ee3f9578 | Iustin Pop | default=False, action="store_true", |
999 | ee3f9578 | Iustin Pop | help="Ignore errors from secondaries")
|
1000 | ee3f9578 | Iustin Pop | |
1001 | 69b99987 | Michael Hanselmann | NOSHUTDOWN_OPT = cli_option("--noshutdown", dest="shutdown", |
1002 | 44c44832 | Iustin Pop | action="store_false", default=True, |
1003 | 44c44832 | Iustin Pop | help="Don't shutdown the instance (unsafe)")
|
1004 | 44c44832 | Iustin Pop | |
1005 | b5762e2a | Guido Trotter | TIMEOUT_OPT = cli_option("--timeout", dest="timeout", type="int", |
1006 | b5762e2a | Guido Trotter | default=constants.DEFAULT_SHUTDOWN_TIMEOUT, |
1007 | b5762e2a | Guido Trotter | help="Maximum time to wait")
|
1008 | 44c44832 | Iustin Pop | |
1009 | 4d98c565 | Guido Trotter | SHUTDOWN_TIMEOUT_OPT = cli_option("--shutdown-timeout",
|
1010 | 4d98c565 | Guido Trotter | dest="shutdown_timeout", type="int", |
1011 | 7e5eaaa8 | Guido Trotter | default=constants.DEFAULT_SHUTDOWN_TIMEOUT, |
1012 | 7e5eaaa8 | Guido Trotter | help="Maximum time to wait for instance shutdown")
|
1013 | 7e5eaaa8 | Guido Trotter | |
1014 | 19b9ba9a | Michael Hanselmann | INTERVAL_OPT = cli_option("--interval", dest="interval", type="int", |
1015 | 19b9ba9a | Michael Hanselmann | default=None,
|
1016 | 19b9ba9a | Michael Hanselmann | help=("Number of seconds between repetions of the"
|
1017 | 19b9ba9a | Michael Hanselmann | " command"))
|
1018 | 19b9ba9a | Michael Hanselmann | |
1019 | 7ea7bcf6 | Iustin Pop | EARLY_RELEASE_OPT = cli_option("--early-release",
|
1020 | 7ea7bcf6 | Iustin Pop | dest="early_release", default=False, |
1021 | 7ea7bcf6 | Iustin Pop | action="store_true",
|
1022 | 7ea7bcf6 | Iustin Pop | help="Release the locks on the secondary"
|
1023 | 7ea7bcf6 | Iustin Pop | " node(s) early")
|
1024 | 7ea7bcf6 | Iustin Pop | |
1025 | 6d4a1656 | Michael Hanselmann | NEW_CLUSTER_CERT_OPT = cli_option("--new-cluster-certificate",
|
1026 | 6d4a1656 | Michael Hanselmann | dest="new_cluster_cert",
|
1027 | 6d4a1656 | Michael Hanselmann | default=False, action="store_true", |
1028 | 6d4a1656 | Michael Hanselmann | help="Generate a new cluster certificate")
|
1029 | 6d4a1656 | Michael Hanselmann | |
1030 | 6d4a1656 | Michael Hanselmann | RAPI_CERT_OPT = cli_option("--rapi-certificate", dest="rapi_cert", |
1031 | 6d4a1656 | Michael Hanselmann | default=None,
|
1032 | 6d4a1656 | Michael Hanselmann | help="File containing new RAPI certificate")
|
1033 | 6d4a1656 | Michael Hanselmann | |
1034 | 6d4a1656 | Michael Hanselmann | NEW_RAPI_CERT_OPT = cli_option("--new-rapi-certificate", dest="new_rapi_cert", |
1035 | 6d4a1656 | Michael Hanselmann | default=None, action="store_true", |
1036 | 6d4a1656 | Michael Hanselmann | help=("Generate a new self-signed RAPI"
|
1037 | 6d4a1656 | Michael Hanselmann | " certificate"))
|
1038 | 6d4a1656 | Michael Hanselmann | |
1039 | 6b7d5878 | Michael Hanselmann | NEW_CONFD_HMAC_KEY_OPT = cli_option("--new-confd-hmac-key",
|
1040 | 6b7d5878 | Michael Hanselmann | dest="new_confd_hmac_key",
|
1041 | 6b7d5878 | Michael Hanselmann | default=False, action="store_true", |
1042 | 6b7d5878 | Michael Hanselmann | help=("Create a new HMAC key for %s" %
|
1043 | 6b7d5878 | Michael Hanselmann | constants.CONFD)) |
1044 | 6d4a1656 | Michael Hanselmann | |
1045 | 3db3eb2a | Michael Hanselmann | CLUSTER_DOMAIN_SECRET_OPT = cli_option("--cluster-domain-secret",
|
1046 | 3db3eb2a | Michael Hanselmann | dest="cluster_domain_secret",
|
1047 | 3db3eb2a | Michael Hanselmann | default=None,
|
1048 | 3db3eb2a | Michael Hanselmann | help=("Load new new cluster domain"
|
1049 | 3db3eb2a | Michael Hanselmann | " secret from file"))
|
1050 | 3db3eb2a | Michael Hanselmann | |
1051 | 3db3eb2a | Michael Hanselmann | NEW_CLUSTER_DOMAIN_SECRET_OPT = cli_option("--new-cluster-domain-secret",
|
1052 | 3db3eb2a | Michael Hanselmann | dest="new_cluster_domain_secret",
|
1053 | 3db3eb2a | Michael Hanselmann | default=False, action="store_true", |
1054 | 3db3eb2a | Michael Hanselmann | help=("Create a new cluster domain"
|
1055 | 3db3eb2a | Michael Hanselmann | " secret"))
|
1056 | 3db3eb2a | Michael Hanselmann | |
1057 | 74adc100 | Iustin Pop | USE_REPL_NET_OPT = cli_option("--use-replication-network",
|
1058 | 74adc100 | Iustin Pop | dest="use_replication_network",
|
1059 | 74adc100 | Iustin Pop | help="Whether to use the replication network"
|
1060 | 74adc100 | Iustin Pop | " for talking to the nodes",
|
1061 | 74adc100 | Iustin Pop | action="store_true", default=False) |
1062 | 74adc100 | Iustin Pop | |
1063 | 3953242f | Iustin Pop | MAINTAIN_NODE_HEALTH_OPT = \ |
1064 | 3953242f | Iustin Pop | cli_option("--maintain-node-health", dest="maintain_node_health", |
1065 | 3953242f | Iustin Pop | metavar=_YORNO, default=None, type="bool", |
1066 | 3953242f | Iustin Pop | help="Configure the cluster to automatically maintain node"
|
1067 | 3953242f | Iustin Pop | " health, by shutting down unknown instances, shutting down"
|
1068 | 3953242f | Iustin Pop | " unknown DRBD devices, etc.")
|
1069 | 3953242f | Iustin Pop | |
1070 | e588764d | Iustin Pop | IDENTIFY_DEFAULTS_OPT = \ |
1071 | e588764d | Iustin Pop | cli_option("--identify-defaults", dest="identify_defaults", |
1072 | e588764d | Iustin Pop | default=False, action="store_true", |
1073 | e588764d | Iustin Pop | help="Identify which saved instance parameters are equal to"
|
1074 | e588764d | Iustin Pop | " the current cluster defaults and set them as such, instead"
|
1075 | e588764d | Iustin Pop | " of marking them as overridden")
|
1076 | e588764d | Iustin Pop | |
1077 | 1338f2b4 | Balazs Lecz | UIDPOOL_OPT = cli_option("--uid-pool", default=None, |
1078 | 1338f2b4 | Balazs Lecz | action="store", dest="uid_pool", |
1079 | 1338f2b4 | Balazs Lecz | help=("A list of user-ids or user-id"
|
1080 | 1338f2b4 | Balazs Lecz | " ranges separated by commas"))
|
1081 | 1338f2b4 | Balazs Lecz | |
1082 | fdad8c4d | Balazs Lecz | ADD_UIDS_OPT = cli_option("--add-uids", default=None, |
1083 | fdad8c4d | Balazs Lecz | action="store", dest="add_uids", |
1084 | fdad8c4d | Balazs Lecz | help=("A list of user-ids or user-id"
|
1085 | fdad8c4d | Balazs Lecz | " ranges separated by commas, to be"
|
1086 | fdad8c4d | Balazs Lecz | " added to the user-id pool"))
|
1087 | fdad8c4d | Balazs Lecz | |
1088 | fdad8c4d | Balazs Lecz | REMOVE_UIDS_OPT = cli_option("--remove-uids", default=None, |
1089 | fdad8c4d | Balazs Lecz | action="store", dest="remove_uids", |
1090 | fdad8c4d | Balazs Lecz | help=("A list of user-ids or user-id"
|
1091 | fdad8c4d | Balazs Lecz | " ranges separated by commas, to be"
|
1092 | fdad8c4d | Balazs Lecz | " removed from the user-id pool"))
|
1093 | fdad8c4d | Balazs Lecz | |
1094 | f38ea602 | Iustin Pop | RESERVED_LVS_OPT = cli_option("--reserved-lvs", default=None, |
1095 | f38ea602 | Iustin Pop | action="store", dest="reserved_lvs", |
1096 | f38ea602 | Iustin Pop | help=("A comma-separated list of reserved"
|
1097 | f38ea602 | Iustin Pop | " logical volumes names, that will be"
|
1098 | f38ea602 | Iustin Pop | " ignored by cluster verify"))
|
1099 | f38ea602 | Iustin Pop | |
1100 | 31d97b2a | Guido Trotter | ROMAN_OPT = cli_option("--roman",
|
1101 | 31d97b2a | Guido Trotter | dest="roman_integers", default=False, |
1102 | 31d97b2a | Guido Trotter | action="store_true",
|
1103 | 31d97b2a | Guido Trotter | help="Use roman numbers for positive integers")
|
1104 | 31d97b2a | Guido Trotter | |
1105 | 26591bfd | Luca Bigliardi | DRBD_HELPER_OPT = cli_option("--drbd-usermode-helper", dest="drbd_helper", |
1106 | 26591bfd | Luca Bigliardi | action="store", default=None, |
1107 | 26591bfd | Luca Bigliardi | help="Specifies usermode helper for DRBD")
|
1108 | 26591bfd | Luca Bigliardi | |
1109 | 26591bfd | Luca Bigliardi | NODRBD_STORAGE_OPT = cli_option("--no-drbd-storage", dest="drbd_storage", |
1110 | 26591bfd | Luca Bigliardi | action="store_false", default=True, |
1111 | 26591bfd | Luca Bigliardi | help="Disable support for DRBD")
|
1112 | 31d97b2a | Guido Trotter | |
1113 | e7323b5e | Manuel Franceschini | PRIMARY_IP_VERSION_OPT = \ |
1114 | e7323b5e | Manuel Franceschini | cli_option("--primary-ip-version", default=constants.IP4_VERSION,
|
1115 | e7323b5e | Manuel Franceschini | action="store", dest="primary_ip_version", |
1116 | e7323b5e | Manuel Franceschini | metavar="%d|%d" % (constants.IP4_VERSION,
|
1117 | e7323b5e | Manuel Franceschini | constants.IP6_VERSION), |
1118 | e7323b5e | Manuel Franceschini | help="Cluster-wide IP version for primary IP")
|
1119 | e7323b5e | Manuel Franceschini | |
1120 | 84a5b33c | Michael Hanselmann | PRIORITY_OPT = cli_option("--priority", default=None, dest="priority", |
1121 | 84a5b33c | Michael Hanselmann | metavar="|".join(name for name, _ in _PRIORITY_NAMES), |
1122 | 84a5b33c | Michael Hanselmann | choices=_PRIONAME_TO_VALUE.keys(), |
1123 | aa06f8c6 | Michael Hanselmann | help="Priority for opcode processing")
|
1124 | 84a5b33c | Michael Hanselmann | |
1125 | 61a14bb3 | Iustin Pop | HID_OS_OPT = cli_option("--hidden", dest="hidden", |
1126 | 61a14bb3 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
1127 | 61a14bb3 | Iustin Pop | help="Sets the hidden flag on the OS")
|
1128 | 61a14bb3 | Iustin Pop | |
1129 | 61a14bb3 | Iustin Pop | BLK_OS_OPT = cli_option("--blacklisted", dest="blacklisted", |
1130 | 61a14bb3 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
1131 | 61a14bb3 | Iustin Pop | help="Sets the blacklisted flag on the OS")
|
1132 | 61a14bb3 | Iustin Pop | |
1133 | b883637f | René Nussbaumer | PREALLOC_WIPE_DISKS_OPT = cli_option("--prealloc-wipe-disks", default=None, |
1134 | b883637f | René Nussbaumer | type="bool", metavar=_YORNO,
|
1135 | b883637f | René Nussbaumer | dest="prealloc_wipe_disks",
|
1136 | b883637f | René Nussbaumer | help=("Wipe disks prior to instance"
|
1137 | b883637f | René Nussbaumer | " creation"))
|
1138 | b883637f | René Nussbaumer | |
1139 | a535cef7 | René Nussbaumer | NODE_PARAMS_OPT = cli_option("--node-parameters", dest="ndparams", |
1140 | 3c2b6a98 | René Nussbaumer | type="keyval", default=None, |
1141 | a535cef7 | René Nussbaumer | help="Node parameters")
|
1142 | a535cef7 | René Nussbaumer | |
1143 | 90e99856 | Adeodato Simo | ALLOC_POLICY_OPT = cli_option("--alloc-policy", dest="alloc_policy", |
1144 | 90e99856 | Adeodato Simo | action="store", metavar="POLICY", default=None, |
1145 | 90e99856 | Adeodato Simo | help="Allocation policy for the node group")
|
1146 | 90e99856 | Adeodato Simo | |
1147 | d2881c71 | René Nussbaumer | NODE_POWERED_OPT = cli_option("--node-powered", default=None, |
1148 | d2881c71 | René Nussbaumer | type="bool", metavar=_YORNO,
|
1149 | d2881c71 | René Nussbaumer | dest="node_powered",
|
1150 | d2881c71 | René Nussbaumer | help="Specify if the SoR for node is powered")
|
1151 | d2881c71 | René Nussbaumer | |
1152 | 61a14bb3 | Iustin Pop | |
1153 | 5786c087 | Michael Hanselmann | #: Options provided by all commands
|
1154 | 5786c087 | Michael Hanselmann | COMMON_OPTS = [DEBUG_OPT] |
1155 | 5786c087 | Michael Hanselmann | |
1156 | eb28ecf6 | Guido Trotter | # common options for creating instances. add and import then add their own
|
1157 | eb28ecf6 | Guido Trotter | # specific ones.
|
1158 | eb28ecf6 | Guido Trotter | COMMON_CREATE_OPTS = [ |
1159 | eb28ecf6 | Guido Trotter | BACKEND_OPT, |
1160 | eb28ecf6 | Guido Trotter | DISK_OPT, |
1161 | eb28ecf6 | Guido Trotter | DISK_TEMPLATE_OPT, |
1162 | eb28ecf6 | Guido Trotter | FILESTORE_DIR_OPT, |
1163 | eb28ecf6 | Guido Trotter | FILESTORE_DRIVER_OPT, |
1164 | eb28ecf6 | Guido Trotter | HYPERVISOR_OPT, |
1165 | eb28ecf6 | Guido Trotter | IALLOCATOR_OPT, |
1166 | eb28ecf6 | Guido Trotter | NET_OPT, |
1167 | eb28ecf6 | Guido Trotter | NODE_PLACEMENT_OPT, |
1168 | eb28ecf6 | Guido Trotter | NOIPCHECK_OPT, |
1169 | eb28ecf6 | Guido Trotter | NONAMECHECK_OPT, |
1170 | eb28ecf6 | Guido Trotter | NONICS_OPT, |
1171 | eb28ecf6 | Guido Trotter | NWSYNC_OPT, |
1172 | eb28ecf6 | Guido Trotter | OSPARAMS_OPT, |
1173 | eb28ecf6 | Guido Trotter | OS_SIZE_OPT, |
1174 | eb28ecf6 | Guido Trotter | SUBMIT_OPT, |
1175 | eb28ecf6 | Guido Trotter | DRY_RUN_OPT, |
1176 | eb28ecf6 | Guido Trotter | PRIORITY_OPT, |
1177 | eb28ecf6 | Guido Trotter | ] |
1178 | eb28ecf6 | Guido Trotter | |
1179 | 771734c9 | Iustin Pop | |
1180 | de47cf8f | Guido Trotter | def _ParseArgs(argv, commands, aliases): |
1181 | c41eea6e | Iustin Pop | """Parser for the command line arguments.
|
1182 | a8083063 | Iustin Pop |
|
1183 | 5bbd3f7f | Michael Hanselmann | This function parses the arguments and returns the function which
|
1184 | c41eea6e | Iustin Pop | must be executed together with its (modified) arguments.
|
1185 | a8083063 | Iustin Pop |
|
1186 | c41eea6e | Iustin Pop | @param argv: the command line
|
1187 | c41eea6e | Iustin Pop | @param commands: dictionary with special contents, see the design
|
1188 | c41eea6e | Iustin Pop | doc for cmdline handling
|
1189 | c41eea6e | Iustin Pop | @param aliases: dictionary with command aliases {'alias': 'target, ...}
|
1190 | 098c0958 | Michael Hanselmann |
|
1191 | a8083063 | Iustin Pop | """
|
1192 | a8083063 | Iustin Pop | if len(argv) == 0: |
1193 | a8083063 | Iustin Pop | binary = "<command>"
|
1194 | a8083063 | Iustin Pop | else:
|
1195 | a8083063 | Iustin Pop | binary = argv[0].split("/")[-1] |
1196 | a8083063 | Iustin Pop | |
1197 | a8083063 | Iustin Pop | if len(argv) > 1 and argv[1] == "--version": |
1198 | 84a12e40 | Iustin Pop | ToStdout("%s (ganeti %s) %s", binary, constants.VCS_VERSION,
|
1199 | 84a12e40 | Iustin Pop | constants.RELEASE_VERSION) |
1200 | a8083063 | Iustin Pop | # Quit right away. That way we don't have to care about this special
|
1201 | a8083063 | Iustin Pop | # argument. optparse.py does it the same.
|
1202 | a8083063 | Iustin Pop | sys.exit(0)
|
1203 | a8083063 | Iustin Pop | |
1204 | de47cf8f | Guido Trotter | if len(argv) < 2 or not (argv[1] in commands or |
1205 | 70a35b6f | Guido Trotter | argv[1] in aliases): |
1206 | a8083063 | Iustin Pop | # let's do a nice thing
|
1207 | a8083063 | Iustin Pop | sortedcmds = commands.keys() |
1208 | a8083063 | Iustin Pop | sortedcmds.sort() |
1209 | 03298ebe | Michael Hanselmann | |
1210 | 03298ebe | Michael Hanselmann | ToStdout("Usage: %s {command} [options...] [argument...]", binary)
|
1211 | 03298ebe | Michael Hanselmann | ToStdout("%s <command> --help to see details, or man %s", binary, binary)
|
1212 | 03298ebe | Michael Hanselmann | ToStdout("")
|
1213 | 03298ebe | Michael Hanselmann | |
1214 | a8083063 | Iustin Pop | # compute the max line length for cmd + usage
|
1215 | 4e713df6 | Iustin Pop | mlen = max([len(" %s" % cmd) for cmd in commands]) |
1216 | a8083063 | Iustin Pop | mlen = min(60, mlen) # should not get here... |
1217 | 03298ebe | Michael Hanselmann | |
1218 | a8083063 | Iustin Pop | # and format a nice command list
|
1219 | 03298ebe | Michael Hanselmann | ToStdout("Commands:")
|
1220 | a8083063 | Iustin Pop | for cmd in sortedcmds: |
1221 | 4e713df6 | Iustin Pop | cmdstr = " %s" % (cmd,)
|
1222 | 9a033156 | Iustin Pop | help_text = commands[cmd][4]
|
1223 | 03298ebe | Michael Hanselmann | help_lines = textwrap.wrap(help_text, 79 - 3 - mlen) |
1224 | 03298ebe | Michael Hanselmann | ToStdout("%-*s - %s", mlen, cmdstr, help_lines.pop(0)) |
1225 | a8083063 | Iustin Pop | for line in help_lines: |
1226 | 03298ebe | Michael Hanselmann | ToStdout("%-*s %s", mlen, "", line) |
1227 | 03298ebe | Michael Hanselmann | |
1228 | 03298ebe | Michael Hanselmann | ToStdout("")
|
1229 | 03298ebe | Michael Hanselmann | |
1230 | a8083063 | Iustin Pop | return None, None, None |
1231 | de47cf8f | Guido Trotter | |
1232 | de47cf8f | Guido Trotter | # get command, unalias it, and look it up in commands
|
1233 | a8083063 | Iustin Pop | cmd = argv.pop(1)
|
1234 | de47cf8f | Guido Trotter | if cmd in aliases: |
1235 | de47cf8f | Guido Trotter | if cmd in commands: |
1236 | de47cf8f | Guido Trotter | raise errors.ProgrammerError("Alias '%s' overrides an existing" |
1237 | de47cf8f | Guido Trotter | " command" % cmd)
|
1238 | de47cf8f | Guido Trotter | |
1239 | de47cf8f | Guido Trotter | if aliases[cmd] not in commands: |
1240 | de47cf8f | Guido Trotter | raise errors.ProgrammerError("Alias '%s' maps to non-existing" |
1241 | de47cf8f | Guido Trotter | " command '%s'" % (cmd, aliases[cmd]))
|
1242 | de47cf8f | Guido Trotter | |
1243 | de47cf8f | Guido Trotter | cmd = aliases[cmd] |
1244 | de47cf8f | Guido Trotter | |
1245 | a8005e17 | Michael Hanselmann | func, args_def, parser_opts, usage, description = commands[cmd] |
1246 | 5786c087 | Michael Hanselmann | parser = OptionParser(option_list=parser_opts + COMMON_OPTS, |
1247 | a8083063 | Iustin Pop | description=description, |
1248 | a8083063 | Iustin Pop | formatter=TitledHelpFormatter(), |
1249 | a8083063 | Iustin Pop | usage="%%prog %s %s" % (cmd, usage))
|
1250 | a8083063 | Iustin Pop | parser.disable_interspersed_args() |
1251 | a8083063 | Iustin Pop | options, args = parser.parse_args() |
1252 | a8005e17 | Michael Hanselmann | |
1253 | a8005e17 | Michael Hanselmann | if not _CheckArguments(cmd, args_def, args): |
1254 | a8083063 | Iustin Pop | return None, None, None |
1255 | a8083063 | Iustin Pop | |
1256 | a8083063 | Iustin Pop | return func, options, args
|
1257 | a8083063 | Iustin Pop | |
1258 | a8083063 | Iustin Pop | |
1259 | a8005e17 | Michael Hanselmann | def _CheckArguments(cmd, args_def, args): |
1260 | a8005e17 | Michael Hanselmann | """Verifies the arguments using the argument definition.
|
1261 | a8005e17 | Michael Hanselmann |
|
1262 | a8005e17 | Michael Hanselmann | Algorithm:
|
1263 | a8005e17 | Michael Hanselmann |
|
1264 | a8005e17 | Michael Hanselmann | 1. Abort with error if values specified by user but none expected.
|
1265 | a8005e17 | Michael Hanselmann |
|
1266 | a8005e17 | Michael Hanselmann | 1. For each argument in definition
|
1267 | a8005e17 | Michael Hanselmann |
|
1268 | a8005e17 | Michael Hanselmann | 1. Keep running count of minimum number of values (min_count)
|
1269 | a8005e17 | Michael Hanselmann | 1. Keep running count of maximum number of values (max_count)
|
1270 | a8005e17 | Michael Hanselmann | 1. If it has an unlimited number of values
|
1271 | a8005e17 | Michael Hanselmann |
|
1272 | a8005e17 | Michael Hanselmann | 1. Abort with error if it's not the last argument in the definition
|
1273 | a8005e17 | Michael Hanselmann |
|
1274 | a8005e17 | Michael Hanselmann | 1. If last argument has limited number of values
|
1275 | a8005e17 | Michael Hanselmann |
|
1276 | a8005e17 | Michael Hanselmann | 1. Abort with error if number of values doesn't match or is too large
|
1277 | a8005e17 | Michael Hanselmann |
|
1278 | a8005e17 | Michael Hanselmann | 1. Abort with error if user didn't pass enough values (min_count)
|
1279 | a8005e17 | Michael Hanselmann |
|
1280 | a8005e17 | Michael Hanselmann | """
|
1281 | a8005e17 | Michael Hanselmann | if args and not args_def: |
1282 | a8005e17 | Michael Hanselmann | ToStderr("Error: Command %s expects no arguments", cmd)
|
1283 | a8005e17 | Michael Hanselmann | return False |
1284 | a8005e17 | Michael Hanselmann | |
1285 | a8005e17 | Michael Hanselmann | min_count = None
|
1286 | a8005e17 | Michael Hanselmann | max_count = None
|
1287 | a8005e17 | Michael Hanselmann | check_max = None
|
1288 | a8005e17 | Michael Hanselmann | |
1289 | a8005e17 | Michael Hanselmann | last_idx = len(args_def) - 1 |
1290 | a8005e17 | Michael Hanselmann | |
1291 | a8005e17 | Michael Hanselmann | for idx, arg in enumerate(args_def): |
1292 | a8005e17 | Michael Hanselmann | if min_count is None: |
1293 | a8005e17 | Michael Hanselmann | min_count = arg.min |
1294 | a8005e17 | Michael Hanselmann | elif arg.min is not None: |
1295 | a8005e17 | Michael Hanselmann | min_count += arg.min |
1296 | a8005e17 | Michael Hanselmann | |
1297 | a8005e17 | Michael Hanselmann | if max_count is None: |
1298 | a8005e17 | Michael Hanselmann | max_count = arg.max |
1299 | a8005e17 | Michael Hanselmann | elif arg.max is not None: |
1300 | a8005e17 | Michael Hanselmann | max_count += arg.max |
1301 | a8005e17 | Michael Hanselmann | |
1302 | a8005e17 | Michael Hanselmann | if idx == last_idx:
|
1303 | a8005e17 | Michael Hanselmann | check_max = (arg.max is not None) |
1304 | a8005e17 | Michael Hanselmann | |
1305 | a8005e17 | Michael Hanselmann | elif arg.max is None: |
1306 | a8005e17 | Michael Hanselmann | raise errors.ProgrammerError("Only the last argument can have max=None") |
1307 | a8005e17 | Michael Hanselmann | |
1308 | a8005e17 | Michael Hanselmann | if check_max:
|
1309 | a8005e17 | Michael Hanselmann | # Command with exact number of arguments
|
1310 | a8005e17 | Michael Hanselmann | if (min_count is not None and max_count is not None and |
1311 | a8005e17 | Michael Hanselmann | min_count == max_count and len(args) != min_count): |
1312 | a8005e17 | Michael Hanselmann | ToStderr("Error: Command %s expects %d argument(s)", cmd, min_count)
|
1313 | a8005e17 | Michael Hanselmann | return False |
1314 | a8005e17 | Michael Hanselmann | |
1315 | a8005e17 | Michael Hanselmann | # Command with limited number of arguments
|
1316 | a8005e17 | Michael Hanselmann | if max_count is not None and len(args) > max_count: |
1317 | a8005e17 | Michael Hanselmann | ToStderr("Error: Command %s expects only %d argument(s)",
|
1318 | a8005e17 | Michael Hanselmann | cmd, max_count) |
1319 | a8005e17 | Michael Hanselmann | return False |
1320 | a8005e17 | Michael Hanselmann | |
1321 | a8005e17 | Michael Hanselmann | # Command with some required arguments
|
1322 | a8005e17 | Michael Hanselmann | if min_count is not None and len(args) < min_count: |
1323 | a8005e17 | Michael Hanselmann | ToStderr("Error: Command %s expects at least %d argument(s)",
|
1324 | a8005e17 | Michael Hanselmann | cmd, min_count) |
1325 | a8005e17 | Michael Hanselmann | return False |
1326 | a8005e17 | Michael Hanselmann | |
1327 | a8005e17 | Michael Hanselmann | return True |
1328 | a8005e17 | Michael Hanselmann | |
1329 | a8005e17 | Michael Hanselmann | |
1330 | 60d49723 | Michael Hanselmann | def SplitNodeOption(value): |
1331 | 60d49723 | Michael Hanselmann | """Splits the value of a --node option.
|
1332 | 60d49723 | Michael Hanselmann |
|
1333 | 60d49723 | Michael Hanselmann | """
|
1334 | 60d49723 | Michael Hanselmann | if value and ':' in value: |
1335 | 60d49723 | Michael Hanselmann | return value.split(':', 1) |
1336 | 60d49723 | Michael Hanselmann | else:
|
1337 | 60d49723 | Michael Hanselmann | return (value, None) |
1338 | 60d49723 | Michael Hanselmann | |
1339 | 60d49723 | Michael Hanselmann | |
1340 | 07150497 | Guido Trotter | def CalculateOSNames(os_name, os_variants): |
1341 | 07150497 | Guido Trotter | """Calculates all the names an OS can be called, according to its variants.
|
1342 | 07150497 | Guido Trotter |
|
1343 | 07150497 | Guido Trotter | @type os_name: string
|
1344 | 07150497 | Guido Trotter | @param os_name: base name of the os
|
1345 | 07150497 | Guido Trotter | @type os_variants: list or None
|
1346 | 07150497 | Guido Trotter | @param os_variants: list of supported variants
|
1347 | 07150497 | Guido Trotter | @rtype: list
|
1348 | 07150497 | Guido Trotter | @return: list of valid names
|
1349 | 07150497 | Guido Trotter |
|
1350 | 07150497 | Guido Trotter | """
|
1351 | 07150497 | Guido Trotter | if os_variants:
|
1352 | 07150497 | Guido Trotter | return ['%s+%s' % (os_name, v) for v in os_variants] |
1353 | 07150497 | Guido Trotter | else:
|
1354 | 07150497 | Guido Trotter | return [os_name]
|
1355 | 07150497 | Guido Trotter | |
1356 | 07150497 | Guido Trotter | |
1357 | a4ebd726 | Michael Hanselmann | def ParseFields(selected, default): |
1358 | a4ebd726 | Michael Hanselmann | """Parses the values of "--field"-like options.
|
1359 | a4ebd726 | Michael Hanselmann |
|
1360 | a4ebd726 | Michael Hanselmann | @type selected: string or None
|
1361 | a4ebd726 | Michael Hanselmann | @param selected: User-selected options
|
1362 | a4ebd726 | Michael Hanselmann | @type default: list
|
1363 | a4ebd726 | Michael Hanselmann | @param default: Default fields
|
1364 | a4ebd726 | Michael Hanselmann |
|
1365 | a4ebd726 | Michael Hanselmann | """
|
1366 | a4ebd726 | Michael Hanselmann | if selected is None: |
1367 | a4ebd726 | Michael Hanselmann | return default
|
1368 | a4ebd726 | Michael Hanselmann | |
1369 | a4ebd726 | Michael Hanselmann | if selected.startswith("+"): |
1370 | a4ebd726 | Michael Hanselmann | return default + selected[1:].split(",") |
1371 | a4ebd726 | Michael Hanselmann | |
1372 | a4ebd726 | Michael Hanselmann | return selected.split(",") |
1373 | a4ebd726 | Michael Hanselmann | |
1374 | a4ebd726 | Michael Hanselmann | |
1375 | e0e916fe | Iustin Pop | UsesRPC = rpc.RunWithRPC |
1376 | 4331f6cd | Michael Hanselmann | |
1377 | 4331f6cd | Michael Hanselmann | |
1378 | 47988778 | Iustin Pop | def AskUser(text, choices=None): |
1379 | 47988778 | Iustin Pop | """Ask the user a question.
|
1380 | a8083063 | Iustin Pop |
|
1381 | c41eea6e | Iustin Pop | @param text: the question to ask
|
1382 | a8083063 | Iustin Pop |
|
1383 | c41eea6e | Iustin Pop | @param choices: list with elements tuples (input_char, return_value,
|
1384 | c41eea6e | Iustin Pop | description); if not given, it will default to: [('y', True,
|
1385 | c41eea6e | Iustin Pop | 'Perform the operation'), ('n', False, 'Do no do the operation')];
|
1386 | c41eea6e | Iustin Pop | note that the '?' char is reserved for help
|
1387 | 47988778 | Iustin Pop |
|
1388 | c41eea6e | Iustin Pop | @return: one of the return values from the choices list; if input is
|
1389 | c41eea6e | Iustin Pop | not possible (i.e. not running with a tty, we return the last
|
1390 | c41eea6e | Iustin Pop | entry from the list
|
1391 | a8083063 | Iustin Pop |
|
1392 | a8083063 | Iustin Pop | """
|
1393 | 47988778 | Iustin Pop | if choices is None: |
1394 | 47988778 | Iustin Pop | choices = [('y', True, 'Perform the operation'), |
1395 | 47988778 | Iustin Pop | ('n', False, 'Do not perform the operation')] |
1396 | 47988778 | Iustin Pop | if not choices or not isinstance(choices, list): |
1397 | 5bbd3f7f | Michael Hanselmann | raise errors.ProgrammerError("Invalid choices argument to AskUser") |
1398 | 47988778 | Iustin Pop | for entry in choices: |
1399 | 47988778 | Iustin Pop | if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?': |
1400 | 5bbd3f7f | Michael Hanselmann | raise errors.ProgrammerError("Invalid choices element to AskUser") |
1401 | 47988778 | Iustin Pop | |
1402 | 47988778 | Iustin Pop | answer = choices[-1][1] |
1403 | 47988778 | Iustin Pop | new_text = [] |
1404 | 47988778 | Iustin Pop | for line in text.splitlines(): |
1405 | 47988778 | Iustin Pop | new_text.append(textwrap.fill(line, 70, replace_whitespace=False)) |
1406 | 47988778 | Iustin Pop | text = "\n".join(new_text)
|
1407 | a8083063 | Iustin Pop | try:
|
1408 | 3023170f | Iustin Pop | f = file("/dev/tty", "a+") |
1409 | a8083063 | Iustin Pop | except IOError: |
1410 | 47988778 | Iustin Pop | return answer
|
1411 | a8083063 | Iustin Pop | try:
|
1412 | 47988778 | Iustin Pop | chars = [entry[0] for entry in choices] |
1413 | 47988778 | Iustin Pop | chars[-1] = "[%s]" % chars[-1] |
1414 | 47988778 | Iustin Pop | chars.append('?')
|
1415 | 47988778 | Iustin Pop | maps = dict([(entry[0], entry[1]) for entry in choices]) |
1416 | 47988778 | Iustin Pop | while True: |
1417 | 47988778 | Iustin Pop | f.write(text) |
1418 | 47988778 | Iustin Pop | f.write('\n')
|
1419 | 47988778 | Iustin Pop | f.write("/".join(chars))
|
1420 | 47988778 | Iustin Pop | f.write(": ")
|
1421 | 47988778 | Iustin Pop | line = f.readline(2).strip().lower()
|
1422 | 47988778 | Iustin Pop | if line in maps: |
1423 | 47988778 | Iustin Pop | answer = maps[line] |
1424 | 47988778 | Iustin Pop | break
|
1425 | 47988778 | Iustin Pop | elif line == '?': |
1426 | 47988778 | Iustin Pop | for entry in choices: |
1427 | 47988778 | Iustin Pop | f.write(" %s - %s\n" % (entry[0], entry[2])) |
1428 | 47988778 | Iustin Pop | f.write("\n")
|
1429 | 47988778 | Iustin Pop | continue
|
1430 | a8083063 | Iustin Pop | finally:
|
1431 | a8083063 | Iustin Pop | f.close() |
1432 | a8083063 | Iustin Pop | return answer
|
1433 | a8083063 | Iustin Pop | |
1434 | a8083063 | Iustin Pop | |
1435 | e9d741b6 | Iustin Pop | class JobSubmittedException(Exception): |
1436 | e9d741b6 | Iustin Pop | """Job was submitted, client should exit.
|
1437 | e9d741b6 | Iustin Pop |
|
1438 | e9d741b6 | Iustin Pop | This exception has one argument, the ID of the job that was
|
1439 | e9d741b6 | Iustin Pop | submitted. The handler should print this ID.
|
1440 | e9d741b6 | Iustin Pop |
|
1441 | e9d741b6 | Iustin Pop | This is not an error, just a structured way to exit from clients.
|
1442 | e9d741b6 | Iustin Pop |
|
1443 | e9d741b6 | Iustin Pop | """
|
1444 | e9d741b6 | Iustin Pop | |
1445 | e9d741b6 | Iustin Pop | |
1446 | 0a1e74d9 | Iustin Pop | def SendJob(ops, cl=None): |
1447 | 0a1e74d9 | Iustin Pop | """Function to submit an opcode without waiting for the results.
|
1448 | a8083063 | Iustin Pop |
|
1449 | 0a1e74d9 | Iustin Pop | @type ops: list
|
1450 | 0a1e74d9 | Iustin Pop | @param ops: list of opcodes
|
1451 | 0a1e74d9 | Iustin Pop | @type cl: luxi.Client
|
1452 | 0a1e74d9 | Iustin Pop | @param cl: the luxi client to use for communicating with the master;
|
1453 | 0a1e74d9 | Iustin Pop | if None, a new client will be created
|
1454 | a8083063 | Iustin Pop |
|
1455 | a8083063 | Iustin Pop | """
|
1456 | e2212007 | Iustin Pop | if cl is None: |
1457 | b33e986b | Iustin Pop | cl = GetClient() |
1458 | 685ee993 | Iustin Pop | |
1459 | 0a1e74d9 | Iustin Pop | job_id = cl.SubmitJob(ops) |
1460 | 0a1e74d9 | Iustin Pop | |
1461 | 0a1e74d9 | Iustin Pop | return job_id
|
1462 | 0a1e74d9 | Iustin Pop | |
1463 | 0a1e74d9 | Iustin Pop | |
1464 | 4e338533 | Michael Hanselmann | def GenericPollJob(job_id, cbs, report_cbs): |
1465 | 4e338533 | Michael Hanselmann | """Generic job-polling function.
|
1466 | 0a1e74d9 | Iustin Pop |
|
1467 | 4e338533 | Michael Hanselmann | @type job_id: number
|
1468 | 4e338533 | Michael Hanselmann | @param job_id: Job ID
|
1469 | 4e338533 | Michael Hanselmann | @type cbs: Instance of L{JobPollCbBase}
|
1470 | 4e338533 | Michael Hanselmann | @param cbs: Data callbacks
|
1471 | 4e338533 | Michael Hanselmann | @type report_cbs: Instance of L{JobPollReportCbBase}
|
1472 | 4e338533 | Michael Hanselmann | @param report_cbs: Reporting callbacks
|
1473 | 0a1e74d9 | Iustin Pop |
|
1474 | 0a1e74d9 | Iustin Pop | """
|
1475 | 6c5a7090 | Michael Hanselmann | prev_job_info = None
|
1476 | 6c5a7090 | Michael Hanselmann | prev_logmsg_serial = None
|
1477 | 6c5a7090 | Michael Hanselmann | |
1478 | f4484122 | Michael Hanselmann | status = None
|
1479 | f4484122 | Michael Hanselmann | |
1480 | 685ee993 | Iustin Pop | while True: |
1481 | 4e338533 | Michael Hanselmann | result = cbs.WaitForJobChangeOnce(job_id, ["status"], prev_job_info,
|
1482 | 4e338533 | Michael Hanselmann | prev_logmsg_serial) |
1483 | 6c5a7090 | Michael Hanselmann | if not result: |
1484 | 685ee993 | Iustin Pop | # job not found, go away!
|
1485 | 0bbe448c | Michael Hanselmann | raise errors.JobLost("Job with id %s lost" % job_id) |
1486 | 4e338533 | Michael Hanselmann | |
1487 | 4e338533 | Michael Hanselmann | if result == constants.JOB_NOTCHANGED:
|
1488 | 4e338533 | Michael Hanselmann | report_cbs.ReportNotChanged(job_id, status) |
1489 | f4484122 | Michael Hanselmann | |
1490 | f4484122 | Michael Hanselmann | # Wait again
|
1491 | f4484122 | Michael Hanselmann | continue
|
1492 | 685ee993 | Iustin Pop | |
1493 | 6c5a7090 | Michael Hanselmann | # Split result, a tuple of (field values, log entries)
|
1494 | 6c5a7090 | Michael Hanselmann | (job_info, log_entries) = result |
1495 | 6c5a7090 | Michael Hanselmann | (status, ) = job_info |
1496 | 6c5a7090 | Michael Hanselmann | |
1497 | 6c5a7090 | Michael Hanselmann | if log_entries:
|
1498 | 6c5a7090 | Michael Hanselmann | for log_entry in log_entries: |
1499 | 4e338533 | Michael Hanselmann | (serial, timestamp, log_type, message) = log_entry |
1500 | 4e338533 | Michael Hanselmann | report_cbs.ReportLogMessage(job_id, serial, timestamp, |
1501 | 4e338533 | Michael Hanselmann | log_type, message) |
1502 | 6c5a7090 | Michael Hanselmann | prev_logmsg_serial = max(prev_logmsg_serial, serial)
|
1503 | 6c5a7090 | Michael Hanselmann | |
1504 | 0bbe448c | Michael Hanselmann | # TODO: Handle canceled and archived jobs
|
1505 | fbf0262f | Michael Hanselmann | elif status in (constants.JOB_STATUS_SUCCESS, |
1506 | fbf0262f | Michael Hanselmann | constants.JOB_STATUS_ERROR, |
1507 | fbf0262f | Michael Hanselmann | constants.JOB_STATUS_CANCELING, |
1508 | fbf0262f | Michael Hanselmann | constants.JOB_STATUS_CANCELED): |
1509 | 685ee993 | Iustin Pop | break
|
1510 | 6c5a7090 | Michael Hanselmann | |
1511 | 6c5a7090 | Michael Hanselmann | prev_job_info = job_info |
1512 | 685ee993 | Iustin Pop | |
1513 | 4e338533 | Michael Hanselmann | jobs = cbs.QueryJobs([job_id], ["status", "opstatus", "opresult"]) |
1514 | 0bbe448c | Michael Hanselmann | if not jobs: |
1515 | 0bbe448c | Michael Hanselmann | raise errors.JobLost("Job with id %s lost" % job_id) |
1516 | 685ee993 | Iustin Pop | |
1517 | 0e050889 | Iustin Pop | status, opstatus, result = jobs[0]
|
1518 | 4e338533 | Michael Hanselmann | |
1519 | 0bbe448c | Michael Hanselmann | if status == constants.JOB_STATUS_SUCCESS:
|
1520 | 53c04d04 | Iustin Pop | return result
|
1521 | 4e338533 | Michael Hanselmann | |
1522 | 4e338533 | Michael Hanselmann | if status in (constants.JOB_STATUS_CANCELING, constants.JOB_STATUS_CANCELED): |
1523 | fbf0262f | Michael Hanselmann | raise errors.OpExecError("Job was canceled") |
1524 | 4e338533 | Michael Hanselmann | |
1525 | 4e338533 | Michael Hanselmann | has_ok = False
|
1526 | 4e338533 | Michael Hanselmann | for idx, (status, msg) in enumerate(zip(opstatus, result)): |
1527 | 4e338533 | Michael Hanselmann | if status == constants.OP_STATUS_SUCCESS:
|
1528 | 4e338533 | Michael Hanselmann | has_ok = True
|
1529 | 4e338533 | Michael Hanselmann | elif status == constants.OP_STATUS_ERROR:
|
1530 | 4e338533 | Michael Hanselmann | errors.MaybeRaise(msg) |
1531 | 4e338533 | Michael Hanselmann | |
1532 | 4e338533 | Michael Hanselmann | if has_ok:
|
1533 | 4e338533 | Michael Hanselmann | raise errors.OpExecError("partial failure (opcode %d): %s" % |
1534 | 4e338533 | Michael Hanselmann | (idx, msg)) |
1535 | 4e338533 | Michael Hanselmann | |
1536 | 4e338533 | Michael Hanselmann | raise errors.OpExecError(str(msg)) |
1537 | 4e338533 | Michael Hanselmann | |
1538 | 4e338533 | Michael Hanselmann | # default failure mode
|
1539 | 4e338533 | Michael Hanselmann | raise errors.OpExecError(result)
|
1540 | 4e338533 | Michael Hanselmann | |
1541 | 4e338533 | Michael Hanselmann | |
1542 | 4e338533 | Michael Hanselmann | class JobPollCbBase: |
1543 | 4e338533 | Michael Hanselmann | """Base class for L{GenericPollJob} callbacks.
|
1544 | 4e338533 | Michael Hanselmann |
|
1545 | 4e338533 | Michael Hanselmann | """
|
1546 | 4e338533 | Michael Hanselmann | def __init__(self): |
1547 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
1548 | 4e338533 | Michael Hanselmann |
|
1549 | 4e338533 | Michael Hanselmann | """
|
1550 | 4e338533 | Michael Hanselmann | |
1551 | 4e338533 | Michael Hanselmann | def WaitForJobChangeOnce(self, job_id, fields, |
1552 | 4e338533 | Michael Hanselmann | prev_job_info, prev_log_serial): |
1553 | 4e338533 | Michael Hanselmann | """Waits for changes on a job.
|
1554 | 4e338533 | Michael Hanselmann |
|
1555 | 4e338533 | Michael Hanselmann | """
|
1556 | 4e338533 | Michael Hanselmann | raise NotImplementedError() |
1557 | 4e338533 | Michael Hanselmann | |
1558 | 4e338533 | Michael Hanselmann | def QueryJobs(self, job_ids, fields): |
1559 | 4e338533 | Michael Hanselmann | """Returns the selected fields for the selected job IDs.
|
1560 | 4e338533 | Michael Hanselmann |
|
1561 | 4e338533 | Michael Hanselmann | @type job_ids: list of numbers
|
1562 | 4e338533 | Michael Hanselmann | @param job_ids: Job IDs
|
1563 | 4e338533 | Michael Hanselmann | @type fields: list of strings
|
1564 | 4e338533 | Michael Hanselmann | @param fields: Fields
|
1565 | 4e338533 | Michael Hanselmann |
|
1566 | 4e338533 | Michael Hanselmann | """
|
1567 | 4e338533 | Michael Hanselmann | raise NotImplementedError() |
1568 | 4e338533 | Michael Hanselmann | |
1569 | 4e338533 | Michael Hanselmann | |
1570 | 4e338533 | Michael Hanselmann | class JobPollReportCbBase: |
1571 | 4e338533 | Michael Hanselmann | """Base class for L{GenericPollJob} reporting callbacks.
|
1572 | 4e338533 | Michael Hanselmann |
|
1573 | 4e338533 | Michael Hanselmann | """
|
1574 | 4e338533 | Michael Hanselmann | def __init__(self): |
1575 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
1576 | 4e338533 | Michael Hanselmann |
|
1577 | 4e338533 | Michael Hanselmann | """
|
1578 | 4e338533 | Michael Hanselmann | |
1579 | 4e338533 | Michael Hanselmann | def ReportLogMessage(self, job_id, serial, timestamp, log_type, log_msg): |
1580 | 4e338533 | Michael Hanselmann | """Handles a log message.
|
1581 | 4e338533 | Michael Hanselmann |
|
1582 | 4e338533 | Michael Hanselmann | """
|
1583 | 4e338533 | Michael Hanselmann | raise NotImplementedError() |
1584 | 4e338533 | Michael Hanselmann | |
1585 | 4e338533 | Michael Hanselmann | def ReportNotChanged(self, job_id, status): |
1586 | 4e338533 | Michael Hanselmann | """Called for if a job hasn't changed in a while.
|
1587 | 4e338533 | Michael Hanselmann |
|
1588 | 4e338533 | Michael Hanselmann | @type job_id: number
|
1589 | 4e338533 | Michael Hanselmann | @param job_id: Job ID
|
1590 | 4e338533 | Michael Hanselmann | @type status: string or None
|
1591 | 4e338533 | Michael Hanselmann | @param status: Job status if available
|
1592 | 4e338533 | Michael Hanselmann |
|
1593 | 4e338533 | Michael Hanselmann | """
|
1594 | 4e338533 | Michael Hanselmann | raise NotImplementedError() |
1595 | 4e338533 | Michael Hanselmann | |
1596 | 4e338533 | Michael Hanselmann | |
1597 | 4e338533 | Michael Hanselmann | class _LuxiJobPollCb(JobPollCbBase): |
1598 | 4e338533 | Michael Hanselmann | def __init__(self, cl): |
1599 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
1600 | 4e338533 | Michael Hanselmann |
|
1601 | 4e338533 | Michael Hanselmann | """
|
1602 | 4e338533 | Michael Hanselmann | JobPollCbBase.__init__(self)
|
1603 | 4e338533 | Michael Hanselmann | self.cl = cl
|
1604 | 4e338533 | Michael Hanselmann | |
1605 | 4e338533 | Michael Hanselmann | def WaitForJobChangeOnce(self, job_id, fields, |
1606 | 4e338533 | Michael Hanselmann | prev_job_info, prev_log_serial): |
1607 | 4e338533 | Michael Hanselmann | """Waits for changes on a job.
|
1608 | 4e338533 | Michael Hanselmann |
|
1609 | 4e338533 | Michael Hanselmann | """
|
1610 | 4e338533 | Michael Hanselmann | return self.cl.WaitForJobChangeOnce(job_id, fields, |
1611 | 4e338533 | Michael Hanselmann | prev_job_info, prev_log_serial) |
1612 | 4e338533 | Michael Hanselmann | |
1613 | 4e338533 | Michael Hanselmann | def QueryJobs(self, job_ids, fields): |
1614 | 4e338533 | Michael Hanselmann | """Returns the selected fields for the selected job IDs.
|
1615 | 4e338533 | Michael Hanselmann |
|
1616 | 4e338533 | Michael Hanselmann | """
|
1617 | 4e338533 | Michael Hanselmann | return self.cl.QueryJobs(job_ids, fields) |
1618 | 4e338533 | Michael Hanselmann | |
1619 | 4e338533 | Michael Hanselmann | |
1620 | 4e338533 | Michael Hanselmann | class FeedbackFnJobPollReportCb(JobPollReportCbBase): |
1621 | 4e338533 | Michael Hanselmann | def __init__(self, feedback_fn): |
1622 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
1623 | 4e338533 | Michael Hanselmann |
|
1624 | 4e338533 | Michael Hanselmann | """
|
1625 | 4e338533 | Michael Hanselmann | JobPollReportCbBase.__init__(self)
|
1626 | 4e338533 | Michael Hanselmann | |
1627 | 4e338533 | Michael Hanselmann | self.feedback_fn = feedback_fn
|
1628 | 4e338533 | Michael Hanselmann | |
1629 | 4e338533 | Michael Hanselmann | assert callable(feedback_fn) |
1630 | 4e338533 | Michael Hanselmann | |
1631 | 4e338533 | Michael Hanselmann | def ReportLogMessage(self, job_id, serial, timestamp, log_type, log_msg): |
1632 | 4e338533 | Michael Hanselmann | """Handles a log message.
|
1633 | 4e338533 | Michael Hanselmann |
|
1634 | 4e338533 | Michael Hanselmann | """
|
1635 | 4e338533 | Michael Hanselmann | self.feedback_fn((timestamp, log_type, log_msg))
|
1636 | 4e338533 | Michael Hanselmann | |
1637 | 4e338533 | Michael Hanselmann | def ReportNotChanged(self, job_id, status): |
1638 | 4e338533 | Michael Hanselmann | """Called if a job hasn't changed in a while.
|
1639 | 4e338533 | Michael Hanselmann |
|
1640 | 4e338533 | Michael Hanselmann | """
|
1641 | 4e338533 | Michael Hanselmann | # Ignore
|
1642 | 4e338533 | Michael Hanselmann | |
1643 | 4e338533 | Michael Hanselmann | |
1644 | 4e338533 | Michael Hanselmann | class StdioJobPollReportCb(JobPollReportCbBase): |
1645 | 4e338533 | Michael Hanselmann | def __init__(self): |
1646 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
1647 | 4e338533 | Michael Hanselmann |
|
1648 | 4e338533 | Michael Hanselmann | """
|
1649 | 4e338533 | Michael Hanselmann | JobPollReportCbBase.__init__(self)
|
1650 | 4e338533 | Michael Hanselmann | |
1651 | 4e338533 | Michael Hanselmann | self.notified_queued = False |
1652 | 4e338533 | Michael Hanselmann | self.notified_waitlock = False |
1653 | 4e338533 | Michael Hanselmann | |
1654 | 4e338533 | Michael Hanselmann | def ReportLogMessage(self, job_id, serial, timestamp, log_type, log_msg): |
1655 | 4e338533 | Michael Hanselmann | """Handles a log message.
|
1656 | 4e338533 | Michael Hanselmann |
|
1657 | 4e338533 | Michael Hanselmann | """
|
1658 | 4e338533 | Michael Hanselmann | ToStdout("%s %s", time.ctime(utils.MergeTime(timestamp)),
|
1659 | 8a7f1c61 | Michael Hanselmann | FormatLogMessage(log_type, log_msg)) |
1660 | 4e338533 | Michael Hanselmann | |
1661 | 4e338533 | Michael Hanselmann | def ReportNotChanged(self, job_id, status): |
1662 | 4e338533 | Michael Hanselmann | """Called if a job hasn't changed in a while.
|
1663 | 4e338533 | Michael Hanselmann |
|
1664 | 4e338533 | Michael Hanselmann | """
|
1665 | 4e338533 | Michael Hanselmann | if status is None: |
1666 | 4e338533 | Michael Hanselmann | return
|
1667 | 4e338533 | Michael Hanselmann | |
1668 | 4e338533 | Michael Hanselmann | if status == constants.JOB_STATUS_QUEUED and not self.notified_queued: |
1669 | 4e338533 | Michael Hanselmann | ToStderr("Job %s is waiting in queue", job_id)
|
1670 | 4e338533 | Michael Hanselmann | self.notified_queued = True |
1671 | 4e338533 | Michael Hanselmann | |
1672 | 4e338533 | Michael Hanselmann | elif status == constants.JOB_STATUS_WAITLOCK and not self.notified_waitlock: |
1673 | 4e338533 | Michael Hanselmann | ToStderr("Job %s is trying to acquire all necessary locks", job_id)
|
1674 | 4e338533 | Michael Hanselmann | self.notified_waitlock = True |
1675 | 4e338533 | Michael Hanselmann | |
1676 | 4e338533 | Michael Hanselmann | |
1677 | 8a7f1c61 | Michael Hanselmann | def FormatLogMessage(log_type, log_msg): |
1678 | 8a7f1c61 | Michael Hanselmann | """Formats a job message according to its type.
|
1679 | 8a7f1c61 | Michael Hanselmann |
|
1680 | 8a7f1c61 | Michael Hanselmann | """
|
1681 | 8a7f1c61 | Michael Hanselmann | if log_type != constants.ELOG_MESSAGE:
|
1682 | 8a7f1c61 | Michael Hanselmann | log_msg = str(log_msg)
|
1683 | 8a7f1c61 | Michael Hanselmann | |
1684 | 8a7f1c61 | Michael Hanselmann | return utils.SafeEncode(log_msg)
|
1685 | 8a7f1c61 | Michael Hanselmann | |
1686 | 8a7f1c61 | Michael Hanselmann | |
1687 | 583163a6 | Michael Hanselmann | def PollJob(job_id, cl=None, feedback_fn=None, reporter=None): |
1688 | 4e338533 | Michael Hanselmann | """Function to poll for the result of a job.
|
1689 | 4e338533 | Michael Hanselmann |
|
1690 | 4e338533 | Michael Hanselmann | @type job_id: job identified
|
1691 | 4e338533 | Michael Hanselmann | @param job_id: the job to poll for results
|
1692 | 4e338533 | Michael Hanselmann | @type cl: luxi.Client
|
1693 | 4e338533 | Michael Hanselmann | @param cl: the luxi client to use for communicating with the master;
|
1694 | 4e338533 | Michael Hanselmann | if None, a new client will be created
|
1695 | 4e338533 | Michael Hanselmann |
|
1696 | 4e338533 | Michael Hanselmann | """
|
1697 | 4e338533 | Michael Hanselmann | if cl is None: |
1698 | 4e338533 | Michael Hanselmann | cl = GetClient() |
1699 | 4e338533 | Michael Hanselmann | |
1700 | 583163a6 | Michael Hanselmann | if reporter is None: |
1701 | 583163a6 | Michael Hanselmann | if feedback_fn:
|
1702 | 583163a6 | Michael Hanselmann | reporter = FeedbackFnJobPollReportCb(feedback_fn) |
1703 | 583163a6 | Michael Hanselmann | else:
|
1704 | 583163a6 | Michael Hanselmann | reporter = StdioJobPollReportCb() |
1705 | 583163a6 | Michael Hanselmann | elif feedback_fn:
|
1706 | 583163a6 | Michael Hanselmann | raise errors.ProgrammerError("Can't specify reporter and feedback function") |
1707 | 4e338533 | Michael Hanselmann | |
1708 | 4e338533 | Michael Hanselmann | return GenericPollJob(job_id, _LuxiJobPollCb(cl), reporter)
|
1709 | ceab32dd | Iustin Pop | |
1710 | ceab32dd | Iustin Pop | |
1711 | 583163a6 | Michael Hanselmann | def SubmitOpCode(op, cl=None, feedback_fn=None, opts=None, reporter=None): |
1712 | 0a1e74d9 | Iustin Pop | """Legacy function to submit an opcode.
|
1713 | 0a1e74d9 | Iustin Pop |
|
1714 | 0a1e74d9 | Iustin Pop | This is just a simple wrapper over the construction of the processor
|
1715 | 0a1e74d9 | Iustin Pop | instance. It should be extended to better handle feedback and
|
1716 | 0a1e74d9 | Iustin Pop | interaction functions.
|
1717 | 0a1e74d9 | Iustin Pop |
|
1718 | 0a1e74d9 | Iustin Pop | """
|
1719 | 0a1e74d9 | Iustin Pop | if cl is None: |
1720 | 0a1e74d9 | Iustin Pop | cl = GetClient() |
1721 | 0a1e74d9 | Iustin Pop | |
1722 | 293ba2d8 | Iustin Pop | SetGenericOpcodeOpts([op], opts) |
1723 | 293ba2d8 | Iustin Pop | |
1724 | 5d297d8a | Michael Hanselmann | job_id = SendJob([op], cl=cl) |
1725 | 0a1e74d9 | Iustin Pop | |
1726 | 583163a6 | Michael Hanselmann | op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn, |
1727 | 583163a6 | Michael Hanselmann | reporter=reporter) |
1728 | 53c04d04 | Iustin Pop | |
1729 | 53c04d04 | Iustin Pop | return op_results[0] |
1730 | 0a1e74d9 | Iustin Pop | |
1731 | 0a1e74d9 | Iustin Pop | |
1732 | 94428652 | Iustin Pop | def SubmitOrSend(op, opts, cl=None, feedback_fn=None): |
1733 | 94428652 | Iustin Pop | """Wrapper around SubmitOpCode or SendJob.
|
1734 | 94428652 | Iustin Pop |
|
1735 | 94428652 | Iustin Pop | This function will decide, based on the 'opts' parameter, whether to
|
1736 | 94428652 | Iustin Pop | submit and wait for the result of the opcode (and return it), or
|
1737 | 94428652 | Iustin Pop | whether to just send the job and print its identifier. It is used in
|
1738 | 94428652 | Iustin Pop | order to simplify the implementation of the '--submit' option.
|
1739 | 94428652 | Iustin Pop |
|
1740 | 293ba2d8 | Iustin Pop | It will also process the opcodes if we're sending the via SendJob
|
1741 | 293ba2d8 | Iustin Pop | (otherwise SubmitOpCode does it).
|
1742 | 64c65a2a | Iustin Pop |
|
1743 | 94428652 | Iustin Pop | """
|
1744 | 94428652 | Iustin Pop | if opts and opts.submit_only: |
1745 | 293ba2d8 | Iustin Pop | job = [op] |
1746 | 293ba2d8 | Iustin Pop | SetGenericOpcodeOpts(job, opts) |
1747 | 293ba2d8 | Iustin Pop | job_id = SendJob(job, cl=cl) |
1748 | e9d741b6 | Iustin Pop | raise JobSubmittedException(job_id)
|
1749 | 94428652 | Iustin Pop | else:
|
1750 | 293ba2d8 | Iustin Pop | return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn, opts=opts)
|
1751 | 293ba2d8 | Iustin Pop | |
1752 | 293ba2d8 | Iustin Pop | |
1753 | 293ba2d8 | Iustin Pop | def SetGenericOpcodeOpts(opcode_list, options): |
1754 | 293ba2d8 | Iustin Pop | """Processor for generic options.
|
1755 | 293ba2d8 | Iustin Pop |
|
1756 | 293ba2d8 | Iustin Pop | This function updates the given opcodes based on generic command
|
1757 | 293ba2d8 | Iustin Pop | line options (like debug, dry-run, etc.).
|
1758 | 293ba2d8 | Iustin Pop |
|
1759 | 293ba2d8 | Iustin Pop | @param opcode_list: list of opcodes
|
1760 | 293ba2d8 | Iustin Pop | @param options: command line options or None
|
1761 | 293ba2d8 | Iustin Pop | @return: None (in-place modification)
|
1762 | 293ba2d8 | Iustin Pop |
|
1763 | 293ba2d8 | Iustin Pop | """
|
1764 | 293ba2d8 | Iustin Pop | if not options: |
1765 | 293ba2d8 | Iustin Pop | return
|
1766 | 293ba2d8 | Iustin Pop | for op in opcode_list: |
1767 | aa06f8c6 | Michael Hanselmann | op.debug_level = options.debug |
1768 | a0a6ff34 | Iustin Pop | if hasattr(options, "dry_run"): |
1769 | a0a6ff34 | Iustin Pop | op.dry_run = options.dry_run |
1770 | aa06f8c6 | Michael Hanselmann | if getattr(options, "priority", None) is not None: |
1771 | aa06f8c6 | Michael Hanselmann | op.priority = _PRIONAME_TO_VALUE[options.priority] |
1772 | 94428652 | Iustin Pop | |
1773 | 94428652 | Iustin Pop | |
1774 | af30b2fd | Michael Hanselmann | def GetClient(): |
1775 | af30b2fd | Michael Hanselmann | # TODO: Cache object?
|
1776 | b33e986b | Iustin Pop | try:
|
1777 | b33e986b | Iustin Pop | client = luxi.Client() |
1778 | b33e986b | Iustin Pop | except luxi.NoMasterError:
|
1779 | d9a51679 | Michael Hanselmann | ss = ssconf.SimpleStore() |
1780 | d9a51679 | Michael Hanselmann | |
1781 | d9a51679 | Michael Hanselmann | # Try to read ssconf file
|
1782 | d9a51679 | Michael Hanselmann | try:
|
1783 | d9a51679 | Michael Hanselmann | ss.GetMasterNode() |
1784 | d9a51679 | Michael Hanselmann | except errors.ConfigurationError:
|
1785 | d9a51679 | Michael Hanselmann | raise errors.OpPrereqError("Cluster not initialized or this machine is" |
1786 | d9a51679 | Michael Hanselmann | " not part of a cluster")
|
1787 | d9a51679 | Michael Hanselmann | |
1788 | d9a51679 | Michael Hanselmann | master, myself = ssconf.GetMasterAndMyself(ss=ss) |
1789 | b33e986b | Iustin Pop | if master != myself:
|
1790 | b33e986b | Iustin Pop | raise errors.OpPrereqError("This is not the master node, please connect" |
1791 | b33e986b | Iustin Pop | " to node '%s' and rerun the command" %
|
1792 | b33e986b | Iustin Pop | master) |
1793 | d9a51679 | Michael Hanselmann | raise
|
1794 | b33e986b | Iustin Pop | return client
|
1795 | af30b2fd | Michael Hanselmann | |
1796 | af30b2fd | Michael Hanselmann | |
1797 | 73702ee7 | Iustin Pop | def FormatError(err): |
1798 | 73702ee7 | Iustin Pop | """Return a formatted error message for a given error.
|
1799 | 73702ee7 | Iustin Pop |
|
1800 | 73702ee7 | Iustin Pop | This function takes an exception instance and returns a tuple
|
1801 | 73702ee7 | Iustin Pop | consisting of two values: first, the recommended exit code, and
|
1802 | 73702ee7 | Iustin Pop | second, a string describing the error message (not
|
1803 | 73702ee7 | Iustin Pop | newline-terminated).
|
1804 | 73702ee7 | Iustin Pop |
|
1805 | 73702ee7 | Iustin Pop | """
|
1806 | 73702ee7 | Iustin Pop | retcode = 1
|
1807 | 73702ee7 | Iustin Pop | obuf = StringIO() |
1808 | e2e521d0 | Iustin Pop | msg = str(err)
|
1809 | 73702ee7 | Iustin Pop | if isinstance(err, errors.ConfigurationError): |
1810 | e2e521d0 | Iustin Pop | txt = "Corrupt configuration file: %s" % msg
|
1811 | 46fbdd04 | Iustin Pop | logging.error(txt) |
1812 | e2e521d0 | Iustin Pop | obuf.write(txt + "\n")
|
1813 | 73702ee7 | Iustin Pop | obuf.write("Aborting.")
|
1814 | 73702ee7 | Iustin Pop | retcode = 2
|
1815 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.HooksAbort): |
1816 | 73702ee7 | Iustin Pop | obuf.write("Failure: hooks execution failed:\n")
|
1817 | 73702ee7 | Iustin Pop | for node, script, out in err.args[0]: |
1818 | 73702ee7 | Iustin Pop | if out:
|
1819 | 73702ee7 | Iustin Pop | obuf.write(" node: %s, script: %s, output: %s\n" %
|
1820 | 73702ee7 | Iustin Pop | (node, script, out)) |
1821 | 73702ee7 | Iustin Pop | else:
|
1822 | 73702ee7 | Iustin Pop | obuf.write(" node: %s, script: %s (no output)\n" %
|
1823 | 73702ee7 | Iustin Pop | (node, script)) |
1824 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.HooksFailure): |
1825 | e2e521d0 | Iustin Pop | obuf.write("Failure: hooks general failure: %s" % msg)
|
1826 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.ResolverError): |
1827 | b705c7a6 | Manuel Franceschini | this_host = netutils.Hostname.GetSysName() |
1828 | 73702ee7 | Iustin Pop | if err.args[0] == this_host: |
1829 | 73702ee7 | Iustin Pop | msg = "Failure: can't resolve my own hostname ('%s')"
|
1830 | 73702ee7 | Iustin Pop | else:
|
1831 | 73702ee7 | Iustin Pop | msg = "Failure: can't resolve hostname '%s'"
|
1832 | 73702ee7 | Iustin Pop | obuf.write(msg % err.args[0])
|
1833 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.OpPrereqError): |
1834 | 5c983ee5 | Iustin Pop | if len(err.args) == 2: |
1835 | 5c983ee5 | Iustin Pop | obuf.write("Failure: prerequisites not met for this"
|
1836 | 5c983ee5 | Iustin Pop | " operation:\nerror type: %s, error details:\n%s" %
|
1837 | 5c983ee5 | Iustin Pop | (err.args[1], err.args[0])) |
1838 | 5c983ee5 | Iustin Pop | else:
|
1839 | 5c983ee5 | Iustin Pop | obuf.write("Failure: prerequisites not met for this"
|
1840 | 5c983ee5 | Iustin Pop | " operation:\n%s" % msg)
|
1841 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.OpExecError): |
1842 | e2e521d0 | Iustin Pop | obuf.write("Failure: command execution error:\n%s" % msg)
|
1843 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.TagError): |
1844 | e2e521d0 | Iustin Pop | obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
|
1845 | 686d7433 | Iustin Pop | elif isinstance(err, errors.JobQueueDrainError): |
1846 | 686d7433 | Iustin Pop | obuf.write("Failure: the job queue is marked for drain and doesn't"
|
1847 | 686d7433 | Iustin Pop | " accept new requests\n")
|
1848 | f87b405e | Michael Hanselmann | elif isinstance(err, errors.JobQueueFull): |
1849 | f87b405e | Michael Hanselmann | obuf.write("Failure: the job queue is full and doesn't accept new"
|
1850 | f87b405e | Michael Hanselmann | " job submissions until old jobs are archived\n")
|
1851 | a5728081 | Guido Trotter | elif isinstance(err, errors.TypeEnforcementError): |
1852 | a5728081 | Guido Trotter | obuf.write("Parameter Error: %s" % msg)
|
1853 | c1ce76bb | Iustin Pop | elif isinstance(err, errors.ParameterError): |
1854 | c1ce76bb | Iustin Pop | obuf.write("Failure: unknown/wrong parameter name '%s'" % msg)
|
1855 | 03a8dbdc | Iustin Pop | elif isinstance(err, luxi.NoMasterError): |
1856 | 03a8dbdc | Iustin Pop | obuf.write("Cannot communicate with the master daemon.\nIs it running"
|
1857 | 082c5adb | Michael Hanselmann | " and listening for connections?")
|
1858 | 03a8dbdc | Iustin Pop | elif isinstance(err, luxi.TimeoutError): |
1859 | cd4c86a8 | Michael Hanselmann | obuf.write("Timeout while talking to the master daemon. Jobs might have"
|
1860 | cd4c86a8 | Michael Hanselmann | " been submitted and will continue to run even if the call"
|
1861 | cd4c86a8 | Michael Hanselmann | " timed out. Useful commands in this situation are \"gnt-job"
|
1862 | cd4c86a8 | Michael Hanselmann | " list\", \"gnt-job cancel\" and \"gnt-job watch\". Error:\n")
|
1863 | cd4c86a8 | Michael Hanselmann | obuf.write(msg) |
1864 | 5a1c22fe | Iustin Pop | elif isinstance(err, luxi.PermissionError): |
1865 | 5a1c22fe | Iustin Pop | obuf.write("It seems you don't have permissions to connect to the"
|
1866 | 5a1c22fe | Iustin Pop | " master daemon.\nPlease retry as a different user.")
|
1867 | 03a8dbdc | Iustin Pop | elif isinstance(err, luxi.ProtocolError): |
1868 | 03a8dbdc | Iustin Pop | obuf.write("Unhandled protocol error while talking to the master daemon:\n"
|
1869 | 03a8dbdc | Iustin Pop | "%s" % msg)
|
1870 | 91c622a8 | Iustin Pop | elif isinstance(err, errors.JobLost): |
1871 | 91c622a8 | Iustin Pop | obuf.write("Error checking job status: %s" % msg)
|
1872 | 797506fc | Michael Hanselmann | elif isinstance(err, errors.GenericError): |
1873 | 797506fc | Michael Hanselmann | obuf.write("Unhandled Ganeti error: %s" % msg)
|
1874 | e9d741b6 | Iustin Pop | elif isinstance(err, JobSubmittedException): |
1875 | e9d741b6 | Iustin Pop | obuf.write("JobID: %s\n" % err.args[0]) |
1876 | e9d741b6 | Iustin Pop | retcode = 0
|
1877 | 73702ee7 | Iustin Pop | else:
|
1878 | e2e521d0 | Iustin Pop | obuf.write("Unhandled exception: %s" % msg)
|
1879 | 73702ee7 | Iustin Pop | return retcode, obuf.getvalue().rstrip('\n') |
1880 | 73702ee7 | Iustin Pop | |
1881 | 73702ee7 | Iustin Pop | |
1882 | de47cf8f | Guido Trotter | def GenericMain(commands, override=None, aliases=None): |
1883 | a8083063 | Iustin Pop | """Generic main function for all the gnt-* commands.
|
1884 | a8083063 | Iustin Pop |
|
1885 | 334d1483 | Iustin Pop | Arguments:
|
1886 | 334d1483 | Iustin Pop | - commands: a dictionary with a special structure, see the design doc
|
1887 | 334d1483 | Iustin Pop | for command line handling.
|
1888 | 334d1483 | Iustin Pop | - override: if not None, we expect a dictionary with keys that will
|
1889 | 334d1483 | Iustin Pop | override command line options; this can be used to pass
|
1890 | 334d1483 | Iustin Pop | options from the scripts to generic functions
|
1891 | de47cf8f | Guido Trotter | - aliases: dictionary with command aliases {'alias': 'target, ...}
|
1892 | a8083063 | Iustin Pop |
|
1893 | a8083063 | Iustin Pop | """
|
1894 | a8083063 | Iustin Pop | # save the program name and the entire command line for later logging
|
1895 | a8083063 | Iustin Pop | if sys.argv:
|
1896 | a8083063 | Iustin Pop | binary = os.path.basename(sys.argv[0]) or sys.argv[0] |
1897 | a8083063 | Iustin Pop | if len(sys.argv) >= 2: |
1898 | a8083063 | Iustin Pop | binary += " " + sys.argv[1] |
1899 | a8083063 | Iustin Pop | old_cmdline = " ".join(sys.argv[2:]) |
1900 | a8083063 | Iustin Pop | else:
|
1901 | a8083063 | Iustin Pop | old_cmdline = ""
|
1902 | a8083063 | Iustin Pop | else:
|
1903 | a8083063 | Iustin Pop | binary = "<unknown program>"
|
1904 | a8083063 | Iustin Pop | old_cmdline = ""
|
1905 | a8083063 | Iustin Pop | |
1906 | de47cf8f | Guido Trotter | if aliases is None: |
1907 | de47cf8f | Guido Trotter | aliases = {} |
1908 | de47cf8f | Guido Trotter | |
1909 | 3126878d | Guido Trotter | try:
|
1910 | 3126878d | Guido Trotter | func, options, args = _ParseArgs(sys.argv, commands, aliases) |
1911 | 3126878d | Guido Trotter | except errors.ParameterError, err:
|
1912 | 3126878d | Guido Trotter | result, err_msg = FormatError(err) |
1913 | 3126878d | Guido Trotter | ToStderr(err_msg) |
1914 | 3126878d | Guido Trotter | return 1 |
1915 | 3126878d | Guido Trotter | |
1916 | a8083063 | Iustin Pop | if func is None: # parse error |
1917 | a8083063 | Iustin Pop | return 1 |
1918 | a8083063 | Iustin Pop | |
1919 | 334d1483 | Iustin Pop | if override is not None: |
1920 | 334d1483 | Iustin Pop | for key, val in override.iteritems(): |
1921 | 334d1483 | Iustin Pop | setattr(options, key, val)
|
1922 | 334d1483 | Iustin Pop | |
1923 | cfcc79c6 | Michael Hanselmann | utils.SetupLogging(constants.LOG_COMMANDS, binary, debug=options.debug, |
1924 | cfcc79c6 | Michael Hanselmann | stderr_logging=True)
|
1925 | a8083063 | Iustin Pop | |
1926 | a8083063 | Iustin Pop | if old_cmdline:
|
1927 | 46fbdd04 | Iustin Pop | logging.info("run with arguments '%s'", old_cmdline)
|
1928 | a8083063 | Iustin Pop | else:
|
1929 | 46fbdd04 | Iustin Pop | logging.info("run with no arguments")
|
1930 | a8083063 | Iustin Pop | |
1931 | a8083063 | Iustin Pop | try:
|
1932 | a4af651e | Iustin Pop | result = func(options, args) |
1933 | d8353c3a | Iustin Pop | except (errors.GenericError, luxi.ProtocolError,
|
1934 | d8353c3a | Iustin Pop | JobSubmittedException), err: |
1935 | a4af651e | Iustin Pop | result, err_msg = FormatError(err) |
1936 | 5bbd3f7f | Michael Hanselmann | logging.exception("Error during command processing")
|
1937 | 46fbdd04 | Iustin Pop | ToStderr(err_msg) |
1938 | 8a53b55f | Iustin Pop | except KeyboardInterrupt: |
1939 | 8a53b55f | Iustin Pop | result = constants.EXIT_FAILURE |
1940 | 8a53b55f | Iustin Pop | ToStderr("Aborted. Note that if the operation created any jobs, they"
|
1941 | 8a53b55f | Iustin Pop | " might have been submitted and"
|
1942 | 8a53b55f | Iustin Pop | " will continue to run in the background.")
|
1943 | 225e2544 | Iustin Pop | except IOError, err: |
1944 | 225e2544 | Iustin Pop | if err.errno == errno.EPIPE:
|
1945 | 225e2544 | Iustin Pop | # our terminal went away, we'll exit
|
1946 | 225e2544 | Iustin Pop | sys.exit(constants.EXIT_FAILURE) |
1947 | 225e2544 | Iustin Pop | else:
|
1948 | 225e2544 | Iustin Pop | raise
|
1949 | a8083063 | Iustin Pop | |
1950 | a8083063 | Iustin Pop | return result
|
1951 | 137161c9 | Michael Hanselmann | |
1952 | 137161c9 | Michael Hanselmann | |
1953 | 845c79d8 | Michael Hanselmann | def ParseNicOption(optvalue): |
1954 | 845c79d8 | Michael Hanselmann | """Parses the value of the --net option(s).
|
1955 | 845c79d8 | Michael Hanselmann |
|
1956 | 845c79d8 | Michael Hanselmann | """
|
1957 | 845c79d8 | Michael Hanselmann | try:
|
1958 | 845c79d8 | Michael Hanselmann | nic_max = max(int(nidx[0]) + 1 for nidx in optvalue) |
1959 | 845c79d8 | Michael Hanselmann | except (TypeError, ValueError), err: |
1960 | 845c79d8 | Michael Hanselmann | raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err)) |
1961 | 845c79d8 | Michael Hanselmann | |
1962 | 845c79d8 | Michael Hanselmann | nics = [{}] * nic_max |
1963 | 845c79d8 | Michael Hanselmann | for nidx, ndict in optvalue: |
1964 | 845c79d8 | Michael Hanselmann | nidx = int(nidx)
|
1965 | 845c79d8 | Michael Hanselmann | |
1966 | 845c79d8 | Michael Hanselmann | if not isinstance(ndict, dict): |
1967 | 845c79d8 | Michael Hanselmann | raise errors.OpPrereqError("Invalid nic/%d value: expected dict," |
1968 | 845c79d8 | Michael Hanselmann | " got %s" % (nidx, ndict))
|
1969 | 845c79d8 | Michael Hanselmann | |
1970 | 845c79d8 | Michael Hanselmann | utils.ForceDictType(ndict, constants.INIC_PARAMS_TYPES) |
1971 | 845c79d8 | Michael Hanselmann | |
1972 | 845c79d8 | Michael Hanselmann | nics[nidx] = ndict |
1973 | 845c79d8 | Michael Hanselmann | |
1974 | 845c79d8 | Michael Hanselmann | return nics
|
1975 | 845c79d8 | Michael Hanselmann | |
1976 | 845c79d8 | Michael Hanselmann | |
1977 | d77490c5 | Iustin Pop | def GenericInstanceCreate(mode, opts, args): |
1978 | d77490c5 | Iustin Pop | """Add an instance to the cluster via either creation or import.
|
1979 | d77490c5 | Iustin Pop |
|
1980 | d77490c5 | Iustin Pop | @param mode: constants.INSTANCE_CREATE or constants.INSTANCE_IMPORT
|
1981 | d77490c5 | Iustin Pop | @param opts: the command line options selected by the user
|
1982 | d77490c5 | Iustin Pop | @type args: list
|
1983 | d77490c5 | Iustin Pop | @param args: should contain only one element, the new instance name
|
1984 | d77490c5 | Iustin Pop | @rtype: int
|
1985 | d77490c5 | Iustin Pop | @return: the desired exit code
|
1986 | d77490c5 | Iustin Pop |
|
1987 | d77490c5 | Iustin Pop | """
|
1988 | d77490c5 | Iustin Pop | instance = args[0]
|
1989 | d77490c5 | Iustin Pop | |
1990 | d77490c5 | Iustin Pop | (pnode, snode) = SplitNodeOption(opts.node) |
1991 | d77490c5 | Iustin Pop | |
1992 | d77490c5 | Iustin Pop | hypervisor = None
|
1993 | d77490c5 | Iustin Pop | hvparams = {} |
1994 | d77490c5 | Iustin Pop | if opts.hypervisor:
|
1995 | d77490c5 | Iustin Pop | hypervisor, hvparams = opts.hypervisor |
1996 | d77490c5 | Iustin Pop | |
1997 | d77490c5 | Iustin Pop | if opts.nics:
|
1998 | 845c79d8 | Michael Hanselmann | nics = ParseNicOption(opts.nics) |
1999 | d77490c5 | Iustin Pop | elif opts.no_nics:
|
2000 | d77490c5 | Iustin Pop | # no nics
|
2001 | d77490c5 | Iustin Pop | nics = [] |
2002 | 0af0f641 | Iustin Pop | elif mode == constants.INSTANCE_CREATE:
|
2003 | d77490c5 | Iustin Pop | # default of one nic, all auto
|
2004 | d77490c5 | Iustin Pop | nics = [{}] |
2005 | 0af0f641 | Iustin Pop | else:
|
2006 | 0af0f641 | Iustin Pop | # mode == import
|
2007 | 0af0f641 | Iustin Pop | nics = [] |
2008 | d77490c5 | Iustin Pop | |
2009 | d77490c5 | Iustin Pop | if opts.disk_template == constants.DT_DISKLESS:
|
2010 | d77490c5 | Iustin Pop | if opts.disks or opts.sd_size is not None: |
2011 | d77490c5 | Iustin Pop | raise errors.OpPrereqError("Diskless instance but disk" |
2012 | d77490c5 | Iustin Pop | " information passed")
|
2013 | d77490c5 | Iustin Pop | disks = [] |
2014 | d77490c5 | Iustin Pop | else:
|
2015 | 9b12ed0f | Iustin Pop | if (not opts.disks and not opts.sd_size |
2016 | 9b12ed0f | Iustin Pop | and mode == constants.INSTANCE_CREATE):
|
2017 | d77490c5 | Iustin Pop | raise errors.OpPrereqError("No disk information specified") |
2018 | d77490c5 | Iustin Pop | if opts.disks and opts.sd_size is not None: |
2019 | d77490c5 | Iustin Pop | raise errors.OpPrereqError("Please use either the '--disk' or" |
2020 | d77490c5 | Iustin Pop | " '-s' option")
|
2021 | d77490c5 | Iustin Pop | if opts.sd_size is not None: |
2022 | d77490c5 | Iustin Pop | opts.disks = [(0, {"size": opts.sd_size})] |
2023 | 9b12ed0f | Iustin Pop | |
2024 | 9b12ed0f | Iustin Pop | if opts.disks:
|
2025 | 9b12ed0f | Iustin Pop | try:
|
2026 | 9b12ed0f | Iustin Pop | disk_max = max(int(didx[0]) + 1 for didx in opts.disks) |
2027 | 9b12ed0f | Iustin Pop | except ValueError, err: |
2028 | 9b12ed0f | Iustin Pop | raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err)) |
2029 | 9b12ed0f | Iustin Pop | disks = [{}] * disk_max |
2030 | 9b12ed0f | Iustin Pop | else:
|
2031 | 9b12ed0f | Iustin Pop | disks = [] |
2032 | d77490c5 | Iustin Pop | for didx, ddict in opts.disks: |
2033 | d77490c5 | Iustin Pop | didx = int(didx)
|
2034 | d77490c5 | Iustin Pop | if not isinstance(ddict, dict): |
2035 | d77490c5 | Iustin Pop | msg = "Invalid disk/%d value: expected dict, got %s" % (didx, ddict)
|
2036 | d77490c5 | Iustin Pop | raise errors.OpPrereqError(msg)
|
2037 | 5029db65 | Iustin Pop | elif "size" in ddict: |
2038 | 5029db65 | Iustin Pop | if "adopt" in ddict: |
2039 | 5029db65 | Iustin Pop | raise errors.OpPrereqError("Only one of 'size' and 'adopt' allowed" |
2040 | 5029db65 | Iustin Pop | " (disk %d)" % didx)
|
2041 | 5029db65 | Iustin Pop | try:
|
2042 | 5029db65 | Iustin Pop | ddict["size"] = utils.ParseUnit(ddict["size"]) |
2043 | 5029db65 | Iustin Pop | except ValueError, err: |
2044 | 5029db65 | Iustin Pop | raise errors.OpPrereqError("Invalid disk size for disk %d: %s" % |
2045 | 5029db65 | Iustin Pop | (didx, err)) |
2046 | 5029db65 | Iustin Pop | elif "adopt" in ddict: |
2047 | 5029db65 | Iustin Pop | if mode == constants.INSTANCE_IMPORT:
|
2048 | 5029db65 | Iustin Pop | raise errors.OpPrereqError("Disk adoption not allowed for instance" |
2049 | 5029db65 | Iustin Pop | " import")
|
2050 | 5029db65 | Iustin Pop | ddict["size"] = 0 |
2051 | 5029db65 | Iustin Pop | else:
|
2052 | 5029db65 | Iustin Pop | raise errors.OpPrereqError("Missing size or adoption source for" |
2053 | 5029db65 | Iustin Pop | " disk %d" % didx)
|
2054 | d77490c5 | Iustin Pop | disks[didx] = ddict |
2055 | d77490c5 | Iustin Pop | |
2056 | d77490c5 | Iustin Pop | utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES) |
2057 | d77490c5 | Iustin Pop | utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES) |
2058 | d77490c5 | Iustin Pop | |
2059 | d77490c5 | Iustin Pop | if mode == constants.INSTANCE_CREATE:
|
2060 | d77490c5 | Iustin Pop | start = opts.start |
2061 | d77490c5 | Iustin Pop | os_type = opts.os |
2062 | 1ee8e01a | Guido Trotter | force_variant = opts.force_variant |
2063 | d77490c5 | Iustin Pop | src_node = None
|
2064 | d77490c5 | Iustin Pop | src_path = None
|
2065 | 25a8792c | Iustin Pop | no_install = opts.no_install |
2066 | e588764d | Iustin Pop | identify_defaults = False
|
2067 | d77490c5 | Iustin Pop | elif mode == constants.INSTANCE_IMPORT:
|
2068 | d77490c5 | Iustin Pop | start = False
|
2069 | d77490c5 | Iustin Pop | os_type = None
|
2070 | 1ee8e01a | Guido Trotter | force_variant = False
|
2071 | d77490c5 | Iustin Pop | src_node = opts.src_node |
2072 | d77490c5 | Iustin Pop | src_path = opts.src_dir |
2073 | 25a8792c | Iustin Pop | no_install = None
|
2074 | e588764d | Iustin Pop | identify_defaults = opts.identify_defaults |
2075 | d77490c5 | Iustin Pop | else:
|
2076 | d77490c5 | Iustin Pop | raise errors.ProgrammerError("Invalid creation mode %s" % mode) |
2077 | d77490c5 | Iustin Pop | |
2078 | e1530b10 | Iustin Pop | op = opcodes.OpInstanceCreate(instance_name=instance, |
2079 | d77490c5 | Iustin Pop | disks=disks, |
2080 | d77490c5 | Iustin Pop | disk_template=opts.disk_template, |
2081 | d77490c5 | Iustin Pop | nics=nics, |
2082 | d77490c5 | Iustin Pop | pnode=pnode, snode=snode, |
2083 | d77490c5 | Iustin Pop | ip_check=opts.ip_check, |
2084 | 460d22be | Iustin Pop | name_check=opts.name_check, |
2085 | d77490c5 | Iustin Pop | wait_for_sync=opts.wait_for_sync, |
2086 | d77490c5 | Iustin Pop | file_storage_dir=opts.file_storage_dir, |
2087 | d77490c5 | Iustin Pop | file_driver=opts.file_driver, |
2088 | d77490c5 | Iustin Pop | iallocator=opts.iallocator, |
2089 | d77490c5 | Iustin Pop | hypervisor=hypervisor, |
2090 | d77490c5 | Iustin Pop | hvparams=hvparams, |
2091 | d77490c5 | Iustin Pop | beparams=opts.beparams, |
2092 | 062a7100 | Iustin Pop | osparams=opts.osparams, |
2093 | d77490c5 | Iustin Pop | mode=mode, |
2094 | d77490c5 | Iustin Pop | start=start, |
2095 | d77490c5 | Iustin Pop | os_type=os_type, |
2096 | 1ee8e01a | Guido Trotter | force_variant=force_variant, |
2097 | d77490c5 | Iustin Pop | src_node=src_node, |
2098 | 25a8792c | Iustin Pop | src_path=src_path, |
2099 | e588764d | Iustin Pop | no_install=no_install, |
2100 | e588764d | Iustin Pop | identify_defaults=identify_defaults) |
2101 | d77490c5 | Iustin Pop | |
2102 | d77490c5 | Iustin Pop | SubmitOrSend(op, opts) |
2103 | d77490c5 | Iustin Pop | return 0 |
2104 | d77490c5 | Iustin Pop | |
2105 | d77490c5 | Iustin Pop | |
2106 | 7e49b6ce | Michael Hanselmann | class _RunWhileClusterStoppedHelper: |
2107 | 7e49b6ce | Michael Hanselmann | """Helper class for L{RunWhileClusterStopped} to simplify state management
|
2108 | 7e49b6ce | Michael Hanselmann |
|
2109 | 7e49b6ce | Michael Hanselmann | """
|
2110 | 7e49b6ce | Michael Hanselmann | def __init__(self, feedback_fn, cluster_name, master_node, online_nodes): |
2111 | 7e49b6ce | Michael Hanselmann | """Initializes this class.
|
2112 | 7e49b6ce | Michael Hanselmann |
|
2113 | 7e49b6ce | Michael Hanselmann | @type feedback_fn: callable
|
2114 | 7e49b6ce | Michael Hanselmann | @param feedback_fn: Feedback function
|
2115 | 7e49b6ce | Michael Hanselmann | @type cluster_name: string
|
2116 | 7e49b6ce | Michael Hanselmann | @param cluster_name: Cluster name
|
2117 | 7e49b6ce | Michael Hanselmann | @type master_node: string
|
2118 | 7e49b6ce | Michael Hanselmann | @param master_node Master node name
|
2119 | 7e49b6ce | Michael Hanselmann | @type online_nodes: list
|
2120 | 7e49b6ce | Michael Hanselmann | @param online_nodes: List of names of online nodes
|
2121 | 7e49b6ce | Michael Hanselmann |
|
2122 | 7e49b6ce | Michael Hanselmann | """
|
2123 | 7e49b6ce | Michael Hanselmann | self.feedback_fn = feedback_fn
|
2124 | 7e49b6ce | Michael Hanselmann | self.cluster_name = cluster_name
|
2125 | 7e49b6ce | Michael Hanselmann | self.master_node = master_node
|
2126 | 7e49b6ce | Michael Hanselmann | self.online_nodes = online_nodes
|
2127 | 7e49b6ce | Michael Hanselmann | |
2128 | 7e49b6ce | Michael Hanselmann | self.ssh = ssh.SshRunner(self.cluster_name) |
2129 | 7e49b6ce | Michael Hanselmann | |
2130 | 7e49b6ce | Michael Hanselmann | self.nonmaster_nodes = [name for name in online_nodes |
2131 | 7e49b6ce | Michael Hanselmann | if name != master_node]
|
2132 | 7e49b6ce | Michael Hanselmann | |
2133 | 7e49b6ce | Michael Hanselmann | assert self.master_node not in self.nonmaster_nodes |
2134 | 7e49b6ce | Michael Hanselmann | |
2135 | 7e49b6ce | Michael Hanselmann | def _RunCmd(self, node_name, cmd): |
2136 | 7e49b6ce | Michael Hanselmann | """Runs a command on the local or a remote machine.
|
2137 | 7e49b6ce | Michael Hanselmann |
|
2138 | 7e49b6ce | Michael Hanselmann | @type node_name: string
|
2139 | 7e49b6ce | Michael Hanselmann | @param node_name: Machine name
|
2140 | 7e49b6ce | Michael Hanselmann | @type cmd: list
|
2141 | 7e49b6ce | Michael Hanselmann | @param cmd: Command
|
2142 | 7e49b6ce | Michael Hanselmann |
|
2143 | 7e49b6ce | Michael Hanselmann | """
|
2144 | 7e49b6ce | Michael Hanselmann | if node_name is None or node_name == self.master_node: |
2145 | 7e49b6ce | Michael Hanselmann | # No need to use SSH
|
2146 | 7e49b6ce | Michael Hanselmann | result = utils.RunCmd(cmd) |
2147 | 7e49b6ce | Michael Hanselmann | else:
|
2148 | 7e49b6ce | Michael Hanselmann | result = self.ssh.Run(node_name, "root", utils.ShellQuoteArgs(cmd)) |
2149 | 7e49b6ce | Michael Hanselmann | |
2150 | 7e49b6ce | Michael Hanselmann | if result.failed:
|
2151 | 7e49b6ce | Michael Hanselmann | errmsg = ["Failed to run command %s" % result.cmd]
|
2152 | 7e49b6ce | Michael Hanselmann | if node_name:
|
2153 | 7e49b6ce | Michael Hanselmann | errmsg.append("on node %s" % node_name)
|
2154 | 7e49b6ce | Michael Hanselmann | errmsg.append(": exitcode %s and error %s" %
|
2155 | 7e49b6ce | Michael Hanselmann | (result.exit_code, result.output)) |
2156 | 7e49b6ce | Michael Hanselmann | raise errors.OpExecError(" ".join(errmsg)) |
2157 | 7e49b6ce | Michael Hanselmann | |
2158 | 7e49b6ce | Michael Hanselmann | def Call(self, fn, *args): |
2159 | 7e49b6ce | Michael Hanselmann | """Call function while all daemons are stopped.
|
2160 | 7e49b6ce | Michael Hanselmann |
|
2161 | 7e49b6ce | Michael Hanselmann | @type fn: callable
|
2162 | 7e49b6ce | Michael Hanselmann | @param fn: Function to be called
|
2163 | 7e49b6ce | Michael Hanselmann |
|
2164 | 7e49b6ce | Michael Hanselmann | """
|
2165 | 7e49b6ce | Michael Hanselmann | # Pause watcher by acquiring an exclusive lock on watcher state file
|
2166 | 7e49b6ce | Michael Hanselmann | self.feedback_fn("Blocking watcher") |
2167 | 7e49b6ce | Michael Hanselmann | watcher_block = utils.FileLock.Open(constants.WATCHER_STATEFILE) |
2168 | 7e49b6ce | Michael Hanselmann | try:
|
2169 | 7e49b6ce | Michael Hanselmann | # TODO: Currently, this just blocks. There's no timeout.
|
2170 | 7e49b6ce | Michael Hanselmann | # TODO: Should it be a shared lock?
|
2171 | 7e49b6ce | Michael Hanselmann | watcher_block.Exclusive(blocking=True)
|
2172 | 7e49b6ce | Michael Hanselmann | |
2173 | 7e49b6ce | Michael Hanselmann | # Stop master daemons, so that no new jobs can come in and all running
|
2174 | 7e49b6ce | Michael Hanselmann | # ones are finished
|
2175 | 7e49b6ce | Michael Hanselmann | self.feedback_fn("Stopping master daemons") |
2176 | 7e49b6ce | Michael Hanselmann | self._RunCmd(None, [constants.DAEMON_UTIL, "stop-master"]) |
2177 | 7e49b6ce | Michael Hanselmann | try:
|
2178 | 7e49b6ce | Michael Hanselmann | # Stop daemons on all nodes
|
2179 | 7e49b6ce | Michael Hanselmann | for node_name in self.online_nodes: |
2180 | 7e49b6ce | Michael Hanselmann | self.feedback_fn("Stopping daemons on %s" % node_name) |
2181 | 7e49b6ce | Michael Hanselmann | self._RunCmd(node_name, [constants.DAEMON_UTIL, "stop-all"]) |
2182 | 7e49b6ce | Michael Hanselmann | |
2183 | 7e49b6ce | Michael Hanselmann | # All daemons are shut down now
|
2184 | 7e49b6ce | Michael Hanselmann | try:
|
2185 | 7e49b6ce | Michael Hanselmann | return fn(self, *args) |
2186 | d512e84b | Michael Hanselmann | except Exception, err: |
2187 | d512e84b | Michael Hanselmann | _, errmsg = FormatError(err) |
2188 | 7e49b6ce | Michael Hanselmann | logging.exception("Caught exception")
|
2189 | d512e84b | Michael Hanselmann | self.feedback_fn(errmsg)
|
2190 | 7e49b6ce | Michael Hanselmann | raise
|
2191 | 7e49b6ce | Michael Hanselmann | finally:
|
2192 | 7e49b6ce | Michael Hanselmann | # Start cluster again, master node last
|
2193 | 7e49b6ce | Michael Hanselmann | for node_name in self.nonmaster_nodes + [self.master_node]: |
2194 | 7e49b6ce | Michael Hanselmann | self.feedback_fn("Starting daemons on %s" % node_name) |
2195 | 7e49b6ce | Michael Hanselmann | self._RunCmd(node_name, [constants.DAEMON_UTIL, "start-all"]) |
2196 | 7e49b6ce | Michael Hanselmann | finally:
|
2197 | 7e49b6ce | Michael Hanselmann | # Resume watcher
|
2198 | 7e49b6ce | Michael Hanselmann | watcher_block.Close() |
2199 | 7e49b6ce | Michael Hanselmann | |
2200 | 7e49b6ce | Michael Hanselmann | |
2201 | 7e49b6ce | Michael Hanselmann | def RunWhileClusterStopped(feedback_fn, fn, *args): |
2202 | 7e49b6ce | Michael Hanselmann | """Calls a function while all cluster daemons are stopped.
|
2203 | 7e49b6ce | Michael Hanselmann |
|
2204 | 7e49b6ce | Michael Hanselmann | @type feedback_fn: callable
|
2205 | 7e49b6ce | Michael Hanselmann | @param feedback_fn: Feedback function
|
2206 | 7e49b6ce | Michael Hanselmann | @type fn: callable
|
2207 | 7e49b6ce | Michael Hanselmann | @param fn: Function to be called when daemons are stopped
|
2208 | 7e49b6ce | Michael Hanselmann |
|
2209 | 7e49b6ce | Michael Hanselmann | """
|
2210 | 7e49b6ce | Michael Hanselmann | feedback_fn("Gathering cluster information")
|
2211 | 7e49b6ce | Michael Hanselmann | |
2212 | 7e49b6ce | Michael Hanselmann | # This ensures we're running on the master daemon
|
2213 | 7e49b6ce | Michael Hanselmann | cl = GetClient() |
2214 | 7e49b6ce | Michael Hanselmann | |
2215 | 7e49b6ce | Michael Hanselmann | (cluster_name, master_node) = \ |
2216 | 7e49b6ce | Michael Hanselmann | cl.QueryConfigValues(["cluster_name", "master_node"]) |
2217 | 7e49b6ce | Michael Hanselmann | |
2218 | 7e49b6ce | Michael Hanselmann | online_nodes = GetOnlineNodes([], cl=cl) |
2219 | 7e49b6ce | Michael Hanselmann | |
2220 | 7e49b6ce | Michael Hanselmann | # Don't keep a reference to the client. The master daemon will go away.
|
2221 | 7e49b6ce | Michael Hanselmann | del cl
|
2222 | 7e49b6ce | Michael Hanselmann | |
2223 | 7e49b6ce | Michael Hanselmann | assert master_node in online_nodes |
2224 | 7e49b6ce | Michael Hanselmann | |
2225 | 7e49b6ce | Michael Hanselmann | return _RunWhileClusterStoppedHelper(feedback_fn, cluster_name, master_node,
|
2226 | 7e49b6ce | Michael Hanselmann | online_nodes).Call(fn, *args) |
2227 | 7e49b6ce | Michael Hanselmann | |
2228 | 7e49b6ce | Michael Hanselmann | |
2229 | 16be8703 | Iustin Pop | def GenerateTable(headers, fields, separator, data, |
2230 | 9fbfbb7b | Iustin Pop | numfields=None, unitfields=None, |
2231 | 9fbfbb7b | Iustin Pop | units=None):
|
2232 | 137161c9 | Michael Hanselmann | """Prints a table with headers and different fields.
|
2233 | 137161c9 | Michael Hanselmann |
|
2234 | 9fbfbb7b | Iustin Pop | @type headers: dict
|
2235 | 9fbfbb7b | Iustin Pop | @param headers: dictionary mapping field names to headers for
|
2236 | 9fbfbb7b | Iustin Pop | the table
|
2237 | 9fbfbb7b | Iustin Pop | @type fields: list
|
2238 | 9fbfbb7b | Iustin Pop | @param fields: the field names corresponding to each row in
|
2239 | 9fbfbb7b | Iustin Pop | the data field
|
2240 | 9fbfbb7b | Iustin Pop | @param separator: the separator to be used; if this is None,
|
2241 | 9fbfbb7b | Iustin Pop | the default 'smart' algorithm is used which computes optimal
|
2242 | 9fbfbb7b | Iustin Pop | field width, otherwise just the separator is used between
|
2243 | 9fbfbb7b | Iustin Pop | each field
|
2244 | 9fbfbb7b | Iustin Pop | @type data: list
|
2245 | 9fbfbb7b | Iustin Pop | @param data: a list of lists, each sublist being one row to be output
|
2246 | 9fbfbb7b | Iustin Pop | @type numfields: list
|
2247 | 9fbfbb7b | Iustin Pop | @param numfields: a list with the fields that hold numeric
|
2248 | 9fbfbb7b | Iustin Pop | values and thus should be right-aligned
|
2249 | 9fbfbb7b | Iustin Pop | @type unitfields: list
|
2250 | 9fbfbb7b | Iustin Pop | @param unitfields: a list with the fields that hold numeric
|
2251 | 9fbfbb7b | Iustin Pop | values that should be formatted with the units field
|
2252 | 9fbfbb7b | Iustin Pop | @type units: string or None
|
2253 | 9fbfbb7b | Iustin Pop | @param units: the units we should use for formatting, or None for
|
2254 | 9fbfbb7b | Iustin Pop | automatic choice (human-readable for non-separator usage, otherwise
|
2255 | 9fbfbb7b | Iustin Pop | megabytes); this is a one-letter string
|
2256 | 137161c9 | Michael Hanselmann |
|
2257 | 137161c9 | Michael Hanselmann | """
|
2258 | 9fbfbb7b | Iustin Pop | if units is None: |
2259 | 9fbfbb7b | Iustin Pop | if separator:
|
2260 | 9fbfbb7b | Iustin Pop | units = "m"
|
2261 | 9fbfbb7b | Iustin Pop | else:
|
2262 | 9fbfbb7b | Iustin Pop | units = "h"
|
2263 | 9fbfbb7b | Iustin Pop | |
2264 | 137161c9 | Michael Hanselmann | if numfields is None: |
2265 | 137161c9 | Michael Hanselmann | numfields = [] |
2266 | 137161c9 | Michael Hanselmann | if unitfields is None: |
2267 | 137161c9 | Michael Hanselmann | unitfields = [] |
2268 | 137161c9 | Michael Hanselmann | |
2269 | fe267188 | Iustin Pop | numfields = utils.FieldSet(*numfields) # pylint: disable-msg=W0142
|
2270 | fe267188 | Iustin Pop | unitfields = utils.FieldSet(*unitfields) # pylint: disable-msg=W0142
|
2271 | 00430f8e | Iustin Pop | |
2272 | 137161c9 | Michael Hanselmann | format_fields = [] |
2273 | 137161c9 | Michael Hanselmann | for field in fields: |
2274 | 01ca31ae | Iustin Pop | if headers and field not in headers: |
2275 | ea5a5b74 | Guido Trotter | # TODO: handle better unknown fields (either revert to old
|
2276 | 71c1af58 | Iustin Pop | # style of raising exception, or deal more intelligently with
|
2277 | 71c1af58 | Iustin Pop | # variable fields)
|
2278 | 71c1af58 | Iustin Pop | headers[field] = field |
2279 | 137161c9 | Michael Hanselmann | if separator is not None: |
2280 | 137161c9 | Michael Hanselmann | format_fields.append("%s")
|
2281 | 00430f8e | Iustin Pop | elif numfields.Matches(field):
|
2282 | 137161c9 | Michael Hanselmann | format_fields.append("%*s")
|
2283 | 137161c9 | Michael Hanselmann | else:
|
2284 | 137161c9 | Michael Hanselmann | format_fields.append("%-*s")
|
2285 | 137161c9 | Michael Hanselmann | |
2286 | 137161c9 | Michael Hanselmann | if separator is None: |
2287 | 137161c9 | Michael Hanselmann | mlens = [0 for name in fields] |
2288 | c04bc777 | Iustin Pop | format_str = ' '.join(format_fields)
|
2289 | 137161c9 | Michael Hanselmann | else:
|
2290 | c04bc777 | Iustin Pop | format_str = separator.replace("%", "%%").join(format_fields) |
2291 | 137161c9 | Michael Hanselmann | |
2292 | 137161c9 | Michael Hanselmann | for row in data: |
2293 | dcbd6288 | Guido Trotter | if row is None: |
2294 | dcbd6288 | Guido Trotter | continue
|
2295 | 137161c9 | Michael Hanselmann | for idx, val in enumerate(row): |
2296 | 00430f8e | Iustin Pop | if unitfields.Matches(fields[idx]):
|
2297 | 137161c9 | Michael Hanselmann | try:
|
2298 | 137161c9 | Michael Hanselmann | val = int(val)
|
2299 | 691744c4 | Iustin Pop | except (TypeError, ValueError): |
2300 | 137161c9 | Michael Hanselmann | pass
|
2301 | 137161c9 | Michael Hanselmann | else:
|
2302 | 9fbfbb7b | Iustin Pop | val = row[idx] = utils.FormatUnit(val, units) |
2303 | 01ca31ae | Iustin Pop | val = row[idx] = str(val)
|
2304 | 137161c9 | Michael Hanselmann | if separator is None: |
2305 | 137161c9 | Michael Hanselmann | mlens[idx] = max(mlens[idx], len(val)) |
2306 | 137161c9 | Michael Hanselmann | |
2307 | 16be8703 | Iustin Pop | result = [] |
2308 | 137161c9 | Michael Hanselmann | if headers:
|
2309 | 137161c9 | Michael Hanselmann | args = [] |
2310 | 137161c9 | Michael Hanselmann | for idx, name in enumerate(fields): |
2311 | 137161c9 | Michael Hanselmann | hdr = headers[name] |
2312 | 137161c9 | Michael Hanselmann | if separator is None: |
2313 | 137161c9 | Michael Hanselmann | mlens[idx] = max(mlens[idx], len(hdr)) |
2314 | 137161c9 | Michael Hanselmann | args.append(mlens[idx]) |
2315 | 137161c9 | Michael Hanselmann | args.append(hdr) |
2316 | c04bc777 | Iustin Pop | result.append(format_str % tuple(args))
|
2317 | 137161c9 | Michael Hanselmann | |
2318 | ec39d63c | Michael Hanselmann | if separator is None: |
2319 | ec39d63c | Michael Hanselmann | assert len(mlens) == len(fields) |
2320 | ec39d63c | Michael Hanselmann | |
2321 | ec39d63c | Michael Hanselmann | if fields and not numfields.Matches(fields[-1]): |
2322 | ec39d63c | Michael Hanselmann | mlens[-1] = 0 |
2323 | ec39d63c | Michael Hanselmann | |
2324 | 137161c9 | Michael Hanselmann | for line in data: |
2325 | 137161c9 | Michael Hanselmann | args = [] |
2326 | dcbd6288 | Guido Trotter | if line is None: |
2327 | dcbd6288 | Guido Trotter | line = ['-' for _ in fields] |
2328 | f1501b3f | Michael Hanselmann | for idx in range(len(fields)): |
2329 | 137161c9 | Michael Hanselmann | if separator is None: |
2330 | 137161c9 | Michael Hanselmann | args.append(mlens[idx]) |
2331 | 137161c9 | Michael Hanselmann | args.append(line[idx]) |
2332 | c04bc777 | Iustin Pop | result.append(format_str % tuple(args))
|
2333 | 16be8703 | Iustin Pop | |
2334 | 16be8703 | Iustin Pop | return result
|
2335 | 3386e7a9 | Iustin Pop | |
2336 | 3386e7a9 | Iustin Pop | |
2337 | ee3aedff | Michael Hanselmann | def _FormatBool(value): |
2338 | ee3aedff | Michael Hanselmann | """Formats a boolean value as a string.
|
2339 | ee3aedff | Michael Hanselmann |
|
2340 | ee3aedff | Michael Hanselmann | """
|
2341 | ee3aedff | Michael Hanselmann | if value:
|
2342 | ee3aedff | Michael Hanselmann | return "Y" |
2343 | ee3aedff | Michael Hanselmann | return "N" |
2344 | ee3aedff | Michael Hanselmann | |
2345 | ee3aedff | Michael Hanselmann | |
2346 | ee3aedff | Michael Hanselmann | #: Default formatting for query results; (callback, align right)
|
2347 | ee3aedff | Michael Hanselmann | _DEFAULT_FORMAT_QUERY = { |
2348 | ee3aedff | Michael Hanselmann | constants.QFT_TEXT: (str, False), |
2349 | ee3aedff | Michael Hanselmann | constants.QFT_BOOL: (_FormatBool, False),
|
2350 | ee3aedff | Michael Hanselmann | constants.QFT_NUMBER: (str, True), |
2351 | ee3aedff | Michael Hanselmann | constants.QFT_TIMESTAMP: (utils.FormatTime, False),
|
2352 | ee3aedff | Michael Hanselmann | constants.QFT_OTHER: (str, False), |
2353 | ee3aedff | Michael Hanselmann | constants.QFT_UNKNOWN: (str, False), |
2354 | ee3aedff | Michael Hanselmann | } |
2355 | ee3aedff | Michael Hanselmann | |
2356 | ee3aedff | Michael Hanselmann | |
2357 | ee3aedff | Michael Hanselmann | def _GetColumnFormatter(fdef, override, unit): |
2358 | ee3aedff | Michael Hanselmann | """Returns formatting function for a field.
|
2359 | ee3aedff | Michael Hanselmann |
|
2360 | ee3aedff | Michael Hanselmann | @type fdef: L{objects.QueryFieldDefinition}
|
2361 | ee3aedff | Michael Hanselmann | @type override: dict
|
2362 | ee3aedff | Michael Hanselmann | @param override: Dictionary for overriding field formatting functions,
|
2363 | ee3aedff | Michael Hanselmann | indexed by field name, contents like L{_DEFAULT_FORMAT_QUERY}
|
2364 | ee3aedff | Michael Hanselmann | @type unit: string
|
2365 | ee3aedff | Michael Hanselmann | @param unit: Unit used for formatting fields of type L{constants.QFT_UNIT}
|
2366 | ee3aedff | Michael Hanselmann | @rtype: tuple; (callable, bool)
|
2367 | ee3aedff | Michael Hanselmann | @return: Returns the function to format a value (takes one parameter) and a
|
2368 | ee3aedff | Michael Hanselmann | boolean for aligning the value on the right-hand side
|
2369 | ee3aedff | Michael Hanselmann |
|
2370 | ee3aedff | Michael Hanselmann | """
|
2371 | ee3aedff | Michael Hanselmann | fmt = override.get(fdef.name, None)
|
2372 | ee3aedff | Michael Hanselmann | if fmt is not None: |
2373 | ee3aedff | Michael Hanselmann | return fmt
|
2374 | ee3aedff | Michael Hanselmann | |
2375 | ee3aedff | Michael Hanselmann | assert constants.QFT_UNIT not in _DEFAULT_FORMAT_QUERY |
2376 | ee3aedff | Michael Hanselmann | |
2377 | ee3aedff | Michael Hanselmann | if fdef.kind == constants.QFT_UNIT:
|
2378 | ee3aedff | Michael Hanselmann | # Can't keep this information in the static dictionary
|
2379 | ee3aedff | Michael Hanselmann | return (lambda value: utils.FormatUnit(value, unit), True) |
2380 | ee3aedff | Michael Hanselmann | |
2381 | ee3aedff | Michael Hanselmann | fmt = _DEFAULT_FORMAT_QUERY.get(fdef.kind, None)
|
2382 | ee3aedff | Michael Hanselmann | if fmt is not None: |
2383 | ee3aedff | Michael Hanselmann | return fmt
|
2384 | ee3aedff | Michael Hanselmann | |
2385 | ee3aedff | Michael Hanselmann | raise NotImplementedError("Can't format column type '%s'" % fdef.kind) |
2386 | ee3aedff | Michael Hanselmann | |
2387 | ee3aedff | Michael Hanselmann | |
2388 | ee3aedff | Michael Hanselmann | class _QueryColumnFormatter: |
2389 | ee3aedff | Michael Hanselmann | """Callable class for formatting fields of a query.
|
2390 | ee3aedff | Michael Hanselmann |
|
2391 | ee3aedff | Michael Hanselmann | """
|
2392 | f0b1bafe | Iustin Pop | def __init__(self, fn, status_fn, verbose): |
2393 | ee3aedff | Michael Hanselmann | """Initializes this class.
|
2394 | ee3aedff | Michael Hanselmann |
|
2395 | ee3aedff | Michael Hanselmann | @type fn: callable
|
2396 | ee3aedff | Michael Hanselmann | @param fn: Formatting function
|
2397 | ee3aedff | Michael Hanselmann | @type status_fn: callable
|
2398 | ee3aedff | Michael Hanselmann | @param status_fn: Function to report fields' status
|
2399 | f0b1bafe | Iustin Pop | @type verbose: boolean
|
2400 | f0b1bafe | Iustin Pop | @param verbose: whether to use verbose field descriptions or not
|
2401 | ee3aedff | Michael Hanselmann |
|
2402 | ee3aedff | Michael Hanselmann | """
|
2403 | ee3aedff | Michael Hanselmann | self._fn = fn
|
2404 | ee3aedff | Michael Hanselmann | self._status_fn = status_fn
|
2405 | f0b1bafe | Iustin Pop | if verbose:
|
2406 | f0b1bafe | Iustin Pop | self._desc_index = 0 |
2407 | f0b1bafe | Iustin Pop | else:
|
2408 | f0b1bafe | Iustin Pop | self._desc_index = 1 |
2409 | ee3aedff | Michael Hanselmann | |
2410 | ee3aedff | Michael Hanselmann | def __call__(self, data): |
2411 | ee3aedff | Michael Hanselmann | """Returns a field's string representation.
|
2412 | ee3aedff | Michael Hanselmann |
|
2413 | ee3aedff | Michael Hanselmann | """
|
2414 | ee3aedff | Michael Hanselmann | (status, value) = data |
2415 | ee3aedff | Michael Hanselmann | |
2416 | ee3aedff | Michael Hanselmann | # Report status
|
2417 | ee3aedff | Michael Hanselmann | self._status_fn(status)
|
2418 | ee3aedff | Michael Hanselmann | |
2419 | cfb084ae | René Nussbaumer | if status == constants.RS_NORMAL:
|
2420 | ee3aedff | Michael Hanselmann | return self._fn(value) |
2421 | ee3aedff | Michael Hanselmann | |
2422 | ee3aedff | Michael Hanselmann | assert value is None, \ |
2423 | ee3aedff | Michael Hanselmann | "Found value %r for abnormal status %s" % (value, status)
|
2424 | ee3aedff | Michael Hanselmann | |
2425 | f0b1bafe | Iustin Pop | if status in constants.RSS_DESCRIPTION: |
2426 | f0b1bafe | Iustin Pop | return constants.RSS_DESCRIPTION[status][self._desc_index] |
2427 | a6070ef7 | Michael Hanselmann | |
2428 | ee3aedff | Michael Hanselmann | raise NotImplementedError("Unknown status %s" % status) |
2429 | ee3aedff | Michael Hanselmann | |
2430 | ee3aedff | Michael Hanselmann | |
2431 | ee3aedff | Michael Hanselmann | def FormatQueryResult(result, unit=None, format_override=None, separator=None, |
2432 | f0b1bafe | Iustin Pop | header=False, verbose=False): |
2433 | ee3aedff | Michael Hanselmann | """Formats data in L{objects.QueryResponse}.
|
2434 | ee3aedff | Michael Hanselmann |
|
2435 | ee3aedff | Michael Hanselmann | @type result: L{objects.QueryResponse}
|
2436 | ee3aedff | Michael Hanselmann | @param result: result of query operation
|
2437 | ee3aedff | Michael Hanselmann | @type unit: string
|
2438 | ee3aedff | Michael Hanselmann | @param unit: Unit used for formatting fields of type L{constants.QFT_UNIT},
|
2439 | 18009c1e | Iustin Pop | see L{utils.text.FormatUnit}
|
2440 | ee3aedff | Michael Hanselmann | @type format_override: dict
|
2441 | ee3aedff | Michael Hanselmann | @param format_override: Dictionary for overriding field formatting functions,
|
2442 | ee3aedff | Michael Hanselmann | indexed by field name, contents like L{_DEFAULT_FORMAT_QUERY}
|
2443 | ee3aedff | Michael Hanselmann | @type separator: string or None
|
2444 | ee3aedff | Michael Hanselmann | @param separator: String used to separate fields
|
2445 | ee3aedff | Michael Hanselmann | @type header: bool
|
2446 | ee3aedff | Michael Hanselmann | @param header: Whether to output header row
|
2447 | f0b1bafe | Iustin Pop | @type verbose: boolean
|
2448 | f0b1bafe | Iustin Pop | @param verbose: whether to use verbose field descriptions or not
|
2449 | ee3aedff | Michael Hanselmann |
|
2450 | ee3aedff | Michael Hanselmann | """
|
2451 | ee3aedff | Michael Hanselmann | if unit is None: |
2452 | ee3aedff | Michael Hanselmann | if separator:
|
2453 | ee3aedff | Michael Hanselmann | unit = "m"
|
2454 | ee3aedff | Michael Hanselmann | else:
|
2455 | ee3aedff | Michael Hanselmann | unit = "h"
|
2456 | ee3aedff | Michael Hanselmann | |
2457 | ee3aedff | Michael Hanselmann | if format_override is None: |
2458 | ee3aedff | Michael Hanselmann | format_override = {} |
2459 | ee3aedff | Michael Hanselmann | |
2460 | cfb084ae | René Nussbaumer | stats = dict.fromkeys(constants.RS_ALL, 0) |
2461 | ee3aedff | Michael Hanselmann | |
2462 | ee3aedff | Michael Hanselmann | def _RecordStatus(status): |
2463 | ee3aedff | Michael Hanselmann | if status in stats: |
2464 | ee3aedff | Michael Hanselmann | stats[status] += 1
|
2465 | ee3aedff | Michael Hanselmann | |
2466 | ee3aedff | Michael Hanselmann | columns = [] |
2467 | ee3aedff | Michael Hanselmann | for fdef in result.fields: |
2468 | ee3aedff | Michael Hanselmann | assert fdef.title and fdef.name |
2469 | ee3aedff | Michael Hanselmann | (fn, align_right) = _GetColumnFormatter(fdef, format_override, unit) |
2470 | ee3aedff | Michael Hanselmann | columns.append(TableColumn(fdef.title, |
2471 | f0b1bafe | Iustin Pop | _QueryColumnFormatter(fn, _RecordStatus, |
2472 | f0b1bafe | Iustin Pop | verbose), |
2473 | ee3aedff | Michael Hanselmann | align_right)) |
2474 | ee3aedff | Michael Hanselmann | |
2475 | ee3aedff | Michael Hanselmann | table = FormatTable(result.data, columns, header, separator) |
2476 | ee3aedff | Michael Hanselmann | |
2477 | ee3aedff | Michael Hanselmann | # Collect statistics
|
2478 | cfb084ae | René Nussbaumer | assert len(stats) == len(constants.RS_ALL) |
2479 | ee3aedff | Michael Hanselmann | assert compat.all(count >= 0 for count in stats.values()) |
2480 | ee3aedff | Michael Hanselmann | |
2481 | ee3aedff | Michael Hanselmann | # Determine overall status. If there was no data, unknown fields must be
|
2482 | ee3aedff | Michael Hanselmann | # detected via the field definitions.
|
2483 | cfb084ae | René Nussbaumer | if (stats[constants.RS_UNKNOWN] or |
2484 | ee3aedff | Michael Hanselmann | (not result.data and _GetUnknownFields(result.fields))): |
2485 | ee3aedff | Michael Hanselmann | status = QR_UNKNOWN |
2486 | ee3aedff | Michael Hanselmann | elif compat.any(count > 0 for key, count in stats.items() |
2487 | cfb084ae | René Nussbaumer | if key != constants.RS_NORMAL):
|
2488 | ee3aedff | Michael Hanselmann | status = QR_INCOMPLETE |
2489 | ee3aedff | Michael Hanselmann | else:
|
2490 | ee3aedff | Michael Hanselmann | status = QR_NORMAL |
2491 | ee3aedff | Michael Hanselmann | |
2492 | ee3aedff | Michael Hanselmann | return (status, table)
|
2493 | ee3aedff | Michael Hanselmann | |
2494 | ee3aedff | Michael Hanselmann | |
2495 | ee3aedff | Michael Hanselmann | def _GetUnknownFields(fdefs): |
2496 | ee3aedff | Michael Hanselmann | """Returns list of unknown fields included in C{fdefs}.
|
2497 | ee3aedff | Michael Hanselmann |
|
2498 | ee3aedff | Michael Hanselmann | @type fdefs: list of L{objects.QueryFieldDefinition}
|
2499 | ee3aedff | Michael Hanselmann |
|
2500 | ee3aedff | Michael Hanselmann | """
|
2501 | ee3aedff | Michael Hanselmann | return [fdef for fdef in fdefs |
2502 | ee3aedff | Michael Hanselmann | if fdef.kind == constants.QFT_UNKNOWN]
|
2503 | ee3aedff | Michael Hanselmann | |
2504 | ee3aedff | Michael Hanselmann | |
2505 | ee3aedff | Michael Hanselmann | def _WarnUnknownFields(fdefs): |
2506 | ee3aedff | Michael Hanselmann | """Prints a warning to stderr if a query included unknown fields.
|
2507 | ee3aedff | Michael Hanselmann |
|
2508 | ee3aedff | Michael Hanselmann | @type fdefs: list of L{objects.QueryFieldDefinition}
|
2509 | ee3aedff | Michael Hanselmann |
|
2510 | ee3aedff | Michael Hanselmann | """
|
2511 | ee3aedff | Michael Hanselmann | unknown = _GetUnknownFields(fdefs) |
2512 | ee3aedff | Michael Hanselmann | if unknown:
|
2513 | ee3aedff | Michael Hanselmann | ToStderr("Warning: Queried for unknown fields %s",
|
2514 | ee3aedff | Michael Hanselmann | utils.CommaJoin(fdef.name for fdef in unknown)) |
2515 | ee3aedff | Michael Hanselmann | return True |
2516 | ee3aedff | Michael Hanselmann | |
2517 | ee3aedff | Michael Hanselmann | return False |
2518 | ee3aedff | Michael Hanselmann | |
2519 | ee3aedff | Michael Hanselmann | |
2520 | ee3aedff | Michael Hanselmann | def GenericList(resource, fields, names, unit, separator, header, cl=None, |
2521 | f0b1bafe | Iustin Pop | format_override=None, verbose=False): |
2522 | ee3aedff | Michael Hanselmann | """Generic implementation for listing all items of a resource.
|
2523 | ee3aedff | Michael Hanselmann |
|
2524 | ee3aedff | Michael Hanselmann | @param resource: One of L{constants.QR_OP_LUXI}
|
2525 | ee3aedff | Michael Hanselmann | @type fields: list of strings
|
2526 | ee3aedff | Michael Hanselmann | @param fields: List of fields to query for
|
2527 | ee3aedff | Michael Hanselmann | @type names: list of strings
|
2528 | ee3aedff | Michael Hanselmann | @param names: Names of items to query for
|
2529 | ee3aedff | Michael Hanselmann | @type unit: string or None
|
2530 | ee3aedff | Michael Hanselmann | @param unit: Unit used for formatting fields of type L{constants.QFT_UNIT} or
|
2531 | ee3aedff | Michael Hanselmann | None for automatic choice (human-readable for non-separator usage,
|
2532 | ee3aedff | Michael Hanselmann | otherwise megabytes); this is a one-letter string
|
2533 | ee3aedff | Michael Hanselmann | @type separator: string or None
|
2534 | ee3aedff | Michael Hanselmann | @param separator: String used to separate fields
|
2535 | ee3aedff | Michael Hanselmann | @type header: bool
|
2536 | ee3aedff | Michael Hanselmann | @param header: Whether to show header row
|
2537 | ee3aedff | Michael Hanselmann | @type format_override: dict
|
2538 | ee3aedff | Michael Hanselmann | @param format_override: Dictionary for overriding field formatting functions,
|
2539 | ee3aedff | Michael Hanselmann | indexed by field name, contents like L{_DEFAULT_FORMAT_QUERY}
|
2540 | f0b1bafe | Iustin Pop | @type verbose: boolean
|
2541 | f0b1bafe | Iustin Pop | @param verbose: whether to use verbose field descriptions or not
|
2542 | ee3aedff | Michael Hanselmann |
|
2543 | ee3aedff | Michael Hanselmann | """
|
2544 | ee3aedff | Michael Hanselmann | if cl is None: |
2545 | ee3aedff | Michael Hanselmann | cl = GetClient() |
2546 | ee3aedff | Michael Hanselmann | |
2547 | ee3aedff | Michael Hanselmann | if not names: |
2548 | ee3aedff | Michael Hanselmann | names = None
|
2549 | ee3aedff | Michael Hanselmann | |
2550 | ee3aedff | Michael Hanselmann | response = cl.Query(resource, fields, qlang.MakeSimpleFilter("name", names))
|
2551 | ee3aedff | Michael Hanselmann | |
2552 | ee3aedff | Michael Hanselmann | found_unknown = _WarnUnknownFields(response.fields) |
2553 | ee3aedff | Michael Hanselmann | |
2554 | ee3aedff | Michael Hanselmann | (status, data) = FormatQueryResult(response, unit=unit, separator=separator, |
2555 | ee3aedff | Michael Hanselmann | header=header, |
2556 | f0b1bafe | Iustin Pop | format_override=format_override, |
2557 | f0b1bafe | Iustin Pop | verbose=verbose) |
2558 | ee3aedff | Michael Hanselmann | |
2559 | ee3aedff | Michael Hanselmann | for line in data: |
2560 | ee3aedff | Michael Hanselmann | ToStdout(line) |
2561 | ee3aedff | Michael Hanselmann | |
2562 | ee3aedff | Michael Hanselmann | assert ((found_unknown and status == QR_UNKNOWN) or |
2563 | ee3aedff | Michael Hanselmann | (not found_unknown and status != QR_UNKNOWN)) |
2564 | ee3aedff | Michael Hanselmann | |
2565 | ee3aedff | Michael Hanselmann | if status == QR_UNKNOWN:
|
2566 | ee3aedff | Michael Hanselmann | return constants.EXIT_UNKNOWN_FIELD
|
2567 | ee3aedff | Michael Hanselmann | |
2568 | ee3aedff | Michael Hanselmann | # TODO: Should the list command fail if not all data could be collected?
|
2569 | ee3aedff | Michael Hanselmann | return constants.EXIT_SUCCESS
|
2570 | ee3aedff | Michael Hanselmann | |
2571 | ee3aedff | Michael Hanselmann | |
2572 | ee3aedff | Michael Hanselmann | def GenericListFields(resource, fields, separator, header, cl=None): |
2573 | ee3aedff | Michael Hanselmann | """Generic implementation for listing fields for a resource.
|
2574 | ee3aedff | Michael Hanselmann |
|
2575 | ee3aedff | Michael Hanselmann | @param resource: One of L{constants.QR_OP_LUXI}
|
2576 | ee3aedff | Michael Hanselmann | @type fields: list of strings
|
2577 | ee3aedff | Michael Hanselmann | @param fields: List of fields to query for
|
2578 | ee3aedff | Michael Hanselmann | @type separator: string or None
|
2579 | ee3aedff | Michael Hanselmann | @param separator: String used to separate fields
|
2580 | ee3aedff | Michael Hanselmann | @type header: bool
|
2581 | ee3aedff | Michael Hanselmann | @param header: Whether to show header row
|
2582 | ee3aedff | Michael Hanselmann |
|
2583 | ee3aedff | Michael Hanselmann | """
|
2584 | ee3aedff | Michael Hanselmann | if cl is None: |
2585 | ee3aedff | Michael Hanselmann | cl = GetClient() |
2586 | ee3aedff | Michael Hanselmann | |
2587 | ee3aedff | Michael Hanselmann | if not fields: |
2588 | ee3aedff | Michael Hanselmann | fields = None
|
2589 | ee3aedff | Michael Hanselmann | |
2590 | ee3aedff | Michael Hanselmann | response = cl.QueryFields(resource, fields) |
2591 | ee3aedff | Michael Hanselmann | |
2592 | ee3aedff | Michael Hanselmann | found_unknown = _WarnUnknownFields(response.fields) |
2593 | ee3aedff | Michael Hanselmann | |
2594 | ee3aedff | Michael Hanselmann | columns = [ |
2595 | ee3aedff | Michael Hanselmann | TableColumn("Name", str, False), |
2596 | ee3aedff | Michael Hanselmann | TableColumn("Title", str, False), |
2597 | ee3aedff | Michael Hanselmann | # TODO: Add field description to master daemon
|
2598 | ee3aedff | Michael Hanselmann | ] |
2599 | ee3aedff | Michael Hanselmann | |
2600 | ee3aedff | Michael Hanselmann | rows = [[fdef.name, fdef.title] for fdef in response.fields] |
2601 | ee3aedff | Michael Hanselmann | |
2602 | ee3aedff | Michael Hanselmann | for line in FormatTable(rows, columns, header, separator): |
2603 | ee3aedff | Michael Hanselmann | ToStdout(line) |
2604 | ee3aedff | Michael Hanselmann | |
2605 | ee3aedff | Michael Hanselmann | if found_unknown:
|
2606 | ee3aedff | Michael Hanselmann | return constants.EXIT_UNKNOWN_FIELD
|
2607 | ee3aedff | Michael Hanselmann | |
2608 | ee3aedff | Michael Hanselmann | return constants.EXIT_SUCCESS
|
2609 | ee3aedff | Michael Hanselmann | |
2610 | ee3aedff | Michael Hanselmann | |
2611 | ee3aedff | Michael Hanselmann | class TableColumn: |
2612 | ee3aedff | Michael Hanselmann | """Describes a column for L{FormatTable}.
|
2613 | ee3aedff | Michael Hanselmann |
|
2614 | ee3aedff | Michael Hanselmann | """
|
2615 | ee3aedff | Michael Hanselmann | def __init__(self, title, fn, align_right): |
2616 | ee3aedff | Michael Hanselmann | """Initializes this class.
|
2617 | ee3aedff | Michael Hanselmann |
|
2618 | ee3aedff | Michael Hanselmann | @type title: string
|
2619 | ee3aedff | Michael Hanselmann | @param title: Column title
|
2620 | ee3aedff | Michael Hanselmann | @type fn: callable
|
2621 | ee3aedff | Michael Hanselmann | @param fn: Formatting function
|
2622 | ee3aedff | Michael Hanselmann | @type align_right: bool
|
2623 | ee3aedff | Michael Hanselmann | @param align_right: Whether to align values on the right-hand side
|
2624 | ee3aedff | Michael Hanselmann |
|
2625 | ee3aedff | Michael Hanselmann | """
|
2626 | ee3aedff | Michael Hanselmann | self.title = title
|
2627 | ee3aedff | Michael Hanselmann | self.format = fn
|
2628 | ee3aedff | Michael Hanselmann | self.align_right = align_right
|
2629 | ee3aedff | Michael Hanselmann | |
2630 | ee3aedff | Michael Hanselmann | |
2631 | ee3aedff | Michael Hanselmann | def _GetColFormatString(width, align_right): |
2632 | ee3aedff | Michael Hanselmann | """Returns the format string for a field.
|
2633 | ee3aedff | Michael Hanselmann |
|
2634 | ee3aedff | Michael Hanselmann | """
|
2635 | ee3aedff | Michael Hanselmann | if align_right:
|
2636 | ee3aedff | Michael Hanselmann | sign = ""
|
2637 | ee3aedff | Michael Hanselmann | else:
|
2638 | ee3aedff | Michael Hanselmann | sign = "-"
|
2639 | ee3aedff | Michael Hanselmann | |
2640 | ee3aedff | Michael Hanselmann | return "%%%s%ss" % (sign, width) |
2641 | ee3aedff | Michael Hanselmann | |
2642 | ee3aedff | Michael Hanselmann | |
2643 | ee3aedff | Michael Hanselmann | def FormatTable(rows, columns, header, separator): |
2644 | ee3aedff | Michael Hanselmann | """Formats data as a table.
|
2645 | ee3aedff | Michael Hanselmann |
|
2646 | ee3aedff | Michael Hanselmann | @type rows: list of lists
|
2647 | ee3aedff | Michael Hanselmann | @param rows: Row data, one list per row
|
2648 | ee3aedff | Michael Hanselmann | @type columns: list of L{TableColumn}
|
2649 | ee3aedff | Michael Hanselmann | @param columns: Column descriptions
|
2650 | ee3aedff | Michael Hanselmann | @type header: bool
|
2651 | ee3aedff | Michael Hanselmann | @param header: Whether to show header row
|
2652 | ee3aedff | Michael Hanselmann | @type separator: string or None
|
2653 | ee3aedff | Michael Hanselmann | @param separator: String used to separate columns
|
2654 | ee3aedff | Michael Hanselmann |
|
2655 | ee3aedff | Michael Hanselmann | """
|
2656 | ee3aedff | Michael Hanselmann | if header:
|
2657 | ee3aedff | Michael Hanselmann | data = [[col.title for col in columns]] |
2658 | ee3aedff | Michael Hanselmann | colwidth = [len(col.title) for col in columns] |
2659 | ee3aedff | Michael Hanselmann | else:
|
2660 | ee3aedff | Michael Hanselmann | data = [] |
2661 | ee3aedff | Michael Hanselmann | colwidth = [0 for _ in columns] |
2662 | ee3aedff | Michael Hanselmann | |
2663 | ee3aedff | Michael Hanselmann | # Format row data
|
2664 | ee3aedff | Michael Hanselmann | for row in rows: |
2665 | ee3aedff | Michael Hanselmann | assert len(row) == len(columns) |
2666 | ee3aedff | Michael Hanselmann | |
2667 | ee3aedff | Michael Hanselmann | formatted = [col.format(value) for value, col in zip(row, columns)] |
2668 | ee3aedff | Michael Hanselmann | |
2669 | ee3aedff | Michael Hanselmann | if separator is None: |
2670 | ee3aedff | Michael Hanselmann | # Update column widths
|
2671 | ee3aedff | Michael Hanselmann | for idx, (oldwidth, value) in enumerate(zip(colwidth, formatted)): |
2672 | ee3aedff | Michael Hanselmann | # Modifying a list's items while iterating is fine
|
2673 | ee3aedff | Michael Hanselmann | colwidth[idx] = max(oldwidth, len(value)) |
2674 | ee3aedff | Michael Hanselmann | |
2675 | ee3aedff | Michael Hanselmann | data.append(formatted) |
2676 | ee3aedff | Michael Hanselmann | |
2677 | ee3aedff | Michael Hanselmann | if separator is not None: |
2678 | ee3aedff | Michael Hanselmann | # Return early if a separator is used
|
2679 | ee3aedff | Michael Hanselmann | return [separator.join(row) for row in data] |
2680 | ee3aedff | Michael Hanselmann | |
2681 | ee3aedff | Michael Hanselmann | if columns and not columns[-1].align_right: |
2682 | ee3aedff | Michael Hanselmann | # Avoid unnecessary spaces at end of line
|
2683 | ee3aedff | Michael Hanselmann | colwidth[-1] = 0 |
2684 | ee3aedff | Michael Hanselmann | |
2685 | ee3aedff | Michael Hanselmann | # Build format string
|
2686 | ee3aedff | Michael Hanselmann | fmt = " ".join([_GetColFormatString(width, col.align_right)
|
2687 | ee3aedff | Michael Hanselmann | for col, width in zip(columns, colwidth)]) |
2688 | ee3aedff | Michael Hanselmann | |
2689 | ee3aedff | Michael Hanselmann | return [fmt % tuple(row) for row in data] |
2690 | ee3aedff | Michael Hanselmann | |
2691 | ee3aedff | Michael Hanselmann | |
2692 | 3386e7a9 | Iustin Pop | def FormatTimestamp(ts): |
2693 | 3386e7a9 | Iustin Pop | """Formats a given timestamp.
|
2694 | 3386e7a9 | Iustin Pop |
|
2695 | 3386e7a9 | Iustin Pop | @type ts: timestamp
|
2696 | 3386e7a9 | Iustin Pop | @param ts: a timeval-type timestamp, a tuple of seconds and microseconds
|
2697 | 3386e7a9 | Iustin Pop |
|
2698 | 3386e7a9 | Iustin Pop | @rtype: string
|
2699 | 5fcc718f | Iustin Pop | @return: a string with the formatted timestamp
|
2700 | 3386e7a9 | Iustin Pop |
|
2701 | 3386e7a9 | Iustin Pop | """
|
2702 | e0ec0ff6 | Iustin Pop | if not isinstance (ts, (tuple, list)) or len(ts) != 2: |
2703 | e0ec0ff6 | Iustin Pop | return '?' |
2704 | 3386e7a9 | Iustin Pop | sec, usec = ts |
2705 | 3386e7a9 | Iustin Pop | return time.strftime("%F %T", time.localtime(sec)) + ".%06d" % usec |
2706 | 2241e2b9 | Iustin Pop | |
2707 | 2241e2b9 | Iustin Pop | |
2708 | 2241e2b9 | Iustin Pop | def ParseTimespec(value): |
2709 | 2241e2b9 | Iustin Pop | """Parse a time specification.
|
2710 | 2241e2b9 | Iustin Pop |
|
2711 | 2241e2b9 | Iustin Pop | The following suffixed will be recognized:
|
2712 | 2241e2b9 | Iustin Pop |
|
2713 | 2241e2b9 | Iustin Pop | - s: seconds
|
2714 | 2241e2b9 | Iustin Pop | - m: minutes
|
2715 | 2241e2b9 | Iustin Pop | - h: hours
|
2716 | 2241e2b9 | Iustin Pop | - d: day
|
2717 | 2241e2b9 | Iustin Pop | - w: weeks
|
2718 | 2241e2b9 | Iustin Pop |
|
2719 | 2241e2b9 | Iustin Pop | Without any suffix, the value will be taken to be in seconds.
|
2720 | 2241e2b9 | Iustin Pop |
|
2721 | 2241e2b9 | Iustin Pop | """
|
2722 | 2241e2b9 | Iustin Pop | value = str(value)
|
2723 | 2241e2b9 | Iustin Pop | if not value: |
2724 | 2241e2b9 | Iustin Pop | raise errors.OpPrereqError("Empty time specification passed") |
2725 | 2241e2b9 | Iustin Pop | suffix_map = { |
2726 | 2241e2b9 | Iustin Pop | 's': 1, |
2727 | 2241e2b9 | Iustin Pop | 'm': 60, |
2728 | 2241e2b9 | Iustin Pop | 'h': 3600, |
2729 | 2241e2b9 | Iustin Pop | 'd': 86400, |
2730 | 2241e2b9 | Iustin Pop | 'w': 604800, |
2731 | 2241e2b9 | Iustin Pop | } |
2732 | 2241e2b9 | Iustin Pop | if value[-1] not in suffix_map: |
2733 | 2241e2b9 | Iustin Pop | try:
|
2734 | 2241e2b9 | Iustin Pop | value = int(value)
|
2735 | 691744c4 | Iustin Pop | except (TypeError, ValueError): |
2736 | 2241e2b9 | Iustin Pop | raise errors.OpPrereqError("Invalid time specification '%s'" % value) |
2737 | 2241e2b9 | Iustin Pop | else:
|
2738 | 2241e2b9 | Iustin Pop | multiplier = suffix_map[value[-1]]
|
2739 | 2241e2b9 | Iustin Pop | value = value[:-1]
|
2740 | 2241e2b9 | Iustin Pop | if not value: # no data left after stripping the suffix |
2741 | 2241e2b9 | Iustin Pop | raise errors.OpPrereqError("Invalid time specification (only" |
2742 | 2241e2b9 | Iustin Pop | " suffix passed)")
|
2743 | 2241e2b9 | Iustin Pop | try:
|
2744 | 2241e2b9 | Iustin Pop | value = int(value) * multiplier
|
2745 | 691744c4 | Iustin Pop | except (TypeError, ValueError): |
2746 | 2241e2b9 | Iustin Pop | raise errors.OpPrereqError("Invalid time specification '%s'" % value) |
2747 | 2241e2b9 | Iustin Pop | return value
|
2748 | 46fbdd04 | Iustin Pop | |
2749 | 46fbdd04 | Iustin Pop | |
2750 | e9e26bb3 | Iustin Pop | def GetOnlineNodes(nodes, cl=None, nowarn=False, secondary_ips=False, |
2751 | e9e26bb3 | Iustin Pop | filter_master=False):
|
2752 | 4040a784 | Iustin Pop | """Returns the names of online nodes.
|
2753 | 4040a784 | Iustin Pop |
|
2754 | 4040a784 | Iustin Pop | This function will also log a warning on stderr with the names of
|
2755 | 4040a784 | Iustin Pop | the online nodes.
|
2756 | 4040a784 | Iustin Pop |
|
2757 | 4040a784 | Iustin Pop | @param nodes: if not empty, use only this subset of nodes (minus the
|
2758 | 4040a784 | Iustin Pop | offline ones)
|
2759 | 4040a784 | Iustin Pop | @param cl: if not None, luxi client to use
|
2760 | 4040a784 | Iustin Pop | @type nowarn: boolean
|
2761 | 4040a784 | Iustin Pop | @param nowarn: by default, this function will output a note with the
|
2762 | 4040a784 | Iustin Pop | offline nodes that are skipped; if this parameter is True the
|
2763 | 4040a784 | Iustin Pop | note is not displayed
|
2764 | e9e26bb3 | Iustin Pop | @type secondary_ips: boolean
|
2765 | e9e26bb3 | Iustin Pop | @param secondary_ips: if True, return the secondary IPs instead of the
|
2766 | e9e26bb3 | Iustin Pop | names, useful for doing network traffic over the replication interface
|
2767 | e9e26bb3 | Iustin Pop | (if any)
|
2768 | e9e26bb3 | Iustin Pop | @type filter_master: boolean
|
2769 | e9e26bb3 | Iustin Pop | @param filter_master: if True, do not return the master node in the list
|
2770 | e9e26bb3 | Iustin Pop | (useful in coordination with secondary_ips where we cannot check our
|
2771 | e9e26bb3 | Iustin Pop | node name against the list)
|
2772 | 4040a784 | Iustin Pop |
|
2773 | 4040a784 | Iustin Pop | """
|
2774 | 4040a784 | Iustin Pop | if cl is None: |
2775 | 4040a784 | Iustin Pop | cl = GetClient() |
2776 | 4040a784 | Iustin Pop | |
2777 | e9e26bb3 | Iustin Pop | if secondary_ips:
|
2778 | e9e26bb3 | Iustin Pop | name_idx = 2
|
2779 | e9e26bb3 | Iustin Pop | else:
|
2780 | e9e26bb3 | Iustin Pop | name_idx = 0
|
2781 | e9e26bb3 | Iustin Pop | |
2782 | e9e26bb3 | Iustin Pop | if filter_master:
|
2783 | e9e26bb3 | Iustin Pop | master_node = cl.QueryConfigValues(["master_node"])[0] |
2784 | e9e26bb3 | Iustin Pop | filter_fn = lambda x: x != master_node
|
2785 | e9e26bb3 | Iustin Pop | else:
|
2786 | e9e26bb3 | Iustin Pop | filter_fn = lambda _: True |
2787 | e9e26bb3 | Iustin Pop | |
2788 | e9e26bb3 | Iustin Pop | result = cl.QueryNodes(names=nodes, fields=["name", "offline", "sip"], |
2789 | 2e7b8369 | Iustin Pop | use_locking=False)
|
2790 | 4040a784 | Iustin Pop | offline = [row[0] for row in result if row[1]] |
2791 | 4040a784 | Iustin Pop | if offline and not nowarn: |
2792 | 1f864b60 | Iustin Pop | ToStderr("Note: skipping offline node(s): %s" % utils.CommaJoin(offline))
|
2793 | e9e26bb3 | Iustin Pop | return [row[name_idx] for row in result if not row[1] and filter_fn(row[0])] |
2794 | 4040a784 | Iustin Pop | |
2795 | 4040a784 | Iustin Pop | |
2796 | 46fbdd04 | Iustin Pop | def _ToStream(stream, txt, *args): |
2797 | 46fbdd04 | Iustin Pop | """Write a message to a stream, bypassing the logging system
|
2798 | 46fbdd04 | Iustin Pop |
|
2799 | 46fbdd04 | Iustin Pop | @type stream: file object
|
2800 | 46fbdd04 | Iustin Pop | @param stream: the file to which we should write
|
2801 | 46fbdd04 | Iustin Pop | @type txt: str
|
2802 | 46fbdd04 | Iustin Pop | @param txt: the message
|
2803 | 46fbdd04 | Iustin Pop |
|
2804 | 46fbdd04 | Iustin Pop | """
|
2805 | 225e2544 | Iustin Pop | try:
|
2806 | 225e2544 | Iustin Pop | if args:
|
2807 | 225e2544 | Iustin Pop | args = tuple(args)
|
2808 | 225e2544 | Iustin Pop | stream.write(txt % args) |
2809 | 225e2544 | Iustin Pop | else:
|
2810 | 225e2544 | Iustin Pop | stream.write(txt) |
2811 | 225e2544 | Iustin Pop | stream.write('\n')
|
2812 | 225e2544 | Iustin Pop | stream.flush() |
2813 | 225e2544 | Iustin Pop | except IOError, err: |
2814 | 225e2544 | Iustin Pop | if err.errno == errno.EPIPE:
|
2815 | 225e2544 | Iustin Pop | # our terminal went away, we'll exit
|
2816 | 225e2544 | Iustin Pop | sys.exit(constants.EXIT_FAILURE) |
2817 | 225e2544 | Iustin Pop | else:
|
2818 | 225e2544 | Iustin Pop | raise
|
2819 | 46fbdd04 | Iustin Pop | |
2820 | 46fbdd04 | Iustin Pop | |
2821 | 46fbdd04 | Iustin Pop | def ToStdout(txt, *args): |
2822 | 46fbdd04 | Iustin Pop | """Write a message to stdout only, bypassing the logging system
|
2823 | 46fbdd04 | Iustin Pop |
|
2824 | 46fbdd04 | Iustin Pop | This is just a wrapper over _ToStream.
|
2825 | 46fbdd04 | Iustin Pop |
|
2826 | 46fbdd04 | Iustin Pop | @type txt: str
|
2827 | 46fbdd04 | Iustin Pop | @param txt: the message
|
2828 | 46fbdd04 | Iustin Pop |
|
2829 | 46fbdd04 | Iustin Pop | """
|
2830 | 46fbdd04 | Iustin Pop | _ToStream(sys.stdout, txt, *args) |
2831 | 46fbdd04 | Iustin Pop | |
2832 | 46fbdd04 | Iustin Pop | |
2833 | 46fbdd04 | Iustin Pop | def ToStderr(txt, *args): |
2834 | 46fbdd04 | Iustin Pop | """Write a message to stderr only, bypassing the logging system
|
2835 | 46fbdd04 | Iustin Pop |
|
2836 | 46fbdd04 | Iustin Pop | This is just a wrapper over _ToStream.
|
2837 | 46fbdd04 | Iustin Pop |
|
2838 | 46fbdd04 | Iustin Pop | @type txt: str
|
2839 | 46fbdd04 | Iustin Pop | @param txt: the message
|
2840 | 46fbdd04 | Iustin Pop |
|
2841 | 46fbdd04 | Iustin Pop | """
|
2842 | 46fbdd04 | Iustin Pop | _ToStream(sys.stderr, txt, *args) |
2843 | 479636a3 | Iustin Pop | |
2844 | 479636a3 | Iustin Pop | |
2845 | 479636a3 | Iustin Pop | class JobExecutor(object): |
2846 | 479636a3 | Iustin Pop | """Class which manages the submission and execution of multiple jobs.
|
2847 | 479636a3 | Iustin Pop |
|
2848 | 479636a3 | Iustin Pop | Note that instances of this class should not be reused between
|
2849 | 479636a3 | Iustin Pop | GetResults() calls.
|
2850 | 479636a3 | Iustin Pop |
|
2851 | 479636a3 | Iustin Pop | """
|
2852 | 919ca415 | Iustin Pop | def __init__(self, cl=None, verbose=True, opts=None, feedback_fn=None): |
2853 | 479636a3 | Iustin Pop | self.queue = []
|
2854 | 479636a3 | Iustin Pop | if cl is None: |
2855 | 479636a3 | Iustin Pop | cl = GetClient() |
2856 | 479636a3 | Iustin Pop | self.cl = cl
|
2857 | 479636a3 | Iustin Pop | self.verbose = verbose
|
2858 | 23b4b983 | Iustin Pop | self.jobs = []
|
2859 | cff5fa7f | Iustin Pop | self.opts = opts
|
2860 | 919ca415 | Iustin Pop | self.feedback_fn = feedback_fn
|
2861 | 479636a3 | Iustin Pop | |
2862 | 479636a3 | Iustin Pop | def QueueJob(self, name, *ops): |
2863 | 23b4b983 | Iustin Pop | """Record a job for later submit.
|
2864 | 479636a3 | Iustin Pop |
|
2865 | 479636a3 | Iustin Pop | @type name: string
|
2866 | 479636a3 | Iustin Pop | @param name: a description of the job, will be used in WaitJobSet
|
2867 | 479636a3 | Iustin Pop | """
|
2868 | cff5fa7f | Iustin Pop | SetGenericOpcodeOpts(ops, self.opts)
|
2869 | 23b4b983 | Iustin Pop | self.queue.append((name, ops))
|
2870 | 23b4b983 | Iustin Pop | |
2871 | 66ecc479 | Guido Trotter | def SubmitPending(self, each=False): |
2872 | 23b4b983 | Iustin Pop | """Submit all pending jobs.
|
2873 | 23b4b983 | Iustin Pop |
|
2874 | 23b4b983 | Iustin Pop | """
|
2875 | 66ecc479 | Guido Trotter | if each:
|
2876 | 66ecc479 | Guido Trotter | results = [] |
2877 | 66ecc479 | Guido Trotter | for row in self.queue: |
2878 | 66ecc479 | Guido Trotter | # SubmitJob will remove the success status, but raise an exception if
|
2879 | 66ecc479 | Guido Trotter | # the submission fails, so we'll notice that anyway.
|
2880 | 66ecc479 | Guido Trotter | results.append([True, self.cl.SubmitJob(row[1])]) |
2881 | 66ecc479 | Guido Trotter | else:
|
2882 | 66ecc479 | Guido Trotter | results = self.cl.SubmitManyJobs([row[1] for row in self.queue]) |
2883 | 5299e61f | Iustin Pop | for (idx, ((status, data), (name, _))) in enumerate(zip(results, |
2884 | 5299e61f | Iustin Pop | self.queue)):
|
2885 | 5299e61f | Iustin Pop | self.jobs.append((idx, status, data, name))
|
2886 | 5299e61f | Iustin Pop | |
2887 | 5299e61f | Iustin Pop | def _ChooseJob(self): |
2888 | 5299e61f | Iustin Pop | """Choose a non-waiting/queued job to poll next.
|
2889 | 5299e61f | Iustin Pop |
|
2890 | 5299e61f | Iustin Pop | """
|
2891 | 5299e61f | Iustin Pop | assert self.jobs, "_ChooseJob called with empty job list" |
2892 | 5299e61f | Iustin Pop | |
2893 | 5299e61f | Iustin Pop | result = self.cl.QueryJobs([i[2] for i in self.jobs], ["status"]) |
2894 | 5299e61f | Iustin Pop | assert result
|
2895 | 5299e61f | Iustin Pop | |
2896 | 5299e61f | Iustin Pop | for job_data, status in zip(self.jobs, result): |
2897 | 91c622a8 | Iustin Pop | if (isinstance(status, list) and status and |
2898 | 91c622a8 | Iustin Pop | status[0] in (constants.JOB_STATUS_QUEUED, |
2899 | 91c622a8 | Iustin Pop | constants.JOB_STATUS_WAITLOCK, |
2900 | 91c622a8 | Iustin Pop | constants.JOB_STATUS_CANCELING)): |
2901 | 91c622a8 | Iustin Pop | # job is still present and waiting
|
2902 | 5299e61f | Iustin Pop | continue
|
2903 | 91c622a8 | Iustin Pop | # good candidate found (either running job or lost job)
|
2904 | 5299e61f | Iustin Pop | self.jobs.remove(job_data)
|
2905 | 5299e61f | Iustin Pop | return job_data
|
2906 | 5299e61f | Iustin Pop | |
2907 | 5299e61f | Iustin Pop | # no job found
|
2908 | 5299e61f | Iustin Pop | return self.jobs.pop(0) |
2909 | 479636a3 | Iustin Pop | |
2910 | 479636a3 | Iustin Pop | def GetResults(self): |
2911 | 479636a3 | Iustin Pop | """Wait for and return the results of all jobs.
|
2912 | 479636a3 | Iustin Pop |
|
2913 | 479636a3 | Iustin Pop | @rtype: list
|
2914 | 479636a3 | Iustin Pop | @return: list of tuples (success, job results), in the same order
|
2915 | 479636a3 | Iustin Pop | as the submitted jobs; if a job has failed, instead of the result
|
2916 | 479636a3 | Iustin Pop | there will be the error message
|
2917 | 479636a3 | Iustin Pop |
|
2918 | 479636a3 | Iustin Pop | """
|
2919 | 23b4b983 | Iustin Pop | if not self.jobs: |
2920 | 23b4b983 | Iustin Pop | self.SubmitPending()
|
2921 | 479636a3 | Iustin Pop | results = [] |
2922 | 479636a3 | Iustin Pop | if self.verbose: |
2923 | 5299e61f | Iustin Pop | ok_jobs = [row[2] for row in self.jobs if row[1]] |
2924 | 23b4b983 | Iustin Pop | if ok_jobs:
|
2925 | 1f864b60 | Iustin Pop | ToStdout("Submitted jobs %s", utils.CommaJoin(ok_jobs))
|
2926 | 5299e61f | Iustin Pop | |
2927 | 5299e61f | Iustin Pop | # first, remove any non-submitted jobs
|
2928 | cea881e5 | Michael Hanselmann | self.jobs, failures = compat.partition(self.jobs, lambda x: x[1]) |
2929 | 5299e61f | Iustin Pop | for idx, _, jid, name in failures: |
2930 | c63355f2 | Iustin Pop | ToStderr("Failed to submit job for %s: %s", name, jid)
|
2931 | c63355f2 | Iustin Pop | results.append((idx, False, jid))
|
2932 | 5299e61f | Iustin Pop | |
2933 | 5299e61f | Iustin Pop | while self.jobs: |
2934 | 5299e61f | Iustin Pop | (idx, _, jid, name) = self._ChooseJob()
|
2935 | 5299e61f | Iustin Pop | ToStdout("Waiting for job %s for %s...", jid, name)
|
2936 | 479636a3 | Iustin Pop | try:
|
2937 | 919ca415 | Iustin Pop | job_result = PollJob(jid, cl=self.cl, feedback_fn=self.feedback_fn) |
2938 | 479636a3 | Iustin Pop | success = True
|
2939 | 91c622a8 | Iustin Pop | except errors.JobLost, err:
|
2940 | 91c622a8 | Iustin Pop | _, job_result = FormatError(err) |
2941 | 91c622a8 | Iustin Pop | ToStderr("Job %s for %s has been archived, cannot check its result",
|
2942 | 91c622a8 | Iustin Pop | jid, name) |
2943 | 91c622a8 | Iustin Pop | success = False
|
2944 | 479636a3 | Iustin Pop | except (errors.GenericError, luxi.ProtocolError), err:
|
2945 | 479636a3 | Iustin Pop | _, job_result = FormatError(err) |
2946 | 479636a3 | Iustin Pop | success = False
|
2947 | 479636a3 | Iustin Pop | # the error message will always be shown, verbose or not
|
2948 | 479636a3 | Iustin Pop | ToStderr("Job %s for %s has failed: %s", jid, name, job_result)
|
2949 | 479636a3 | Iustin Pop | |
2950 | 5299e61f | Iustin Pop | results.append((idx, success, job_result)) |
2951 | 5299e61f | Iustin Pop | |
2952 | 5299e61f | Iustin Pop | # sort based on the index, then drop it
|
2953 | 5299e61f | Iustin Pop | results.sort() |
2954 | 5299e61f | Iustin Pop | results = [i[1:] for i in results] |
2955 | 5299e61f | Iustin Pop | |
2956 | 479636a3 | Iustin Pop | return results
|
2957 | 479636a3 | Iustin Pop | |
2958 | 479636a3 | Iustin Pop | def WaitOrShow(self, wait): |
2959 | 479636a3 | Iustin Pop | """Wait for job results or only print the job IDs.
|
2960 | 479636a3 | Iustin Pop |
|
2961 | 479636a3 | Iustin Pop | @type wait: boolean
|
2962 | 479636a3 | Iustin Pop | @param wait: whether to wait or not
|
2963 | 479636a3 | Iustin Pop |
|
2964 | 479636a3 | Iustin Pop | """
|
2965 | 479636a3 | Iustin Pop | if wait:
|
2966 | 479636a3 | Iustin Pop | return self.GetResults() |
2967 | 479636a3 | Iustin Pop | else:
|
2968 | 23b4b983 | Iustin Pop | if not self.jobs: |
2969 | 23b4b983 | Iustin Pop | self.SubmitPending()
|
2970 | 71834b2a | Guido Trotter | for _, status, result, name in self.jobs: |
2971 | 23b4b983 | Iustin Pop | if status:
|
2972 | 23b4b983 | Iustin Pop | ToStdout("%s: %s", result, name)
|
2973 | 23b4b983 | Iustin Pop | else:
|
2974 | 23b4b983 | Iustin Pop | ToStderr("Failure for %s: %s", name, result)
|
2975 | 53a8a54d | Iustin Pop | return [row[1:3] for row in self.jobs] |
2976 | acd19189 | René Nussbaumer | |
2977 | acd19189 | René Nussbaumer | |
2978 | acd19189 | René Nussbaumer | def FormatParameterDict(buf, param_dict, actual, level=1): |
2979 | acd19189 | René Nussbaumer | """Formats a parameter dictionary.
|
2980 | acd19189 | René Nussbaumer |
|
2981 | acd19189 | René Nussbaumer | @type buf: L{StringIO}
|
2982 | acd19189 | René Nussbaumer | @param buf: the buffer into which to write
|
2983 | acd19189 | René Nussbaumer | @type param_dict: dict
|
2984 | acd19189 | René Nussbaumer | @param param_dict: the own parameters
|
2985 | acd19189 | René Nussbaumer | @type actual: dict
|
2986 | acd19189 | René Nussbaumer | @param actual: the current parameter set (including defaults)
|
2987 | acd19189 | René Nussbaumer | @param level: Level of indent
|
2988 | acd19189 | René Nussbaumer |
|
2989 | acd19189 | René Nussbaumer | """
|
2990 | acd19189 | René Nussbaumer | indent = " " * level
|
2991 | acd19189 | René Nussbaumer | for key in sorted(actual): |
2992 | acd19189 | René Nussbaumer | val = param_dict.get(key, "default (%s)" % actual[key])
|
2993 | acd19189 | René Nussbaumer | buf.write("%s- %s: %s\n" % (indent, key, val)) |