Ansible Modules Collection for using OpenStack
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Zuul 8792b2b527 Merge "Add openstack logger and Ansible display utility" 16 hours ago
changelogs/fragments Moved openstack inventory script from community.general 2 months ago
ci New CI jobs configuration 2 weeks ago
contrib Update author lines 2 weeks ago
docs Remove all of the os_ prefixes 1 month ago
meta Move action_group to runtime 3 weeks ago
plugins Merge "Add openstack logger and Ansible display utility" 16 hours ago
scripts/inventory Moved openstack inventory script from community.general 2 months ago
tests New CI jobs configuration 2 weeks ago
tools New CI jobs configuration 2 weeks ago
.gitignore Ignore a few more things 1 month ago
.gitreview Added .gitreview 9 months ago
.zuul.yaml Fix typos in job definitions 2 weeks ago
CONTRIBUTING.rst Add contributing file 1 month ago
COPYING Fix license metadata 4 months ago
README.md Add a link for issue report and feature request 5 days ago
galaxy.yml.in Ignore a few more things 1 month ago
setup.cfg Add setup.py for install with pip 1 month ago
setup.py Add setup.py for install with pip 1 month ago
test-requirements-2.9.txt New CI jobs configuration 2 weeks ago
test-requirements.txt New CI jobs configuration 2 weeks ago
tox.ini New CI jobs configuration 2 weeks ago

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.