diff --git a/README.md b/README.md index 5678123644..536d673887 100644 --- a/README.md +++ b/README.md @@ -138,46 +138,23 @@ Alternatively, look for the name of the function by PreCheck under the specific Providers: acc.TestAccProviders, ``` -# IBM Cloud Ansible Modules +## Related projects -An implementation of generated Ansible modules using the -[IBM Cloud Terraform Provider]. +### Ansible Collection for IBM Cloud -## Prerequisites +An Ansible Collection package contains many Ansible Modules, +each Ansible Module is a wrapper around resource or data source +elements of the **Terraform Provider for IBM Cloud**. +At each execution of an Ansible Module, on-the-fly Terraform +code is generated and executed for the intended outcome. -1. Install [Python3] - -2. [RedHat Ansible] 2.8+ - - ``` - pip install "ansible>=2.8.0" - ``` - - -## Install - -1. Download IBM Cloud Ansible modules from [release page] - -2. Extract module archive. - - ``` - unzip ibmcloud_ansible_modules.zip - ``` - -3. Add modules and module_utils to the [Ansible search path]. E.g.: - - ``` - cp build/modules/* $HOME/.ansible/plugins/modules/. - cp build/module_utils/* $HOME/.ansible/plugins/module_utils/. - - ``` - -### Example Projects - -1. [VPC Virtual Server Instance](examples/ansible/examples/simple-vm-ssh/) - -2. [Power Virtual Server Instance](examples/ansible/examples/simple-vm-power-vs/) +Compatible with Ansible Core 2.12+, various +[example Ansible Playbooks](https://github.com/IBM-Cloud/ansible-collection-ibm#example-ansible-playbooks) +are provided to show how to use +the Ansible Modules from the Ansible Collection for IBM Cloud. +See more information on the package index entry +[ibm.cloudcollection Ansible Collection - Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/ibm/cloudcollection). [IBM Cloud Terraform Provider]: https://github.com/IBM-Cloud/terraform-provider-ibm [Python3]: https://www.python.org/downloads/