Merge pull request #6929 from rickard-von-essen/doc-clean
docs: cleanup whitspaces etc
This commit is contained in:
commit
2b564eb563
|
@ -60,7 +60,7 @@ builder.
|
|||
for you, and you need to make sure the instance will be stopped in the final provisioner command. Otherwise,
|
||||
Packer will timeout while waiting the instance to be stopped. This option is provided for some specific
|
||||
scenarios that you want to stop the instance by yourself. E.g., Sysprep a windows which may shutdown the instance
|
||||
within its command. The default value is `false`.
|
||||
within its command. The default value is `false`.
|
||||
|
||||
- `image_copy_names` (array of string) - The name of the destination image, \[2,
|
||||
128\] English or Chinese characters. It must begin with an uppercase/lowercase
|
||||
|
@ -198,7 +198,7 @@ builder.
|
|||
|
||||
- `ssh_private_ip` (boolean) - If this value is true, packer will connect to the ECS created through private ip
|
||||
instead of allocating a public ip or an EIP. The default value is false.
|
||||
|
||||
|
||||
- `tags` (object of key/value strings) - Tags applied to the destination image.
|
||||
|
||||
## Basic Example
|
||||
|
|
|
@ -217,10 +217,10 @@ builder.
|
|||
AMI with an encrypted boot volume (discarding the initial unencrypted AMI in the
|
||||
process). Packer will always run this operation, even if the base
|
||||
AMI has an encrypted boot volume to start with. Default `false`.
|
||||
|
||||
|
||||
- `force_delete_snapshot` (boolean) - Force Packer to delete snapshots associated with
|
||||
AMIs, which have been deregistered by `force_deregister`. Default `false`.
|
||||
|
||||
|
||||
- `force_deregister` (boolean) - Force Packer to first deregister an existing
|
||||
AMI if one with the same name already exists. Default `false`.
|
||||
|
||||
|
@ -460,11 +460,11 @@ builder.
|
|||
relevant snapshots. This is a
|
||||
[template engine](../templates/engine.html),
|
||||
see [Build template data](#build-template-data) for more information.
|
||||
|
||||
|
||||
- `temporary_key_pair_name` (string) - The name of the temporary key pair
|
||||
to generate. By default, Packer generates a name that looks like
|
||||
`packer_<UUID>`, where <UUID> is a 36 character unique identifier.
|
||||
|
||||
|
||||
- `temporary_security_group_source_cidr` (string) - An IPv4 CIDR block to be authorized
|
||||
access to the instance, when packer is creating a temporary security group.
|
||||
The default is `0.0.0.0/0` (i.e., allow any IPv4 source). This is only used
|
||||
|
|
|
@ -39,7 +39,7 @@ builder.
|
|||
can also be specified via environment variable `HCLOUD_TOKEN`,
|
||||
if set.
|
||||
|
||||
- `image` (string) - ID or name of image to launch server from.
|
||||
- `image` (string) - ID or name of image to launch server from.
|
||||
|
||||
- `location` (string) - The name of the location to launch the server in.
|
||||
|
||||
|
|
|
@ -71,6 +71,6 @@ Below is a fully functioning example.
|
|||
set the description, but can be used to set anything needed.
|
||||
See https://stgraber.org/2016/03/30/lxd-2-0-image-management-512/
|
||||
for more properties.
|
||||
|
||||
|
||||
- `launch_config` (map[string]string) - List of key/value pairs you wish to
|
||||
pass to `lxc launch` via `--config`. Defaults to empty.
|
||||
|
|
|
@ -63,14 +63,14 @@ This builder currently only works with the SSH communicator.
|
|||
|
||||
### Optional
|
||||
|
||||
- `attributes` (string) - (string) - Attributes to apply when launching the
|
||||
instance. Note that you need to be careful about escaping characters due to
|
||||
the templates being JSON. It is often more convenient to use
|
||||
`attributes_file`, instead. You may only define either `attributes` or
|
||||
- `attributes` (string) - (string) - Attributes to apply when launching the
|
||||
instance. Note that you need to be careful about escaping characters due to
|
||||
the templates being JSON. It is often more convenient to use
|
||||
`attributes_file`, instead. You may only define either `attributes` or
|
||||
`attributes_file`, not both.
|
||||
|
||||
- `attributes_file` (string) - Path to a json file that will be used for the
|
||||
attributes when launching the instance. You may only define either
|
||||
- `attributes_file` (string) - Path to a json file that will be used for the
|
||||
attributes when launching the instance. You may only define either
|
||||
`attributes` or `attributes_file`, not both.
|
||||
|
||||
- `image_description` (string) - a description for your destination
|
||||
|
@ -128,10 +128,10 @@ obfuscated; you will need to add a working `username`, `password`,
|
|||
Attributes file is optional for connecting via ssh, but required for winrm.
|
||||
|
||||
The following file contains the bare minimum necessary to get winRM working;
|
||||
you have to give it the password to give to the "Administrator" user, which
|
||||
you have to give it the password to give to the "Administrator" user, which
|
||||
will be the one winrm connects to. You must also whitelist your computer
|
||||
to connect via winRM -- the empty braces below whitelist any computer to access
|
||||
winRM but you can make it more secure by only allowing your build machine
|
||||
winRM but you can make it more secure by only allowing your build machine
|
||||
access. See the [docs](https://docs.oracle.com/en/cloud/iaas/compute-iaas-cloud/stcsg/automating-instance-initialization-using-opc-init.html#GUID-A0A107D6-3B38-47F4-8FC8-96D50D99379B)
|
||||
for more details on how to define a trusted host.
|
||||
|
||||
|
|
|
@ -35,7 +35,6 @@ In addition to the options listed here, a
|
|||
builder.
|
||||
|
||||
### Required:
|
||||
|
||||
|
||||
- `api_access_key` (string) - The organization access key to use to identify your
|
||||
organization. It can also be specified via environment variable
|
||||
|
|
|
@ -77,6 +77,7 @@ builder.
|
|||
assigned. Maximum 512 characters but should in practice be much shorter
|
||||
(think between 5 and 20 characters). For example `postgresql-95-server` for
|
||||
an image used as a PostgreSQL 9.5 server.
|
||||
|
||||
- `image_version` (string) - The version string for this image. Maximum 128
|
||||
characters. Any string will do but a format of `Major.Minor.Patch` is
|
||||
strongly advised by Joyent. See [Semantic Versioning](http://semver.org/)
|
||||
|
@ -93,13 +94,13 @@ builder.
|
|||
of `triton_key_id` is stored. For example `/home/soandso/.ssh/id_rsa`. If
|
||||
this is not specified, the SSH agent is used to sign requests with the
|
||||
`triton_key_id` specified.
|
||||
|
||||
|
||||
- `triton_user` (string) - The username of a user who has access to your Triton
|
||||
account.
|
||||
|
||||
- `insecure_skip_tls_verify` - (bool) This allows skipping TLS verification of
|
||||
the Triton endpoint. It is useful when connecting to a temporary Triton
|
||||
installation such as Cloud-On-A-Laptop which does not generally use a
|
||||
account.
|
||||
|
||||
- `insecure_skip_tls_verify` - (bool) This allows skipping TLS verification of
|
||||
the Triton endpoint. It is useful when connecting to a temporary Triton
|
||||
installation such as Cloud-On-A-Laptop which does not generally use a
|
||||
certificate signed by a trusted root CA. The default is `false`.
|
||||
|
||||
- `source_machine_firewall_enabled` (boolean) - Whether or not the firewall of
|
||||
|
@ -109,6 +110,7 @@ builder.
|
|||
firewall rules. Unless you have a global rule defined in Triton which allows
|
||||
SSH traffic enabling the firewall will interfere with the SSH provisioner.
|
||||
The default is `false`.
|
||||
|
||||
- `source_machine_metadata` (object of key/value strings) - Triton metadata
|
||||
applied to the VM used to create the image. Metadata can be used to pass
|
||||
configuration information to the VM without the need for networking. See
|
||||
|
@ -117,30 +119,37 @@ builder.
|
|||
Joyent documentation for more information. This can for example be used to
|
||||
set the `user-script` metadata key to have Triton start a user supplied
|
||||
script after the VM has booted.
|
||||
|
||||
- `source_machine_name` (string) - Name of the VM used for building the image.
|
||||
Does not affect (and does not have to be the same) as the name for a VM
|
||||
instance running this image. Maximum 512 characters but should in practice
|
||||
be much shorter (think between 5 and 20 characters). For example
|
||||
`mysql-64-server-image-builder`. When omitted defaults to
|
||||
`packer-builder-[image_name]`.
|
||||
|
||||
- `source_machine_networks` (array of strings) - The UUID's of Triton networks
|
||||
added to the source machine used for creating the image. For example if any
|
||||
of the provisioners which are run need Internet access you will need to add
|
||||
the UUID's of the appropriate networks here. If this is not specified,
|
||||
instances will be placed into the default Triton public and internal
|
||||
networks.
|
||||
|
||||
- `source_machine_tags` (object of key/value strings) - Tags applied to the VM
|
||||
used to create the image.
|
||||
|
||||
- `image_acls` (array of strings) - The UUID's of the users which will have
|
||||
access to this image. When omitted only the owner (the Triton user whose
|
||||
credentials are used) will have access to the image.
|
||||
|
||||
- `image_description` (string) - Description of the image. Maximum 512
|
||||
characters.
|
||||
|
||||
- `image_eula_url` (string) - URL of the End User License Agreement (EULA) for
|
||||
the image. Maximum 128 characters.
|
||||
|
||||
- `image_homepage` (string) - URL of the homepage where users can find
|
||||
information about the image. Maximum 128 characters.
|
||||
|
||||
- `image_tags` (object of key/value strings) - Tag applied to the image.
|
||||
|
||||
- `source_machine_image_filter` (object) - Filters used to populate the `source_machine_image` field.
|
||||
|
|
|
@ -73,7 +73,7 @@ builder.
|
|||
five seconds and one minute 30 seconds, respectively. If this isn't
|
||||
specified, the default is `10s` or 10 seconds.
|
||||
|
||||
* `disable_vnc` (boolean) - Whether to create a VNC connection or not.
|
||||
- `disable_vnc` (boolean) - Whether to create a VNC connection or not.
|
||||
A `boot_command` cannot be used when this is `false`. Defaults to `false`.
|
||||
|
||||
- `floppy_dirs` (array of strings) - A list of directories to place onto
|
||||
|
|
Loading…
Reference in New Issue