AddGroup supports instance policy
[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=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 objects
30 from ganeti import opcodes
31 from ganeti import utils
32
33
34 #: default list of fields for L{ListGroups}
35 _LIST_DEF_FIELDS = ["name", "node_cnt", "pinst_cnt", "alloc_policy", "ndparams"]
36
37
38 _ENV_OVERRIDE = frozenset(["list"])
39
40
41 def AddGroup(opts, args):
42   """Add a node group to the cluster.
43
44   @param opts: the command line options selected by the user
45   @type args: list
46   @param args: a list of length 1 with the name of the group to create
47   @rtype: int
48   @return: the desired exit code
49
50   """
51   ipolicy = \
52     objects.CreateIPolicyFromOpts(ispecs_mem_size=opts.ispecs_mem_size,
53                                   ispecs_cpu_count=opts.ispecs_cpu_count,
54                                   ispecs_disk_count=opts.ispecs_disk_count,
55                                   ispecs_disk_size=opts.ispecs_disk_size,
56                                   ispecs_nic_count=opts.ispecs_nic_count,
57                                   group_ipolicy=True)
58   for key in ipolicy.keys():
59     utils.ForceDictType(ipolicy[key], constants.ISPECS_PARAMETER_TYPES)
60
61   (group_name,) = args
62   diskparams = dict(opts.diskparams)
63   op = opcodes.OpGroupAdd(group_name=group_name, ndparams=opts.ndparams,
64                           alloc_policy=opts.alloc_policy,
65                           diskparams=diskparams, ipolicy=ipolicy)
66   SubmitOpCode(op, opts=opts)
67
68
69 def AssignNodes(opts, args):
70   """Assign nodes to a group.
71
72   @param opts: the command line options selected by the user
73   @type args: list
74   @param args: args[0]: group to assign nodes to; args[1:]: nodes to assign
75   @rtype: int
76   @return: the desired exit code
77
78   """
79   group_name = args[0]
80   node_names = args[1:]
81
82   op = opcodes.OpGroupAssignNodes(group_name=group_name, nodes=node_names,
83                                   force=opts.force)
84   SubmitOpCode(op, opts=opts)
85
86
87 def _FmtDict(data):
88   """Format dict data into command-line format.
89
90   @param data: The input dict to be formatted
91   @return: The formatted dict
92
93   """
94   if not data:
95     return "(empty)"
96
97   return utils.CommaJoin(["%s=%s" % (key, value)
98                           for key, value in data.items()])
99
100
101 def ListGroups(opts, args):
102   """List node groups and their properties.
103
104   @param opts: the command line options selected by the user
105   @type args: list
106   @param args: groups to list, or empty for all
107   @rtype: int
108   @return: the desired exit code
109
110   """
111   desired_fields = ParseFields(opts.output, _LIST_DEF_FIELDS)
112   fmtoverride = {
113     "node_list": (",".join, False),
114     "pinst_list": (",".join, False),
115     "ndparams": (_FmtDict, False),
116     }
117
118   return GenericList(constants.QR_GROUP, desired_fields, args, None,
119                      opts.separator, not opts.no_headers,
120                      format_override=fmtoverride, verbose=opts.verbose,
121                      force_filter=opts.force_filter)
122
123
124 def ListGroupFields(opts, args):
125   """List node fields.
126
127   @param opts: the command line options selected by the user
128   @type args: list
129   @param args: fields to list, or empty for all
130   @rtype: int
131   @return: the desired exit code
132
133   """
134   return GenericListFields(constants.QR_GROUP, args, opts.separator,
135                            not opts.no_headers)
136
137
138 def SetGroupParams(opts, args):
139   """Modifies a node group's parameters.
140
141   @param opts: the command line options selected by the user
142   @type args: list
143   @param args: should contain only one element, the node group name
144
145   @rtype: int
146   @return: the desired exit code
147
148   """
149   if (opts.ndparams is None and opts.alloc_policy is None
150       and not opts.diskparams and not opts.hv_state and not opts.disk_state):
151     ToStderr("Please give at least one of the parameters.")
152     return 1
153
154   if opts.disk_state:
155     disk_state = utils.FlatToDict(opts.disk_state)
156   else:
157     disk_state = {}
158
159   hv_state = dict(opts.hv_state)
160
161   diskparams = dict(opts.diskparams)
162   op = opcodes.OpGroupSetParams(group_name=args[0],
163                                 ndparams=opts.ndparams,
164                                 alloc_policy=opts.alloc_policy,
165                                 hv_state=hv_state,
166                                 disk_state=disk_state,
167                                 diskparams=diskparams)
168   result = SubmitOrSend(op, opts)
169
170   if result:
171     ToStdout("Modified node group %s", args[0])
172     for param, data in result:
173       ToStdout(" - %-5s -> %s", param, data)
174
175   return 0
176
177
178 def RemoveGroup(opts, args):
179   """Remove a node group from the cluster.
180
181   @param opts: the command line options selected by the user
182   @type args: list
183   @param args: a list of length 1 with the name of the group to remove
184   @rtype: int
185   @return: the desired exit code
186
187   """
188   (group_name,) = args
189   op = opcodes.OpGroupRemove(group_name=group_name)
190   SubmitOpCode(op, opts=opts)
191
192
193 def RenameGroup(opts, args):
194   """Rename a node group.
195
196   @param opts: the command line options selected by the user
197   @type args: list
198   @param args: a list of length 2, [old_name, new_name]
199   @rtype: int
200   @return: the desired exit code
201
202   """
203   group_name, new_name = args
204   op = opcodes.OpGroupRename(group_name=group_name, new_name=new_name)
205   SubmitOpCode(op, opts=opts)
206
207
208 def EvacuateGroup(opts, args):
209   """Evacuate a node group.
210
211   """
212   (group_name, ) = args
213
214   cl = GetClient()
215
216   op = opcodes.OpGroupEvacuate(group_name=group_name,
217                                iallocator=opts.iallocator,
218                                target_groups=opts.to,
219                                early_release=opts.early_release)
220   result = SubmitOpCode(op, cl=cl, opts=opts)
221
222   # Keep track of submitted jobs
223   jex = JobExecutor(cl=cl, opts=opts)
224
225   for (status, job_id) in result[constants.JOB_IDS_KEY]:
226     jex.AddJobId(None, status, job_id)
227
228   results = jex.GetResults()
229   bad_cnt = len([row for row in results if not row[0]])
230   if bad_cnt == 0:
231     ToStdout("All instances evacuated successfully.")
232     rcode = constants.EXIT_SUCCESS
233   else:
234     ToStdout("There were %s errors during the evacuation.", bad_cnt)
235     rcode = constants.EXIT_FAILURE
236
237   return rcode
238
239 INSTANCE_POLICY_OPTS = [
240   SPECS_CPU_COUNT_OPT,
241   SPECS_DISK_COUNT_OPT,
242   SPECS_DISK_SIZE_OPT,
243   SPECS_MEM_SIZE_OPT,
244   SPECS_NIC_COUNT_OPT,
245   ]
246
247 commands = {
248   "add": (
249     AddGroup, ARGS_ONE_GROUP,
250     [DRY_RUN_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT, DISK_PARAMS_OPT] +
251     INSTANCE_POLICY_OPTS,
252     "<group_name>", "Add a new node group to the cluster"),
253   "assign-nodes": (
254     AssignNodes, ARGS_ONE_GROUP + ARGS_MANY_NODES, [DRY_RUN_OPT, FORCE_OPT],
255     "<group_name> <node>...", "Assign nodes to a group"),
256   "list": (
257     ListGroups, ARGS_MANY_GROUPS,
258     [NOHDR_OPT, SEP_OPT, FIELDS_OPT, VERBOSE_OPT, FORCE_FILTER_OPT],
259     "[<group_name>...]",
260     "Lists the node groups in the cluster. The available fields can be shown"
261     " using the \"list-fields\" command (see the man page for details)."
262     " The default list is (in order): %s." % utils.CommaJoin(_LIST_DEF_FIELDS)),
263   "list-fields": (
264     ListGroupFields, [ArgUnknown()], [NOHDR_OPT, SEP_OPT], "[fields...]",
265     "Lists all available fields for node groups"),
266   "modify": (
267     SetGroupParams, ARGS_ONE_GROUP,
268     [DRY_RUN_OPT, SUBMIT_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT, HV_STATE_OPT,
269      DISK_STATE_OPT, DISK_PARAMS_OPT],
270     "<group_name>", "Alters the parameters of a node group"),
271   "remove": (
272     RemoveGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT],
273     "[--dry-run] <group-name>",
274     "Remove an (empty) node group from the cluster"),
275   "rename": (
276     RenameGroup, [ArgGroup(min=2, max=2)], [DRY_RUN_OPT],
277     "[--dry-run] <group-name> <new-name>", "Rename a node group"),
278   "evacuate": (
279     EvacuateGroup, [ArgGroup(min=1, max=1)],
280     [TO_GROUP_OPT, IALLOCATOR_OPT, EARLY_RELEASE_OPT],
281     "[-I <iallocator>] [--to <group>]",
282     "Evacuate all instances within a group"),
283   "list-tags": (
284     ListTags, ARGS_ONE_GROUP, [PRIORITY_OPT],
285     "<instance_name>", "List the tags of the given instance"),
286   "add-tags": (
287     AddTags, [ArgGroup(min=1, max=1), ArgUnknown()],
288     [TAG_SRC_OPT, PRIORITY_OPT],
289     "<instance_name> tag...", "Add tags to the given instance"),
290   "remove-tags": (
291     RemoveTags, [ArgGroup(min=1, max=1), ArgUnknown()],
292     [TAG_SRC_OPT, PRIORITY_OPT],
293     "<instance_name> tag...", "Remove tags from given instance"),
294   }
295
296
297 def Main():
298   return GenericMain(commands,
299                      override={"tag_type": constants.TAG_NODEGROUP},
300                      env_override=_ENV_OVERRIDE)