From 6867c4f3e3f81bddc01d9ecbdf3095a4e17bdf30 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Mon, 18 Nov 2013 16:23:28 -0800 Subject: [PATCH] website: vsphere endpoint docs --- post-processor/vsphere/post-processor.go | 2 +- .../post-processors/vsphere.html.markdown | 48 +++++++++++++++++++ website/source/layouts/docs.erb | 1 + 3 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 website/source/docs/post-processors/vsphere.html.markdown diff --git a/post-processor/vsphere/post-processor.go b/post-processor/vsphere/post-processor.go index d6211c040..5508638fd 100644 --- a/post-processor/vsphere/post-processor.go +++ b/post-processor/vsphere/post-processor.go @@ -20,12 +20,12 @@ type Config struct { Datacenter string `mapstructure:"datacenter"` Datastore string `mapstructure:"datastore"` Host string `mapstructure:"host"` - VMNetwork string `mapstructure:"vm_network"` Password string `mapstructure:"password"` PathToResourcePool string `mapstructure:"path_to_resource_pool"` Username string `mapstructure:"username"` VMFolder string `mapstructure:"vm_folder"` VMName string `mapstructure:"vm_name"` + VMNetwork string `mapstructure:"vm_network"` } type PostProcessor struct { diff --git a/website/source/docs/post-processors/vsphere.html.markdown b/website/source/docs/post-processors/vsphere.html.markdown new file mode 100644 index 000000000..08bb157f8 --- /dev/null +++ b/website/source/docs/post-processors/vsphere.html.markdown @@ -0,0 +1,48 @@ +--- +layout: "docs" +page_title: "vSphere Post-Processor" +--- + +# vSphere Post-Processor + +Type: `vsphere-upload` + +The vSphere post-processor takes an artifact from the VMware builder +and uploads it to a vSphere endpoint. + +## Configuration + +There are many configuration options available for the post-processor. They are +segmented below into two categories: required and optional parameters. Within +each category, the available configuration keys are alphabetized. + +Required: + +* `datacenter` (string) - The name of the datacenter within vSphere to + add the VM to. + +* `datastore` (string) - The name of the datastore to store this VM. + +* `host` (string) - The vSphere host that will be contacted to perform + the VM upload. + +* `password` (string) - Password to use to authenticate to the vSphere + endpoint. + +* `path_to_resource_pool` (string) - The path within the resource pool to + store the VM. + +* `username` (string) - The username to use to authenticate to the vSphere + endpoint. + +* `vm_folder` (string) - The folder within the datastore to store the VM. + +* `vm_name` (string) - The name of the VM once it is uploaded. + +* `vm_network` (string) - The name of the VM network this VM will be + added to. + +Optional: + +* `insecure` (bool) - Whether or not the connection to vSphere can be done + over an insecure connection. By default this is false. diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index d340b6edc..88c77d9db 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -54,6 +54,7 @@