From 9364081e24b5e7f07bc0d92fc332e2ef084ae039 Mon Sep 17 00:00:00 2001 From: mukultaneja Date: Thu, 7 Jan 2021 02:26:29 +0530 Subject: [PATCH] Update project README to add project usage Signed-off-by: mukultaneja --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6f6c65f..c72c5a6 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,22 @@ 1. pip install --user pyvcloud 2. git clone https://github.com/vmware/ansible-module-vcloud-director 3. cd ansible-module-vcloud-director +4. ansible-playbook -i main.yml + +### Usage + +This reposiroty packaged below two components to manage VCD, + +1. Ansible Modules +2. Ansbile Playbooks + + +Ansible playbooks are the client which use modules as a gateway to interact with VCD. We have written various ansible playbooks to show how to interact with VCD. We are using [ansible roles](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html) +to define playbooks in modular fashion for each module. Please refer [roles](https://github.com/vmware/ansible-module-vcloud-director/tree/master/roles) and [main.yml](https://github.com/vmware/ansible-module-vcloud-director/blob/master/main.yml) to see usage. ## Documentation -Refer [docs](https://github.com/vmware/ansible-module-vcloud-director/wiki/vCD-Ansible-Modules) to know more about available modules's usage. +Refer [docs](https://github.com/vmware/ansible-module-vcloud-director/wiki/vCD-Ansible-Modules) to know more about available modules and their usage. 1. vcd_catalog 2. vcd_catalog_item @@ -40,15 +52,12 @@ Refer [docs](https://github.com/vmware/ansible-module-vcloud-director/wiki/vCD-A 16. vcd_vdc_network 17. vcd_gateway_services -We have also written sample ansible playbooks to show usage of these ansible modules and their interaction with vCD instance. We are using [ansible role](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html) -concept to define playbooks in modular fashion for these modules. Please refer [roles](https://github.com/vmware/ansible-module-vcloud-director/tree/master/roles) and [main.yml](https://github.com/vmware/ansible-module-vcloud-director/blob/master/main.yml) to see usage. - ## Releases & Major Branches Following is the approx version matrix which are tested and supported through vCD ansible modules, | vCD Version | API Versions | -| ------------- | :-------------: | +| ------------- | ------------- | | vCD 9.0 | 29.0 | | vCD 9.1 | 30.0 | | vCD 9.5 | 31.0 |