root / src / Ganeti / Hs2Py / OpDoc.hs @ 7d81bb8b
History | View | Annotate | Download (14.4 kB)
1 | 6c2c542e | Jose A. Lopes | {-| Implementation of the doc strings for the opcodes. |
---|---|---|---|
2 | 6c2c542e | Jose A. Lopes | |
3 | 6c2c542e | Jose A. Lopes | -} |
4 | 6c2c542e | Jose A. Lopes | |
5 | 6c2c542e | Jose A. Lopes | {- |
6 | 6c2c542e | Jose A. Lopes | |
7 | 6c2c542e | Jose A. Lopes | Copyright (C) 2009, 2010, 2011, 2012, 2013 Google Inc. |
8 | 6c2c542e | Jose A. Lopes | |
9 | 6c2c542e | Jose A. Lopes | This program is free software; you can redistribute it and/or modify |
10 | 6c2c542e | Jose A. Lopes | it under the terms of the GNU General Public License as published by |
11 | 6c2c542e | Jose A. Lopes | the Free Software Foundation; either version 2 of the License, or |
12 | 6c2c542e | Jose A. Lopes | (at your option) any later version. |
13 | 6c2c542e | Jose A. Lopes | |
14 | 6c2c542e | Jose A. Lopes | This program is distributed in the hope that it will be useful, but |
15 | 6c2c542e | Jose A. Lopes | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | 6c2c542e | Jose A. Lopes | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
17 | 6c2c542e | Jose A. Lopes | General Public License for more details. |
18 | 6c2c542e | Jose A. Lopes | |
19 | 6c2c542e | Jose A. Lopes | You should have received a copy of the GNU General Public License |
20 | 6c2c542e | Jose A. Lopes | along with this program; if not, write to the Free Software |
21 | 6c2c542e | Jose A. Lopes | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
22 | 6c2c542e | Jose A. Lopes | 02110-1301, USA. |
23 | 6c2c542e | Jose A. Lopes | |
24 | 6c2c542e | Jose A. Lopes | -} |
25 | 6c2c542e | Jose A. Lopes | |
26 | 6c2c542e | Jose A. Lopes | module Ganeti.Hs2Py.OpDoc where |
27 | 6c2c542e | Jose A. Lopes | |
28 | 6c2c542e | Jose A. Lopes | |
29 | 6c2c542e | Jose A. Lopes | opClusterPostInit :: String |
30 | 6c2c542e | Jose A. Lopes | opClusterPostInit = |
31 | 6c2c542e | Jose A. Lopes | "Post cluster initialization.\n\ |
32 | 6c2c542e | Jose A. Lopes | \\n\ |
33 | 6c2c542e | Jose A. Lopes | \ This opcode does not touch the cluster at all. Its purpose is to run hooks\n\ |
34 | 6c2c542e | Jose A. Lopes | \ after the cluster has been initialized." |
35 | 6c2c542e | Jose A. Lopes | |
36 | 6c2c542e | Jose A. Lopes | opClusterDestroy :: String |
37 | 6c2c542e | Jose A. Lopes | opClusterDestroy = |
38 | 6c2c542e | Jose A. Lopes | "Destroy the cluster.\n\ |
39 | 6c2c542e | Jose A. Lopes | \\n\ |
40 | 6c2c542e | Jose A. Lopes | \ This opcode has no other parameters. All the state is irreversibly\n\ |
41 | 6c2c542e | Jose A. Lopes | \ lost after the execution of this opcode." |
42 | 6c2c542e | Jose A. Lopes | |
43 | 6c2c542e | Jose A. Lopes | opClusterQuery :: String |
44 | 6c2c542e | Jose A. Lopes | opClusterQuery = |
45 | 6c2c542e | Jose A. Lopes | "Query cluster information." |
46 | 6c2c542e | Jose A. Lopes | |
47 | 6c2c542e | Jose A. Lopes | opClusterVerify :: String |
48 | 6c2c542e | Jose A. Lopes | opClusterVerify = |
49 | 6c2c542e | Jose A. Lopes | "Submits all jobs necessary to verify the cluster." |
50 | 6c2c542e | Jose A. Lopes | |
51 | 6c2c542e | Jose A. Lopes | opClusterVerifyConfig :: String |
52 | 6c2c542e | Jose A. Lopes | opClusterVerifyConfig = |
53 | 6c2c542e | Jose A. Lopes | "Verify the cluster config." |
54 | 6c2c542e | Jose A. Lopes | |
55 | 6c2c542e | Jose A. Lopes | opClusterVerifyGroup :: String |
56 | 6c2c542e | Jose A. Lopes | opClusterVerifyGroup = |
57 | 6c2c542e | Jose A. Lopes | "Run verify on a node group from the cluster.\n\ |
58 | 6c2c542e | Jose A. Lopes | \\n\ |
59 | 6c2c542e | Jose A. Lopes | \ @type skip_checks: C{list}\n\ |
60 | 6c2c542e | Jose A. Lopes | \ @ivar skip_checks: steps to be skipped from the verify process; this\n\ |
61 | 6c2c542e | Jose A. Lopes | \ needs to be a subset of\n\ |
62 | 6c2c542e | Jose A. Lopes | \ L{constants.VERIFY_OPTIONAL_CHECKS}; currently\n\ |
63 | 6c2c542e | Jose A. Lopes | \ only L{constants.VERIFY_NPLUSONE_MEM} can be passed" |
64 | 6c2c542e | Jose A. Lopes | |
65 | 6c2c542e | Jose A. Lopes | opClusterVerifyDisks :: String |
66 | 6c2c542e | Jose A. Lopes | opClusterVerifyDisks = |
67 | 6c2c542e | Jose A. Lopes | "Verify the cluster disks." |
68 | 6c2c542e | Jose A. Lopes | |
69 | 6c2c542e | Jose A. Lopes | opGroupVerifyDisks :: String |
70 | 6c2c542e | Jose A. Lopes | opGroupVerifyDisks = |
71 | 6c2c542e | Jose A. Lopes | "Verifies the status of all disks in a node group.\n\ |
72 | 6c2c542e | Jose A. Lopes | \\n\ |
73 | 6c2c542e | Jose A. Lopes | \ Result: a tuple of three elements:\n\ |
74 | 6c2c542e | Jose A. Lopes | \ - dict of node names with issues (values: error msg)\n\ |
75 | 6c2c542e | Jose A. Lopes | \ - list of instances with degraded disks (that should be activated)\n\ |
76 | 6c2c542e | Jose A. Lopes | \ - dict of instances with missing logical volumes (values: (node, vol)\n\ |
77 | 6c2c542e | Jose A. Lopes | \ pairs with details about the missing volumes)\n\ |
78 | 6c2c542e | Jose A. Lopes | \\n\ |
79 | 6c2c542e | Jose A. Lopes | \ In normal operation, all lists should be empty. A non-empty instance\n\ |
80 | 6c2c542e | Jose A. Lopes | \ list (3rd element of the result) is still ok (errors were fixed) but\n\ |
81 | 6c2c542e | Jose A. Lopes | \ non-empty node list means some node is down, and probably there are\n\ |
82 | 6c2c542e | Jose A. Lopes | \ unfixable drbd errors.\n\ |
83 | 6c2c542e | Jose A. Lopes | \\n\ |
84 | 6c2c542e | Jose A. Lopes | \ Note that only instances that are drbd-based are taken into\n\ |
85 | 6c2c542e | Jose A. Lopes | \ consideration. This might need to be revisited in the future." |
86 | 6c2c542e | Jose A. Lopes | |
87 | 6c2c542e | Jose A. Lopes | opClusterRepairDiskSizes :: String |
88 | 6c2c542e | Jose A. Lopes | opClusterRepairDiskSizes = |
89 | 6c2c542e | Jose A. Lopes | "Verify the disk sizes of the instances and fixes configuration\n\ |
90 | 6c2c542e | Jose A. Lopes | \ mismatches.\n\ |
91 | 6c2c542e | Jose A. Lopes | \\n\ |
92 | 6c2c542e | Jose A. Lopes | \ Parameters: optional instances list, in case we want to restrict the\n\ |
93 | 6c2c542e | Jose A. Lopes | \ checks to only a subset of the instances.\n\ |
94 | 6c2c542e | Jose A. Lopes | \\n\ |
95 | 6c2c542e | Jose A. Lopes | \ Result: a list of tuples, (instance, disk, parameter, new-size) for\n\ |
96 | 6c2c542e | Jose A. Lopes | \ changed configurations.\n\ |
97 | 6c2c542e | Jose A. Lopes | \\n\ |
98 | 6c2c542e | Jose A. Lopes | \ In normal operation, the list should be empty.\n\ |
99 | 6c2c542e | Jose A. Lopes | \\n\ |
100 | 6c2c542e | Jose A. Lopes | \ @type instances: list\n\ |
101 | 6c2c542e | Jose A. Lopes | \ @ivar instances: the list of instances to check, or empty for all instances" |
102 | 6c2c542e | Jose A. Lopes | |
103 | 6c2c542e | Jose A. Lopes | opClusterConfigQuery :: String |
104 | 6c2c542e | Jose A. Lopes | opClusterConfigQuery = |
105 | 6c2c542e | Jose A. Lopes | "Query cluster configuration values." |
106 | 6c2c542e | Jose A. Lopes | |
107 | 6c2c542e | Jose A. Lopes | opClusterRename :: String |
108 | 6c2c542e | Jose A. Lopes | opClusterRename = |
109 | 6c2c542e | Jose A. Lopes | "Rename the cluster.\n\ |
110 | 6c2c542e | Jose A. Lopes | \\n\ |
111 | 6c2c542e | Jose A. Lopes | \ @type name: C{str}\n\ |
112 | 6c2c542e | Jose A. Lopes | \ @ivar name: The new name of the cluster. The name and/or the master IP\n\ |
113 | 6c2c542e | Jose A. Lopes | \ address will be changed to match the new name and its IP\n\ |
114 | 6c2c542e | Jose A. Lopes | \ address." |
115 | 6c2c542e | Jose A. Lopes | |
116 | 6c2c542e | Jose A. Lopes | opClusterSetParams :: String |
117 | 6c2c542e | Jose A. Lopes | opClusterSetParams = |
118 | 6c2c542e | Jose A. Lopes | "Change the parameters of the cluster.\n\ |
119 | 6c2c542e | Jose A. Lopes | \\n\ |
120 | 6c2c542e | Jose A. Lopes | \ @type vg_name: C{str} or C{None}\n\ |
121 | 6c2c542e | Jose A. Lopes | \ @ivar vg_name: The new volume group name or None to disable LVM usage." |
122 | 6c2c542e | Jose A. Lopes | |
123 | 6c2c542e | Jose A. Lopes | opClusterRedistConf :: String |
124 | 6c2c542e | Jose A. Lopes | opClusterRedistConf = |
125 | 6c2c542e | Jose A. Lopes | "Force a full push of the cluster configuration." |
126 | 6c2c542e | Jose A. Lopes | |
127 | 6c2c542e | Jose A. Lopes | opClusterActivateMasterIp :: String |
128 | 6c2c542e | Jose A. Lopes | opClusterActivateMasterIp = |
129 | 6c2c542e | Jose A. Lopes | "Activate the master IP on the master node." |
130 | 6c2c542e | Jose A. Lopes | |
131 | 6c2c542e | Jose A. Lopes | opClusterDeactivateMasterIp :: String |
132 | 6c2c542e | Jose A. Lopes | opClusterDeactivateMasterIp = |
133 | 6c2c542e | Jose A. Lopes | "Deactivate the master IP on the master node." |
134 | 6c2c542e | Jose A. Lopes | |
135 | 6c2c542e | Jose A. Lopes | opQuery :: String |
136 | 6c2c542e | Jose A. Lopes | opQuery = |
137 | 6c2c542e | Jose A. Lopes | "Query for resources/items.\n\ |
138 | 6c2c542e | Jose A. Lopes | \\n\ |
139 | 6c2c542e | Jose A. Lopes | \ @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}\n\ |
140 | 6c2c542e | Jose A. Lopes | \ @ivar fields: List of fields to retrieve\n\ |
141 | 6c2c542e | Jose A. Lopes | \ @ivar qfilter: Query filter" |
142 | 6c2c542e | Jose A. Lopes | |
143 | 6c2c542e | Jose A. Lopes | opQueryFields :: String |
144 | 6c2c542e | Jose A. Lopes | opQueryFields = |
145 | 6c2c542e | Jose A. Lopes | "Query for available resource/item fields.\n\ |
146 | 6c2c542e | Jose A. Lopes | \\n\ |
147 | 6c2c542e | Jose A. Lopes | \ @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}\n\ |
148 | 6c2c542e | Jose A. Lopes | \ @ivar fields: List of fields to retrieve" |
149 | 6c2c542e | Jose A. Lopes | |
150 | 6c2c542e | Jose A. Lopes | opOobCommand :: String |
151 | 6c2c542e | Jose A. Lopes | opOobCommand = |
152 | 6c2c542e | Jose A. Lopes | "Interact with OOB." |
153 | 6c2c542e | Jose A. Lopes | |
154 | 6c2c542e | Jose A. Lopes | opRestrictedCommand :: String |
155 | 6c2c542e | Jose A. Lopes | opRestrictedCommand = |
156 | 6c2c542e | Jose A. Lopes | "Runs a restricted command on node(s)." |
157 | 6c2c542e | Jose A. Lopes | |
158 | 6c2c542e | Jose A. Lopes | opNodeRemove :: String |
159 | 6c2c542e | Jose A. Lopes | opNodeRemove = |
160 | 6c2c542e | Jose A. Lopes | "Remove a node.\n\ |
161 | 6c2c542e | Jose A. Lopes | \\n\ |
162 | 6c2c542e | Jose A. Lopes | \ @type node_name: C{str}\n\ |
163 | 6c2c542e | Jose A. Lopes | \ @ivar node_name: The name of the node to remove. If the node still has\n\ |
164 | 6c2c542e | Jose A. Lopes | \ instances on it, the operation will fail." |
165 | 6c2c542e | Jose A. Lopes | |
166 | 6c2c542e | Jose A. Lopes | opNodeAdd :: String |
167 | 6c2c542e | Jose A. Lopes | opNodeAdd = |
168 | 6c2c542e | Jose A. Lopes | "Add a node to the cluster.\n\ |
169 | 6c2c542e | Jose A. Lopes | \\n\ |
170 | 6c2c542e | Jose A. Lopes | \ @type node_name: C{str}\n\ |
171 | 6c2c542e | Jose A. Lopes | \ @ivar node_name: The name of the node to add. This can be a short name,\n\ |
172 | 6c2c542e | Jose A. Lopes | \ but it will be expanded to the FQDN.\n\ |
173 | 6c2c542e | Jose A. Lopes | \ @type primary_ip: IP address\n\ |
174 | 6c2c542e | Jose A. Lopes | \ @ivar primary_ip: The primary IP of the node. This will be ignored when\n\ |
175 | 6c2c542e | Jose A. Lopes | \ the opcode is submitted, but will be filled during the\n\ |
176 | 6c2c542e | Jose A. Lopes | \ node add (so it will be visible in the job query).\n\ |
177 | 6c2c542e | Jose A. Lopes | \ @type secondary_ip: IP address\n\ |
178 | 6c2c542e | Jose A. Lopes | \ @ivar secondary_ip: The secondary IP of the node. This needs to be passed\n\ |
179 | 6c2c542e | Jose A. Lopes | \ if the cluster has been initialized in 'dual-network'\n\ |
180 | 6c2c542e | Jose A. Lopes | \ mode, otherwise it must not be given.\n\ |
181 | 6c2c542e | Jose A. Lopes | \ @type readd: C{bool}\n\ |
182 | 6c2c542e | Jose A. Lopes | \ @ivar readd: Whether to re-add an existing node to the cluster. If\n\ |
183 | 6c2c542e | Jose A. Lopes | \ this is not passed, then the operation will abort if the node\n\ |
184 | 6c2c542e | Jose A. Lopes | \ name is already in the cluster; use this parameter to\n\ |
185 | 6c2c542e | Jose A. Lopes | \ 'repair' a node that had its configuration broken, or was\n\ |
186 | 6c2c542e | Jose A. Lopes | \ reinstalled without removal from the cluster.\n\ |
187 | 6c2c542e | Jose A. Lopes | \ @type group: C{str}\n\ |
188 | 6c2c542e | Jose A. Lopes | \ @ivar group: The node group to which this node will belong.\n\ |
189 | 6c2c542e | Jose A. Lopes | \ @type vm_capable: C{bool}\n\ |
190 | 6c2c542e | Jose A. Lopes | \ @ivar vm_capable: The vm_capable node attribute\n\ |
191 | 6c2c542e | Jose A. Lopes | \ @type master_capable: C{bool}\n\ |
192 | 6c2c542e | Jose A. Lopes | \ @ivar master_capable: The master_capable node attribute" |
193 | 6c2c542e | Jose A. Lopes | |
194 | 6c2c542e | Jose A. Lopes | opNodeQuery :: String |
195 | 6c2c542e | Jose A. Lopes | opNodeQuery = |
196 | 6c2c542e | Jose A. Lopes | "Compute the list of nodes." |
197 | 6c2c542e | Jose A. Lopes | |
198 | 6c2c542e | Jose A. Lopes | opNodeQueryvols :: String |
199 | 6c2c542e | Jose A. Lopes | opNodeQueryvols = |
200 | 6c2c542e | Jose A. Lopes | "Get list of volumes on node." |
201 | 6c2c542e | Jose A. Lopes | |
202 | 6c2c542e | Jose A. Lopes | opNodeQueryStorage :: String |
203 | 6c2c542e | Jose A. Lopes | opNodeQueryStorage = |
204 | 6c2c542e | Jose A. Lopes | "Get information on storage for node(s)." |
205 | 6c2c542e | Jose A. Lopes | |
206 | 6c2c542e | Jose A. Lopes | opNodeModifyStorage :: String |
207 | 6c2c542e | Jose A. Lopes | opNodeModifyStorage = |
208 | 6c2c542e | Jose A. Lopes | "Modifies the properies of a storage unit" |
209 | 6c2c542e | Jose A. Lopes | |
210 | 6c2c542e | Jose A. Lopes | opRepairNodeStorage :: String |
211 | 6c2c542e | Jose A. Lopes | opRepairNodeStorage = |
212 | 6c2c542e | Jose A. Lopes | "Repairs the volume group on a node." |
213 | 6c2c542e | Jose A. Lopes | |
214 | 6c2c542e | Jose A. Lopes | opNodeSetParams :: String |
215 | 6c2c542e | Jose A. Lopes | opNodeSetParams = |
216 | 6c2c542e | Jose A. Lopes | "Change the parameters of a node." |
217 | 6c2c542e | Jose A. Lopes | |
218 | 6c2c542e | Jose A. Lopes | opNodePowercycle :: String |
219 | 6c2c542e | Jose A. Lopes | opNodePowercycle = |
220 | 6c2c542e | Jose A. Lopes | "Tries to powercycle a node." |
221 | 6c2c542e | Jose A. Lopes | |
222 | 6c2c542e | Jose A. Lopes | opNodeMigrate :: String |
223 | 6c2c542e | Jose A. Lopes | opNodeMigrate = |
224 | 6c2c542e | Jose A. Lopes | "Migrate all instances from a node." |
225 | 6c2c542e | Jose A. Lopes | |
226 | 6c2c542e | Jose A. Lopes | opNodeEvacuate :: String |
227 | 6c2c542e | Jose A. Lopes | opNodeEvacuate = |
228 | 6c2c542e | Jose A. Lopes | "Evacuate instances off a number of nodes." |
229 | 6c2c542e | Jose A. Lopes | |
230 | 6c2c542e | Jose A. Lopes | opInstanceCreate :: String |
231 | 6c2c542e | Jose A. Lopes | opInstanceCreate = |
232 | 6c2c542e | Jose A. Lopes | "Create an instance.\n\ |
233 | 6c2c542e | Jose A. Lopes | \\n\ |
234 | 6c2c542e | Jose A. Lopes | \ @ivar instance_name: Instance name\n\ |
235 | 6c2c542e | Jose A. Lopes | \ @ivar mode: Instance creation mode (one of\ |
236 | 6c2c542e | Jose A. Lopes | \ L{constants.INSTANCE_CREATE_MODES})\n\ |
237 | 6c2c542e | Jose A. Lopes | \ @ivar source_handshake: Signed handshake from source (remote import only)\n\ |
238 | 6c2c542e | Jose A. Lopes | \ @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)\n\ |
239 | 6c2c542e | Jose A. Lopes | \ @ivar source_instance_name: Previous name of instance (remote import only)\n\ |
240 | 6c2c542e | Jose A. Lopes | \ @ivar source_shutdown_timeout: Shutdown timeout used for source instance\n\ |
241 | 6c2c542e | Jose A. Lopes | \ (remote import only)" |
242 | 6c2c542e | Jose A. Lopes | |
243 | 6c2c542e | Jose A. Lopes | opInstanceMultiAlloc :: String |
244 | 6c2c542e | Jose A. Lopes | opInstanceMultiAlloc = |
245 | 6c2c542e | Jose A. Lopes | "Allocates multiple instances." |
246 | 6c2c542e | Jose A. Lopes | |
247 | 6c2c542e | Jose A. Lopes | opInstanceReinstall :: String |
248 | 6c2c542e | Jose A. Lopes | opInstanceReinstall = |
249 | 6c2c542e | Jose A. Lopes | "Reinstall an instance's OS." |
250 | 6c2c542e | Jose A. Lopes | |
251 | 6c2c542e | Jose A. Lopes | opInstanceRemove :: String |
252 | 6c2c542e | Jose A. Lopes | opInstanceRemove = |
253 | 6c2c542e | Jose A. Lopes | "Remove an instance." |
254 | 6c2c542e | Jose A. Lopes | |
255 | 6c2c542e | Jose A. Lopes | opInstanceRename :: String |
256 | 6c2c542e | Jose A. Lopes | opInstanceRename = |
257 | 6c2c542e | Jose A. Lopes | "Rename an instance." |
258 | 6c2c542e | Jose A. Lopes | |
259 | 6c2c542e | Jose A. Lopes | opInstanceStartup :: String |
260 | 6c2c542e | Jose A. Lopes | opInstanceStartup = |
261 | 6c2c542e | Jose A. Lopes | "Startup an instance." |
262 | 6c2c542e | Jose A. Lopes | |
263 | 6c2c542e | Jose A. Lopes | opInstanceShutdown :: String |
264 | 6c2c542e | Jose A. Lopes | opInstanceShutdown = |
265 | 6c2c542e | Jose A. Lopes | "Shutdown an instance." |
266 | 6c2c542e | Jose A. Lopes | |
267 | 6c2c542e | Jose A. Lopes | opInstanceReboot :: String |
268 | 6c2c542e | Jose A. Lopes | opInstanceReboot = |
269 | 6c2c542e | Jose A. Lopes | "Reboot an instance." |
270 | 6c2c542e | Jose A. Lopes | |
271 | 6c2c542e | Jose A. Lopes | opInstanceReplaceDisks :: String |
272 | 6c2c542e | Jose A. Lopes | opInstanceReplaceDisks = |
273 | 6c2c542e | Jose A. Lopes | "Replace the disks of an instance." |
274 | 6c2c542e | Jose A. Lopes | |
275 | 6c2c542e | Jose A. Lopes | opInstanceFailover :: String |
276 | 6c2c542e | Jose A. Lopes | opInstanceFailover = |
277 | 6c2c542e | Jose A. Lopes | "Failover an instance." |
278 | 6c2c542e | Jose A. Lopes | |
279 | 6c2c542e | Jose A. Lopes | opInstanceMigrate :: String |
280 | 6c2c542e | Jose A. Lopes | opInstanceMigrate = |
281 | 6c2c542e | Jose A. Lopes | "Migrate an instance.\n\ |
282 | 6c2c542e | Jose A. Lopes | \\n\ |
283 | 6c2c542e | Jose A. Lopes | \ This migrates (without shutting down an instance) to its secondary\n\ |
284 | 6c2c542e | Jose A. Lopes | \ node.\n\ |
285 | 6c2c542e | Jose A. Lopes | \\n\ |
286 | 6c2c542e | Jose A. Lopes | \ @ivar instance_name: the name of the instance\n\ |
287 | 6c2c542e | Jose A. Lopes | \ @ivar mode: the migration mode (live, non-live or None for auto)" |
288 | 6c2c542e | Jose A. Lopes | |
289 | 6c2c542e | Jose A. Lopes | opInstanceMove :: String |
290 | 6c2c542e | Jose A. Lopes | opInstanceMove = |
291 | 6c2c542e | Jose A. Lopes | "Move an instance.\n\ |
292 | 6c2c542e | Jose A. Lopes | \\n\ |
293 | 6c2c542e | Jose A. Lopes | \ This move (with shutting down an instance and data copying) to an\n\ |
294 | 6c2c542e | Jose A. Lopes | \ arbitrary node.\n\ |
295 | 6c2c542e | Jose A. Lopes | \\n\ |
296 | 6c2c542e | Jose A. Lopes | \ @ivar instance_name: the name of the instance\n\ |
297 | 6c2c542e | Jose A. Lopes | \ @ivar target_node: the destination node" |
298 | 6c2c542e | Jose A. Lopes | |
299 | 6c2c542e | Jose A. Lopes | opInstanceConsole :: String |
300 | 6c2c542e | Jose A. Lopes | opInstanceConsole = |
301 | 6c2c542e | Jose A. Lopes | "Connect to an instance's console." |
302 | 6c2c542e | Jose A. Lopes | |
303 | 6c2c542e | Jose A. Lopes | opInstanceActivateDisks :: String |
304 | 6c2c542e | Jose A. Lopes | opInstanceActivateDisks = |
305 | 6c2c542e | Jose A. Lopes | "Activate an instance's disks." |
306 | 6c2c542e | Jose A. Lopes | |
307 | 6c2c542e | Jose A. Lopes | opInstanceDeactivateDisks :: String |
308 | 6c2c542e | Jose A. Lopes | opInstanceDeactivateDisks = |
309 | 6c2c542e | Jose A. Lopes | "Deactivate an instance's disks." |
310 | 6c2c542e | Jose A. Lopes | |
311 | 6c2c542e | Jose A. Lopes | opInstanceRecreateDisks :: String |
312 | 6c2c542e | Jose A. Lopes | opInstanceRecreateDisks = |
313 | 6c2c542e | Jose A. Lopes | "Recreate an instance's disks." |
314 | 6c2c542e | Jose A. Lopes | |
315 | 6c2c542e | Jose A. Lopes | opInstanceQuery :: String |
316 | 6c2c542e | Jose A. Lopes | opInstanceQuery = |
317 | 6c2c542e | Jose A. Lopes | "Compute the list of instances." |
318 | 6c2c542e | Jose A. Lopes | |
319 | 6c2c542e | Jose A. Lopes | opInstanceQueryData :: String |
320 | 6c2c542e | Jose A. Lopes | opInstanceQueryData = |
321 | 6c2c542e | Jose A. Lopes | "Compute the run-time status of instances." |
322 | 6c2c542e | Jose A. Lopes | |
323 | 6c2c542e | Jose A. Lopes | opInstanceSetParams :: String |
324 | 6c2c542e | Jose A. Lopes | opInstanceSetParams = |
325 | 6c2c542e | Jose A. Lopes | "Change the parameters of an instance." |
326 | 6c2c542e | Jose A. Lopes | |
327 | 6c2c542e | Jose A. Lopes | opInstanceGrowDisk :: String |
328 | 6c2c542e | Jose A. Lopes | opInstanceGrowDisk = |
329 | 6c2c542e | Jose A. Lopes | "Grow a disk of an instance." |
330 | 6c2c542e | Jose A. Lopes | |
331 | 6c2c542e | Jose A. Lopes | opInstanceChangeGroup :: String |
332 | 6c2c542e | Jose A. Lopes | opInstanceChangeGroup = |
333 | 6c2c542e | Jose A. Lopes | "Moves an instance to another node group." |
334 | 6c2c542e | Jose A. Lopes | |
335 | 7d81bb8b | Dimitris Aragiorgis | opInstanceSnapshot :: String |
336 | 7d81bb8b | Dimitris Aragiorgis | opInstanceSnapshot = |
337 | 7d81bb8b | Dimitris Aragiorgis | "Takes snapshot of requested instance's disks (only for ext template)." |
338 | 7d81bb8b | Dimitris Aragiorgis | |
339 | 6c2c542e | Jose A. Lopes | opGroupAdd :: String |
340 | 6c2c542e | Jose A. Lopes | opGroupAdd = |
341 | 6c2c542e | Jose A. Lopes | "Add a node group to the cluster." |
342 | 6c2c542e | Jose A. Lopes | |
343 | 6c2c542e | Jose A. Lopes | opGroupAssignNodes :: String |
344 | 6c2c542e | Jose A. Lopes | opGroupAssignNodes = |
345 | 6c2c542e | Jose A. Lopes | "Assign nodes to a node group." |
346 | 6c2c542e | Jose A. Lopes | |
347 | 6c2c542e | Jose A. Lopes | opGroupQuery :: String |
348 | 6c2c542e | Jose A. Lopes | opGroupQuery = |
349 | 6c2c542e | Jose A. Lopes | "Compute the list of node groups." |
350 | 6c2c542e | Jose A. Lopes | |
351 | 6c2c542e | Jose A. Lopes | opGroupSetParams :: String |
352 | 6c2c542e | Jose A. Lopes | opGroupSetParams = |
353 | 6c2c542e | Jose A. Lopes | "Change the parameters of a node group." |
354 | 6c2c542e | Jose A. Lopes | |
355 | 6c2c542e | Jose A. Lopes | opGroupRemove :: String |
356 | 6c2c542e | Jose A. Lopes | opGroupRemove = |
357 | 6c2c542e | Jose A. Lopes | "Remove a node group from the cluster." |
358 | 6c2c542e | Jose A. Lopes | |
359 | 6c2c542e | Jose A. Lopes | opGroupRename :: String |
360 | 6c2c542e | Jose A. Lopes | opGroupRename = |
361 | 6c2c542e | Jose A. Lopes | "Rename a node group in the cluster." |
362 | 6c2c542e | Jose A. Lopes | |
363 | 6c2c542e | Jose A. Lopes | opGroupEvacuate :: String |
364 | 6c2c542e | Jose A. Lopes | opGroupEvacuate = |
365 | 6c2c542e | Jose A. Lopes | "Evacuate a node group in the cluster." |
366 | 6c2c542e | Jose A. Lopes | |
367 | 6c2c542e | Jose A. Lopes | opOsDiagnose :: String |
368 | 6c2c542e | Jose A. Lopes | opOsDiagnose = |
369 | 6c2c542e | Jose A. Lopes | "Compute the list of guest operating systems." |
370 | 6c2c542e | Jose A. Lopes | |
371 | 6c2c542e | Jose A. Lopes | opExtStorageDiagnose :: String |
372 | 6c2c542e | Jose A. Lopes | opExtStorageDiagnose = |
373 | 6c2c542e | Jose A. Lopes | "Compute the list of external storage providers." |
374 | 6c2c542e | Jose A. Lopes | |
375 | 6c2c542e | Jose A. Lopes | opBackupQuery :: String |
376 | 6c2c542e | Jose A. Lopes | opBackupQuery = |
377 | 6c2c542e | Jose A. Lopes | "Compute the list of exported images." |
378 | 6c2c542e | Jose A. Lopes | |
379 | 6c2c542e | Jose A. Lopes | opBackupPrepare :: String |
380 | 6c2c542e | Jose A. Lopes | opBackupPrepare = |
381 | 6c2c542e | Jose A. Lopes | "Prepares an instance export.\n\ |
382 | 6c2c542e | Jose A. Lopes | \\n\ |
383 | 6c2c542e | Jose A. Lopes | \ @ivar instance_name: Instance name\n\ |
384 | 6c2c542e | Jose A. Lopes | \ @ivar mode: Export mode (one of L{constants.EXPORT_MODES})" |
385 | 6c2c542e | Jose A. Lopes | |
386 | 6c2c542e | Jose A. Lopes | opBackupExport :: String |
387 | 6c2c542e | Jose A. Lopes | opBackupExport = |
388 | 6c2c542e | Jose A. Lopes | "Export an instance.\n\ |
389 | 6c2c542e | Jose A. Lopes | \\n\ |
390 | 6c2c542e | Jose A. Lopes | \ For local exports, the export destination is the node name. For\n\ |
391 | 6c2c542e | Jose A. Lopes | \ remote exports, the export destination is a list of tuples, each\n\ |
392 | 6c2c542e | Jose A. Lopes | \ consisting of hostname/IP address, port, magic, HMAC and HMAC\n\ |
393 | 6c2c542e | Jose A. Lopes | \ salt. The HMAC is calculated using the cluster domain secret over\n\ |
394 | 6c2c542e | Jose A. Lopes | \ the value \"${index}:${hostname}:${port}\". The destination X509 CA\n\ |
395 | 6c2c542e | Jose A. Lopes | \ must be a signed certificate.\n\ |
396 | 6c2c542e | Jose A. Lopes | \\n\ |
397 | 6c2c542e | Jose A. Lopes | \ @ivar mode: Export mode (one of L{constants.EXPORT_MODES})\n\ |
398 | 6c2c542e | Jose A. Lopes | \ @ivar target_node: Export destination\n\ |
399 | 6c2c542e | Jose A. Lopes | \ @ivar x509_key_name: X509 key to use (remote export only)\n\ |
400 | 6c2c542e | Jose A. Lopes | \ @ivar destination_x509_ca: Destination X509 CA in PEM format (remote\n\ |
401 | 6c2c542e | Jose A. Lopes | \ export only)" |
402 | 6c2c542e | Jose A. Lopes | |
403 | 6c2c542e | Jose A. Lopes | opBackupRemove :: String |
404 | 6c2c542e | Jose A. Lopes | opBackupRemove = |
405 | 6c2c542e | Jose A. Lopes | "Remove an instance's export." |
406 | 6c2c542e | Jose A. Lopes | |
407 | 6c2c542e | Jose A. Lopes | opTagsGet :: String |
408 | 6c2c542e | Jose A. Lopes | opTagsGet = |
409 | 6c2c542e | Jose A. Lopes | "Returns the tags of the given object." |
410 | 6c2c542e | Jose A. Lopes | |
411 | 6c2c542e | Jose A. Lopes | opTagsSearch :: String |
412 | 6c2c542e | Jose A. Lopes | opTagsSearch = |
413 | 6c2c542e | Jose A. Lopes | "Searches the tags in the cluster for a given pattern." |
414 | 6c2c542e | Jose A. Lopes | |
415 | 6c2c542e | Jose A. Lopes | opTagsSet :: String |
416 | 6c2c542e | Jose A. Lopes | opTagsSet = |
417 | 6c2c542e | Jose A. Lopes | "Add a list of tags on a given object." |
418 | 6c2c542e | Jose A. Lopes | |
419 | 6c2c542e | Jose A. Lopes | opTagsDel :: String |
420 | 6c2c542e | Jose A. Lopes | opTagsDel = |
421 | 6c2c542e | Jose A. Lopes | "Remove a list of tags from a given object." |
422 | 6c2c542e | Jose A. Lopes | |
423 | 6c2c542e | Jose A. Lopes | opTestDelay :: String |
424 | 6c2c542e | Jose A. Lopes | opTestDelay = |
425 | 6c2c542e | Jose A. Lopes | "Sleeps for a configured amount of time.\n\ |
426 | 6c2c542e | Jose A. Lopes | \\n\ |
427 | 6c2c542e | Jose A. Lopes | \ This is used just for debugging and testing.\n\ |
428 | 6c2c542e | Jose A. Lopes | \\n\ |
429 | 6c2c542e | Jose A. Lopes | \ Parameters:\n\ |
430 | 6c2c542e | Jose A. Lopes | \ - duration: the time to sleep, in seconds\n\ |
431 | 6c2c542e | Jose A. Lopes | \ - on_master: if true, sleep on the master\n\ |
432 | 6c2c542e | Jose A. Lopes | \ - on_nodes: list of nodes in which to sleep\n\ |
433 | 6c2c542e | Jose A. Lopes | \\n\ |
434 | 6c2c542e | Jose A. Lopes | \ If the on_master parameter is true, it will execute a sleep on the\n\ |
435 | 6c2c542e | Jose A. Lopes | \ master (before any node sleep).\n\ |
436 | 6c2c542e | Jose A. Lopes | \\n\ |
437 | 6c2c542e | Jose A. Lopes | \ If the on_nodes list is not empty, it will sleep on those nodes\n\ |
438 | 6c2c542e | Jose A. Lopes | \ (after the sleep on the master, if that is enabled).\n\ |
439 | 6c2c542e | Jose A. Lopes | \\n\ |
440 | 6c2c542e | Jose A. Lopes | \ As an additional feature, the case of duration < 0 will be reported\n\ |
441 | 6c2c542e | Jose A. Lopes | \ as an execution error, so this opcode can be used as a failure\n\ |
442 | 6c2c542e | Jose A. Lopes | \ generator. The case of duration == 0 will not be treated specially." |
443 | 6c2c542e | Jose A. Lopes | |
444 | 6c2c542e | Jose A. Lopes | opTestAllocator :: String |
445 | 6c2c542e | Jose A. Lopes | opTestAllocator = |
446 | 6c2c542e | Jose A. Lopes | "Allocator framework testing.\n\ |
447 | 6c2c542e | Jose A. Lopes | \\n\ |
448 | 6c2c542e | Jose A. Lopes | \ This opcode has two modes:\n\ |
449 | 6c2c542e | Jose A. Lopes | \ - gather and return allocator input for a given mode (allocate new\n\ |
450 | 6c2c542e | Jose A. Lopes | \ or replace secondary) and a given instance definition (direction\n\ |
451 | 6c2c542e | Jose A. Lopes | \ 'in')\n\ |
452 | 6c2c542e | Jose A. Lopes | \ - run a selected allocator for a given operation (as above) and\n\ |
453 | 6c2c542e | Jose A. Lopes | \ return the allocator output (direction 'out')" |
454 | 6c2c542e | Jose A. Lopes | |
455 | 6c2c542e | Jose A. Lopes | opTestJqueue :: String |
456 | 6c2c542e | Jose A. Lopes | opTestJqueue = |
457 | 6c2c542e | Jose A. Lopes | "Utility opcode to test some aspects of the job queue." |
458 | 6c2c542e | Jose A. Lopes | |
459 | 6c2c542e | Jose A. Lopes | opTestDummy :: String |
460 | 6c2c542e | Jose A. Lopes | opTestDummy = |
461 | 6c2c542e | Jose A. Lopes | "Utility opcode used by unittests." |
462 | 6c2c542e | Jose A. Lopes | |
463 | 6c2c542e | Jose A. Lopes | opNetworkAdd :: String |
464 | 6c2c542e | Jose A. Lopes | opNetworkAdd = |
465 | 6c2c542e | Jose A. Lopes | "Add an IP network to the cluster." |
466 | 6c2c542e | Jose A. Lopes | |
467 | 6c2c542e | Jose A. Lopes | opNetworkRemove :: String |
468 | 6c2c542e | Jose A. Lopes | opNetworkRemove = |
469 | 6c2c542e | Jose A. Lopes | "Remove an existing network from the cluster.\n\ |
470 | 6c2c542e | Jose A. Lopes | \ Must not be connected to any nodegroup." |
471 | 6c2c542e | Jose A. Lopes | |
472 | 6c2c542e | Jose A. Lopes | opNetworkSetParams :: String |
473 | 6c2c542e | Jose A. Lopes | opNetworkSetParams = |
474 | 6c2c542e | Jose A. Lopes | "Modify Network's parameters except for IPv4 subnet" |
475 | 6c2c542e | Jose A. Lopes | |
476 | 6c2c542e | Jose A. Lopes | opNetworkConnect :: String |
477 | 6c2c542e | Jose A. Lopes | opNetworkConnect = |
478 | 6c2c542e | Jose A. Lopes | "Connect a Network to a specific Nodegroup with the defined netparams\n\ |
479 | 6c2c542e | Jose A. Lopes | \ (mode, link). Nics in this Network will inherit those params.\n\ |
480 | 6c2c542e | Jose A. Lopes | \ Produce errors if a NIC (that its not already assigned to a network)\n\ |
481 | 6c2c542e | Jose A. Lopes | \ has an IP that is contained in the Network this will produce error\ |
482 | 6c2c542e | Jose A. Lopes | \ unless\n\ |
483 | 6c2c542e | Jose A. Lopes | \ --no-conflicts-check is passed." |
484 | 6c2c542e | Jose A. Lopes | |
485 | 6c2c542e | Jose A. Lopes | opNetworkDisconnect :: String |
486 | 6c2c542e | Jose A. Lopes | opNetworkDisconnect = |
487 | 6c2c542e | Jose A. Lopes | "Disconnect a Network from a Nodegroup. Produce errors if NICs are\n\ |
488 | 6c2c542e | Jose A. Lopes | \ present in the Network unless --no-conficts-check option is passed." |
489 | 6c2c542e | Jose A. Lopes | |
490 | 6c2c542e | Jose A. Lopes | opNetworkQuery :: String |
491 | 6c2c542e | Jose A. Lopes | opNetworkQuery = |
492 | 6c2c542e | Jose A. Lopes | "Compute the list of networks." |