summaryrefslogtreecommitdiff
path: root/ironicclient/osc/v1/baremetal_deploy_template.py
blob: e624b0a3009db66821d3ee543635f849794e0fa1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
#   Licensed under the Apache License, Version 2.0 (the "License"); you may
#   not use this file except in compliance with the License. You may obtain
#   a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#   License for the specific language governing permissions and limitations
#   under the License.
#

import itertools
import json
import logging

from osc_lib.command import command
from osc_lib import utils as oscutils

from ironicclient.common.i18n import _
from ironicclient.common import utils
from ironicclient import exc
from ironicclient.v1 import resource_fields as res_fields


_DEPLOY_STEPS_HELP = _(
    "The deploy steps. May be the path to a YAML file containing the deploy "
    "steps; OR '-', with the deploy steps being read from standard "
    "input; OR a JSON string. The value should be a list of deploy-step "
    "dictionaries; each dictionary should have keys 'interface', 'step', "
    "'args' and 'priority'.")


class CreateBaremetalDeployTemplate(command.ShowOne):
    """Create a new deploy template"""

    log = logging.getLogger(__name__ + ".CreateBaremetalDeployTemplate")

    def get_parser(self, prog_name):
        parser = super(CreateBaremetalDeployTemplate, self).get_parser(
            prog_name)

        parser.add_argument(
            'name',
            metavar='<name>',
            help=_('Unique name for this deploy template. Must be a valid '
                   'trait name')
        )
        parser.add_argument(
            '--uuid',
            dest='uuid',
            metavar='<uuid>',
            help=_('UUID of the deploy template.'))
        parser.add_argument(
            '--extra',
            metavar="<key=value>",
            action='append',
            help=_("Record arbitrary key/value metadata. "
                   "Can be specified multiple times."))
        parser.add_argument(
            '--steps',
            metavar="<steps>",
            required=True,
            help=_DEPLOY_STEPS_HELP
        )
        return parser

    def take_action(self, parsed_args):
        self.log.debug("take_action(%s)", parsed_args)
        baremetal_client = self.app.client_manager.baremetal

        steps = utils.handle_json_arg(parsed_args.steps, 'deploy steps')

        field_list = ['name', 'uuid', 'extra']
        fields = dict((k, v) for (k, v) in vars(parsed_args).items()
                      if k in field_list and v is not None)
        fields = utils.args_array_to_dict(fields, 'extra')
        template = baremetal_client.deploy_template.create(steps=steps,
                                                           **fields)

        data = dict([(f, getattr(template, f, '')) for f in
                     res_fields.DEPLOY_TEMPLATE_DETAILED_RESOURCE.fields])

        return self.dict2columns(data)


class ShowBaremetalDeployTemplate(command.ShowOne):
    """Show baremetal deploy template details."""

    log = logging.getLogger(__name__ + ".ShowBaremetalDeployTemplate")

    def get_parser(self, prog_name):
        parser = super(ShowBaremetalDeployTemplate, self).get_parser(prog_name)
        parser.add_argument(
            "template",
            metavar="<template>",
            help=_("Name or UUID of the deploy template.")
        )
        parser.add_argument(
            '--fields',
            nargs='+',
            dest='fields',
            metavar='<field>',
            action='append',
            choices=res_fields.DEPLOY_TEMPLATE_DETAILED_RESOURCE.fields,
            default=[],
            help=_("One or more deploy template fields. Only these fields "
                   "will be fetched from the server.")
        )
        return parser

    def take_action(self, parsed_args):
        self.log.debug("take_action(%s)", parsed_args)

        baremetal_client = self.app.client_manager.baremetal
        fields = list(itertools.chain.from_iterable(parsed_args.fields))
        fields = fields if fields else None

        template = baremetal_client.deploy_template.get(
            parsed_args.template, fields=fields)._info

        template.pop("links", None)
        return zip(*sorted(template.items()))


class SetBaremetalDeployTemplate(command.Command):
    """Set baremetal deploy template properties."""

    log = logging.getLogger(__name__ + ".SetBaremetalDeployTemplate")

    def get_parser(self, prog_name):
        parser = super(SetBaremetalDeployTemplate, self).get_parser(prog_name)

        parser.add_argument(
            'template',
            metavar='<template>',
            help=_("Name or UUID of the deploy template")
        )
        parser.add_argument(
            '--name',
            metavar='<name>',
            help=_('Set unique name of the deploy template. Must be a valid '
                   'trait name.')
        )
        parser.add_argument(
            '--steps',
            metavar="<steps>",
            help=_DEPLOY_STEPS_HELP
        )
        parser.add_argument(
            "--extra",
            metavar="<key=value>",
            action='append',
            help=_('Extra to set on this baremetal deploy template '
                   '(repeat option to set multiple extras).'),
        )
        return parser

    def take_action(self, parsed_args):
        self.log.debug("take_action(%s)", parsed_args)

        baremetal_client = self.app.client_manager.baremetal

        properties = []
        if parsed_args.name:
            name = ["name=%s" % parsed_args.name]
            properties.extend(utils.args_array_to_patch('add', name))
        if parsed_args.steps:
            steps = utils.handle_json_arg(parsed_args.steps, 'deploy steps')
            steps = ["steps=%s" % json.dumps(steps)]
            properties.extend(utils.args_array_to_patch('add', steps))
        if parsed_args.extra:
            properties.extend(utils.args_array_to_patch(
                'add', ['extra/' + x for x in parsed_args.extra]))

        if properties:
            baremetal_client.deploy_template.update(parsed_args.template,
                                                    properties)
        else:
            self.log.warning("Please specify what to set.")


class UnsetBaremetalDeployTemplate(command.Command):
    """Unset baremetal deploy template properties."""
    log = logging.getLogger(__name__ + ".UnsetBaremetalDeployTemplate")

    def get_parser(self, prog_name):
        parser = super(UnsetBaremetalDeployTemplate, self).get_parser(
            prog_name)

        parser.add_argument(
            'template',
            metavar='<template>',
            help=_("Name or UUID of the deploy template")
        )
        parser.add_argument(
            "--extra",
            metavar="<key>",
            action='append',
            help=_('Extra to unset on this baremetal deploy template '
                   '(repeat option to unset multiple extras).'),
        )

        return parser

    def take_action(self, parsed_args):
        self.log.debug("take_action(%s)", parsed_args)

        baremetal_client = self.app.client_manager.baremetal

        properties = []
        if parsed_args.extra:
            properties.extend(utils.args_array_to_patch('remove',
                              ['extra/' + x for x in parsed_args.extra]))

        if properties:
            baremetal_client.deploy_template.update(parsed_args.template,
                                                    properties)
        else:
            self.log.warning("Please specify what to unset.")


class DeleteBaremetalDeployTemplate(command.Command):
    """Delete deploy template(s)."""

    log = logging.getLogger(__name__ + ".DeleteBaremetalDeployTemplate")

    def get_parser(self, prog_name):
        parser = super(DeleteBaremetalDeployTemplate, self).get_parser(
            prog_name)
        parser.add_argument(
            "templates",
            metavar="<template>",
            nargs="+",
            help=_("Name(s) or UUID(s) of the deploy template(s) to delete.")
        )

        return parser

    def take_action(self, parsed_args):
        self.log.debug("take_action(%s)", parsed_args)

        baremetal_client = self.app.client_manager.baremetal

        failures = []
        for template in parsed_args.templates:
            try:
                baremetal_client.deploy_template.delete(template)
                print(_('Deleted deploy template %s') % template)
            except exc.ClientException as e:
                failures.append(_("Failed to delete deploy template "
                                  "%(template)s: %(error)s")
                                % {'template': template, 'error': e})

        if failures:
            raise exc.ClientException("\n".join(failures))


class ListBaremetalDeployTemplate(command.Lister):
    """List baremetal deploy templates."""

    log = logging.getLogger(__name__ + ".ListBaremetalDeployTemplate")

    def get_parser(self, prog_name):
        parser = super(ListBaremetalDeployTemplate, self).get_parser(prog_name)
        parser.add_argument(
            '--limit',
            metavar='<limit>',
            type=int,
            help=_('Maximum number of deploy templates to return per request, '
                   '0 for no limit. Default is the maximum number used '
                   'by the Baremetal API Service.')
        )
        parser.add_argument(
            '--marker',
            metavar='<template>',
            help=_('DeployTemplate UUID (for example, of the last deploy '
                   'template in the list from a previous request). Returns '
                   'the list of deploy templates after this UUID.')
        )
        parser.add_argument(
            '--sort',
            metavar="<key>[:<direction>]",
            help=_('Sort output by specified deploy template fields and '
                   'directions (asc or desc) (default: asc). Multiple fields '
                   'and directions can be specified, separated by comma.')
        )
        display_group = parser.add_mutually_exclusive_group()
        display_group.add_argument(
            '--long',
            dest='detail',
            action='store_true',
            default=False,
            help=_("Show detailed information about deploy templates.")
        )
        display_group.add_argument(
            '--fields',
            nargs='+',
            dest='fields',
            metavar='<field>',
            action='append',
            default=[],
            choices=res_fields.DEPLOY_TEMPLATE_DETAILED_RESOURCE.fields,
            help=_("One or more deploy template fields. Only these fields "
                   "will be fetched from the server. Can not be used when "
                   "'--long' is specified.")
        )
        return parser

    def take_action(self, parsed_args):
        self.log.debug("take_action(%s)", parsed_args)
        client = self.app.client_manager.baremetal

        columns = res_fields.DEPLOY_TEMPLATE_RESOURCE.fields
        labels = res_fields.DEPLOY_TEMPLATE_RESOURCE.labels

        params = {}
        if parsed_args.limit is not None and parsed_args.limit < 0:
            raise exc.CommandError(
                _('Expected non-negative --limit, got %s') %
                parsed_args.limit)
        params['limit'] = parsed_args.limit
        params['marker'] = parsed_args.marker

        if parsed_args.detail:
            params['detail'] = parsed_args.detail
            columns = res_fields.DEPLOY_TEMPLATE_DETAILED_RESOURCE.fields
            labels = res_fields.DEPLOY_TEMPLATE_DETAILED_RESOURCE.labels

        elif parsed_args.fields:
            params['detail'] = False
            fields = itertools.chain.from_iterable(parsed_args.fields)
            resource = res_fields.Resource(list(fields))
            columns = resource.fields
            labels = resource.labels
            params['fields'] = columns

        self.log.debug("params(%s)", params)
        data = client.deploy_template.list(**params)

        data = oscutils.sort_items(data, parsed_args.sort)

        return (labels,
                (oscutils.get_item_properties(s, columns) for s in data))