diff --git a/doc/source/modules/modules-tripleo_config_download.rst b/doc/source/modules/modules-tripleo_config_download.rst new file mode 100644 index 000000000..1ee792980 --- /dev/null +++ b/doc/source/modules/modules-tripleo_config_download.rst @@ -0,0 +1,14 @@ +================================ +Module - tripleo_config_download +================================ + + +This module provides for the following ansible plugin: + + * tripleo_config_download + + +.. ansibleautoplugin:: + :module: tripleo_ansible/ansible_plugins/modules/tripleo_config_download.py + :documentation: true + :examples: true diff --git a/tripleo_ansible/ansible_plugins/modules/tripleo_config_download.py b/tripleo_ansible/ansible_plugins/modules/tripleo_config_download.py new file mode 100644 index 000000000..63ad5a27a --- /dev/null +++ b/tripleo_ansible/ansible_plugins/modules/tripleo_config_download.py @@ -0,0 +1,145 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright (c) 2018 OpenStack Foundation +# All Rights Reserved. +# +# 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. + +from __future__ import absolute_import +from __future__ import division +from __future__ import print_function + +import yaml + +from ansible.module_utils import tripleo_common_utils as tc +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.openstack import openstack_full_argument_spec +from ansible.module_utils.openstack import openstack_module_kwargs +from ansible.module_utils.openstack import openstack_cloud_from_module + +from tripleo_common.utils import config as ooo_config + +ANSIBLE_METADATA = { + 'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'community' +} + +DOCUMENTATION = ''' +--- +module: tripleo_config_download + +short_description: Download config + +version_added: "2.8" + +description: + - "Download Config." + +options: + plan: + description: + - Overcloud plan name + type: str + default: overcloud + config_container: + description: + - Config container name + type: str + default: overcloud-config + work_dir: + description: + - Work dir + type: str + default: /home/stack/config-download + config_type: + description: + - Config type + type: str + download: + description: + - Download flag + type: bool + default: true +author: + - Rabi Mishra (@ramishra) +''' + +EXAMPLES = ''' +- name: Download config + tripleo_config_download: + plan: overcloud + config_container: overcloud-config + work_dir: /home/stack/config-downloa +''' + + +def run_module(): + result = dict( + success=False, + changed=False, + error="", + ) + + argument_spec = openstack_full_argument_spec( + **yaml.safe_load(DOCUMENTATION)['options'] + ) + + module = AnsibleModule( + argument_spec, + supports_check_mode=False, + **openstack_module_kwargs() + ) + + try: + plan = module.params.get('plan') + config_container = module.params.get('config_container') + work_dir = module.params.get('work_dir') + config_type = module.params.get('config_type') + download = module.params.get('download') + + _, conn = openstack_cloud_from_module(module) + tripleo = tc.TripleOCommon(session=conn.session) + + swift = tripleo.get_object_client() + heat = tripleo.get_orchestration_client() + ooo_config.get_overcloud_config( + swift, + heat, + plan, + config_container, + config_type) + if download: + ooo_config.download_overcloud_config( + swift, + config_container, + work_dir) + result['success'] = True + result['changed'] = True + except Exception as err: + result['error'] = str(err) + result['msg'] = ("Error downloading config for %s: %s" % ( + plan, err)) + module.fail_json(**result) + + # in the event of a successful module execution, you will want to + # simple AnsibleModule.exit_json(), passing the key/value results + module.exit_json(**result) + + +def main(): + run_module() + + +if __name__ == '__main__': + main()