{"id":20111187,"url":"https://github.com/openstack/ansible-collections-openstack","last_synced_at":"2025-04-05T21:10:42.470Z","repository":{"id":40678306,"uuid":"210877584","full_name":"openstack/ansible-collections-openstack","owner":"openstack","description":"Ansible Modules Collection for using OpenStack. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2025-01-27T22:04:01.000Z","size":1804,"stargazers_count":51,"open_issues_count":0,"forks_count":36,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-29T20:08:51.707Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/ansible-collections-openstack","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openstack.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":"docs/contributing.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-25T15:21:44.000Z","updated_at":"2025-02-23T16:00:05.000Z","dependencies_parsed_at":"2023-12-04T10:30:21.091Z","dependency_job_id":"f6c27130-0e2a-43eb-ac93-f5523baed035","html_url":"https://github.com/openstack/ansible-collections-openstack","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fansible-collections-openstack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fansible-collections-openstack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fansible-collections-openstack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fansible-collections-openstack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/ansible-collections-openstack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399885,"owners_count":20932880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T18:14:47.638Z","updated_at":"2025-04-05T21:10:42.448Z","avatar_url":"https://github.com/openstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![OpenDev Zuul Builds - Ansible OpenStack Collection](https://zuul-ci.org/gated.svg)](\nhttp://zuul.opendev.org/t/openstack/builds?project=openstack%2Fansible-collections-openstack)\n\n# Ansible OpenStack Collection\n\nAnsible OpenStack collection aka `openstack.cloud` provides Ansible modules and Ansible plugins for managing OpenStack\nclouds. It is supported and maintained by the OpenStack community.\n\n**NOTE:** We need and value your contributions! Maintaining this collection is a community effort. We are all both users\nand developers of this collection at the same time. If you find a bug, please report it. If you have fixed a bug, please\nsubmit a patch. If you need new functionality which is not covered by this collection yet, please extend an existing\nmodule or submit a new one. Our [Contributing](#contributing) section below has tons of docs to check out. Please get in\ntouch!\n\n## Branches and Non Backward Compatibility ⚠️\n\nOur codebase has been split into two separate release series, `2.x.x` and `1.x.x`:\n\n* `2.x.x` releases of Ansible OpenStack collection are compatible with [OpenStack SDK][openstacksdk] `1.x.x` and its\n  release candidates `0.99.0` and later *only* (OpenStack Zed and later). Our `master` branch tracks our `2.x.x`\n  releases.\n* `1.x.x` releases of Ansible OpenStack collection are compatible with [OpenStack SDK][openstacksdk] `0.x.x` prior to\n  `0.99.0` *only* (OpenStack Yoga and earlier). Our `stable/1.0.0` branch tracks our `1.x.x` releases.\n* `2.x.x` releases of Ansible OpenStack collection are not backward compatible to `1.x.x` releases ⚠️\n\nFor rationale and details please read our [branching docs](docs/branching.md). Both branches will be developed in\nparallel for the time being. Patches from `master` will be backported to `stable/1.0.0` on a best effort basis but\nexpect new features to be introduced in our `master` branch only. Contributions are welcome for both branches!\n\n[openstacksdk]: https://opendev.org/openstack/openstacksdk\n\n## Installation\n\nFor using this collection, first you have to install both Python packages `ansible` and `openstacksdk` on your Ansible\ncontroller:\n\n```sh\npip install \"ansible\u003e=2.9\" \"openstacksdk\u003e=1.0.0\"\n```\n\n[OpenStack SDK][openstacksdk] has to be available on the Ansible host running the OpenStack modules. Depending on the\nAnsible playbook and roles you use, this host is not necessarily the Ansible controller. Sometimes Ansible might invoke\na non-standard Python interpreter on the target Ansible host. Using Python 3.6 is required for modules in this\ncollection.\n\nAlways use the last stable version of [OpenStack SDK][openstacksdk] if possible, also when running against older\nOpenStack deployments. OpenStack SDK is backward compatible to older OpenStack deployments, so its safe to run last\nversion of the SDK against older OpenStack clouds. The installed version of the OpenStack SDK does not have to match\nyour OpenStack cloud, but it has to match the release series of this collection which you are using. For notes about\nour release series and branches please read the introduction above.\n\nBefore using this collection, you have to install it with `ansible-galaxy`:\n\n```sh\nansible-galaxy collection install openstack.cloud\n```\n\nYou can also include it in a `requirements.yml` file:\n\n```yaml\ncollections:\n- name: openstack.cloud\n```\n\nAnd then install it with:\n\n```sh\nansible-galaxy collection install -r requirements.yml\n```\n\n## Usage\n\nTo use a module from the Ansible OpenStack collection, call them by their Fully Qualified Collection Name (FQCN),\ncomposed of their namespace, collection name and module name:\n\n```yaml\n---\n- hosts: localhost\n  tasks:\n    - name: Create server in an OpenStack cloud\n      openstack.cloud.server:\n        name: vm\n        state: present\n        cloud: openstack\n        region_name: ams01\n        image: Ubuntu Server 14.04\n        flavor_ram: 4096\n        boot_from_volume: True\n        volume_size: 75\n```\n\nOr you can add the full namespace and collection name in the `collections` element:\n\n```yaml\n---\n- hosts: localhost\n  collections:\n    - openstack.cloud\n  tasks:\n    - name: Create server in an OpenStack cloud\n      server_volume:\n        state: present\n        cloud: openstack\n        server: Mysql-server\n        volume: mysql-data\n        device: /dev/vdb\n```\n\nFor powerful generic [CRUD][crud]-style resource management use Ansible module\n[`openstack.cloud.resource`](plugins/modules/resource.py):\n\n```yaml\n---\n- hosts: localhost\n  tasks:\n    - name: Create security group\n      openstack.cloud.resource:\n        cloud: openstack\n        service: network\n        type: security_group\n        attributes:\n          name: ansible_security_group\n          description: 'ansible security group'\n\n    - name: Update security group description\n      openstack.cloud.resource:\n        cloud: openstack\n        service: network\n        type: security_group\n        attributes:\n          name: ansible_security_group\n          description: 'ansible neutron security group'\n\n    - name: Delete security group\n      openstack.cloud.resource:\n        cloud: openstack\n        service: network\n        type: security_group\n        attributes:\n          name: ansible_security_group\n        state: absent\n```\n\nFor generic resource listing use Ansible module [`openstack.cloud.resources`](plugins/modules/resources.py):\n\n```yaml\n---\n- hosts: localhost\n  tasks:\n    - name: List images\n      openstack.cloud.resources:\n        cloud: openstack\n        service: image\n        type: image\n\n    - name: List compute flavors\n      openstack.cloud.resources:\n        cloud: openstack\n        service: compute\n        type: flavor\n\n    - name: List networks with name 'public'\n      openstack.cloud.resources:\n        cloud: openstack\n        service: network\n        type: network\n        parameters:\n          name: public\n```\n\n[Ansible module defaults][ansible-module-defaults] are supported as well:\n\n```yaml\n---\n- module_defaults:\n    group/openstack.cloud.openstack:\n      cloud: devstack-admin\n    #\n    #\n    # Listing modules individually is required for\n    # backward compatibility with Ansible 2.9 only\n    openstack.cloud.compute_flavor_info:\n      cloud: devstack-admin\n    openstack.cloud.server_info:\n      cloud: devstack-admin\n  block:\n    - name: List compute flavors\n      openstack.cloud.compute_flavor_info:\n\n    - name: List servers\n      openstack.cloud.server_info:\n```\n\n[ansible-module-defaults]: https://docs.ansible.com/ansible/latest/user_guide/playbooks_module_defaults.html\n[crud]: https://en.wikipedia.org/wiki/CRUD\n\n## Documentation\n\nSee collection docs at Ansible's main page:\n\n* [openstack.cloud collection docs (version released in Ansible package)](\n  https://docs.ansible.com/ansible/latest/collections/openstack/cloud/index.html)\n\n* [openstack.cloud collection docs (devel version)](\n  https://docs.ansible.com/ansible/devel/collections/openstack/cloud/index.html)\n\n## Contributing\n\nThank you for your interest in our Ansible OpenStack collection ☺️\n\nThere are many ways in which you can participate in the project, for example:\n\n- [Report and verify bugs and help with solving issues](\n  https://storyboard.openstack.org/#!/project/openstack/ansible-collections-openstack).\n- [Submit and review patches](\n  https://review.opendev.org/#/q/project:openstack/ansible-collections-openstack).\n- Follow OpenStack's [How To Contribute](https://wiki.openstack.org/wiki/How_To_Contribute) guide.\n\nPlease read our [Contributions and Development Guide](docs/contributing.md) (⚠️) and our [Review Guide](\ndocs/reviewing.md) (⚠️) before sending your first patch. Pull requests submitted through GitHub will be ignored.\n\n## Communication\n\nWe have a Special Interest Group for the Ansible OpenStack collection. Join us in `#openstack-ansible-sig` on\n[OFTC IRC](https://www.oftc.net/) 🍪\n\n## License\n\nGNU General Public License v3.0 or later\n\nSee [LICENCE](COPYING) to see the full text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fansible-collections-openstack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fansible-collections-openstack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fansible-collections-openstack/lists"}