9ec8cd408ea8d839c2576e1b6232d39027ff330c
[ganeti-local] / lib / client / gnt_group.py
1 #
2 #
3
4 # Copyright (C) 2010 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)
105
106
107 def ListGroupFields(opts, args):
108   """List node fields.
109
110   @param opts: the command line options selected by the user
111   @type args: list
112   @param args: fields to list, or empty for all
113   @rtype: int
114   @return: the desired exit code
115
116   """
117   return GenericListFields(constants.QR_GROUP, args, opts.separator,
118                            not opts.no_headers)
119
120
121 def SetGroupParams(opts, args):
122   """Modifies a node group's parameters.
123
124   @param opts: the command line options seletect by the user
125   @type args: list
126   @param args: should contain only one element, the node group name
127
128   @rtype: int
129   @return: the desired exit code
130
131   """
132   all_changes = {
133     "ndparams": opts.ndparams,
134     "alloc_policy": opts.alloc_policy,
135   }
136
137   if all_changes.values().count(None) == len(all_changes):
138     ToStderr("Please give at least one of the parameters.")
139     return 1
140
141   op = opcodes.OpSetGroupParams(group_name=args[0], # pylint: disable-msg=W0142
142                                 **all_changes)
143   result = SubmitOrSend(op, opts)
144
145   if result:
146     ToStdout("Modified node group %s", args[0])
147     for param, data in result:
148       ToStdout(" - %-5s -> %s", param, data)
149
150   return 0
151
152
153 def RemoveGroup(opts, args):
154   """Remove a node group from the cluster.
155
156   @param opts: the command line options selected by the user
157   @type args: list
158   @param args: a list of length 1 with the name of the group to remove
159   @rtype: int
160   @return: the desired exit code
161
162   """
163   (group_name,) = args
164   op = opcodes.OpRemoveGroup(group_name=group_name)
165   SubmitOpCode(op, opts=opts)
166
167
168 def RenameGroup(opts, args):
169   """Rename a node group.
170
171   @param opts: the command line options selected by the user
172   @type args: list
173   @param args: a list of length 2, [old_name, new_name]
174   @rtype: int
175   @return: the desired exit code
176
177   """
178   old_name, new_name = args
179   op = opcodes.OpRenameGroup(old_name=old_name, new_name=new_name)
180   SubmitOpCode(op, opts=opts)
181
182
183 commands = {
184   "add": (
185     AddGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT],
186     "<group_name>", "Add a new node group to the cluster"),
187   "assign-nodes": (
188     AssignNodes, ARGS_ONE_GROUP + ARGS_MANY_NODES, [DRY_RUN_OPT, FORCE_OPT],
189     "<group_name> <node>...", "Assign nodes to a group"),
190   "list": (
191     ListGroups, ARGS_MANY_GROUPS,
192     [NOHDR_OPT, SEP_OPT, FIELDS_OPT],
193     "[<group_name>...]",
194     "Lists the node groups in the cluster. The available fields can be shown"
195     " using the \"list-fields\" command (see the man page for details)."
196     " The default list is (in order): %s." % utils.CommaJoin(_LIST_DEF_FIELDS)),
197   "list-fields": (
198     ListGroupFields, [ArgUnknown()], [NOHDR_OPT, SEP_OPT], "[fields...]",
199     "Lists all available fields for node groups"),
200   "modify": (
201     SetGroupParams, ARGS_ONE_GROUP,
202     [DRY_RUN_OPT, SUBMIT_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT],
203     "<group_name>", "Alters the parameters of a node group"),
204   "remove": (
205     RemoveGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT],
206     "[--dry-run] <group_name>",
207     "Remove an (empty) node group from the cluster"),
208   "rename": (
209     RenameGroup, [ArgGroup(min=2, max=2)], [DRY_RUN_OPT],
210     "[--dry-run] <old_name> <new_name>", "Rename a node group"),
211 }
212
213
214 def Main():
215   return GenericMain(commands)