diff options
Diffstat (limited to 'ansible_collections/openstack/cloud/README.md')
| -rw-r--r-- | ansible_collections/openstack/cloud/README.md | 245 |
1 files changed, 156 insertions, 89 deletions
diff --git a/ansible_collections/openstack/cloud/README.md b/ansible_collections/openstack/cloud/README.md index 5dd8c9d08..020d64e51 100644 --- a/ansible_collections/openstack/cloud/README.md +++ b/ansible_collections/openstack/cloud/README.md @@ -1,94 +1,84 @@ -[](http://zuul.opendev.org/t/openstack/builds?project=openstack%2Fansible-collections-openstack#) +[]( +http://zuul.opendev.org/t/openstack/builds?project=openstack%2Fansible-collections-openstack) -# Ansible Collection: openstack.cloud +# Ansible OpenStack Collection -This repo hosts the `openstack.cloud` Ansible Collection. +Ansible OpenStack collection aka `openstack.cloud` provides Ansible modules and Ansible plugins for managing OpenStack +clouds. It is supported and maintained by the OpenStack community. -The collection includes the Openstack modules and plugins supported by Openstack community to help the management of Openstack infrastructure. +**NOTE:** We need and value your contributions! Maintaining this collection is a community effort. We are all both users +and developers of this collection at the same time. If you find a bug, please report it. If you have fixed a bug, please +submit a patch. If you need new functionality which is not covered by this collection yet, please extend an existing +module or submit a new one. Our [Contributing](#contributing) section below has tons of docs to check out. Please get in +touch! -## Breaking backward compatibility :warning: +## Branches and Non Backward Compatibility ⚠️ -Dear contributors and users of the Ansible OpenStack collection! -Our codebase has been split into two separate release series: +Our codebase has been split into two separate release series, `2.x.x` and `1.x.x`: -* `2.x.x` releases of Ansible OpenStack collection are compatible with OpenStack SDK `1.x.x` and its release candidates - `0.99.x` *only* (OpenStack Zed and later). Our `master` branch tracks our `2.x.x` releases. -* `1.x.x` releases of Ansible OpenStack collection are compatible with OpenStack SDK `0.x.x` prior to `0.99.0` *only* - (OpenStack Yoga and earlier). Our `stable/1.0.0` branch tracks our `1.x.x` releases. +* `2.x.x` releases of Ansible OpenStack collection are compatible with [OpenStack SDK][openstacksdk] `1.x.x` and its + release candidates `0.99.0` and later *only* (OpenStack Zed and later). Our `master` branch tracks our `2.x.x` + releases. +* `1.x.x` releases of Ansible OpenStack collection are compatible with [OpenStack SDK][openstacksdk] `0.x.x` prior to + `0.99.0` *only* (OpenStack Yoga and earlier). Our `stable/1.0.0` branch tracks our `1.x.x` releases. +* `2.x.x` releases of Ansible OpenStack collection are not backward compatible to `1.x.x` releases ⚠️ -Both branches will be developed in parallel for the time being. Patches from `master` will be backported to -`stable/1.0.0` on a best effort basis but expect new features to be introduced in our `master` branch only. -Contributions are welcome for both branches! -Differences between both branches are mainly renamed and sometimes dropped module return values. We try to keep our -module parameters backward compatible by offering aliases but e.g. the semantics of `filters` parameters in `*_info` -modules have changed due to updates in the OpenStack SDK. +For rationale and details please read our [branching docs](docs/branching.md). Both branches will be developed in +parallel for the time being. Patches from `master` will be backported to `stable/1.0.0` on a best effort basis but +expect new features to be introduced in our `master` branch only. Contributions are welcome for both branches! -Our decision to break backward compatibility was not taken lightly. OpenStack SDK's first major release (`1.0.0` and its -release candidates `0.99.x`) has streamlined and improved large parts of its codebase. For example, its Connection -interface now consistently uses the Resource interfaces under the hood. This required breaking changes from older SDK -releases though. The Ansible OpenStack collection is heavily based on OpenStack SDK. With OpenStack SDK becoming -backward incompatible, so does our Ansible OpenStack collection. We simply lack the devpower to maintain a backward -compatible interface in Ansible OpenStack collection across several SDK releases. +[openstacksdk]: https://opendev.org/openstack/openstacksdk -Our first `2.0.0` release is currently under development and we still have a long way to go. If you use modules of the -Ansible OpenStack collection and want to join us in porting them to the upcoming OpenStack SDK, please contact us! -Ping Jakob Meng <mail@jakobmeng.de> (jm1) or Rafael Castillo <rcastill@redhat.com> (rcastillo) and we will give you a -quick introduction. We are also hanging around on `irc.oftc.net/#openstack-ansible-sig` and `irc.oftc.net/#oooq` 😎 +## Installation -We have extensive documentation on [why, what and how we are adopting and reviewing the new modules]( -https://hackmd.io/szgyWa5qSUOWw3JJBXLmOQ?view), [how to set up a working DevStack environment for hacking on the -collection](https://hackmd.io/PI10x-iCTBuO09duvpeWgQ?view) and, most importantly, [a list of modules where we are -coordinating our porting efforts](https://hackmd.io/7NtovjRkRn-tKraBXfz9jw?view). +For using this collection, first you have to install both Python packages `ansible` and `openstacksdk` on your Ansible +controller: -## Installation and Usage - -### Installing dependencies - -For using the Openstack Cloud collection firstly you need to install `ansible` and `openstacksdk` Python modules on your Ansible controller. -For example with pip: - -```bash -pip install "ansible>=2.9" "openstacksdk>=0.36,<0.99.0" +```sh +pip install "ansible>=2.9" "openstacksdk>=1.0.0" ``` -OpenStackSDK has to be available to Ansible and to the Python interpreter on the host, where Ansible executes the module (target host). -Please note, that under some circumstances Ansible might invoke a non-standard Python interpreter on the target host. -Using Python version 3 is highly recommended for OpenstackSDK and strongly required from OpenstackSDK version 0.39.0. - ---- - -#### NOTE - -OpenstackSDK is better to be the last stable version. It should NOT be installed on Openstack nodes, -but rather on operators host (aka "Ansible controller"). OpenstackSDK from last version supports -operations on all Openstack cloud versions. Therefore OpenstackSDK module version doesn't have to match -Openstack cloud version usually. +[OpenStack SDK][openstacksdk] has to be available on the Ansible host running the OpenStack modules. Depending on the +Ansible playbook and roles you use, this host is not necessarily the Ansible controller. Sometimes Ansible might invoke +a non-standard Python interpreter on the target Ansible host. Using Python 3.6 is required for modules in this +collection. ---- +Always use the last stable version of [OpenStack SDK][openstacksdk] if possible, also when running against older +OpenStack deployments. OpenStack SDK is backward compatible to older OpenStack deployments, so its safe to run last +version of the SDK against older OpenStack clouds. The installed version of the OpenStack SDK does not have to match +your OpenStack cloud, but it has to match the release series of this collection which you are using. For notes about +our release series and branches please read the introduction above. -### Installing the Collection from Ansible Galaxy +Before using this collection, you have to install it with `ansible-galaxy`: -Before using the Openstack Cloud collection, you need to install the collection with the `ansible-galaxy` CLI: - -`ansible-galaxy collection install openstack.cloud` +```sh +ansible-galaxy collection install openstack.cloud +``` -You can also include it in a `requirements.yml` file and install it through `ansible-galaxy collection install -r requirements.yml` using the format: +You can also include it in a `requirements.yml` file: ```yaml collections: - name: openstack.cloud ``` -### Playbooks +And then install it with: -To use a module from the Openstack Cloud collection, please reference the full namespace, collection name, and module name that you want to use: +```sh +ansible-galaxy collection install -r requirements.yml +``` + +## Usage + +To use a module from the Ansible OpenStack collection, call them by their Fully Qualified Collection Name (FQCN), +composed of their namespace, collection name and module name: ```yaml --- -- name: Using Openstack Cloud collection - hosts: localhost +- hosts: localhost tasks: - - openstack.cloud.server: + - name: Create server in an OpenStack cloud + openstack.cloud.server: name: vm state: present cloud: openstack @@ -103,12 +93,12 @@ Or you can add the full namespace and collection name in the `collections` eleme ```yaml --- -- name: Using Openstack Cloud collection - hosts: localhost +- hosts: localhost collections: - openstack.cloud tasks: - - server_volume: + - name: Create server in an OpenStack cloud + server_volume: state: present cloud: openstack server: Mysql-server @@ -116,49 +106,126 @@ Or you can add the full namespace and collection name in the `collections` eleme device: /dev/vdb ``` -### Usage +For powerful generic [CRUD][crud]-style resource management use Ansible module +[`openstack.cloud.resource`](plugins/modules/resource.py): -See the collection docs at Ansible site: +```yaml +--- +- hosts: localhost + tasks: + - name: Create security group + openstack.cloud.resource: + cloud: openstack + service: network + type: security_group + attributes: + name: ansible_security_group + description: 'ansible security group' + + - name: Update security group description + openstack.cloud.resource: + cloud: openstack + service: network + type: security_group + attributes: + name: ansible_security_group + description: 'ansible neutron security group' + + - name: Delete security group + openstack.cloud.resource: + cloud: openstack + service: network + type: security_group + attributes: + name: ansible_security_group + state: absent +``` -* [openstack.cloud collection docs (version released in Ansible package)](https://docs.ansible.com/ansible/latest/collections/openstack/cloud/index.html) +For generic resource listing use Ansible module [`openstack.cloud.resources`](plugins/modules/resources.py): -* [openstack.cloud collection docs (devel version)](https://docs.ansible.com/ansible/devel/collections/openstack/cloud/index.html) +```yaml +--- +- hosts: localhost + tasks: + - name: List images + openstack.cloud.resources: + cloud: openstack + service: image + type: image -## Contributing + - name: List compute flavors + openstack.cloud.resources: + cloud: openstack + service: compute + type: flavor + + - name: List networks with name 'public' + openstack.cloud.resources: + cloud: openstack + service: network + type: network + parameters: + name: public +``` -For information on contributing, please see [CONTRIBUTING](https://opendev.org/openstack/ansible-collections-openstack/src/branch/master/CONTRIBUTING.rst) +[Ansible module defaults][ansible-module-defaults] are supported as well: -There are many ways in which you can participate in the project, for example: +```yaml +--- +- module_defaults: + group/openstack.cloud.openstack: + cloud: devstack-admin + # + # + # Listing modules individually is required for + # backward compatibility with Ansible 2.9 only + openstack.cloud.compute_flavor_info: + cloud: devstack-admin + openstack.cloud.server_info: + cloud: devstack-admin + block: + - name: List compute flavors + openstack.cloud.compute_flavor_info: + + - name: List servers + openstack.cloud.server_info: +``` -- Submit [bugs and feature requests](https://storyboard.openstack.org/#!/project/openstack/ansible-collections-openstack), and help us verify them -- Submit and review source code changes in [Openstack Gerrit](https://review.opendev.org/#/q/project:openstack/ansible-collections-openstack) -- Add new modules for Openstack Cloud +[ansible-module-defaults]: https://docs.ansible.com/ansible/latest/user_guide/playbooks_module_defaults.html +[crud]: https://en.wikipedia.org/wiki/CRUD -We work with [OpenDev Gerrit](https://review.opendev.org/), pull requests submitted through GitHub will be ignored. +## Documentation -## Testing and Development +See collection docs at Ansible's main page: -If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there. +* [openstack.cloud collection docs (version released in Ansible package)]( + https://docs.ansible.com/ansible/latest/collections/openstack/cloud/index.html) -### Testing with `ansible-test` +* [openstack.cloud collection docs (devel version)]( + https://docs.ansible.com/ansible/devel/collections/openstack/cloud/index.html) -We use `ansible-test` for sanity: +## Contributing -```bash -tox -e linters -``` +Thank you for your interest in our Ansible OpenStack collection ☺️ + +There are many ways in which you can participate in the project, for example: -## More Information +- [Report and verify bugs and help with solving issues]( + https://storyboard.openstack.org/#!/project/openstack/ansible-collections-openstack). +- [Submit and review patches]( + https://review.opendev.org/#/q/project:openstack/ansible-collections-openstack). +- Follow OpenStack's [How To Contribute](https://wiki.openstack.org/wiki/How_To_Contribute) guide. -TBD +Please read our [Contributions and Development Guide](docs/contributing.md) (⚠️) and our [Review Guide]( +docs/reviewing.md) (⚠️) before sending your first patch. Pull requests submitted through GitHub will be ignored. ## Communication -We have a dedicated Interest Group for Openstack Ansible modules. -You can find other people interested in this in `#openstack-ansible-sig` on [OFTC IRC](https://www.oftc.net/). +We have a Special Interest Group for the Ansible OpenStack collection. Join us in `#openstack-ansible-sig` on +[OFTC IRC](https://www.oftc.net/) 🍪 ## License GNU General Public License v3.0 or later -See [LICENCE](https://opendev.org/openstack/ansible-collections-openstack/src/branch/master/COPYING) to see the full text. +See [LICENCE](COPYING) to see the full text. |