From f5ec71e8cba67d23531bc6784c48eabc8082f620 Mon Sep 17 00:00:00 2001 From: Chris Love Date: Sat, 16 Apr 2016 12:09:28 -0600 Subject: [PATCH] Starting work on developer documentation. --- builtin/providers/vsphere/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 builtin/providers/vsphere/README.md diff --git a/builtin/providers/vsphere/README.md b/builtin/providers/vsphere/README.md new file mode 100644 index 000000000000..c3c121cbe6df --- /dev/null +++ b/builtin/providers/vsphere/README.md @@ -0,0 +1,20 @@ +# Terraform vSphere Provider Dev Docs + +This document is in place for developer documentation. User documentation is located [HERE](https://www.terraform.io/docs/providers/vsphere/) on Terraform's website. + +Thank-you [@tkak](https://github.com/tkak) and [Rakuten, Inc.](https://github.com/rakutentech) for there original contribution of the source base used for this provider! + +## Introductory Documentation + +Both [README.md](../../../README.md) and [BUILDING.md](../../../BUILDING.md) should be read first! + +## Base API Dependency ~ [govmomi](https://github.com/vmware/govmomi) + +This provider utilizes [govmomi](https://github.com/vmware/govmomi) Go Library for communicating to VMware vSphere APIs (ESXi and/or vCenter). +Because of the dependency this provider is compatible with VMware systems that are supported by govmomi. Much thanks to the dev team that maintains govmomi, and +even more thanks to there guidance with the development of this provider. We have had many issues answered by the govomi team! + +#### vSphere CLI ~ [govc](https://github.com/vmware/govmomi/blob/master/govc/README.md) + +One of the great tools that govmomi contains is [govc](https://github.com/vmware/govmomi/blob/master/govc/README.md). It is a command line tool for using the govmomi API. Not only is it a tool to use, but also it's +[source base](https://github.com/vmware/govmomi/blob/master/govc/) is a great resource of examples on how to exercise the API.