Ansible Modules Collection for using OpenStack
Go to file
Sagi Shnaidman c9da50e7e7 Add setup.py for install with pip
Make possible installation with pip.
Change-Id: I8eec015142c4f29eadff0dac2781782b76dea308
2020-06-04 14:23:23 +00:00
changelogs/fragments Moved openstack inventory script from community.general 2020-04-13 15:22:18 +05:30
ci Add setup.py for install with pip 2020-06-04 14:23:23 +00:00
contrib Add template for generation of artibtrary module 2020-05-25 02:27:40 +03:00
docs Remove all of the os_ prefixes 2020-05-12 10:19:28 -05:00
meta Rename routing.yml to runtime.yml 2020-05-16 07:43:29 -05:00
plugins Redesign OpenstackModule class 2020-06-04 13:49:48 +03:00
scripts/inventory Moved openstack inventory script from community.general 2020-04-13 15:22:18 +05:30
tests Redesign OpenstackModule class 2020-06-04 13:49:48 +03:00
tools Fix ansible-tests for devel branch 2020-06-03 00:05:07 +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 Add setup.py for install with pip 2020-06-04 14:23:23 +00: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 Update README with additional information 2020-05-14 08:39:47 +03: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.txt Validate that we can upload build collection 2020-05-19 11:13:22 -05:00
tox.ini Add setup.py for install with pip 2020-06-04 14:23:23 +00: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 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:

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

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.