root / lib / cli.py @ d93e2477
History | View | Annotate | Download (138.4 kB)
1 | 2f31098c | Iustin Pop | #
|
---|---|---|---|
2 | a8083063 | Iustin Pop | #
|
3 | a8083063 | Iustin Pop | |
4 | 7f5edc60 | Iustin Pop | # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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 | 60452edf | Michael Hanselmann | import itertools |
32 | ef9fa5b9 | René Nussbaumer | import shlex |
33 | 73702ee7 | Iustin Pop | from cStringIO import StringIO |
34 | a8083063 | Iustin Pop | |
35 | a8083063 | Iustin Pop | from ganeti import utils |
36 | a8083063 | Iustin Pop | from ganeti import errors |
37 | a8083063 | Iustin Pop | from ganeti import constants |
38 | 846baef9 | Iustin Pop | from ganeti import opcodes |
39 | ceab32dd | Iustin Pop | from ganeti import luxi |
40 | b33e986b | Iustin Pop | from ganeti import ssconf |
41 | 4331f6cd | Michael Hanselmann | from ganeti import rpc |
42 | 7e49b6ce | Michael Hanselmann | from ganeti import ssh |
43 | cea881e5 | Michael Hanselmann | from ganeti import compat |
44 | a744b676 | Manuel Franceschini | from ganeti import netutils |
45 | ee3aedff | Michael Hanselmann | from ganeti import qlang |
46 | 703fa9ab | Iustin Pop | from ganeti import objects |
47 | ee4a14c0 | Michael Hanselmann | from ganeti import pathutils |
48 | a8083063 | Iustin Pop | |
49 | bf5338b3 | Michael Hanselmann | from optparse import (OptionParser, TitledHelpFormatter, |
50 | 38206f3c | Iustin Pop | Option, OptionValueError) |
51 | a8083063 | Iustin Pop | |
52 | 03298ebe | Michael Hanselmann | |
53 | 4abc4f1e | Iustin Pop | __all__ = [ |
54 | 4abc4f1e | Iustin Pop | # Command line options
|
55 | ef8270dc | Iustin Pop | "ABSOLUTE_OPT",
|
56 | fdad8c4d | Balazs Lecz | "ADD_UIDS_OPT",
|
57 | 9c784fb3 | Dimitris Aragiorgis | "ADD_RESERVED_IPS_OPT",
|
58 | e7e09483 | Iustin Pop | "ALLOCATABLE_OPT",
|
59 | 90e99856 | Adeodato Simo | "ALLOC_POLICY_OPT",
|
60 | 2d5e7ae1 | Iustin Pop | "ALL_OPT",
|
61 | e9c487be | René Nussbaumer | "ALLOW_FAILOVER_OPT",
|
62 | 4c61d894 | Iustin Pop | "AUTO_PROMOTE_OPT",
|
63 | e00f7a05 | Iustin Pop | "AUTO_REPLACE_OPT",
|
64 | 087ed2ed | Iustin Pop | "BACKEND_OPT",
|
65 | 61a14bb3 | Iustin Pop | "BLK_OS_OPT",
|
66 | f91e255a | Iustin Pop | "CAPAB_MASTER_OPT",
|
67 | 53919782 | Iustin Pop | "CAPAB_VM_OPT",
|
68 | baef337d | Iustin Pop | "CLEANUP_OPT",
|
69 | 3db3eb2a | Michael Hanselmann | "CLUSTER_DOMAIN_SECRET_OPT",
|
70 | 4abc4f1e | Iustin Pop | "CONFIRM_OPT",
|
71 | e32df528 | Iustin Pop | "CP_SIZE_OPT",
|
72 | 4abc4f1e | Iustin Pop | "DEBUG_OPT",
|
73 | a0c9776a | Iustin Pop | "DEBUG_SIMERR_OPT",
|
74 | 4b038a1e | Iustin Pop | "DISKIDX_OPT",
|
75 | e3876ccb | Iustin Pop | "DISK_OPT",
|
76 | bc5d0215 | Andrea Spadaccini | "DISK_PARAMS_OPT",
|
77 | 4b038a1e | Iustin Pop | "DISK_TEMPLATE_OPT",
|
78 | 771734c9 | Iustin Pop | "DRAINED_OPT",
|
79 | a0a6ff34 | Iustin Pop | "DRY_RUN_OPT",
|
80 | 26591bfd | Luca Bigliardi | "DRBD_HELPER_OPT",
|
81 | 1b7761fd | Apollon Oikonomopoulos | "DST_NODE_OPT",
|
82 | 7ea7bcf6 | Iustin Pop | "EARLY_RELEASE_OPT",
|
83 | 383a3591 | Iustin Pop | "ENABLED_HV_OPT",
|
84 | 66af5ec5 | Helga Velroyen | "ENABLED_DISK_TEMPLATES_OPT",
|
85 | 14e9e7f3 | Iustin Pop | "ERROR_CODES_OPT",
|
86 | d5b031dc | Michael Hanselmann | "FAILURE_ONLY_OPT",
|
87 | 4abc4f1e | Iustin Pop | "FIELDS_OPT",
|
88 | 4a25828c | Iustin Pop | "FILESTORE_DIR_OPT",
|
89 | 0f87c43e | Iustin Pop | "FILESTORE_DRIVER_OPT",
|
90 | 2039321f | Klaus Aehlig | "FORCE_FAILOVER_OPT",
|
91 | 442587bf | Michael Hanselmann | "FORCE_FILTER_OPT",
|
92 | 06073e85 | Guido Trotter | "FORCE_OPT",
|
93 | 06073e85 | Guido Trotter | "FORCE_VARIANT_OPT",
|
94 | 9c784fb3 | Dimitris Aragiorgis | "GATEWAY_OPT",
|
95 | 9c784fb3 | Dimitris Aragiorgis | "GATEWAY6_OPT",
|
96 | 29392516 | Iustin Pop | "GLOBAL_FILEDIR_OPT",
|
97 | 61a14bb3 | Iustin Pop | "HID_OS_OPT",
|
98 | 4b97f902 | Apollon Oikonomopoulos | "GLOBAL_SHARED_FILEDIR_OPT",
|
99 | df58ca1c | Dimitris Aragiorgis | "HOTPLUG_OPT",
|
100 | 96ed3a3e | Dimitris Aragiorgis | "HOTPLUG_IF_POSSIBLE_OPT",
|
101 | 073271f6 | Iustin Pop | "HVLIST_OPT",
|
102 | 48f212d7 | Iustin Pop | "HVOPTS_OPT",
|
103 | 236fd9c4 | Iustin Pop | "HYPERVISOR_OPT",
|
104 | 4eb62659 | Iustin Pop | "IALLOCATOR_OPT",
|
105 | bf4af505 | Apollon Oikonomopoulos | "DEFAULT_IALLOCATOR_OPT",
|
106 | e588764d | Iustin Pop | "IDENTIFY_DEFAULTS_OPT",
|
107 | 82a786d5 | Iustin Pop | "IGNORE_CONSIST_OPT",
|
108 | 93f2399e | Andrea Spadaccini | "IGNORE_ERRORS_OPT",
|
109 | b6e841a8 | Iustin Pop | "IGNORE_FAILURES_OPT",
|
110 | b44bd844 | Michael Hanselmann | "IGNORE_OFFLINE_OPT",
|
111 | 8d8d650c | Michael Hanselmann | "IGNORE_REMOVE_FAILURES_OPT",
|
112 | ee3f9578 | Iustin Pop | "IGNORE_SECONDARIES_OPT",
|
113 | 05586c90 | Iustin Pop | "IGNORE_SIZE_OPT",
|
114 | ea9d3b40 | Bernardo Dal Seno | "INCLUDEDEFAULTS_OPT",
|
115 | 19b9ba9a | Michael Hanselmann | "INTERVAL_OPT",
|
116 | e3646f22 | Iustin Pop | "MAC_PREFIX_OPT",
|
117 | 3953242f | Iustin Pop | "MAINTAIN_NODE_HEALTH_OPT",
|
118 | 29392516 | Iustin Pop | "MASTER_NETDEV_OPT",
|
119 | 5a8648eb | Andrea Spadaccini | "MASTER_NETMASK_OPT",
|
120 | 771734c9 | Iustin Pop | "MC_OPT",
|
121 | 783a6c0b | Iustin Pop | "MIGRATION_MODE_OPT",
|
122 | c89db623 | Michele Tartara | "MODIFY_ETCHOSTS_OPT",
|
123 | 7d3a9fab | Iustin Pop | "NET_OPT",
|
124 | 9c784fb3 | Dimitris Aragiorgis | "NETWORK_OPT",
|
125 | 9c784fb3 | Dimitris Aragiorgis | "NETWORK6_OPT",
|
126 | 6d4a1656 | Michael Hanselmann | "NEW_CLUSTER_CERT_OPT",
|
127 | 3db3eb2a | Michael Hanselmann | "NEW_CLUSTER_DOMAIN_SECRET_OPT",
|
128 | 6b7d5878 | Michael Hanselmann | "NEW_CONFD_HMAC_KEY_OPT",
|
129 | 6d4a1656 | Michael Hanselmann | "NEW_RAPI_CERT_OPT",
|
130 | 3438e1f8 | Klaus Aehlig | "NEW_PRIMARY_OPT",
|
131 | a14db5ff | Iustin Pop | "NEW_SECONDARY_OPT",
|
132 | b6267745 | Andrea Spadaccini | "NEW_SPICE_CERT_OPT",
|
133 | 4fbc93dd | Iustin Pop | "NIC_PARAMS_OPT",
|
134 | 9c784fb3 | Dimitris Aragiorgis | "NOCONFLICTSCHECK_OPT",
|
135 | 61413377 | Stephen Shirley | "NODE_FORCE_JOIN_OPT",
|
136 | 7edc4637 | Iustin Pop | "NODE_LIST_OPT",
|
137 | 990b7886 | Iustin Pop | "NODE_PLACEMENT_OPT",
|
138 | 5fbbd028 | Guido Trotter | "NODEGROUP_OPT",
|
139 | a535cef7 | René Nussbaumer | "NODE_PARAMS_OPT",
|
140 | dd94e9f6 | René Nussbaumer | "NODE_POWERED_OPT",
|
141 | 4abc4f1e | Iustin Pop | "NOHDR_OPT",
|
142 | 91e0748c | Iustin Pop | "NOIPCHECK_OPT",
|
143 | 25a8792c | Iustin Pop | "NO_INSTALL_OPT",
|
144 | 460d22be | Iustin Pop | "NONAMECHECK_OPT",
|
145 | 831040bf | Iustin Pop | "NOLVM_STORAGE_OPT",
|
146 | 29392516 | Iustin Pop | "NOMODIFY_ETCHOSTS_OPT",
|
147 | b989b9d9 | Ken Wehr | "NOMODIFY_SSH_SETUP_OPT",
|
148 | 26023ecd | Iustin Pop | "NONICS_OPT",
|
149 | f2a0828c | Iustin Pop | "NONLIVE_OPT",
|
150 | 14e9e7f3 | Iustin Pop | "NONPLUS1_OPT",
|
151 | 8c0b16f6 | Guido Trotter | "NORUNTIME_CHGS_OPT",
|
152 | 44c44832 | Iustin Pop | "NOSHUTDOWN_OPT",
|
153 | edeb878a | Iustin Pop | "NOSTART_OPT",
|
154 | fcdde7f2 | Iustin Pop | "NOSSH_KEYCHECK_OPT",
|
155 | 58371861 | Iustin Pop | "NOVOTING_OPT",
|
156 | 885a0fc4 | Iustin Pop | "NO_REMEMBER_OPT",
|
157 | 3f75b4f3 | Iustin Pop | "NWSYNC_OPT",
|
158 | 57de31c0 | Agata Murawska | "OFFLINE_INST_OPT",
|
159 | 57de31c0 | Agata Murawska | "ONLINE_INST_OPT",
|
160 | a72d0a79 | Iustin Pop | "ON_PRIMARY_OPT",
|
161 | feb09e6a | Iustin Pop | "ON_SECONDARY_OPT",
|
162 | 771734c9 | Iustin Pop | "OFFLINE_OPT",
|
163 | 062a7100 | Iustin Pop | "OSPARAMS_OPT",
|
164 | d3ed23ff | Iustin Pop | "OS_OPT",
|
165 | ff00c1a7 | Iustin Pop | "OS_SIZE_OPT",
|
166 | 41543d8b | René Nussbaumer | "OOB_TIMEOUT_OPT",
|
167 | 0c086a13 | René Nussbaumer | "POWER_DELAY_OPT",
|
168 | b883637f | René Nussbaumer | "PREALLOC_WIPE_DISKS_OPT",
|
169 | e7323b5e | Manuel Franceschini | "PRIMARY_IP_VERSION_OPT",
|
170 | aafee533 | Michael Hanselmann | "PRIMARY_ONLY_OPT",
|
171 | d6cd74dd | Klaus Aehlig | "PRINT_JOBID_OPT",
|
172 | 84a5b33c | Michael Hanselmann | "PRIORITY_OPT",
|
173 | 6d4a1656 | Michael Hanselmann | "RAPI_CERT_OPT",
|
174 | b8d0f938 | Iustin Pop | "READD_OPT",
|
175 | a59d5fa1 | Michele Tartara | "REASON_OPT",
|
176 | 12054861 | Iustin Pop | "REBOOT_TYPE_OPT",
|
177 | 8d8d650c | Michael Hanselmann | "REMOVE_INSTANCE_OPT",
|
178 | 9c784fb3 | Dimitris Aragiorgis | "REMOVE_RESERVED_IPS_OPT",
|
179 | fdad8c4d | Balazs Lecz | "REMOVE_UIDS_OPT",
|
180 | f38ea602 | Iustin Pop | "RESERVED_LVS_OPT",
|
181 | 2c0af7da | Guido Trotter | "RUNTIME_MEM_OPT",
|
182 | 31d97b2a | Guido Trotter | "ROMAN_OPT",
|
183 | 8d823629 | Iustin Pop | "SECONDARY_IP_OPT",
|
184 | aafee533 | Michael Hanselmann | "SECONDARY_ONLY_OPT",
|
185 | 67840b40 | Iustin Pop | "SELECT_OS_OPT",
|
186 | 4abc4f1e | Iustin Pop | "SEP_OPT",
|
187 | fdcf4d84 | Iustin Pop | "SHOWCMD_OPT",
|
188 | f92ed8ab | Michael Hanselmann | "SHOW_MACHINE_OPT",
|
189 | 7e5eaaa8 | Guido Trotter | "SHUTDOWN_TIMEOUT_OPT",
|
190 | f36d7d81 | Iustin Pop | "SINGLE_NODE_OPT",
|
191 | 32017174 | Agata Murawska | "SPECS_CPU_COUNT_OPT",
|
192 | 32017174 | Agata Murawska | "SPECS_DISK_COUNT_OPT",
|
193 | 32017174 | Agata Murawska | "SPECS_DISK_SIZE_OPT",
|
194 | 32017174 | Agata Murawska | "SPECS_MEM_SIZE_OPT",
|
195 | 32017174 | Agata Murawska | "SPECS_NIC_COUNT_OPT",
|
196 | 919db916 | Bernardo Dal Seno | "SPLIT_ISPECS_OPTS",
|
197 | d2d3935a | Bernardo Dal Seno | "IPOLICY_STD_SPECS_OPT",
|
198 | d04c9d45 | Iustin Pop | "IPOLICY_DISK_TEMPLATES",
|
199 | 976b78ba | Iustin Pop | "IPOLICY_VCPU_RATIO",
|
200 | ed9c2202 | Klaus Aehlig | "SEQUENTIAL_OPT",
|
201 | b6267745 | Andrea Spadaccini | "SPICE_CACERT_OPT",
|
202 | b6267745 | Andrea Spadaccini | "SPICE_CERT_OPT",
|
203 | df62e5db | Iustin Pop | "SRC_DIR_OPT",
|
204 | df62e5db | Iustin Pop | "SRC_NODE_OPT",
|
205 | 4abc4f1e | Iustin Pop | "SUBMIT_OPT",
|
206 | d6cd74dd | Klaus Aehlig | "SUBMIT_OPTS",
|
207 | 323f9095 | Stephen Shirley | "STARTUP_PAUSED_OPT",
|
208 | 99a8c799 | Iustin Pop | "STATIC_OPT",
|
209 | 4abc4f1e | Iustin Pop | "SYNC_OPT",
|
210 | a57981c5 | Apollon Oikonomopoulos | "TAG_ADD_OPT",
|
211 | 4abc4f1e | Iustin Pop | "TAG_SRC_OPT",
|
212 | b5762e2a | Guido Trotter | "TIMEOUT_OPT",
|
213 | f6eb380d | Michael Hanselmann | "TO_GROUP_OPT",
|
214 | 1338f2b4 | Balazs Lecz | "UIDPOOL_OPT",
|
215 | 4abc4f1e | Iustin Pop | "USEUNITS_OPT",
|
216 | bf689b7a | Andrea Spadaccini | "USE_EXTERNAL_MIP_SCRIPT",
|
217 | 74adc100 | Iustin Pop | "USE_REPL_NET_OPT",
|
218 | 9cdb9578 | Iustin Pop | "VERBOSE_OPT",
|
219 | b58726e8 | Iustin Pop | "VG_NAME_OPT",
|
220 | f30d8165 | Iustin Pop | "WFSYNC_OPT",
|
221 | 1f587d3d | Iustin Pop | "YES_DOIT_OPT",
|
222 | 38f29a36 | René Nussbaumer | "DISK_STATE_OPT",
|
223 | 38f29a36 | René Nussbaumer | "HV_STATE_OPT",
|
224 | b6aaf437 | René Nussbaumer | "IGNORE_IPOLICY_OPT",
|
225 | 0ce212e5 | Iustin Pop | "INSTANCE_POLICY_OPTS",
|
226 | 4abc4f1e | Iustin Pop | # Generic functions for CLI programs
|
227 | 25bd815c | René Nussbaumer | "ConfirmOperation",
|
228 | 703fa9ab | Iustin Pop | "CreateIPolicyFromOpts",
|
229 | 4abc4f1e | Iustin Pop | "GenericMain",
|
230 | d77490c5 | Iustin Pop | "GenericInstanceCreate",
|
231 | ee3aedff | Michael Hanselmann | "GenericList",
|
232 | ee3aedff | Michael Hanselmann | "GenericListFields",
|
233 | 4abc4f1e | Iustin Pop | "GetClient",
|
234 | 4abc4f1e | Iustin Pop | "GetOnlineNodes",
|
235 | 4abc4f1e | Iustin Pop | "JobExecutor",
|
236 | 4abc4f1e | Iustin Pop | "JobSubmittedException",
|
237 | 4abc4f1e | Iustin Pop | "ParseTimespec",
|
238 | 7e49b6ce | Michael Hanselmann | "RunWhileClusterStopped",
|
239 | 4abc4f1e | Iustin Pop | "SubmitOpCode",
|
240 | 346c3037 | Klaus Aehlig | "SubmitOpCodeToDrainedQueue",
|
241 | 4abc4f1e | Iustin Pop | "SubmitOrSend",
|
242 | 4abc4f1e | Iustin Pop | "UsesRPC",
|
243 | 4abc4f1e | Iustin Pop | # Formatting functions
|
244 | 4abc4f1e | Iustin Pop | "ToStderr", "ToStdout", |
245 | 4abc4f1e | Iustin Pop | "FormatError",
|
246 | ee3aedff | Michael Hanselmann | "FormatQueryResult",
|
247 | 4d99964c | Bernardo Dal Seno | "FormatParamsDictInfo",
|
248 | d00884a2 | Bernardo Dal Seno | "FormatPolicyInfo",
|
249 | ea9d3b40 | Bernardo Dal Seno | "PrintIPolicyCommand",
|
250 | 4d99964c | Bernardo Dal Seno | "PrintGenericInfo",
|
251 | 4abc4f1e | Iustin Pop | "GenerateTable",
|
252 | 4abc4f1e | Iustin Pop | "AskUser",
|
253 | 4abc4f1e | Iustin Pop | "FormatTimestamp",
|
254 | 8a7f1c61 | Michael Hanselmann | "FormatLogMessage",
|
255 | 4abc4f1e | Iustin Pop | # Tags functions
|
256 | 4abc4f1e | Iustin Pop | "ListTags",
|
257 | 4abc4f1e | Iustin Pop | "AddTags",
|
258 | 4abc4f1e | Iustin Pop | "RemoveTags",
|
259 | 4abc4f1e | Iustin Pop | # command line options support infrastructure
|
260 | 4abc4f1e | Iustin Pop | "ARGS_MANY_INSTANCES",
|
261 | 4abc4f1e | Iustin Pop | "ARGS_MANY_NODES",
|
262 | 667dbd6b | Adeodato Simo | "ARGS_MANY_GROUPS",
|
263 | 9c784fb3 | Dimitris Aragiorgis | "ARGS_MANY_NETWORKS",
|
264 | 4abc4f1e | Iustin Pop | "ARGS_NONE",
|
265 | 4abc4f1e | Iustin Pop | "ARGS_ONE_INSTANCE",
|
266 | 4abc4f1e | Iustin Pop | "ARGS_ONE_NODE",
|
267 | 667dbd6b | Adeodato Simo | "ARGS_ONE_GROUP",
|
268 | f9faf9c3 | René Nussbaumer | "ARGS_ONE_OS",
|
269 | 9c784fb3 | Dimitris Aragiorgis | "ARGS_ONE_NETWORK",
|
270 | 4abc4f1e | Iustin Pop | "ArgChoice",
|
271 | 4abc4f1e | Iustin Pop | "ArgCommand",
|
272 | 4abc4f1e | Iustin Pop | "ArgFile",
|
273 | 667dbd6b | Adeodato Simo | "ArgGroup",
|
274 | 4abc4f1e | Iustin Pop | "ArgHost",
|
275 | 4abc4f1e | Iustin Pop | "ArgInstance",
|
276 | 4abc4f1e | Iustin Pop | "ArgJobId",
|
277 | 9c784fb3 | Dimitris Aragiorgis | "ArgNetwork",
|
278 | 4abc4f1e | Iustin Pop | "ArgNode",
|
279 | f9faf9c3 | René Nussbaumer | "ArgOs",
|
280 | b954f097 | Constantinos Venetsanopoulos | "ArgExtStorage",
|
281 | 4abc4f1e | Iustin Pop | "ArgSuggest",
|
282 | 4abc4f1e | Iustin Pop | "ArgUnknown",
|
283 | 4abc4f1e | Iustin Pop | "OPT_COMPL_INST_ADD_NODES",
|
284 | 4abc4f1e | Iustin Pop | "OPT_COMPL_MANY_NODES",
|
285 | 4abc4f1e | Iustin Pop | "OPT_COMPL_ONE_IALLOCATOR",
|
286 | 4abc4f1e | Iustin Pop | "OPT_COMPL_ONE_INSTANCE",
|
287 | 4abc4f1e | Iustin Pop | "OPT_COMPL_ONE_NODE",
|
288 | 36e247e1 | Guido Trotter | "OPT_COMPL_ONE_NODEGROUP",
|
289 | 9c784fb3 | Dimitris Aragiorgis | "OPT_COMPL_ONE_NETWORK",
|
290 | 4abc4f1e | Iustin Pop | "OPT_COMPL_ONE_OS",
|
291 | b954f097 | Constantinos Venetsanopoulos | "OPT_COMPL_ONE_EXTSTORAGE",
|
292 | 4abc4f1e | Iustin Pop | "cli_option",
|
293 | 02a6b50a | Michele Tartara | "FixHvParams",
|
294 | 4abc4f1e | Iustin Pop | "SplitNodeOption",
|
295 | 07150497 | Guido Trotter | "CalculateOSNames",
|
296 | a4ebd726 | Michael Hanselmann | "ParseFields",
|
297 | eb28ecf6 | Guido Trotter | "COMMON_CREATE_OPTS",
|
298 | 4abc4f1e | Iustin Pop | ] |
299 | 846baef9 | Iustin Pop | |
300 | 8b46606c | Guido Trotter | NO_PREFIX = "no_"
|
301 | 8b46606c | Guido Trotter | UN_PREFIX = "-"
|
302 | 846baef9 | Iustin Pop | |
303 | 84a5b33c | Michael Hanselmann | #: Priorities (sorted)
|
304 | 84a5b33c | Michael Hanselmann | _PRIORITY_NAMES = [ |
305 | 84a5b33c | Michael Hanselmann | ("low", constants.OP_PRIO_LOW),
|
306 | 84a5b33c | Michael Hanselmann | ("normal", constants.OP_PRIO_NORMAL),
|
307 | 84a5b33c | Michael Hanselmann | ("high", constants.OP_PRIO_HIGH),
|
308 | 84a5b33c | Michael Hanselmann | ] |
309 | 84a5b33c | Michael Hanselmann | |
310 | 84a5b33c | Michael Hanselmann | #: Priority dictionary for easier lookup
|
311 | 84a5b33c | Michael Hanselmann | # TODO: Replace this and _PRIORITY_NAMES with a single sorted dictionary once
|
312 | 84a5b33c | Michael Hanselmann | # we migrate to Python 2.6
|
313 | 84a5b33c | Michael Hanselmann | _PRIONAME_TO_VALUE = dict(_PRIORITY_NAMES)
|
314 | 84a5b33c | Michael Hanselmann | |
315 | ee3aedff | Michael Hanselmann | # Query result status for clients
|
316 | ee3aedff | Michael Hanselmann | (QR_NORMAL, |
317 | ee3aedff | Michael Hanselmann | QR_UNKNOWN, |
318 | ee3aedff | Michael Hanselmann | QR_INCOMPLETE) = range(3) |
319 | ee3aedff | Michael Hanselmann | |
320 | 11705e3d | Iustin Pop | #: Maximum batch size for ChooseJob
|
321 | 11705e3d | Iustin Pop | _CHOOSE_BATCH = 25
|
322 | 11705e3d | Iustin Pop | |
323 | 03298ebe | Michael Hanselmann | |
324 | 703fa9ab | Iustin Pop | # constants used to create InstancePolicy dictionary
|
325 | 703fa9ab | Iustin Pop | TISPECS_GROUP_TYPES = { |
326 | 703fa9ab | Iustin Pop | constants.ISPECS_MIN: constants.VTYPE_INT, |
327 | 703fa9ab | Iustin Pop | constants.ISPECS_MAX: constants.VTYPE_INT, |
328 | 703fa9ab | Iustin Pop | } |
329 | 703fa9ab | Iustin Pop | |
330 | 703fa9ab | Iustin Pop | TISPECS_CLUSTER_TYPES = { |
331 | 703fa9ab | Iustin Pop | constants.ISPECS_MIN: constants.VTYPE_INT, |
332 | 703fa9ab | Iustin Pop | constants.ISPECS_MAX: constants.VTYPE_INT, |
333 | 703fa9ab | Iustin Pop | constants.ISPECS_STD: constants.VTYPE_INT, |
334 | 703fa9ab | Iustin Pop | } |
335 | 703fa9ab | Iustin Pop | |
336 | c1912a48 | Michael Hanselmann | #: User-friendly names for query2 field types
|
337 | c1912a48 | Michael Hanselmann | _QFT_NAMES = { |
338 | c1912a48 | Michael Hanselmann | constants.QFT_UNKNOWN: "Unknown",
|
339 | c1912a48 | Michael Hanselmann | constants.QFT_TEXT: "Text",
|
340 | c1912a48 | Michael Hanselmann | constants.QFT_BOOL: "Boolean",
|
341 | c1912a48 | Michael Hanselmann | constants.QFT_NUMBER: "Number",
|
342 | c1912a48 | Michael Hanselmann | constants.QFT_UNIT: "Storage size",
|
343 | c1912a48 | Michael Hanselmann | constants.QFT_TIMESTAMP: "Timestamp",
|
344 | c1912a48 | Michael Hanselmann | constants.QFT_OTHER: "Custom",
|
345 | c1912a48 | Michael Hanselmann | } |
346 | c1912a48 | Michael Hanselmann | |
347 | 703fa9ab | Iustin Pop | |
348 | 876fb142 | Helga Velroyen | class _Argument(object): |
349 | b459a848 | Andrea Spadaccini | def __init__(self, min=0, max=None): # pylint: disable=W0622 |
350 | 863d7f46 | Michael Hanselmann | self.min = min |
351 | 863d7f46 | Michael Hanselmann | self.max = max |
352 | 863d7f46 | Michael Hanselmann | |
353 | 863d7f46 | Michael Hanselmann | def __repr__(self): |
354 | 863d7f46 | Michael Hanselmann | return ("<%s min=%s max=%s>" % |
355 | 863d7f46 | Michael Hanselmann | (self.__class__.__name__, self.min, self.max)) |
356 | 863d7f46 | Michael Hanselmann | |
357 | 863d7f46 | Michael Hanselmann | |
358 | 863d7f46 | Michael Hanselmann | class ArgSuggest(_Argument): |
359 | 863d7f46 | Michael Hanselmann | """Suggesting argument.
|
360 | 863d7f46 | Michael Hanselmann |
|
361 | 863d7f46 | Michael Hanselmann | Value can be any of the ones passed to the constructor.
|
362 | 863d7f46 | Michael Hanselmann |
|
363 | 863d7f46 | Michael Hanselmann | """
|
364 | b459a848 | Andrea Spadaccini | # pylint: disable=W0622
|
365 | 863d7f46 | Michael Hanselmann | def __init__(self, min=0, max=None, choices=None): |
366 | 863d7f46 | Michael Hanselmann | _Argument.__init__(self, min=min, max=max) |
367 | 863d7f46 | Michael Hanselmann | self.choices = choices
|
368 | 863d7f46 | Michael Hanselmann | |
369 | 863d7f46 | Michael Hanselmann | def __repr__(self): |
370 | 863d7f46 | Michael Hanselmann | return ("<%s min=%s max=%s choices=%r>" % |
371 | 863d7f46 | Michael Hanselmann | (self.__class__.__name__, self.min, self.max, self.choices)) |
372 | 863d7f46 | Michael Hanselmann | |
373 | 863d7f46 | Michael Hanselmann | |
374 | 863d7f46 | Michael Hanselmann | class ArgChoice(ArgSuggest): |
375 | 863d7f46 | Michael Hanselmann | """Choice argument.
|
376 | 863d7f46 | Michael Hanselmann |
|
377 | 863d7f46 | Michael Hanselmann | Value can be any of the ones passed to the constructor. Like L{ArgSuggest},
|
378 | 863d7f46 | Michael Hanselmann | but value must be one of the choices.
|
379 | 863d7f46 | Michael Hanselmann |
|
380 | 863d7f46 | Michael Hanselmann | """
|
381 | 863d7f46 | Michael Hanselmann | |
382 | 863d7f46 | Michael Hanselmann | |
383 | 863d7f46 | Michael Hanselmann | class ArgUnknown(_Argument): |
384 | 863d7f46 | Michael Hanselmann | """Unknown argument to program (e.g. determined at runtime).
|
385 | 863d7f46 | Michael Hanselmann |
|
386 | 863d7f46 | Michael Hanselmann | """
|
387 | 863d7f46 | Michael Hanselmann | |
388 | 863d7f46 | Michael Hanselmann | |
389 | 863d7f46 | Michael Hanselmann | class ArgInstance(_Argument): |
390 | 863d7f46 | Michael Hanselmann | """Instances argument.
|
391 | 863d7f46 | Michael Hanselmann |
|
392 | 863d7f46 | Michael Hanselmann | """
|
393 | 863d7f46 | Michael Hanselmann | |
394 | 863d7f46 | Michael Hanselmann | |
395 | 863d7f46 | Michael Hanselmann | class ArgNode(_Argument): |
396 | 863d7f46 | Michael Hanselmann | """Node argument.
|
397 | 863d7f46 | Michael Hanselmann |
|
398 | 863d7f46 | Michael Hanselmann | """
|
399 | 863d7f46 | Michael Hanselmann | |
400 | 667dbd6b | Adeodato Simo | |
401 | 9c784fb3 | Dimitris Aragiorgis | class ArgNetwork(_Argument): |
402 | 9c784fb3 | Dimitris Aragiorgis | """Network argument.
|
403 | 9c784fb3 | Dimitris Aragiorgis |
|
404 | 9c784fb3 | Dimitris Aragiorgis | """
|
405 | 9c784fb3 | Dimitris Aragiorgis | |
406 | 3c286190 | Dimitris Aragiorgis | |
407 | 667dbd6b | Adeodato Simo | class ArgGroup(_Argument): |
408 | 667dbd6b | Adeodato Simo | """Node group argument.
|
409 | 667dbd6b | Adeodato Simo |
|
410 | 667dbd6b | Adeodato Simo | """
|
411 | 667dbd6b | Adeodato Simo | |
412 | 667dbd6b | Adeodato Simo | |
413 | 863d7f46 | Michael Hanselmann | class ArgJobId(_Argument): |
414 | 863d7f46 | Michael Hanselmann | """Job ID argument.
|
415 | 863d7f46 | Michael Hanselmann |
|
416 | 863d7f46 | Michael Hanselmann | """
|
417 | 863d7f46 | Michael Hanselmann | |
418 | 863d7f46 | Michael Hanselmann | |
419 | 863d7f46 | Michael Hanselmann | class ArgFile(_Argument): |
420 | 863d7f46 | Michael Hanselmann | """File path argument.
|
421 | 863d7f46 | Michael Hanselmann |
|
422 | 863d7f46 | Michael Hanselmann | """
|
423 | 863d7f46 | Michael Hanselmann | |
424 | 863d7f46 | Michael Hanselmann | |
425 | 863d7f46 | Michael Hanselmann | class ArgCommand(_Argument): |
426 | 863d7f46 | Michael Hanselmann | """Command argument.
|
427 | 863d7f46 | Michael Hanselmann |
|
428 | 863d7f46 | Michael Hanselmann | """
|
429 | 863d7f46 | Michael Hanselmann | |
430 | 863d7f46 | Michael Hanselmann | |
431 | 83ec7961 | Michael Hanselmann | class ArgHost(_Argument): |
432 | 83ec7961 | Michael Hanselmann | """Host argument.
|
433 | 83ec7961 | Michael Hanselmann |
|
434 | 83ec7961 | Michael Hanselmann | """
|
435 | 83ec7961 | Michael Hanselmann | |
436 | 83ec7961 | Michael Hanselmann | |
437 | f9faf9c3 | René Nussbaumer | class ArgOs(_Argument): |
438 | f9faf9c3 | René Nussbaumer | """OS argument.
|
439 | f9faf9c3 | René Nussbaumer |
|
440 | f9faf9c3 | René Nussbaumer | """
|
441 | f9faf9c3 | René Nussbaumer | |
442 | f9faf9c3 | René Nussbaumer | |
443 | b954f097 | Constantinos Venetsanopoulos | class ArgExtStorage(_Argument): |
444 | b954f097 | Constantinos Venetsanopoulos | """ExtStorage argument.
|
445 | b954f097 | Constantinos Venetsanopoulos |
|
446 | b954f097 | Constantinos Venetsanopoulos | """
|
447 | b954f097 | Constantinos Venetsanopoulos | |
448 | b954f097 | Constantinos Venetsanopoulos | |
449 | 4a265c08 | Michael Hanselmann | ARGS_NONE = [] |
450 | 4a265c08 | Michael Hanselmann | ARGS_MANY_INSTANCES = [ArgInstance()] |
451 | 9c784fb3 | Dimitris Aragiorgis | ARGS_MANY_NETWORKS = [ArgNetwork()] |
452 | 4a265c08 | Michael Hanselmann | ARGS_MANY_NODES = [ArgNode()] |
453 | 667dbd6b | Adeodato Simo | ARGS_MANY_GROUPS = [ArgGroup()] |
454 | 4a265c08 | Michael Hanselmann | ARGS_ONE_INSTANCE = [ArgInstance(min=1, max=1)] |
455 | 9c784fb3 | Dimitris Aragiorgis | ARGS_ONE_NETWORK = [ArgNetwork(min=1, max=1)] |
456 | 4a265c08 | Michael Hanselmann | ARGS_ONE_NODE = [ArgNode(min=1, max=1)] |
457 | dadf6b7d | Michael Hanselmann | # TODO
|
458 | dadf6b7d | Michael Hanselmann | ARGS_ONE_GROUP = [ArgGroup(min=1, max=1)] |
459 | f9faf9c3 | René Nussbaumer | ARGS_ONE_OS = [ArgOs(min=1, max=1)] |
460 | 4a265c08 | Michael Hanselmann | |
461 | 4a265c08 | Michael Hanselmann | |
462 | 846baef9 | Iustin Pop | def _ExtractTagsObject(opts, args): |
463 | 846baef9 | Iustin Pop | """Extract the tag type object.
|
464 | 846baef9 | Iustin Pop |
|
465 | 846baef9 | Iustin Pop | Note that this function will modify its args parameter.
|
466 | 846baef9 | Iustin Pop |
|
467 | 846baef9 | Iustin Pop | """
|
468 | 846baef9 | Iustin Pop | if not hasattr(opts, "tag_type"): |
469 | 846baef9 | Iustin Pop | raise errors.ProgrammerError("tag_type not passed to _ExtractTagsObject") |
470 | 846baef9 | Iustin Pop | kind = opts.tag_type |
471 | 846baef9 | Iustin Pop | if kind == constants.TAG_CLUSTER:
|
472 | 5cbf7832 | Jose A. Lopes | retval = kind, ""
|
473 | 819cbfe5 | Michael Hanselmann | elif kind in (constants.TAG_NODEGROUP, |
474 | 819cbfe5 | Michael Hanselmann | constants.TAG_NODE, |
475 | 8140e24f | Dimitris Aragiorgis | constants.TAG_NETWORK, |
476 | 819cbfe5 | Michael Hanselmann | constants.TAG_INSTANCE): |
477 | 846baef9 | Iustin Pop | if not args: |
478 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("no arguments passed to the command", |
479 | 2cfbc784 | Iustin Pop | errors.ECODE_INVAL) |
480 | 846baef9 | Iustin Pop | name = args.pop(0)
|
481 | 846baef9 | Iustin Pop | retval = kind, name |
482 | 846baef9 | Iustin Pop | else:
|
483 | 846baef9 | Iustin Pop | raise errors.ProgrammerError("Unhandled tag type '%s'" % kind) |
484 | 846baef9 | Iustin Pop | return retval
|
485 | 846baef9 | Iustin Pop | |
486 | 846baef9 | Iustin Pop | |
487 | 810c50b7 | Iustin Pop | def _ExtendTags(opts, args): |
488 | 810c50b7 | Iustin Pop | """Extend the args if a source file has been given.
|
489 | 810c50b7 | Iustin Pop |
|
490 | 810c50b7 | Iustin Pop | This function will extend the tags with the contents of the file
|
491 | 810c50b7 | Iustin Pop | passed in the 'tags_source' attribute of the opts parameter. A file
|
492 | 810c50b7 | Iustin Pop | named '-' will be replaced by stdin.
|
493 | 810c50b7 | Iustin Pop |
|
494 | 810c50b7 | Iustin Pop | """
|
495 | 810c50b7 | Iustin Pop | fname = opts.tags_source |
496 | 810c50b7 | Iustin Pop | if fname is None: |
497 | 810c50b7 | Iustin Pop | return
|
498 | 810c50b7 | Iustin Pop | if fname == "-": |
499 | 810c50b7 | Iustin Pop | new_fh = sys.stdin |
500 | 810c50b7 | Iustin Pop | else:
|
501 | 810c50b7 | Iustin Pop | new_fh = open(fname, "r") |
502 | 810c50b7 | Iustin Pop | new_data = [] |
503 | 810c50b7 | Iustin Pop | try:
|
504 | 810c50b7 | Iustin Pop | # we don't use the nice 'new_data = [line.strip() for line in fh]'
|
505 | 810c50b7 | Iustin Pop | # because of python bug 1633941
|
506 | 810c50b7 | Iustin Pop | while True: |
507 | 810c50b7 | Iustin Pop | line = new_fh.readline() |
508 | 810c50b7 | Iustin Pop | if not line: |
509 | 810c50b7 | Iustin Pop | break
|
510 | 810c50b7 | Iustin Pop | new_data.append(line.strip()) |
511 | 810c50b7 | Iustin Pop | finally:
|
512 | 810c50b7 | Iustin Pop | new_fh.close() |
513 | 810c50b7 | Iustin Pop | args.extend(new_data) |
514 | 810c50b7 | Iustin Pop | |
515 | 810c50b7 | Iustin Pop | |
516 | 846baef9 | Iustin Pop | def ListTags(opts, args): |
517 | 846baef9 | Iustin Pop | """List the tags on a given object.
|
518 | 846baef9 | Iustin Pop |
|
519 | 846baef9 | Iustin Pop | This is a generic implementation that knows how to deal with all
|
520 | 846baef9 | Iustin Pop | three cases of tag objects (cluster, node, instance). The opts
|
521 | 846baef9 | Iustin Pop | argument is expected to contain a tag_type field denoting what
|
522 | 846baef9 | Iustin Pop | object type we work on.
|
523 | 846baef9 | Iustin Pop |
|
524 | 846baef9 | Iustin Pop | """
|
525 | 846baef9 | Iustin Pop | kind, name = _ExtractTagsObject(opts, args) |
526 | f2374060 | Iustin Pop | cl = GetClient(query=True)
|
527 | 7699c3af | Iustin Pop | result = cl.QueryTags(kind, name) |
528 | 846baef9 | Iustin Pop | result = list(result)
|
529 | 846baef9 | Iustin Pop | result.sort() |
530 | 846baef9 | Iustin Pop | for tag in result: |
531 | 03298ebe | Michael Hanselmann | ToStdout(tag) |
532 | 846baef9 | Iustin Pop | |
533 | 846baef9 | Iustin Pop | |
534 | 846baef9 | Iustin Pop | def AddTags(opts, args): |
535 | 846baef9 | Iustin Pop | """Add tags on a given object.
|
536 | 846baef9 | Iustin Pop |
|
537 | 846baef9 | Iustin Pop | This is a generic implementation that knows how to deal with all
|
538 | 846baef9 | Iustin Pop | three cases of tag objects (cluster, node, instance). The opts
|
539 | 846baef9 | Iustin Pop | argument is expected to contain a tag_type field denoting what
|
540 | 846baef9 | Iustin Pop | object type we work on.
|
541 | 846baef9 | Iustin Pop |
|
542 | 846baef9 | Iustin Pop | """
|
543 | 846baef9 | Iustin Pop | kind, name = _ExtractTagsObject(opts, args) |
544 | 810c50b7 | Iustin Pop | _ExtendTags(opts, args) |
545 | 846baef9 | Iustin Pop | if not args: |
546 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("No tags to be added", errors.ECODE_INVAL) |
547 | d1602edc | Iustin Pop | op = opcodes.OpTagsSet(kind=kind, name=name, tags=args) |
548 | 6bc3ed14 | Michael Hanselmann | SubmitOrSend(op, opts) |
549 | 846baef9 | Iustin Pop | |
550 | 846baef9 | Iustin Pop | |
551 | 846baef9 | Iustin Pop | def RemoveTags(opts, args): |
552 | 846baef9 | Iustin Pop | """Remove tags from a given object.
|
553 | 846baef9 | Iustin Pop |
|
554 | 846baef9 | Iustin Pop | This is a generic implementation that knows how to deal with all
|
555 | 846baef9 | Iustin Pop | three cases of tag objects (cluster, node, instance). The opts
|
556 | 846baef9 | Iustin Pop | argument is expected to contain a tag_type field denoting what
|
557 | 846baef9 | Iustin Pop | object type we work on.
|
558 | 846baef9 | Iustin Pop |
|
559 | 846baef9 | Iustin Pop | """
|
560 | 846baef9 | Iustin Pop | kind, name = _ExtractTagsObject(opts, args) |
561 | 810c50b7 | Iustin Pop | _ExtendTags(opts, args) |
562 | 846baef9 | Iustin Pop | if not args: |
563 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("No tags to be removed", errors.ECODE_INVAL) |
564 | 3f0ab95f | Iustin Pop | op = opcodes.OpTagsDel(kind=kind, name=name, tags=args) |
565 | 6bc3ed14 | Michael Hanselmann | SubmitOrSend(op, opts) |
566 | 846baef9 | Iustin Pop | |
567 | a8083063 | Iustin Pop | |
568 | b459a848 | Andrea Spadaccini | def check_unit(option, opt, value): # pylint: disable=W0613 |
569 | 65fe4693 | Iustin Pop | """OptParsers custom converter for units.
|
570 | 65fe4693 | Iustin Pop |
|
571 | 65fe4693 | Iustin Pop | """
|
572 | a8083063 | Iustin Pop | try:
|
573 | a8083063 | Iustin Pop | return utils.ParseUnit(value)
|
574 | a8083063 | Iustin Pop | except errors.UnitParseError, err:
|
575 | 3ecf6786 | Iustin Pop | raise OptionValueError("option %s: %s" % (opt, err)) |
576 | a8083063 | Iustin Pop | |
577 | a8083063 | Iustin Pop | |
578 | 726ae450 | Bernardo Dal Seno | def _SplitKeyVal(opt, data, parse_prefixes): |
579 | a8469393 | Iustin Pop | """Convert a KeyVal string into a dict.
|
580 | a8469393 | Iustin Pop |
|
581 | a8469393 | Iustin Pop | This function will convert a key=val[,...] string into a dict. Empty
|
582 | a8469393 | Iustin Pop | values will be converted specially: keys which have the prefix 'no_'
|
583 | 726ae450 | Bernardo Dal Seno | will have the value=False and the prefix stripped, keys with the prefix
|
584 | 726ae450 | Bernardo Dal Seno | "-" will have value=None and the prefix stripped, and the others will
|
585 | a8469393 | Iustin Pop | have value=True.
|
586 | a8469393 | Iustin Pop |
|
587 | a8469393 | Iustin Pop | @type opt: string
|
588 | a8469393 | Iustin Pop | @param opt: a string holding the option name for which we process the
|
589 | a8469393 | Iustin Pop | data, used in building error messages
|
590 | a8469393 | Iustin Pop | @type data: string
|
591 | a8469393 | Iustin Pop | @param data: a string of the format key=val,key=val,...
|
592 | 726ae450 | Bernardo Dal Seno | @type parse_prefixes: bool
|
593 | 726ae450 | Bernardo Dal Seno | @param parse_prefixes: whether to handle prefixes specially
|
594 | a8469393 | Iustin Pop | @rtype: dict
|
595 | a8469393 | Iustin Pop | @return: {key=val, key=val}
|
596 | a8469393 | Iustin Pop | @raises errors.ParameterError: if there are duplicate keys
|
597 | a8469393 | Iustin Pop |
|
598 | a8469393 | Iustin Pop | """
|
599 | a8469393 | Iustin Pop | kv_dict = {} |
600 | 4f31882e | Guido Trotter | if data:
|
601 | 1b3a7656 | Iustin Pop | for elem in utils.UnescapeAndSplit(data, sep=","): |
602 | 4f31882e | Guido Trotter | if "=" in elem: |
603 | 4f31882e | Guido Trotter | key, val = elem.split("=", 1) |
604 | 726ae450 | Bernardo Dal Seno | elif parse_prefixes:
|
605 | 4f31882e | Guido Trotter | if elem.startswith(NO_PREFIX):
|
606 | 4f31882e | Guido Trotter | key, val = elem[len(NO_PREFIX):], False |
607 | 4f31882e | Guido Trotter | elif elem.startswith(UN_PREFIX):
|
608 | 4f31882e | Guido Trotter | key, val = elem[len(UN_PREFIX):], None |
609 | 4f31882e | Guido Trotter | else:
|
610 | 4f31882e | Guido Trotter | key, val = elem, True
|
611 | 726ae450 | Bernardo Dal Seno | else:
|
612 | 726ae450 | Bernardo Dal Seno | raise errors.ParameterError("Missing value for key '%s' in option %s" % |
613 | 726ae450 | Bernardo Dal Seno | (elem, opt)) |
614 | 4f31882e | Guido Trotter | if key in kv_dict: |
615 | 4f31882e | Guido Trotter | raise errors.ParameterError("Duplicate key '%s' in option %s" % |
616 | 4f31882e | Guido Trotter | (key, opt)) |
617 | 4f31882e | Guido Trotter | kv_dict[key] = val |
618 | a8469393 | Iustin Pop | return kv_dict
|
619 | a8469393 | Iustin Pop | |
620 | a8469393 | Iustin Pop | |
621 | 726ae450 | Bernardo Dal Seno | def _SplitIdentKeyVal(opt, value, parse_prefixes): |
622 | 726ae450 | Bernardo Dal Seno | """Helper function to parse "ident:key=val,key=val" options.
|
623 | 552c8dff | Michael Hanselmann |
|
624 | 726ae450 | Bernardo Dal Seno | @type opt: string
|
625 | 726ae450 | Bernardo Dal Seno | @param opt: option name, used in error messages
|
626 | 726ae450 | Bernardo Dal Seno | @type value: string
|
627 | 726ae450 | Bernardo Dal Seno | @param value: expected to be in the format "ident:key=val,key=val,..."
|
628 | 726ae450 | Bernardo Dal Seno | @type parse_prefixes: bool
|
629 | 726ae450 | Bernardo Dal Seno | @param parse_prefixes: whether to handle prefixes specially (see
|
630 | 726ae450 | Bernardo Dal Seno | L{_SplitKeyVal})
|
631 | 726ae450 | Bernardo Dal Seno | @rtype: tuple
|
632 | 726ae450 | Bernardo Dal Seno | @return: (ident, {key=val, key=val})
|
633 | 726ae450 | Bernardo Dal Seno | @raises errors.ParameterError: in case of duplicates or other parsing errors
|
634 | a8469393 | Iustin Pop |
|
635 | a8469393 | Iustin Pop | """
|
636 | a8469393 | Iustin Pop | if ":" not in value: |
637 | d0c8c01d | Iustin Pop | ident, rest = value, ""
|
638 | a8469393 | Iustin Pop | else:
|
639 | a8469393 | Iustin Pop | ident, rest = value.split(":", 1) |
640 | 8b46606c | Guido Trotter | |
641 | 726ae450 | Bernardo Dal Seno | if parse_prefixes and ident.startswith(NO_PREFIX): |
642 | 8b46606c | Guido Trotter | if rest:
|
643 | 8b46606c | Guido Trotter | msg = "Cannot pass options when removing parameter groups: %s" % value
|
644 | 8b46606c | Guido Trotter | raise errors.ParameterError(msg)
|
645 | 8b46606c | Guido Trotter | retval = (ident[len(NO_PREFIX):], False) |
646 | 726ae450 | Bernardo Dal Seno | elif (parse_prefixes and ident.startswith(UN_PREFIX) and |
647 | 726ae450 | Bernardo Dal Seno | (len(ident) <= len(UN_PREFIX) or not ident[len(UN_PREFIX)].isdigit())): |
648 | 8b46606c | Guido Trotter | if rest:
|
649 | 8b46606c | Guido Trotter | msg = "Cannot pass options when removing parameter groups: %s" % value
|
650 | 8b46606c | Guido Trotter | raise errors.ParameterError(msg)
|
651 | 8b46606c | Guido Trotter | retval = (ident[len(UN_PREFIX):], None) |
652 | 8b46606c | Guido Trotter | else:
|
653 | 726ae450 | Bernardo Dal Seno | kv_dict = _SplitKeyVal(opt, rest, parse_prefixes) |
654 | a8469393 | Iustin Pop | retval = (ident, kv_dict) |
655 | a8469393 | Iustin Pop | return retval
|
656 | a8469393 | Iustin Pop | |
657 | a8469393 | Iustin Pop | |
658 | 726ae450 | Bernardo Dal Seno | def check_ident_key_val(option, opt, value): # pylint: disable=W0613 |
659 | 726ae450 | Bernardo Dal Seno | """Custom parser for ident:key=val,key=val options.
|
660 | 726ae450 | Bernardo Dal Seno |
|
661 | 726ae450 | Bernardo Dal Seno | This will store the parsed values as a tuple (ident, {key: val}). As such,
|
662 | 726ae450 | Bernardo Dal Seno | multiple uses of this option via action=append is possible.
|
663 | 726ae450 | Bernardo Dal Seno |
|
664 | 726ae450 | Bernardo Dal Seno | """
|
665 | 726ae450 | Bernardo Dal Seno | return _SplitIdentKeyVal(opt, value, True) |
666 | 726ae450 | Bernardo Dal Seno | |
667 | 726ae450 | Bernardo Dal Seno | |
668 | b459a848 | Andrea Spadaccini | def check_key_val(option, opt, value): # pylint: disable=W0613 |
669 | 552c8dff | Michael Hanselmann | """Custom parser class for key=val,key=val options.
|
670 | 552c8dff | Michael Hanselmann |
|
671 | 552c8dff | Michael Hanselmann | This will store the parsed values as a dict {key: val}.
|
672 | a8469393 | Iustin Pop |
|
673 | a8469393 | Iustin Pop | """
|
674 | 726ae450 | Bernardo Dal Seno | return _SplitKeyVal(opt, value, True) |
675 | 726ae450 | Bernardo Dal Seno | |
676 | 726ae450 | Bernardo Dal Seno | |
677 | 726ae450 | Bernardo Dal Seno | def _SplitListKeyVal(opt, value): |
678 | 726ae450 | Bernardo Dal Seno | retval = {} |
679 | 726ae450 | Bernardo Dal Seno | for elem in value.split("/"): |
680 | 726ae450 | Bernardo Dal Seno | if not elem: |
681 | 726ae450 | Bernardo Dal Seno | raise errors.ParameterError("Empty section in option '%s'" % opt) |
682 | 726ae450 | Bernardo Dal Seno | (ident, valdict) = _SplitIdentKeyVal(opt, elem, False)
|
683 | 726ae450 | Bernardo Dal Seno | if ident in retval: |
684 | 726ae450 | Bernardo Dal Seno | msg = ("Duplicated parameter '%s' in parsing %s: %s" %
|
685 | 726ae450 | Bernardo Dal Seno | (ident, opt, elem)) |
686 | 726ae450 | Bernardo Dal Seno | raise errors.ParameterError(msg)
|
687 | 726ae450 | Bernardo Dal Seno | retval[ident] = valdict |
688 | 726ae450 | Bernardo Dal Seno | return retval
|
689 | 726ae450 | Bernardo Dal Seno | |
690 | 726ae450 | Bernardo Dal Seno | |
691 | ef99e3e8 | Bernardo Dal Seno | def check_multilist_ident_key_val(_, opt, value): |
692 | ef99e3e8 | Bernardo Dal Seno | """Custom parser for "ident:key=val,key=val/ident:key=val//ident:.." options.
|
693 | 726ae450 | Bernardo Dal Seno |
|
694 | 726ae450 | Bernardo Dal Seno | @rtype: list of dictionary
|
695 | ef99e3e8 | Bernardo Dal Seno | @return: [{ident: {key: val, key: val}, ident: {key: val}}, {ident:..}]
|
696 | 726ae450 | Bernardo Dal Seno |
|
697 | 726ae450 | Bernardo Dal Seno | """
|
698 | ef99e3e8 | Bernardo Dal Seno | retval = [] |
699 | ef99e3e8 | Bernardo Dal Seno | for line in value.split("//"): |
700 | ef99e3e8 | Bernardo Dal Seno | retval.append(_SplitListKeyVal(opt, line)) |
701 | ef99e3e8 | Bernardo Dal Seno | return retval
|
702 | a8469393 | Iustin Pop | |
703 | a8469393 | Iustin Pop | |
704 | b459a848 | Andrea Spadaccini | def check_bool(option, opt, value): # pylint: disable=W0613 |
705 | e7b61bb0 | Iustin Pop | """Custom parser for yes/no options.
|
706 | e7b61bb0 | Iustin Pop |
|
707 | e7b61bb0 | Iustin Pop | This will store the parsed value as either True or False.
|
708 | e7b61bb0 | Iustin Pop |
|
709 | e7b61bb0 | Iustin Pop | """
|
710 | e7b61bb0 | Iustin Pop | value = value.lower() |
711 | e7b61bb0 | Iustin Pop | if value == constants.VALUE_FALSE or value == "no": |
712 | e7b61bb0 | Iustin Pop | return False |
713 | e7b61bb0 | Iustin Pop | elif value == constants.VALUE_TRUE or value == "yes": |
714 | e7b61bb0 | Iustin Pop | return True |
715 | e7b61bb0 | Iustin Pop | else:
|
716 | e7b61bb0 | Iustin Pop | raise errors.ParameterError("Invalid boolean value '%s'" % value) |
717 | e7b61bb0 | Iustin Pop | |
718 | e7b61bb0 | Iustin Pop | |
719 | 499eb088 | Iustin Pop | def check_list(option, opt, value): # pylint: disable=W0613 |
720 | 499eb088 | Iustin Pop | """Custom parser for comma-separated lists.
|
721 | 499eb088 | Iustin Pop |
|
722 | 499eb088 | Iustin Pop | """
|
723 | 499eb088 | Iustin Pop | # we have to make this explicit check since "".split(",") is [""],
|
724 | 499eb088 | Iustin Pop | # not an empty list :(
|
725 | 499eb088 | Iustin Pop | if not value: |
726 | 499eb088 | Iustin Pop | return []
|
727 | 499eb088 | Iustin Pop | else:
|
728 | 499eb088 | Iustin Pop | return utils.UnescapeAndSplit(value)
|
729 | 499eb088 | Iustin Pop | |
730 | 499eb088 | Iustin Pop | |
731 | cd415612 | René Nussbaumer | def check_maybefloat(option, opt, value): # pylint: disable=W0613 |
732 | cd415612 | René Nussbaumer | """Custom parser for float numbers which might be also defaults.
|
733 | cd415612 | René Nussbaumer |
|
734 | cd415612 | René Nussbaumer | """
|
735 | cd415612 | René Nussbaumer | value = value.lower() |
736 | cd415612 | René Nussbaumer | |
737 | cd415612 | René Nussbaumer | if value == constants.VALUE_DEFAULT:
|
738 | cd415612 | René Nussbaumer | return value
|
739 | cd415612 | René Nussbaumer | else:
|
740 | cd415612 | René Nussbaumer | return float(value) |
741 | cd415612 | René Nussbaumer | |
742 | cd415612 | René Nussbaumer | |
743 | 63d44c55 | Michael Hanselmann | # completion_suggestion is normally a list. Using numeric values not evaluating
|
744 | 63d44c55 | Michael Hanselmann | # to False for dynamic completion.
|
745 | 63d44c55 | Michael Hanselmann | (OPT_COMPL_MANY_NODES, |
746 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_NODE, |
747 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_INSTANCE, |
748 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_OS, |
749 | b954f097 | Constantinos Venetsanopoulos | OPT_COMPL_ONE_EXTSTORAGE, |
750 | 2d3ed64b | Michael Hanselmann | OPT_COMPL_ONE_IALLOCATOR, |
751 | 9c784fb3 | Dimitris Aragiorgis | OPT_COMPL_ONE_NETWORK, |
752 | 36e247e1 | Guido Trotter | OPT_COMPL_INST_ADD_NODES, |
753 | b954f097 | Constantinos Venetsanopoulos | OPT_COMPL_ONE_NODEGROUP) = range(100, 109) |
754 | 63d44c55 | Michael Hanselmann | |
755 | b8028dcf | Michael Hanselmann | OPT_COMPL_ALL = compat.UniqueFrozenset([ |
756 | 63d44c55 | Michael Hanselmann | OPT_COMPL_MANY_NODES, |
757 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_NODE, |
758 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_INSTANCE, |
759 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_OS, |
760 | b954f097 | Constantinos Venetsanopoulos | OPT_COMPL_ONE_EXTSTORAGE, |
761 | 63d44c55 | Michael Hanselmann | OPT_COMPL_ONE_IALLOCATOR, |
762 | 9c784fb3 | Dimitris Aragiorgis | OPT_COMPL_ONE_NETWORK, |
763 | 2d3ed64b | Michael Hanselmann | OPT_COMPL_INST_ADD_NODES, |
764 | 36e247e1 | Guido Trotter | OPT_COMPL_ONE_NODEGROUP, |
765 | 63d44c55 | Michael Hanselmann | ]) |
766 | 63d44c55 | Michael Hanselmann | |
767 | 63d44c55 | Michael Hanselmann | |
768 | 552c8dff | Michael Hanselmann | class CliOption(Option): |
769 | 552c8dff | Michael Hanselmann | """Custom option class for optparse.
|
770 | a8469393 | Iustin Pop |
|
771 | a8469393 | Iustin Pop | """
|
772 | 863d7f46 | Michael Hanselmann | ATTRS = Option.ATTRS + [ |
773 | 863d7f46 | Michael Hanselmann | "completion_suggest",
|
774 | 863d7f46 | Michael Hanselmann | ] |
775 | 552c8dff | Michael Hanselmann | TYPES = Option.TYPES + ( |
776 | ef99e3e8 | Bernardo Dal Seno | "multilistidentkeyval",
|
777 | 552c8dff | Michael Hanselmann | "identkeyval",
|
778 | 552c8dff | Michael Hanselmann | "keyval",
|
779 | 552c8dff | Michael Hanselmann | "unit",
|
780 | e7b61bb0 | Iustin Pop | "bool",
|
781 | 499eb088 | Iustin Pop | "list",
|
782 | cd415612 | René Nussbaumer | "maybefloat",
|
783 | 552c8dff | Michael Hanselmann | ) |
784 | 552c8dff | Michael Hanselmann | TYPE_CHECKER = Option.TYPE_CHECKER.copy() |
785 | ef99e3e8 | Bernardo Dal Seno | TYPE_CHECKER["multilistidentkeyval"] = check_multilist_ident_key_val
|
786 | 552c8dff | Michael Hanselmann | TYPE_CHECKER["identkeyval"] = check_ident_key_val
|
787 | a8469393 | Iustin Pop | TYPE_CHECKER["keyval"] = check_key_val
|
788 | 552c8dff | Michael Hanselmann | TYPE_CHECKER["unit"] = check_unit
|
789 | e7b61bb0 | Iustin Pop | TYPE_CHECKER["bool"] = check_bool
|
790 | 499eb088 | Iustin Pop | TYPE_CHECKER["list"] = check_list
|
791 | cd415612 | René Nussbaumer | TYPE_CHECKER["maybefloat"] = check_maybefloat
|
792 | a8469393 | Iustin Pop | |
793 | a8469393 | Iustin Pop | |
794 | a8083063 | Iustin Pop | # optparse.py sets make_option, so we do it for our own option class, too
|
795 | a8083063 | Iustin Pop | cli_option = CliOption |
796 | a8083063 | Iustin Pop | |
797 | a8083063 | Iustin Pop | |
798 | 771734c9 | Iustin Pop | _YORNO = "yes|no"
|
799 | 771734c9 | Iustin Pop | |
800 | ea34193f | Iustin Pop | DEBUG_OPT = cli_option("-d", "--debug", default=0, action="count", |
801 | ea34193f | Iustin Pop | help="Increase debugging level")
|
802 | c38c44ad | Michael Hanselmann | |
803 | c38c44ad | Michael Hanselmann | NOHDR_OPT = cli_option("--no-headers", default=False, |
804 | c38c44ad | Michael Hanselmann | action="store_true", dest="no_headers", |
805 | c38c44ad | Michael Hanselmann | help="Don't display column headers")
|
806 | c38c44ad | Michael Hanselmann | |
807 | c38c44ad | Michael Hanselmann | SEP_OPT = cli_option("--separator", default=None, |
808 | c38c44ad | Michael Hanselmann | action="store", dest="separator", |
809 | c38c44ad | Michael Hanselmann | help=("Separator between output fields"
|
810 | c38c44ad | Michael Hanselmann | " (defaults to one space)"))
|
811 | c38c44ad | Michael Hanselmann | |
812 | c38c44ad | Michael Hanselmann | USEUNITS_OPT = cli_option("--units", default=None, |
813 | d0c8c01d | Iustin Pop | dest="units", choices=("h", "m", "g", "t"), |
814 | b714765a | Adeodato Simo | help="Specify units for output (one of h/m/g/t)")
|
815 | c38c44ad | Michael Hanselmann | |
816 | c38c44ad | Michael Hanselmann | FIELDS_OPT = cli_option("-o", "--output", dest="output", action="store", |
817 | c38c44ad | Michael Hanselmann | type="string", metavar="FIELDS", |
818 | c38c44ad | Michael Hanselmann | help="Comma separated list of output fields")
|
819 | c38c44ad | Michael Hanselmann | |
820 | c38c44ad | Michael Hanselmann | FORCE_OPT = cli_option("-f", "--force", dest="force", action="store_true", |
821 | c38c44ad | Michael Hanselmann | default=False, help="Force the operation") |
822 | c38c44ad | Michael Hanselmann | |
823 | c38c44ad | Michael Hanselmann | CONFIRM_OPT = cli_option("--yes", dest="confirm", action="store_true", |
824 | c38c44ad | Michael Hanselmann | default=False, help="Do not require confirmation") |
825 | c38c44ad | Michael Hanselmann | |
826 | b44bd844 | Michael Hanselmann | IGNORE_OFFLINE_OPT = cli_option("--ignore-offline", dest="ignore_offline", |
827 | b44bd844 | Michael Hanselmann | action="store_true", default=False, |
828 | b44bd844 | Michael Hanselmann | help=("Ignore offline nodes and do as much"
|
829 | b44bd844 | Michael Hanselmann | " as possible"))
|
830 | b44bd844 | Michael Hanselmann | |
831 | a57981c5 | Apollon Oikonomopoulos | TAG_ADD_OPT = cli_option("--tags", dest="tags", |
832 | a57981c5 | Apollon Oikonomopoulos | default=None, help="Comma-separated list of instance" |
833 | a57981c5 | Apollon Oikonomopoulos | " tags")
|
834 | a57981c5 | Apollon Oikonomopoulos | |
835 | c38c44ad | Michael Hanselmann | TAG_SRC_OPT = cli_option("--from", dest="tags_source", |
836 | c38c44ad | Michael Hanselmann | default=None, help="File with tag names") |
837 | c38c44ad | Michael Hanselmann | |
838 | c38c44ad | Michael Hanselmann | SUBMIT_OPT = cli_option("--submit", dest="submit_only", |
839 | c38c44ad | Michael Hanselmann | default=False, action="store_true", |
840 | c38c44ad | Michael Hanselmann | help=("Submit the job and return the job ID, but"
|
841 | c38c44ad | Michael Hanselmann | " don't wait for the job to finish"))
|
842 | c38c44ad | Michael Hanselmann | |
843 | d6cd74dd | Klaus Aehlig | PRINT_JOBID_OPT = cli_option("--print-jobid", dest="print_jobid", |
844 | d6cd74dd | Klaus Aehlig | default=False, action="store_true", |
845 | d6cd74dd | Klaus Aehlig | help=("Additionally print the job as first line"
|
846 | d6cd74dd | Klaus Aehlig | " on stdout (for scripting)."))
|
847 | d6cd74dd | Klaus Aehlig | |
848 | ed9c2202 | Klaus Aehlig | SEQUENTIAL_OPT = cli_option("--sequential", dest="sequential", |
849 | ed9c2202 | Klaus Aehlig | default=False, action="store_true", |
850 | ed9c2202 | Klaus Aehlig | help=("Execute all resulting jobs sequentially"))
|
851 | ed9c2202 | Klaus Aehlig | |
852 | c38c44ad | Michael Hanselmann | SYNC_OPT = cli_option("--sync", dest="do_locking", |
853 | c38c44ad | Michael Hanselmann | default=False, action="store_true", |
854 | c38c44ad | Michael Hanselmann | help=("Grab locks while doing the queries"
|
855 | c38c44ad | Michael Hanselmann | " in order to ensure more consistent results"))
|
856 | c38c44ad | Michael Hanselmann | |
857 | a0a6ff34 | Iustin Pop | DRY_RUN_OPT = cli_option("--dry-run", default=False, |
858 | a0a6ff34 | Iustin Pop | action="store_true",
|
859 | a0a6ff34 | Iustin Pop | help=("Do not execute the operation, just run the"
|
860 | 90efd920 | Michael Hanselmann | " check steps and verify if it could be"
|
861 | a0a6ff34 | Iustin Pop | " executed"))
|
862 | c38c44ad | Michael Hanselmann | |
863 | 9cdb9578 | Iustin Pop | VERBOSE_OPT = cli_option("-v", "--verbose", default=False, |
864 | 9cdb9578 | Iustin Pop | action="store_true",
|
865 | 9cdb9578 | Iustin Pop | help="Increase the verbosity of the operation")
|
866 | 9cdb9578 | Iustin Pop | |
867 | a0c9776a | Iustin Pop | DEBUG_SIMERR_OPT = cli_option("--debug-simulate-errors", default=False, |
868 | a0c9776a | Iustin Pop | action="store_true", dest="simulate_errors", |
869 | a0c9776a | Iustin Pop | help="Debugging option that makes the operation"
|
870 | a0c9776a | Iustin Pop | " treat most runtime checks as failed")
|
871 | a0c9776a | Iustin Pop | |
872 | 3f75b4f3 | Iustin Pop | NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync", |
873 | 3f75b4f3 | Iustin Pop | default=True, action="store_false", |
874 | 3f75b4f3 | Iustin Pop | help="Don't wait for sync (DANGEROUS!)")
|
875 | 3f75b4f3 | Iustin Pop | |
876 | f30d8165 | Iustin Pop | WFSYNC_OPT = cli_option("--wait-for-sync", dest="wait_for_sync", |
877 | f30d8165 | Iustin Pop | default=False, action="store_true", |
878 | f30d8165 | Iustin Pop | help="Wait for disks to sync")
|
879 | f30d8165 | Iustin Pop | |
880 | 57de31c0 | Agata Murawska | ONLINE_INST_OPT = cli_option("--online", dest="online_inst", |
881 | 57de31c0 | Agata Murawska | action="store_true", default=False, |
882 | 57de31c0 | Agata Murawska | help="Enable offline instance")
|
883 | 57de31c0 | Agata Murawska | |
884 | 57de31c0 | Agata Murawska | OFFLINE_INST_OPT = cli_option("--offline", dest="offline_inst", |
885 | 57de31c0 | Agata Murawska | action="store_true", default=False, |
886 | 57de31c0 | Agata Murawska | help="Disable down instance")
|
887 | 57de31c0 | Agata Murawska | |
888 | 4f365444 | Iustin Pop | DISK_TEMPLATE_OPT = cli_option("-t", "--disk-template", dest="disk_template", |
889 | 235407ba | Michael Hanselmann | help=("Custom disk setup (%s)" %
|
890 | 235407ba | Michael Hanselmann | utils.CommaJoin(constants.DISK_TEMPLATES)), |
891 | 4f365444 | Iustin Pop | default=None, metavar="TEMPL", |
892 | 4f365444 | Iustin Pop | choices=list(constants.DISK_TEMPLATES))
|
893 | 4f365444 | Iustin Pop | |
894 | 26023ecd | Iustin Pop | NONICS_OPT = cli_option("--no-nics", default=False, action="store_true", |
895 | 26023ecd | Iustin Pop | help="Do not create any network cards for"
|
896 | 26023ecd | Iustin Pop | " the instance")
|
897 | 26023ecd | Iustin Pop | |
898 | 4a25828c | Iustin Pop | FILESTORE_DIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir", |
899 | 4a25828c | Iustin Pop | help="Relative path under default cluster-wide"
|
900 | 4a25828c | Iustin Pop | " file storage dir to store file-based disks",
|
901 | 4a25828c | Iustin Pop | default=None, metavar="<DIR>") |
902 | 4a25828c | Iustin Pop | |
903 | 0f87c43e | Iustin Pop | FILESTORE_DRIVER_OPT = cli_option("--file-driver", dest="file_driver", |
904 | 0f87c43e | Iustin Pop | help="Driver to use for image files",
|
905 | ff34fb97 | Michele Tartara | default=None, metavar="<DRIVER>", |
906 | 0f87c43e | Iustin Pop | choices=list(constants.FILE_DRIVER))
|
907 | 0f87c43e | Iustin Pop | |
908 | 4eb62659 | Iustin Pop | IALLOCATOR_OPT = cli_option("-I", "--iallocator", metavar="<NAME>", |
909 | 4eb62659 | Iustin Pop | help="Select nodes for the instance automatically"
|
910 | 4eb62659 | Iustin Pop | " using the <NAME> iallocator plugin",
|
911 | 4eb62659 | Iustin Pop | default=None, type="string", |
912 | 4eb62659 | Iustin Pop | completion_suggest=OPT_COMPL_ONE_IALLOCATOR) |
913 | 4eb62659 | Iustin Pop | |
914 | bf4af505 | Apollon Oikonomopoulos | DEFAULT_IALLOCATOR_OPT = cli_option("-I", "--default-iallocator", |
915 | 5ae4945a | Iustin Pop | metavar="<NAME>",
|
916 | 5ae4945a | Iustin Pop | help="Set the default instance"
|
917 | 5ae4945a | Iustin Pop | " allocator plugin",
|
918 | 5ae4945a | Iustin Pop | default=None, type="string", |
919 | 5ae4945a | Iustin Pop | completion_suggest=OPT_COMPL_ONE_IALLOCATOR) |
920 | bf4af505 | Apollon Oikonomopoulos | |
921 | d3ed23ff | Iustin Pop | OS_OPT = cli_option("-o", "--os-type", dest="os", help="What OS to run", |
922 | d3ed23ff | Iustin Pop | metavar="<os>",
|
923 | d3ed23ff | Iustin Pop | completion_suggest=OPT_COMPL_ONE_OS) |
924 | d3ed23ff | Iustin Pop | |
925 | 062a7100 | Iustin Pop | OSPARAMS_OPT = cli_option("-O", "--os-parameters", dest="osparams", |
926 | 5ae4945a | Iustin Pop | type="keyval", default={},
|
927 | 5ae4945a | Iustin Pop | help="OS parameters")
|
928 | 062a7100 | Iustin Pop | |
929 | 06073e85 | Guido Trotter | FORCE_VARIANT_OPT = cli_option("--force-variant", dest="force_variant", |
930 | 06073e85 | Guido Trotter | action="store_true", default=False, |
931 | 06073e85 | Guido Trotter | help="Force an unknown variant")
|
932 | 06073e85 | Guido Trotter | |
933 | 25a8792c | Iustin Pop | NO_INSTALL_OPT = cli_option("--no-install", dest="no_install", |
934 | 25a8792c | Iustin Pop | action="store_true", default=False, |
935 | 25a8792c | Iustin Pop | help="Do not install the OS (will"
|
936 | 25a8792c | Iustin Pop | " enable no-start)")
|
937 | 25a8792c | Iustin Pop | |
938 | 8c0b16f6 | Guido Trotter | NORUNTIME_CHGS_OPT = cli_option("--no-runtime-changes",
|
939 | 8c0b16f6 | Guido Trotter | dest="allow_runtime_chgs",
|
940 | 8c0b16f6 | Guido Trotter | default=True, action="store_false", |
941 | 8c0b16f6 | Guido Trotter | help="Don't allow runtime changes")
|
942 | 8c0b16f6 | Guido Trotter | |
943 | 087ed2ed | Iustin Pop | BACKEND_OPT = cli_option("-B", "--backend-parameters", dest="beparams", |
944 | 087ed2ed | Iustin Pop | type="keyval", default={},
|
945 | 087ed2ed | Iustin Pop | help="Backend parameters")
|
946 | 48f212d7 | Iustin Pop | |
947 | e687ec01 | Michael Hanselmann | HVOPTS_OPT = cli_option("-H", "--hypervisor-parameters", type="keyval", |
948 | e687ec01 | Michael Hanselmann | default={}, dest="hvparams",
|
949 | e687ec01 | Michael Hanselmann | help="Hypervisor parameters")
|
950 | 087ed2ed | Iustin Pop | |
951 | bc5d0215 | Andrea Spadaccini | DISK_PARAMS_OPT = cli_option("-D", "--disk-parameters", dest="diskparams", |
952 | bc5d0215 | Andrea Spadaccini | help="Disk template parameters, in the format"
|
953 | bc5d0215 | Andrea Spadaccini | " template:option=value,option=value,...",
|
954 | bc5d0215 | Andrea Spadaccini | type="identkeyval", action="append", default=[]) |
955 | bc5d0215 | Andrea Spadaccini | |
956 | 32017174 | Agata Murawska | SPECS_MEM_SIZE_OPT = cli_option("--specs-mem-size", dest="ispecs_mem_size", |
957 | 32017174 | Agata Murawska | type="keyval", default={},
|
958 | d67e0a94 | Iustin Pop | help="Memory size specs: list of key=value,"
|
959 | d67e0a94 | Iustin Pop | " where key is one of min, max, std"
|
960 | d67e0a94 | Iustin Pop | " (in MB or using a unit)")
|
961 | 32017174 | Agata Murawska | |
962 | 32017174 | Agata Murawska | SPECS_CPU_COUNT_OPT = cli_option("--specs-cpu-count", dest="ispecs_cpu_count", |
963 | 32017174 | Agata Murawska | type="keyval", default={},
|
964 | d67e0a94 | Iustin Pop | help="CPU count specs: list of key=value,"
|
965 | d67e0a94 | Iustin Pop | " where key is one of min, max, std")
|
966 | 32017174 | Agata Murawska | |
967 | 32017174 | Agata Murawska | SPECS_DISK_COUNT_OPT = cli_option("--specs-disk-count",
|
968 | 32017174 | Agata Murawska | dest="ispecs_disk_count",
|
969 | 32017174 | Agata Murawska | type="keyval", default={},
|
970 | d67e0a94 | Iustin Pop | help="Disk count specs: list of key=value,"
|
971 | d67e0a94 | Iustin Pop | " where key is one of min, max, std")
|
972 | 32017174 | Agata Murawska | |
973 | 32017174 | Agata Murawska | SPECS_DISK_SIZE_OPT = cli_option("--specs-disk-size", dest="ispecs_disk_size", |
974 | 32017174 | Agata Murawska | type="keyval", default={},
|
975 | d67e0a94 | Iustin Pop | help="Disk size specs: list of key=value,"
|
976 | 5ae4945a | Iustin Pop | " where key is one of min, max, std"
|
977 | d67e0a94 | Iustin Pop | " (in MB or using a unit)")
|
978 | 32017174 | Agata Murawska | |
979 | 32017174 | Agata Murawska | SPECS_NIC_COUNT_OPT = cli_option("--specs-nic-count", dest="ispecs_nic_count", |
980 | 32017174 | Agata Murawska | type="keyval", default={},
|
981 | d67e0a94 | Iustin Pop | help="NIC count specs: list of key=value,"
|
982 | d67e0a94 | Iustin Pop | " where key is one of min, max, std")
|
983 | 32017174 | Agata Murawska | |
984 | d2d3935a | Bernardo Dal Seno | IPOLICY_BOUNDS_SPECS_STR = "--ipolicy-bounds-specs"
|
985 | d2d3935a | Bernardo Dal Seno | IPOLICY_BOUNDS_SPECS_OPT = cli_option(IPOLICY_BOUNDS_SPECS_STR, |
986 | d2d3935a | Bernardo Dal Seno | dest="ipolicy_bounds_specs",
|
987 | ef99e3e8 | Bernardo Dal Seno | type="multilistidentkeyval", default=None, |
988 | d2d3935a | Bernardo Dal Seno | help="Complete instance specs limits")
|
989 | d2d3935a | Bernardo Dal Seno | |
990 | d2d3935a | Bernardo Dal Seno | IPOLICY_STD_SPECS_STR = "--ipolicy-std-specs"
|
991 | d2d3935a | Bernardo Dal Seno | IPOLICY_STD_SPECS_OPT = cli_option(IPOLICY_STD_SPECS_STR, |
992 | d2d3935a | Bernardo Dal Seno | dest="ipolicy_std_specs",
|
993 | d2d3935a | Bernardo Dal Seno | type="keyval", default=None, |
994 | d2d3935a | Bernardo Dal Seno | help="Complte standard instance specs")
|
995 | d2d3935a | Bernardo Dal Seno | |
996 | d04c9d45 | Iustin Pop | IPOLICY_DISK_TEMPLATES = cli_option("--ipolicy-disk-templates",
|
997 | 5ae4945a | Iustin Pop | dest="ipolicy_disk_templates",
|
998 | 5ae4945a | Iustin Pop | type="list", default=None, |
999 | 5ae4945a | Iustin Pop | help="Comma-separated list of"
|
1000 | 5ae4945a | Iustin Pop | " enabled disk templates")
|
1001 | 12c3d3f6 | Iustin Pop | |
1002 | 976b78ba | Iustin Pop | IPOLICY_VCPU_RATIO = cli_option("--ipolicy-vcpu-ratio",
|
1003 | 976b78ba | Iustin Pop | dest="ipolicy_vcpu_ratio",
|
1004 | cd415612 | René Nussbaumer | type="maybefloat", default=None, |
1005 | 976b78ba | Iustin Pop | help="The maximum allowed vcpu-to-cpu ratio")
|
1006 | 976b78ba | Iustin Pop | |
1007 | ad5cc6bd | René Nussbaumer | IPOLICY_SPINDLE_RATIO = cli_option("--ipolicy-spindle-ratio",
|
1008 | ad5cc6bd | René Nussbaumer | dest="ipolicy_spindle_ratio",
|
1009 | cd415612 | René Nussbaumer | type="maybefloat", default=None, |
1010 | ad5cc6bd | René Nussbaumer | help=("The maximum allowed instances to"
|
1011 | ad5cc6bd | René Nussbaumer | " spindle ratio"))
|
1012 | ad5cc6bd | René Nussbaumer | |
1013 | 236fd9c4 | Iustin Pop | HYPERVISOR_OPT = cli_option("-H", "--hypervisor-parameters", dest="hypervisor", |
1014 | 236fd9c4 | Iustin Pop | help="Hypervisor and hypervisor options, in the"
|
1015 | 236fd9c4 | Iustin Pop | " format hypervisor:option=value,option=value,...",
|
1016 | 236fd9c4 | Iustin Pop | default=None, type="identkeyval") |
1017 | 073271f6 | Iustin Pop | |
1018 | 073271f6 | Iustin Pop | HVLIST_OPT = cli_option("-H", "--hypervisor-parameters", dest="hvparams", |
1019 | 073271f6 | Iustin Pop | help="Hypervisor and hypervisor options, in the"
|
1020 | 073271f6 | Iustin Pop | " format hypervisor:option=value,option=value,...",
|
1021 | 073271f6 | Iustin Pop | default=[], action="append", type="identkeyval") |
1022 | 236fd9c4 | Iustin Pop | |
1023 | 91e0748c | Iustin Pop | NOIPCHECK_OPT = cli_option("--no-ip-check", dest="ip_check", default=True, |
1024 | 91e0748c | Iustin Pop | action="store_false",
|
1025 | 91e0748c | Iustin Pop | help="Don't check that the instance's IP"
|
1026 | 91e0748c | Iustin Pop | " is alive")
|
1027 | 91e0748c | Iustin Pop | |
1028 | 460d22be | Iustin Pop | NONAMECHECK_OPT = cli_option("--no-name-check", dest="name_check", |
1029 | 460d22be | Iustin Pop | default=True, action="store_false", |
1030 | 460d22be | Iustin Pop | help="Don't check that the instance's name"
|
1031 | 460d22be | Iustin Pop | " is resolvable")
|
1032 | 460d22be | Iustin Pop | |
1033 | 7d3a9fab | Iustin Pop | NET_OPT = cli_option("--net",
|
1034 | 7d3a9fab | Iustin Pop | help="NIC parameters", default=[],
|
1035 | 7d3a9fab | Iustin Pop | dest="nics", action="append", type="identkeyval") |
1036 | e3876ccb | Iustin Pop | |
1037 | e3876ccb | Iustin Pop | DISK_OPT = cli_option("--disk", help="Disk parameters", default=[], |
1038 | e3876ccb | Iustin Pop | dest="disks", action="append", type="identkeyval") |
1039 | 91e0748c | Iustin Pop | |
1040 | 4b038a1e | Iustin Pop | DISKIDX_OPT = cli_option("--disks", dest="disks", default=None, |
1041 | 4b038a1e | Iustin Pop | help="Comma-separated list of disks"
|
1042 | 4b038a1e | Iustin Pop | " indices to act on (e.g. 0,2) (optional,"
|
1043 | 4b038a1e | Iustin Pop | " defaults to all disks)")
|
1044 | 4b038a1e | Iustin Pop | |
1045 | ff00c1a7 | Iustin Pop | OS_SIZE_OPT = cli_option("-s", "--os-size", dest="sd_size", |
1046 | ff00c1a7 | Iustin Pop | help="Enforces a single-disk configuration using the"
|
1047 | ff00c1a7 | Iustin Pop | " given disk size, in MiB unless a suffix is used",
|
1048 | ff00c1a7 | Iustin Pop | default=None, type="unit", metavar="<size>") |
1049 | ff00c1a7 | Iustin Pop | |
1050 | 82a786d5 | Iustin Pop | IGNORE_CONSIST_OPT = cli_option("--ignore-consistency",
|
1051 | 82a786d5 | Iustin Pop | dest="ignore_consistency",
|
1052 | 82a786d5 | Iustin Pop | action="store_true", default=False, |
1053 | 82a786d5 | Iustin Pop | help="Ignore the consistency of the disks on"
|
1054 | 82a786d5 | Iustin Pop | " the secondary")
|
1055 | 82a786d5 | Iustin Pop | |
1056 | e9c487be | René Nussbaumer | ALLOW_FAILOVER_OPT = cli_option("--allow-failover",
|
1057 | e9c487be | René Nussbaumer | dest="allow_failover",
|
1058 | e9c487be | René Nussbaumer | action="store_true", default=False, |
1059 | e9c487be | René Nussbaumer | help="If migration is not possible fallback to"
|
1060 | e9c487be | René Nussbaumer | " failover")
|
1061 | e9c487be | René Nussbaumer | |
1062 | 2039321f | Klaus Aehlig | FORCE_FAILOVER_OPT = cli_option("--force-failover",
|
1063 | 2039321f | Klaus Aehlig | dest="force_failover",
|
1064 | 2039321f | Klaus Aehlig | action="store_true", default=False, |
1065 | 2039321f | Klaus Aehlig | help="Do not use migration, always use"
|
1066 | 2039321f | Klaus Aehlig | " failover")
|
1067 | 2039321f | Klaus Aehlig | |
1068 | f2a0828c | Iustin Pop | NONLIVE_OPT = cli_option("--non-live", dest="live", |
1069 | f2a0828c | Iustin Pop | default=True, action="store_false", |
1070 | f2a0828c | Iustin Pop | help="Do a non-live migration (this usually means"
|
1071 | f2a0828c | Iustin Pop | " freeze the instance, save the state, transfer and"
|
1072 | f2a0828c | Iustin Pop | " only then resume running on the secondary node)")
|
1073 | f2a0828c | Iustin Pop | |
1074 | 783a6c0b | Iustin Pop | MIGRATION_MODE_OPT = cli_option("--migration-mode", dest="migration_mode", |
1075 | e71b9ef4 | Iustin Pop | default=None,
|
1076 | 783a6c0b | Iustin Pop | choices=list(constants.HT_MIGRATION_MODES),
|
1077 | 783a6c0b | Iustin Pop | help="Override default migration mode (choose"
|
1078 | e71b9ef4 | Iustin Pop | " either live or non-live")
|
1079 | e71b9ef4 | Iustin Pop | |
1080 | 990b7886 | Iustin Pop | NODE_PLACEMENT_OPT = cli_option("-n", "--node", dest="node", |
1081 | 990b7886 | Iustin Pop | help="Target node and optional secondary node",
|
1082 | 990b7886 | Iustin Pop | metavar="<pnode>[:<snode>]",
|
1083 | 990b7886 | Iustin Pop | completion_suggest=OPT_COMPL_INST_ADD_NODES) |
1084 | 990b7886 | Iustin Pop | |
1085 | 7edc4637 | Iustin Pop | NODE_LIST_OPT = cli_option("-n", "--node", dest="nodes", default=[], |
1086 | 7edc4637 | Iustin Pop | action="append", metavar="<node>", |
1087 | 7edc4637 | Iustin Pop | help="Use only this node (can be used multiple"
|
1088 | 7edc4637 | Iustin Pop | " times, if not given defaults to all nodes)",
|
1089 | 7edc4637 | Iustin Pop | completion_suggest=OPT_COMPL_ONE_NODE) |
1090 | f36d7d81 | Iustin Pop | |
1091 | 21ee2318 | Michael Hanselmann | NODEGROUP_OPT_NAME = "--node-group"
|
1092 | 21ee2318 | Michael Hanselmann | NODEGROUP_OPT = cli_option("-g", NODEGROUP_OPT_NAME,
|
1093 | 5fbbd028 | Guido Trotter | dest="nodegroup",
|
1094 | 5fbbd028 | Guido Trotter | help="Node group (name or uuid)",
|
1095 | 5fbbd028 | Guido Trotter | metavar="<nodegroup>",
|
1096 | 5fbbd028 | Guido Trotter | default=None, type="string", |
1097 | 5fbbd028 | Guido Trotter | completion_suggest=OPT_COMPL_ONE_NODEGROUP) |
1098 | 5fbbd028 | Guido Trotter | |
1099 | f36d7d81 | Iustin Pop | SINGLE_NODE_OPT = cli_option("-n", "--node", dest="node", help="Target node", |
1100 | f36d7d81 | Iustin Pop | metavar="<node>",
|
1101 | f36d7d81 | Iustin Pop | completion_suggest=OPT_COMPL_ONE_NODE) |
1102 | 7edc4637 | Iustin Pop | |
1103 | edeb878a | Iustin Pop | NOSTART_OPT = cli_option("--no-start", dest="start", default=True, |
1104 | edeb878a | Iustin Pop | action="store_false",
|
1105 | edeb878a | Iustin Pop | help="Don't start the instance after creation")
|
1106 | edeb878a | Iustin Pop | |
1107 | fdcf4d84 | Iustin Pop | SHOWCMD_OPT = cli_option("--show-cmd", dest="show_command", |
1108 | fdcf4d84 | Iustin Pop | action="store_true", default=False, |
1109 | fdcf4d84 | Iustin Pop | help="Show command instead of executing it")
|
1110 | fdcf4d84 | Iustin Pop | |
1111 | baef337d | Iustin Pop | CLEANUP_OPT = cli_option("--cleanup", dest="cleanup", |
1112 | baef337d | Iustin Pop | default=False, action="store_true", |
1113 | aa7a5c90 | Michele Tartara | help="Instead of performing the migration/failover,"
|
1114 | aa7a5c90 | Michele Tartara | " try to recover from a failed cleanup. This is safe"
|
1115 | baef337d | Iustin Pop | " to run even if the instance is healthy, but it"
|
1116 | baef337d | Iustin Pop | " will create extra replication traffic and "
|
1117 | baef337d | Iustin Pop | " disrupt briefly the replication (like during the"
|
1118 | aa7a5c90 | Michele Tartara | " migration/failover")
|
1119 | baef337d | Iustin Pop | |
1120 | 99a8c799 | Iustin Pop | STATIC_OPT = cli_option("-s", "--static", dest="static", |
1121 | 99a8c799 | Iustin Pop | action="store_true", default=False, |
1122 | 99a8c799 | Iustin Pop | help="Only show configuration data, not runtime data")
|
1123 | 99a8c799 | Iustin Pop | |
1124 | 2d5e7ae1 | Iustin Pop | ALL_OPT = cli_option("--all", dest="show_all", |
1125 | 2d5e7ae1 | Iustin Pop | default=False, action="store_true", |
1126 | 2d5e7ae1 | Iustin Pop | help="Show info on all instances on the cluster."
|
1127 | 2d5e7ae1 | Iustin Pop | " This can take a long time to run, use wisely")
|
1128 | 2d5e7ae1 | Iustin Pop | |
1129 | 67840b40 | Iustin Pop | SELECT_OS_OPT = cli_option("--select-os", dest="select_os", |
1130 | 67840b40 | Iustin Pop | action="store_true", default=False, |
1131 | 67840b40 | Iustin Pop | help="Interactive OS reinstall, lists available"
|
1132 | 67840b40 | Iustin Pop | " OS templates for selection")
|
1133 | 2d5e7ae1 | Iustin Pop | |
1134 | b6e841a8 | Iustin Pop | IGNORE_FAILURES_OPT = cli_option("--ignore-failures", dest="ignore_failures", |
1135 | b6e841a8 | Iustin Pop | action="store_true", default=False, |
1136 | b6e841a8 | Iustin Pop | help="Remove the instance from the cluster"
|
1137 | b6e841a8 | Iustin Pop | " configuration even if there are failures"
|
1138 | b6e841a8 | Iustin Pop | " during the removal process")
|
1139 | b6e841a8 | Iustin Pop | |
1140 | 8d8d650c | Michael Hanselmann | IGNORE_REMOVE_FAILURES_OPT = cli_option("--ignore-remove-failures",
|
1141 | 8d8d650c | Michael Hanselmann | dest="ignore_remove_failures",
|
1142 | 8d8d650c | Michael Hanselmann | action="store_true", default=False, |
1143 | 8d8d650c | Michael Hanselmann | help="Remove the instance from the"
|
1144 | 8d8d650c | Michael Hanselmann | " cluster configuration even if there"
|
1145 | 8d8d650c | Michael Hanselmann | " are failures during the removal"
|
1146 | 8d8d650c | Michael Hanselmann | " process")
|
1147 | 8d8d650c | Michael Hanselmann | |
1148 | 8d8d650c | Michael Hanselmann | REMOVE_INSTANCE_OPT = cli_option("--remove-instance", dest="remove_instance", |
1149 | 8d8d650c | Michael Hanselmann | action="store_true", default=False, |
1150 | 8d8d650c | Michael Hanselmann | help="Remove the instance from the cluster")
|
1151 | 8d8d650c | Michael Hanselmann | |
1152 | 1b7761fd | Apollon Oikonomopoulos | DST_NODE_OPT = cli_option("-n", "--target-node", dest="dst_node", |
1153 | 1b7761fd | Apollon Oikonomopoulos | help="Specifies the new node for the instance",
|
1154 | 1b7761fd | Apollon Oikonomopoulos | metavar="NODE", default=None, |
1155 | 1b7761fd | Apollon Oikonomopoulos | completion_suggest=OPT_COMPL_ONE_NODE) |
1156 | 1b7761fd | Apollon Oikonomopoulos | |
1157 | a14db5ff | Iustin Pop | NEW_SECONDARY_OPT = cli_option("-n", "--new-secondary", dest="dst_node", |
1158 | a14db5ff | Iustin Pop | help="Specifies the new secondary node",
|
1159 | a14db5ff | Iustin Pop | metavar="NODE", default=None, |
1160 | a14db5ff | Iustin Pop | completion_suggest=OPT_COMPL_ONE_NODE) |
1161 | a14db5ff | Iustin Pop | |
1162 | 3438e1f8 | Klaus Aehlig | NEW_PRIMARY_OPT = cli_option("--new-primary", dest="new_primary_node", |
1163 | 3438e1f8 | Klaus Aehlig | help="Specifies the new primary node",
|
1164 | 3438e1f8 | Klaus Aehlig | metavar="<node>", default=None, |
1165 | 3438e1f8 | Klaus Aehlig | completion_suggest=OPT_COMPL_ONE_NODE) |
1166 | 3438e1f8 | Klaus Aehlig | |
1167 | a72d0a79 | Iustin Pop | ON_PRIMARY_OPT = cli_option("-p", "--on-primary", dest="on_primary", |
1168 | a72d0a79 | Iustin Pop | default=False, action="store_true", |
1169 | a72d0a79 | Iustin Pop | help="Replace the disk(s) on the primary"
|
1170 | 235407ba | Michael Hanselmann | " node (applies only to internally mirrored"
|
1171 | 235407ba | Michael Hanselmann | " disk templates, e.g. %s)" %
|
1172 | 235407ba | Michael Hanselmann | utils.CommaJoin(constants.DTS_INT_MIRROR)) |
1173 | feb09e6a | Iustin Pop | |
1174 | feb09e6a | Iustin Pop | ON_SECONDARY_OPT = cli_option("-s", "--on-secondary", dest="on_secondary", |
1175 | feb09e6a | Iustin Pop | default=False, action="store_true", |
1176 | feb09e6a | Iustin Pop | help="Replace the disk(s) on the secondary"
|
1177 | 235407ba | Michael Hanselmann | " node (applies only to internally mirrored"
|
1178 | 235407ba | Michael Hanselmann | " disk templates, e.g. %s)" %
|
1179 | 235407ba | Michael Hanselmann | utils.CommaJoin(constants.DTS_INT_MIRROR)) |
1180 | e00f7a05 | Iustin Pop | |
1181 | 4c61d894 | Iustin Pop | AUTO_PROMOTE_OPT = cli_option("--auto-promote", dest="auto_promote", |
1182 | 4c61d894 | Iustin Pop | default=False, action="store_true", |
1183 | 4c61d894 | Iustin Pop | help="Lock all nodes and auto-promote as needed"
|
1184 | 4c61d894 | Iustin Pop | " to MC status")
|
1185 | 4c61d894 | Iustin Pop | |
1186 | e00f7a05 | Iustin Pop | AUTO_REPLACE_OPT = cli_option("-a", "--auto", dest="auto", |
1187 | e00f7a05 | Iustin Pop | default=False, action="store_true", |
1188 | e00f7a05 | Iustin Pop | help="Automatically replace faulty disks"
|
1189 | 235407ba | Michael Hanselmann | " (applies only to internally mirrored"
|
1190 | 235407ba | Michael Hanselmann | " disk templates, e.g. %s)" %
|
1191 | 235407ba | Michael Hanselmann | utils.CommaJoin(constants.DTS_INT_MIRROR)) |
1192 | a72d0a79 | Iustin Pop | |
1193 | 05586c90 | Iustin Pop | IGNORE_SIZE_OPT = cli_option("--ignore-size", dest="ignore_size", |
1194 | 05586c90 | Iustin Pop | default=False, action="store_true", |
1195 | 05586c90 | Iustin Pop | help="Ignore current recorded size"
|
1196 | 05586c90 | Iustin Pop | " (useful for forcing activation when"
|
1197 | 05586c90 | Iustin Pop | " the recorded size is wrong)")
|
1198 | 05586c90 | Iustin Pop | |
1199 | df62e5db | Iustin Pop | SRC_NODE_OPT = cli_option("--src-node", dest="src_node", help="Source node", |
1200 | df62e5db | Iustin Pop | metavar="<node>",
|
1201 | df62e5db | Iustin Pop | completion_suggest=OPT_COMPL_ONE_NODE) |
1202 | df62e5db | Iustin Pop | |
1203 | df62e5db | Iustin Pop | SRC_DIR_OPT = cli_option("--src-dir", dest="src_dir", help="Source directory", |
1204 | df62e5db | Iustin Pop | metavar="<dir>")
|
1205 | df62e5db | Iustin Pop | |
1206 | 8d823629 | Iustin Pop | SECONDARY_IP_OPT = cli_option("-s", "--secondary-ip", dest="secondary_ip", |
1207 | 8d823629 | Iustin Pop | help="Specify the secondary ip for the node",
|
1208 | 8d823629 | Iustin Pop | metavar="ADDRESS", default=None) |
1209 | 8d823629 | Iustin Pop | |
1210 | b8d0f938 | Iustin Pop | READD_OPT = cli_option("--readd", dest="readd", |
1211 | b8d0f938 | Iustin Pop | default=False, action="store_true", |
1212 | b8d0f938 | Iustin Pop | help="Readd old node after replacing it")
|
1213 | b8d0f938 | Iustin Pop | |
1214 | fcdde7f2 | Iustin Pop | NOSSH_KEYCHECK_OPT = cli_option("--no-ssh-key-check", dest="ssh_key_check", |
1215 | fcdde7f2 | Iustin Pop | default=True, action="store_false", |
1216 | fcdde7f2 | Iustin Pop | help="Disable SSH key fingerprint checking")
|
1217 | fcdde7f2 | Iustin Pop | |
1218 | 61413377 | Stephen Shirley | NODE_FORCE_JOIN_OPT = cli_option("--force-join", dest="force_join", |
1219 | 61413377 | Stephen Shirley | default=False, action="store_true", |
1220 | 50769215 | Stephen Shirley | help="Force the joining of a node")
|
1221 | 61413377 | Stephen Shirley | |
1222 | 771734c9 | Iustin Pop | MC_OPT = cli_option("-C", "--master-candidate", dest="master_candidate", |
1223 | e7b61bb0 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
1224 | 771734c9 | Iustin Pop | help="Set the master_candidate flag on the node")
|
1225 | 771734c9 | Iustin Pop | |
1226 | 771734c9 | Iustin Pop | OFFLINE_OPT = cli_option("-O", "--offline", dest="offline", metavar=_YORNO, |
1227 | e7b61bb0 | Iustin Pop | type="bool", default=None, |
1228 | 34616379 | Michael Hanselmann | help=("Set the offline flag on the node"
|
1229 | 34616379 | Michael Hanselmann | " (cluster does not communicate with offline"
|
1230 | 34616379 | Michael Hanselmann | " nodes)"))
|
1231 | 771734c9 | Iustin Pop | |
1232 | 771734c9 | Iustin Pop | DRAINED_OPT = cli_option("-D", "--drained", dest="drained", metavar=_YORNO, |
1233 | e7b61bb0 | Iustin Pop | type="bool", default=None, |
1234 | 34616379 | Michael Hanselmann | help=("Set the drained flag on the node"
|
1235 | 34616379 | Michael Hanselmann | " (excluded from allocation operations)"))
|
1236 | 771734c9 | Iustin Pop | |
1237 | f91e255a | Iustin Pop | CAPAB_MASTER_OPT = cli_option("--master-capable", dest="master_capable", |
1238 | 5ae4945a | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
1239 | 5ae4945a | Iustin Pop | help="Set the master_capable flag on the node")
|
1240 | f91e255a | Iustin Pop | |
1241 | 53919782 | Iustin Pop | CAPAB_VM_OPT = cli_option("--vm-capable", dest="vm_capable", |
1242 | 5ae4945a | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
1243 | 5ae4945a | Iustin Pop | help="Set the vm_capable flag on the node")
|
1244 | 53919782 | Iustin Pop | |
1245 | e7e09483 | Iustin Pop | ALLOCATABLE_OPT = cli_option("--allocatable", dest="allocatable", |
1246 | e7b61bb0 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
1247 | e7e09483 | Iustin Pop | help="Set the allocatable flag on a volume")
|
1248 | e7e09483 | Iustin Pop | |
1249 | 831040bf | Iustin Pop | NOLVM_STORAGE_OPT = cli_option("--no-lvm-storage", dest="lvm_storage", |
1250 | 831040bf | Iustin Pop | help="Disable support for lvm based instances"
|
1251 | 831040bf | Iustin Pop | " (cluster-wide)",
|
1252 | 831040bf | Iustin Pop | action="store_false", default=True) |
1253 | 831040bf | Iustin Pop | |
1254 | 383a3591 | Iustin Pop | ENABLED_HV_OPT = cli_option("--enabled-hypervisors",
|
1255 | 383a3591 | Iustin Pop | dest="enabled_hypervisors",
|
1256 | 383a3591 | Iustin Pop | help="Comma-separated list of hypervisors",
|
1257 | 383a3591 | Iustin Pop | type="string", default=None) |
1258 | 383a3591 | Iustin Pop | |
1259 | 66af5ec5 | Helga Velroyen | ENABLED_DISK_TEMPLATES_OPT = cli_option("--enabled-disk-templates",
|
1260 | 66af5ec5 | Helga Velroyen | dest="enabled_disk_templates",
|
1261 | 66af5ec5 | Helga Velroyen | help="Comma-separated list of "
|
1262 | 66af5ec5 | Helga Velroyen | "disk templates",
|
1263 | 66af5ec5 | Helga Velroyen | type="string", default=None) |
1264 | 66af5ec5 | Helga Velroyen | |
1265 | 4fbc93dd | Iustin Pop | NIC_PARAMS_OPT = cli_option("-N", "--nic-parameters", dest="nicparams", |
1266 | 4fbc93dd | Iustin Pop | type="keyval", default={},
|
1267 | 4fbc93dd | Iustin Pop | help="NIC parameters")
|
1268 | 4fbc93dd | Iustin Pop | |
1269 | e32df528 | Iustin Pop | CP_SIZE_OPT = cli_option("-C", "--candidate-pool-size", default=None, |
1270 | e32df528 | Iustin Pop | dest="candidate_pool_size", type="int", |
1271 | e32df528 | Iustin Pop | help="Set the candidate pool size")
|
1272 | e32df528 | Iustin Pop | |
1273 | 04367e70 | Guido Trotter | VG_NAME_OPT = cli_option("--vg-name", dest="vg_name", |
1274 | 34616379 | Michael Hanselmann | help=("Enables LVM and specifies the volume group"
|
1275 | 34616379 | Michael Hanselmann | " name (cluster-wide) for disk allocation"
|
1276 | 34616379 | Michael Hanselmann | " [%s]" % constants.DEFAULT_VG),
|
1277 | b58726e8 | Iustin Pop | metavar="VG", default=None) |
1278 | b58726e8 | Iustin Pop | |
1279 | a3ac3243 | Iustin Pop | YES_DOIT_OPT = cli_option("--yes-do-it", "--ya-rly", dest="yes_do_it", |
1280 | 1f587d3d | Iustin Pop | help="Destroy cluster", action="store_true") |
1281 | b58726e8 | Iustin Pop | |
1282 | 58371861 | Iustin Pop | NOVOTING_OPT = cli_option("--no-voting", dest="no_voting", |
1283 | 58371861 | Iustin Pop | help="Skip node agreement check (dangerous)",
|
1284 | 58371861 | Iustin Pop | action="store_true", default=False) |
1285 | 58371861 | Iustin Pop | |
1286 | e3646f22 | Iustin Pop | MAC_PREFIX_OPT = cli_option("-m", "--mac-prefix", dest="mac_prefix", |
1287 | e3646f22 | Iustin Pop | help="Specify the mac prefix for the instance IP"
|
1288 | e3646f22 | Iustin Pop | " addresses, in the format XX:XX:XX",
|
1289 | e3646f22 | Iustin Pop | metavar="PREFIX",
|
1290 | e3646f22 | Iustin Pop | default=None)
|
1291 | e3646f22 | Iustin Pop | |
1292 | 29392516 | Iustin Pop | MASTER_NETDEV_OPT = cli_option("--master-netdev", dest="master_netdev", |
1293 | 29392516 | Iustin Pop | help="Specify the node interface (cluster-wide)"
|
1294 | 25be0c75 | Guido Trotter | " on which the master IP address will be added"
|
1295 | 25be0c75 | Guido Trotter | " (cluster init default: %s)" %
|
1296 | 25be0c75 | Guido Trotter | constants.DEFAULT_BRIDGE, |
1297 | 29392516 | Iustin Pop | metavar="NETDEV",
|
1298 | 25be0c75 | Guido Trotter | default=None)
|
1299 | 29392516 | Iustin Pop | |
1300 | 5a8648eb | Andrea Spadaccini | MASTER_NETMASK_OPT = cli_option("--master-netmask", dest="master_netmask", |
1301 | 5a8648eb | Andrea Spadaccini | help="Specify the netmask of the master IP",
|
1302 | 5a8648eb | Andrea Spadaccini | metavar="NETMASK",
|
1303 | 5a8648eb | Andrea Spadaccini | default=None)
|
1304 | 5a8648eb | Andrea Spadaccini | |
1305 | bf689b7a | Andrea Spadaccini | USE_EXTERNAL_MIP_SCRIPT = cli_option("--use-external-mip-script",
|
1306 | 5ae4945a | Iustin Pop | dest="use_external_mip_script",
|
1307 | 5ae4945a | Iustin Pop | help="Specify whether to run a"
|
1308 | 5ae4945a | Iustin Pop | " user-provided script for the master"
|
1309 | 5ae4945a | Iustin Pop | " IP address turnup and"
|
1310 | 5ae4945a | Iustin Pop | " turndown operations",
|
1311 | 5ae4945a | Iustin Pop | type="bool", metavar=_YORNO, default=None) |
1312 | bf689b7a | Andrea Spadaccini | |
1313 | 29392516 | Iustin Pop | GLOBAL_FILEDIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir", |
1314 | 29392516 | Iustin Pop | help="Specify the default directory (cluster-"
|
1315 | 29392516 | Iustin Pop | "wide) for storing the file-based disks [%s]" %
|
1316 | ee4a14c0 | Michael Hanselmann | pathutils.DEFAULT_FILE_STORAGE_DIR, |
1317 | 29392516 | Iustin Pop | metavar="DIR",
|
1318 | 3039e2dc | Helga Velroyen | default=None)
|
1319 | 4b97f902 | Apollon Oikonomopoulos | |
1320 | 5ae4945a | Iustin Pop | GLOBAL_SHARED_FILEDIR_OPT = cli_option( |
1321 | 5ae4945a | Iustin Pop | "--shared-file-storage-dir",
|
1322 | 5ae4945a | Iustin Pop | dest="shared_file_storage_dir",
|
1323 | 5ae4945a | Iustin Pop | help="Specify the default directory (cluster-wide) for storing the"
|
1324 | 5ae4945a | Iustin Pop | " shared file-based disks [%s]" %
|
1325 | ee4a14c0 | Michael Hanselmann | pathutils.DEFAULT_SHARED_FILE_STORAGE_DIR, |
1326 | 4e6cfd11 | Helga Velroyen | metavar="SHAREDDIR", default=None) |
1327 | 29392516 | Iustin Pop | |
1328 | 29392516 | Iustin Pop | NOMODIFY_ETCHOSTS_OPT = cli_option("--no-etc-hosts", dest="modify_etc_hosts", |
1329 | 72043dac | Michael Hanselmann | help="Don't modify %s" % pathutils.ETC_HOSTS,
|
1330 | 29392516 | Iustin Pop | action="store_false", default=True) |
1331 | 29392516 | Iustin Pop | |
1332 | c89db623 | Michele Tartara | MODIFY_ETCHOSTS_OPT = \ |
1333 | c89db623 | Michele Tartara | cli_option("--modify-etc-hosts", dest="modify_etc_hosts", metavar=_YORNO, |
1334 | c89db623 | Michele Tartara | default=None, type="bool", |
1335 | c89db623 | Michele Tartara | help="Defines whether the cluster should autonomously modify"
|
1336 | c89db623 | Michele Tartara | " and keep in sync the /etc/hosts file of the nodes")
|
1337 | c89db623 | Michele Tartara | |
1338 | b989b9d9 | Ken Wehr | NOMODIFY_SSH_SETUP_OPT = cli_option("--no-ssh-init", dest="modify_ssh_setup", |
1339 | b989b9d9 | Ken Wehr | help="Don't initialize SSH keys",
|
1340 | b989b9d9 | Ken Wehr | action="store_false", default=True) |
1341 | b989b9d9 | Ken Wehr | |
1342 | 14e9e7f3 | Iustin Pop | ERROR_CODES_OPT = cli_option("--error-codes", dest="error_codes", |
1343 | 14e9e7f3 | Iustin Pop | help="Enable parseable error messages",
|
1344 | 14e9e7f3 | Iustin Pop | action="store_true", default=False) |
1345 | 14e9e7f3 | Iustin Pop | |
1346 | 14e9e7f3 | Iustin Pop | NONPLUS1_OPT = cli_option("--no-nplus1-mem", dest="skip_nplusone_mem", |
1347 | 14e9e7f3 | Iustin Pop | help="Skip N+1 memory redundancy tests",
|
1348 | 14e9e7f3 | Iustin Pop | action="store_true", default=False) |
1349 | 14e9e7f3 | Iustin Pop | |
1350 | 12054861 | Iustin Pop | REBOOT_TYPE_OPT = cli_option("-t", "--type", dest="reboot_type", |
1351 | 12054861 | Iustin Pop | help="Type of reboot: soft/hard/full",
|
1352 | 12054861 | Iustin Pop | default=constants.INSTANCE_REBOOT_HARD, |
1353 | 12054861 | Iustin Pop | metavar="<REBOOT>",
|
1354 | 12054861 | Iustin Pop | choices=list(constants.REBOOT_TYPES))
|
1355 | 12054861 | Iustin Pop | |
1356 | ee3f9578 | Iustin Pop | IGNORE_SECONDARIES_OPT = cli_option("--ignore-secondaries",
|
1357 | ee3f9578 | Iustin Pop | dest="ignore_secondaries",
|
1358 | ee3f9578 | Iustin Pop | default=False, action="store_true", |
1359 | ee3f9578 | Iustin Pop | help="Ignore errors from secondaries")
|
1360 | ee3f9578 | Iustin Pop | |
1361 | 69b99987 | Michael Hanselmann | NOSHUTDOWN_OPT = cli_option("--noshutdown", dest="shutdown", |
1362 | 44c44832 | Iustin Pop | action="store_false", default=True, |
1363 | 44c44832 | Iustin Pop | help="Don't shutdown the instance (unsafe)")
|
1364 | 44c44832 | Iustin Pop | |
1365 | b5762e2a | Guido Trotter | TIMEOUT_OPT = cli_option("--timeout", dest="timeout", type="int", |
1366 | b5762e2a | Guido Trotter | default=constants.DEFAULT_SHUTDOWN_TIMEOUT, |
1367 | b5762e2a | Guido Trotter | help="Maximum time to wait")
|
1368 | 44c44832 | Iustin Pop | |
1369 | 4d98c565 | Guido Trotter | SHUTDOWN_TIMEOUT_OPT = cli_option("--shutdown-timeout",
|
1370 | 5ae4945a | Iustin Pop | dest="shutdown_timeout", type="int", |
1371 | 5ae4945a | Iustin Pop | default=constants.DEFAULT_SHUTDOWN_TIMEOUT, |
1372 | 5ae4945a | Iustin Pop | help="Maximum time to wait for instance"
|
1373 | 5ae4945a | Iustin Pop | " shutdown")
|
1374 | 7e5eaaa8 | Guido Trotter | |
1375 | 19b9ba9a | Michael Hanselmann | INTERVAL_OPT = cli_option("--interval", dest="interval", type="int", |
1376 | 19b9ba9a | Michael Hanselmann | default=None,
|
1377 | 19b9ba9a | Michael Hanselmann | help=("Number of seconds between repetions of the"
|
1378 | 19b9ba9a | Michael Hanselmann | " command"))
|
1379 | 19b9ba9a | Michael Hanselmann | |
1380 | 7ea7bcf6 | Iustin Pop | EARLY_RELEASE_OPT = cli_option("--early-release",
|
1381 | 7ea7bcf6 | Iustin Pop | dest="early_release", default=False, |
1382 | 7ea7bcf6 | Iustin Pop | action="store_true",
|
1383 | 7ea7bcf6 | Iustin Pop | help="Release the locks on the secondary"
|
1384 | 7ea7bcf6 | Iustin Pop | " node(s) early")
|
1385 | 7ea7bcf6 | Iustin Pop | |
1386 | 6d4a1656 | Michael Hanselmann | NEW_CLUSTER_CERT_OPT = cli_option("--new-cluster-certificate",
|
1387 | 6d4a1656 | Michael Hanselmann | dest="new_cluster_cert",
|
1388 | 6d4a1656 | Michael Hanselmann | default=False, action="store_true", |
1389 | 6d4a1656 | Michael Hanselmann | help="Generate a new cluster certificate")
|
1390 | 6d4a1656 | Michael Hanselmann | |
1391 | 6d4a1656 | Michael Hanselmann | RAPI_CERT_OPT = cli_option("--rapi-certificate", dest="rapi_cert", |
1392 | 6d4a1656 | Michael Hanselmann | default=None,
|
1393 | 6d4a1656 | Michael Hanselmann | help="File containing new RAPI certificate")
|
1394 | 6d4a1656 | Michael Hanselmann | |
1395 | 6d4a1656 | Michael Hanselmann | NEW_RAPI_CERT_OPT = cli_option("--new-rapi-certificate", dest="new_rapi_cert", |
1396 | 6d4a1656 | Michael Hanselmann | default=None, action="store_true", |
1397 | 6d4a1656 | Michael Hanselmann | help=("Generate a new self-signed RAPI"
|
1398 | 6d4a1656 | Michael Hanselmann | " certificate"))
|
1399 | 6d4a1656 | Michael Hanselmann | |
1400 | b6267745 | Andrea Spadaccini | SPICE_CERT_OPT = cli_option("--spice-certificate", dest="spice_cert", |
1401 | 5ae4945a | Iustin Pop | default=None,
|
1402 | 5ae4945a | Iustin Pop | help="File containing new SPICE certificate")
|
1403 | b6267745 | Andrea Spadaccini | |
1404 | b6267745 | Andrea Spadaccini | SPICE_CACERT_OPT = cli_option("--spice-ca-certificate", dest="spice_cacert", |
1405 | 5ae4945a | Iustin Pop | default=None,
|
1406 | 5ae4945a | Iustin Pop | help="File containing the certificate of the CA"
|
1407 | 5ae4945a | Iustin Pop | " which signed the SPICE certificate")
|
1408 | b6267745 | Andrea Spadaccini | |
1409 | b6267745 | Andrea Spadaccini | NEW_SPICE_CERT_OPT = cli_option("--new-spice-certificate",
|
1410 | 5ae4945a | Iustin Pop | dest="new_spice_cert", default=None, |
1411 | 5ae4945a | Iustin Pop | action="store_true",
|
1412 | 5ae4945a | Iustin Pop | help=("Generate a new self-signed SPICE"
|
1413 | 5ae4945a | Iustin Pop | " certificate"))
|
1414 | b6267745 | Andrea Spadaccini | |
1415 | 6b7d5878 | Michael Hanselmann | NEW_CONFD_HMAC_KEY_OPT = cli_option("--new-confd-hmac-key",
|
1416 | 6b7d5878 | Michael Hanselmann | dest="new_confd_hmac_key",
|
1417 | 6b7d5878 | Michael Hanselmann | default=False, action="store_true", |
1418 | 6b7d5878 | Michael Hanselmann | help=("Create a new HMAC key for %s" %
|
1419 | 6b7d5878 | Michael Hanselmann | constants.CONFD)) |
1420 | 6d4a1656 | Michael Hanselmann | |
1421 | 3db3eb2a | Michael Hanselmann | CLUSTER_DOMAIN_SECRET_OPT = cli_option("--cluster-domain-secret",
|
1422 | 3db3eb2a | Michael Hanselmann | dest="cluster_domain_secret",
|
1423 | 3db3eb2a | Michael Hanselmann | default=None,
|
1424 | 3db3eb2a | Michael Hanselmann | help=("Load new new cluster domain"
|
1425 | 3db3eb2a | Michael Hanselmann | " secret from file"))
|
1426 | 3db3eb2a | Michael Hanselmann | |
1427 | 3db3eb2a | Michael Hanselmann | NEW_CLUSTER_DOMAIN_SECRET_OPT = cli_option("--new-cluster-domain-secret",
|
1428 | 3db3eb2a | Michael Hanselmann | dest="new_cluster_domain_secret",
|
1429 | 3db3eb2a | Michael Hanselmann | default=False, action="store_true", |
1430 | 3db3eb2a | Michael Hanselmann | help=("Create a new cluster domain"
|
1431 | 3db3eb2a | Michael Hanselmann | " secret"))
|
1432 | 3db3eb2a | Michael Hanselmann | |
1433 | 74adc100 | Iustin Pop | USE_REPL_NET_OPT = cli_option("--use-replication-network",
|
1434 | 74adc100 | Iustin Pop | dest="use_replication_network",
|
1435 | 74adc100 | Iustin Pop | help="Whether to use the replication network"
|
1436 | 74adc100 | Iustin Pop | " for talking to the nodes",
|
1437 | 74adc100 | Iustin Pop | action="store_true", default=False) |
1438 | 74adc100 | Iustin Pop | |
1439 | 3953242f | Iustin Pop | MAINTAIN_NODE_HEALTH_OPT = \ |
1440 | 3953242f | Iustin Pop | cli_option("--maintain-node-health", dest="maintain_node_health", |
1441 | 3953242f | Iustin Pop | metavar=_YORNO, default=None, type="bool", |
1442 | 3953242f | Iustin Pop | help="Configure the cluster to automatically maintain node"
|
1443 | 3953242f | Iustin Pop | " health, by shutting down unknown instances, shutting down"
|
1444 | 3953242f | Iustin Pop | " unknown DRBD devices, etc.")
|
1445 | 3953242f | Iustin Pop | |
1446 | e588764d | Iustin Pop | IDENTIFY_DEFAULTS_OPT = \ |
1447 | e588764d | Iustin Pop | cli_option("--identify-defaults", dest="identify_defaults", |
1448 | e588764d | Iustin Pop | default=False, action="store_true", |
1449 | e588764d | Iustin Pop | help="Identify which saved instance parameters are equal to"
|
1450 | e588764d | Iustin Pop | " the current cluster defaults and set them as such, instead"
|
1451 | e588764d | Iustin Pop | " of marking them as overridden")
|
1452 | e588764d | Iustin Pop | |
1453 | 1338f2b4 | Balazs Lecz | UIDPOOL_OPT = cli_option("--uid-pool", default=None, |
1454 | 1338f2b4 | Balazs Lecz | action="store", dest="uid_pool", |
1455 | 1338f2b4 | Balazs Lecz | help=("A list of user-ids or user-id"
|
1456 | 1338f2b4 | Balazs Lecz | " ranges separated by commas"))
|
1457 | 1338f2b4 | Balazs Lecz | |
1458 | fdad8c4d | Balazs Lecz | ADD_UIDS_OPT = cli_option("--add-uids", default=None, |
1459 | fdad8c4d | Balazs Lecz | action="store", dest="add_uids", |
1460 | fdad8c4d | Balazs Lecz | help=("A list of user-ids or user-id"
|
1461 | fdad8c4d | Balazs Lecz | " ranges separated by commas, to be"
|
1462 | fdad8c4d | Balazs Lecz | " added to the user-id pool"))
|
1463 | fdad8c4d | Balazs Lecz | |
1464 | fdad8c4d | Balazs Lecz | REMOVE_UIDS_OPT = cli_option("--remove-uids", default=None, |
1465 | fdad8c4d | Balazs Lecz | action="store", dest="remove_uids", |
1466 | fdad8c4d | Balazs Lecz | help=("A list of user-ids or user-id"
|
1467 | fdad8c4d | Balazs Lecz | " ranges separated by commas, to be"
|
1468 | fdad8c4d | Balazs Lecz | " removed from the user-id pool"))
|
1469 | fdad8c4d | Balazs Lecz | |
1470 | f38ea602 | Iustin Pop | RESERVED_LVS_OPT = cli_option("--reserved-lvs", default=None, |
1471 | 5ae4945a | Iustin Pop | action="store", dest="reserved_lvs", |
1472 | 5ae4945a | Iustin Pop | help=("A comma-separated list of reserved"
|
1473 | 5ae4945a | Iustin Pop | " logical volumes names, that will be"
|
1474 | 5ae4945a | Iustin Pop | " ignored by cluster verify"))
|
1475 | f38ea602 | Iustin Pop | |
1476 | 31d97b2a | Guido Trotter | ROMAN_OPT = cli_option("--roman",
|
1477 | 31d97b2a | Guido Trotter | dest="roman_integers", default=False, |
1478 | 31d97b2a | Guido Trotter | action="store_true",
|
1479 | 31d97b2a | Guido Trotter | help="Use roman numbers for positive integers")
|
1480 | 31d97b2a | Guido Trotter | |
1481 | 26591bfd | Luca Bigliardi | DRBD_HELPER_OPT = cli_option("--drbd-usermode-helper", dest="drbd_helper", |
1482 | 26591bfd | Luca Bigliardi | action="store", default=None, |
1483 | 26591bfd | Luca Bigliardi | help="Specifies usermode helper for DRBD")
|
1484 | 26591bfd | Luca Bigliardi | |
1485 | e7323b5e | Manuel Franceschini | PRIMARY_IP_VERSION_OPT = \ |
1486 | e7323b5e | Manuel Franceschini | cli_option("--primary-ip-version", default=constants.IP4_VERSION,
|
1487 | e7323b5e | Manuel Franceschini | action="store", dest="primary_ip_version", |
1488 | e7323b5e | Manuel Franceschini | metavar="%d|%d" % (constants.IP4_VERSION,
|
1489 | e7323b5e | Manuel Franceschini | constants.IP6_VERSION), |
1490 | e7323b5e | Manuel Franceschini | help="Cluster-wide IP version for primary IP")
|
1491 | e7323b5e | Manuel Franceschini | |
1492 | f92ed8ab | Michael Hanselmann | SHOW_MACHINE_OPT = cli_option("-M", "--show-machine-names", default=False, |
1493 | f92ed8ab | Michael Hanselmann | action="store_true",
|
1494 | f92ed8ab | Michael Hanselmann | help="Show machine name for every line in output")
|
1495 | f92ed8ab | Michael Hanselmann | |
1496 | d5b031dc | Michael Hanselmann | FAILURE_ONLY_OPT = cli_option("--failure-only", default=False, |
1497 | d5b031dc | Michael Hanselmann | action="store_true",
|
1498 | d5b031dc | Michael Hanselmann | help=("Hide successful results and show failures"
|
1499 | d5b031dc | Michael Hanselmann | " only (determined by the exit code)"))
|
1500 | d5b031dc | Michael Hanselmann | |
1501 | a59d5fa1 | Michele Tartara | REASON_OPT = cli_option("--reason", default=None, |
1502 | aa922d64 | Michele Tartara | help="The reason for executing the command")
|
1503 | a59d5fa1 | Michele Tartara | |
1504 | 552328b8 | Michael Hanselmann | |
1505 | 552328b8 | Michael Hanselmann | def _PriorityOptionCb(option, _, value, parser): |
1506 | 552328b8 | Michael Hanselmann | """Callback for processing C{--priority} option.
|
1507 | 552328b8 | Michael Hanselmann |
|
1508 | 552328b8 | Michael Hanselmann | """
|
1509 | 552328b8 | Michael Hanselmann | value = _PRIONAME_TO_VALUE[value] |
1510 | 552328b8 | Michael Hanselmann | |
1511 | 552328b8 | Michael Hanselmann | setattr(parser.values, option.dest, value)
|
1512 | 552328b8 | Michael Hanselmann | |
1513 | 552328b8 | Michael Hanselmann | |
1514 | 84a5b33c | Michael Hanselmann | PRIORITY_OPT = cli_option("--priority", default=None, dest="priority", |
1515 | 84a5b33c | Michael Hanselmann | metavar="|".join(name for name, _ in _PRIORITY_NAMES), |
1516 | 84a5b33c | Michael Hanselmann | choices=_PRIONAME_TO_VALUE.keys(), |
1517 | 552328b8 | Michael Hanselmann | action="callback", type="choice", |
1518 | 552328b8 | Michael Hanselmann | callback=_PriorityOptionCb, |
1519 | aa06f8c6 | Michael Hanselmann | help="Priority for opcode processing")
|
1520 | 84a5b33c | Michael Hanselmann | |
1521 | 61a14bb3 | Iustin Pop | HID_OS_OPT = cli_option("--hidden", dest="hidden", |
1522 | 61a14bb3 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
1523 | 61a14bb3 | Iustin Pop | help="Sets the hidden flag on the OS")
|
1524 | 61a14bb3 | Iustin Pop | |
1525 | 61a14bb3 | Iustin Pop | BLK_OS_OPT = cli_option("--blacklisted", dest="blacklisted", |
1526 | 61a14bb3 | Iustin Pop | type="bool", default=None, metavar=_YORNO, |
1527 | 61a14bb3 | Iustin Pop | help="Sets the blacklisted flag on the OS")
|
1528 | 61a14bb3 | Iustin Pop | |
1529 | b883637f | René Nussbaumer | PREALLOC_WIPE_DISKS_OPT = cli_option("--prealloc-wipe-disks", default=None, |
1530 | b883637f | René Nussbaumer | type="bool", metavar=_YORNO,
|
1531 | b883637f | René Nussbaumer | dest="prealloc_wipe_disks",
|
1532 | b883637f | René Nussbaumer | help=("Wipe disks prior to instance"
|
1533 | b883637f | René Nussbaumer | " creation"))
|
1534 | b883637f | René Nussbaumer | |
1535 | a535cef7 | René Nussbaumer | NODE_PARAMS_OPT = cli_option("--node-parameters", dest="ndparams", |
1536 | 3c2b6a98 | René Nussbaumer | type="keyval", default=None, |
1537 | a535cef7 | René Nussbaumer | help="Node parameters")
|
1538 | a535cef7 | René Nussbaumer | |
1539 | 90e99856 | Adeodato Simo | ALLOC_POLICY_OPT = cli_option("--alloc-policy", dest="alloc_policy", |
1540 | 90e99856 | Adeodato Simo | action="store", metavar="POLICY", default=None, |
1541 | 90e99856 | Adeodato Simo | help="Allocation policy for the node group")
|
1542 | 90e99856 | Adeodato Simo | |
1543 | d2881c71 | René Nussbaumer | NODE_POWERED_OPT = cli_option("--node-powered", default=None, |
1544 | d2881c71 | René Nussbaumer | type="bool", metavar=_YORNO,
|
1545 | d2881c71 | René Nussbaumer | dest="node_powered",
|
1546 | d2881c71 | René Nussbaumer | help="Specify if the SoR for node is powered")
|
1547 | d2881c71 | René Nussbaumer | |
1548 | 41543d8b | René Nussbaumer | OOB_TIMEOUT_OPT = cli_option("--oob-timeout", dest="oob_timeout", type="int", |
1549 | 5ae4945a | Iustin Pop | default=constants.OOB_TIMEOUT, |
1550 | 5ae4945a | Iustin Pop | help="Maximum time to wait for out-of-band helper")
|
1551 | 41543d8b | René Nussbaumer | |
1552 | 0c086a13 | René Nussbaumer | POWER_DELAY_OPT = cli_option("--power-delay", dest="power_delay", type="float", |
1553 | 0c086a13 | René Nussbaumer | default=constants.OOB_POWER_DELAY, |
1554 | 0c086a13 | René Nussbaumer | help="Time in seconds to wait between power-ons")
|
1555 | 0c086a13 | René Nussbaumer | |
1556 | 442587bf | Michael Hanselmann | FORCE_FILTER_OPT = cli_option("-F", "--filter", dest="force_filter", |
1557 | 442587bf | Michael Hanselmann | action="store_true", default=False, |
1558 | 442587bf | Michael Hanselmann | help=("Whether command argument should be treated"
|
1559 | 442587bf | Michael Hanselmann | " as filter"))
|
1560 | 442587bf | Michael Hanselmann | |
1561 | 885a0fc4 | Iustin Pop | NO_REMEMBER_OPT = cli_option("--no-remember",
|
1562 | 885a0fc4 | Iustin Pop | dest="no_remember",
|
1563 | 885a0fc4 | Iustin Pop | action="store_true", default=False, |
1564 | 885a0fc4 | Iustin Pop | help="Perform but do not record the change"
|
1565 | 885a0fc4 | Iustin Pop | " in the configuration")
|
1566 | 885a0fc4 | Iustin Pop | |
1567 | aafee533 | Michael Hanselmann | PRIMARY_ONLY_OPT = cli_option("-p", "--primary-only", |
1568 | aafee533 | Michael Hanselmann | default=False, action="store_true", |
1569 | aafee533 | Michael Hanselmann | help="Evacuate primary instances only")
|
1570 | aafee533 | Michael Hanselmann | |
1571 | aafee533 | Michael Hanselmann | SECONDARY_ONLY_OPT = cli_option("-s", "--secondary-only", |
1572 | aafee533 | Michael Hanselmann | default=False, action="store_true", |
1573 | aafee533 | Michael Hanselmann | help="Evacuate secondary instances only"
|
1574 | aafee533 | Michael Hanselmann | " (applies only to internally mirrored"
|
1575 | aafee533 | Michael Hanselmann | " disk templates, e.g. %s)" %
|
1576 | aafee533 | Michael Hanselmann | utils.CommaJoin(constants.DTS_INT_MIRROR)) |
1577 | aafee533 | Michael Hanselmann | |
1578 | 323f9095 | Stephen Shirley | STARTUP_PAUSED_OPT = cli_option("--paused", dest="startup_paused", |
1579 | 323f9095 | Stephen Shirley | action="store_true", default=False, |
1580 | 323f9095 | Stephen Shirley | help="Pause instance at startup")
|
1581 | 323f9095 | Stephen Shirley | |
1582 | f6eb380d | Michael Hanselmann | TO_GROUP_OPT = cli_option("--to", dest="to", metavar="<group>", |
1583 | f6eb380d | Michael Hanselmann | help="Destination node group (name or uuid)",
|
1584 | f6eb380d | Michael Hanselmann | default=None, action="append", |
1585 | f6eb380d | Michael Hanselmann | completion_suggest=OPT_COMPL_ONE_NODEGROUP) |
1586 | f6eb380d | Michael Hanselmann | |
1587 | 93f2399e | Andrea Spadaccini | IGNORE_ERRORS_OPT = cli_option("-I", "--ignore-errors", default=[], |
1588 | 93f2399e | Andrea Spadaccini | action="append", dest="ignore_errors", |
1589 | 93f2399e | Andrea Spadaccini | choices=list(constants.CV_ALL_ECODES_STRINGS),
|
1590 | 93f2399e | Andrea Spadaccini | help="Error code to be ignored")
|
1591 | 93f2399e | Andrea Spadaccini | |
1592 | 38f29a36 | René Nussbaumer | DISK_STATE_OPT = cli_option("--disk-state", default=[], dest="disk_state", |
1593 | 38f29a36 | René Nussbaumer | action="append",
|
1594 | a1cef552 | Iustin Pop | help=("Specify disk state information in the"
|
1595 | a1cef552 | Iustin Pop | " format"
|
1596 | a1cef552 | Iustin Pop | " storage_type/identifier:option=value,...;"
|
1597 | a1cef552 | Iustin Pop | " note this is unused for now"),
|
1598 | 38f29a36 | René Nussbaumer | type="identkeyval")
|
1599 | 38f29a36 | René Nussbaumer | |
1600 | 38f29a36 | René Nussbaumer | HV_STATE_OPT = cli_option("--hypervisor-state", default=[], dest="hv_state", |
1601 | 38f29a36 | René Nussbaumer | action="append",
|
1602 | 38f29a36 | René Nussbaumer | help=("Specify hypervisor state information in the"
|
1603 | a1cef552 | Iustin Pop | " format hypervisor:option=value,...;"
|
1604 | a1cef552 | Iustin Pop | " note this is unused for now"),
|
1605 | 38f29a36 | René Nussbaumer | type="identkeyval")
|
1606 | 38f29a36 | René Nussbaumer | |
1607 | b6aaf437 | René Nussbaumer | IGNORE_IPOLICY_OPT = cli_option("--ignore-ipolicy", dest="ignore_ipolicy", |
1608 | b6aaf437 | René Nussbaumer | action="store_true", default=False, |
1609 | b6aaf437 | René Nussbaumer | help="Ignore instance policy violations")
|
1610 | b6aaf437 | René Nussbaumer | |
1611 | 2c0af7da | Guido Trotter | RUNTIME_MEM_OPT = cli_option("-m", "--runtime-memory", dest="runtime_mem", |
1612 | 2c0af7da | Guido Trotter | help="Sets the instance's runtime memory,"
|
1613 | 2c0af7da | Guido Trotter | " ballooning it up or down to the new value",
|
1614 | 2c0af7da | Guido Trotter | default=None, type="unit", metavar="<size>") |
1615 | 61a14bb3 | Iustin Pop | |
1616 | ef8270dc | Iustin Pop | ABSOLUTE_OPT = cli_option("--absolute", dest="absolute", |
1617 | ef8270dc | Iustin Pop | action="store_true", default=False, |
1618 | ef8270dc | Iustin Pop | help="Marks the grow as absolute instead of the"
|
1619 | ef8270dc | Iustin Pop | " (default) relative mode")
|
1620 | ef8270dc | Iustin Pop | |
1621 | 9c784fb3 | Dimitris Aragiorgis | NETWORK_OPT = cli_option("--network",
|
1622 | 9c784fb3 | Dimitris Aragiorgis | action="store", default=None, dest="network", |
1623 | 9c784fb3 | Dimitris Aragiorgis | help="IP network in CIDR notation")
|
1624 | 9c784fb3 | Dimitris Aragiorgis | |
1625 | 9c784fb3 | Dimitris Aragiorgis | GATEWAY_OPT = cli_option("--gateway",
|
1626 | 9c784fb3 | Dimitris Aragiorgis | action="store", default=None, dest="gateway", |
1627 | 9c784fb3 | Dimitris Aragiorgis | help="IP address of the router (gateway)")
|
1628 | 9c784fb3 | Dimitris Aragiorgis | |
1629 | 9c784fb3 | Dimitris Aragiorgis | ADD_RESERVED_IPS_OPT = cli_option("--add-reserved-ips",
|
1630 | 9c784fb3 | Dimitris Aragiorgis | action="store", default=None, |
1631 | 9c784fb3 | Dimitris Aragiorgis | dest="add_reserved_ips",
|
1632 | 9c784fb3 | Dimitris Aragiorgis | help="Comma-separated list of"
|
1633 | 9c784fb3 | Dimitris Aragiorgis | " reserved IPs to add")
|
1634 | 9c784fb3 | Dimitris Aragiorgis | |
1635 | 9c784fb3 | Dimitris Aragiorgis | REMOVE_RESERVED_IPS_OPT = cli_option("--remove-reserved-ips",
|
1636 | 9c784fb3 | Dimitris Aragiorgis | action="store", default=None, |
1637 | 9c784fb3 | Dimitris Aragiorgis | dest="remove_reserved_ips",
|
1638 | 9c784fb3 | Dimitris Aragiorgis | help="Comma-delimited list of"
|
1639 | 9c784fb3 | Dimitris Aragiorgis | " reserved IPs to remove")
|
1640 | 9c784fb3 | Dimitris Aragiorgis | |
1641 | 9c784fb3 | Dimitris Aragiorgis | NETWORK6_OPT = cli_option("--network6",
|
1642 | 9c784fb3 | Dimitris Aragiorgis | action="store", default=None, dest="network6", |
1643 | 9c784fb3 | Dimitris Aragiorgis | help="IP network in CIDR notation")
|
1644 | 9c784fb3 | Dimitris Aragiorgis | |
1645 | 9c784fb3 | Dimitris Aragiorgis | GATEWAY6_OPT = cli_option("--gateway6",
|
1646 | 9c784fb3 | Dimitris Aragiorgis | action="store", default=None, dest="gateway6", |
1647 | 9c784fb3 | Dimitris Aragiorgis | help="IP6 address of the router (gateway)")
|
1648 | 9c784fb3 | Dimitris Aragiorgis | |
1649 | 9c784fb3 | Dimitris Aragiorgis | NOCONFLICTSCHECK_OPT = cli_option("--no-conflicts-check",
|
1650 | 9c784fb3 | Dimitris Aragiorgis | dest="conflicts_check",
|
1651 | 9c784fb3 | Dimitris Aragiorgis | default=True,
|
1652 | 9c784fb3 | Dimitris Aragiorgis | action="store_false",
|
1653 | 9c784fb3 | Dimitris Aragiorgis | help="Don't check for conflicting IPs")
|
1654 | 9c784fb3 | Dimitris Aragiorgis | |
1655 | ea9d3b40 | Bernardo Dal Seno | INCLUDEDEFAULTS_OPT = cli_option("--include-defaults", dest="include_defaults", |
1656 | ea9d3b40 | Bernardo Dal Seno | default=False, action="store_true", |
1657 | ea9d3b40 | Bernardo Dal Seno | help="Include default values")
|
1658 | ea9d3b40 | Bernardo Dal Seno | |
1659 | df58ca1c | Dimitris Aragiorgis | HOTPLUG_OPT = cli_option("--hotplug", dest="hotplug", |
1660 | df58ca1c | Dimitris Aragiorgis | action="store_true", default=False, |
1661 | e15a00dc | Dimitris Aragiorgis | help="Hotplug supported devices (NICs and Disks)")
|
1662 | df58ca1c | Dimitris Aragiorgis | |
1663 | 96ed3a3e | Dimitris Aragiorgis | HOTPLUG_IF_POSSIBLE_OPT = cli_option("--hotplug-if-possible",
|
1664 | 96ed3a3e | Dimitris Aragiorgis | dest="hotplug_if_possible",
|
1665 | 96ed3a3e | Dimitris Aragiorgis | action="store_true", default=False, |
1666 | 96ed3a3e | Dimitris Aragiorgis | help="Hotplug devices in case"
|
1667 | 96ed3a3e | Dimitris Aragiorgis | " hotplug is supported")
|
1668 | 96ed3a3e | Dimitris Aragiorgis | |
1669 | 5786c087 | Michael Hanselmann | #: Options provided by all commands
|
1670 | aa4fff02 | Michele Tartara | COMMON_OPTS = [DEBUG_OPT, REASON_OPT] |
1671 | 5786c087 | Michael Hanselmann | |
1672 | d6cd74dd | Klaus Aehlig | # options related to asynchronous job handling
|
1673 | d6cd74dd | Klaus Aehlig | |
1674 | d6cd74dd | Klaus Aehlig | SUBMIT_OPTS = [ |
1675 | d6cd74dd | Klaus Aehlig | SUBMIT_OPT, |
1676 | d6cd74dd | Klaus Aehlig | PRINT_JOBID_OPT, |
1677 | d6cd74dd | Klaus Aehlig | ] |
1678 | d6cd74dd | Klaus Aehlig | |
1679 | eb28ecf6 | Guido Trotter | # common options for creating instances. add and import then add their own
|
1680 | eb28ecf6 | Guido Trotter | # specific ones.
|
1681 | eb28ecf6 | Guido Trotter | COMMON_CREATE_OPTS = [ |
1682 | eb28ecf6 | Guido Trotter | BACKEND_OPT, |
1683 | eb28ecf6 | Guido Trotter | DISK_OPT, |
1684 | eb28ecf6 | Guido Trotter | DISK_TEMPLATE_OPT, |
1685 | eb28ecf6 | Guido Trotter | FILESTORE_DIR_OPT, |
1686 | eb28ecf6 | Guido Trotter | FILESTORE_DRIVER_OPT, |
1687 | eb28ecf6 | Guido Trotter | HYPERVISOR_OPT, |
1688 | eb28ecf6 | Guido Trotter | IALLOCATOR_OPT, |
1689 | eb28ecf6 | Guido Trotter | NET_OPT, |
1690 | eb28ecf6 | Guido Trotter | NODE_PLACEMENT_OPT, |
1691 | eb28ecf6 | Guido Trotter | NOIPCHECK_OPT, |
1692 | 9c784fb3 | Dimitris Aragiorgis | NOCONFLICTSCHECK_OPT, |
1693 | eb28ecf6 | Guido Trotter | NONAMECHECK_OPT, |
1694 | eb28ecf6 | Guido Trotter | NONICS_OPT, |
1695 | eb28ecf6 | Guido Trotter | NWSYNC_OPT, |
1696 | eb28ecf6 | Guido Trotter | OSPARAMS_OPT, |
1697 | eb28ecf6 | Guido Trotter | OS_SIZE_OPT, |
1698 | eb28ecf6 | Guido Trotter | SUBMIT_OPT, |
1699 | d6cd74dd | Klaus Aehlig | PRINT_JOBID_OPT, |
1700 | 0f8810df | Michael Hanselmann | TAG_ADD_OPT, |
1701 | eb28ecf6 | Guido Trotter | DRY_RUN_OPT, |
1702 | eb28ecf6 | Guido Trotter | PRIORITY_OPT, |
1703 | eb28ecf6 | Guido Trotter | ] |
1704 | eb28ecf6 | Guido Trotter | |
1705 | 0ce212e5 | Iustin Pop | # common instance policy options
|
1706 | 0ce212e5 | Iustin Pop | INSTANCE_POLICY_OPTS = [ |
1707 | 919db916 | Bernardo Dal Seno | IPOLICY_BOUNDS_SPECS_OPT, |
1708 | 919db916 | Bernardo Dal Seno | IPOLICY_DISK_TEMPLATES, |
1709 | 919db916 | Bernardo Dal Seno | IPOLICY_VCPU_RATIO, |
1710 | 919db916 | Bernardo Dal Seno | IPOLICY_SPINDLE_RATIO, |
1711 | 919db916 | Bernardo Dal Seno | ] |
1712 | 919db916 | Bernardo Dal Seno | |
1713 | 919db916 | Bernardo Dal Seno | # instance policy split specs options
|
1714 | 919db916 | Bernardo Dal Seno | SPLIT_ISPECS_OPTS = [ |
1715 | 0ce212e5 | Iustin Pop | SPECS_CPU_COUNT_OPT, |
1716 | 0ce212e5 | Iustin Pop | SPECS_DISK_COUNT_OPT, |
1717 | 0ce212e5 | Iustin Pop | SPECS_DISK_SIZE_OPT, |
1718 | 0ce212e5 | Iustin Pop | SPECS_MEM_SIZE_OPT, |
1719 | 0ce212e5 | Iustin Pop | SPECS_NIC_COUNT_OPT, |
1720 | 0ce212e5 | Iustin Pop | ] |
1721 | 0ce212e5 | Iustin Pop | |
1722 | 771734c9 | Iustin Pop | |
1723 | d971402f | Michael Hanselmann | class _ShowUsage(Exception): |
1724 | d971402f | Michael Hanselmann | """Exception class for L{_ParseArgs}.
|
1725 | d971402f | Michael Hanselmann |
|
1726 | d971402f | Michael Hanselmann | """
|
1727 | d971402f | Michael Hanselmann | def __init__(self, exit_error): |
1728 | d971402f | Michael Hanselmann | """Initializes instances of this class.
|
1729 | d971402f | Michael Hanselmann |
|
1730 | d971402f | Michael Hanselmann | @type exit_error: bool
|
1731 | d971402f | Michael Hanselmann | @param exit_error: Whether to report failure on exit
|
1732 | d971402f | Michael Hanselmann |
|
1733 | d971402f | Michael Hanselmann | """
|
1734 | d971402f | Michael Hanselmann | Exception.__init__(self) |
1735 | d971402f | Michael Hanselmann | self.exit_error = exit_error
|
1736 | d971402f | Michael Hanselmann | |
1737 | d971402f | Michael Hanselmann | |
1738 | d971402f | Michael Hanselmann | class _ShowVersion(Exception): |
1739 | d971402f | Michael Hanselmann | """Exception class for L{_ParseArgs}.
|
1740 | d971402f | Michael Hanselmann |
|
1741 | d971402f | Michael Hanselmann | """
|
1742 | d971402f | Michael Hanselmann | |
1743 | d971402f | Michael Hanselmann | |
1744 | d971402f | Michael Hanselmann | def _ParseArgs(binary, argv, commands, aliases, env_override): |
1745 | c41eea6e | Iustin Pop | """Parser for the command line arguments.
|
1746 | a8083063 | Iustin Pop |
|
1747 | 5bbd3f7f | Michael Hanselmann | This function parses the arguments and returns the function which
|
1748 | c41eea6e | Iustin Pop | must be executed together with its (modified) arguments.
|
1749 | a8083063 | Iustin Pop |
|
1750 | d971402f | Michael Hanselmann | @param binary: Script name
|
1751 | d971402f | Michael Hanselmann | @param argv: Command line arguments
|
1752 | d971402f | Michael Hanselmann | @param commands: Dictionary containing command definitions
|
1753 | d971402f | Michael Hanselmann | @param aliases: dictionary with command aliases {"alias": "target", ...}
|
1754 | ef9fa5b9 | René Nussbaumer | @param env_override: list of env variables allowed for default args
|
1755 | d971402f | Michael Hanselmann | @raise _ShowUsage: If usage description should be shown
|
1756 | d971402f | Michael Hanselmann | @raise _ShowVersion: If version should be shown
|
1757 | 098c0958 | Michael Hanselmann |
|
1758 | a8083063 | Iustin Pop | """
|
1759 | ef9fa5b9 | René Nussbaumer | assert not (env_override - set(commands)) |
1760 | d971402f | Michael Hanselmann | assert not (set(aliases.keys()) & set(commands.keys())) |
1761 | ef9fa5b9 | René Nussbaumer | |
1762 | d971402f | Michael Hanselmann | if len(argv) > 1: |
1763 | d971402f | Michael Hanselmann | cmd = argv[1]
|
1764 | a8083063 | Iustin Pop | else:
|
1765 | d971402f | Michael Hanselmann | # No option or command given
|
1766 | d971402f | Michael Hanselmann | raise _ShowUsage(exit_error=True) |
1767 | a8083063 | Iustin Pop | |
1768 | d971402f | Michael Hanselmann | if cmd == "--version": |
1769 | d971402f | Michael Hanselmann | raise _ShowVersion()
|
1770 | d971402f | Michael Hanselmann | elif cmd == "--help": |
1771 | d971402f | Michael Hanselmann | raise _ShowUsage(exit_error=False) |
1772 | d971402f | Michael Hanselmann | elif not (cmd in commands or cmd in aliases): |
1773 | d971402f | Michael Hanselmann | raise _ShowUsage(exit_error=True) |
1774 | de47cf8f | Guido Trotter | |
1775 | de47cf8f | Guido Trotter | # get command, unalias it, and look it up in commands
|
1776 | de47cf8f | Guido Trotter | if cmd in aliases: |
1777 | de47cf8f | Guido Trotter | if aliases[cmd] not in commands: |
1778 | de47cf8f | Guido Trotter | raise errors.ProgrammerError("Alias '%s' maps to non-existing" |
1779 | de47cf8f | Guido Trotter | " command '%s'" % (cmd, aliases[cmd]))
|
1780 | de47cf8f | Guido Trotter | |
1781 | de47cf8f | Guido Trotter | cmd = aliases[cmd] |
1782 | de47cf8f | Guido Trotter | |
1783 | ef9fa5b9 | René Nussbaumer | if cmd in env_override: |
1784 | ef9fa5b9 | René Nussbaumer | args_env_name = ("%s_%s" % (binary.replace("-", "_"), cmd)).upper() |
1785 | ef9fa5b9 | René Nussbaumer | env_args = os.environ.get(args_env_name) |
1786 | ef9fa5b9 | René Nussbaumer | if env_args:
|
1787 | d971402f | Michael Hanselmann | argv = utils.InsertAtPos(argv, 2, shlex.split(env_args))
|
1788 | ef9fa5b9 | René Nussbaumer | |
1789 | a8005e17 | Michael Hanselmann | func, args_def, parser_opts, usage, description = commands[cmd] |
1790 | bf5338b3 | Michael Hanselmann | parser = OptionParser(option_list=parser_opts + COMMON_OPTS, |
1791 | bf5338b3 | Michael Hanselmann | description=description, |
1792 | bf5338b3 | Michael Hanselmann | formatter=TitledHelpFormatter(), |
1793 | bf5338b3 | Michael Hanselmann | usage="%%prog %s %s" % (cmd, usage))
|
1794 | a8083063 | Iustin Pop | parser.disable_interspersed_args() |
1795 | d971402f | Michael Hanselmann | options, args = parser.parse_args(args=argv[2:])
|
1796 | a8005e17 | Michael Hanselmann | |
1797 | a8005e17 | Michael Hanselmann | if not _CheckArguments(cmd, args_def, args): |
1798 | a8083063 | Iustin Pop | return None, None, None |
1799 | a8083063 | Iustin Pop | |
1800 | a8083063 | Iustin Pop | return func, options, args
|
1801 | a8083063 | Iustin Pop | |
1802 | a8083063 | Iustin Pop | |
1803 | d971402f | Michael Hanselmann | def _FormatUsage(binary, commands): |
1804 | d971402f | Michael Hanselmann | """Generates a nice description of all commands.
|
1805 | d971402f | Michael Hanselmann |
|
1806 | d971402f | Michael Hanselmann | @param binary: Script name
|
1807 | d971402f | Michael Hanselmann | @param commands: Dictionary containing command definitions
|
1808 | d971402f | Michael Hanselmann |
|
1809 | d971402f | Michael Hanselmann | """
|
1810 | d971402f | Michael Hanselmann | # compute the max line length for cmd + usage
|
1811 | d971402f | Michael Hanselmann | mlen = min(60, max(map(len, commands))) |
1812 | d971402f | Michael Hanselmann | |
1813 | d971402f | Michael Hanselmann | yield "Usage: %s {command} [options...] [argument...]" % binary |
1814 | d971402f | Michael Hanselmann | yield "%s <command> --help to see details, or man %s" % (binary, binary) |
1815 | d971402f | Michael Hanselmann | yield "" |
1816 | d971402f | Michael Hanselmann | yield "Commands:" |
1817 | d971402f | Michael Hanselmann | |
1818 | d971402f | Michael Hanselmann | # and format a nice command list
|
1819 | d971402f | Michael Hanselmann | for (cmd, (_, _, _, _, help_text)) in sorted(commands.items()): |
1820 | d971402f | Michael Hanselmann | help_lines = textwrap.wrap(help_text, 79 - 3 - mlen) |
1821 | d971402f | Michael Hanselmann | yield " %-*s - %s" % (mlen, cmd, help_lines.pop(0)) |
1822 | d971402f | Michael Hanselmann | for line in help_lines: |
1823 | d971402f | Michael Hanselmann | yield " %-*s %s" % (mlen, "", line) |
1824 | d971402f | Michael Hanselmann | |
1825 | d971402f | Michael Hanselmann | yield "" |
1826 | d971402f | Michael Hanselmann | |
1827 | d971402f | Michael Hanselmann | |
1828 | a8005e17 | Michael Hanselmann | def _CheckArguments(cmd, args_def, args): |
1829 | a8005e17 | Michael Hanselmann | """Verifies the arguments using the argument definition.
|
1830 | a8005e17 | Michael Hanselmann |
|
1831 | a8005e17 | Michael Hanselmann | Algorithm:
|
1832 | a8005e17 | Michael Hanselmann |
|
1833 | a8005e17 | Michael Hanselmann | 1. Abort with error if values specified by user but none expected.
|
1834 | a8005e17 | Michael Hanselmann |
|
1835 | a8005e17 | Michael Hanselmann | 1. For each argument in definition
|
1836 | a8005e17 | Michael Hanselmann |
|
1837 | a8005e17 | Michael Hanselmann | 1. Keep running count of minimum number of values (min_count)
|
1838 | a8005e17 | Michael Hanselmann | 1. Keep running count of maximum number of values (max_count)
|
1839 | a8005e17 | Michael Hanselmann | 1. If it has an unlimited number of values
|
1840 | a8005e17 | Michael Hanselmann |
|
1841 | a8005e17 | Michael Hanselmann | 1. Abort with error if it's not the last argument in the definition
|
1842 | a8005e17 | Michael Hanselmann |
|
1843 | a8005e17 | Michael Hanselmann | 1. If last argument has limited number of values
|
1844 | a8005e17 | Michael Hanselmann |
|
1845 | a8005e17 | Michael Hanselmann | 1. Abort with error if number of values doesn't match or is too large
|
1846 | a8005e17 | Michael Hanselmann |
|
1847 | a8005e17 | Michael Hanselmann | 1. Abort with error if user didn't pass enough values (min_count)
|
1848 | a8005e17 | Michael Hanselmann |
|
1849 | a8005e17 | Michael Hanselmann | """
|
1850 | a8005e17 | Michael Hanselmann | if args and not args_def: |
1851 | a8005e17 | Michael Hanselmann | ToStderr("Error: Command %s expects no arguments", cmd)
|
1852 | a8005e17 | Michael Hanselmann | return False |
1853 | a8005e17 | Michael Hanselmann | |
1854 | a8005e17 | Michael Hanselmann | min_count = None
|
1855 | a8005e17 | Michael Hanselmann | max_count = None
|
1856 | a8005e17 | Michael Hanselmann | check_max = None
|
1857 | a8005e17 | Michael Hanselmann | |
1858 | a8005e17 | Michael Hanselmann | last_idx = len(args_def) - 1 |
1859 | a8005e17 | Michael Hanselmann | |
1860 | a8005e17 | Michael Hanselmann | for idx, arg in enumerate(args_def): |
1861 | a8005e17 | Michael Hanselmann | if min_count is None: |
1862 | a8005e17 | Michael Hanselmann | min_count = arg.min |
1863 | a8005e17 | Michael Hanselmann | elif arg.min is not None: |
1864 | a8005e17 | Michael Hanselmann | min_count += arg.min |
1865 | a8005e17 | Michael Hanselmann | |
1866 | a8005e17 | Michael Hanselmann | if max_count is None: |
1867 | a8005e17 | Michael Hanselmann | max_count = arg.max |
1868 | a8005e17 | Michael Hanselmann | elif arg.max is not None: |
1869 | a8005e17 | Michael Hanselmann | max_count += arg.max |
1870 | a8005e17 | Michael Hanselmann | |
1871 | a8005e17 | Michael Hanselmann | if idx == last_idx:
|
1872 | a8005e17 | Michael Hanselmann | check_max = (arg.max is not None) |
1873 | a8005e17 | Michael Hanselmann | |
1874 | a8005e17 | Michael Hanselmann | elif arg.max is None: |
1875 | a8005e17 | Michael Hanselmann | raise errors.ProgrammerError("Only the last argument can have max=None") |
1876 | a8005e17 | Michael Hanselmann | |
1877 | a8005e17 | Michael Hanselmann | if check_max:
|
1878 | a8005e17 | Michael Hanselmann | # Command with exact number of arguments
|
1879 | a8005e17 | Michael Hanselmann | if (min_count is not None and max_count is not None and |
1880 | a8005e17 | Michael Hanselmann | min_count == max_count and len(args) != min_count): |
1881 | a8005e17 | Michael Hanselmann | ToStderr("Error: Command %s expects %d argument(s)", cmd, min_count)
|
1882 | a8005e17 | Michael Hanselmann | return False |
1883 | a8005e17 | Michael Hanselmann | |
1884 | a8005e17 | Michael Hanselmann | # Command with limited number of arguments
|
1885 | a8005e17 | Michael Hanselmann | if max_count is not None and len(args) > max_count: |
1886 | a8005e17 | Michael Hanselmann | ToStderr("Error: Command %s expects only %d argument(s)",
|
1887 | a8005e17 | Michael Hanselmann | cmd, max_count) |
1888 | a8005e17 | Michael Hanselmann | return False |
1889 | a8005e17 | Michael Hanselmann | |
1890 | a8005e17 | Michael Hanselmann | # Command with some required arguments
|
1891 | a8005e17 | Michael Hanselmann | if min_count is not None and len(args) < min_count: |
1892 | a8005e17 | Michael Hanselmann | ToStderr("Error: Command %s expects at least %d argument(s)",
|
1893 | a8005e17 | Michael Hanselmann | cmd, min_count) |
1894 | a8005e17 | Michael Hanselmann | return False |
1895 | a8005e17 | Michael Hanselmann | |
1896 | a8005e17 | Michael Hanselmann | return True |
1897 | a8005e17 | Michael Hanselmann | |
1898 | a8005e17 | Michael Hanselmann | |
1899 | 60d49723 | Michael Hanselmann | def SplitNodeOption(value): |
1900 | 60d49723 | Michael Hanselmann | """Splits the value of a --node option.
|
1901 | 60d49723 | Michael Hanselmann |
|
1902 | 60d49723 | Michael Hanselmann | """
|
1903 | d0c8c01d | Iustin Pop | if value and ":" in value: |
1904 | d0c8c01d | Iustin Pop | return value.split(":", 1) |
1905 | 60d49723 | Michael Hanselmann | else:
|
1906 | 60d49723 | Michael Hanselmann | return (value, None) |
1907 | 60d49723 | Michael Hanselmann | |
1908 | 60d49723 | Michael Hanselmann | |
1909 | 07150497 | Guido Trotter | def CalculateOSNames(os_name, os_variants): |
1910 | 07150497 | Guido Trotter | """Calculates all the names an OS can be called, according to its variants.
|
1911 | 07150497 | Guido Trotter |
|
1912 | 07150497 | Guido Trotter | @type os_name: string
|
1913 | 07150497 | Guido Trotter | @param os_name: base name of the os
|
1914 | 07150497 | Guido Trotter | @type os_variants: list or None
|
1915 | 07150497 | Guido Trotter | @param os_variants: list of supported variants
|
1916 | 07150497 | Guido Trotter | @rtype: list
|
1917 | 07150497 | Guido Trotter | @return: list of valid names
|
1918 | 07150497 | Guido Trotter |
|
1919 | 07150497 | Guido Trotter | """
|
1920 | 07150497 | Guido Trotter | if os_variants:
|
1921 | d0c8c01d | Iustin Pop | return ["%s+%s" % (os_name, v) for v in os_variants] |
1922 | 07150497 | Guido Trotter | else:
|
1923 | 07150497 | Guido Trotter | return [os_name]
|
1924 | 07150497 | Guido Trotter | |
1925 | 07150497 | Guido Trotter | |
1926 | a4ebd726 | Michael Hanselmann | def ParseFields(selected, default): |
1927 | a4ebd726 | Michael Hanselmann | """Parses the values of "--field"-like options.
|
1928 | a4ebd726 | Michael Hanselmann |
|
1929 | a4ebd726 | Michael Hanselmann | @type selected: string or None
|
1930 | a4ebd726 | Michael Hanselmann | @param selected: User-selected options
|
1931 | a4ebd726 | Michael Hanselmann | @type default: list
|
1932 | a4ebd726 | Michael Hanselmann | @param default: Default fields
|
1933 | a4ebd726 | Michael Hanselmann |
|
1934 | a4ebd726 | Michael Hanselmann | """
|
1935 | a4ebd726 | Michael Hanselmann | if selected is None: |
1936 | a4ebd726 | Michael Hanselmann | return default
|
1937 | a4ebd726 | Michael Hanselmann | |
1938 | a4ebd726 | Michael Hanselmann | if selected.startswith("+"): |
1939 | a4ebd726 | Michael Hanselmann | return default + selected[1:].split(",") |
1940 | a4ebd726 | Michael Hanselmann | |
1941 | a4ebd726 | Michael Hanselmann | return selected.split(",") |
1942 | a4ebd726 | Michael Hanselmann | |
1943 | a4ebd726 | Michael Hanselmann | |
1944 | e0e916fe | Iustin Pop | UsesRPC = rpc.RunWithRPC |
1945 | 4331f6cd | Michael Hanselmann | |
1946 | 4331f6cd | Michael Hanselmann | |
1947 | 47988778 | Iustin Pop | def AskUser(text, choices=None): |
1948 | 47988778 | Iustin Pop | """Ask the user a question.
|
1949 | a8083063 | Iustin Pop |
|
1950 | c41eea6e | Iustin Pop | @param text: the question to ask
|
1951 | a8083063 | Iustin Pop |
|
1952 | c41eea6e | Iustin Pop | @param choices: list with elements tuples (input_char, return_value,
|
1953 | c41eea6e | Iustin Pop | description); if not given, it will default to: [('y', True,
|
1954 | c41eea6e | Iustin Pop | 'Perform the operation'), ('n', False, 'Do no do the operation')];
|
1955 | c41eea6e | Iustin Pop | note that the '?' char is reserved for help
|
1956 | 47988778 | Iustin Pop |
|
1957 | c41eea6e | Iustin Pop | @return: one of the return values from the choices list; if input is
|
1958 | c41eea6e | Iustin Pop | not possible (i.e. not running with a tty, we return the last
|
1959 | c41eea6e | Iustin Pop | entry from the list
|
1960 | a8083063 | Iustin Pop |
|
1961 | a8083063 | Iustin Pop | """
|
1962 | 47988778 | Iustin Pop | if choices is None: |
1963 | d0c8c01d | Iustin Pop | choices = [("y", True, "Perform the operation"), |
1964 | d0c8c01d | Iustin Pop | ("n", False, "Do not perform the operation")] |
1965 | 47988778 | Iustin Pop | if not choices or not isinstance(choices, list): |
1966 | 5bbd3f7f | Michael Hanselmann | raise errors.ProgrammerError("Invalid choices argument to AskUser") |
1967 | 47988778 | Iustin Pop | for entry in choices: |
1968 | d0c8c01d | Iustin Pop | if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == "?": |
1969 | 5bbd3f7f | Michael Hanselmann | raise errors.ProgrammerError("Invalid choices element to AskUser") |
1970 | 47988778 | Iustin Pop | |
1971 | 47988778 | Iustin Pop | answer = choices[-1][1] |
1972 | 47988778 | Iustin Pop | new_text = [] |
1973 | 47988778 | Iustin Pop | for line in text.splitlines(): |
1974 | 47988778 | Iustin Pop | new_text.append(textwrap.fill(line, 70, replace_whitespace=False)) |
1975 | 47988778 | Iustin Pop | text = "\n".join(new_text)
|
1976 | a8083063 | Iustin Pop | try:
|
1977 | 3023170f | Iustin Pop | f = file("/dev/tty", "a+") |
1978 | a8083063 | Iustin Pop | except IOError: |
1979 | 47988778 | Iustin Pop | return answer
|
1980 | a8083063 | Iustin Pop | try:
|
1981 | 47988778 | Iustin Pop | chars = [entry[0] for entry in choices] |
1982 | 47988778 | Iustin Pop | chars[-1] = "[%s]" % chars[-1] |
1983 | d0c8c01d | Iustin Pop | chars.append("?")
|
1984 | 47988778 | Iustin Pop | maps = dict([(entry[0], entry[1]) for entry in choices]) |
1985 | 47988778 | Iustin Pop | while True: |
1986 | 47988778 | Iustin Pop | f.write(text) |
1987 | d0c8c01d | Iustin Pop | f.write("\n")
|
1988 | 47988778 | Iustin Pop | f.write("/".join(chars))
|
1989 | 47988778 | Iustin Pop | f.write(": ")
|
1990 | 47988778 | Iustin Pop | line = f.readline(2).strip().lower()
|
1991 | 47988778 | Iustin Pop | if line in maps: |
1992 | 47988778 | Iustin Pop | answer = maps[line] |
1993 | 47988778 | Iustin Pop | break
|
1994 | d0c8c01d | Iustin Pop | elif line == "?": |
1995 | 47988778 | Iustin Pop | for entry in choices: |
1996 | 47988778 | Iustin Pop | f.write(" %s - %s\n" % (entry[0], entry[2])) |
1997 | 47988778 | Iustin Pop | f.write("\n")
|
1998 | 47988778 | Iustin Pop | continue
|
1999 | a8083063 | Iustin Pop | finally:
|
2000 | a8083063 | Iustin Pop | f.close() |
2001 | a8083063 | Iustin Pop | return answer
|
2002 | a8083063 | Iustin Pop | |
2003 | a8083063 | Iustin Pop | |
2004 | e9d741b6 | Iustin Pop | class JobSubmittedException(Exception): |
2005 | e9d741b6 | Iustin Pop | """Job was submitted, client should exit.
|
2006 | e9d741b6 | Iustin Pop |
|
2007 | e9d741b6 | Iustin Pop | This exception has one argument, the ID of the job that was
|
2008 | e9d741b6 | Iustin Pop | submitted. The handler should print this ID.
|
2009 | e9d741b6 | Iustin Pop |
|
2010 | e9d741b6 | Iustin Pop | This is not an error, just a structured way to exit from clients.
|
2011 | e9d741b6 | Iustin Pop |
|
2012 | e9d741b6 | Iustin Pop | """
|
2013 | e9d741b6 | Iustin Pop | |
2014 | e9d741b6 | Iustin Pop | |
2015 | 0a1e74d9 | Iustin Pop | def SendJob(ops, cl=None): |
2016 | 0a1e74d9 | Iustin Pop | """Function to submit an opcode without waiting for the results.
|
2017 | a8083063 | Iustin Pop |
|
2018 | 0a1e74d9 | Iustin Pop | @type ops: list
|
2019 | 0a1e74d9 | Iustin Pop | @param ops: list of opcodes
|
2020 | 0a1e74d9 | Iustin Pop | @type cl: luxi.Client
|
2021 | 0a1e74d9 | Iustin Pop | @param cl: the luxi client to use for communicating with the master;
|
2022 | 0a1e74d9 | Iustin Pop | if None, a new client will be created
|
2023 | a8083063 | Iustin Pop |
|
2024 | a8083063 | Iustin Pop | """
|
2025 | e2212007 | Iustin Pop | if cl is None: |
2026 | b33e986b | Iustin Pop | cl = GetClient() |
2027 | 685ee993 | Iustin Pop | |
2028 | 0a1e74d9 | Iustin Pop | job_id = cl.SubmitJob(ops) |
2029 | 0a1e74d9 | Iustin Pop | |
2030 | 0a1e74d9 | Iustin Pop | return job_id
|
2031 | 0a1e74d9 | Iustin Pop | |
2032 | 0a1e74d9 | Iustin Pop | |
2033 | 4e338533 | Michael Hanselmann | def GenericPollJob(job_id, cbs, report_cbs): |
2034 | 4e338533 | Michael Hanselmann | """Generic job-polling function.
|
2035 | 0a1e74d9 | Iustin Pop |
|
2036 | 4e338533 | Michael Hanselmann | @type job_id: number
|
2037 | 4e338533 | Michael Hanselmann | @param job_id: Job ID
|
2038 | 4e338533 | Michael Hanselmann | @type cbs: Instance of L{JobPollCbBase}
|
2039 | 4e338533 | Michael Hanselmann | @param cbs: Data callbacks
|
2040 | 4e338533 | Michael Hanselmann | @type report_cbs: Instance of L{JobPollReportCbBase}
|
2041 | 4e338533 | Michael Hanselmann | @param report_cbs: Reporting callbacks
|
2042 | 0a1e74d9 | Iustin Pop |
|
2043 | 0a1e74d9 | Iustin Pop | """
|
2044 | 6c5a7090 | Michael Hanselmann | prev_job_info = None
|
2045 | 6c5a7090 | Michael Hanselmann | prev_logmsg_serial = None
|
2046 | 6c5a7090 | Michael Hanselmann | |
2047 | f4484122 | Michael Hanselmann | status = None
|
2048 | f4484122 | Michael Hanselmann | |
2049 | 685ee993 | Iustin Pop | while True: |
2050 | 4e338533 | Michael Hanselmann | result = cbs.WaitForJobChangeOnce(job_id, ["status"], prev_job_info,
|
2051 | 4e338533 | Michael Hanselmann | prev_logmsg_serial) |
2052 | 6c5a7090 | Michael Hanselmann | if not result: |
2053 | 685ee993 | Iustin Pop | # job not found, go away!
|
2054 | 0bbe448c | Michael Hanselmann | raise errors.JobLost("Job with id %s lost" % job_id) |
2055 | 4e338533 | Michael Hanselmann | |
2056 | 4e338533 | Michael Hanselmann | if result == constants.JOB_NOTCHANGED:
|
2057 | 4e338533 | Michael Hanselmann | report_cbs.ReportNotChanged(job_id, status) |
2058 | f4484122 | Michael Hanselmann | |
2059 | f4484122 | Michael Hanselmann | # Wait again
|
2060 | f4484122 | Michael Hanselmann | continue
|
2061 | 685ee993 | Iustin Pop | |
2062 | 6c5a7090 | Michael Hanselmann | # Split result, a tuple of (field values, log entries)
|
2063 | 6c5a7090 | Michael Hanselmann | (job_info, log_entries) = result |
2064 | 6c5a7090 | Michael Hanselmann | (status, ) = job_info |
2065 | 6c5a7090 | Michael Hanselmann | |
2066 | 6c5a7090 | Michael Hanselmann | if log_entries:
|
2067 | 6c5a7090 | Michael Hanselmann | for log_entry in log_entries: |
2068 | 4e338533 | Michael Hanselmann | (serial, timestamp, log_type, message) = log_entry |
2069 | 4e338533 | Michael Hanselmann | report_cbs.ReportLogMessage(job_id, serial, timestamp, |
2070 | 4e338533 | Michael Hanselmann | log_type, message) |
2071 | 6c5a7090 | Michael Hanselmann | prev_logmsg_serial = max(prev_logmsg_serial, serial)
|
2072 | 6c5a7090 | Michael Hanselmann | |
2073 | 0bbe448c | Michael Hanselmann | # TODO: Handle canceled and archived jobs
|
2074 | fbf0262f | Michael Hanselmann | elif status in (constants.JOB_STATUS_SUCCESS, |
2075 | fbf0262f | Michael Hanselmann | constants.JOB_STATUS_ERROR, |
2076 | fbf0262f | Michael Hanselmann | constants.JOB_STATUS_CANCELING, |
2077 | fbf0262f | Michael Hanselmann | constants.JOB_STATUS_CANCELED): |
2078 | 685ee993 | Iustin Pop | break
|
2079 | 6c5a7090 | Michael Hanselmann | |
2080 | 6c5a7090 | Michael Hanselmann | prev_job_info = job_info |
2081 | 685ee993 | Iustin Pop | |
2082 | 4e338533 | Michael Hanselmann | jobs = cbs.QueryJobs([job_id], ["status", "opstatus", "opresult"]) |
2083 | 0bbe448c | Michael Hanselmann | if not jobs: |
2084 | 0bbe448c | Michael Hanselmann | raise errors.JobLost("Job with id %s lost" % job_id) |
2085 | 685ee993 | Iustin Pop | |
2086 | 0e050889 | Iustin Pop | status, opstatus, result = jobs[0]
|
2087 | 4e338533 | Michael Hanselmann | |
2088 | 0bbe448c | Michael Hanselmann | if status == constants.JOB_STATUS_SUCCESS:
|
2089 | 53c04d04 | Iustin Pop | return result
|
2090 | 4e338533 | Michael Hanselmann | |
2091 | 4e338533 | Michael Hanselmann | if status in (constants.JOB_STATUS_CANCELING, constants.JOB_STATUS_CANCELED): |
2092 | fbf0262f | Michael Hanselmann | raise errors.OpExecError("Job was canceled") |
2093 | 4e338533 | Michael Hanselmann | |
2094 | 4e338533 | Michael Hanselmann | has_ok = False
|
2095 | 4e338533 | Michael Hanselmann | for idx, (status, msg) in enumerate(zip(opstatus, result)): |
2096 | 4e338533 | Michael Hanselmann | if status == constants.OP_STATUS_SUCCESS:
|
2097 | 4e338533 | Michael Hanselmann | has_ok = True
|
2098 | 4e338533 | Michael Hanselmann | elif status == constants.OP_STATUS_ERROR:
|
2099 | 4e338533 | Michael Hanselmann | errors.MaybeRaise(msg) |
2100 | 4e338533 | Michael Hanselmann | |
2101 | 4e338533 | Michael Hanselmann | if has_ok:
|
2102 | 4e338533 | Michael Hanselmann | raise errors.OpExecError("partial failure (opcode %d): %s" % |
2103 | 4e338533 | Michael Hanselmann | (idx, msg)) |
2104 | 4e338533 | Michael Hanselmann | |
2105 | 4e338533 | Michael Hanselmann | raise errors.OpExecError(str(msg)) |
2106 | 4e338533 | Michael Hanselmann | |
2107 | 4e338533 | Michael Hanselmann | # default failure mode
|
2108 | 4e338533 | Michael Hanselmann | raise errors.OpExecError(result)
|
2109 | 4e338533 | Michael Hanselmann | |
2110 | 4e338533 | Michael Hanselmann | |
2111 | 876fb142 | Helga Velroyen | class JobPollCbBase(object): |
2112 | 4e338533 | Michael Hanselmann | """Base class for L{GenericPollJob} callbacks.
|
2113 | 4e338533 | Michael Hanselmann |
|
2114 | 4e338533 | Michael Hanselmann | """
|
2115 | 4e338533 | Michael Hanselmann | def __init__(self): |
2116 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
2117 | 4e338533 | Michael Hanselmann |
|
2118 | 4e338533 | Michael Hanselmann | """
|
2119 | 4e338533 | Michael Hanselmann | |
2120 | 4e338533 | Michael Hanselmann | def WaitForJobChangeOnce(self, job_id, fields, |
2121 | 4e338533 | Michael Hanselmann | prev_job_info, prev_log_serial): |
2122 | 4e338533 | Michael Hanselmann | """Waits for changes on a job.
|
2123 | 4e338533 | Michael Hanselmann |
|
2124 | 4e338533 | Michael Hanselmann | """
|
2125 | 4e338533 | Michael Hanselmann | raise NotImplementedError() |
2126 | 4e338533 | Michael Hanselmann | |
2127 | 4e338533 | Michael Hanselmann | def QueryJobs(self, job_ids, fields): |
2128 | 4e338533 | Michael Hanselmann | """Returns the selected fields for the selected job IDs.
|
2129 | 4e338533 | Michael Hanselmann |
|
2130 | 4e338533 | Michael Hanselmann | @type job_ids: list of numbers
|
2131 | 4e338533 | Michael Hanselmann | @param job_ids: Job IDs
|
2132 | 4e338533 | Michael Hanselmann | @type fields: list of strings
|
2133 | 4e338533 | Michael Hanselmann | @param fields: Fields
|
2134 | 4e338533 | Michael Hanselmann |
|
2135 | 4e338533 | Michael Hanselmann | """
|
2136 | 4e338533 | Michael Hanselmann | raise NotImplementedError() |
2137 | 4e338533 | Michael Hanselmann | |
2138 | 4e338533 | Michael Hanselmann | |
2139 | 876fb142 | Helga Velroyen | class JobPollReportCbBase(object): |
2140 | 4e338533 | Michael Hanselmann | """Base class for L{GenericPollJob} reporting callbacks.
|
2141 | 4e338533 | Michael Hanselmann |
|
2142 | 4e338533 | Michael Hanselmann | """
|
2143 | 4e338533 | Michael Hanselmann | def __init__(self): |
2144 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
2145 | 4e338533 | Michael Hanselmann |
|
2146 | 4e338533 | Michael Hanselmann | """
|
2147 | 4e338533 | Michael Hanselmann | |
2148 | 4e338533 | Michael Hanselmann | def ReportLogMessage(self, job_id, serial, timestamp, log_type, log_msg): |
2149 | 4e338533 | Michael Hanselmann | """Handles a log message.
|
2150 | 4e338533 | Michael Hanselmann |
|
2151 | 4e338533 | Michael Hanselmann | """
|
2152 | 4e338533 | Michael Hanselmann | raise NotImplementedError() |
2153 | 4e338533 | Michael Hanselmann | |
2154 | 4e338533 | Michael Hanselmann | def ReportNotChanged(self, job_id, status): |
2155 | 4e338533 | Michael Hanselmann | """Called for if a job hasn't changed in a while.
|
2156 | 4e338533 | Michael Hanselmann |
|
2157 | 4e338533 | Michael Hanselmann | @type job_id: number
|
2158 | 4e338533 | Michael Hanselmann | @param job_id: Job ID
|
2159 | 4e338533 | Michael Hanselmann | @type status: string or None
|
2160 | 4e338533 | Michael Hanselmann | @param status: Job status if available
|
2161 | 4e338533 | Michael Hanselmann |
|
2162 | 4e338533 | Michael Hanselmann | """
|
2163 | 4e338533 | Michael Hanselmann | raise NotImplementedError() |
2164 | 4e338533 | Michael Hanselmann | |
2165 | 4e338533 | Michael Hanselmann | |
2166 | 4e338533 | Michael Hanselmann | class _LuxiJobPollCb(JobPollCbBase): |
2167 | 4e338533 | Michael Hanselmann | def __init__(self, cl): |
2168 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
2169 | 4e338533 | Michael Hanselmann |
|
2170 | 4e338533 | Michael Hanselmann | """
|
2171 | 4e338533 | Michael Hanselmann | JobPollCbBase.__init__(self)
|
2172 | 4e338533 | Michael Hanselmann | self.cl = cl
|
2173 | 4e338533 | Michael Hanselmann | |
2174 | 4e338533 | Michael Hanselmann | def WaitForJobChangeOnce(self, job_id, fields, |
2175 | 4e338533 | Michael Hanselmann | prev_job_info, prev_log_serial): |
2176 | 4e338533 | Michael Hanselmann | """Waits for changes on a job.
|
2177 | 4e338533 | Michael Hanselmann |
|
2178 | 4e338533 | Michael Hanselmann | """
|
2179 | 4e338533 | Michael Hanselmann | return self.cl.WaitForJobChangeOnce(job_id, fields, |
2180 | 4e338533 | Michael Hanselmann | prev_job_info, prev_log_serial) |
2181 | 4e338533 | Michael Hanselmann | |
2182 | 4e338533 | Michael Hanselmann | def QueryJobs(self, job_ids, fields): |
2183 | 4e338533 | Michael Hanselmann | """Returns the selected fields for the selected job IDs.
|
2184 | 4e338533 | Michael Hanselmann |
|
2185 | 4e338533 | Michael Hanselmann | """
|
2186 | 4e338533 | Michael Hanselmann | return self.cl.QueryJobs(job_ids, fields) |
2187 | 4e338533 | Michael Hanselmann | |
2188 | 4e338533 | Michael Hanselmann | |
2189 | 4e338533 | Michael Hanselmann | class FeedbackFnJobPollReportCb(JobPollReportCbBase): |
2190 | 4e338533 | Michael Hanselmann | def __init__(self, feedback_fn): |
2191 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
2192 | 4e338533 | Michael Hanselmann |
|
2193 | 4e338533 | Michael Hanselmann | """
|
2194 | 4e338533 | Michael Hanselmann | JobPollReportCbBase.__init__(self)
|
2195 | 4e338533 | Michael Hanselmann | |
2196 | 4e338533 | Michael Hanselmann | self.feedback_fn = feedback_fn
|
2197 | 4e338533 | Michael Hanselmann | |
2198 | 4e338533 | Michael Hanselmann | assert callable(feedback_fn) |
2199 | 4e338533 | Michael Hanselmann | |
2200 | 4e338533 | Michael Hanselmann | def ReportLogMessage(self, job_id, serial, timestamp, log_type, log_msg): |
2201 | 4e338533 | Michael Hanselmann | """Handles a log message.
|
2202 | 4e338533 | Michael Hanselmann |
|
2203 | 4e338533 | Michael Hanselmann | """
|
2204 | 4e338533 | Michael Hanselmann | self.feedback_fn((timestamp, log_type, log_msg))
|
2205 | 4e338533 | Michael Hanselmann | |
2206 | 4e338533 | Michael Hanselmann | def ReportNotChanged(self, job_id, status): |
2207 | 4e338533 | Michael Hanselmann | """Called if a job hasn't changed in a while.
|
2208 | 4e338533 | Michael Hanselmann |
|
2209 | 4e338533 | Michael Hanselmann | """
|
2210 | 4e338533 | Michael Hanselmann | # Ignore
|
2211 | 4e338533 | Michael Hanselmann | |
2212 | 4e338533 | Michael Hanselmann | |
2213 | 4e338533 | Michael Hanselmann | class StdioJobPollReportCb(JobPollReportCbBase): |
2214 | 4e338533 | Michael Hanselmann | def __init__(self): |
2215 | 4e338533 | Michael Hanselmann | """Initializes this class.
|
2216 | 4e338533 | Michael Hanselmann |
|
2217 | 4e338533 | Michael Hanselmann | """
|
2218 | 4e338533 | Michael Hanselmann | JobPollReportCbBase.__init__(self)
|
2219 | 4e338533 | Michael Hanselmann | |
2220 | 4e338533 | Michael Hanselmann | self.notified_queued = False |
2221 | 4e338533 | Michael Hanselmann | self.notified_waitlock = False |
2222 | 4e338533 | Michael Hanselmann | |
2223 | 4e338533 | Michael Hanselmann | def ReportLogMessage(self, job_id, serial, timestamp, log_type, log_msg): |
2224 | 4e338533 | Michael Hanselmann | """Handles a log message.
|
2225 | 4e338533 | Michael Hanselmann |
|
2226 | 4e338533 | Michael Hanselmann | """
|
2227 | 4e338533 | Michael Hanselmann | ToStdout("%s %s", time.ctime(utils.MergeTime(timestamp)),
|
2228 | 8a7f1c61 | Michael Hanselmann | FormatLogMessage(log_type, log_msg)) |
2229 | 4e338533 | Michael Hanselmann | |
2230 | 4e338533 | Michael Hanselmann | def ReportNotChanged(self, job_id, status): |
2231 | 4e338533 | Michael Hanselmann | """Called if a job hasn't changed in a while.
|
2232 | 4e338533 | Michael Hanselmann |
|
2233 | 4e338533 | Michael Hanselmann | """
|
2234 | 4e338533 | Michael Hanselmann | if status is None: |
2235 | 4e338533 | Michael Hanselmann | return
|
2236 | 4e338533 | Michael Hanselmann | |
2237 | 4e338533 | Michael Hanselmann | if status == constants.JOB_STATUS_QUEUED and not self.notified_queued: |
2238 | 4e338533 | Michael Hanselmann | ToStderr("Job %s is waiting in queue", job_id)
|
2239 | 4e338533 | Michael Hanselmann | self.notified_queued = True |
2240 | 4e338533 | Michael Hanselmann | |
2241 | 47099cd1 | Michael Hanselmann | elif status == constants.JOB_STATUS_WAITING and not self.notified_waitlock: |
2242 | 4e338533 | Michael Hanselmann | ToStderr("Job %s is trying to acquire all necessary locks", job_id)
|
2243 | 4e338533 | Michael Hanselmann | self.notified_waitlock = True |
2244 | 4e338533 | Michael Hanselmann | |
2245 | 4e338533 | Michael Hanselmann | |
2246 | 8a7f1c61 | Michael Hanselmann | def FormatLogMessage(log_type, log_msg): |
2247 | 8a7f1c61 | Michael Hanselmann | """Formats a job message according to its type.
|
2248 | 8a7f1c61 | Michael Hanselmann |
|
2249 | 8a7f1c61 | Michael Hanselmann | """
|
2250 | 8a7f1c61 | Michael Hanselmann | if log_type != constants.ELOG_MESSAGE:
|
2251 | 8a7f1c61 | Michael Hanselmann | log_msg = str(log_msg)
|
2252 | 8a7f1c61 | Michael Hanselmann | |
2253 | 8a7f1c61 | Michael Hanselmann | return utils.SafeEncode(log_msg)
|
2254 | 8a7f1c61 | Michael Hanselmann | |
2255 | 8a7f1c61 | Michael Hanselmann | |
2256 | 583163a6 | Michael Hanselmann | def PollJob(job_id, cl=None, feedback_fn=None, reporter=None): |
2257 | 4e338533 | Michael Hanselmann | """Function to poll for the result of a job.
|
2258 | 4e338533 | Michael Hanselmann |
|
2259 | 4e338533 | Michael Hanselmann | @type job_id: job identified
|
2260 | 4e338533 | Michael Hanselmann | @param job_id: the job to poll for results
|
2261 | 4e338533 | Michael Hanselmann | @type cl: luxi.Client
|
2262 | 4e338533 | Michael Hanselmann | @param cl: the luxi client to use for communicating with the master;
|
2263 | 4e338533 | Michael Hanselmann | if None, a new client will be created
|
2264 | 4e338533 | Michael Hanselmann |
|
2265 | 4e338533 | Michael Hanselmann | """
|
2266 | 4e338533 | Michael Hanselmann | if cl is None: |
2267 | 4e338533 | Michael Hanselmann | cl = GetClient() |
2268 | 4e338533 | Michael Hanselmann | |
2269 | 583163a6 | Michael Hanselmann | if reporter is None: |
2270 | 583163a6 | Michael Hanselmann | if feedback_fn:
|
2271 | 583163a6 | Michael Hanselmann | reporter = FeedbackFnJobPollReportCb(feedback_fn) |
2272 | 583163a6 | Michael Hanselmann | else:
|
2273 | 583163a6 | Michael Hanselmann | reporter = StdioJobPollReportCb() |
2274 | 583163a6 | Michael Hanselmann | elif feedback_fn:
|
2275 | 583163a6 | Michael Hanselmann | raise errors.ProgrammerError("Can't specify reporter and feedback function") |
2276 | 4e338533 | Michael Hanselmann | |
2277 | 4e338533 | Michael Hanselmann | return GenericPollJob(job_id, _LuxiJobPollCb(cl), reporter)
|
2278 | ceab32dd | Iustin Pop | |
2279 | ceab32dd | Iustin Pop | |
2280 | 583163a6 | Michael Hanselmann | def SubmitOpCode(op, cl=None, feedback_fn=None, opts=None, reporter=None): |
2281 | 0a1e74d9 | Iustin Pop | """Legacy function to submit an opcode.
|
2282 | 0a1e74d9 | Iustin Pop |
|
2283 | 0a1e74d9 | Iustin Pop | This is just a simple wrapper over the construction of the processor
|
2284 | 0a1e74d9 | Iustin Pop | instance. It should be extended to better handle feedback and
|
2285 | 0a1e74d9 | Iustin Pop | interaction functions.
|
2286 | 0a1e74d9 | Iustin Pop |
|
2287 | 0a1e74d9 | Iustin Pop | """
|
2288 | 0a1e74d9 | Iustin Pop | if cl is None: |
2289 | 0a1e74d9 | Iustin Pop | cl = GetClient() |
2290 | 0a1e74d9 | Iustin Pop | |
2291 | 293ba2d8 | Iustin Pop | SetGenericOpcodeOpts([op], opts) |
2292 | 293ba2d8 | Iustin Pop | |
2293 | 5d297d8a | Michael Hanselmann | job_id = SendJob([op], cl=cl) |
2294 | fe5a2780 | Klaus Aehlig | if hasattr(opts, "print_jobid") and opts.print_jobid: |
2295 | d6cd74dd | Klaus Aehlig | ToStdout("%d" % job_id)
|
2296 | 0a1e74d9 | Iustin Pop | |
2297 | 583163a6 | Michael Hanselmann | op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn, |
2298 | 583163a6 | Michael Hanselmann | reporter=reporter) |
2299 | 53c04d04 | Iustin Pop | |
2300 | 53c04d04 | Iustin Pop | return op_results[0] |
2301 | 0a1e74d9 | Iustin Pop | |
2302 | 0a1e74d9 | Iustin Pop | |
2303 | 346c3037 | Klaus Aehlig | def SubmitOpCodeToDrainedQueue(op): |
2304 | 346c3037 | Klaus Aehlig | """Forcefully insert a job in the queue, even if it is drained.
|
2305 | 346c3037 | Klaus Aehlig |
|
2306 | 346c3037 | Klaus Aehlig | """
|
2307 | 346c3037 | Klaus Aehlig | cl = GetClient() |
2308 | 346c3037 | Klaus Aehlig | job_id = cl.SubmitJobToDrainedQueue([op]) |
2309 | 346c3037 | Klaus Aehlig | op_results = PollJob(job_id, cl=cl) |
2310 | 346c3037 | Klaus Aehlig | return op_results[0] |
2311 | 346c3037 | Klaus Aehlig | |
2312 | 346c3037 | Klaus Aehlig | |
2313 | 94428652 | Iustin Pop | def SubmitOrSend(op, opts, cl=None, feedback_fn=None): |
2314 | 94428652 | Iustin Pop | """Wrapper around SubmitOpCode or SendJob.
|
2315 | 94428652 | Iustin Pop |
|
2316 | 94428652 | Iustin Pop | This function will decide, based on the 'opts' parameter, whether to
|
2317 | 94428652 | Iustin Pop | submit and wait for the result of the opcode (and return it), or
|
2318 | 94428652 | Iustin Pop | whether to just send the job and print its identifier. It is used in
|
2319 | 94428652 | Iustin Pop | order to simplify the implementation of the '--submit' option.
|
2320 | 94428652 | Iustin Pop |
|
2321 | 293ba2d8 | Iustin Pop | It will also process the opcodes if we're sending the via SendJob
|
2322 | 293ba2d8 | Iustin Pop | (otherwise SubmitOpCode does it).
|
2323 | 64c65a2a | Iustin Pop |
|
2324 | 94428652 | Iustin Pop | """
|
2325 | 94428652 | Iustin Pop | if opts and opts.submit_only: |
2326 | 293ba2d8 | Iustin Pop | job = [op] |
2327 | 293ba2d8 | Iustin Pop | SetGenericOpcodeOpts(job, opts) |
2328 | 293ba2d8 | Iustin Pop | job_id = SendJob(job, cl=cl) |
2329 | d6cd74dd | Klaus Aehlig | if opts.print_jobid:
|
2330 | d6cd74dd | Klaus Aehlig | ToStdout("%d" % job_id)
|
2331 | e9d741b6 | Iustin Pop | raise JobSubmittedException(job_id)
|
2332 | 94428652 | Iustin Pop | else:
|
2333 | 293ba2d8 | Iustin Pop | return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn, opts=opts)
|
2334 | 293ba2d8 | Iustin Pop | |
2335 | 293ba2d8 | Iustin Pop | |
2336 | 276e51bd | Michele Tartara | def _InitReasonTrail(op, opts): |
2337 | 276e51bd | Michele Tartara | """Builds the first part of the reason trail
|
2338 | 276e51bd | Michele Tartara |
|
2339 | 276e51bd | Michele Tartara | Builds the initial part of the reason trail, adding the user provided reason
|
2340 | 276e51bd | Michele Tartara | (if it exists) and the name of the command starting the operation.
|
2341 | 276e51bd | Michele Tartara |
|
2342 | 276e51bd | Michele Tartara | @param op: the opcode the reason trail will be added to
|
2343 | 276e51bd | Michele Tartara | @param opts: the command line options selected by the user
|
2344 | 276e51bd | Michele Tartara |
|
2345 | 276e51bd | Michele Tartara | """
|
2346 | 276e51bd | Michele Tartara | assert len(sys.argv) >= 2 |
2347 | 276e51bd | Michele Tartara | trail = [] |
2348 | 276e51bd | Michele Tartara | |
2349 | 276e51bd | Michele Tartara | if opts.reason:
|
2350 | 276e51bd | Michele Tartara | trail.append((constants.OPCODE_REASON_SRC_USER, |
2351 | 276e51bd | Michele Tartara | opts.reason, |
2352 | 276e51bd | Michele Tartara | utils.EpochNano())) |
2353 | 276e51bd | Michele Tartara | |
2354 | 276e51bd | Michele Tartara | binary = os.path.basename(sys.argv[0])
|
2355 | 276e51bd | Michele Tartara | source = "%s:%s" % (constants.OPCODE_REASON_SRC_CLIENT, binary)
|
2356 | 276e51bd | Michele Tartara | command = sys.argv[1]
|
2357 | 276e51bd | Michele Tartara | trail.append((source, command, utils.EpochNano())) |
2358 | 276e51bd | Michele Tartara | op.reason = trail |
2359 | 276e51bd | Michele Tartara | |
2360 | 276e51bd | Michele Tartara | |
2361 | 293ba2d8 | Iustin Pop | def SetGenericOpcodeOpts(opcode_list, options): |
2362 | 293ba2d8 | Iustin Pop | """Processor for generic options.
|
2363 | 293ba2d8 | Iustin Pop |
|
2364 | 293ba2d8 | Iustin Pop | This function updates the given opcodes based on generic command
|
2365 | 293ba2d8 | Iustin Pop | line options (like debug, dry-run, etc.).
|
2366 | 293ba2d8 | Iustin Pop |
|
2367 | 293ba2d8 | Iustin Pop | @param opcode_list: list of opcodes
|
2368 | 293ba2d8 | Iustin Pop | @param options: command line options or None
|
2369 | 293ba2d8 | Iustin Pop | @return: None (in-place modification)
|
2370 | 293ba2d8 | Iustin Pop |
|
2371 | 293ba2d8 | Iustin Pop | """
|
2372 | 293ba2d8 | Iustin Pop | if not options: |
2373 | 293ba2d8 | Iustin Pop | return
|
2374 | 293ba2d8 | Iustin Pop | for op in opcode_list: |
2375 | aa06f8c6 | Michael Hanselmann | op.debug_level = options.debug |
2376 | a0a6ff34 | Iustin Pop | if hasattr(options, "dry_run"): |
2377 | a0a6ff34 | Iustin Pop | op.dry_run = options.dry_run |
2378 | aa06f8c6 | Michael Hanselmann | if getattr(options, "priority", None) is not None: |
2379 | 552328b8 | Michael Hanselmann | op.priority = options.priority |
2380 | 276e51bd | Michele Tartara | _InitReasonTrail(op, options) |
2381 | 94428652 | Iustin Pop | |
2382 | 94428652 | Iustin Pop | |
2383 | 42ab9ac4 | Iustin Pop | def GetClient(query=False): |
2384 | 42ab9ac4 | Iustin Pop | """Connects to the a luxi socket and returns a client.
|
2385 | 42ab9ac4 | Iustin Pop |
|
2386 | 42ab9ac4 | Iustin Pop | @type query: boolean
|
2387 | 42ab9ac4 | Iustin Pop | @param query: this signifies that the client will only be
|
2388 | 42ab9ac4 | Iustin Pop | used for queries; if the build-time parameter
|
2389 | 42ab9ac4 | Iustin Pop | enable-split-queries is enabled, then the client will be
|
2390 | 42ab9ac4 | Iustin Pop | connected to the query socket instead of the masterd socket
|
2391 | 42ab9ac4 | Iustin Pop |
|
2392 | 42ab9ac4 | Iustin Pop | """
|
2393 | 055d6ac0 | Iustin Pop | override_socket = os.getenv(constants.LUXI_OVERRIDE, "")
|
2394 | 055d6ac0 | Iustin Pop | if override_socket:
|
2395 | 055d6ac0 | Iustin Pop | if override_socket == constants.LUXI_OVERRIDE_MASTER:
|
2396 | 055d6ac0 | Iustin Pop | address = pathutils.MASTER_SOCKET |
2397 | 055d6ac0 | Iustin Pop | elif override_socket == constants.LUXI_OVERRIDE_QUERY:
|
2398 | 055d6ac0 | Iustin Pop | address = pathutils.QUERY_SOCKET |
2399 | 055d6ac0 | Iustin Pop | else:
|
2400 | 055d6ac0 | Iustin Pop | address = override_socket |
2401 | 055d6ac0 | Iustin Pop | elif query and constants.ENABLE_SPLIT_QUERY: |
2402 | ee4a14c0 | Michael Hanselmann | address = pathutils.QUERY_SOCKET |
2403 | 42ab9ac4 | Iustin Pop | else:
|
2404 | 42ab9ac4 | Iustin Pop | address = None
|
2405 | af30b2fd | Michael Hanselmann | # TODO: Cache object?
|
2406 | b33e986b | Iustin Pop | try:
|
2407 | 42ab9ac4 | Iustin Pop | client = luxi.Client(address=address) |
2408 | b33e986b | Iustin Pop | except luxi.NoMasterError:
|
2409 | d9a51679 | Michael Hanselmann | ss = ssconf.SimpleStore() |
2410 | d9a51679 | Michael Hanselmann | |
2411 | d9a51679 | Michael Hanselmann | # Try to read ssconf file
|
2412 | d9a51679 | Michael Hanselmann | try:
|
2413 | d9a51679 | Michael Hanselmann | ss.GetMasterNode() |
2414 | d9a51679 | Michael Hanselmann | except errors.ConfigurationError:
|
2415 | d9a51679 | Michael Hanselmann | raise errors.OpPrereqError("Cluster not initialized or this machine is" |
2416 | 2cfbc784 | Iustin Pop | " not part of a cluster",
|
2417 | 2cfbc784 | Iustin Pop | errors.ECODE_INVAL) |
2418 | d9a51679 | Michael Hanselmann | |
2419 | d9a51679 | Michael Hanselmann | master, myself = ssconf.GetMasterAndMyself(ss=ss) |
2420 | b33e986b | Iustin Pop | if master != myself:
|
2421 | b33e986b | Iustin Pop | raise errors.OpPrereqError("This is not the master node, please connect" |
2422 | b33e986b | Iustin Pop | " to node '%s' and rerun the command" %
|
2423 | 2cfbc784 | Iustin Pop | master, errors.ECODE_INVAL) |
2424 | d9a51679 | Michael Hanselmann | raise
|
2425 | b33e986b | Iustin Pop | return client
|
2426 | af30b2fd | Michael Hanselmann | |
2427 | af30b2fd | Michael Hanselmann | |
2428 | 73702ee7 | Iustin Pop | def FormatError(err): |
2429 | 73702ee7 | Iustin Pop | """Return a formatted error message for a given error.
|
2430 | 73702ee7 | Iustin Pop |
|
2431 | 73702ee7 | Iustin Pop | This function takes an exception instance and returns a tuple
|
2432 | 73702ee7 | Iustin Pop | consisting of two values: first, the recommended exit code, and
|
2433 | 73702ee7 | Iustin Pop | second, a string describing the error message (not
|
2434 | 73702ee7 | Iustin Pop | newline-terminated).
|
2435 | 73702ee7 | Iustin Pop |
|
2436 | 73702ee7 | Iustin Pop | """
|
2437 | 73702ee7 | Iustin Pop | retcode = 1
|
2438 | 73702ee7 | Iustin Pop | obuf = StringIO() |
2439 | e2e521d0 | Iustin Pop | msg = str(err)
|
2440 | 73702ee7 | Iustin Pop | if isinstance(err, errors.ConfigurationError): |
2441 | e2e521d0 | Iustin Pop | txt = "Corrupt configuration file: %s" % msg
|
2442 | 46fbdd04 | Iustin Pop | logging.error(txt) |
2443 | e2e521d0 | Iustin Pop | obuf.write(txt + "\n")
|
2444 | 73702ee7 | Iustin Pop | obuf.write("Aborting.")
|
2445 | 73702ee7 | Iustin Pop | retcode = 2
|
2446 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.HooksAbort): |
2447 | 73702ee7 | Iustin Pop | obuf.write("Failure: hooks execution failed:\n")
|
2448 | 73702ee7 | Iustin Pop | for node, script, out in err.args[0]: |
2449 | 73702ee7 | Iustin Pop | if out:
|
2450 | 73702ee7 | Iustin Pop | obuf.write(" node: %s, script: %s, output: %s\n" %
|
2451 | 73702ee7 | Iustin Pop | (node, script, out)) |
2452 | 73702ee7 | Iustin Pop | else:
|
2453 | 73702ee7 | Iustin Pop | obuf.write(" node: %s, script: %s (no output)\n" %
|
2454 | 73702ee7 | Iustin Pop | (node, script)) |
2455 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.HooksFailure): |
2456 | e2e521d0 | Iustin Pop | obuf.write("Failure: hooks general failure: %s" % msg)
|
2457 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.ResolverError): |
2458 | b705c7a6 | Manuel Franceschini | this_host = netutils.Hostname.GetSysName() |
2459 | 73702ee7 | Iustin Pop | if err.args[0] == this_host: |
2460 | 73702ee7 | Iustin Pop | msg = "Failure: can't resolve my own hostname ('%s')"
|
2461 | 73702ee7 | Iustin Pop | else:
|
2462 | 73702ee7 | Iustin Pop | msg = "Failure: can't resolve hostname '%s'"
|
2463 | 73702ee7 | Iustin Pop | obuf.write(msg % err.args[0])
|
2464 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.OpPrereqError): |
2465 | 5c983ee5 | Iustin Pop | if len(err.args) == 2: |
2466 | 5c983ee5 | Iustin Pop | obuf.write("Failure: prerequisites not met for this"
|
2467 | 5ae4945a | Iustin Pop | " operation:\nerror type: %s, error details:\n%s" %
|
2468 | 5c983ee5 | Iustin Pop | (err.args[1], err.args[0])) |
2469 | 5c983ee5 | Iustin Pop | else:
|
2470 | 5c983ee5 | Iustin Pop | obuf.write("Failure: prerequisites not met for this"
|
2471 | 5c983ee5 | Iustin Pop | " operation:\n%s" % msg)
|
2472 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.OpExecError): |
2473 | e2e521d0 | Iustin Pop | obuf.write("Failure: command execution error:\n%s" % msg)
|
2474 | 73702ee7 | Iustin Pop | elif isinstance(err, errors.TagError): |
2475 | e2e521d0 | Iustin Pop | obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
|
2476 | 686d7433 | Iustin Pop | elif isinstance(err, errors.JobQueueDrainError): |
2477 | 686d7433 | Iustin Pop | obuf.write("Failure: the job queue is marked for drain and doesn't"
|
2478 | 686d7433 | Iustin Pop | " accept new requests\n")
|
2479 | f87b405e | Michael Hanselmann | elif isinstance(err, errors.JobQueueFull): |
2480 | f87b405e | Michael Hanselmann | obuf.write("Failure: the job queue is full and doesn't accept new"
|
2481 | f87b405e | Michael Hanselmann | " job submissions until old jobs are archived\n")
|
2482 | a5728081 | Guido Trotter | elif isinstance(err, errors.TypeEnforcementError): |
2483 | a5728081 | Guido Trotter | obuf.write("Parameter Error: %s" % msg)
|
2484 | c1ce76bb | Iustin Pop | elif isinstance(err, errors.ParameterError): |
2485 | c1ce76bb | Iustin Pop | obuf.write("Failure: unknown/wrong parameter name '%s'" % msg)
|
2486 | 03a8dbdc | Iustin Pop | elif isinstance(err, luxi.NoMasterError): |
2487 | 7f5edc60 | Iustin Pop | if err.args[0] == pathutils.MASTER_SOCKET: |
2488 | 055d6ac0 | Iustin Pop | daemon = "the master daemon"
|
2489 | 055d6ac0 | Iustin Pop | elif err.args[0] == pathutils.QUERY_SOCKET: |
2490 | 055d6ac0 | Iustin Pop | daemon = "the config daemon"
|
2491 | 7f5edc60 | Iustin Pop | else:
|
2492 | 055d6ac0 | Iustin Pop | daemon = "socket '%s'" % str(err.args[0]) |
2493 | 055d6ac0 | Iustin Pop | obuf.write("Cannot communicate with %s.\nIs the process running"
|
2494 | 7f5edc60 | Iustin Pop | " and listening for connections?" % daemon)
|
2495 | 03a8dbdc | Iustin Pop | elif isinstance(err, luxi.TimeoutError): |
2496 | cd4c86a8 | Michael Hanselmann | obuf.write("Timeout while talking to the master daemon. Jobs might have"
|
2497 | cd4c86a8 | Michael Hanselmann | " been submitted and will continue to run even if the call"
|
2498 | cd4c86a8 | Michael Hanselmann | " timed out. Useful commands in this situation are \"gnt-job"
|
2499 | cd4c86a8 | Michael Hanselmann | " list\", \"gnt-job cancel\" and \"gnt-job watch\". Error:\n")
|
2500 | cd4c86a8 | Michael Hanselmann | obuf.write(msg) |
2501 | 5a1c22fe | Iustin Pop | elif isinstance(err, luxi.PermissionError): |
2502 | 5a1c22fe | Iustin Pop | obuf.write("It seems you don't have permissions to connect to the"
|
2503 | 5a1c22fe | Iustin Pop | " master daemon.\nPlease retry as a different user.")
|
2504 | 03a8dbdc | Iustin Pop | elif isinstance(err, luxi.ProtocolError): |
2505 | 03a8dbdc | Iustin Pop | obuf.write("Unhandled protocol error while talking to the master daemon:\n"
|
2506 | 03a8dbdc | Iustin Pop | "%s" % msg)
|
2507 | 91c622a8 | Iustin Pop | elif isinstance(err, errors.JobLost): |
2508 | 91c622a8 | Iustin Pop | obuf.write("Error checking job status: %s" % msg)
|
2509 | cb1e6c3c | Michael Hanselmann | elif isinstance(err, errors.QueryFilterParseError): |
2510 | cb1e6c3c | Michael Hanselmann | obuf.write("Error while parsing query filter: %s\n" % err.args[0]) |
2511 | cb1e6c3c | Michael Hanselmann | obuf.write("\n".join(err.GetDetails()))
|
2512 | 797506fc | Michael Hanselmann | elif isinstance(err, errors.GenericError): |
2513 | 797506fc | Michael Hanselmann | obuf.write("Unhandled Ganeti error: %s" % msg)
|
2514 | e9d741b6 | Iustin Pop | elif isinstance(err, JobSubmittedException): |
2515 | e9d741b6 | Iustin Pop | obuf.write("JobID: %s\n" % err.args[0]) |
2516 | e9d741b6 | Iustin Pop | retcode = 0
|
2517 | 73702ee7 | Iustin Pop | else:
|
2518 | e2e521d0 | Iustin Pop | obuf.write("Unhandled exception: %s" % msg)
|
2519 | d0c8c01d | Iustin Pop | return retcode, obuf.getvalue().rstrip("\n") |
2520 | 73702ee7 | Iustin Pop | |
2521 | 73702ee7 | Iustin Pop | |
2522 | ef9fa5b9 | René Nussbaumer | def GenericMain(commands, override=None, aliases=None, |
2523 | ef9fa5b9 | René Nussbaumer | env_override=frozenset()):
|
2524 | a8083063 | Iustin Pop | """Generic main function for all the gnt-* commands.
|
2525 | a8083063 | Iustin Pop |
|
2526 | ef9fa5b9 | René Nussbaumer | @param commands: a dictionary with a special structure, see the design doc
|
2527 | ef9fa5b9 | René Nussbaumer | for command line handling.
|
2528 | ef9fa5b9 | René Nussbaumer | @param override: if not None, we expect a dictionary with keys that will
|
2529 | ef9fa5b9 | René Nussbaumer | override command line options; this can be used to pass
|
2530 | ef9fa5b9 | René Nussbaumer | options from the scripts to generic functions
|
2531 | ef9fa5b9 | René Nussbaumer | @param aliases: dictionary with command aliases {'alias': 'target, ...}
|
2532 | ef9fa5b9 | René Nussbaumer | @param env_override: list of environment names which are allowed to submit
|
2533 | ef9fa5b9 | René Nussbaumer | default args for commands
|
2534 | a8083063 | Iustin Pop |
|
2535 | a8083063 | Iustin Pop | """
|
2536 | a8083063 | Iustin Pop | # save the program name and the entire command line for later logging
|
2537 | a8083063 | Iustin Pop | if sys.argv:
|
2538 | c1f19851 | Michael Hanselmann | binary = os.path.basename(sys.argv[0])
|
2539 | c1f19851 | Michael Hanselmann | if not binary: |
2540 | c1f19851 | Michael Hanselmann | binary = sys.argv[0]
|
2541 | c1f19851 | Michael Hanselmann | |
2542 | a8083063 | Iustin Pop | if len(sys.argv) >= 2: |
2543 | c1f19851 | Michael Hanselmann | logname = utils.ShellQuoteArgs([binary, sys.argv[1]])
|
2544 | a8083063 | Iustin Pop | else:
|
2545 | c1f19851 | Michael Hanselmann | logname = binary |
2546 | c1f19851 | Michael Hanselmann | |
2547 | c1f19851 | Michael Hanselmann | cmdline = utils.ShellQuoteArgs([binary] + sys.argv[1:])
|
2548 | a8083063 | Iustin Pop | else:
|
2549 | a8083063 | Iustin Pop | binary = "<unknown program>"
|
2550 | c1f19851 | Michael Hanselmann | cmdline = "<unknown>"
|
2551 | a8083063 | Iustin Pop | |
2552 | de47cf8f | Guido Trotter | if aliases is None: |
2553 | de47cf8f | Guido Trotter | aliases = {} |
2554 | de47cf8f | Guido Trotter | |
2555 | 3126878d | Guido Trotter | try:
|
2556 | d971402f | Michael Hanselmann | (func, options, args) = _ParseArgs(binary, sys.argv, commands, aliases, |
2557 | d971402f | Michael Hanselmann | env_override) |
2558 | d971402f | Michael Hanselmann | except _ShowVersion:
|
2559 | d971402f | Michael Hanselmann | ToStdout("%s (ganeti %s) %s", binary, constants.VCS_VERSION,
|
2560 | d971402f | Michael Hanselmann | constants.RELEASE_VERSION) |
2561 | d971402f | Michael Hanselmann | return constants.EXIT_SUCCESS
|
2562 | d971402f | Michael Hanselmann | except _ShowUsage, err:
|
2563 | d971402f | Michael Hanselmann | for line in _FormatUsage(binary, commands): |
2564 | d971402f | Michael Hanselmann | ToStdout(line) |
2565 | d971402f | Michael Hanselmann | |
2566 | d971402f | Michael Hanselmann | if err.exit_error:
|
2567 | d971402f | Michael Hanselmann | return constants.EXIT_FAILURE
|
2568 | d971402f | Michael Hanselmann | else:
|
2569 | d971402f | Michael Hanselmann | return constants.EXIT_SUCCESS
|
2570 | 3126878d | Guido Trotter | except errors.ParameterError, err:
|
2571 | 3126878d | Guido Trotter | result, err_msg = FormatError(err) |
2572 | 3126878d | Guido Trotter | ToStderr(err_msg) |
2573 | 3126878d | Guido Trotter | return 1 |
2574 | 3126878d | Guido Trotter | |
2575 | a8083063 | Iustin Pop | if func is None: # parse error |
2576 | a8083063 | Iustin Pop | return 1 |
2577 | a8083063 | Iustin Pop | |
2578 | 334d1483 | Iustin Pop | if override is not None: |
2579 | 334d1483 | Iustin Pop | for key, val in override.iteritems(): |
2580 | 334d1483 | Iustin Pop | setattr(options, key, val)
|
2581 | 334d1483 | Iustin Pop | |
2582 | ee4a14c0 | Michael Hanselmann | utils.SetupLogging(pathutils.LOG_COMMANDS, logname, debug=options.debug, |
2583 | cfcc79c6 | Michael Hanselmann | stderr_logging=True)
|
2584 | a8083063 | Iustin Pop | |
2585 | c1f19851 | Michael Hanselmann | logging.info("Command line: %s", cmdline)
|
2586 | a8083063 | Iustin Pop | |
2587 | a8083063 | Iustin Pop | try:
|
2588 | a4af651e | Iustin Pop | result = func(options, args) |
2589 | d8353c3a | Iustin Pop | except (errors.GenericError, luxi.ProtocolError,
|
2590 | d8353c3a | Iustin Pop | JobSubmittedException), err: |
2591 | a4af651e | Iustin Pop | result, err_msg = FormatError(err) |
2592 | 5bbd3f7f | Michael Hanselmann | logging.exception("Error during command processing")
|
2593 | 46fbdd04 | Iustin Pop | ToStderr(err_msg) |
2594 | 8a53b55f | Iustin Pop | except KeyboardInterrupt: |
2595 | 8a53b55f | Iustin Pop | result = constants.EXIT_FAILURE |
2596 | 8a53b55f | Iustin Pop | ToStderr("Aborted. Note that if the operation created any jobs, they"
|
2597 | 8a53b55f | Iustin Pop | " might have been submitted and"
|
2598 | 8a53b55f | Iustin Pop | " will continue to run in the background.")
|
2599 | 225e2544 | Iustin Pop | except IOError, err: |
2600 | 225e2544 | Iustin Pop | if err.errno == errno.EPIPE:
|
2601 | 225e2544 | Iustin Pop | # our terminal went away, we'll exit
|
2602 | 225e2544 | Iustin Pop | sys.exit(constants.EXIT_FAILURE) |
2603 | 225e2544 | Iustin Pop | else:
|
2604 | 225e2544 | Iustin Pop | raise
|
2605 | a8083063 | Iustin Pop | |
2606 | a8083063 | Iustin Pop | return result
|
2607 | 137161c9 | Michael Hanselmann | |
2608 | 137161c9 | Michael Hanselmann | |
2609 | 845c79d8 | Michael Hanselmann | def ParseNicOption(optvalue): |
2610 | 845c79d8 | Michael Hanselmann | """Parses the value of the --net option(s).
|
2611 | 845c79d8 | Michael Hanselmann |
|
2612 | 845c79d8 | Michael Hanselmann | """
|
2613 | 845c79d8 | Michael Hanselmann | try:
|
2614 | 845c79d8 | Michael Hanselmann | nic_max = max(int(nidx[0]) + 1 for nidx in optvalue) |
2615 | 845c79d8 | Michael Hanselmann | except (TypeError, ValueError), err: |
2616 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err), |
2617 | 2cfbc784 | Iustin Pop | errors.ECODE_INVAL) |
2618 | 845c79d8 | Michael Hanselmann | |
2619 | 845c79d8 | Michael Hanselmann | nics = [{}] * nic_max |
2620 | 845c79d8 | Michael Hanselmann | for nidx, ndict in optvalue: |
2621 | 845c79d8 | Michael Hanselmann | nidx = int(nidx)
|
2622 | 845c79d8 | Michael Hanselmann | |
2623 | 845c79d8 | Michael Hanselmann | if not isinstance(ndict, dict): |
2624 | 845c79d8 | Michael Hanselmann | raise errors.OpPrereqError("Invalid nic/%d value: expected dict," |
2625 | 2cfbc784 | Iustin Pop | " got %s" % (nidx, ndict), errors.ECODE_INVAL)
|
2626 | 845c79d8 | Michael Hanselmann | |
2627 | 845c79d8 | Michael Hanselmann | utils.ForceDictType(ndict, constants.INIC_PARAMS_TYPES) |
2628 | 845c79d8 | Michael Hanselmann | |
2629 | 845c79d8 | Michael Hanselmann | nics[nidx] = ndict |
2630 | 845c79d8 | Michael Hanselmann | |
2631 | 845c79d8 | Michael Hanselmann | return nics
|
2632 | 845c79d8 | Michael Hanselmann | |
2633 | 845c79d8 | Michael Hanselmann | |
2634 | 02a6b50a | Michele Tartara | def FixHvParams(hvparams): |
2635 | 02a6b50a | Michele Tartara | # In Ganeti 2.8.4 the separator for the usb_devices hvparam was changed from
|
2636 | 02a6b50a | Michele Tartara | # comma to space because commas cannot be accepted on the command line
|
2637 | 02a6b50a | Michele Tartara | # (they already act as the separator between different hvparams). Still,
|
2638 | 02a6b50a | Michele Tartara | # RAPI should be able to accept commas for backwards compatibility.
|
2639 | 02a6b50a | Michele Tartara | # Therefore, we convert spaces into commas here, and we keep the old
|
2640 | 02a6b50a | Michele Tartara | # parsing logic everywhere else.
|
2641 | 02a6b50a | Michele Tartara | try:
|
2642 | 02a6b50a | Michele Tartara | new_usb_devices = hvparams[constants.HV_USB_DEVICES].replace(" ", ",") |
2643 | 02a6b50a | Michele Tartara | hvparams[constants.HV_USB_DEVICES] = new_usb_devices |
2644 | 02a6b50a | Michele Tartara | except KeyError: |
2645 | 02a6b50a | Michele Tartara | #No usb_devices, no modification required
|
2646 | 02a6b50a | Michele Tartara | pass
|
2647 | 02a6b50a | Michele Tartara | |
2648 | 02a6b50a | Michele Tartara | |
2649 | d77490c5 | Iustin Pop | def GenericInstanceCreate(mode, opts, args): |
2650 | d77490c5 | Iustin Pop | """Add an instance to the cluster via either creation or import.
|
2651 | d77490c5 | Iustin Pop |
|
2652 | d77490c5 | Iustin Pop | @param mode: constants.INSTANCE_CREATE or constants.INSTANCE_IMPORT
|
2653 | d77490c5 | Iustin Pop | @param opts: the command line options selected by the user
|
2654 | d77490c5 | Iustin Pop | @type args: list
|
2655 | d77490c5 | Iustin Pop | @param args: should contain only one element, the new instance name
|
2656 | d77490c5 | Iustin Pop | @rtype: int
|
2657 | d77490c5 | Iustin Pop | @return: the desired exit code
|
2658 | d77490c5 | Iustin Pop |
|
2659 | d77490c5 | Iustin Pop | """
|
2660 | d77490c5 | Iustin Pop | instance = args[0]
|
2661 | d77490c5 | Iustin Pop | |
2662 | d77490c5 | Iustin Pop | (pnode, snode) = SplitNodeOption(opts.node) |
2663 | d77490c5 | Iustin Pop | |
2664 | d77490c5 | Iustin Pop | hypervisor = None
|
2665 | d77490c5 | Iustin Pop | hvparams = {} |
2666 | d77490c5 | Iustin Pop | if opts.hypervisor:
|
2667 | d77490c5 | Iustin Pop | hypervisor, hvparams = opts.hypervisor |
2668 | d77490c5 | Iustin Pop | |
2669 | d77490c5 | Iustin Pop | if opts.nics:
|
2670 | 845c79d8 | Michael Hanselmann | nics = ParseNicOption(opts.nics) |
2671 | d77490c5 | Iustin Pop | elif opts.no_nics:
|
2672 | d77490c5 | Iustin Pop | # no nics
|
2673 | d77490c5 | Iustin Pop | nics = [] |
2674 | 0af0f641 | Iustin Pop | elif mode == constants.INSTANCE_CREATE:
|
2675 | d77490c5 | Iustin Pop | # default of one nic, all auto
|
2676 | d77490c5 | Iustin Pop | nics = [{}] |
2677 | 0af0f641 | Iustin Pop | else:
|
2678 | 0af0f641 | Iustin Pop | # mode == import
|
2679 | 0af0f641 | Iustin Pop | nics = [] |
2680 | d77490c5 | Iustin Pop | |
2681 | d77490c5 | Iustin Pop | if opts.disk_template == constants.DT_DISKLESS:
|
2682 | d77490c5 | Iustin Pop | if opts.disks or opts.sd_size is not None: |
2683 | d77490c5 | Iustin Pop | raise errors.OpPrereqError("Diskless instance but disk" |
2684 | 2cfbc784 | Iustin Pop | " information passed", errors.ECODE_INVAL)
|
2685 | d77490c5 | Iustin Pop | disks = [] |
2686 | d77490c5 | Iustin Pop | else:
|
2687 | 9b12ed0f | Iustin Pop | if (not opts.disks and not opts.sd_size |
2688 | 9b12ed0f | Iustin Pop | and mode == constants.INSTANCE_CREATE):
|
2689 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("No disk information specified", |
2690 | 2cfbc784 | Iustin Pop | errors.ECODE_INVAL) |
2691 | d77490c5 | Iustin Pop | if opts.disks and opts.sd_size is not None: |
2692 | d77490c5 | Iustin Pop | raise errors.OpPrereqError("Please use either the '--disk' or" |
2693 | 2cfbc784 | Iustin Pop | " '-s' option", errors.ECODE_INVAL)
|
2694 | d77490c5 | Iustin Pop | if opts.sd_size is not None: |
2695 | ccfa86ba | Michael Hanselmann | opts.disks = [(0, {constants.IDISK_SIZE: opts.sd_size})]
|
2696 | 9b12ed0f | Iustin Pop | |
2697 | 9b12ed0f | Iustin Pop | if opts.disks:
|
2698 | 9b12ed0f | Iustin Pop | try:
|
2699 | 9b12ed0f | Iustin Pop | disk_max = max(int(didx[0]) + 1 for didx in opts.disks) |
2700 | 9b12ed0f | Iustin Pop | except ValueError, err: |
2701 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err), |
2702 | 2cfbc784 | Iustin Pop | errors.ECODE_INVAL) |
2703 | 9b12ed0f | Iustin Pop | disks = [{}] * disk_max |
2704 | 9b12ed0f | Iustin Pop | else:
|
2705 | 9b12ed0f | Iustin Pop | disks = [] |
2706 | d77490c5 | Iustin Pop | for didx, ddict in opts.disks: |
2707 | d77490c5 | Iustin Pop | didx = int(didx)
|
2708 | d77490c5 | Iustin Pop | if not isinstance(ddict, dict): |
2709 | d77490c5 | Iustin Pop | msg = "Invalid disk/%d value: expected dict, got %s" % (didx, ddict)
|
2710 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError(msg, errors.ECODE_INVAL)
|
2711 | ccfa86ba | Michael Hanselmann | elif constants.IDISK_SIZE in ddict: |
2712 | ccfa86ba | Michael Hanselmann | if constants.IDISK_ADOPT in ddict: |
2713 | 5029db65 | Iustin Pop | raise errors.OpPrereqError("Only one of 'size' and 'adopt' allowed" |
2714 | 2cfbc784 | Iustin Pop | " (disk %d)" % didx, errors.ECODE_INVAL)
|
2715 | 5029db65 | Iustin Pop | try:
|
2716 | ccfa86ba | Michael Hanselmann | ddict[constants.IDISK_SIZE] = \ |
2717 | ccfa86ba | Michael Hanselmann | utils.ParseUnit(ddict[constants.IDISK_SIZE]) |
2718 | 5029db65 | Iustin Pop | except ValueError, err: |
2719 | 5029db65 | Iustin Pop | raise errors.OpPrereqError("Invalid disk size for disk %d: %s" % |
2720 | 2cfbc784 | Iustin Pop | (didx, err), errors.ECODE_INVAL) |
2721 | ccfa86ba | Michael Hanselmann | elif constants.IDISK_ADOPT in ddict: |
2722 | c615590c | Bernardo Dal Seno | if constants.IDISK_SPINDLES in ddict: |
2723 | c615590c | Bernardo Dal Seno | raise errors.OpPrereqError("spindles is not a valid option when" |
2724 | c615590c | Bernardo Dal Seno | " adopting a disk", errors.ECODE_INVAL)
|
2725 | 5029db65 | Iustin Pop | if mode == constants.INSTANCE_IMPORT:
|
2726 | 5029db65 | Iustin Pop | raise errors.OpPrereqError("Disk adoption not allowed for instance" |
2727 | 2cfbc784 | Iustin Pop | " import", errors.ECODE_INVAL)
|
2728 | ccfa86ba | Michael Hanselmann | ddict[constants.IDISK_SIZE] = 0
|
2729 | 5029db65 | Iustin Pop | else:
|
2730 | 5029db65 | Iustin Pop | raise errors.OpPrereqError("Missing size or adoption source for" |
2731 | 2cfbc784 | Iustin Pop | " disk %d" % didx, errors.ECODE_INVAL)
|
2732 | d77490c5 | Iustin Pop | disks[didx] = ddict |
2733 | d77490c5 | Iustin Pop | |
2734 | a57981c5 | Apollon Oikonomopoulos | if opts.tags is not None: |
2735 | 0f8810df | Michael Hanselmann | tags = opts.tags.split(",")
|
2736 | a57981c5 | Apollon Oikonomopoulos | else:
|
2737 | a57981c5 | Apollon Oikonomopoulos | tags = [] |
2738 | a57981c5 | Apollon Oikonomopoulos | |
2739 | b2e233a5 | Guido Trotter | utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_COMPAT) |
2740 | d77490c5 | Iustin Pop | utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES) |
2741 | 02a6b50a | Michele Tartara | FixHvParams(hvparams) |
2742 | d77490c5 | Iustin Pop | |
2743 | d77490c5 | Iustin Pop | if mode == constants.INSTANCE_CREATE:
|
2744 | d77490c5 | Iustin Pop | start = opts.start |
2745 | d77490c5 | Iustin Pop | os_type = opts.os |
2746 | 1ee8e01a | Guido Trotter | force_variant = opts.force_variant |
2747 | d77490c5 | Iustin Pop | src_node = None
|
2748 | d77490c5 | Iustin Pop | src_path = None
|
2749 | 25a8792c | Iustin Pop | no_install = opts.no_install |
2750 | e588764d | Iustin Pop | identify_defaults = False
|
2751 | d77490c5 | Iustin Pop | elif mode == constants.INSTANCE_IMPORT:
|
2752 | d77490c5 | Iustin Pop | start = False
|
2753 | d77490c5 | Iustin Pop | os_type = None
|
2754 | 1ee8e01a | Guido Trotter | force_variant = False
|
2755 | d77490c5 | Iustin Pop | src_node = opts.src_node |
2756 | d77490c5 | Iustin Pop | src_path = opts.src_dir |
2757 | 25a8792c | Iustin Pop | no_install = None
|
2758 | e588764d | Iustin Pop | identify_defaults = opts.identify_defaults |
2759 | d77490c5 | Iustin Pop | else:
|
2760 | d77490c5 | Iustin Pop | raise errors.ProgrammerError("Invalid creation mode %s" % mode) |
2761 | d77490c5 | Iustin Pop | |
2762 | e1530b10 | Iustin Pop | op = opcodes.OpInstanceCreate(instance_name=instance, |
2763 | d77490c5 | Iustin Pop | disks=disks, |
2764 | d77490c5 | Iustin Pop | disk_template=opts.disk_template, |
2765 | d77490c5 | Iustin Pop | nics=nics, |
2766 | d4117a72 | Apollon Oikonomopoulos | conflicts_check=opts.conflicts_check, |
2767 | d77490c5 | Iustin Pop | pnode=pnode, snode=snode, |
2768 | d77490c5 | Iustin Pop | ip_check=opts.ip_check, |
2769 | 460d22be | Iustin Pop | name_check=opts.name_check, |
2770 | d77490c5 | Iustin Pop | wait_for_sync=opts.wait_for_sync, |
2771 | d77490c5 | Iustin Pop | file_storage_dir=opts.file_storage_dir, |
2772 | d77490c5 | Iustin Pop | file_driver=opts.file_driver, |
2773 | d77490c5 | Iustin Pop | iallocator=opts.iallocator, |
2774 | d77490c5 | Iustin Pop | hypervisor=hypervisor, |
2775 | d77490c5 | Iustin Pop | hvparams=hvparams, |
2776 | d77490c5 | Iustin Pop | beparams=opts.beparams, |
2777 | 062a7100 | Iustin Pop | osparams=opts.osparams, |
2778 | d77490c5 | Iustin Pop | mode=mode, |
2779 | d77490c5 | Iustin Pop | start=start, |
2780 | d77490c5 | Iustin Pop | os_type=os_type, |
2781 | 1ee8e01a | Guido Trotter | force_variant=force_variant, |
2782 | d77490c5 | Iustin Pop | src_node=src_node, |
2783 | 25a8792c | Iustin Pop | src_path=src_path, |
2784 | a57981c5 | Apollon Oikonomopoulos | tags=tags, |
2785 | e588764d | Iustin Pop | no_install=no_install, |
2786 | 10889e0c | René Nussbaumer | identify_defaults=identify_defaults, |
2787 | 10889e0c | René Nussbaumer | ignore_ipolicy=opts.ignore_ipolicy) |
2788 | d77490c5 | Iustin Pop | |
2789 | d77490c5 | Iustin Pop | SubmitOrSend(op, opts) |
2790 | d77490c5 | Iustin Pop | return 0 |
2791 | d77490c5 | Iustin Pop | |
2792 | d77490c5 | Iustin Pop | |
2793 | 876fb142 | Helga Velroyen | class _RunWhileClusterStoppedHelper(object): |
2794 | 7e49b6ce | Michael Hanselmann | """Helper class for L{RunWhileClusterStopped} to simplify state management
|
2795 | 7e49b6ce | Michael Hanselmann |
|
2796 | 7e49b6ce | Michael Hanselmann | """
|
2797 | 7e49b6ce | Michael Hanselmann | def __init__(self, feedback_fn, cluster_name, master_node, online_nodes): |
2798 | 7e49b6ce | Michael Hanselmann | """Initializes this class.
|
2799 | 7e49b6ce | Michael Hanselmann |
|
2800 | 7e49b6ce | Michael Hanselmann | @type feedback_fn: callable
|
2801 | 7e49b6ce | Michael Hanselmann | @param feedback_fn: Feedback function
|
2802 | 7e49b6ce | Michael Hanselmann | @type cluster_name: string
|
2803 | 7e49b6ce | Michael Hanselmann | @param cluster_name: Cluster name
|
2804 | 7e49b6ce | Michael Hanselmann | @type master_node: string
|
2805 | 7e49b6ce | Michael Hanselmann | @param master_node Master node name
|
2806 | 7e49b6ce | Michael Hanselmann | @type online_nodes: list
|
2807 | 7e49b6ce | Michael Hanselmann | @param online_nodes: List of names of online nodes
|
2808 | 7e49b6ce | Michael Hanselmann |
|
2809 | 7e49b6ce | Michael Hanselmann | """
|
2810 | 7e49b6ce | Michael Hanselmann | self.feedback_fn = feedback_fn
|
2811 | 7e49b6ce | Michael Hanselmann | self.cluster_name = cluster_name
|
2812 | 7e49b6ce | Michael Hanselmann | self.master_node = master_node
|
2813 | 7e49b6ce | Michael Hanselmann | self.online_nodes = online_nodes
|
2814 | 7e49b6ce | Michael Hanselmann | |
2815 | 7e49b6ce | Michael Hanselmann | self.ssh = ssh.SshRunner(self.cluster_name) |
2816 | 7e49b6ce | Michael Hanselmann | |
2817 | 7e49b6ce | Michael Hanselmann | self.nonmaster_nodes = [name for name in online_nodes |
2818 | 7e49b6ce | Michael Hanselmann | if name != master_node]
|
2819 | 7e49b6ce | Michael Hanselmann | |
2820 | 7e49b6ce | Michael Hanselmann | assert self.master_node not in self.nonmaster_nodes |
2821 | 7e49b6ce | Michael Hanselmann | |
2822 | 7e49b6ce | Michael Hanselmann | def _RunCmd(self, node_name, cmd): |
2823 | 7e49b6ce | Michael Hanselmann | """Runs a command on the local or a remote machine.
|
2824 | 7e49b6ce | Michael Hanselmann |
|
2825 | 7e49b6ce | Michael Hanselmann | @type node_name: string
|
2826 | 7e49b6ce | Michael Hanselmann | @param node_name: Machine name
|
2827 | 7e49b6ce | Michael Hanselmann | @type cmd: list
|
2828 | 7e49b6ce | Michael Hanselmann | @param cmd: Command
|
2829 | 7e49b6ce | Michael Hanselmann |
|
2830 | 7e49b6ce | Michael Hanselmann | """
|
2831 | 7e49b6ce | Michael Hanselmann | if node_name is None or node_name == self.master_node: |
2832 | 7e49b6ce | Michael Hanselmann | # No need to use SSH
|
2833 | 7e49b6ce | Michael Hanselmann | result = utils.RunCmd(cmd) |
2834 | 7e49b6ce | Michael Hanselmann | else:
|
2835 | 052783ff | Michael Hanselmann | result = self.ssh.Run(node_name, constants.SSH_LOGIN_USER,
|
2836 | 052783ff | Michael Hanselmann | utils.ShellQuoteArgs(cmd)) |
2837 | 7e49b6ce | Michael Hanselmann | |
2838 | 7e49b6ce | Michael Hanselmann | if result.failed:
|
2839 | 7e49b6ce | Michael Hanselmann | errmsg = ["Failed to run command %s" % result.cmd]
|
2840 | 7e49b6ce | Michael Hanselmann | if node_name:
|
2841 | 7e49b6ce | Michael Hanselmann | errmsg.append("on node %s" % node_name)
|
2842 | 7e49b6ce | Michael Hanselmann | errmsg.append(": exitcode %s and error %s" %
|
2843 | 7e49b6ce | Michael Hanselmann | (result.exit_code, result.output)) |
2844 | 7e49b6ce | Michael Hanselmann | raise errors.OpExecError(" ".join(errmsg)) |
2845 | 7e49b6ce | Michael Hanselmann | |
2846 | 7e49b6ce | Michael Hanselmann | def Call(self, fn, *args): |
2847 | 7e49b6ce | Michael Hanselmann | """Call function while all daemons are stopped.
|
2848 | 7e49b6ce | Michael Hanselmann |
|
2849 | 7e49b6ce | Michael Hanselmann | @type fn: callable
|
2850 | 7e49b6ce | Michael Hanselmann | @param fn: Function to be called
|
2851 | 7e49b6ce | Michael Hanselmann |
|
2852 | 7e49b6ce | Michael Hanselmann | """
|
2853 | 7e49b6ce | Michael Hanselmann | # Pause watcher by acquiring an exclusive lock on watcher state file
|
2854 | 7e49b6ce | Michael Hanselmann | self.feedback_fn("Blocking watcher") |
2855 | ee4a14c0 | Michael Hanselmann | watcher_block = utils.FileLock.Open(pathutils.WATCHER_LOCK_FILE) |
2856 | 7e49b6ce | Michael Hanselmann | try:
|
2857 | 7e49b6ce | Michael Hanselmann | # TODO: Currently, this just blocks. There's no timeout.
|
2858 | 7e49b6ce | Michael Hanselmann | # TODO: Should it be a shared lock?
|
2859 | 7e49b6ce | Michael Hanselmann | watcher_block.Exclusive(blocking=True)
|
2860 | 7e49b6ce | Michael Hanselmann | |
2861 | 7e49b6ce | Michael Hanselmann | # Stop master daemons, so that no new jobs can come in and all running
|
2862 | 7e49b6ce | Michael Hanselmann | # ones are finished
|
2863 | 7e49b6ce | Michael Hanselmann | self.feedback_fn("Stopping master daemons") |
2864 | ee4a14c0 | Michael Hanselmann | self._RunCmd(None, [pathutils.DAEMON_UTIL, "stop-master"]) |
2865 | 7e49b6ce | Michael Hanselmann | try:
|
2866 | 7e49b6ce | Michael Hanselmann | # Stop daemons on all nodes
|
2867 | 7e49b6ce | Michael Hanselmann | for node_name in self.online_nodes: |
2868 | 7e49b6ce | Michael Hanselmann | self.feedback_fn("Stopping daemons on %s" % node_name) |
2869 | ee4a14c0 | Michael Hanselmann | self._RunCmd(node_name, [pathutils.DAEMON_UTIL, "stop-all"]) |
2870 | 7e49b6ce | Michael Hanselmann | |
2871 | 7e49b6ce | Michael Hanselmann | # All daemons are shut down now
|
2872 | 7e49b6ce | Michael Hanselmann | try:
|
2873 | 7e49b6ce | Michael Hanselmann | return fn(self, *args) |
2874 | d512e84b | Michael Hanselmann | except Exception, err: |
2875 | d512e84b | Michael Hanselmann | _, errmsg = FormatError(err) |
2876 | 7e49b6ce | Michael Hanselmann | logging.exception("Caught exception")
|
2877 | d512e84b | Michael Hanselmann | self.feedback_fn(errmsg)
|
2878 | 7e49b6ce | Michael Hanselmann | raise
|
2879 | 7e49b6ce | Michael Hanselmann | finally:
|
2880 | 7e49b6ce | Michael Hanselmann | # Start cluster again, master node last
|
2881 | 7e49b6ce | Michael Hanselmann | for node_name in self.nonmaster_nodes + [self.master_node]: |
2882 | 7e49b6ce | Michael Hanselmann | self.feedback_fn("Starting daemons on %s" % node_name) |
2883 | ee4a14c0 | Michael Hanselmann | self._RunCmd(node_name, [pathutils.DAEMON_UTIL, "start-all"]) |
2884 | 7e49b6ce | Michael Hanselmann | finally:
|
2885 | 7e49b6ce | Michael Hanselmann | # Resume watcher
|
2886 | 7e49b6ce | Michael Hanselmann | watcher_block.Close() |
2887 | 7e49b6ce | Michael Hanselmann | |
2888 | 7e49b6ce | Michael Hanselmann | |
2889 | 7e49b6ce | Michael Hanselmann | def RunWhileClusterStopped(feedback_fn, fn, *args): |
2890 | 7e49b6ce | Michael Hanselmann | """Calls a function while all cluster daemons are stopped.
|
2891 | 7e49b6ce | Michael Hanselmann |
|
2892 | 7e49b6ce | Michael Hanselmann | @type feedback_fn: callable
|
2893 | 7e49b6ce | Michael Hanselmann | @param feedback_fn: Feedback function
|
2894 | 7e49b6ce | Michael Hanselmann | @type fn: callable
|
2895 | 7e49b6ce | Michael Hanselmann | @param fn: Function to be called when daemons are stopped
|
2896 | 7e49b6ce | Michael Hanselmann |
|
2897 | 7e49b6ce | Michael Hanselmann | """
|
2898 | 7e49b6ce | Michael Hanselmann | feedback_fn("Gathering cluster information")
|
2899 | 7e49b6ce | Michael Hanselmann | |
2900 | 7e49b6ce | Michael Hanselmann | # This ensures we're running on the master daemon
|
2901 | 7e49b6ce | Michael Hanselmann | cl = GetClient() |
2902 | 7e49b6ce | Michael Hanselmann | |
2903 | 7e49b6ce | Michael Hanselmann | (cluster_name, master_node) = \ |
2904 | 7e49b6ce | Michael Hanselmann | cl.QueryConfigValues(["cluster_name", "master_node"]) |
2905 | 7e49b6ce | Michael Hanselmann | |
2906 | 7e49b6ce | Michael Hanselmann | online_nodes = GetOnlineNodes([], cl=cl) |
2907 | 7e49b6ce | Michael Hanselmann | |
2908 | 7e49b6ce | Michael Hanselmann | # Don't keep a reference to the client. The master daemon will go away.
|
2909 | 7e49b6ce | Michael Hanselmann | del cl
|
2910 | 7e49b6ce | Michael Hanselmann | |
2911 | 7e49b6ce | Michael Hanselmann | assert master_node in online_nodes |
2912 | 7e49b6ce | Michael Hanselmann | |
2913 | 7e49b6ce | Michael Hanselmann | return _RunWhileClusterStoppedHelper(feedback_fn, cluster_name, master_node,
|
2914 | 7e49b6ce | Michael Hanselmann | online_nodes).Call(fn, *args) |
2915 | 7e49b6ce | Michael Hanselmann | |
2916 | 7e49b6ce | Michael Hanselmann | |
2917 | 16be8703 | Iustin Pop | def GenerateTable(headers, fields, separator, data, |
2918 | 9fbfbb7b | Iustin Pop | numfields=None, unitfields=None, |
2919 | 9fbfbb7b | Iustin Pop | units=None):
|
2920 | 137161c9 | Michael Hanselmann | """Prints a table with headers and different fields.
|
2921 | 137161c9 | Michael Hanselmann |
|
2922 | 9fbfbb7b | Iustin Pop | @type headers: dict
|
2923 | 9fbfbb7b | Iustin Pop | @param headers: dictionary mapping field names to headers for
|
2924 | 9fbfbb7b | Iustin Pop | the table
|
2925 | 9fbfbb7b | Iustin Pop | @type fields: list
|
2926 | 9fbfbb7b | Iustin Pop | @param fields: the field names corresponding to each row in
|
2927 | 9fbfbb7b | Iustin Pop | the data field
|
2928 | 9fbfbb7b | Iustin Pop | @param separator: the separator to be used; if this is None,
|
2929 | 9fbfbb7b | Iustin Pop | the default 'smart' algorithm is used which computes optimal
|
2930 | 9fbfbb7b | Iustin Pop | field width, otherwise just the separator is used between
|
2931 | 9fbfbb7b | Iustin Pop | each field
|
2932 | 9fbfbb7b | Iustin Pop | @type data: list
|
2933 | 9fbfbb7b | Iustin Pop | @param data: a list of lists, each sublist being one row to be output
|
2934 | 9fbfbb7b | Iustin Pop | @type numfields: list
|
2935 | 9fbfbb7b | Iustin Pop | @param numfields: a list with the fields that hold numeric
|
2936 | 9fbfbb7b | Iustin Pop | values and thus should be right-aligned
|
2937 | 9fbfbb7b | Iustin Pop | @type unitfields: list
|
2938 | 9fbfbb7b | Iustin Pop | @param unitfields: a list with the fields that hold numeric
|
2939 | 9fbfbb7b | Iustin Pop | values that should be formatted with the units field
|
2940 | 9fbfbb7b | Iustin Pop | @type units: string or None
|
2941 | 9fbfbb7b | Iustin Pop | @param units: the units we should use for formatting, or None for
|
2942 | 9fbfbb7b | Iustin Pop | automatic choice (human-readable for non-separator usage, otherwise
|
2943 | 9fbfbb7b | Iustin Pop | megabytes); this is a one-letter string
|
2944 | 137161c9 | Michael Hanselmann |
|
2945 | 137161c9 | Michael Hanselmann | """
|
2946 | 9fbfbb7b | Iustin Pop | if units is None: |
2947 | 9fbfbb7b | Iustin Pop | if separator:
|
2948 | 9fbfbb7b | Iustin Pop | units = "m"
|
2949 | 9fbfbb7b | Iustin Pop | else:
|
2950 | 9fbfbb7b | Iustin Pop | units = "h"
|
2951 | 9fbfbb7b | Iustin Pop | |
2952 | 137161c9 | Michael Hanselmann | if numfields is None: |
2953 | 137161c9 | Michael Hanselmann | numfields = [] |
2954 | 137161c9 | Michael Hanselmann | if unitfields is None: |
2955 | 137161c9 | Michael Hanselmann | unitfields = [] |
2956 | 137161c9 | Michael Hanselmann | |
2957 | b459a848 | Andrea Spadaccini | numfields = utils.FieldSet(*numfields) # pylint: disable=W0142
|
2958 | b459a848 | Andrea Spadaccini | unitfields = utils.FieldSet(*unitfields) # pylint: disable=W0142
|
2959 | 00430f8e | Iustin Pop | |
2960 | 137161c9 | Michael Hanselmann | format_fields = [] |
2961 | 137161c9 | Michael Hanselmann | for field in fields: |
2962 | 01ca31ae | Iustin Pop | if headers and field not in headers: |
2963 | ea5a5b74 | Guido Trotter | # TODO: handle better unknown fields (either revert to old
|
2964 | 71c1af58 | Iustin Pop | # style of raising exception, or deal more intelligently with
|
2965 | 71c1af58 | Iustin Pop | # variable fields)
|
2966 | 71c1af58 | Iustin Pop | headers[field] = field |
2967 | 137161c9 | Michael Hanselmann | if separator is not None: |
2968 | 137161c9 | Michael Hanselmann | format_fields.append("%s")
|
2969 | 00430f8e | Iustin Pop | elif numfields.Matches(field):
|
2970 | 137161c9 | Michael Hanselmann | format_fields.append("%*s")
|
2971 | 137161c9 | Michael Hanselmann | else:
|
2972 | 137161c9 | Michael Hanselmann | format_fields.append("%-*s")
|
2973 | 137161c9 | Michael Hanselmann | |
2974 | 137161c9 | Michael Hanselmann | if separator is None: |
2975 | 137161c9 | Michael Hanselmann | mlens = [0 for name in fields] |
2976 | d0c8c01d | Iustin Pop | format_str = " ".join(format_fields)
|
2977 | 137161c9 | Michael Hanselmann | else:
|
2978 | c04bc777 | Iustin Pop | format_str = separator.replace("%", "%%").join(format_fields) |
2979 | 137161c9 | Michael Hanselmann | |
2980 | 137161c9 | Michael Hanselmann | for row in data: |
2981 | dcbd6288 | Guido Trotter | if row is None: |
2982 | dcbd6288 | Guido Trotter | continue
|
2983 | 137161c9 | Michael Hanselmann | for idx, val in enumerate(row): |
2984 | 00430f8e | Iustin Pop | if unitfields.Matches(fields[idx]):
|
2985 | 137161c9 | Michael Hanselmann | try:
|
2986 | 137161c9 | Michael Hanselmann | val = int(val)
|
2987 | 691744c4 | Iustin Pop | except (TypeError, ValueError): |
2988 | 137161c9 | Michael Hanselmann | pass
|
2989 | 137161c9 | Michael Hanselmann | else:
|
2990 | 9fbfbb7b | Iustin Pop | val = row[idx] = utils.FormatUnit(val, units) |
2991 | 01ca31ae | Iustin Pop | val = row[idx] = str(val)
|
2992 | 137161c9 | Michael Hanselmann | if separator is None: |
2993 | 137161c9 | Michael Hanselmann | mlens[idx] = max(mlens[idx], len(val)) |
2994 | 137161c9 | Michael Hanselmann | |
2995 | 16be8703 | Iustin Pop | result = [] |
2996 | 137161c9 | Michael Hanselmann | if headers:
|
2997 | 137161c9 | Michael Hanselmann | args = [] |
2998 | 137161c9 | Michael Hanselmann | for idx, name in enumerate(fields): |
2999 | 137161c9 | Michael Hanselmann | hdr = headers[name] |
3000 | 137161c9 | Michael Hanselmann | if separator is None: |
3001 | 137161c9 | Michael Hanselmann | mlens[idx] = max(mlens[idx], len(hdr)) |
3002 | 137161c9 | Michael Hanselmann | args.append(mlens[idx]) |
3003 | 137161c9 | Michael Hanselmann | args.append(hdr) |
3004 | c04bc777 | Iustin Pop | result.append(format_str % tuple(args))
|
3005 | 137161c9 | Michael Hanselmann | |
3006 | ec39d63c | Michael Hanselmann | if separator is None: |
3007 | ec39d63c | Michael Hanselmann | assert len(mlens) == len(fields) |
3008 | ec39d63c | Michael Hanselmann | |
3009 | ec39d63c | Michael Hanselmann | if fields and not numfields.Matches(fields[-1]): |
3010 | ec39d63c | Michael Hanselmann | mlens[-1] = 0 |
3011 | ec39d63c | Michael Hanselmann | |
3012 | 137161c9 | Michael Hanselmann | for line in data: |
3013 | 137161c9 | Michael Hanselmann | args = [] |
3014 | dcbd6288 | Guido Trotter | if line is None: |
3015 | d0c8c01d | Iustin Pop | line = ["-" for _ in fields] |
3016 | f1501b3f | Michael Hanselmann | for idx in range(len(fields)): |
3017 | 137161c9 | Michael Hanselmann | if separator is None: |
3018 | 137161c9 | Michael Hanselmann | args.append(mlens[idx]) |
3019 | 137161c9 | Michael Hanselmann | args.append(line[idx]) |
3020 | c04bc777 | Iustin Pop | result.append(format_str % tuple(args))
|
3021 | 16be8703 | Iustin Pop | |
3022 | 16be8703 | Iustin Pop | return result
|
3023 | 3386e7a9 | Iustin Pop | |
3024 | 3386e7a9 | Iustin Pop | |
3025 | ee3aedff | Michael Hanselmann | def _FormatBool(value): |
3026 | ee3aedff | Michael Hanselmann | """Formats a boolean value as a string.
|
3027 | ee3aedff | Michael Hanselmann |
|
3028 | ee3aedff | Michael Hanselmann | """
|
3029 | ee3aedff | Michael Hanselmann | if value:
|
3030 | ee3aedff | Michael Hanselmann | return "Y" |
3031 | ee3aedff | Michael Hanselmann | return "N" |
3032 | ee3aedff | Michael Hanselmann | |
3033 | ee3aedff | Michael Hanselmann | |
3034 | ee3aedff | Michael Hanselmann | #: Default formatting for query results; (callback, align right)
|
3035 | ee3aedff | Michael Hanselmann | _DEFAULT_FORMAT_QUERY = { |
3036 | ee3aedff | Michael Hanselmann | constants.QFT_TEXT: (str, False), |
3037 | ee3aedff | Michael Hanselmann | constants.QFT_BOOL: (_FormatBool, False),
|
3038 | ee3aedff | Michael Hanselmann | constants.QFT_NUMBER: (str, True), |
3039 | ee3aedff | Michael Hanselmann | constants.QFT_TIMESTAMP: (utils.FormatTime, False),
|
3040 | ee3aedff | Michael Hanselmann | constants.QFT_OTHER: (str, False), |
3041 | ee3aedff | Michael Hanselmann | constants.QFT_UNKNOWN: (str, False), |
3042 | ee3aedff | Michael Hanselmann | } |
3043 | ee3aedff | Michael Hanselmann | |
3044 | ee3aedff | Michael Hanselmann | |
3045 | ee3aedff | Michael Hanselmann | def _GetColumnFormatter(fdef, override, unit): |
3046 | ee3aedff | Michael Hanselmann | """Returns formatting function for a field.
|
3047 | ee3aedff | Michael Hanselmann |
|
3048 | ee3aedff | Michael Hanselmann | @type fdef: L{objects.QueryFieldDefinition}
|
3049 | ee3aedff | Michael Hanselmann | @type override: dict
|
3050 | ee3aedff | Michael Hanselmann | @param override: Dictionary for overriding field formatting functions,
|
3051 | ee3aedff | Michael Hanselmann | indexed by field name, contents like L{_DEFAULT_FORMAT_QUERY}
|
3052 | ee3aedff | Michael Hanselmann | @type unit: string
|
3053 | ee3aedff | Michael Hanselmann | @param unit: Unit used for formatting fields of type L{constants.QFT_UNIT}
|
3054 | ee3aedff | Michael Hanselmann | @rtype: tuple; (callable, bool)
|
3055 | ee3aedff | Michael Hanselmann | @return: Returns the function to format a value (takes one parameter) and a
|
3056 | ee3aedff | Michael Hanselmann | boolean for aligning the value on the right-hand side
|
3057 | ee3aedff | Michael Hanselmann |
|
3058 | ee3aedff | Michael Hanselmann | """
|
3059 | ee3aedff | Michael Hanselmann | fmt = override.get(fdef.name, None)
|
3060 | ee3aedff | Michael Hanselmann | if fmt is not None: |
3061 | ee3aedff | Michael Hanselmann | return fmt
|
3062 | ee3aedff | Michael Hanselmann | |
3063 | ee3aedff | Michael Hanselmann | assert constants.QFT_UNIT not in _DEFAULT_FORMAT_QUERY |
3064 | ee3aedff | Michael Hanselmann | |
3065 | ee3aedff | Michael Hanselmann | if fdef.kind == constants.QFT_UNIT:
|
3066 | ee3aedff | Michael Hanselmann | # Can't keep this information in the static dictionary
|
3067 | ee3aedff | Michael Hanselmann | return (lambda value: utils.FormatUnit(value, unit), True) |
3068 | ee3aedff | Michael Hanselmann | |
3069 | ee3aedff | Michael Hanselmann | fmt = _DEFAULT_FORMAT_QUERY.get(fdef.kind, None)
|
3070 | ee3aedff | Michael Hanselmann | if fmt is not None: |
3071 | ee3aedff | Michael Hanselmann | return fmt
|
3072 | ee3aedff | Michael Hanselmann | |
3073 | ee3aedff | Michael Hanselmann | raise NotImplementedError("Can't format column type '%s'" % fdef.kind) |
3074 | ee3aedff | Michael Hanselmann | |
3075 | ee3aedff | Michael Hanselmann | |
3076 | 876fb142 | Helga Velroyen | class _QueryColumnFormatter(object): |
3077 | ee3aedff | Michael Hanselmann | """Callable class for formatting fields of a query.
|
3078 | ee3aedff | Michael Hanselmann |
|
3079 | ee3aedff | Michael Hanselmann | """
|
3080 | f0b1bafe | Iustin Pop | def __init__(self, fn, status_fn, verbose): |
3081 | ee3aedff | Michael Hanselmann | """Initializes this class.
|
3082 | ee3aedff | Michael Hanselmann |
|
3083 | ee3aedff | Michael Hanselmann | @type fn: callable
|
3084 | ee3aedff | Michael Hanselmann | @param fn: Formatting function
|
3085 | ee3aedff | Michael Hanselmann | @type status_fn: callable
|
3086 | ee3aedff | Michael Hanselmann | @param status_fn: Function to report fields' status
|
3087 | f0b1bafe | Iustin Pop | @type verbose: boolean
|
3088 | f0b1bafe | Iustin Pop | @param verbose: whether to use verbose field descriptions or not
|
3089 | ee3aedff | Michael Hanselmann |
|
3090 | ee3aedff | Michael Hanselmann | """
|
3091 | ee3aedff | Michael Hanselmann | self._fn = fn
|
3092 | ee3aedff | Michael Hanselmann | self._status_fn = status_fn
|
3093 | cbfa4f0f | Michael Hanselmann | self._verbose = verbose
|
3094 | ee3aedff | Michael Hanselmann | |
3095 | ee3aedff | Michael Hanselmann | def __call__(self, data): |
3096 | ee3aedff | Michael Hanselmann | """Returns a field's string representation.
|
3097 | ee3aedff | Michael Hanselmann |
|
3098 | ee3aedff | Michael Hanselmann | """
|
3099 | ee3aedff | Michael Hanselmann | (status, value) = data |
3100 | ee3aedff | Michael Hanselmann | |
3101 | ee3aedff | Michael Hanselmann | # Report status
|
3102 | ee3aedff | Michael Hanselmann | self._status_fn(status)
|
3103 | ee3aedff | Michael Hanselmann | |
3104 | cfb084ae | René Nussbaumer | if status == constants.RS_NORMAL:
|
3105 | ee3aedff | Michael Hanselmann | return self._fn(value) |
3106 | ee3aedff | Michael Hanselmann | |
3107 | ee3aedff | Michael Hanselmann | assert value is None, \ |
3108 | ee3aedff | Michael Hanselmann | "Found value %r for abnormal status %s" % (value, status)
|
3109 | ee3aedff | Michael Hanselmann | |
3110 | f2c6673d | Michael Hanselmann | return FormatResultError(status, self._verbose) |
3111 | ee3aedff | Michael Hanselmann | |
3112 | ee3aedff | Michael Hanselmann | |
3113 | f2c6673d | Michael Hanselmann | def FormatResultError(status, verbose): |
3114 | ae95e419 | René Nussbaumer | """Formats result status other than L{constants.RS_NORMAL}.
|
3115 | ee3aedff | Michael Hanselmann |
|
3116 | ae95e419 | René Nussbaumer | @param status: The result status
|
3117 | f2c6673d | Michael Hanselmann | @type verbose: boolean
|
3118 | f2c6673d | Michael Hanselmann | @param verbose: Whether to return the verbose text
|
3119 | ae95e419 | René Nussbaumer | @return: Text of result status
|
3120 | a6070ef7 | Michael Hanselmann |
|
3121 | ae95e419 | René Nussbaumer | """
|
3122 | ae95e419 | René Nussbaumer | assert status != constants.RS_NORMAL, \
|
3123 | cbfa4f0f | Michael Hanselmann | "FormatResultError called with status equal to constants.RS_NORMAL"
|
3124 | ae95e419 | René Nussbaumer | try:
|
3125 | cbfa4f0f | Michael Hanselmann | (verbose_text, normal_text) = constants.RSS_DESCRIPTION[status] |
3126 | ae95e419 | René Nussbaumer | except KeyError: |
3127 | ee3aedff | Michael Hanselmann | raise NotImplementedError("Unknown status %s" % status) |
3128 | cbfa4f0f | Michael Hanselmann | else:
|
3129 | cbfa4f0f | Michael Hanselmann | if verbose:
|
3130 | cbfa4f0f | Michael Hanselmann | return verbose_text
|
3131 | cbfa4f0f | Michael Hanselmann | return normal_text
|
3132 | ee3aedff | Michael Hanselmann | |
3133 | ee3aedff | Michael Hanselmann | |
3134 | ee3aedff | Michael Hanselmann | def FormatQueryResult(result, unit=None, format_override=None, separator=None, |
3135 | f0b1bafe | Iustin Pop | header=False, verbose=False): |
3136 | ee3aedff | Michael Hanselmann | """Formats data in L{objects.QueryResponse}.
|
3137 | ee3aedff | Michael Hanselmann |
|
3138 | ee3aedff | Michael Hanselmann | @type result: L{objects.QueryResponse}
|
3139 | ee3aedff | Michael Hanselmann | @param result: result of query operation
|
3140 | ee3aedff | Michael Hanselmann | @type unit: string
|
3141 | ee3aedff | Michael Hanselmann | @param unit: Unit used for formatting fields of type L{constants.QFT_UNIT},
|
3142 | 18009c1e | Iustin Pop | see L{utils.text.FormatUnit}
|
3143 | ee3aedff | Michael Hanselmann | @type format_override: dict
|
3144 | ee3aedff | Michael Hanselmann | @param format_override: Dictionary for overriding field formatting functions,
|
3145 | ee3aedff | Michael Hanselmann | indexed by field name, contents like L{_DEFAULT_FORMAT_QUERY}
|
3146 | ee3aedff | Michael Hanselmann | @type separator: string or None
|
3147 | ee3aedff | Michael Hanselmann | @param separator: String used to separate fields
|
3148 | ee3aedff | Michael Hanselmann | @type header: bool
|
3149 | ee3aedff | Michael Hanselmann | @param header: Whether to output header row
|
3150 | f0b1bafe | Iustin Pop | @type verbose: boolean
|
3151 | f0b1bafe | Iustin Pop | @param verbose: whether to use verbose field descriptions or not
|
3152 | ee3aedff | Michael Hanselmann |
|
3153 | ee3aedff | Michael Hanselmann | """
|
3154 | ee3aedff | Michael Hanselmann | if unit is None: |
3155 | ee3aedff | Michael Hanselmann | if separator:
|
3156 | ee3aedff | Michael Hanselmann | unit = "m"
|
3157 | ee3aedff | Michael Hanselmann | else:
|
3158 | ee3aedff | Michael Hanselmann | unit = "h"
|
3159 | ee3aedff | Michael Hanselmann | |
3160 | ee3aedff | Michael Hanselmann | if format_override is None: |
3161 | ee3aedff | Michael Hanselmann | format_override = {} |
3162 | ee3aedff | Michael Hanselmann | |
3163 | cfb084ae | René Nussbaumer | stats = dict.fromkeys(constants.RS_ALL, 0) |
3164 | ee3aedff | Michael Hanselmann | |
3165 | ee3aedff | Michael Hanselmann | def _RecordStatus(status): |
3166 | ee3aedff | Michael Hanselmann | if status in stats: |
3167 | ee3aedff | Michael Hanselmann | stats[status] += 1
|
3168 | ee3aedff | Michael Hanselmann | |
3169 | ee3aedff | Michael Hanselmann | columns = [] |
3170 | ee3aedff | Michael Hanselmann | for fdef in result.fields: |
3171 | ee3aedff | Michael Hanselmann | assert fdef.title and fdef.name |
3172 | ee3aedff | Michael Hanselmann | (fn, align_right) = _GetColumnFormatter(fdef, format_override, unit) |
3173 | ee3aedff | Michael Hanselmann | columns.append(TableColumn(fdef.title, |
3174 | f0b1bafe | Iustin Pop | _QueryColumnFormatter(fn, _RecordStatus, |
3175 | f0b1bafe | Iustin Pop | verbose), |
3176 | ee3aedff | Michael Hanselmann | align_right)) |
3177 | ee3aedff | Michael Hanselmann | |
3178 | ee3aedff | Michael Hanselmann | table = FormatTable(result.data, columns, header, separator) |
3179 | ee3aedff | Michael Hanselmann | |
3180 | ee3aedff | Michael Hanselmann | # Collect statistics
|
3181 | cfb084ae | René Nussbaumer | assert len(stats) == len(constants.RS_ALL) |
3182 | ee3aedff | Michael Hanselmann | assert compat.all(count >= 0 for count in stats.values()) |
3183 | ee3aedff | Michael Hanselmann | |
3184 | ee3aedff | Michael Hanselmann | # Determine overall status. If there was no data, unknown fields must be
|
3185 | ee3aedff | Michael Hanselmann | # detected via the field definitions.
|
3186 | cfb084ae | René Nussbaumer | if (stats[constants.RS_UNKNOWN] or |
3187 | ee3aedff | Michael Hanselmann | (not result.data and _GetUnknownFields(result.fields))): |
3188 | ee3aedff | Michael Hanselmann | status = QR_UNKNOWN |
3189 | ee3aedff | Michael Hanselmann | elif compat.any(count > 0 for key, count in stats.items() |
3190 | cfb084ae | René Nussbaumer | if key != constants.RS_NORMAL):
|
3191 | ee3aedff | Michael Hanselmann | status = QR_INCOMPLETE |
3192 | ee3aedff | Michael Hanselmann | else:
|
3193 | ee3aedff | Michael Hanselmann | status = QR_NORMAL |
3194 | ee3aedff | Michael Hanselmann | |
3195 | ee3aedff | Michael Hanselmann | return (status, table)
|
3196 | ee3aedff | Michael Hanselmann | |
3197 | ee3aedff | Michael Hanselmann | |
3198 | ee3aedff | Michael Hanselmann | def _GetUnknownFields(fdefs): |
3199 | ee3aedff | Michael Hanselmann | """Returns list of unknown fields included in C{fdefs}.
|
3200 | ee3aedff | Michael Hanselmann |
|
3201 | ee3aedff | Michael Hanselmann | @type fdefs: list of L{objects.QueryFieldDefinition}
|
3202 | ee3aedff | Michael Hanselmann |
|
3203 | ee3aedff | Michael Hanselmann | """
|
3204 | ee3aedff | Michael Hanselmann | return [fdef for fdef in fdefs |
3205 | ee3aedff | Michael Hanselmann | if fdef.kind == constants.QFT_UNKNOWN]
|
3206 | ee3aedff | Michael Hanselmann | |
3207 | ee3aedff | Michael Hanselmann | |
3208 | ee3aedff | Michael Hanselmann | def _WarnUnknownFields(fdefs): |
3209 | ee3aedff | Michael Hanselmann | """Prints a warning to stderr if a query included unknown fields.
|
3210 | ee3aedff | Michael Hanselmann |
|
3211 | ee3aedff | Michael Hanselmann | @type fdefs: list of L{objects.QueryFieldDefinition}
|
3212 | ee3aedff | Michael Hanselmann |
|
3213 | ee3aedff | Michael Hanselmann | """
|
3214 | ee3aedff | Michael Hanselmann | unknown = _GetUnknownFields(fdefs) |
3215 | ee3aedff | Michael Hanselmann | if unknown:
|
3216 | ee3aedff | Michael Hanselmann | ToStderr("Warning: Queried for unknown fields %s",
|
3217 | ee3aedff | Michael Hanselmann | utils.CommaJoin(fdef.name for fdef in unknown)) |
3218 | ee3aedff | Michael Hanselmann | return True |
3219 | ee3aedff | Michael Hanselmann | |
3220 | ee3aedff | Michael Hanselmann | return False |
3221 | ee3aedff | Michael Hanselmann | |
3222 | ee3aedff | Michael Hanselmann | |
3223 | ee3aedff | Michael Hanselmann | def GenericList(resource, fields, names, unit, separator, header, cl=None, |
3224 | 03ec545a | Michael Hanselmann | format_override=None, verbose=False, force_filter=False, |
3225 | 6f287cf3 | Iustin Pop | namefield=None, qfilter=None, isnumeric=False): |
3226 | ee3aedff | Michael Hanselmann | """Generic implementation for listing all items of a resource.
|
3227 | ee3aedff | Michael Hanselmann |
|
3228 | abd66bf8 | Michael Hanselmann | @param resource: One of L{constants.QR_VIA_LUXI}
|
3229 | ee3aedff | Michael Hanselmann | @type fields: list of strings
|
3230 | ee3aedff | Michael Hanselmann | @param fields: List of fields to query for
|
3231 | ee3aedff | Michael Hanselmann | @type names: list of strings
|
3232 | ee3aedff | Michael Hanselmann | @param names: Names of items to query for
|
3233 | ee3aedff | Michael Hanselmann | @type unit: string or None
|
3234 | ee3aedff | Michael Hanselmann | @param unit: Unit used for formatting fields of type L{constants.QFT_UNIT} or
|
3235 | ee3aedff | Michael Hanselmann | None for automatic choice (human-readable for non-separator usage,
|
3236 | ee3aedff | Michael Hanselmann | otherwise megabytes); this is a one-letter string
|
3237 | ee3aedff | Michael Hanselmann | @type separator: string or None
|
3238 | ee3aedff | Michael Hanselmann | @param separator: String used to separate fields
|
3239 | ee3aedff | Michael Hanselmann | @type header: bool
|
3240 | ee3aedff | Michael Hanselmann | @param header: Whether to show header row
|
3241 | 2928de47 | Michael Hanselmann | @type force_filter: bool
|
3242 | 2928de47 | Michael Hanselmann | @param force_filter: Whether to always treat names as filter
|
3243 | ee3aedff | Michael Hanselmann | @type format_override: dict
|
3244 | ee3aedff | Michael Hanselmann | @param format_override: Dictionary for overriding field formatting functions,
|
3245 | ee3aedff | Michael Hanselmann | indexed by field name, contents like L{_DEFAULT_FORMAT_QUERY}
|
3246 | f0b1bafe | Iustin Pop | @type verbose: boolean
|
3247 | f0b1bafe | Iustin Pop | @param verbose: whether to use verbose field descriptions or not
|
3248 | 03ec545a | Michael Hanselmann | @type namefield: string
|
3249 | 03ec545a | Michael Hanselmann | @param namefield: Name of field to use for simple filters (see
|
3250 | 03ec545a | Michael Hanselmann | L{qlang.MakeFilter} for details)
|
3251 | f037e9d7 | Michael Hanselmann | @type qfilter: list or None
|
3252 | f037e9d7 | Michael Hanselmann | @param qfilter: Query filter (in addition to names)
|
3253 | 6f287cf3 | Iustin Pop | @param isnumeric: bool
|
3254 | 6f287cf3 | Iustin Pop | @param isnumeric: Whether the namefield's type is numeric, and therefore
|
3255 | 6f287cf3 | Iustin Pop | any simple filters built by namefield should use integer values to
|
3256 | 6f287cf3 | Iustin Pop | reflect that
|
3257 | ee3aedff | Michael Hanselmann |
|
3258 | ee3aedff | Michael Hanselmann | """
|
3259 | ee3aedff | Michael Hanselmann | if not names: |
3260 | ee3aedff | Michael Hanselmann | names = None
|
3261 | ee3aedff | Michael Hanselmann | |
3262 | 6f287cf3 | Iustin Pop | namefilter = qlang.MakeFilter(names, force_filter, namefield=namefield, |
3263 | 6f287cf3 | Iustin Pop | isnumeric=isnumeric) |
3264 | f037e9d7 | Michael Hanselmann | |
3265 | f037e9d7 | Michael Hanselmann | if qfilter is None: |
3266 | f037e9d7 | Michael Hanselmann | qfilter = namefilter |
3267 | f037e9d7 | Michael Hanselmann | elif namefilter is not None: |
3268 | f037e9d7 | Michael Hanselmann | qfilter = [qlang.OP_AND, namefilter, qfilter] |
3269 | 2928de47 | Michael Hanselmann | |
3270 | 727274dd | Iustin Pop | if cl is None: |
3271 | 727274dd | Iustin Pop | cl = GetClient() |
3272 | 727274dd | Iustin Pop | |
3273 | 2e5c33db | Iustin Pop | response = cl.Query(resource, fields, qfilter) |
3274 | ee3aedff | Michael Hanselmann | |
3275 | ee3aedff | Michael Hanselmann | found_unknown = _WarnUnknownFields(response.fields) |
3276 | ee3aedff | Michael Hanselmann | |
3277 | ee3aedff | Michael Hanselmann | (status, data) = FormatQueryResult(response, unit=unit, separator=separator, |
3278 | ee3aedff | Michael Hanselmann | header=header, |
3279 | f0b1bafe | Iustin Pop | format_override=format_override, |
3280 | f0b1bafe | Iustin Pop | verbose=verbose) |
3281 | ee3aedff | Michael Hanselmann | |
3282 | ee3aedff | Michael Hanselmann | for line in data: |
3283 | ee3aedff | Michael Hanselmann | ToStdout(line) |
3284 | ee3aedff | Michael Hanselmann | |
3285 | ee3aedff | Michael Hanselmann | assert ((found_unknown and status == QR_UNKNOWN) or |
3286 | ee3aedff | Michael Hanselmann | (not found_unknown and status != QR_UNKNOWN)) |
3287 | ee3aedff | Michael Hanselmann | |
3288 | ee3aedff | Michael Hanselmann | if status == QR_UNKNOWN:
|
3289 | ee3aedff | Michael Hanselmann | return constants.EXIT_UNKNOWN_FIELD
|
3290 | ee3aedff | Michael Hanselmann | |
3291 | ee3aedff | Michael Hanselmann | # TODO: Should the list command fail if not all data could be collected?
|
3292 | ee3aedff | Michael Hanselmann | return constants.EXIT_SUCCESS
|
3293 | ee3aedff | Michael Hanselmann | |
3294 | ee3aedff | Michael Hanselmann | |
3295 | c1912a48 | Michael Hanselmann | def _FieldDescValues(fdef): |
3296 | c1912a48 | Michael Hanselmann | """Helper function for L{GenericListFields} to get query field description.
|
3297 | c1912a48 | Michael Hanselmann |
|
3298 | c1912a48 | Michael Hanselmann | @type fdef: L{objects.QueryFieldDefinition}
|
3299 | c1912a48 | Michael Hanselmann | @rtype: list
|
3300 | c1912a48 | Michael Hanselmann |
|
3301 | c1912a48 | Michael Hanselmann | """
|
3302 | c1912a48 | Michael Hanselmann | return [
|
3303 | c1912a48 | Michael Hanselmann | fdef.name, |
3304 | c1912a48 | Michael Hanselmann | _QFT_NAMES.get(fdef.kind, fdef.kind), |
3305 | c1912a48 | Michael Hanselmann | fdef.title, |
3306 | c1912a48 | Michael Hanselmann | fdef.doc, |
3307 | c1912a48 | Michael Hanselmann | ] |
3308 | c1912a48 | Michael Hanselmann | |
3309 | c1912a48 | Michael Hanselmann | |
3310 | ee3aedff | Michael Hanselmann | def GenericListFields(resource, fields, separator, header, cl=None): |
3311 | ee3aedff | Michael Hanselmann | """Generic implementation for listing fields for a resource.
|
3312 | ee3aedff | Michael Hanselmann |
|
3313 | abd66bf8 | Michael Hanselmann | @param resource: One of L{constants.QR_VIA_LUXI}
|
3314 | ee3aedff | Michael Hanselmann | @type fields: list of strings
|
3315 | ee3aedff | Michael Hanselmann | @param fields: List of fields to query for
|
3316 | ee3aedff | Michael Hanselmann | @type separator: string or None
|
3317 | ee3aedff | Michael Hanselmann | @param separator: String used to separate fields
|
3318 | ee3aedff | Michael Hanselmann | @type header: bool
|
3319 | ee3aedff | Michael Hanselmann | @param header: Whether to show header row
|
3320 | ee3aedff | Michael Hanselmann |
|
3321 | ee3aedff | Michael Hanselmann | """
|
3322 | ee3aedff | Michael Hanselmann | if cl is None: |
3323 | ee3aedff | Michael Hanselmann | cl = GetClient() |
3324 | ee3aedff | Michael Hanselmann | |
3325 | ee3aedff | Michael Hanselmann | if not fields: |
3326 | ee3aedff | Michael Hanselmann | fields = None
|
3327 | ee3aedff | Michael Hanselmann | |
3328 | ee3aedff | Michael Hanselmann | response = cl.QueryFields(resource, fields) |
3329 | ee3aedff | Michael Hanselmann | |
3330 | ee3aedff | Michael Hanselmann | found_unknown = _WarnUnknownFields(response.fields) |
3331 | ee3aedff | Michael Hanselmann | |
3332 | ee3aedff | Michael Hanselmann | columns = [ |
3333 | ee3aedff | Michael Hanselmann | TableColumn("Name", str, False), |
3334 | c1912a48 | Michael Hanselmann | TableColumn("Type", str, False), |
3335 | ee3aedff | Michael Hanselmann | TableColumn("Title", str, False), |
3336 | ea1440c1 | Michael Hanselmann | TableColumn("Description", str, False), |
3337 | ee3aedff | Michael Hanselmann | ] |
3338 | ee3aedff | Michael Hanselmann | |
3339 | c1912a48 | Michael Hanselmann | rows = map(_FieldDescValues, response.fields)
|
3340 | ee3aedff | Michael Hanselmann | |
3341 | ee3aedff | Michael Hanselmann | for line in FormatTable(rows, columns, header, separator): |
3342 | ee3aedff | Michael Hanselmann | ToStdout(line) |
3343 | ee3aedff | Michael Hanselmann | |
3344 | ee3aedff | Michael Hanselmann | if found_unknown:
|
3345 | ee3aedff | Michael Hanselmann | return constants.EXIT_UNKNOWN_FIELD
|
3346 | ee3aedff | Michael Hanselmann | |
3347 | ee3aedff | Michael Hanselmann | return constants.EXIT_SUCCESS
|
3348 | ee3aedff | Michael Hanselmann | |
3349 | ee3aedff | Michael Hanselmann | |
3350 | 876fb142 | Helga Velroyen | class TableColumn(object): |
3351 | ee3aedff | Michael Hanselmann | """Describes a column for L{FormatTable}.
|
3352 | ee3aedff | Michael Hanselmann |
|
3353 | ee3aedff | Michael Hanselmann | """
|
3354 | ee3aedff | Michael Hanselmann | def __init__(self, title, fn, align_right): |
3355 | ee3aedff | Michael Hanselmann | """Initializes this class.
|
3356 | ee3aedff | Michael Hanselmann |
|
3357 | ee3aedff | Michael Hanselmann | @type title: string
|
3358 | ee3aedff | Michael Hanselmann | @param title: Column title
|
3359 | ee3aedff | Michael Hanselmann | @type fn: callable
|
3360 | ee3aedff | Michael Hanselmann | @param fn: Formatting function
|
3361 | ee3aedff | Michael Hanselmann | @type align_right: bool
|
3362 | ee3aedff | Michael Hanselmann | @param align_right: Whether to align values on the right-hand side
|
3363 | ee3aedff | Michael Hanselmann |
|
3364 | ee3aedff | Michael Hanselmann | """
|
3365 | ee3aedff | Michael Hanselmann | self.title = title
|
3366 | ee3aedff | Michael Hanselmann | self.format = fn
|
3367 | ee3aedff | Michael Hanselmann | self.align_right = align_right
|
3368 | ee3aedff | Michael Hanselmann | |
3369 | ee3aedff | Michael Hanselmann | |
3370 | ee3aedff | Michael Hanselmann | def _GetColFormatString(width, align_right): |
3371 | ee3aedff | Michael Hanselmann | """Returns the format string for a field.
|
3372 | ee3aedff | Michael Hanselmann |
|
3373 | ee3aedff | Michael Hanselmann | """
|
3374 | ee3aedff | Michael Hanselmann | if align_right:
|
3375 | ee3aedff | Michael Hanselmann | sign = ""
|
3376 | ee3aedff | Michael Hanselmann | else:
|
3377 | ee3aedff | Michael Hanselmann | sign = "-"
|
3378 | ee3aedff | Michael Hanselmann | |
3379 | ee3aedff | Michael Hanselmann | return "%%%s%ss" % (sign, width) |
3380 | ee3aedff | Michael Hanselmann | |
3381 | ee3aedff | Michael Hanselmann | |
3382 | ee3aedff | Michael Hanselmann | def FormatTable(rows, columns, header, separator): |
3383 | ee3aedff | Michael Hanselmann | """Formats data as a table.
|
3384 | ee3aedff | Michael Hanselmann |
|
3385 | ee3aedff | Michael Hanselmann | @type rows: list of lists
|
3386 | ee3aedff | Michael Hanselmann | @param rows: Row data, one list per row
|
3387 | ee3aedff | Michael Hanselmann | @type columns: list of L{TableColumn}
|
3388 | ee3aedff | Michael Hanselmann | @param columns: Column descriptions
|
3389 | ee3aedff | Michael Hanselmann | @type header: bool
|
3390 | ee3aedff | Michael Hanselmann | @param header: Whether to show header row
|
3391 | ee3aedff | Michael Hanselmann | @type separator: string or None
|
3392 | ee3aedff | Michael Hanselmann | @param separator: String used to separate columns
|
3393 | ee3aedff | Michael Hanselmann |
|
3394 | ee3aedff | Michael Hanselmann | """
|
3395 | ee3aedff | Michael Hanselmann | if header:
|
3396 | ee3aedff | Michael Hanselmann | data = [[col.title for col in columns]] |
3397 | ee3aedff | Michael Hanselmann | colwidth = [len(col.title) for col in columns] |
3398 | ee3aedff | Michael Hanselmann | else:
|
3399 | ee3aedff | Michael Hanselmann | data = [] |
3400 | ee3aedff | Michael Hanselmann | colwidth = [0 for _ in columns] |
3401 | ee3aedff | Michael Hanselmann | |
3402 | ee3aedff | Michael Hanselmann | # Format row data
|
3403 | ee3aedff | Michael Hanselmann | for row in rows: |
3404 | ee3aedff | Michael Hanselmann | assert len(row) == len(columns) |
3405 | ee3aedff | Michael Hanselmann | |
3406 | ee3aedff | Michael Hanselmann | formatted = [col.format(value) for value, col in zip(row, columns)] |
3407 | ee3aedff | Michael Hanselmann | |
3408 | ee3aedff | Michael Hanselmann | if separator is None: |
3409 | ee3aedff | Michael Hanselmann | # Update column widths
|
3410 | ee3aedff | Michael Hanselmann | for idx, (oldwidth, value) in enumerate(zip(colwidth, formatted)): |
3411 | ee3aedff | Michael Hanselmann | # Modifying a list's items while iterating is fine
|
3412 | ee3aedff | Michael Hanselmann | colwidth[idx] = max(oldwidth, len(value)) |
3413 | ee3aedff | Michael Hanselmann | |
3414 | ee3aedff | Michael Hanselmann | data.append(formatted) |
3415 | ee3aedff | Michael Hanselmann | |
3416 | ee3aedff | Michael Hanselmann | if separator is not None: |
3417 | ee3aedff | Michael Hanselmann | # Return early if a separator is used
|
3418 | ee3aedff | Michael Hanselmann | return [separator.join(row) for row in data] |
3419 | ee3aedff | Michael Hanselmann | |
3420 | ee3aedff | Michael Hanselmann | if columns and not columns[-1].align_right: |
3421 | ee3aedff | Michael Hanselmann | # Avoid unnecessary spaces at end of line
|
3422 | ee3aedff | Michael Hanselmann | colwidth[-1] = 0 |
3423 | ee3aedff | Michael Hanselmann | |
3424 | ee3aedff | Michael Hanselmann | # Build format string
|
3425 | ee3aedff | Michael Hanselmann | fmt = " ".join([_GetColFormatString(width, col.align_right)
|
3426 | ee3aedff | Michael Hanselmann | for col, width in zip(columns, colwidth)]) |
3427 | ee3aedff | Michael Hanselmann | |
3428 | ee3aedff | Michael Hanselmann | return [fmt % tuple(row) for row in data] |
3429 | ee3aedff | Michael Hanselmann | |
3430 | ee3aedff | Michael Hanselmann | |
3431 | 3386e7a9 | Iustin Pop | def FormatTimestamp(ts): |
3432 | 3386e7a9 | Iustin Pop | """Formats a given timestamp.
|
3433 | 3386e7a9 | Iustin Pop |
|
3434 | 3386e7a9 | Iustin Pop | @type ts: timestamp
|
3435 | 3386e7a9 | Iustin Pop | @param ts: a timeval-type timestamp, a tuple of seconds and microseconds
|
3436 | 3386e7a9 | Iustin Pop |
|
3437 | 3386e7a9 | Iustin Pop | @rtype: string
|
3438 | 5fcc718f | Iustin Pop | @return: a string with the formatted timestamp
|
3439 | 3386e7a9 | Iustin Pop |
|
3440 | 3386e7a9 | Iustin Pop | """
|
3441 | e687ec01 | Michael Hanselmann | if not isinstance(ts, (tuple, list)) or len(ts) != 2: |
3442 | d0c8c01d | Iustin Pop | return "?" |
3443 | 26a72a48 | Michael Hanselmann | |
3444 | 26a72a48 | Michael Hanselmann | (sec, usecs) = ts |
3445 | 26a72a48 | Michael Hanselmann | return utils.FormatTime(sec, usecs=usecs)
|
3446 | 2241e2b9 | Iustin Pop | |
3447 | 2241e2b9 | Iustin Pop | |
3448 | 2241e2b9 | Iustin Pop | def ParseTimespec(value): |
3449 | 2241e2b9 | Iustin Pop | """Parse a time specification.
|
3450 | 2241e2b9 | Iustin Pop |
|
3451 | 2241e2b9 | Iustin Pop | The following suffixed will be recognized:
|
3452 | 2241e2b9 | Iustin Pop |
|
3453 | 2241e2b9 | Iustin Pop | - s: seconds
|
3454 | 2241e2b9 | Iustin Pop | - m: minutes
|
3455 | 2241e2b9 | Iustin Pop | - h: hours
|
3456 | 2241e2b9 | Iustin Pop | - d: day
|
3457 | 2241e2b9 | Iustin Pop | - w: weeks
|
3458 | 2241e2b9 | Iustin Pop |
|
3459 | 2241e2b9 | Iustin Pop | Without any suffix, the value will be taken to be in seconds.
|
3460 | 2241e2b9 | Iustin Pop |
|
3461 | 2241e2b9 | Iustin Pop | """
|
3462 | 2241e2b9 | Iustin Pop | value = str(value)
|
3463 | 2241e2b9 | Iustin Pop | if not value: |
3464 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("Empty time specification passed", |
3465 | 2cfbc784 | Iustin Pop | errors.ECODE_INVAL) |
3466 | 2241e2b9 | Iustin Pop | suffix_map = { |
3467 | d0c8c01d | Iustin Pop | "s": 1, |
3468 | d0c8c01d | Iustin Pop | "m": 60, |
3469 | d0c8c01d | Iustin Pop | "h": 3600, |
3470 | d0c8c01d | Iustin Pop | "d": 86400, |
3471 | d0c8c01d | Iustin Pop | "w": 604800, |
3472 | 2241e2b9 | Iustin Pop | } |
3473 | 2241e2b9 | Iustin Pop | if value[-1] not in suffix_map: |
3474 | 2241e2b9 | Iustin Pop | try:
|
3475 | 2241e2b9 | Iustin Pop | value = int(value)
|
3476 | 691744c4 | Iustin Pop | except (TypeError, ValueError): |
3477 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("Invalid time specification '%s'" % value, |
3478 | 2cfbc784 | Iustin Pop | errors.ECODE_INVAL) |
3479 | 2241e2b9 | Iustin Pop | else:
|
3480 | 2241e2b9 | Iustin Pop | multiplier = suffix_map[value[-1]]
|
3481 | 2241e2b9 | Iustin Pop | value = value[:-1]
|
3482 | 2241e2b9 | Iustin Pop | if not value: # no data left after stripping the suffix |
3483 | 2241e2b9 | Iustin Pop | raise errors.OpPrereqError("Invalid time specification (only" |
3484 | 2cfbc784 | Iustin Pop | " suffix passed)", errors.ECODE_INVAL)
|
3485 | 2241e2b9 | Iustin Pop | try:
|
3486 | 2241e2b9 | Iustin Pop | value = int(value) * multiplier
|
3487 | 691744c4 | Iustin Pop | except (TypeError, ValueError): |
3488 | 2cfbc784 | Iustin Pop | raise errors.OpPrereqError("Invalid time specification '%s'" % value, |
3489 | 2cfbc784 | Iustin Pop | errors.ECODE_INVAL) |
3490 | 2241e2b9 | Iustin Pop | return value
|
3491 | 46fbdd04 | Iustin Pop | |
3492 | 46fbdd04 | Iustin Pop | |
3493 | e9e26bb3 | Iustin Pop | def GetOnlineNodes(nodes, cl=None, nowarn=False, secondary_ips=False, |
3494 | 05484a24 | Michael Hanselmann | filter_master=False, nodegroup=None): |
3495 | 4040a784 | Iustin Pop | """Returns the names of online nodes.
|
3496 | 4040a784 | Iustin Pop |
|
3497 | 4040a784 | Iustin Pop | This function will also log a warning on stderr with the names of
|
3498 | 4040a784 | Iustin Pop | the online nodes.
|
3499 | 4040a784 | Iustin Pop |
|
3500 | 4040a784 | Iustin Pop | @param nodes: if not empty, use only this subset of nodes (minus the
|
3501 | 4040a784 | Iustin Pop | offline ones)
|
3502 | 4040a784 | Iustin Pop | @param cl: if not None, luxi client to use
|
3503 | 4040a784 | Iustin Pop | @type nowarn: boolean
|
3504 | 4040a784 | Iustin Pop | @param nowarn: by default, this function will output a note with the
|
3505 | 4040a784 | Iustin Pop | offline nodes that are skipped; if this parameter is True the
|
3506 | 4040a784 | Iustin Pop | note is not displayed
|
3507 | e9e26bb3 | Iustin Pop | @type secondary_ips: boolean
|
3508 | e9e26bb3 | Iustin Pop | @param secondary_ips: if True, return the secondary IPs instead of the
|
3509 | e9e26bb3 | Iustin Pop | names, useful for doing network traffic over the replication interface
|
3510 | e9e26bb3 | Iustin Pop | (if any)
|
3511 | e9e26bb3 | Iustin Pop | @type filter_master: boolean
|
3512 | e9e26bb3 | Iustin Pop | @param filter_master: if True, do not return the master node in the list
|
3513 | e9e26bb3 | Iustin Pop | (useful in coordination with secondary_ips where we cannot check our
|
3514 | e9e26bb3 | Iustin Pop | node name against the list)
|
3515 | 05484a24 | Michael Hanselmann | @type nodegroup: string
|
3516 | 05484a24 | Michael Hanselmann | @param nodegroup: If set, only return nodes in this node group
|
3517 | 4040a784 | Iustin Pop |
|
3518 | 4040a784 | Iustin Pop | """
|
3519 | 4040a784 | Iustin Pop | if cl is None: |
3520 | 4040a784 | Iustin Pop | cl = GetClient() |
3521 | 4040a784 | Iustin Pop | |
3522 | 2e5c33db | Iustin Pop | qfilter = [] |
3523 | 05484a24 | Michael Hanselmann | |
3524 | 05484a24 | Michael Hanselmann | if nodes:
|
3525 | 2e5c33db | Iustin Pop | qfilter.append(qlang.MakeSimpleFilter("name", nodes))
|
3526 | 05484a24 | Michael Hanselmann | |
3527 | 05484a24 | Michael Hanselmann | if nodegroup is not None: |
3528 | 2e5c33db | Iustin Pop | qfilter.append([qlang.OP_OR, [qlang.OP_EQUAL, "group", nodegroup],
|
3529 | 05484a24 | Michael Hanselmann | [qlang.OP_EQUAL, "group.uuid", nodegroup]])
|
3530 | e9e26bb3 | Iustin Pop | |
3531 | e9e26bb3 | Iustin Pop | if filter_master:
|
3532 | 2e5c33db | Iustin Pop | qfilter.append([qlang.OP_NOT, [qlang.OP_TRUE, "master"]])
|
3533 | 05484a24 | Michael Hanselmann | |
3534 | 2e5c33db | Iustin Pop | if qfilter:
|
3535 | 2e5c33db | Iustin Pop | if len(qfilter) > 1: |
3536 | 2e5c33db | Iustin Pop | final_filter = [qlang.OP_AND] + qfilter |
3537 | 05484a24 | Michael Hanselmann | else:
|
3538 | 2e5c33db | Iustin Pop | assert len(qfilter) == 1 |
3539 | 2e5c33db | Iustin Pop | final_filter = qfilter[0]
|
3540 | e9e26bb3 | Iustin Pop | else:
|
3541 | 05484a24 | Michael Hanselmann | final_filter = None
|
3542 | 05484a24 | Michael Hanselmann | |
3543 | 05484a24 | Michael Hanselmann | result = cl.Query(constants.QR_NODE, ["name", "offline", "sip"], final_filter) |
3544 | 05484a24 | Michael Hanselmann | |
3545 | 05484a24 | Michael Hanselmann | def _IsOffline(row): |
3546 | 05484a24 | Michael Hanselmann | (_, (_, offline), _) = row |
3547 | 05484a24 | Michael Hanselmann | return offline
|
3548 | 05484a24 | Michael Hanselmann | |
3549 | 05484a24 | Michael Hanselmann | def _GetName(row): |
3550 | 05484a24 | Michael Hanselmann | ((_, name), _, _) = row |
3551 | 05484a24 | Michael Hanselmann | return name
|
3552 | 05484a24 | Michael Hanselmann | |
3553 | 05484a24 | Michael Hanselmann | def _GetSip(row): |
3554 | 05484a24 | Michael Hanselmann | (_, _, (_, sip)) = row |
3555 | 05484a24 | Michael Hanselmann | return sip
|
3556 | 05484a24 | Michael Hanselmann | |
3557 | 05484a24 | Michael Hanselmann | (offline, online) = compat.partition(result.data, _IsOffline) |
3558 | e9e26bb3 | Iustin Pop | |
3559 | 4040a784 | Iustin Pop | if offline and not nowarn: |
3560 | 05484a24 | Michael Hanselmann | ToStderr("Note: skipping offline node(s): %s" %
|
3561 | 05484a24 | Michael Hanselmann | utils.CommaJoin(map(_GetName, offline)))
|
3562 | 05484a24 | Michael Hanselmann | |
3563 | 05484a24 | Michael Hanselmann | if secondary_ips:
|
3564 | 05484a24 | Michael Hanselmann | fn = _GetSip |
3565 | 05484a24 | Michael Hanselmann | else:
|
3566 | 05484a24 | Michael Hanselmann | fn = _GetName |
3567 | 05484a24 | Michael Hanselmann | |
3568 | 05484a24 | Michael Hanselmann | return map(fn, online) |
3569 | 4040a784 | Iustin Pop | |
3570 | 4040a784 | Iustin Pop | |
3571 | 46fbdd04 | Iustin Pop | def _ToStream(stream, txt, *args): |
3572 | 46fbdd04 | Iustin Pop | """Write a message to a stream, bypassing the logging system
|
3573 | 46fbdd04 | Iustin Pop |
|
3574 | 46fbdd04 | Iustin Pop | @type stream: file object
|
3575 | 46fbdd04 | Iustin Pop | @param stream: the file to which we should write
|
3576 | 46fbdd04 | Iustin Pop | @type txt: str
|
3577 | 46fbdd04 | Iustin Pop | @param txt: the message
|
3578 | 46fbdd04 | Iustin Pop |
|
3579 | 46fbdd04 | Iustin Pop | """
|
3580 | 225e2544 | Iustin Pop | try:
|
3581 | 225e2544 | Iustin Pop | if args:
|
3582 | 225e2544 | Iustin Pop | args = tuple(args)
|
3583 | 225e2544 | Iustin Pop | stream.write(txt % args) |
3584 | 225e2544 | Iustin Pop | else:
|
3585 | 225e2544 | Iustin Pop | stream.write(txt) |
3586 | d0c8c01d | Iustin Pop | stream.write("\n")
|
3587 | 225e2544 | Iustin Pop | stream.flush() |
3588 | 225e2544 | Iustin Pop | except IOError, err: |
3589 | 225e2544 | Iustin Pop | if err.errno == errno.EPIPE:
|
3590 | 225e2544 | Iustin Pop | # our terminal went away, we'll exit
|
3591 | 225e2544 | Iustin Pop | sys.exit(constants.EXIT_FAILURE) |
3592 | 225e2544 | Iustin Pop | else:
|
3593 | 225e2544 | Iustin Pop | raise
|
3594 | 46fbdd04 | Iustin Pop | |
3595 | 46fbdd04 | Iustin Pop | |
3596 | 46fbdd04 | Iustin Pop | def ToStdout(txt, *args): |
3597 | 46fbdd04 | Iustin Pop | """Write a message to stdout only, bypassing the logging system
|
3598 | 46fbdd04 | Iustin Pop |
|
3599 | 46fbdd04 | Iustin Pop | This is just a wrapper over _ToStream.
|
3600 | 46fbdd04 | Iustin Pop |
|
3601 | 46fbdd04 | Iustin Pop | @type txt: str
|
3602 | 46fbdd04 | Iustin Pop | @param txt: the message
|
3603 | 46fbdd04 | Iustin Pop |
|
3604 | 46fbdd04 | Iustin Pop | """
|
3605 | 46fbdd04 | Iustin Pop | _ToStream(sys.stdout, txt, *args) |
3606 | 46fbdd04 | Iustin Pop | |
3607 | 46fbdd04 | Iustin Pop | |
3608 | 46fbdd04 | Iustin Pop | def ToStderr(txt, *args): |
3609 | 46fbdd04 | Iustin Pop | """Write a message to stderr only, bypassing the logging system
|
3610 | 46fbdd04 | Iustin Pop |
|
3611 | 46fbdd04 | Iustin Pop | This is just a wrapper over _ToStream.
|
3612 | 46fbdd04 | Iustin Pop |
|
3613 | 46fbdd04 | Iustin Pop | @type txt: str
|
3614 | 46fbdd04 | Iustin Pop | @param txt: the message
|
3615 | 46fbdd04 | Iustin Pop |
|
3616 | 46fbdd04 | Iustin Pop | """
|
3617 | 46fbdd04 | Iustin Pop | _ToStream(sys.stderr, txt, *args) |
3618 | 479636a3 | Iustin Pop | |
3619 | 479636a3 | Iustin Pop | |
3620 | 479636a3 | Iustin Pop | class JobExecutor(object): |
3621 | 479636a3 | Iustin Pop | """Class which manages the submission and execution of multiple jobs.
|
3622 | 479636a3 | Iustin Pop |
|
3623 | 479636a3 | Iustin Pop | Note that instances of this class should not be reused between
|
3624 | 479636a3 | Iustin Pop | GetResults() calls.
|
3625 | 479636a3 | Iustin Pop |
|
3626 | 479636a3 | Iustin Pop | """
|
3627 | 919ca415 | Iustin Pop | def __init__(self, cl=None, verbose=True, opts=None, feedback_fn=None): |
3628 | 479636a3 | Iustin Pop | self.queue = []
|
3629 | 479636a3 | Iustin Pop | if cl is None: |
3630 | 479636a3 | Iustin Pop | cl = GetClient() |
3631 | 479636a3 | Iustin Pop | self.cl = cl
|
3632 | 479636a3 | Iustin Pop | self.verbose = verbose
|
3633 | 23b4b983 | Iustin Pop | self.jobs = []
|
3634 | cff5fa7f | Iustin Pop | self.opts = opts
|
3635 | 919ca415 | Iustin Pop | self.feedback_fn = feedback_fn
|
3636 | 60452edf | Michael Hanselmann | self._counter = itertools.count()
|
3637 | 479636a3 | Iustin Pop | |
3638 | 8d99a8bf | Michael Hanselmann | @staticmethod
|
3639 | 8d99a8bf | Michael Hanselmann | def _IfName(name, fmt): |
3640 | 8d99a8bf | Michael Hanselmann | """Helper function for formatting name.
|
3641 | 8d99a8bf | Michael Hanselmann |
|
3642 | 8d99a8bf | Michael Hanselmann | """
|
3643 | 8d99a8bf | Michael Hanselmann | if name:
|
3644 | 8d99a8bf | Michael Hanselmann | return fmt % name
|
3645 | 8d99a8bf | Michael Hanselmann | |
3646 | 8d99a8bf | Michael Hanselmann | return "" |
3647 | 8d99a8bf | Michael Hanselmann | |
3648 | 479636a3 | Iustin Pop | def QueueJob(self, name, *ops): |
3649 | 23b4b983 | Iustin Pop | """Record a job for later submit.
|
3650 | 479636a3 | Iustin Pop |
|
3651 | 479636a3 | Iustin Pop | @type name: string
|
3652 | 479636a3 | Iustin Pop | @param name: a description of the job, will be used in WaitJobSet
|
3653 | 8d99a8bf | Michael Hanselmann |
|
3654 | 479636a3 | Iustin Pop | """
|
3655 | cff5fa7f | Iustin Pop | SetGenericOpcodeOpts(ops, self.opts)
|
3656 | 60452edf | Michael Hanselmann | self.queue.append((self._counter.next(), name, ops)) |
3657 | 23b4b983 | Iustin Pop | |
3658 | 8d99a8bf | Michael Hanselmann | def AddJobId(self, name, status, job_id): |
3659 | 8d99a8bf | Michael Hanselmann | """Adds a job ID to the internal queue.
|
3660 | 8d99a8bf | Michael Hanselmann |
|
3661 | 8d99a8bf | Michael Hanselmann | """
|
3662 | 8d99a8bf | Michael Hanselmann | self.jobs.append((self._counter.next(), status, job_id, name)) |
3663 | 8d99a8bf | Michael Hanselmann | |
3664 | 66ecc479 | Guido Trotter | def SubmitPending(self, each=False): |
3665 | 23b4b983 | Iustin Pop | """Submit all pending jobs.
|
3666 | 23b4b983 | Iustin Pop |
|
3667 | 23b4b983 | Iustin Pop | """
|
3668 | 66ecc479 | Guido Trotter | if each:
|
3669 | 66ecc479 | Guido Trotter | results = [] |
3670 | 60452edf | Michael Hanselmann | for (_, _, ops) in self.queue: |
3671 | 66ecc479 | Guido Trotter | # SubmitJob will remove the success status, but raise an exception if
|
3672 | 66ecc479 | Guido Trotter | # the submission fails, so we'll notice that anyway.
|
3673 | 519fafa1 | Andrea Spadaccini | results.append([True, self.cl.SubmitJob(ops)[0]]) |
3674 | 66ecc479 | Guido Trotter | else:
|
3675 | 60452edf | Michael Hanselmann | results = self.cl.SubmitManyJobs([ops for (_, _, ops) in self.queue]) |
3676 | 60452edf | Michael Hanselmann | for ((status, data), (idx, name, _)) in zip(results, self.queue): |
3677 | 5299e61f | Iustin Pop | self.jobs.append((idx, status, data, name))
|
3678 | 5299e61f | Iustin Pop | |
3679 | 5299e61f | Iustin Pop | def _ChooseJob(self): |
3680 | 5299e61f | Iustin Pop | """Choose a non-waiting/queued job to poll next.
|
3681 | 5299e61f | Iustin Pop |
|
3682 | 5299e61f | Iustin Pop | """
|
3683 | 5299e61f | Iustin Pop | assert self.jobs, "_ChooseJob called with empty job list" |
3684 | 5299e61f | Iustin Pop | |
3685 | 11705e3d | Iustin Pop | result = self.cl.QueryJobs([i[2] for i in self.jobs[:_CHOOSE_BATCH]], |
3686 | 11705e3d | Iustin Pop | ["status"])
|
3687 | 5299e61f | Iustin Pop | assert result
|
3688 | 5299e61f | Iustin Pop | |
3689 | 5299e61f | Iustin Pop | for job_data, status in zip(self.jobs, result): |
3690 | 91c622a8 | Iustin Pop | if (isinstance(status, list) and status and |
3691 | 91c622a8 | Iustin Pop | status[0] in (constants.JOB_STATUS_QUEUED, |
3692 | 47099cd1 | Michael Hanselmann | constants.JOB_STATUS_WAITING, |
3693 | 91c622a8 | Iustin Pop | constants.JOB_STATUS_CANCELING)): |
3694 | 91c622a8 | Iustin Pop | # job is still present and waiting
|
3695 | 5299e61f | Iustin Pop | continue
|
3696 | 91c622a8 | Iustin Pop | # good candidate found (either running job or lost job)
|
3697 | 5299e61f | Iustin Pop | self.jobs.remove(job_data)
|
3698 | 5299e61f | Iustin Pop | return job_data
|
3699 | 5299e61f | Iustin Pop | |
3700 | 5299e61f | Iustin Pop | # no job found
|
3701 | 5299e61f | Iustin Pop | return self.jobs.pop(0) |
3702 | 479636a3 | Iustin Pop | |
3703 | 479636a3 | Iustin Pop | def GetResults(self): |
3704 | 479636a3 | Iustin Pop | """Wait for and return the results of all jobs.
|
3705 | 479636a3 | Iustin Pop |
|
3706 | 479636a3 | Iustin Pop | @rtype: list
|
3707 | 479636a3 | Iustin Pop | @return: list of tuples (success, job results), in the same order
|
3708 | 479636a3 | Iustin Pop | as the submitted jobs; if a job has failed, instead of the result
|
3709 | 479636a3 | Iustin Pop | there will be the error message
|
3710 | 479636a3 | Iustin Pop |
|
3711 | 479636a3 | Iustin Pop | """
|
3712 | 23b4b983 | Iustin Pop | if not self.jobs: |
3713 | 23b4b983 | Iustin Pop | self.SubmitPending()
|
3714 | 479636a3 | Iustin Pop | results = [] |
3715 | 479636a3 | Iustin Pop | if self.verbose: |
3716 | 5299e61f | Iustin Pop | ok_jobs = [row[2] for row in self.jobs if row[1]] |
3717 | 23b4b983 | Iustin Pop | if ok_jobs:
|
3718 | 4474f112 | Iustin Pop | ToStdout("Submitted jobs %s", utils.CommaJoin(ok_jobs))
|
3719 | 5299e61f | Iustin Pop | |
3720 | 5299e61f | Iustin Pop | # first, remove any non-submitted jobs
|
3721 | cea881e5 | Michael Hanselmann | self.jobs, failures = compat.partition(self.jobs, lambda x: x[1]) |
3722 | 5299e61f | Iustin Pop | for idx, _, jid, name in failures: |
3723 | 4474f112 | Iustin Pop | ToStderr("Failed to submit job%s: %s", self._IfName(name, " for %s"), jid) |
3724 | c63355f2 | Iustin Pop | results.append((idx, False, jid))
|
3725 | 5299e61f | Iustin Pop | |
3726 | 5299e61f | Iustin Pop | while self.jobs: |
3727 | 5299e61f | Iustin Pop | (idx, _, jid, name) = self._ChooseJob()
|
3728 | 4474f112 | Iustin Pop | ToStdout("Waiting for job %s%s ...", jid, self._IfName(name, " for %s")) |
3729 | 479636a3 | Iustin Pop | try:
|
3730 | 919ca415 | Iustin Pop | job_result = PollJob(jid, cl=self.cl, feedback_fn=self.feedback_fn) |
3731 | 479636a3 | Iustin Pop | success = True
|
3732 | 91c622a8 | Iustin Pop | except errors.JobLost, err:
|
3733 | 91c622a8 | Iustin Pop | _, job_result = FormatError(err) |
3734 | 4474f112 | Iustin Pop | ToStderr("Job %s%s has been archived, cannot check its result",
|
3735 | 4474f112 | Iustin Pop | jid, self._IfName(name, " for %s")) |
3736 | 91c622a8 | Iustin Pop | success = False
|
3737 | 479636a3 | Iustin Pop | except (errors.GenericError, luxi.ProtocolError), err:
|
3738 | 479636a3 | Iustin Pop | _, job_result = FormatError(err) |
3739 | 479636a3 | Iustin Pop | success = False
|
3740 | 479636a3 | Iustin Pop | # the error message will always be shown, verbose or not
|
3741 | 4474f112 | Iustin Pop | ToStderr("Job %s%s has failed: %s",
|
3742 | 4474f112 | Iustin Pop | jid, self._IfName(name, " for %s"), job_result) |
3743 | 479636a3 | Iustin Pop | |
3744 | 5299e61f | Iustin Pop | results.append((idx, success, job_result)) |
3745 | 5299e61f | Iustin Pop | |
3746 | 5299e61f | Iustin Pop | # sort based on the index, then drop it
|
3747 | 5299e61f | Iustin Pop | results.sort() |
3748 | 5299e61f | Iustin Pop | results = [i[1:] for i in results] |
3749 | 5299e61f | Iustin Pop | |
3750 | 479636a3 | Iustin Pop | return results
|
3751 | 479636a3 | Iustin Pop | |
3752 | 479636a3 | Iustin Pop | def WaitOrShow(self, wait): |
3753 | 479636a3 | Iustin Pop | """Wait for job results or only print the job IDs.
|
3754 | 479636a3 | Iustin Pop |
|
3755 | 479636a3 | Iustin Pop | @type wait: boolean
|
3756 | 479636a3 | Iustin Pop | @param wait: whether to wait or not
|
3757 | 479636a3 | Iustin Pop |
|
3758 | 479636a3 | Iustin Pop | """
|
3759 | 479636a3 | Iustin Pop | if wait:
|
3760 | 479636a3 | Iustin Pop | return self.GetResults() |
3761 | 479636a3 | Iustin Pop | else:
|
3762 | 23b4b983 | Iustin Pop | if not self.jobs: |
3763 | 23b4b983 | Iustin Pop | self.SubmitPending()
|
3764 | 71834b2a | Guido Trotter | for _, status, result, name in self.jobs: |
3765 | 23b4b983 | Iustin Pop | if status:
|
3766 | 4474f112 | Iustin Pop | ToStdout("%s: %s", result, name)
|
3767 | 23b4b983 | Iustin Pop | else:
|
3768 | 4474f112 | Iustin Pop | ToStderr("Failure for %s: %s", name, result)
|
3769 | 53a8a54d | Iustin Pop | return [row[1:3] for row in self.jobs] |
3770 | acd19189 | René Nussbaumer | |
3771 | acd19189 | René Nussbaumer | |
3772 | 4d99964c | Bernardo Dal Seno | def FormatParamsDictInfo(param_dict, actual): |
3773 | 4d99964c | Bernardo Dal Seno | """Formats a parameter dictionary.
|
3774 | 4d99964c | Bernardo Dal Seno |
|
3775 | 4d99964c | Bernardo Dal Seno | @type param_dict: dict
|
3776 | 4d99964c | Bernardo Dal Seno | @param param_dict: the own parameters
|
3777 | 4d99964c | Bernardo Dal Seno | @type actual: dict
|
3778 | 4d99964c | Bernardo Dal Seno | @param actual: the current parameter set (including defaults)
|
3779 | 4d99964c | Bernardo Dal Seno | @rtype: dict
|
3780 | 4d99964c | Bernardo Dal Seno | @return: dictionary where the value of each parameter is either a fully
|
3781 | 4d99964c | Bernardo Dal Seno | formatted string or a dictionary containing formatted strings
|
3782 | 4d99964c | Bernardo Dal Seno |
|
3783 | 4d99964c | Bernardo Dal Seno | """
|
3784 | 4d99964c | Bernardo Dal Seno | ret = {} |
3785 | 4d99964c | Bernardo Dal Seno | for (key, data) in actual.items(): |
3786 | 4d99964c | Bernardo Dal Seno | if isinstance(data, dict) and data: |
3787 | 4d99964c | Bernardo Dal Seno | ret[key] = FormatParamsDictInfo(param_dict.get(key, {}), data) |
3788 | 4d99964c | Bernardo Dal Seno | else:
|
3789 | 4d99964c | Bernardo Dal Seno | ret[key] = str(param_dict.get(key, "default (%s)" % data)) |
3790 | 4d99964c | Bernardo Dal Seno | return ret
|
3791 | 4d99964c | Bernardo Dal Seno | |
3792 | 4d99964c | Bernardo Dal Seno | |
3793 | d00884a2 | Bernardo Dal Seno | def _FormatListInfoDefault(data, def_data): |
3794 | d00884a2 | Bernardo Dal Seno | if data is not None: |
3795 | d00884a2 | Bernardo Dal Seno | ret = utils.CommaJoin(data) |
3796 | d00884a2 | Bernardo Dal Seno | else:
|
3797 | d00884a2 | Bernardo Dal Seno | ret = "default (%s)" % utils.CommaJoin(def_data)
|
3798 | d00884a2 | Bernardo Dal Seno | return ret
|
3799 | d00884a2 | Bernardo Dal Seno | |
3800 | d00884a2 | Bernardo Dal Seno | |
3801 | d00884a2 | Bernardo Dal Seno | def FormatPolicyInfo(custom_ipolicy, eff_ipolicy, iscluster): |
3802 | d00884a2 | Bernardo Dal Seno | """Formats an instance policy.
|
3803 | d00884a2 | Bernardo Dal Seno |
|
3804 | d00884a2 | Bernardo Dal Seno | @type custom_ipolicy: dict
|
3805 | d00884a2 | Bernardo Dal Seno | @param custom_ipolicy: own policy
|
3806 | d00884a2 | Bernardo Dal Seno | @type eff_ipolicy: dict
|
3807 | d00884a2 | Bernardo Dal Seno | @param eff_ipolicy: effective policy (including defaults); ignored for
|
3808 | d00884a2 | Bernardo Dal Seno | cluster
|
3809 | d00884a2 | Bernardo Dal Seno | @type iscluster: bool
|
3810 | d00884a2 | Bernardo Dal Seno | @param iscluster: the policy is at cluster level
|
3811 | d00884a2 | Bernardo Dal Seno | @rtype: list of pairs
|
3812 | d00884a2 | Bernardo Dal Seno | @return: formatted data, suitable for L{PrintGenericInfo}
|
3813 | d00884a2 | Bernardo Dal Seno |
|
3814 | d00884a2 | Bernardo Dal Seno | """
|
3815 | d00884a2 | Bernardo Dal Seno | if iscluster:
|
3816 | d00884a2 | Bernardo Dal Seno | eff_ipolicy = custom_ipolicy |
3817 | d00884a2 | Bernardo Dal Seno | |
3818 | 41044e04 | Bernardo Dal Seno | minmax_out = [] |
3819 | 41044e04 | Bernardo Dal Seno | custom_minmax = custom_ipolicy.get(constants.ISPECS_MINMAX) |
3820 | 41044e04 | Bernardo Dal Seno | if custom_minmax:
|
3821 | 41044e04 | Bernardo Dal Seno | for (k, minmax) in enumerate(custom_minmax): |
3822 | 41044e04 | Bernardo Dal Seno | minmax_out.append([ |
3823 | 41044e04 | Bernardo Dal Seno | ("%s/%s" % (key, k),
|
3824 | 41044e04 | Bernardo Dal Seno | FormatParamsDictInfo(minmax[key], minmax[key])) |
3825 | 41044e04 | Bernardo Dal Seno | for key in constants.ISPECS_MINMAX_KEYS |
3826 | 41044e04 | Bernardo Dal Seno | ]) |
3827 | 41044e04 | Bernardo Dal Seno | else:
|
3828 | 41044e04 | Bernardo Dal Seno | for (k, minmax) in enumerate(eff_ipolicy[constants.ISPECS_MINMAX]): |
3829 | 41044e04 | Bernardo Dal Seno | minmax_out.append([ |
3830 | 41044e04 | Bernardo Dal Seno | ("%s/%s" % (key, k),
|
3831 | 41044e04 | Bernardo Dal Seno | FormatParamsDictInfo({}, minmax[key])) |
3832 | 41044e04 | Bernardo Dal Seno | for key in constants.ISPECS_MINMAX_KEYS |
3833 | 41044e04 | Bernardo Dal Seno | ]) |
3834 | 41044e04 | Bernardo Dal Seno | ret = [("bounds specs", minmax_out)]
|
3835 | 41044e04 | Bernardo Dal Seno | |
3836 | d00884a2 | Bernardo Dal Seno | if iscluster:
|
3837 | d00884a2 | Bernardo Dal Seno | stdspecs = custom_ipolicy[constants.ISPECS_STD] |
3838 | d00884a2 | Bernardo Dal Seno | ret.append( |
3839 | d00884a2 | Bernardo Dal Seno | (constants.ISPECS_STD, |
3840 | d00884a2 | Bernardo Dal Seno | FormatParamsDictInfo(stdspecs, stdspecs)) |
3841 | d00884a2 | Bernardo Dal Seno | ) |
3842 | d00884a2 | Bernardo Dal Seno | |
3843 | d00884a2 | Bernardo Dal Seno | ret.append( |
3844 | 9db0b351 | Bernardo Dal Seno | ("allowed disk templates",
|
3845 | d00884a2 | Bernardo Dal Seno | _FormatListInfoDefault(custom_ipolicy.get(constants.IPOLICY_DTS), |
3846 | d00884a2 | Bernardo Dal Seno | eff_ipolicy[constants.IPOLICY_DTS])) |
3847 | d00884a2 | Bernardo Dal Seno | ) |
3848 | d00884a2 | Bernardo Dal Seno | ret.extend([ |
3849 | d00884a2 | Bernardo Dal Seno | (key, str(custom_ipolicy.get(key, "default (%s)" % eff_ipolicy[key]))) |
3850 | d00884a2 | Bernardo Dal Seno | for key in constants.IPOLICY_PARAMETERS |
3851 | d00884a2 | Bernardo Dal Seno | ]) |
3852 | d00884a2 | Bernardo Dal Seno | return ret
|
3853 | d00884a2 | Bernardo Dal Seno | |
3854 | d00884a2 | Bernardo Dal Seno | |
3855 | ea9d3b40 | Bernardo Dal Seno | def _PrintSpecsParameters(buf, specs): |
3856 | ea9d3b40 | Bernardo Dal Seno | values = ("%s=%s" % (par, val) for (par, val) in sorted(specs.items())) |
3857 | ea9d3b40 | Bernardo Dal Seno | buf.write(",".join(values))
|
3858 | ea9d3b40 | Bernardo Dal Seno | |
3859 | ea9d3b40 | Bernardo Dal Seno | |
3860 | ea9d3b40 | Bernardo Dal Seno | def PrintIPolicyCommand(buf, ipolicy, isgroup): |
3861 | ea9d3b40 | Bernardo Dal Seno | """Print the command option used to generate the given instance policy.
|
3862 | ea9d3b40 | Bernardo Dal Seno |
|
3863 | ea9d3b40 | Bernardo Dal Seno | Currently only the parts dealing with specs are supported.
|
3864 | ea9d3b40 | Bernardo Dal Seno |
|
3865 | ea9d3b40 | Bernardo Dal Seno | @type buf: StringIO
|
3866 | ea9d3b40 | Bernardo Dal Seno | @param buf: stream to write into
|
3867 | ea9d3b40 | Bernardo Dal Seno | @type ipolicy: dict
|
3868 | ea9d3b40 | Bernardo Dal Seno | @param ipolicy: instance policy
|
3869 | ea9d3b40 | Bernardo Dal Seno | @type isgroup: bool
|
3870 | ea9d3b40 | Bernardo Dal Seno | @param isgroup: whether the policy is at group level
|
3871 | ea9d3b40 | Bernardo Dal Seno |
|
3872 | ea9d3b40 | Bernardo Dal Seno | """
|
3873 | ea9d3b40 | Bernardo Dal Seno | if not isgroup: |
3874 | ea9d3b40 | Bernardo Dal Seno | stdspecs = ipolicy.get("std")
|
3875 | ea9d3b40 | Bernardo Dal Seno | if stdspecs:
|
3876 | ea9d3b40 | Bernardo Dal Seno | buf.write(" %s " % IPOLICY_STD_SPECS_STR)
|
3877 | ea9d3b40 | Bernardo Dal Seno | _PrintSpecsParameters(buf, stdspecs) |
3878 | ef99e3e8 | Bernardo Dal Seno | minmaxes = ipolicy.get("minmax", [])
|
3879 | ef99e3e8 | Bernardo Dal Seno | first = True
|
3880 | ef99e3e8 | Bernardo Dal Seno | for minmax in minmaxes: |
3881 | ef99e3e8 | Bernardo Dal Seno | minspecs = minmax.get("min")
|
3882 | ef99e3e8 | Bernardo Dal Seno | maxspecs = minmax.get("max")
|
3883 | ea9d3b40 | Bernardo Dal Seno | if minspecs and maxspecs: |
3884 | ef99e3e8 | Bernardo Dal Seno | if first:
|
3885 | ef99e3e8 | Bernardo Dal Seno | buf.write(" %s " % IPOLICY_BOUNDS_SPECS_STR)
|
3886 | ef99e3e8 | Bernardo Dal Seno | first = False
|
3887 | ef99e3e8 | Bernardo Dal Seno | else:
|
3888 | ef99e3e8 | Bernardo Dal Seno | buf.write("//")
|
3889 | ea9d3b40 | Bernardo Dal Seno | buf.write("min:")
|
3890 | ea9d3b40 | Bernardo Dal Seno | _PrintSpecsParameters(buf, minspecs) |
3891 | ea9d3b40 | Bernardo Dal Seno | buf.write("/max:")
|
3892 | ea9d3b40 | Bernardo Dal Seno | _PrintSpecsParameters(buf, maxspecs) |
3893 | ea9d3b40 | Bernardo Dal Seno | |
3894 | ea9d3b40 | Bernardo Dal Seno | |
3895 | 25bd815c | René Nussbaumer | def ConfirmOperation(names, list_type, text, extra=""): |
3896 | 25bd815c | René Nussbaumer | """Ask the user to confirm an operation on a list of list_type.
|
3897 | 25bd815c | René Nussbaumer |
|
3898 | 25bd815c | René Nussbaumer | This function is used to request confirmation for doing an operation
|
3899 | 25bd815c | René Nussbaumer | on a given list of list_type.
|
3900 | 25bd815c | René Nussbaumer |
|
3901 | 25bd815c | René Nussbaumer | @type names: list
|
3902 | 25bd815c | René Nussbaumer | @param names: the list of names that we display when
|
3903 | 25bd815c | René Nussbaumer | we ask for confirmation
|
3904 | 25bd815c | René Nussbaumer | @type list_type: str
|
3905 | 25bd815c | René Nussbaumer | @param list_type: Human readable name for elements in the list (e.g. nodes)
|
3906 | 25bd815c | René Nussbaumer | @type text: str
|
3907 | 25bd815c | René Nussbaumer | @param text: the operation that the user should confirm
|
3908 | 25bd815c | René Nussbaumer | @rtype: boolean
|
3909 | 25bd815c | René Nussbaumer | @return: True or False depending on user's confirmation.
|
3910 | 25bd815c | René Nussbaumer |
|
3911 | 25bd815c | René Nussbaumer | """
|
3912 | 25bd815c | René Nussbaumer | count = len(names)
|
3913 | 25bd815c | René Nussbaumer | msg = ("The %s will operate on %d %s.\n%s"
|
3914 | 25bd815c | René Nussbaumer | "Do you want to continue?" % (text, count, list_type, extra))
|
3915 | 25bd815c | René Nussbaumer | affected = (("\nAffected %s:\n" % list_type) +
|
3916 | 25bd815c | René Nussbaumer | "\n".join([" %s" % name for name in names])) |
3917 | 25bd815c | René Nussbaumer | |
3918 | 25bd815c | René Nussbaumer | choices = [("y", True, "Yes, execute the %s" % text), |
3919 | 25bd815c | René Nussbaumer | ("n", False, "No, abort the %s" % text)] |
3920 | 25bd815c | René Nussbaumer | |
3921 | 25bd815c | René Nussbaumer | if count > 20: |
3922 | 25bd815c | René Nussbaumer | choices.insert(1, ("v", "v", "View the list of affected %s" % list_type)) |
3923 | 25bd815c | René Nussbaumer | question = msg |
3924 | 25bd815c | René Nussbaumer | else:
|
3925 | 25bd815c | René Nussbaumer | question = msg + affected |
3926 | 25bd815c | René Nussbaumer | |
3927 | 25bd815c | René Nussbaumer | choice = AskUser(question, choices) |
3928 | 25bd815c | René Nussbaumer | if choice == "v": |
3929 | 25bd815c | René Nussbaumer | choices.pop(1)
|
3930 | 25bd815c | René Nussbaumer | choice = AskUser(msg + affected, choices) |
3931 | 25bd815c | René Nussbaumer | return choice
|
3932 | 703fa9ab | Iustin Pop | |
3933 | 703fa9ab | Iustin Pop | |
3934 | cd415612 | René Nussbaumer | def _MaybeParseUnit(elements): |
3935 | cd415612 | René Nussbaumer | """Parses and returns an array of potential values with units.
|
3936 | cd415612 | René Nussbaumer |
|
3937 | cd415612 | René Nussbaumer | """
|
3938 | ef40c537 | René Nussbaumer | parsed = {} |
3939 | ef40c537 | René Nussbaumer | for k, v in elements.items(): |
3940 | ef40c537 | René Nussbaumer | if v == constants.VALUE_DEFAULT:
|
3941 | ef40c537 | René Nussbaumer | parsed[k] = v |
3942 | cd415612 | René Nussbaumer | else:
|
3943 | ef40c537 | René Nussbaumer | parsed[k] = utils.ParseUnit(v) |
3944 | cd415612 | René Nussbaumer | return parsed
|
3945 | cd415612 | René Nussbaumer | |
3946 | cd415612 | René Nussbaumer | |
3947 | d2d3935a | Bernardo Dal Seno | def _InitISpecsFromSplitOpts(ipolicy, ispecs_mem_size, ispecs_cpu_count, |
3948 | d2d3935a | Bernardo Dal Seno | ispecs_disk_count, ispecs_disk_size, |
3949 | 919db916 | Bernardo Dal Seno | ispecs_nic_count, group_ipolicy, fill_all): |
3950 | d67e0a94 | Iustin Pop | try:
|
3951 | d67e0a94 | Iustin Pop | if ispecs_mem_size:
|
3952 | cd415612 | René Nussbaumer | ispecs_mem_size = _MaybeParseUnit(ispecs_mem_size) |
3953 | d67e0a94 | Iustin Pop | if ispecs_disk_size:
|
3954 | cd415612 | René Nussbaumer | ispecs_disk_size = _MaybeParseUnit(ispecs_disk_size) |
3955 | d67e0a94 | Iustin Pop | except (TypeError, ValueError, errors.UnitParseError), err: |
3956 | d67e0a94 | Iustin Pop | raise errors.OpPrereqError("Invalid disk (%s) or memory (%s) size" |
3957 | d67e0a94 | Iustin Pop | " in policy: %s" %
|
3958 | d67e0a94 | Iustin Pop | (ispecs_disk_size, ispecs_mem_size, err), |
3959 | d67e0a94 | Iustin Pop | errors.ECODE_INVAL) |
3960 | d67e0a94 | Iustin Pop | |
3961 | 703fa9ab | Iustin Pop | # prepare ipolicy dict
|
3962 | d948c101 | Bernardo Dal Seno | ispecs_transposed = { |
3963 | 703fa9ab | Iustin Pop | constants.ISPEC_MEM_SIZE: ispecs_mem_size, |
3964 | 703fa9ab | Iustin Pop | constants.ISPEC_CPU_COUNT: ispecs_cpu_count, |
3965 | 703fa9ab | Iustin Pop | constants.ISPEC_DISK_COUNT: ispecs_disk_count, |
3966 | 703fa9ab | Iustin Pop | constants.ISPEC_DISK_SIZE: ispecs_disk_size, |
3967 | 703fa9ab | Iustin Pop | constants.ISPEC_NIC_COUNT: ispecs_nic_count, |
3968 | 703fa9ab | Iustin Pop | } |
3969 | 703fa9ab | Iustin Pop | |
3970 | 703fa9ab | Iustin Pop | # first, check that the values given are correct
|
3971 | 703fa9ab | Iustin Pop | if group_ipolicy:
|
3972 | 703fa9ab | Iustin Pop | forced_type = TISPECS_GROUP_TYPES |
3973 | 703fa9ab | Iustin Pop | else:
|
3974 | 703fa9ab | Iustin Pop | forced_type = TISPECS_CLUSTER_TYPES |
3975 | d948c101 | Bernardo Dal Seno | for specs in ispecs_transposed.values(): |
3976 | d2d3935a | Bernardo Dal Seno | assert type(specs) is dict |
3977 | 919db916 | Bernardo Dal Seno | utils.ForceDictType(specs, forced_type) |
3978 | 703fa9ab | Iustin Pop | |
3979 | 703fa9ab | Iustin Pop | # then transpose
|
3980 | da5f09ef | Bernardo Dal Seno | ispecs = { |
3981 | da5f09ef | Bernardo Dal Seno | constants.ISPECS_MIN: {}, |
3982 | da5f09ef | Bernardo Dal Seno | constants.ISPECS_MAX: {}, |
3983 | da5f09ef | Bernardo Dal Seno | constants.ISPECS_STD: {}, |
3984 | da5f09ef | Bernardo Dal Seno | } |
3985 | d948c101 | Bernardo Dal Seno | for (name, specs) in ispecs_transposed.iteritems(): |
3986 | 703fa9ab | Iustin Pop | assert name in constants.ISPECS_PARAMETERS |
3987 | 703fa9ab | Iustin Pop | for key, val in specs.items(): # {min: .. ,max: .., std: ..} |
3988 | da5f09ef | Bernardo Dal Seno | assert key in ispecs |
3989 | da5f09ef | Bernardo Dal Seno | ispecs[key][name] = val |
3990 | 41044e04 | Bernardo Dal Seno | minmax_out = {} |
3991 | da5f09ef | Bernardo Dal Seno | for key in constants.ISPECS_MINMAX_KEYS: |
3992 | 919db916 | Bernardo Dal Seno | if fill_all:
|
3993 | 41044e04 | Bernardo Dal Seno | minmax_out[key] = \ |
3994 | 919db916 | Bernardo Dal Seno | objects.FillDict(constants.ISPECS_MINMAX_DEFAULTS[key], ispecs[key]) |
3995 | 919db916 | Bernardo Dal Seno | else:
|
3996 | 41044e04 | Bernardo Dal Seno | minmax_out[key] = ispecs[key] |
3997 | 41044e04 | Bernardo Dal Seno | ipolicy[constants.ISPECS_MINMAX] = [minmax_out] |
3998 | 919db916 | Bernardo Dal Seno | if fill_all:
|
3999 | 919db916 | Bernardo Dal Seno | ipolicy[constants.ISPECS_STD] = \ |
4000 | 919db916 | Bernardo Dal Seno | objects.FillDict(constants.IPOLICY_DEFAULTS[constants.ISPECS_STD], |
4001 | 919db916 | Bernardo Dal Seno | ispecs[constants.ISPECS_STD]) |
4002 | 919db916 | Bernardo Dal Seno | else:
|
4003 | 919db916 | Bernardo Dal Seno | ipolicy[constants.ISPECS_STD] = ispecs[constants.ISPECS_STD] |
4004 | d948c101 | Bernardo Dal Seno | |
4005 | d948c101 | Bernardo Dal Seno | |
4006 | d2d3935a | Bernardo Dal Seno | def _ParseSpecUnit(spec, keyname): |
4007 | d2d3935a | Bernardo Dal Seno | ret = spec.copy() |
4008 | d2d3935a | Bernardo Dal Seno | for k in [constants.ISPEC_DISK_SIZE, constants.ISPEC_MEM_SIZE]: |
4009 | 919db916 | Bernardo Dal Seno | if k in ret: |
4010 | d2d3935a | Bernardo Dal Seno | try:
|
4011 | d2d3935a | Bernardo Dal Seno | ret[k] = utils.ParseUnit(ret[k]) |
4012 | d2d3935a | Bernardo Dal Seno | except (TypeError, ValueError, errors.UnitParseError), err: |
4013 | d2d3935a | Bernardo Dal Seno | raise errors.OpPrereqError(("Invalid parameter %s (%s) in %s instance" |
4014 | d2d3935a | Bernardo Dal Seno | " specs: %s" % (k, ret[k], keyname, err)),
|
4015 | d2d3935a | Bernardo Dal Seno | errors.ECODE_INVAL) |
4016 | d2d3935a | Bernardo Dal Seno | return ret
|
4017 | d2d3935a | Bernardo Dal Seno | |
4018 | d2d3935a | Bernardo Dal Seno | |
4019 | 919db916 | Bernardo Dal Seno | def _ParseISpec(spec, keyname, required): |
4020 | d2d3935a | Bernardo Dal Seno | ret = _ParseSpecUnit(spec, keyname) |
4021 | 919db916 | Bernardo Dal Seno | utils.ForceDictType(ret, constants.ISPECS_PARAMETER_TYPES) |
4022 | 919db916 | Bernardo Dal Seno | missing = constants.ISPECS_PARAMETERS - frozenset(ret.keys())
|
4023 | 919db916 | Bernardo Dal Seno | if required and missing: |
4024 | 919db916 | Bernardo Dal Seno | raise errors.OpPrereqError("Missing parameters in ipolicy spec %s: %s" % |
4025 | 919db916 | Bernardo Dal Seno | (keyname, utils.CommaJoin(missing)), |
4026 | 919db916 | Bernardo Dal Seno | errors.ECODE_INVAL) |
4027 | 919db916 | Bernardo Dal Seno | return ret
|
4028 | 919db916 | Bernardo Dal Seno | |
4029 | 919db916 | Bernardo Dal Seno | |
4030 | 919db916 | Bernardo Dal Seno | def _GetISpecsInAllowedValues(minmax_ispecs, allowed_values): |
4031 | 919db916 | Bernardo Dal Seno | ret = None
|
4032 | ef99e3e8 | Bernardo Dal Seno | if (minmax_ispecs and allowed_values and len(minmax_ispecs) == 1 and |
4033 | ef99e3e8 | Bernardo Dal Seno | len(minmax_ispecs[0]) == 1): |
4034 | ef99e3e8 | Bernardo Dal Seno | for (key, spec) in minmax_ispecs[0].items(): |
4035 | 919db916 | Bernardo Dal Seno | # This loop is executed exactly once
|
4036 | 919db916 | Bernardo Dal Seno | if key in allowed_values and not spec: |
4037 | 919db916 | Bernardo Dal Seno | ret = key |
4038 | d2d3935a | Bernardo Dal Seno | return ret
|
4039 | d2d3935a | Bernardo Dal Seno | |
4040 | d2d3935a | Bernardo Dal Seno | |
4041 | d2d3935a | Bernardo Dal Seno | def _InitISpecsFromFullOpts(ipolicy_out, minmax_ispecs, std_ispecs, |
4042 | d2d3935a | Bernardo Dal Seno | group_ipolicy, allowed_values): |
4043 | 919db916 | Bernardo Dal Seno | found_allowed = _GetISpecsInAllowedValues(minmax_ispecs, allowed_values) |
4044 | 919db916 | Bernardo Dal Seno | if found_allowed is not None: |
4045 | 919db916 | Bernardo Dal Seno | ipolicy_out[constants.ISPECS_MINMAX] = found_allowed |
4046 | 919db916 | Bernardo Dal Seno | elif minmax_ispecs is not None: |
4047 | ef99e3e8 | Bernardo Dal Seno | minmax_out = [] |
4048 | ef99e3e8 | Bernardo Dal Seno | for mmpair in minmax_ispecs: |
4049 | ef99e3e8 | Bernardo Dal Seno | mmpair_out = {} |
4050 | ef99e3e8 | Bernardo Dal Seno | for (key, spec) in mmpair.items(): |
4051 | ef99e3e8 | Bernardo Dal Seno | if key not in constants.ISPECS_MINMAX_KEYS: |
4052 | ef99e3e8 | Bernardo Dal Seno | msg = "Invalid key in bounds instance specifications: %s" % key
|
4053 | ef99e3e8 | Bernardo Dal Seno | raise errors.OpPrereqError(msg, errors.ECODE_INVAL)
|
4054 | ef99e3e8 | Bernardo Dal Seno | mmpair_out[key] = _ParseISpec(spec, key, True)
|
4055 | ef99e3e8 | Bernardo Dal Seno | minmax_out.append(mmpair_out) |
4056 | ef99e3e8 | Bernardo Dal Seno | ipolicy_out[constants.ISPECS_MINMAX] = minmax_out |
4057 | d2d3935a | Bernardo Dal Seno | if std_ispecs is not None: |
4058 | d2d3935a | Bernardo Dal Seno | assert not group_ipolicy # This is not an option for gnt-group |
4059 | 919db916 | Bernardo Dal Seno | ipolicy_out[constants.ISPECS_STD] = _ParseISpec(std_ispecs, "std", False) |
4060 | d2d3935a | Bernardo Dal Seno | |
4061 | d2d3935a | Bernardo Dal Seno | |
4062 | d948c101 | Bernardo Dal Seno | def CreateIPolicyFromOpts(ispecs_mem_size=None, |
4063 | d948c101 | Bernardo Dal Seno | ispecs_cpu_count=None,
|
4064 | d948c101 | Bernardo Dal Seno | ispecs_disk_count=None,
|
4065 | d948c101 | Bernardo Dal Seno | ispecs_disk_size=None,
|
4066 | d948c101 | Bernardo Dal Seno | ispecs_nic_count=None,
|
4067 | d2d3935a | Bernardo Dal Seno | minmax_ispecs=None,
|
4068 | d2d3935a | Bernardo Dal Seno | std_ispecs=None,
|
4069 | d948c101 | Bernardo Dal Seno | ipolicy_disk_templates=None,
|
4070 | d948c101 | Bernardo Dal Seno | ipolicy_vcpu_ratio=None,
|
4071 | d948c101 | Bernardo Dal Seno | ipolicy_spindle_ratio=None,
|
4072 | d948c101 | Bernardo Dal Seno | group_ipolicy=False,
|
4073 | d948c101 | Bernardo Dal Seno | allowed_values=None,
|
4074 | d948c101 | Bernardo Dal Seno | fill_all=False):
|
4075 | d948c101 | Bernardo Dal Seno | """Creation of instance policy based on command line options.
|
4076 | d948c101 | Bernardo Dal Seno |
|
4077 | d948c101 | Bernardo Dal Seno | @param fill_all: whether for cluster policies we should ensure that
|
4078 | d948c101 | Bernardo Dal Seno | all values are filled
|
4079 | d948c101 | Bernardo Dal Seno |
|
4080 | d948c101 | Bernardo Dal Seno | """
|
4081 | 919db916 | Bernardo Dal Seno | assert not (fill_all and allowed_values) |
4082 | 919db916 | Bernardo Dal Seno | |
4083 | 919db916 | Bernardo Dal Seno | split_specs = (ispecs_mem_size or ispecs_cpu_count or ispecs_disk_count or |
4084 | 919db916 | Bernardo Dal Seno | ispecs_disk_size or ispecs_nic_count)
|
4085 | 919db916 | Bernardo Dal Seno | if (split_specs and (minmax_ispecs is not None or std_ispecs is not None)): |
4086 | d2d3935a | Bernardo Dal Seno | raise errors.OpPrereqError("A --specs-xxx option cannot be specified" |
4087 | d2d3935a | Bernardo Dal Seno | " together with any --ipolicy-xxx-specs option",
|
4088 | d2d3935a | Bernardo Dal Seno | errors.ECODE_INVAL) |
4089 | d948c101 | Bernardo Dal Seno | |
4090 | d948c101 | Bernardo Dal Seno | ipolicy_out = objects.MakeEmptyIPolicy() |
4091 | 919db916 | Bernardo Dal Seno | if split_specs:
|
4092 | 919db916 | Bernardo Dal Seno | assert fill_all
|
4093 | d2d3935a | Bernardo Dal Seno | _InitISpecsFromSplitOpts(ipolicy_out, ispecs_mem_size, ispecs_cpu_count, |
4094 | d2d3935a | Bernardo Dal Seno | ispecs_disk_count, ispecs_disk_size, |
4095 | 919db916 | Bernardo Dal Seno | ispecs_nic_count, group_ipolicy, fill_all) |
4096 | 919db916 | Bernardo Dal Seno | elif (minmax_ispecs is not None or std_ispecs is not None): |
4097 | d2d3935a | Bernardo Dal Seno | _InitISpecsFromFullOpts(ipolicy_out, minmax_ispecs, std_ispecs, |
4098 | d2d3935a | Bernardo Dal Seno | group_ipolicy, allowed_values) |
4099 | 703fa9ab | Iustin Pop | |
4100 | 703fa9ab | Iustin Pop | if ipolicy_disk_templates is not None: |
4101 | f824ae42 | Bernardo Dal Seno | if allowed_values and ipolicy_disk_templates in allowed_values: |
4102 | f824ae42 | Bernardo Dal Seno | ipolicy_out[constants.IPOLICY_DTS] = ipolicy_disk_templates |
4103 | f824ae42 | Bernardo Dal Seno | else:
|
4104 | f824ae42 | Bernardo Dal Seno | ipolicy_out[constants.IPOLICY_DTS] = list(ipolicy_disk_templates)
|
4105 | 703fa9ab | Iustin Pop | if ipolicy_vcpu_ratio is not None: |
4106 | 703fa9ab | Iustin Pop | ipolicy_out[constants.IPOLICY_VCPU_RATIO] = ipolicy_vcpu_ratio |
4107 | ad5cc6bd | René Nussbaumer | if ipolicy_spindle_ratio is not None: |
4108 | ad5cc6bd | René Nussbaumer | ipolicy_out[constants.IPOLICY_SPINDLE_RATIO] = ipolicy_spindle_ratio |
4109 | 703fa9ab | Iustin Pop | |
4110 | 703fa9ab | Iustin Pop | assert not (frozenset(ipolicy_out.keys()) - constants.IPOLICY_ALL_KEYS) |
4111 | 703fa9ab | Iustin Pop | |
4112 | eeaa5f6c | Bernardo Dal Seno | if not group_ipolicy and fill_all: |
4113 | eeaa5f6c | Bernardo Dal Seno | ipolicy_out = objects.FillIPolicy(constants.IPOLICY_DEFAULTS, ipolicy_out) |
4114 | eeaa5f6c | Bernardo Dal Seno | |
4115 | 703fa9ab | Iustin Pop | return ipolicy_out
|
4116 | 4d99964c | Bernardo Dal Seno | |
4117 | 4d99964c | Bernardo Dal Seno | |
4118 | 4d99964c | Bernardo Dal Seno | def _SerializeGenericInfo(buf, data, level, afterkey=False): |
4119 | 4d99964c | Bernardo Dal Seno | """Formatting core of L{PrintGenericInfo}.
|
4120 | 4d99964c | Bernardo Dal Seno |
|
4121 | 4d99964c | Bernardo Dal Seno | @param buf: (string) stream to accumulate the result into
|
4122 | 4d99964c | Bernardo Dal Seno | @param data: data to format
|
4123 | 4d99964c | Bernardo Dal Seno | @type level: int
|
4124 | 4d99964c | Bernardo Dal Seno | @param level: depth in the data hierarchy, used for indenting
|
4125 | 4d99964c | Bernardo Dal Seno | @type afterkey: bool
|
4126 | 4d99964c | Bernardo Dal Seno | @param afterkey: True when we are in the middle of a line after a key (used
|
4127 | 4d99964c | Bernardo Dal Seno | to properly add newlines or indentation)
|
4128 | 4d99964c | Bernardo Dal Seno |
|
4129 | 4d99964c | Bernardo Dal Seno | """
|
4130 | 4d99964c | Bernardo Dal Seno | baseind = " "
|
4131 | 4d99964c | Bernardo Dal Seno | if isinstance(data, dict): |
4132 | 4d99964c | Bernardo Dal Seno | if not data: |
4133 | 4d99964c | Bernardo Dal Seno | buf.write("\n")
|
4134 | 4d99964c | Bernardo Dal Seno | else:
|
4135 | 4d99964c | Bernardo Dal Seno | if afterkey:
|
4136 | 4d99964c | Bernardo Dal Seno | buf.write("\n")
|
4137 | 4d99964c | Bernardo Dal Seno | doindent = True
|
4138 | 4d99964c | Bernardo Dal Seno | else:
|
4139 | 4d99964c | Bernardo Dal Seno | doindent = False
|
4140 | 4d99964c | Bernardo Dal Seno | for key in sorted(data): |
4141 | 4d99964c | Bernardo Dal Seno | if doindent:
|
4142 | 4d99964c | Bernardo Dal Seno | buf.write(baseind * level) |
4143 | 4d99964c | Bernardo Dal Seno | else:
|
4144 | 4d99964c | Bernardo Dal Seno | doindent = True
|
4145 | 4d99964c | Bernardo Dal Seno | buf.write(key) |
4146 | 4d99964c | Bernardo Dal Seno | buf.write(": ")
|
4147 | 4d99964c | Bernardo Dal Seno | _SerializeGenericInfo(buf, data[key], level + 1, afterkey=True) |
4148 | 4d99964c | Bernardo Dal Seno | elif isinstance(data, list) and len(data) > 0 and isinstance(data[0], tuple): |
4149 | 4d99964c | Bernardo Dal Seno | # list of tuples (an ordered dictionary)
|
4150 | 4d99964c | Bernardo Dal Seno | if afterkey:
|
4151 | 4d99964c | Bernardo Dal Seno | buf.write("\n")
|
4152 | 4d99964c | Bernardo Dal Seno | doindent = True
|
4153 | 4d99964c | Bernardo Dal Seno | else:
|
4154 | 4d99964c | Bernardo Dal Seno | doindent = False
|
4155 | 4d99964c | Bernardo Dal Seno | for (key, val) in data: |
4156 | 4d99964c | Bernardo Dal Seno | if doindent:
|
4157 | 4d99964c | Bernardo Dal Seno | buf.write(baseind * level) |
4158 | 4d99964c | Bernardo Dal Seno | else:
|
4159 | 4d99964c | Bernardo Dal Seno | doindent = True
|
4160 | 4d99964c | Bernardo Dal Seno | buf.write(key) |
4161 | 4d99964c | Bernardo Dal Seno | buf.write(": ")
|
4162 | 4d99964c | Bernardo Dal Seno | _SerializeGenericInfo(buf, val, level + 1, afterkey=True) |
4163 | 4d99964c | Bernardo Dal Seno | elif isinstance(data, list): |
4164 | 4d99964c | Bernardo Dal Seno | if not data: |
4165 | 4d99964c | Bernardo Dal Seno | buf.write("\n")
|
4166 | 4d99964c | Bernardo Dal Seno | else:
|
4167 | 4d99964c | Bernardo Dal Seno | if afterkey:
|
4168 | 4d99964c | Bernardo Dal Seno | buf.write("\n")
|
4169 | 4d99964c | Bernardo Dal Seno | doindent = True
|
4170 | 4d99964c | Bernardo Dal Seno | else:
|
4171 | 4d99964c | Bernardo Dal Seno | doindent = False
|
4172 | 4d99964c | Bernardo Dal Seno | for item in data: |
4173 | 4d99964c | Bernardo Dal Seno | if doindent:
|
4174 | 4d99964c | Bernardo Dal Seno | buf.write(baseind * level) |
4175 | 4d99964c | Bernardo Dal Seno | else:
|
4176 | 4d99964c | Bernardo Dal Seno | doindent = True
|
4177 | 4d99964c | Bernardo Dal Seno | buf.write("-")
|
4178 | 4d99964c | Bernardo Dal Seno | buf.write(baseind[1:])
|
4179 | 4d99964c | Bernardo Dal Seno | _SerializeGenericInfo(buf, item, level + 1)
|
4180 | 4d99964c | Bernardo Dal Seno | else:
|
4181 | 4d99964c | Bernardo Dal Seno | # This branch should be only taken for strings, but it's practically
|
4182 | 4d99964c | Bernardo Dal Seno | # impossible to guarantee that no other types are produced somewhere
|
4183 | 4d99964c | Bernardo Dal Seno | buf.write(str(data))
|
4184 | 4d99964c | Bernardo Dal Seno | buf.write("\n")
|
4185 | 4d99964c | Bernardo Dal Seno | |
4186 | 4d99964c | Bernardo Dal Seno | |
4187 | 4d99964c | Bernardo Dal Seno | def PrintGenericInfo(data): |
4188 | 4d99964c | Bernardo Dal Seno | """Print information formatted according to the hierarchy.
|
4189 | 4d99964c | Bernardo Dal Seno |
|
4190 | 4d99964c | Bernardo Dal Seno | The output is a valid YAML string.
|
4191 | 4d99964c | Bernardo Dal Seno |
|
4192 | 4d99964c | Bernardo Dal Seno | @param data: the data to print. It's a hierarchical structure whose elements
|
4193 | 4d99964c | Bernardo Dal Seno | can be:
|
4194 | 4d99964c | Bernardo Dal Seno | - dictionaries, where keys are strings and values are of any of the
|
4195 | 4d99964c | Bernardo Dal Seno | types listed here
|
4196 | 4d99964c | Bernardo Dal Seno | - lists of pairs (key, value), where key is a string and value is of
|
4197 | 4d99964c | Bernardo Dal Seno | any of the types listed here; it's a way to encode ordered
|
4198 | 4d99964c | Bernardo Dal Seno | dictionaries
|
4199 | 4d99964c | Bernardo Dal Seno | - lists of any of the types listed here
|
4200 | 4d99964c | Bernardo Dal Seno | - strings
|
4201 | 4d99964c | Bernardo Dal Seno |
|
4202 | 4d99964c | Bernardo Dal Seno | """
|
4203 | 4d99964c | Bernardo Dal Seno | buf = StringIO() |
4204 | 4d99964c | Bernardo Dal Seno | _SerializeGenericInfo(buf, data, 0)
|
4205 | 4d99964c | Bernardo Dal Seno | ToStdout(buf.getvalue().rstrip("\n")) |