openstack
/
tripleo-ansible
Code Issues Proposed changes

Creates container_config_data module 

container_config_data is a new module that replaces some tasks that were
previously used to read and process JSON files on a host.

Doing it in a module will reduce the number of tasks, and make it a
little bit faster and easier to debug in big deployments.

Unit tests will come later.

Change-Id: I9844ed166ecf0718935ac1537b719000da816dbb
(cherry picked from commit c2602508e1)
This commit is contained in:
Emilien Macchi 2020-03-02 17:38:09 -05:00
parent fc8626d287
commit 191b60731d
4 changed files with 225 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
tripleo_ansible/ansible_plugins/modules/container_config_data.py Normal file
View File

@ -0,0 +1,190 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2020 Red Hat, Inc.
# 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, division, print_function
__metaclass__ = type
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.parsing.convert_bool import boolean
import glob
import json
import os
import yaml
ANSIBLE_METADATA = {
'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'
}
DOCUMENTATION = """
---
module: container_config_data
author:
- Emilien Macchi <emilien@redhat.com>
version_added: '2.8'
short_description: Generates a dictionary which contains all container configs
notes: []
description:
- This module reads container configs in JSON files and generate a dictionary
which later will be used to manage the containers.
options:
config_path:
description:
- The path of a directory or a file where the JSON files are.
This parameter is required.
required: True
type: str
config_pattern:
description:
- Search pattern to find JSON files.
default: '*.json'
required: False
type: str
config_overrides:
description:
- Allows to override any container configuration which will take
precedence over the JSON files.
default: {}
required: False
type: dict
debug:
description:
- Whether or not debug is enabled.
default: False
required: False
type: bool
"""
EXAMPLES = """
- name: Generate containers configs data
container_config_data:
config_path: /var/lib/tripleo-config/container-startup-config/step_1
- name: Generate containers configs data for HAproxy and override image
container_config_data:
config_path: /var/lib/tripleo-config/container-startup-config/step_1
config_pattern: 'haproxy.json'
config_overrides:
haproxy:
image: my-registry.io/tripleo/haproxy:mytag
"""
RETURN = """
configs:
description:
- Dictionary with container configs ready to be consumed by
tripleo_container_manage role.
returned: always
type: dict
"""
class ContainerConfigDataManager(object):
"""Notes about this module.
It will generates a dictionary which contains all container configs,
later consumed by tripleo_container_manage role.
"""
def __init__(self, module, results):
self.module = module
self.results = results
# parse args
args = self.module.params
# Set parameters
config_path = args['config_path']
config_pattern = args['config_pattern']
config_overrides = args['config_overrides']
self.debug = args['debug']
# Generate dict from JSON files that match search pattern
if os.path.exists(config_path):
matched_configs = glob.glob(os.path.join(config_path,
config_pattern))
else:
self.module.fail_json(
msg='{} does not exists'.format(config_path))
config_dict = {}
for mc in matched_configs:
name = os.path.splitext(os.path.basename(mc))[0]
config = json.loads(self._slurp(mc))
if self.debug:
self.module.debug('Config found for {}: {}'.format(name,
config))
config_dict.update({name: config})
# Merge the config dict with given overrides
self.results['configs'] = self._merge_with_overrides(config_dict,
config_overrides)
# Returns data
self.module.exit_json(**self.results)
def _merge_with_overrides(self, config, merge_with=None):
"""Merge config with a given dict of overrides.
:param config: dictionary of configs
:param merge_with: dictionary of overrides
:return: dict
"""
merged_dict = config
if merge_with is None:
merge_with = {}
for k in merge_with.keys():
if k in config:
for mk, mv in merge_with[k].items():
if self.debug:
self.module.debug('Override found for {}: {} will be '
'set to {}'.format(k, mk, mv))
merged_dict[k][mk] = mv
break
return merged_dict
def _slurp(self, path):
"""Slurps a file and return its content.
:param path: string
:returns: string
"""
if os.path.exists(path):
f = open(path, 'r')
return f.read()
else:
self.module.warn('{} was not found.'.format(path))
return ''
def main():
module = AnsibleModule(
argument_spec=yaml.safe_load(DOCUMENTATION)['options'],
supports_check_mode=True,
)
results = dict(
changed=False,
configs={}
)
ContainerConfigDataManager(module, results)
if __name__ == '__main__':
main()

30
tripleo_ansible/roles/tripleo-container-manage/tasks/main.yml
View File

@ -52,31 +52,15 @@
no_log: "{{ not tripleo_container_manage_debug }}"
block:
- name: "Find all matching configs configs for in {{ tripleo_container_manage_config }}"
find:
paths: "{{ tripleo_container_manage_config }}"
patterns: "{{ tripleo_container_manage_config_patterns }}"
recurse: true
register: matched_files
- name: "Read config for each container in {{ tripleo_container_manage_config }}"
slurp:
src: "{{ item.path }}"
register: containers_data
loop: "{{ matched_files.files }}"
- name: Prepare container hashes from config
set_fact:
container_hash: "{'{{ item.source|basename|regex_replace('^hashed-','')|regex_replace('.json$','') }}': {{ item.content|b64decode|from_json }} }"
register: container_hashes
loop: "{{ containers_data['results'] }}"
- name: Compile container hashes from results
set_fact:
container_hash: "{{ item.ansible_facts.container_hash | combine(item.ansible_facts.container_hash) }}"
register: container_hashes
loop: "{{ container_hashes.results }}"
container_config_data:
config_path: "{{ tripleo_container_manage_config }}"
config_pattern: "{{ tripleo_container_manage_config_patterns }}"
config_overrides: "{{ tripleo_container_manage_config_overrides }}"
debug: "{{ tripleo_container_manage_debug }}"
register: container_config_data
- name: Finalise hashes for all containers
set_fact:
all_containers_hash: >-
{{ container_hashes.results | map(attribute='ansible_facts.container_hash') |
list | singledict(merge_with=tripleo_container_manage_config_overrides) }}
all_containers_hash: "{{ container_config_data.configs }}"
- name: "Manage systemd shutdown files"
become: true

23
tripleo_ansible/tests/modules/test_container_config_data.py Normal file
View File

@ -0,0 +1,23 @@
# Copyright 2019 Red Hat, Inc.
# 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 tripleo_ansible.ansible_plugins.modules import container_config_data
from tripleo_ansible.tests import base as tests_base
class TestContainerConfigData(tests_base.TestCase):
def test_run(self):
# TODO(emilien) write actual tests
pass

5
zuul.d/molecule.yaml
View File

@ -341,6 +341,11 @@
files:
- ^tripleo_ansible/roles/tripleo-container-manage/.*
- ^tripleo_ansible/roles/tripleo-container-rm/.*
- ^tripleo_ansible/ansible_plugins/filter/helpers.py$
- ^tripleo_ansible/ansible_plugins/modules/container_config_data.py$
- ^tripleo_ansible/ansible_plugins/modules/container_puppet_config.py$
- ^tripleo_ansible/ansible_plugins/modules/podman_container.py$
- ^tripleo_ansible/ansible_plugins/modules/podman_container_info.py$
name: tripleo-ansible-centos-7-molecule-tripleo-container-manage
parent: tripleo-ansible-centos-7-base
vars: