Ansible Modules Collection for using OpenStack
Go to file
Zuul 26530ac97b Merge "Leave queens job only in experimental" 2021-12-18 23:25:14 +00:00
changelogs Release 1.5.3 version with bugfixes 2021-11-11 13:58:54 +02:00
ci Allow to attach multiple floating ips to a server 2021-08-06 15:02:20 +02:00
contrib Update author lines 2020-06-23 21:50:43 +03:00
docs Guidelines: Fix links and formatting 2021-02-15 20:49:37 +00:00
meta Add mandatory requires_ansible version to metadata 2021-07-29 17:05:11 +03:00
plugins quota: Adds metadata_items parameter 2021-12-16 18:59:40 +00:00
scripts/inventory Moved openstack inventory script from community.general 2020-04-13 15:22:18 +05:30
tests Move CI to use Ansible 2.12 version as main 2021-10-04 15:05:51 +03:00
tools Remove tests directory from ansible-tests 2021-08-16 16:06:10 +03:00
.gitignore Add galaxy.yml to support install from git 2020-10-21 09:12:05 +00:00
.gitreview Added .gitreview 2019-09-25 15:21:42 +00:00
.zuul.yaml Leave queens job only in experimental 2021-12-18 22:23:24 +02:00
CHANGELOG.rst Release 1.5.3 version with bugfixes 2021-11-11 13:58:54 +02:00
CONTRIBUTING.rst Add contributing file 2020-05-13 08:07:01 -05:00
COPYING Fix license metadata 2020-03-05 15:08:38 +00:00 Add documentation links to 2021-10-25 13:32:04 +02:00
bindep.txt Add bindep.txt for ansible-builder 2021-05-19 14:04:33 -04:00
galaxy.yml Release 1.5.3 version with bugfixes 2021-11-11 13:58:54 +02:00 Add galaxy.yml to support install from git 2020-10-21 09:12:05 +00:00
requirements.txt Add execution environment metadata 2021-04-07 14:41:19 +00:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-04-29 17:38:54 +08:00 Add for install with pip 2020-06-04 14:23:23 +00:00
test-requirements-2.9.txt Fix linters for new ansible release 2020-09-24 23:59:26 +03:00
test-requirements-2.11.txt Fix Ansible devel jobs 2020-11-24 22:40:09 +02:00
test-requirements-2.12.txt Move CI to use Ansible 2.12 version as main 2021-10-04 15:05:51 +03:00
test-requirements.txt Prepare for Ansible 2.11 tests 2021-04-08 00:19:24 +03:00
tox.ini Move CI to use Ansible 2.12 version as main 2021-10-04 15:05:51 +03:00

OpenDev Zuul Builds - Ansible Collection OpenStack

Ansible Collection:

This repo hosts the Ansible Collection.

The collection includes the Openstack modules and plugins supported by Openstack community to help the management of Openstack infrastructure.

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:

pip install ansible openstacksdk

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 CLI:

ansible-galaxy collection install

You can also include it in a requirements.yml file and install it through ansible-galaxy collection install -r requirements.yml using the format:

- name:


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
        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 collections element:

- name: Using Openstack Cloud collection
  hosts: localhost
    - 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:

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.

Testing with ansible-test

We use ansible-test for sanity:

tox -e linters

More Information



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.