Switch to ansible for overcloud node (un)provision

Change-Id: Iaa10d3d3e5f9facd6b03ba0e55f90f532d691abd
Story: 2007212
Task: 38457

setup.cfg

@@ -77,8 +77,8 @@ openstack.tripleoclient.v2 =
     overcloud_node_clean = tripleoclient.v1.overcloud_node:CleanNode
     overcloud_node_bios_configure = tripleoclient.v1.overcloud_bios:ConfigureBIOS
     overcloud_node_bios_reset = tripleoclient.v1.overcloud_bios:ResetBIOS
-    overcloud_node_provision = tripleoclient.v1.overcloud_node:ProvisionNode
-    overcloud_node_unprovision = tripleoclient.v1.overcloud_node:UnprovisionNode
+    overcloud_node_provision = tripleoclient.v2.overcloud_node:ProvisionNode
+    overcloud_node_unprovision = tripleoclient.v2.overcloud_node:UnprovisionNode
     overcloud_parameters_set = tripleoclient.v1.overcloud_parameters:SetParameters
     overcloud_plan_create = tripleoclient.v1.overcloud_plan:CreatePlan
     overcloud_plan_delete = tripleoclient.v1.overcloud_plan:DeletePlan

tripleoclient/tests/v2/overcloud_node/test_overcloud_node.py

@@ -338,3 +338,123 @@ class TestIntrospectNode(fakes.TestOvercloudNode):
         self.workflow.executions.create.assert_has_calls(call_list)
         self.assertEqual(self.workflow.executions.create.call_count,
                          2 if provide else 1)
+
+
+class TestProvisionNode(fakes.TestOvercloudNode):
+
+    def setUp(self):
+        super(TestProvisionNode, self).setUp()
+        self.cmd = overcloud_node.ProvisionNode(self.app, None)
+        self.cmd.app_args = mock.Mock(verbose_level=1)
+
+    @mock.patch('tripleoclient.utils.run_ansible_playbook',
+                autospec=True)
+    def test_ok(self, mock_playbook):
+        with tempfile.NamedTemporaryFile() as inp:
+            with tempfile.NamedTemporaryFile() as outp:
+                with tempfile.NamedTemporaryFile() as keyf:
+                    inp.write(b'- name: Compute\n- name: Controller\n')
+                    inp.flush()
+                    keyf.write(b'I am a key')
+                    keyf.flush()
+                    with open('{}.pub'.format(keyf.name), 'w') as f:
+                        f.write('I am a key')
+
+                    argslist = ['--output', outp.name,
+                                '--overcloud-ssh-key', keyf.name,
+                                inp.name]
+                    verifylist = [('input', inp.name),
+                                  ('output', outp.name),
+                                  ('overcloud_ssh_key', keyf.name)]
+
+                    parsed_args = self.check_parser(self.cmd,
+                                                    argslist, verifylist)
+                    self.cmd.take_action(parsed_args)
+
+        mock_playbook.assert_called_once_with(
+            extra_vars={
+                'stack_name': 'overcloud',
+                'baremetal_deployment': [
+                    {'name': 'Compute'},
+                    {'name': 'Controller'}
+                ],
+                'baremetal_deployed_path': mock.ANY,
+                'ssh_public_keys': 'I am a key',
+                'ssh_user_name': 'heat-admin',
+                'node_timeout': 3600,
+                'concurrency': 20
+            },
+            inventory='localhost,',
+            playbook='cli-overcloud-node-provision.yaml',
+            playbook_dir='/usr/share/ansible/tripleo-playbooks',
+            verbosity=0,
+            workdir=mock.ANY
+        )
+
+
+class TestUnprovisionNode(fakes.TestOvercloudNode):
+
+    def setUp(self):
+        super(TestUnprovisionNode, self).setUp()
+        self.cmd = overcloud_node.UnprovisionNode(self.app, None)
+        self.cmd.app_args = mock.Mock(verbose_level=1)
+
+    @mock.patch('tripleoclient.utils.run_ansible_playbook',
+                autospec=True)
+    @mock.patch('tripleoclient.utils.tempfile')
+    @mock.patch('tripleoclient.utils.prompt_user_for_confirmation')
+    def test_ok(self, mock_prompt, mock_tempfile, mock_playbook):
+        tmp = tempfile.mkdtemp()
+        mock_tempfile.mkdtemp.return_value = tmp
+        mock_prompt.return_value = True
+        unprovision_confirm = os.path.join(tmp, 'unprovision_confirm.json')
+        with open(unprovision_confirm, 'w') as confirm:
+            confirm.write(json.dumps([
+                {'hostname': 'compute-0', 'name': 'baremetal-1'},
+                {'hostname': 'controller-0', 'name': 'baremetal-2'}
+            ]))
+
+        with tempfile.NamedTemporaryFile() as inp:
+            inp.write(b'- name: Compute\n- name: Controller\n')
+            inp.flush()
+            argslist = ['--all', inp.name]
+            verifylist = [('input', inp.name), ('all', True)]
+
+            parsed_args = self.check_parser(self.cmd,
+                                            argslist, verifylist)
+            self.cmd.take_action(parsed_args)
+        mock_playbook.assert_has_calls([
+            mock.call(
+                extra_vars={
+                    'stack_name': 'overcloud',
+                    'baremetal_deployment': [
+                        {'name': 'Compute'},
+                        {'name': 'Controller'}
+                    ],
+                    'all': True,
+                    'prompt': True,
+                    'unprovision_confirm': unprovision_confirm
+                },
+                inventory='localhost,',
+                playbook='cli-overcloud-node-unprovision.yaml',
+                playbook_dir='/usr/share/ansible/tripleo-playbooks',
+                verbosity=0,
+                workdir=tmp
+            ),
+            mock.call(
+                extra_vars={
+                    'stack_name': 'overcloud',
+                    'baremetal_deployment': [
+                        {'name': 'Compute'},
+                        {'name': 'Controller'}
+                    ],
+                    'all': True,
+                    'prompt': False
+                },
+                inventory='localhost,',
+                playbook='cli-overcloud-node-unprovision.yaml',
+                playbook_dir='/usr/share/ansible/tripleo-playbooks',
+                verbosity=0,
+                workdir=tmp
+            )
+        ])

tripleoclient/v2/overcloud_node.py

@@ -14,10 +14,17 @@
 #
 
 import argparse
+import collections
+import json
 import logging
 import os
+import sys
 
+from cliff.formatters import table
+from osc_lib import exceptions as oscexc
 from osc_lib.i18n import _
+from osc_lib import utils
+import yaml
 
 from tripleoclient import command
 from tripleoclient import constants
@@ -31,8 +38,6 @@ from tripleoclient.v1.overcloud_node import ConfigureNode  # noqa
 from tripleoclient.v1.overcloud_node import DeleteNode  # noqa
 from tripleoclient.v1.overcloud_node import DiscoverNode  # noqa
 from tripleoclient.v1.overcloud_node import ProvideNode  # noqa
-from tripleoclient.v1.overcloud_node import ProvisionNode  # noqa
-from tripleoclient.v1.overcloud_node import UnprovisionNode  # noqa
 
 
 class ImportNode(command.Command):
@@ -187,3 +192,176 @@ class IntrospectNode(command.Command):
                 )
             else:
                 baremetal.provide_manageable_nodes(self.app.client_manager)
+
+
+class ProvisionNode(command.Command):
+    """Provision new nodes using Ironic."""
+
+    log = logging.getLogger(__name__ + ".ProvisionNode")
+
+    def get_parser(self, prog_name):
+        parser = super(ProvisionNode, self).get_parser(prog_name)
+        parser.add_argument('input',
+                            metavar='<baremetal_deployment.yaml>',
+                            help=_('Configuration file describing the '
+                                   'baremetal deployment'))
+        parser.add_argument('-o', '--output',
+                            default='baremetal_environment.yaml',
+                            help=_('The output environment file path'))
+        parser.add_argument('--stack', dest='stack',
+                            help=_('Name or ID of heat stack '
+                                   '(default=Env: OVERCLOUD_STACK_NAME)'),
+                            default=utils.env('OVERCLOUD_STACK_NAME',
+                                              default='overcloud'))
+        parser.add_argument('--overcloud-ssh-user',
+                            default='heat-admin',
+                            help=_('User for SSH access to newly deployed '
+                                   'nodes'))
+        parser.add_argument('--overcloud-ssh-key',
+                            default=None,
+                            help=_('Key path for ssh access to'
+                                   'overcloud nodes. When undefined the key'
+                                   'will be autodetected.'))
+        parser.add_argument('--concurrency', type=int,
+                            default=20,
+                            help=_('Maximum number of nodes to provision at '
+                                   'once. (default=20)'))
+        parser.add_argument('--timeout', type=int,
+                            default=3600,
+                            help=_('Number of seconds to wait for the node '
+                                   'provision to complete. (default=3600)'))
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)" % parsed_args)
+
+        with open(parsed_args.input, 'r') as fp:
+            roles = yaml.safe_load(fp)
+
+        key = self.get_key_pair(parsed_args)
+        with open('{}.pub'.format(key), 'rt') as fp:
+            ssh_key = fp.read()
+
+        output_path = os.path.abspath(parsed_args.output)
+
+        extra_vars = {
+            "stack_name": parsed_args.stack,
+            "baremetal_deployment": roles,
+            "baremetal_deployed_path": output_path,
+            "ssh_public_keys": ssh_key,
+            "ssh_user_name": parsed_args.overcloud_ssh_user,
+            "node_timeout": parsed_args.timeout,
+            "concurrency": parsed_args.concurrency
+        }
+
+        with oooutils.TempDirs() as tmp:
+            oooutils.run_ansible_playbook(
+                playbook='cli-overcloud-node-provision.yaml',
+                inventory='localhost,',
+                verbosity=self.app_args.verbose_level - 1,
+                workdir=tmp,
+                playbook_dir=constants.ANSIBLE_TRIPLEO_PLAYBOOKS,
+                extra_vars=extra_vars,
+            )
+
+        print('Nodes deployed successfully, add %s to your deployment '
+              'environment' % parsed_args.output)
+
+
+class UnprovisionNode(command.Command):
+    """Unprovisions nodes using Ironic."""
+
+    log = logging.getLogger(__name__ + ".UnprovisionNode")
+
+    def get_parser(self, prog_name):
+        parser = super(UnprovisionNode, self).get_parser(prog_name)
+        parser.add_argument('--stack', dest='stack',
+                            help=_('Name or ID of heat stack '
+                                   '(default=Env: OVERCLOUD_STACK_NAME)'),
+                            default=utils.env('OVERCLOUD_STACK_NAME',
+                                              default='overcloud'))
+        parser.add_argument('--all',
+                            help=_('Unprovision every instance in the '
+                                   'deployment'),
+                            default=False,
+                            action="store_true")
+        parser.add_argument('-y', '--yes',
+                            help=_('Skip yes/no prompt (assume yes)'),
+                            default=False,
+                            action="store_true")
+        parser.add_argument('input',
+                            metavar='<baremetal_deployment.yaml>',
+                            help=_('Configuration file describing the '
+                                   'baremetal deployment'))
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)" % parsed_args)
+
+        with open(parsed_args.input, 'r') as fp:
+            roles = yaml.safe_load(fp)
+
+        with oooutils.TempDirs() as tmp:
+            unprovision_confirm = os.path.join(tmp, 'unprovision_confirm.json')
+
+            if not parsed_args.yes:
+                oooutils.run_ansible_playbook(
+                    playbook='cli-overcloud-node-unprovision.yaml',
+                    inventory='localhost,',
+                    verbosity=self.app_args.verbose_level - 1,
+                    workdir=tmp,
+                    playbook_dir=constants.ANSIBLE_TRIPLEO_PLAYBOOKS,
+                    extra_vars={
+                        "stack_name": parsed_args.stack,
+                        "baremetal_deployment": roles,
+                        "all": parsed_args.all,
+                        "prompt": True,
+                        "unprovision_confirm": unprovision_confirm
+                    }
+                )
+                with open(unprovision_confirm) as f:
+                    to_unprovision = json.load(f)
+                    if not to_unprovision:
+                        print('Nothing to unprovision, exiting')
+                        return
+                    self._print_nodes(to_unprovision)
+
+                confirm = oooutils.prompt_user_for_confirmation(
+                    message=_("Are you sure you want to unprovision these %s "
+                              "nodes [y/N]? ") % parsed_args.stack,
+                    logger=self.log)
+                if not confirm:
+                    raise oscexc.CommandError("Action not confirmed, exiting.")
+
+            oooutils.run_ansible_playbook(
+                playbook='cli-overcloud-node-unprovision.yaml',
+                inventory='localhost,',
+                verbosity=self.app_args.verbose_level - 1,
+                workdir=tmp,
+                playbook_dir=constants.ANSIBLE_TRIPLEO_PLAYBOOKS,
+                extra_vars={
+                    "stack_name": parsed_args.stack,
+                    "baremetal_deployment": roles,
+                    "all": parsed_args.all,
+                    "prompt": False,
+                }
+            )
+
+        print('Unprovision complete')
+
+    def _print_nodes(self, nodes):
+        TableArgs = collections.namedtuple(
+            'TableArgs', 'print_empty max_width fit_width')
+        args = TableArgs(print_empty=True, max_width=-1, fit_width=True)
+        nodes_data = [(i.get('hostname', ''),
+                       i.get('name', ''),
+                       i.get('id', '')) for i in nodes]
+
+        sys.stdout.write('\n')
+        formatter = table.TableFormatter()
+        formatter.emit_list(
+            column_names=['hostname', 'name', 'id'],
+            data=nodes_data,
+            stdout=sys.stdout,
+            parsed_args=args
+        )