-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Ondra Machacek <omachace@redhat.com>
- Loading branch information
1 parent
f7eb03e
commit f396364
Showing
1 changed file
with
65 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| <!-- Add CI and code coverage badges here. Samples included below. --> | ||
| [](https://github.com/ansible-collections/REPONAMEHERE/actions) [](https://codecov.io/gh/ansible-collections/REPONAMEHERE) | ||
| This repository hosts the `cloud.vmware_ops` Ansible Collection. | ||
|
|
||
| <!-- Describe the collection and why a user would want to use it. What does the collection do? --> | ||
| The collection includes a variety of Ansible roles and playbooks to help automate the management of VMware. | ||
|
|
||
| ## Our mission | ||
| <!--start requires_ansible--> | ||
| ## Ansible version compatibility | ||
|
|
||
| <!-- Put your collection project's mission statement in here. --> | ||
| 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 | ||
|
|
||
| <!--List available communication channels. In addition to channels specific to your collection, we also recommend to use the following ones.--> | ||
|
|
||
| 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 | ||
|
|
||
| <!--Describe how the community can contribute to your collection. At a minimum, fill up and include the CONTRIBUTING.md file containing how and where users can create issues to report problems or request features for this collection. List contribution requirements, including preferred workflows and necessary testing, so you can benefit from community PRs. If you are following general Ansible contributor guidelines, you can link to - [Ansible Community Guide](https://docs.ansible.com/ansible/devel/community/index.html). List the current maintainers (contributors with write or higher access to the repository). The following can be included:--> | ||
|
|
||
| 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 | ||
|
|
||
| <!--Describe how the collection is governed. Here can be the following text:--> | ||
|
|
||
| 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 | ||
| <!--start collection content--> | ||
| ### 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. | ||
|
|
||
| <!-- List the versions of Ansible the collection has been tested with. Must match what is in galaxy.yml. --> | ||
| ### 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. | ||
| <!--end collection content--> | ||
|
|
||
| ## External requirements | ||
| ## Installation and Usage | ||
|
|
||
| <!-- List any external resources the collection depends on, for example minimum versions of an OS, libraries, or utilities. Do not list other Ansible collections here. --> | ||
| ### Requirements | ||
|
|
||
| ### Supported connections | ||
| <!-- Optional. If your collection supports only specific connection types (such as HTTPAPI, netconf, or others), list them here. --> | ||
| 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 | ||
|
|
||
| <!-- Galaxy will eventually list the module docs within the UI, but until that is ready, you may need to either describe your plugins etc here, or point to an external docsite to cover that information. --> | ||
| 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 | ||
| <!--Include some quick examples that cover the most common use cases for your collection content. It can include the following examples of installation and upgrade (change NAMESPACE.COLLECTION_NAME correspondingly):--> | ||
| [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=<SuperSecretToken> | ||
| ``` | ||
| 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. | ||
| <!-- Optional. Include the roadmap for this collection, and the proposed release/versioning strategy so users can anticipate the upgrade/update cycle. --> | ||
| ### 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: | ||
|
|
||
| <!-- List out where the user can find additional information, such as working group meeting times, slack/IRC channels, or documentation for the product this collection automates. At a minimum, link to: --> | ||
| ```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 | ||
| ``` | ||
|
|
||
| <!-- Include the appropriate license information here and a pointer to the full licensing details. If the collection contains modules migrated from the ansible/ansible repo, you must use the same license that existed in the ansible/ansible repo. See the GNU license example below. --> | ||
| ## 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. |