|2 months ago|
|changelogs||2 months ago|
|ci||2 months ago|
|contrib||2 years ago|
|docs||9 months ago|
|meta||8 months ago|
|plugins||2 months ago|
|scripts/inventory||2 months ago|
|tests||4 months ago|
|tools||7 months ago|
|.gitignore||2 years ago|
|.gitreview||3 years ago|
|.zuul.yaml||2 months ago|
|CHANGELOG.rst||2 months ago|
|CONTRIBUTING.rst||3 years ago|
|COPYING||3 years ago|
|README.md||6 months ago|
|bindep.txt||2 years ago|
|galaxy.yml||2 months ago|
|galaxy.yml.in||8 months ago|
|requirements.txt||6 months ago|
|setup.cfg||2 years ago|
|setup.py||3 years ago|
|tox.ini||8 months ago|
Ansible Collection: openstack.cloud
This repo hosts the
openstack.cloud Ansible Collection.
The collection includes the Openstack modules and plugins supported by Openstack community to help the management of Openstack infrastructure.
Breaking backward compatibility ⚠️
Dear contributors and users of the Ansible OpenStack collection! Our codebase has been split into two separate release series:
2.x.xreleases of Ansible OpenStack collection are compatible with OpenStack SDK
1.x.xand its release candidates
0.99.xonly (OpenStack Zed and later). Our
masterbranch tracks our
1.x.xreleases of Ansible OpenStack collection are compatible with OpenStack SDK
0.99.0only (OpenStack Yoga and earlier). Our
stable/1.0.0branch tracks our
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
modules have changed due to updates in the OpenStack SDK.
Our decision to break backward compatibility was not taken lightly. OpenStack SDK's first major release (
1.0.0 and its
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.
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 email@example.com (jm1) or Rafael Castillo firstname.lastname@example.org (rcastillo) and we will give you a
quick introduction. We are also hanging around on
We have extensive documentation on why, what and how we are adopting and reviewing the new modules, how to set up a working DevStack environment for hacking on the collection and, most importantly, a list of modules where we are coordinating our porting efforts.
Installation and Usage
For using the Openstack Cloud collection firstly you need to install
openstacksdk Python modules on your Ansible controller.
For example with pip:
pip install "ansible>=2.9" "openstacksdk>=0.36,<0.99.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.
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.
Installing the Collection from Ansible Galaxy
Before using the Openstack Cloud collection, you need to install the collection with the
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:
collections: - name: openstack.cloud
To use a module from the Openstack Cloud collection, please reference the full namespace, collection name, and module name that you want to use:
--- - name: Using Openstack Cloud collection hosts: localhost tasks: - openstack.cloud.server: name: vm state: present cloud: openstack region_name: ams01 image: Ubuntu Server 14.04 flavor_ram: 4096 boot_from_volume: True volume_size: 75
Or you can add the full namespace and collection name in the
--- - name: Using Openstack Cloud collection hosts: localhost collections: - openstack.cloud tasks: - server_volume: state: present cloud: openstack server: Mysql-server volume: mysql-data device: /dev/vdb
See the collection docs at Ansible site:
For information on contributing, please see CONTRIBUTING
There are many ways in which you can participate in the project, for example:
- Submit bugs and feature requests, and help us verify them
- Submit and review source code changes in Openstack Gerrit
- Add new modules for Openstack Cloud
We work with OpenDev Gerrit, pull requests submitted through GitHub will be ignored.
Testing and Development
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, and work on it there.
ansible-test for sanity:
tox -e linters
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.
GNU General Public License v3.0 or later
See LICENCE to see the full text.