Skip to content
This repository has been archived by the owner on Mar 6, 2024. It is now read-only.

Commit

Permalink
Update project README to add project usage
Browse files Browse the repository at this point in the history
Signed-off-by: mukultaneja <[email protected]>
  • Loading branch information
mukultaneja committed Jan 6, 2021
1 parent e0e6269 commit 9364081
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 |
Expand Down

0 comments on commit 9364081

Please sign in to comment.