diff --git a/README.md b/README.md index eb2694bb..6214c487 100644 --- a/README.md +++ b/README.md @@ -1,150 +1,102 @@ -# collection_template -You can build a new repository for an Ansible Collection using this template by following [Creating a repository from a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template). This README.md contains recommended headings for your collection README.md, with comments describing what each section should contain. Once you have created your collection repository, delete this paragraph and the title above it from your README.md. +# cloud.vmware_ops roles/playbooks for VMware -# Foo Collection for Ansible - -[![CI](https://github.com/ansible-collections/REPONAMEHERE/workflows/CI/badge.svg?event=push)](https://github.com/ansible-collections/REPONAMEHERE/actions) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/REPONAMEHERE)](https://codecov.io/gh/ansible-collections/REPONAMEHERE) +This repository hosts the `cloud.vmware_ops` Ansible Collection. - +The collection includes a variety of Ansible roles and playbooks to help automate the management of VMware. -## Our mission + +## Ansible version compatibility - +This collection has been tested against following Ansible versions: **>=2.14.0**. -## Code of Conduct +## Python version compatibility -We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project. +This collection requires Python 3.9 or greater. -If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint. - -## Communication - - - -We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). If you are a collection developer, be sure you are subscribed. - -Join us on: -* The Ansible forum: - * [News & Announcements](https://forum.ansible.com/c/news/5/none) - * [Get Help](https://forum.ansible.com/c/help/6/none) - * [Social Spaces](https://forum.ansible.com/c/chat/4) -* Matrix chat rooms: - * [#users:ansible.com](https://matrix.to/#/#users:ansible.com): general use questions and support - * [#community:ansible.com](https://matrix.to/#/#community:ansible.com): community and collection development questions - * [#social:ansible.com](https://matrix.to/#/#social:ansible.com): to say "Good morning, community!" - -We take part in the global [Ansible contributor summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn) and join us. - -For more information about communication, refer to the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html). - -## Contributing to this collection - - - -The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software. - -We are actively accepting new contributors and all types of contributions are very welcome. - -Don't know how to start? Refer to the [Ansible community guide](https://docs.ansible.com/ansible/devel/community/index.html)! - -Want to submit code changes? Take a look at the [Quick-start development guide](https://docs.ansible.com/ansible/devel/community/create_pr_quick_start.html). - -We also use the following guidelines: - -* [Collection review checklist](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_reviewing.html) -* [Ansible development guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html) -* [Ansible collection development guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections) - -## Collection maintenance - -The current maintainers are listed in the [MAINTAINERS](MAINTAINERS) file. If you have questions or need help, feel free to mention them in the proposals. - -To learn how to maintain/become a maintainer of this collection, refer to the [Maintainer guidelines](https://docs.ansible.com/ansible/devel/community/maintainers.html). - -It is necessary for maintainers of this collection to be subscribed to: - -* The collection itself (the `Watch` button -> `All Activity` in the upper right corner of the repository's homepage). -* The [news-for-maintainers repository](https://github.com/ansible-collections/news-for-maintainers). - -They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). - -## Governance - - - -The process of decision making in this collection is based on discussing and finding consensus among participants. +## Included content -Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it! +Click on the name of a role to view that content's documentation: -## Tested with Ansible + +### Roles +Name | Description +--- | --- +[cloud.vmware_ops.provision_vcenter](https://github.com/ansible-collections/cloud.vmware_ops/blob/main/roles/provision_vcenter/README.md)|A role to provison Vcenter on ESXi host. +[cloud.vmware_ops.provision_vm](https://github.com/ansible-collections/cloud.vmware_ops/blob/main/roles/provision_vm/README.md)|A role to create/manage virtual machines on VMware. +[cloud.vmware_ops.system_settings](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/roles/system_settings/README.md)|A role to manage system settings on VMware. - +### Playbooks +Name | Description +--- | --- +[cloud.vmware_ops.provision_vcenter](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/provision_vcenter/provision_vcsa_on_esxi.yml)|A playbook to provison Vcenter on ESXi host. +[cloud.vmware_ops.provision_vm](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/provision_vm/manage_vm.yml)|A playbook to create/manage virtual machines on VMware. +[cloud.vmware_ops.system_settings](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/system_settings.yml)|A playbook to manage system settings on VMware. + -## External requirements +## Installation and Usage - +### Requirements -### Supported connections - +The [community.vmware](https://github.com/ansible-collections/community.vmware), [vmware.vmware_rest](https://github.com/ansible-collections/vmware.vmware_rest) and [community.general](https://github.com/ansible-collections/community.general) collections MUST be installed in order for this collection to work. -## Included content +### Installation - +To consume this Validated Content from Automation Hub, please ensure that you add the following lines to your ansible.cfg file. -## Using this collection +``` +[galaxy] +server_list = automation_hub - +[galaxy_server.automation_hub] +url=https://cloud.redhat.com/api/automation-hub/ +auth_url=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token +token= +``` +The token can be obtained from the [Automation Hub Web UI](https://console.redhat.com/ansible/automation-hub/token). -### Installing the Collection from Ansible Galaxy +Once the above steps are done, you can run the following command to install the collection. -Before using this collection, you need to install it with the Ansible Galaxy command-line tool: -```bash -ansible-galaxy collection install NAMESPACE.COLLECTION_NAME ``` - -You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format: -```yaml ---- -collections: - - name: NAMESPACE.COLLECTION_NAME +ansible-galaxy collection install cloud.vmware_ops ``` -Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the `ansible` package. To upgrade the collection to the latest available version, run the following command: -```bash -ansible-galaxy collection install NAMESPACE.COLLECTION_NAME --upgrade -``` +### Using this collection -You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version `0.1.0`: +Once installed, you can reference the cloud.vmware_ops collection content by its fully qualified collection name (FQCN), for example: -```bash -ansible-galaxy collection install NAMESPACE.COLLECTION_NAME:==0.1.0 +```yaml + - hosts: localhost + roles: + - role: cloud.vmware_ops.system_settings ``` -See [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details. +### See Also -## Release notes +* [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details. -See the [changelog](https://github.com/ansible-collections/REPONAMEHERE/tree/main/CHANGELOG.rst). -## Roadmap +## Contributing to this collection + +We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against this collection repository. - +### Testing and Development -## More information +The project uses `ansible-lint` and `black`. +Assuming this repository is checked out in the proper structure, +e.g. `collections_root/ansible_collections/cloud/gcp_ops/`, run: - +```shell + tox -e linters +``` -- [Ansible user guide](https://docs.ansible.com/ansible/devel/user_guide/index.html) -- [Ansible developer guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html) -- [Ansible collections requirements](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_requirements.html) -- [Ansible community Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) -- [The Bullhorn (the Ansible contributor newsletter)](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn) -- [Important announcements for maintainers](https://github.com/ansible-collections/news-for-maintainers) +Sanity and unit tests are run as normal: -## Licensing +```shell + ansible-test sanity +``` - +## License -GNU General Public License v3.0 or later. +GNU General Public License v3.0 or later -See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. +See [LICENSE](https://github.com/ansible-collections/cloud.gcp_ops/blob/main/LICENSE) to see the full text. \ No newline at end of file