diff options
Diffstat (limited to 'vendor/github.com/mitchellh/packer/website/source/docs/builders')
14 files changed, 388 insertions, 34 deletions
diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/alicloud-ecs.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/alicloud-ecs.html.md index 6db22f4f..614b2d3d 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/alicloud-ecs.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/alicloud-ecs.html.md @@ -4,6 +4,7 @@ description: | customized images based on an existing base images. layout: docs page_title: Alicloud Image Builder +sidebar_current: 'docs-builders-alicloud-ecs' --- # Alicloud Image Builder diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-chroot.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-chroot.html.md index 36c0cde1..d1ba50d8 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-chroot.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-chroot.html.md @@ -128,11 +128,10 @@ each category, the available configuration keys are alphabetized. source AMI will be attached. This defaults to "" (empty string), which forces Packer to find an open device automatically. -- `enhanced_networking` (boolean) - Enable enhanced - networking (SriovNetSupport and ENA) on HVM-compatible AMIs. If true, add - `ec2:ModifyInstanceAttribute` to your AWS IAM policy. Note: you must make - sure enhanced networking is enabled on your instance. See [Amazon's - documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking) +- `ena_support` (boolean) - Enable enhanced networking (ENA but not SriovNetSupport) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM policy. + Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. - `force_deregister` (boolean) - Force Packer to first deregister an existing AMI if one with the same name already exists. Default `false`. @@ -270,7 +269,7 @@ each category, the available configuration keys are alphabetized. "source_ami_filter": { "filters": { "virtualization-type": "hvm", - "name": "*ubuntu-xenial-16.04-amd64-server-*", + "name": "ubuntu/images/*ubuntu-xenial-16.04-amd64-server-*", "root-device-type": "ebs" }, "owners": ["099720109477"], @@ -293,6 +292,12 @@ each category, the available configuration keys are alphabetized. - `most_recent` (bool) - Selects the newest created image when true. This is most useful for selecting a daily distro build. +- `sriov_support` (boolean) - Enable enhanced networking (SriovNetSupport but not ENA) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM + policy. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). + Default `false`. + - `tags` (object of key/value strings) - Tags applied to the AMI. This is a [template engine](/docs/templates/engine.html) where the `SourceAMI` variable is replaced with the source AMI ID and diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebs.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebs.html.md index 0bdb3021..f144fbba 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebs.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebs.html.md @@ -165,11 +165,10 @@ builder. Optimized](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html). Default `false`. -- `enhanced_networking` (boolean) - Enable enhanced - networking (SriovNetSupport and ENA) on HVM-compatible AMIs. If true, add - `ec2:ModifyInstanceAttribute` to your AWS IAM policy. Note: you must make - sure enhanced networking is enabled on your instance. See [Amazon's - documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking) +- `ena_support` (boolean) - Enable enhanced networking (ENA but not SriovNetSupport) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM policy. + Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. - `force_deregister` (boolean) - Force Packer to first deregister an existing AMI if one with the same name already exists. Default `false`. @@ -265,7 +264,7 @@ builder. "source_ami_filter": { "filters": { "virtualization-type": "hvm", - "name": "*ubuntu-xenial-16.04-amd64-server-*", + "name": "ubuntu/images/*ubuntu-xenial-16.04-amd64-server-*", "root-device-type": "ebs" }, "owners": ["099720109477"], @@ -302,6 +301,12 @@ builder. best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)` +- `sriov_support` (boolean) - Enable enhanced networking (SriovNetSupport but not ENA) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM + policy. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). + Default `false`. + - `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Amazon EC2. By default, this is blank, and Packer will diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebssurrogate.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebssurrogate.html.md index 071af814..f60f6de1 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebssurrogate.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebssurrogate.html.md @@ -158,11 +158,10 @@ builder. Optimized](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html). Default `false`. -- `enhanced_networking` (boolean) - Enable enhanced - networking (SriovNetSupport and ENA) on HVM-compatible AMIs. If true, add - `ec2:ModifyInstanceAttribute` to your AWS IAM policy. Note: you must make - sure enhanced networking is enabled on your instance. See [Amazon's - documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking) +- `ena_support` (boolean) - Enable enhanced networking (ENA but not SriovNetSupport) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM policy. + Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. - `force_deregister` (boolean) - Force Packer to first deregister an existing AMI if one with the same name already exists. Default `false`. @@ -258,7 +257,7 @@ builder. "source_ami_filter": { "filters": { "virtualization-type": "hvm", - "name": "*ubuntu-xenial-16.04-amd64-server-*", + "name": "ubuntu/images/*ubuntu-xenial-16.04-amd64-server-*", "root-device-type": "ebs" }, "owners": ["099720109477"], @@ -295,6 +294,12 @@ builder. best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)` +- `sriov_support` (boolean) - Enable enhanced networking (SriovNetSupport but not ENA) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM + policy. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). + Default `false`. + - `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Amazon EC2. By default, this is blank, and Packer will diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebsvolume.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebsvolume.html.md index c27c5414..06da8399 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebsvolume.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-ebsvolume.html.md @@ -104,11 +104,10 @@ builder. Optimized](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html). Default `false`. -- `enhanced_networking` (boolean) - Enable enhanced - networking (SriovNetSupport and ENA) on HVM-compatible AMIs. If true, add - `ec2:ModifyInstanceAttribute` to your AWS IAM policy. Note: you must make - sure enhanced networking is enabled on your instance. See [Amazon's - documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking) +- `ena_support` (boolean) - Enable enhanced networking (ENA but not SriovNetSupport) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM policy. + Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. - `iam_instance_profile` (string) - The name of an [IAM instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html) @@ -171,7 +170,7 @@ builder. "source_ami_filter": { "filters": { "virtualization-type": "hvm", - "name": "*ubuntu-xenial-16.04-amd64-server-*", + "name": "ubuntu/images/*ubuntu-xenial-16.04-amd64-server-*", "root-device-type": "ebs" }, "owners": ["099720109477"], @@ -208,6 +207,12 @@ builder. best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)` or `Windows (Amazon VPC)` +- `sriov_support` (boolean) - Enable enhanced networking (SriovNetSupport but not ENA) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM + policy. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). + Default `false`. + - `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. By default, this is blank, and Packer will generate a temporary key pair unless diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-instance.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-instance.html.md index c63e537a..8bbd72b8 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-instance.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/amazon-instance.html.md @@ -189,11 +189,10 @@ builder. Optimized](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html). Default `false`. -- `enhanced_networking` (boolean) - Enable enhanced - networking (SriovNetSupport and ENA) on HVM-compatible AMIs. If true, add - `ec2:ModifyInstanceAttribute` to your AWS IAM policy. Note: you must make - sure enhanced networking is enabled on your instance. See [Amazon's - documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking) +- `ena_support` (boolean) - Enable enhanced networking (ENA but not SriovNetSupport) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM policy. + Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. - `force_deregister` (boolean) - Force Packer to first deregister an existing AMI if one with the same name already exists. Defaults to `false`. @@ -263,7 +262,7 @@ builder. "source_ami_filter": { "filters": { "virtualization-type": "hvm", - "name": "*ubuntu-xenial-16.04-amd64-server-*", + "name": "ubuntu/images/*ubuntu-xenial-16.04-amd64-server-*", "root-device-type": "ebs" }, "owners": ["099720109477"], @@ -303,6 +302,12 @@ builder. best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)` +- `sriov_support` (boolean) - Enable enhanced networking (SriovNetSupport but not ENA) + on HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM + policy. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's + documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). + Default `false`. + - `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Amazon EC2. By default, this is blank, and Packer will diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/azure.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/azure.html.md index ec391631..abda2a5f 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/azure.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/azure.html.md @@ -50,7 +50,10 @@ builder. #### VHD or Managed Image -The Azure builder can create either a VHD, or a managed image. When creating a VHD the following two options are required. +The Azure builder can create either a VHD, or a managed image. If you +are creating a VHD, you **must** start with a VHD. Likewise, if you +want to create a managed image you **must** start with a managed +image. When creating a VHD the following two options are required. - `capture_container_name` (string) Destination container name. Essentially the "directory" where your VHD will be organized in Azure. The captured VHD's URL will be https://<storage_account>.blob.core.windows.net/system/Microsoft.Compute/Images/<capture_container_name>/<capture_name_prefix>.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.vhd. @@ -107,6 +110,10 @@ When creating a managed image the following two options are required. - `image_url` (string) Specify a custom VHD to use. If this value is set, do not set image\_publisher, image\_offer, image\_sku, or image\_version. + +- `managed_image_storage_account_type` (string) Specify the storage + account type for a managed image. Valid values are Standard_LRS + and Premium\_LRS. The default is Standard\_LRS. - `object_id` (string) Specify an OAuth Object ID to protect WinRM certificates created at runtime. This variable is required when creating images based on @@ -131,9 +138,12 @@ When creating a managed image the following two options are required. - `tenant_id` (string) The account identifier with which your `client_id` and `subscription_id` are associated. If not specified, `tenant_id` will be looked up using `subscription_id`. +- `private_virtual_network_with_public_ip` (boolean) This value allows you to set a `virtual_network_name` and obtain + a public IP. If this value is not set and `virtual_network_name` is defined Packer is only allowed to be executed + from a host on the same subnet / virtual network. + - `virtual_network_name` (string) Use a pre-existing virtual network for the VM. This option enables private - communication with the VM, no public IP address is **used** or **provisioned**. This value should only be set if - Packer is executed from a host on the same subnet / virtual network. + communication with the VM, no public IP address is **used** or **provisioned** (unless you set `private_virtual_network_with_public_ip`). - `virtual_network_resource_group_name` (string) If virtual\_network\_name is set, this value **may** also be set. If virtual\_network\_name is set, and this value is not set the builder attempts to determine the resource group diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/cloudstack.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/cloudstack.html.md index 9b6bc2ca..7e59fe71 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/cloudstack.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/cloudstack.html.md @@ -74,6 +74,11 @@ builder. connect to the instance. Defaults to `[ "0.0.0.0/0" ]`. Only required when `use_local_ip_address` is `false`. +- `create_security_group` (boolean) - If `true` a temporary security group + will be created which allows traffic towards the instance from the + `cidr_list`. This option will be ignored if `security_groups` is also + defined. Requires `expunge` set to `true`. Defaults to `false`. + - `disk_offering` (string) - The name or ID of the disk offering used for the instance. This option is only available (and also required) when using `source_iso`. @@ -118,6 +123,9 @@ builder. connecting any provisioners to. If not provided, a temporary public IP address will be associated and released during the Packer run. +- `security_groups` (array of strings) - A list of security group IDs or names + to associate the instance with. + - `ssh_agent_auth` (boolean) - If true, the local SSH agent will be used to authenticate connections to the source instance. No temporary keypair will be created, and the values of `ssh_password` and `ssh_private_key_file` will @@ -149,6 +157,10 @@ builder. - `template_scalable` (boolean) - Set to `true` to indicate that the template contains tools to support dynamic scaling of VM cpu/memory. Defaults to `false`. +- `temporary_keypair_name` (string) - The name of the temporary SSH key pair + to generate. By default, Packer generates a name that looks like + `packer_<UUID>`, where <UUID> is a 36 character unique identifier. + - `user_data` (string) - User data to launch with the instance. This is a [template engine](/docs/templates/engine.html) see _User Data_ bellow for more details. diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/docker.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/docker.html.md index c8276540..7fab6d09 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/docker.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/docker.html.md @@ -204,6 +204,10 @@ You must specify (only) one of `commit`, `discard`, or `export_path`. mount into this container. The key of the object is the host path, the value is the container path. +- `container_dir` (string) - The directory inside container to mount + temp directory from host server for work [file provisioner](/docs/provisioners/file.html). + By default this is set to `/packer-files`. + ## Using the Artifact: Export Once the tar artifact has been generated, you will likely want to import, tag, diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/googlecompute.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/googlecompute.html.md index cce0e41c..dda8841d 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/googlecompute.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/googlecompute.html.md @@ -174,6 +174,12 @@ builder. Not required if you run Packer on a GCE instance with a service account. Instructions for creating file or using service accounts are above. +- `accelerator_count` (int) - Number of guest accelerator cards to add to the launched instance. + +- `accelerator_type` (string) - Full or partial URL of the guest accelerator type. GPU accelerators can only be used with + `"on_host_maintenance": "TERMINATE"` option set. + Example: `"projects/project_id/zones/europe-west1-b/acceleratorTypes/nvidia-tesla-k80"` + - `address` (string) - The name of a pre-allocated static external IP address. Note, must be the name and not the actual IP address. @@ -198,6 +204,9 @@ builder. - `instance_name` (string) - A name to give the launched instance. Beware that this must be unique. Defaults to `"packer-{{uuid}}"`. +- `labels` (object of key/value strings) - Key/value pair labels to apply to + the launched instance. + - `machine_type` (string) - The machine type. Defaults to `"n1-standard-1"`. - `metadata` (object of key/value strings) - Metadata applied to the launched diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/lxc.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/lxc.html.md new file mode 100644 index 00000000..0dc207a9 --- /dev/null +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/lxc.html.md @@ -0,0 +1,97 @@ +--- +description: | + The `lxc` Packer builder builds containers for lxc1. The builder starts an LXC + container, runs provisioners within this container, then exports the container + as a tar.gz of the root file system. +layout: docs +page_title: LXC Builder +... + +# LXC Builder + +Type: `lxc` + +The `lxc` Packer builder builds containers for lxc1. The builder starts an LXC +container, runs provisioners within this container, then exports the container +as a tar.gz of the root file system. + +The LXC builder requires a modern linux kernel and the `lxc` or `lxc1` package. +This builder does not work with LXD. + +Note to build Centos images on a Debian family host, you will need the `yum` package installed. + +Some provisioners such as `ansible-local` get confused when running in a container of a different family. +E.G. it will attempt to use `apt-get` to install packages, when running in a Centos container if the parent OS is Debian based. + +## Basic Example + +Below is a fully functioning example. + +``` {.javascript} +{ + "builders": [ + { + "type": "lxc", + "name": "lxc-trusty", + "config_file": "/tmp/lxc/config", + "template_name": "ubuntu", + "template_environment_vars": [ + "SUITE=trusty" + ] + }, + { + "type": "lxc", + "name": "lxc-xenial", + "config_file": "/tmp/lxc/config", + "template_name": "ubuntu", + "template_environment_vars": [ + "SUITE=xenial" + ] + }, + { + "type": "lxc", + "name": "lxc-jessie", + "config_file": "/tmp/lxc/config", + "template_name": "debian", + "template_environment_vars": [ + "SUITE=jessie" + ] + }, + { + "type": "lxc", + "name": "lxc-centos-7-x64", + "config_file": "/tmp/lxc/config", + "template_name": "centos", + "template_parameters": [ + "-R","7", + "-a","x86_64" + ] + } + ] +} +``` + +## Configuration Reference + +### Required: + +- `config_file` (string) - The path to the lxc configuration file. + +- `template_name` (string) - The LXC template name to use. + +- `template_environment_vars` (array of strings) - Environmental variables to use to build the template with. + +### Optional: + +- `target_runlevel` (int) - The minimum run level to wait for the container to reach. Note some distributions (Ubuntu) simulate run levels and may report 5 rather than 3. + +- `output_directory` (string) - The directory in which to save the exported tar.gz. Defaults to `output-<BuildName>` in the current directory. + +- `container_name` (string) - The name of the LXC container. Usually stored in `/var/lib/lxc/containers/<container_name>`. Defaults to `packer-<BuildName>`. + +- `command_wrapper` (string) - Allows you to specify a wrapper command, such as `ssh` so you can execute packer builds on a remote host. Defaults to Empty. + +- `init_timeout` (string) - The timeout in seconds to wait for the the container to start. Defaults to 20 seconds. + +- `template_parameters` (array of strings) - Options to pass to the given `lxc-template` command, usually located in `/usr/share/lxc/templates/lxc-<template_name>``. Note: This gets passed as ARGV to the template command. Ensure you have an array of strings, as a single string with spaces probably won't work. Defaults to `[]`. + diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/lxd.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/lxd.html.md new file mode 100644 index 00000000..dd386b1b --- /dev/null +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/lxd.html.md @@ -0,0 +1,52 @@ +--- +description: | + The `lxd` Packer builder builds containers for LXD. The builder starts an LXD + container, runs provisioners within this container, then saves the container + as an LXD image. +layout: docs +page_title: LXD Builder +... + +# LXD Builder + +Type: `lxd` + +The `lxd` Packer builder builds containers for LXD. The builder starts an LXD +container, runs provisioners within this container, then saves the container +as an LXD image. + +The LXD builder requires a modern linux kernel and the `lxd` package. +This builder does not work with LXC. + +## Basic Example + +Below is a fully functioning example. + +``` {.javascript} +{ + "builders": [ + { + "type": "lxd", + "name": "lxd-xenial", + "image": "ubuntu-daily:xenial", + "output_image": "ubuntu-xenial" + } + ] +} +``` + +## Configuration Reference + +### Required: + +- `image` (string) - The source image to use when creating the build container. This can be a (local or remote) image (name or fingerprint). E.G. my-base-image, ubuntu-daily:x, 08fababf6f27... + Note: The builder may appear to pause if required to download a remote image, as they are usually 100-200MB. `/var/log/lxd/lxd.log` will mention starting such downloads. + +### Optional: + +- `name` (string) - The name of the started container. Defaults to `packer-$PACKER_BUILD_NAME`. + +- `output_image` (string) - The name of the output artifact. Defaults to `name`. + +- `command_wrapper` (string) - lets you prefix all builder commands, such as with `ssh` for a remote build host. Defaults to `""`. + diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/oracle-oci.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/oracle-oci.html.md new file mode 100644 index 00000000..3503d4fc --- /dev/null +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/oracle-oci.html.md @@ -0,0 +1,143 @@ +--- +description: + The oracle-oci builder is able to create new custom images for use with Oracle + Cloud Infrastructure (OCI). +layout: docs +page_title: 'Oracle OCI - Builders' +sidebar_current: 'docs-builders-oracle-oci' +--- + +# Oracle Cloud Infrastructure (OCI) Builder + +Type: `oracle-oci` + +The `oracle-oci` Packer builder is able to create new custom images for use +with [Oracle Cloud Infrastructure](https://cloud.oracle.com) (OCI). The builder +takes a base image, runs any provisioning necessary on the base image after +launching it, and finally snapshots it creating a reusable custom image. + +It is recommended that you familiarise yourself with the +[Key Concepts and Terminology](https://docs.us-phoenix-1.oraclecloud.com/Content/GSG/Concepts/concepts.htm) +prior to using this builder if you have not done so already. + +The builder _does not_ manage images. Once it creates an image, it is up to you +to use it or delete it. + +## Authorization + +The Oracle OCI API requires that requests be signed with the RSA public key +associated with your [IAM](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm) +user account. For a comprehensive example of how to configure the required +authentication see the documentation on +[Required Keys and OCIDs](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) +([Oracle Cloud IDs](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm)). + +## Configuration Reference + +There are many configuration options available for the `oracle-oci` builder. +In addition to the options listed here, a +[communicator](/docs/templates/communicator.html) can be configured for this +builder. + +### Required + + - `availability_domain` (string) - The name of the + [Availability Domain](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) + within which a new instance is launched and provisioned. + The names of the Availability Domains have a prefix that is specific to + your [tenancy](https://docs.us-phoenix-1.oraclecloud.com/Content/GSG/Concepts/concepts.htm#two). + + To get a list of the Availability Domains, use the + [ListAvailabilityDomains](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/identity/latest/AvailabilityDomain/ListAvailabilityDomains) + operation, which is available in the IAM Service API. + + - `base_image_ocid` (string) - The OCID of the [base image](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/images.htm) + to use. This is the unique identifier of the image that will be used to + launch a new instance and provision it. + + To get a list of the accepted image OCIDs, use the + [ListImages](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/latest/Image/ListImages) + operation available in the Core Services API. + + - `compartment_ocid` (string) - The OCID of the + [compartment](https://docs.us-phoenix-1.oraclecloud.com/Content/GSG/Tasks/choosingcompartments.htm) + + - `fingerprint` (string) - Fingerprint for the OCI API signing key. + Overrides value provided by the + [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) + if present. + + - `shape` (string) - The template that determines the number of + CPUs, amount of memory, and other resources allocated to a newly created + instance. + + To get a list of the available shapes, use the + [ListShapes](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/Shape/ListShapes) + operation available in the Core Services API. + + - `subnet_ocid` (string) - The name of the subnet within which a new instance + is launched and provisioned. + + To get a list of your subnets, use the + [ListSubnets](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/latest/Subnet/ListSubnets) + operation available in the Core Services API. + + Note: the subnet must be configured to allow access via your chosen + [communicator](/docs/templates/communicator.html) (communicator defaults to + [SSH tcp/22](/docs/templates/communicator.html#ssh_port)). + + +### Optional + + - `access_cfg_file` (string) - The path to the + [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm). + Defaults to `$HOME/.oci/config`. + + - `access_cfg_file_account` (string) - The specific account in the + [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) + to use. Defaults to `DEFAULT`. + + - `image_name` (string) - The name to assign to the resulting custom image. + + - `key_file` (string) - Full path and filename of the OCI API signing key. + Overrides value provided by the + [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) + if present. + + - `pass_phrase` (string) - Pass phrase used to decrypt the OCI API signing + key. Overrides value provided by the + [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) + if present. + + - `region` (string) - An Oracle Cloud Infrastructure region. Overrides + value provided by the + [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) + if present. + + - `tenancy_ocid` (string) - The OCID of your tenancy. Overrides value provided + by the + [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) + if present. + + - `user_ocid` (string) - The OCID of the user calling the OCI API. Overrides + value provided by the [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) + if present. + + +## Basic Example + +Here is a basic example. Note that account specific configuration has been +substituted with the letter `a` and OCIDS have been shortened for brevity. + +``` {.json} +{ + "availability_domain": "aaaa:PHX-AD-1", + "base_image_ocid": "ocid1.image.oc1.phx.aaaaaaaa5yu6pw3riqtuhxzov7fdngi4tsteganmao54nq3pyxu3hxcuzmoa", + "compartment_ocid": "ocid1.compartment.oc1..aaa", + "image_name": "ExampleImage", + "shape": "VM.Standard1.1", + "ssh_username": "opc", + "subnet_ocid": "ocid1.subnet.oc1..aaa", + "type": "oracle-oci" +} +``` diff --git a/vendor/github.com/mitchellh/packer/website/source/docs/builders/vmware-iso.html.md b/vendor/github.com/mitchellh/packer/website/source/docs/builders/vmware-iso.html.md index 478c1a0b..4d00965b 100644 --- a/vendor/github.com/mitchellh/packer/website/source/docs/builders/vmware-iso.html.md +++ b/vendor/github.com/mitchellh/packer/website/source/docs/builders/vmware-iso.html.md @@ -478,7 +478,8 @@ modify as well: - `format` (string) - Either "ovf", "ova" or "vmx", this specifies the output format of the exported virtual machine. This defaults to "ovf". - Before using this option, you need to install `ovftool`. + Before using this option, you need to install `ovftool`. This option + works currently only with option remote_type set to "esx5". ### VNC port discovery |