gnt-group: Add command to evacuate whole group
[ganeti-local] / lib / client / gnt_group.py
1 #
2 #
3
4 # Copyright (C) 2010, 2011 Google Inc.
5 #
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 # General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 # 02110-1301, USA.
20
21 """Node group related commands"""
22
23 # pylint: disable-msg=W0401,W0614
24 # W0401: Wildcard import ganeti.cli
25 # W0614: Unused import %s from wildcard import (since we need cli)
26
27 from ganeti.cli import *
28 from ganeti import constants
29 from ganeti import opcodes
30 from ganeti import utils
31
32
33 #: default list of fields for L{ListGroups}
34 _LIST_DEF_FIELDS = ["name", "node_cnt", "pinst_cnt", "alloc_policy", "ndparams"]
35
36
37 def AddGroup(opts, args):
38   """Add a node group to the cluster.
39
40   @param opts: the command line options selected by the user
41   @type args: list
42   @param args: a list of length 1 with the name of the group to create
43   @rtype: int
44   @return: the desired exit code
45
46   """
47   (group_name,) = args
48   op = opcodes.OpGroupAdd(group_name=group_name, ndparams=opts.ndparams,
49                           alloc_policy=opts.alloc_policy)
50   SubmitOpCode(op, opts=opts)
51
52
53 def AssignNodes(opts, args):
54   """Assign nodes to a group.
55
56   @param opts: the command line options selected by the user
57   @type args: list
58   @param args: args[0]: group to assign nodes to; args[1:]: nodes to assign
59   @rtype: int
60   @return: the desired exit code
61
62   """
63   group_name = args[0]
64   node_names = args[1:]
65
66   op = opcodes.OpGroupAssignNodes(group_name=group_name, nodes=node_names,
67                                   force=opts.force)
68   SubmitOpCode(op, opts=opts)
69
70
71 def _FmtDict(data):
72   """Format dict data into command-line format.
73
74   @param data: The input dict to be formatted
75   @return: The formatted dict
76
77   """
78   if not data:
79     return "(empty)"
80
81   return utils.CommaJoin(["%s=%s" % (key, value)
82                           for key, value in data.items()])
83
84
85 def ListGroups(opts, args):
86   """List node groups and their properties.
87
88   @param opts: the command line options selected by the user
89   @type args: list
90   @param args: groups to list, or empty for all
91   @rtype: int
92   @return: the desired exit code
93
94   """
95   desired_fields = ParseFields(opts.output, _LIST_DEF_FIELDS)
96   fmtoverride = {
97     "node_list": (",".join, False),
98     "pinst_list": (",".join, False),
99     "ndparams": (_FmtDict, False),
100     }
101
102   return GenericList(constants.QR_GROUP, desired_fields, args, None,
103                      opts.separator, not opts.no_headers,
104                      format_override=fmtoverride, verbose=opts.verbose,
105                      force_filter=opts.force_filter)
106
107
108 def ListGroupFields(opts, args):
109   """List node fields.
110
111   @param opts: the command line options selected by the user
112   @type args: list
113   @param args: fields to list, or empty for all
114   @rtype: int
115   @return: the desired exit code
116
117   """
118   return GenericListFields(constants.QR_GROUP, args, opts.separator,
119                            not opts.no_headers)
120
121
122 def SetGroupParams(opts, args):
123   """Modifies a node group's parameters.
124
125   @param opts: the command line options selected by the user
126   @type args: list
127   @param args: should contain only one element, the node group name
128
129   @rtype: int
130   @return: the desired exit code
131
132   """
133   all_changes = {
134     "ndparams": opts.ndparams,
135     "alloc_policy": opts.alloc_policy,
136   }
137
138   if all_changes.values().count(None) == len(all_changes):
139     ToStderr("Please give at least one of the parameters.")
140     return 1
141
142   op = opcodes.OpGroupSetParams(group_name=args[0], # pylint: disable-msg=W0142
143                                 **all_changes)
144   result = SubmitOrSend(op, opts)
145
146   if result:
147     ToStdout("Modified node group %s", args[0])
148     for param, data in result:
149       ToStdout(" - %-5s -> %s", param, data)
150
151   return 0
152
153
154 def RemoveGroup(opts, args):
155   """Remove a node group from the cluster.
156
157   @param opts: the command line options selected by the user
158   @type args: list
159   @param args: a list of length 1 with the name of the group to remove
160   @rtype: int
161   @return: the desired exit code
162
163   """
164   (group_name,) = args
165   op = opcodes.OpGroupRemove(group_name=group_name)
166   SubmitOpCode(op, opts=opts)
167
168
169 def RenameGroup(opts, args):
170   """Rename a node group.
171
172   @param opts: the command line options selected by the user
173   @type args: list
174   @param args: a list of length 2, [old_name, new_name]
175   @rtype: int
176   @return: the desired exit code
177
178   """
179   group_name, new_name = args
180   op = opcodes.OpGroupRename(group_name=group_name, new_name=new_name)
181   SubmitOpCode(op, opts=opts)
182
183
184 def EvacuateGroup(opts, args):
185   """Evacuate a node group.
186
187   """
188   (group_name, ) = args
189
190   cl = GetClient()
191
192   op = opcodes.OpGroupEvacuate(group_name=group_name,
193                                iallocator=opts.iallocator,
194                                target_groups=opts.to,
195                                early_release=opts.early_release)
196   result = SubmitOpCode(op, cl=cl, opts=opts)
197
198   # Keep track of submitted jobs
199   jex = JobExecutor(cl=cl, opts=opts)
200
201   for (status, job_id) in result[constants.JOB_IDS_KEY]:
202     jex.AddJobId(None, status, job_id)
203
204   results = jex.GetResults()
205   bad_cnt = len([row for row in results if not row[0]])
206   if bad_cnt == 0:
207     ToStdout("All instances evacuated successfully.")
208     rcode = constants.EXIT_SUCCESS
209   else:
210     ToStdout("There were %s errors during the evacuation.", bad_cnt)
211     rcode = constants.EXIT_FAILURE
212
213   return rcode
214
215 commands = {
216   "add": (
217     AddGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT],
218     "<group_name>", "Add a new node group to the cluster"),
219   "assign-nodes": (
220     AssignNodes, ARGS_ONE_GROUP + ARGS_MANY_NODES, [DRY_RUN_OPT, FORCE_OPT],
221     "<group_name> <node>...", "Assign nodes to a group"),
222   "list": (
223     ListGroups, ARGS_MANY_GROUPS,
224     [NOHDR_OPT, SEP_OPT, FIELDS_OPT, VERBOSE_OPT, FORCE_FILTER_OPT],
225     "[<group_name>...]",
226     "Lists the node groups in the cluster. The available fields can be shown"
227     " using the \"list-fields\" command (see the man page for details)."
228     " The default list is (in order): %s." % utils.CommaJoin(_LIST_DEF_FIELDS)),
229   "list-fields": (
230     ListGroupFields, [ArgUnknown()], [NOHDR_OPT, SEP_OPT], "[fields...]",
231     "Lists all available fields for node groups"),
232   "modify": (
233     SetGroupParams, ARGS_ONE_GROUP,
234     [DRY_RUN_OPT, SUBMIT_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT],
235     "<group_name>", "Alters the parameters of a node group"),
236   "remove": (
237     RemoveGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT],
238     "[--dry-run] <group-name>",
239     "Remove an (empty) node group from the cluster"),
240   "rename": (
241     RenameGroup, [ArgGroup(min=2, max=2)], [DRY_RUN_OPT],
242     "[--dry-run] <group-name> <new-name>", "Rename a node group"),
243   "evacuate": (
244     EvacuateGroup, [ArgGroup(min=1, max=1)],
245     [TO_GROUP_OPT, IALLOCATOR_OPT, EARLY_RELEASE_OPT],
246     "-I <iallocator> [--to <group>]", "Evacuate all instances within a group"),
247   "list-tags": (
248     ListTags, ARGS_ONE_GROUP, [PRIORITY_OPT],
249     "<instance_name>", "List the tags of the given instance"),
250   "add-tags": (
251     AddTags, [ArgGroup(min=1, max=1), ArgUnknown()],
252     [TAG_SRC_OPT, PRIORITY_OPT],
253     "<instance_name> tag...", "Add tags to the given instance"),
254   "remove-tags": (
255     RemoveTags, [ArgGroup(min=1, max=1), ArgUnknown()],
256     [TAG_SRC_OPT, PRIORITY_OPT],
257     "<instance_name> tag...", "Remove tags from given instance"),
258   }
259
260
261 def Main():
262   return GenericMain(commands,
263                      override={"tag_type": constants.TAG_NODEGROUP})