![]() With "extends_documentation_fragment: ['openstack.cloud.openstack']" it is not necessary to list required Python libraries in section 'requirements' of DOCUMENTATION docstring in modules. Ansible will merge requirements from doc fragments and DOCUMENTATION docstring which previously resulted in duplicates such as in server module [0]: * openstacksdk * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 When removing the 'requirements' section from server module, then Ansible will list openstacksdk once only: * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 To see what documentation Ansible will produce for server module run: ansible-doc --type module openstack.cloud.server [0] https://docs.ansible.com/ansible/latest/collections/openstack/\ cloud/server_module.html Change-Id: Ia53c2c34436c7a72080602f5699e82d20f677b8b |
||
---|---|---|
changelogs | ||
ci | ||
docs | ||
meta | ||
plugins | ||
scripts/inventory | ||
tests | ||
tools | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
bindep.txt | ||
CHANGELOG.rst | ||
COPYING | ||
galaxy.yml | ||
galaxy.yml.in | ||
README.md | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
tox.ini |
Ansible OpenStack Collection
Ansible OpenStack collection aka openstack.cloud
provides Ansible modules and Ansible plugins for managing OpenStack
clouds. It is supported and maintained by the OpenStack community.
Branches and Non Backward Compatibility ⚠️
Our codebase has been split into two separate release series, 2.x.x
and 1.x.x
:
2.x.x
releases of Ansible OpenStack collection are compatible with OpenStack SDK1.x.x
and its release candidates0.99.0
and later only (OpenStack Zed and later). Ourmaster
branch tracks our2.x.x
releases.1.x.x
releases of Ansible OpenStack collection are compatible with OpenStack SDK0.x.x
prior to0.99.0
only (OpenStack Yoga and earlier). Ourstable/1.0.0
branch tracks our1.x.x
releases.2.x.x
releases of Ansible OpenStack collection are not backward compatible to1.x.x
releases ⚠️
For rationale and details please read our branching docs. 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!
Installation
For using this collection, first you have to install both Python packages ansible
and openstacksdk
on your Ansible
controller:
pip install "ansible>=2.9" "openstacksdk>=0.36,<0.99.0"
OpenStack SDK has to be available on the Ansible host running the OpenStack modules. Depending on the Ansible playbook and roles you use, this host is not necessarily the Ansible controller. Sometimes Ansible might invoke a non-standard Python interpreter on the target Ansible host. Using Python 3.6 is required for modules in this collection.
Always use the last stable version of OpenStack SDK if possible, also when running against older OpenStack deployments. OpenStack SDK is backward compatible to older OpenStack deployments, so its safe to run last version of the SDK against older OpenStack clouds. The installed version of the OpenStack SDK does not have to match your OpenStack cloud, but it has to match the release series of this collection which you are using. For notes about our release series and branches please read the introduction above.
Before using this collection, you have to install it with ansible-galaxy
:
ansible-galaxy collection install openstack.cloud
You can also include it in a requirements.yml
file:
collections:
- name: openstack.cloud
And then install it with:
ansible-galaxy collection install -r requirements.yml
Usage
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 collections
element:
---
- name: Using the Ansible OpenStack Collection
hosts: localhost
collections:
- openstack.cloud
tasks:
- server_volume:
state: present
cloud: openstack
server: Mysql-server
volume: mysql-data
device: /dev/vdb
Ansible module defaults are supported as well:
---
- module_defaults:
group/openstack.cloud.openstack:
cloud: devstack-admin
#
#
# Listing modules individually is required for
# backward compatibility with Ansible 2.9 only
openstack.cloud.compute_flavor_info:
cloud: devstack-admin
openstack.cloud.server_info:
cloud: devstack-admin
block:
- name: List compute flavors
openstack.cloud.compute_flavor_info:
- name: List servers
openstack.cloud.server_info:
Documentation
See collection docs at Ansible's main page:
Contributing
Thank you for your interest in our Ansible OpenStack collection ☺️
There are many ways in which you can participate in the project, for example:
- Report and verify bugs and help with solving issues.
- Submit and review patches.
- Follow OpenStack's How To Contribute guide.
Please read our Contributions and Development Guide (⚠️) and our Review Guide (⚠️) before sending your first patch. Pull requests submitted through GitHub will be ignored.
Communication
We have a Special Interest Group for the Ansible OpenStack collection. Join us in #openstack-ansible-sig
on
OFTC IRC and ping Artem Goncharov artem.goncharov@gmail.com (gtema), Jakob Meng
mail@jakobmeng.de (jm1) or Sagi Shnaidman sshnaidm@redhat.com (sshnaidm) 🍪
License
GNU General Public License v3.0 or later
See LICENCE to see the full text.