This repository is archived. Content Builder tool should be used to generate
amazon.cloud and vmware.vmware_rest collections. If you face issues or have queries please submit an issue on Content Builder repository.
This repository contains the gouttelette package, a well tested python library that generates the cloud collections amazon.cloud and vmware.vmware_rest.
This tool reuses the functionalities of the existing amazon_cloud_code_generator and vmware_rest_code_generator. These generators will be archived in the future.
The final goal is to integrate this tool with the content_builder
and extend the usage to other openAPI based cloud platforms.
The amazon.cloud modules generation relies on the CloudFormation client. Hence, the following requirements must be met:
boto3 >= 1.20.0botocore >= 1.23.0
Apart from the above requirements, the tool needs
Python 3.9tox
The gouttelette generator is capable of performing the following functionalities
refresh_modules: Generates the modules specified in resources.py. It is important to make sure the REST schema and modules list files are present in the default location (details below), if not passed as input arguments.
python -m gouttelette.cmd.refresh_modules --collection <collection_name> --target-dir <path> --modules <path> --next-version <version> --schema-dir <path>
| Input args | Description |
|---|---|
| collection | The collection for which the modules are generated (values: amazon_cloud or vmware_rest, default: amazon_cloud) |
| target-dir | Location of the target repository (default: ./cloud or ./vmware_rest) |
| modules | Location of the modules.yaml file (default: gouttelette/config/). modules.yaml has an entry for each of the AWS modules that are to be generated. Each entry should have the module's name. Other information that will be used in the module's DOCUMENTATION like short_description, description, etc can be added to the entry. |
| next-version | The next major version (default: "TODO" |
| schema-dir | Location of the collected schemas (default: ./gouttelette/api_specifications/ |
refresh_schema: This command is for the amazon.cloud . It uses the AWS CloudFormation API to generate the rest schemas for the modules mentioned in the modules.yaml.
python -m gouttelette.cmd.refresh_schema --schema-dir <path>
| Input args | Description |
|---|---|
| schema-dir | Location where the generated schemas will be stored (default: ./gouttelette/api_specifications/amazon_cloud |
refresh_examples: Generates the examples by using the content of the tests/ directory under target-dir that is passed as an argument (or the default location).
python -m gouttelette.cmd.refresh_examples --target-dir <path>
| Input args | Description |
|---|---|
| target-dir | Location of the target repository (default: ./cloud or ./vmware_rest). This location should have the generated modules. |
refresh_ignore_files: Refresh the ignore files of the vmware_rest collection.
python -m gouttelette.cmd.refresh_ignore_files --target-dir <path>
| Input args | Description |
|---|---|
| target-dir | Location of the target repository (default: ./cloud or ./vmware_rest). This location should have the generated modules. |
- Clone
gouttelette repo.
git clone https://github.com/ansible-collections/gouttelette
- From gouttelette execute the following command
python -m gouttelette.cmd.refresh_modules --collection "amazon_cloud"
The default values are taken for the other input arguments. Same steps are followed to refresh schema, refresh examples and refresh ignore files.
- Clone the collection repository
For vmware_rest
mkdir -p ~/.ansible/collections/ansible_collections/vmware/vmware_rest
cd ~/.ansible/collections/ansible_collections/vmware/vmware_rest
git clone https://github.com/ansible-collections/vmware.vmware_rest
tox -e refresh_modules
For amazon.cloud
mkdir -p ~/.ansible/collections/ansible_collections/amazon/cloud
cd ~/.ansible/collections/ansible_collections/amazon/cloud
git clone https://github.com/ansible-collections/amazon.cloud
tox -e refresh_modules
Version can be specified as follows
tox -e refresh_modules -- --next-version "2.0.0"
Plugins documentation located in ~/.ansible/collections/ansible_collections/amazon/cloud/docs can be refreshed by running (same applies for vmware.vmware_rest).
tox -e add_docs
ansible-test can be used to validate the generated content
virtualenv -p python3.9 ~/tmp/venv-tmp-py39-aws
source ~/tmp/venv-tmp-py39-aws/bin/activate pip install -r requirements.txt -r test-requirements.txt ansible
ansible-test sanity --requirements --local --python 3.9 -vvv
All integration tests for the collection can be executed using
ansible-test integration --requirements --docker
We welcome community contributions and if you find problems, please open an issue or create a Pull Request. You can also join us in the:
- #ansible-aws irc.libera.chat channel
- #ansible (general use questions and support), #ansible-community (community and collection development questions), and other IRC channels.
The Amazon Web Services Working groups is holding a monthly community meeting at #ansible-aws IRC channel at 17:30 UTC every fourth Thursday of the month. If you have something to discuss (e.g. a PR that needs help), add your request to the meeting agenda and join the IRC #ansible-aws channel. Invite (import by URL): ics file
You don't know how to start? Refer to our contribution guide!
This project is governed by the Ansible Community code of conduct
GNU General Public License v3.0 or later.
See COPYING to see the full text.