Prepare data for the v2.2.0 release with few new modules and bugfixes. Change-Id: Id593b623b389cedb140fb05e8063f48ef7eacc36
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.
NOTE: We need and value your contributions! Maintaining this collection is a community effort. We are all both users and developers of this collection at the same time. If you find a bug, please report it. If you have fixed a bug, please submit a patch. If you need new functionality which is not covered by this collection yet, please extend an existing module or submit a new one. Our Contributing section below has tons of docs to check out. Please get in touch!
Branches and Non Backward Compatibility ⚠️
Our codebase has been split into two separate release series,
2.x.xreleases of Ansible OpenStack collection are compatible with OpenStack SDK
1.x.xand its release candidates
0.99.0and later only (OpenStack Zed and later). Our
masterbranch tracks our
1.x.xreleases of Ansible OpenStack collection are compatible with OpenStack SDK
0.99.0only (OpenStack Yoga and earlier). Our
stable/1.0.0branch tracks our
2.x.xreleases of Ansible OpenStack collection are not backward compatible to
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!
For using this collection, first you have to install both Python packages
openstacksdk on your Ansible
pip install "ansible>=2.9" "openstacksdk>=1.0.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 collection install openstack.cloud
You can also include it in a
collections: - name: openstack.cloud
And then install it with:
ansible-galaxy collection install -r requirements.yml
To use a module from the Ansible OpenStack collection, call them by their Fully Qualified Collection Name (FQCN), composed of their namespace, collection name and module name:
--- - hosts: localhost tasks: - name: Create server in an OpenStack cloud 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
--- - hosts: localhost collections: - openstack.cloud tasks: - name: Create server in an OpenStack cloud server_volume: state: present cloud: openstack server: Mysql-server volume: mysql-data device: /dev/vdb
--- - hosts: localhost tasks: - name: Create security group openstack.cloud.resource: cloud: openstack service: network type: security_group attributes: name: ansible_security_group description: 'ansible security group' - name: Update security group description openstack.cloud.resource: cloud: openstack service: network type: security_group attributes: name: ansible_security_group description: 'ansible neutron security group' - name: Delete security group openstack.cloud.resource: cloud: openstack service: network type: security_group attributes: name: ansible_security_group state: absent
For generic resource listing use Ansible module
--- - hosts: localhost tasks: - name: List images openstack.cloud.resources: cloud: openstack service: image type: image - name: List compute flavors openstack.cloud.resources: cloud: openstack service: compute type: flavor - name: List networks with name 'public' openstack.cloud.resources: cloud: openstack service: network type: network parameters: name: public
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:
See collection docs at Ansible's main page:
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.
We have a Special Interest Group for the Ansible OpenStack collection. Join us in
OFTC IRC 🍪
GNU General Public License v3.0 or later
See LICENCE to see the full text.