Ansible Modules Collection for using OpenStack
Go to file
Sagi Shnaidman 1c6663999d Add changelog for 1.2.0
Change-Id: I63cff2945703d12d95726a43b33888e80e35b040
2020-10-13 17:00:37 +03:00
changelogs Add changelog for 1.2.0 2020-10-13 17:00:37 +03:00
ci Add volume_snapshot_info module 2020-09-30 13:40:54 +02:00
contrib Update author lines 2020-06-23 21:50:43 +03:00
docs Remove all of the os_ prefixes 2020-05-12 10:19:28 -05:00
meta Add volume_snapshot_info module 2020-09-30 13:40:54 +02:00
plugins Merge "Add volume_snapshot_info module" 2020-09-30 16:02:15 +00:00
scripts/inventory Moved openstack inventory script from community.general 2020-04-13 15:22:18 +05:30
tests New CI jobs configuration 2020-06-23 12:27:04 +03:00
tools Temporarly disable check-import 2020-07-26 11:49:18 +03:00
.gitignore Ignore a few more things 2020-05-19 11:59:11 -05:00
.gitreview Added .gitreview 2019-09-25 15:21:42 +00:00
.zuul.yaml Fix linters for new ansible release 2020-09-24 23:59:26 +03:00
CHANGELOG.rst Add changelog for 1.2.0 2020-10-13 17:00:37 +03: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
README.md Add a link for issue report and feature request 2020-07-04 11:31:30 +02:00
galaxy.yml.in Ignore a few more things 2020-05-19 11:59:11 -05:00
setup.cfg Add setup.py for install with pip 2020-06-04 14:23:23 +00:00
setup.py Add setup.py 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.txt Temporarly disable check-import 2020-07-26 11:49:18 +03:00
tox.ini Temporarly disable check-import 2020-07-26 11:49:18 +03:00

README.md

OpenDev Zuul Builds - Ansible Collection OpenStack

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.

Installation and Usage

Installing dependencies

For using Openstack Cloud collection firstly need to install ansible and openstacksdk Python modules on 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 not standard Python interpreter on the target host. Using Python verison 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.


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 openstack.cloud

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

collections:
- name: openstack.cloud

Playbooks

To use a module from Openstack Cloud collection, please reference the full namespace, collection name, and modules 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 full namepsace and collecton name in the collections element:

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

Contributing

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

TBD

Communication

We have a dedicated Interest Group for Openstack Ansible modules. You can find other people interested in this in #openstack-ansible-sig on Freenode IRC.

License

GNU General Public License v3.0 or later

See LICENCE to see the full text.