From f4d5842b7266963061a8c478b75833f87f37262e Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Wed, 12 Jun 2019 16:33:18 +0200 Subject: [PATCH] generate all header docs --- .../builder/alicloud/ecs/_AlicloudAccessConfig.html.md | 2 ++ website/source/partials/builder/amazon/chroot/_Config.html.md | 3 +++ .../source/partials/builder/amazon/common/_AMIConfig.html.md | 2 ++ .../partials/builder/amazon/common/_AccessConfig.html.md | 2 ++ .../partials/builder/amazon/common/_BlockDevice.html.md | 2 ++ .../source/partials/builder/amazon/common/_RunConfig.html.md | 3 +++ .../source/partials/builder/amazon/instance/_Config.html.md | 3 +++ .../source/partials/builder/azure/arm/_ClientConfig.html.md | 2 ++ website/source/partials/builder/cloudstack/_Config.html.md | 2 ++ website/source/partials/builder/googlecompute/_Config.html.md | 4 ++++ website/source/partials/builder/hyperv/iso/_Builder.html.md | 3 +++ website/source/partials/builder/hyperv/vmcx/_Builder.html.md | 3 +++ website/source/partials/builder/ncloud/_Config.html.md | 2 ++ .../source/partials/builder/openstack/_AccessConfig.html.md | 2 ++ .../source/partials/builder/openstack/_ImageConfig.html.md | 2 ++ website/source/partials/builder/openstack/_RunConfig.html.md | 3 +++ .../partials/builder/parallels/common/_OutputConfig.html.md | 2 ++ .../partials/builder/parallels/common/_PrlctlConfig.html.md | 3 +++ .../builder/parallels/common/_PrlctlPostConfig.html.md | 3 +++ .../builder/parallels/common/_PrlctlVersionConfig.html.md | 2 ++ .../partials/builder/parallels/common/_ShutdownConfig.html.md | 2 ++ .../partials/builder/parallels/common/_ToolsConfig.html.md | 2 ++ website/source/partials/builder/parallels/pvm/_Config.html.md | 2 ++ website/source/partials/builder/triton/_AccessConfig.html.md | 2 ++ .../partials/builder/triton/_SourceMachineConfig.html.md | 3 +++ .../source/partials/builder/triton/_TargetImageConfig.html.md | 3 +++ website/source/partials/builder/vagrant/_Builder.html.md | 3 +++ .../source/partials/builder/virtualbox/ovf/_Config.html.md | 2 ++ .../partials/builder/vmware/common/_ParallelUnion.html.md | 2 ++ .../partials/builder/vmware/common/_SerialConfigPipe.html.md | 2 ++ website/source/partials/builder/vmware/vmx/_Config.html.md | 2 ++ website/source/partials/helper/communicator/_Config.html.md | 3 +++ 32 files changed, 78 insertions(+) create mode 100644 website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig.html.md create mode 100644 website/source/partials/builder/amazon/chroot/_Config.html.md create mode 100644 website/source/partials/builder/amazon/common/_AMIConfig.html.md create mode 100644 website/source/partials/builder/amazon/common/_AccessConfig.html.md create mode 100644 website/source/partials/builder/amazon/common/_BlockDevice.html.md create mode 100644 website/source/partials/builder/amazon/common/_RunConfig.html.md create mode 100644 website/source/partials/builder/amazon/instance/_Config.html.md create mode 100644 website/source/partials/builder/azure/arm/_ClientConfig.html.md create mode 100644 website/source/partials/builder/cloudstack/_Config.html.md create mode 100644 website/source/partials/builder/googlecompute/_Config.html.md create mode 100644 website/source/partials/builder/hyperv/iso/_Builder.html.md create mode 100644 website/source/partials/builder/hyperv/vmcx/_Builder.html.md create mode 100644 website/source/partials/builder/ncloud/_Config.html.md create mode 100644 website/source/partials/builder/openstack/_AccessConfig.html.md create mode 100644 website/source/partials/builder/openstack/_ImageConfig.html.md create mode 100644 website/source/partials/builder/openstack/_RunConfig.html.md create mode 100644 website/source/partials/builder/parallels/common/_OutputConfig.html.md create mode 100644 website/source/partials/builder/parallels/common/_PrlctlConfig.html.md create mode 100644 website/source/partials/builder/parallels/common/_PrlctlPostConfig.html.md create mode 100644 website/source/partials/builder/parallels/common/_PrlctlVersionConfig.html.md create mode 100644 website/source/partials/builder/parallels/common/_ShutdownConfig.html.md create mode 100644 website/source/partials/builder/parallels/common/_ToolsConfig.html.md create mode 100644 website/source/partials/builder/parallels/pvm/_Config.html.md create mode 100644 website/source/partials/builder/triton/_AccessConfig.html.md create mode 100644 website/source/partials/builder/triton/_SourceMachineConfig.html.md create mode 100644 website/source/partials/builder/triton/_TargetImageConfig.html.md create mode 100644 website/source/partials/builder/vagrant/_Builder.html.md create mode 100644 website/source/partials/builder/virtualbox/ovf/_Config.html.md create mode 100644 website/source/partials/builder/vmware/common/_ParallelUnion.html.md create mode 100644 website/source/partials/builder/vmware/common/_SerialConfigPipe.html.md create mode 100644 website/source/partials/builder/vmware/vmx/_Config.html.md create mode 100644 website/source/partials/helper/communicator/_Config.html.md diff --git a/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig.html.md b/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig.html.md new file mode 100644 index 000000000..5898c5f0e --- /dev/null +++ b/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig.html.md @@ -0,0 +1,2 @@ + +Config of alicloud diff --git a/website/source/partials/builder/amazon/chroot/_Config.html.md b/website/source/partials/builder/amazon/chroot/_Config.html.md new file mode 100644 index 000000000..7831c185a --- /dev/null +++ b/website/source/partials/builder/amazon/chroot/_Config.html.md @@ -0,0 +1,3 @@ + +Config is the configuration that is chained through the steps and +settable from the template. diff --git a/website/source/partials/builder/amazon/common/_AMIConfig.html.md b/website/source/partials/builder/amazon/common/_AMIConfig.html.md new file mode 100644 index 000000000..55af4c4cf --- /dev/null +++ b/website/source/partials/builder/amazon/common/_AMIConfig.html.md @@ -0,0 +1,2 @@ + +AMIConfig is for common configuration related to creating AMIs. diff --git a/website/source/partials/builder/amazon/common/_AccessConfig.html.md b/website/source/partials/builder/amazon/common/_AccessConfig.html.md new file mode 100644 index 000000000..092224e9c --- /dev/null +++ b/website/source/partials/builder/amazon/common/_AccessConfig.html.md @@ -0,0 +1,2 @@ + +AccessConfig is for common configuration related to AWS access diff --git a/website/source/partials/builder/amazon/common/_BlockDevice.html.md b/website/source/partials/builder/amazon/common/_BlockDevice.html.md new file mode 100644 index 000000000..3d831aa0d --- /dev/null +++ b/website/source/partials/builder/amazon/common/_BlockDevice.html.md @@ -0,0 +1,2 @@ + +BlockDevice diff --git a/website/source/partials/builder/amazon/common/_RunConfig.html.md b/website/source/partials/builder/amazon/common/_RunConfig.html.md new file mode 100644 index 000000000..c67a8fb25 --- /dev/null +++ b/website/source/partials/builder/amazon/common/_RunConfig.html.md @@ -0,0 +1,3 @@ + +RunConfig contains configuration for running an instance from a source +AMI and details on how to access that launched image. diff --git a/website/source/partials/builder/amazon/instance/_Config.html.md b/website/source/partials/builder/amazon/instance/_Config.html.md new file mode 100644 index 000000000..dd749cca0 --- /dev/null +++ b/website/source/partials/builder/amazon/instance/_Config.html.md @@ -0,0 +1,3 @@ + +Config is the configuration that is chained through the steps and +settable from the template. diff --git a/website/source/partials/builder/azure/arm/_ClientConfig.html.md b/website/source/partials/builder/azure/arm/_ClientConfig.html.md new file mode 100644 index 000000000..89ed1f25d --- /dev/null +++ b/website/source/partials/builder/azure/arm/_ClientConfig.html.md @@ -0,0 +1,2 @@ + +ClientConfig allows for various ways to authenticate Azure clients diff --git a/website/source/partials/builder/cloudstack/_Config.html.md b/website/source/partials/builder/cloudstack/_Config.html.md new file mode 100644 index 000000000..0b401cd22 --- /dev/null +++ b/website/source/partials/builder/cloudstack/_Config.html.md @@ -0,0 +1,2 @@ + +Config holds all the details needed to configure the builder. diff --git a/website/source/partials/builder/googlecompute/_Config.html.md b/website/source/partials/builder/googlecompute/_Config.html.md new file mode 100644 index 000000000..63b5232d7 --- /dev/null +++ b/website/source/partials/builder/googlecompute/_Config.html.md @@ -0,0 +1,4 @@ + +Config is the configuration structure for the GCE builder. It stores +both the publicly settable state as well as the privately generated +state of the config object. diff --git a/website/source/partials/builder/hyperv/iso/_Builder.html.md b/website/source/partials/builder/hyperv/iso/_Builder.html.md new file mode 100644 index 000000000..ffb9a0873 --- /dev/null +++ b/website/source/partials/builder/hyperv/iso/_Builder.html.md @@ -0,0 +1,3 @@ + +Builder implements packer.Builder and builds the actual Hyperv +images. diff --git a/website/source/partials/builder/hyperv/vmcx/_Builder.html.md b/website/source/partials/builder/hyperv/vmcx/_Builder.html.md new file mode 100644 index 000000000..5e0c3c265 --- /dev/null +++ b/website/source/partials/builder/hyperv/vmcx/_Builder.html.md @@ -0,0 +1,3 @@ + +Builder implements packer.Builder and builds the actual Hyperv +images. diff --git a/website/source/partials/builder/ncloud/_Config.html.md b/website/source/partials/builder/ncloud/_Config.html.md new file mode 100644 index 000000000..7a02a6c27 --- /dev/null +++ b/website/source/partials/builder/ncloud/_Config.html.md @@ -0,0 +1,2 @@ + +Config is structure to use packer builder plugin for Naver Cloud Platform diff --git a/website/source/partials/builder/openstack/_AccessConfig.html.md b/website/source/partials/builder/openstack/_AccessConfig.html.md new file mode 100644 index 000000000..f92fbd550 --- /dev/null +++ b/website/source/partials/builder/openstack/_AccessConfig.html.md @@ -0,0 +1,2 @@ + +AccessConfig is for common configuration related to openstack access diff --git a/website/source/partials/builder/openstack/_ImageConfig.html.md b/website/source/partials/builder/openstack/_ImageConfig.html.md new file mode 100644 index 000000000..45f731377 --- /dev/null +++ b/website/source/partials/builder/openstack/_ImageConfig.html.md @@ -0,0 +1,2 @@ + +ImageConfig is for common configuration related to creating Images. diff --git a/website/source/partials/builder/openstack/_RunConfig.html.md b/website/source/partials/builder/openstack/_RunConfig.html.md new file mode 100644 index 000000000..a6c9c023a --- /dev/null +++ b/website/source/partials/builder/openstack/_RunConfig.html.md @@ -0,0 +1,3 @@ + +RunConfig contains configuration for running an instance from a source +image and details on how to access that launched image. diff --git a/website/source/partials/builder/parallels/common/_OutputConfig.html.md b/website/source/partials/builder/parallels/common/_OutputConfig.html.md new file mode 100644 index 000000000..8fdd9cb7f --- /dev/null +++ b/website/source/partials/builder/parallels/common/_OutputConfig.html.md @@ -0,0 +1,2 @@ + +OutputConfig contains the configuration for builder's output. diff --git a/website/source/partials/builder/parallels/common/_PrlctlConfig.html.md b/website/source/partials/builder/parallels/common/_PrlctlConfig.html.md new file mode 100644 index 000000000..518286eab --- /dev/null +++ b/website/source/partials/builder/parallels/common/_PrlctlConfig.html.md @@ -0,0 +1,3 @@ + +PrlctlConfig contains the configuration for running "prlctl" commands +before the VM start. diff --git a/website/source/partials/builder/parallels/common/_PrlctlPostConfig.html.md b/website/source/partials/builder/parallels/common/_PrlctlPostConfig.html.md new file mode 100644 index 000000000..35cc46e66 --- /dev/null +++ b/website/source/partials/builder/parallels/common/_PrlctlPostConfig.html.md @@ -0,0 +1,3 @@ + +PrlctlPostConfig contains the configuration for running "prlctl" commands +in the end of artifact build. diff --git a/website/source/partials/builder/parallels/common/_PrlctlVersionConfig.html.md b/website/source/partials/builder/parallels/common/_PrlctlVersionConfig.html.md new file mode 100644 index 000000000..3dfa090c1 --- /dev/null +++ b/website/source/partials/builder/parallels/common/_PrlctlVersionConfig.html.md @@ -0,0 +1,2 @@ + +PrlctlVersionConfig contains the configuration for `prlctl` version. diff --git a/website/source/partials/builder/parallels/common/_ShutdownConfig.html.md b/website/source/partials/builder/parallels/common/_ShutdownConfig.html.md new file mode 100644 index 000000000..4401e453e --- /dev/null +++ b/website/source/partials/builder/parallels/common/_ShutdownConfig.html.md @@ -0,0 +1,2 @@ + +ShutdownConfig contains the configuration for VM shutdown. diff --git a/website/source/partials/builder/parallels/common/_ToolsConfig.html.md b/website/source/partials/builder/parallels/common/_ToolsConfig.html.md new file mode 100644 index 000000000..76c3773ba --- /dev/null +++ b/website/source/partials/builder/parallels/common/_ToolsConfig.html.md @@ -0,0 +1,2 @@ + +ToolsConfig contains the builder configuration related to Parallels Tools. diff --git a/website/source/partials/builder/parallels/pvm/_Config.html.md b/website/source/partials/builder/parallels/pvm/_Config.html.md new file mode 100644 index 000000000..31b4e2f09 --- /dev/null +++ b/website/source/partials/builder/parallels/pvm/_Config.html.md @@ -0,0 +1,2 @@ + +Config is the configuration structure for the builder. diff --git a/website/source/partials/builder/triton/_AccessConfig.html.md b/website/source/partials/builder/triton/_AccessConfig.html.md new file mode 100644 index 000000000..2a1f4f9ce --- /dev/null +++ b/website/source/partials/builder/triton/_AccessConfig.html.md @@ -0,0 +1,2 @@ + +AccessConfig is for common configuration related to Triton access diff --git a/website/source/partials/builder/triton/_SourceMachineConfig.html.md b/website/source/partials/builder/triton/_SourceMachineConfig.html.md new file mode 100644 index 000000000..c74dc9012 --- /dev/null +++ b/website/source/partials/builder/triton/_SourceMachineConfig.html.md @@ -0,0 +1,3 @@ + +SourceMachineConfig represents the configuration to run a machine using +the SDC API in order for provisioning to take place. diff --git a/website/source/partials/builder/triton/_TargetImageConfig.html.md b/website/source/partials/builder/triton/_TargetImageConfig.html.md new file mode 100644 index 000000000..d940ce624 --- /dev/null +++ b/website/source/partials/builder/triton/_TargetImageConfig.html.md @@ -0,0 +1,3 @@ + +TargetImageConfig represents the configuration for the image to be created +from the source machine. diff --git a/website/source/partials/builder/vagrant/_Builder.html.md b/website/source/partials/builder/vagrant/_Builder.html.md new file mode 100644 index 000000000..9db960859 --- /dev/null +++ b/website/source/partials/builder/vagrant/_Builder.html.md @@ -0,0 +1,3 @@ + +Builder implements packer.Builder and builds the actual VirtualBox +images. diff --git a/website/source/partials/builder/virtualbox/ovf/_Config.html.md b/website/source/partials/builder/virtualbox/ovf/_Config.html.md new file mode 100644 index 000000000..55488ff4b --- /dev/null +++ b/website/source/partials/builder/virtualbox/ovf/_Config.html.md @@ -0,0 +1,2 @@ + +Config is the configuration structure for the builder. diff --git a/website/source/partials/builder/vmware/common/_ParallelUnion.html.md b/website/source/partials/builder/vmware/common/_ParallelUnion.html.md new file mode 100644 index 000000000..fc2e092f6 --- /dev/null +++ b/website/source/partials/builder/vmware/common/_ParallelUnion.html.md @@ -0,0 +1,2 @@ + + parallel port diff --git a/website/source/partials/builder/vmware/common/_SerialConfigPipe.html.md b/website/source/partials/builder/vmware/common/_SerialConfigPipe.html.md new file mode 100644 index 000000000..067351033 --- /dev/null +++ b/website/source/partials/builder/vmware/common/_SerialConfigPipe.html.md @@ -0,0 +1,2 @@ + + serial conversions diff --git a/website/source/partials/builder/vmware/vmx/_Config.html.md b/website/source/partials/builder/vmware/vmx/_Config.html.md new file mode 100644 index 000000000..a25ad5386 --- /dev/null +++ b/website/source/partials/builder/vmware/vmx/_Config.html.md @@ -0,0 +1,2 @@ + +Config is the configuration structure for the builder. diff --git a/website/source/partials/helper/communicator/_Config.html.md b/website/source/partials/helper/communicator/_Config.html.md new file mode 100644 index 000000000..2a07eba25 --- /dev/null +++ b/website/source/partials/helper/communicator/_Config.html.md @@ -0,0 +1,3 @@ + +Config is the common configuration that communicators allow within +a builder.