Statistics
| Branch: | Tag: | Revision:

root / lib / client / gnt_group.py @ 216d23c0

History | View | Annotate | Download (11.5 kB)

1
#
2
#
3

    
4
# Copyright (C) 2010, 2011, 2012 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
from cStringIO import StringIO
33

    
34

    
35
#: default list of fields for L{ListGroups}
36
_LIST_DEF_FIELDS = ["name", "node_cnt", "pinst_cnt", "alloc_policy", "ndparams"]
37

    
38

    
39
_ENV_OVERRIDE = frozenset(["list"])
40

    
41

    
42
def AddGroup(opts, args):
43
  """Add a node group to the cluster.
44

45
  @param opts: the command line options selected by the user
46
  @type args: list
47
  @param args: a list of length 1 with the name of the group to create
48
  @rtype: int
49
  @return: the desired exit code
50

51
  """
52
  ipolicy = \
53
    objects.CreateIPolicyFromOpts(ispecs_mem_size=opts.ispecs_mem_size,
54
                                  ispecs_cpu_count=opts.ispecs_cpu_count,
55
                                  ispecs_disk_count=opts.ispecs_disk_count,
56
                                  ispecs_disk_size=opts.ispecs_disk_size,
57
                                  ispecs_nic_count=opts.ispecs_nic_count,
58
                                  group_ipolicy=True)
59

    
60
  (group_name,) = args
61
  diskparams = dict(opts.diskparams)
62

    
63
  if opts.disk_state:
64
    disk_state = utils.FlatToDict(opts.disk_state)
65
  else:
66
    disk_state = {}
67
  hv_state = dict(opts.hv_state)
68

    
69
  op = opcodes.OpGroupAdd(group_name=group_name, ndparams=opts.ndparams,
70
                          alloc_policy=opts.alloc_policy,
71
                          diskparams=diskparams, ipolicy=ipolicy,
72
                          hv_state=hv_state,
73
                          disk_state=disk_state)
74
  SubmitOrSend(op, opts)
75

    
76

    
77
def AssignNodes(opts, args):
78
  """Assign nodes to a group.
79

80
  @param opts: the command line options selected by the user
81
  @type args: list
82
  @param args: args[0]: group to assign nodes to; args[1:]: nodes to assign
83
  @rtype: int
84
  @return: the desired exit code
85

86
  """
87
  group_name = args[0]
88
  node_names = args[1:]
89

    
90
  op = opcodes.OpGroupAssignNodes(group_name=group_name, nodes=node_names,
91
                                  force=opts.force)
92
  SubmitOrSend(op, opts)
93

    
94

    
95
def _FmtDict(data):
96
  """Format dict data into command-line format.
97

98
  @param data: The input dict to be formatted
99
  @return: The formatted dict
100

101
  """
102
  if not data:
103
    return "(empty)"
104

    
105
  return utils.CommaJoin(["%s=%s" % (key, value)
106
                          for key, value in data.items()])
107

    
108

    
109
def ListGroups(opts, args):
110
  """List node groups and their properties.
111

112
  @param opts: the command line options selected by the user
113
  @type args: list
114
  @param args: groups to list, or empty for all
115
  @rtype: int
116
  @return: the desired exit code
117

118
  """
119
  desired_fields = ParseFields(opts.output, _LIST_DEF_FIELDS)
120
  fmtoverride = {
121
    "node_list": (",".join, False),
122
    "pinst_list": (",".join, False),
123
    "ndparams": (_FmtDict, False),
124
    }
125

    
126
  return GenericList(constants.QR_GROUP, desired_fields, args, None,
127
                     opts.separator, not opts.no_headers,
128
                     format_override=fmtoverride, verbose=opts.verbose,
129
                     force_filter=opts.force_filter)
130

    
131

    
132
def ListGroupFields(opts, args):
133
  """List node fields.
134

135
  @param opts: the command line options selected by the user
136
  @type args: list
137
  @param args: fields to list, or empty for all
138
  @rtype: int
139
  @return: the desired exit code
140

141
  """
142
  return GenericListFields(constants.QR_GROUP, args, opts.separator,
143
                           not opts.no_headers)
144

    
145

    
146
def SetGroupParams(opts, args):
147
  """Modifies a node group's parameters.
148

149
  @param opts: the command line options selected by the user
150
  @type args: list
151
  @param args: should contain only one element, the node group name
152

153
  @rtype: int
154
  @return: the desired exit code
155

156
  """
157
  allmods = [opts.ndparams, opts.alloc_policy, opts.diskparams, opts.hv_state,
158
             opts.disk_state, opts.ispecs_mem_size, opts.ispecs_cpu_count,
159
             opts.ispecs_disk_count, opts.ispecs_disk_size,
160
             opts.ispecs_nic_count, opts.diskparams]
161
  if allmods.count(None) == len(allmods):
162
    ToStderr("Please give at least one of the parameters.")
163
    return 1
164

    
165
  if opts.disk_state:
166
    disk_state = utils.FlatToDict(opts.disk_state)
167
  else:
168
    disk_state = {}
169

    
170
  hv_state = dict(opts.hv_state)
171

    
172
  diskparams = dict(opts.diskparams)
173

    
174
  # set the default values
175
  to_ipolicy = [
176
    opts.ispecs_mem_size,
177
    opts.ispecs_cpu_count,
178
    opts.ispecs_disk_count,
179
    opts.ispecs_disk_size,
180
    opts.ispecs_nic_count,
181
    ]
182
  for ispec in to_ipolicy:
183
    for param in ispec:
184
      if isinstance(ispec[param], basestring):
185
        if ispec[param].lower() == "default":
186
          ispec[param] = constants.VALUE_DEFAULT
187
  # create ipolicy object
188
  ipolicy = objects.CreateIPolicyFromOpts(\
189
    ispecs_mem_size=opts.ispecs_mem_size,
190
    ispecs_cpu_count=opts.ispecs_cpu_count,
191
    ispecs_disk_count=opts.ispecs_disk_count,
192
    ispecs_disk_size=opts.ispecs_disk_size,
193
    ispecs_nic_count=opts.ispecs_nic_count,
194
    ipolicy_disk_templates=opts.ipolicy_disk_templates,
195
    group_ipolicy=True,
196
    allowed_values=[constants.VALUE_DEFAULT])
197

    
198
  op = opcodes.OpGroupSetParams(group_name=args[0],
199
                                ndparams=opts.ndparams,
200
                                alloc_policy=opts.alloc_policy,
201
                                hv_state=hv_state,
202
                                disk_state=disk_state,
203
                                diskparams=diskparams,
204
                                ipolicy=ipolicy)
205

    
206
  result = SubmitOrSend(op, opts)
207

    
208
  if result:
209
    ToStdout("Modified node group %s", args[0])
210
    for param, data in result:
211
      ToStdout(" - %-5s -> %s", param, data)
212

    
213
  return 0
214

    
215

    
216
def RemoveGroup(opts, args):
217
  """Remove a node group from the cluster.
218

219
  @param opts: the command line options selected by the user
220
  @type args: list
221
  @param args: a list of length 1 with the name of the group to remove
222
  @rtype: int
223
  @return: the desired exit code
224

225
  """
226
  (group_name,) = args
227
  op = opcodes.OpGroupRemove(group_name=group_name)
228
  SubmitOrSend(op, opts)
229

    
230

    
231
def RenameGroup(opts, args):
232
  """Rename a node group.
233

234
  @param opts: the command line options selected by the user
235
  @type args: list
236
  @param args: a list of length 2, [old_name, new_name]
237
  @rtype: int
238
  @return: the desired exit code
239

240
  """
241
  group_name, new_name = args
242
  op = opcodes.OpGroupRename(group_name=group_name, new_name=new_name)
243
  SubmitOrSend(op, opts)
244

    
245

    
246
def EvacuateGroup(opts, args):
247
  """Evacuate a node group.
248

249
  """
250
  (group_name, ) = args
251

    
252
  cl = GetClient()
253

    
254
  op = opcodes.OpGroupEvacuate(group_name=group_name,
255
                               iallocator=opts.iallocator,
256
                               target_groups=opts.to,
257
                               early_release=opts.early_release)
258
  result = SubmitOrSend(op, opts, cl=cl)
259

    
260
  # Keep track of submitted jobs
261
  jex = JobExecutor(cl=cl, opts=opts)
262

    
263
  for (status, job_id) in result[constants.JOB_IDS_KEY]:
264
    jex.AddJobId(None, status, job_id)
265

    
266
  results = jex.GetResults()
267
  bad_cnt = len([row for row in results if not row[0]])
268
  if bad_cnt == 0:
269
    ToStdout("All instances evacuated successfully.")
270
    rcode = constants.EXIT_SUCCESS
271
  else:
272
    ToStdout("There were %s errors during the evacuation.", bad_cnt)
273
    rcode = constants.EXIT_FAILURE
274

    
275
  return rcode
276

    
277

    
278
def _FormatDict(custom, actual, level=2):
279
  """Helper function to L{cli.FormatParameterDict}.
280

281
  @param custom: The customized dict
282
  @param actual: The fully filled dict
283

284
  """
285
  buf = StringIO()
286
  FormatParameterDict(buf, custom, actual, level=level)
287
  return buf.getvalue().rstrip("\n")
288

    
289

    
290
def GroupInfo(_, args):
291
  """Shows info about node group.
292

293
  """
294
  cl = GetClient()
295
  selected_fields = ["name",
296
                     "ndparams", "custom_ndparams",
297
                     "diskparams", "custom_diskparams",
298
                     "ipolicy", "custom_ipolicy"]
299
  result = cl.QueryGroups(names=args, fields=selected_fields,
300
                          use_locking=False)
301

    
302
  for (name,
303
       ndparams, custom_ndparams,
304
       diskparams, custom_diskparams,
305
       ipolicy, custom_ipolicy) in result:
306
    ToStdout("Node group: %s" % name)
307
    ToStdout("  Node parameters:")
308
    ToStdout(_FormatDict(custom_ndparams, ndparams))
309
    ToStdout("  Disk parameters:")
310
    ToStdout(_FormatDict(custom_diskparams, diskparams))
311
    ToStdout("  Instance policy:")
312
    ToStdout(_FormatDict(custom_ipolicy, ipolicy))
313

    
314

    
315
commands = {
316
  "add": (
317
    AddGroup, ARGS_ONE_GROUP,
318
    [DRY_RUN_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT, DISK_PARAMS_OPT,
319
     HV_STATE_OPT, DISK_STATE_OPT, PRIORITY_OPT,
320
     SUBMIT_OPT] + INSTANCE_POLICY_OPTS,
321
    "<group_name>", "Add a new node group to the cluster"),
322
  "assign-nodes": (
323
    AssignNodes, ARGS_ONE_GROUP + ARGS_MANY_NODES,
324
    [DRY_RUN_OPT, FORCE_OPT, PRIORITY_OPT, SUBMIT_OPT],
325
    "<group_name> <node>...", "Assign nodes to a group"),
326
  "list": (
327
    ListGroups, ARGS_MANY_GROUPS,
328
    [NOHDR_OPT, SEP_OPT, FIELDS_OPT, VERBOSE_OPT, FORCE_FILTER_OPT],
329
    "[<group_name>...]",
330
    "Lists the node groups in the cluster. The available fields can be shown"
331
    " using the \"list-fields\" command (see the man page for details)."
332
    " The default list is (in order): %s." % utils.CommaJoin(_LIST_DEF_FIELDS)),
333
  "list-fields": (
334
    ListGroupFields, [ArgUnknown()], [NOHDR_OPT, SEP_OPT], "[fields...]",
335
    "Lists all available fields for node groups"),
336
  "modify": (
337
    SetGroupParams, ARGS_ONE_GROUP,
338
    [DRY_RUN_OPT, SUBMIT_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT, HV_STATE_OPT,
339
     DISK_STATE_OPT, DISK_PARAMS_OPT, PRIORITY_OPT] + INSTANCE_POLICY_OPTS,
340
    "<group_name>", "Alters the parameters of a node group"),
341
  "remove": (
342
    RemoveGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT, PRIORITY_OPT, SUBMIT_OPT],
343
    "[--dry-run] <group-name>",
344
    "Remove an (empty) node group from the cluster"),
345
  "rename": (
346
    RenameGroup, [ArgGroup(min=2, max=2)],
347
    [DRY_RUN_OPT, SUBMIT_OPT, PRIORITY_OPT],
348
    "[--dry-run] <group-name> <new-name>", "Rename a node group"),
349
  "evacuate": (
350
    EvacuateGroup, [ArgGroup(min=1, max=1)],
351
    [TO_GROUP_OPT, IALLOCATOR_OPT, EARLY_RELEASE_OPT, SUBMIT_OPT, PRIORITY_OPT],
352
    "[-I <iallocator>] [--to <group>]",
353
    "Evacuate all instances within a group"),
354
  "list-tags": (
355
    ListTags, ARGS_ONE_GROUP, [],
356
    "<group_name>", "List the tags of the given group"),
357
  "add-tags": (
358
    AddTags, [ArgGroup(min=1, max=1), ArgUnknown()],
359
    [TAG_SRC_OPT, PRIORITY_OPT, SUBMIT_OPT],
360
    "<group_name> tag...", "Add tags to the given group"),
361
  "remove-tags": (
362
    RemoveTags, [ArgGroup(min=1, max=1), ArgUnknown()],
363
    [TAG_SRC_OPT, PRIORITY_OPT, SUBMIT_OPT],
364
    "<group_name> tag...", "Remove tags from the given group"),
365
  "info": (
366
    GroupInfo, ARGS_MANY_GROUPS, [], "<group_name>", "Show group information"),
367
  }
368

    
369

    
370
def Main():
371
  return GenericMain(commands,
372
                     override={"tag_type": constants.TAG_NODEGROUP},
373
                     env_override=_ENV_OVERRIDE)