Merge pull request #6929 from rickard-von-essen/doc-clean

docs: cleanup whitspaces etc
This commit is contained in:
Rickard von Essen 2018-10-26 10:10:45 +02:00 committed by GitHub
commit 2b564eb563
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 32 additions and 24 deletions

View File

@ -36,7 +36,6 @@ builder.
### Required: ### Required:
- `api_access_key` (string) - The organization access key to use to identify your - `api_access_key` (string) - The organization access key to use to identify your
organization. It can also be specified via environment variable organization. It can also be specified via environment variable
`SCALEWAY_API_ACCESS_KEY`. Your access key is available in the `SCALEWAY_API_ACCESS_KEY`. Your access key is available in the

View File

@ -77,6 +77,7 @@ builder.
assigned. Maximum 512 characters but should in practice be much shorter assigned. Maximum 512 characters but should in practice be much shorter
(think between 5 and 20 characters). For example `postgresql-95-server` for (think between 5 and 20 characters). For example `postgresql-95-server` for
an image used as a PostgreSQL 9.5 server. an image used as a PostgreSQL 9.5 server.
- `image_version` (string) - The version string for this image. Maximum 128 - `image_version` (string) - The version string for this image. Maximum 128
characters. Any string will do but a format of `Major.Minor.Patch` is characters. Any string will do but a format of `Major.Minor.Patch` is
strongly advised by Joyent. See [Semantic Versioning](http://semver.org/) strongly advised by Joyent. See [Semantic Versioning](http://semver.org/)
@ -109,6 +110,7 @@ builder.
firewall rules. Unless you have a global rule defined in Triton which allows firewall rules. Unless you have a global rule defined in Triton which allows
SSH traffic enabling the firewall will interfere with the SSH provisioner. SSH traffic enabling the firewall will interfere with the SSH provisioner.
The default is `false`. The default is `false`.
- `source_machine_metadata` (object of key/value strings) - Triton metadata - `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 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 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 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 set the `user-script` metadata key to have Triton start a user supplied
script after the VM has booted. script after the VM has booted.
- `source_machine_name` (string) - Name of the VM used for building the image. - `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 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 instance running this image. Maximum 512 characters but should in practice
be much shorter (think between 5 and 20 characters). For example be much shorter (think between 5 and 20 characters). For example
`mysql-64-server-image-builder`. When omitted defaults to `mysql-64-server-image-builder`. When omitted defaults to
`packer-builder-[image_name]`. `packer-builder-[image_name]`.
- `source_machine_networks` (array of strings) - The UUID's of Triton networks - `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 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 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, the UUID's of the appropriate networks here. If this is not specified,
instances will be placed into the default Triton public and internal instances will be placed into the default Triton public and internal
networks. networks.
- `source_machine_tags` (object of key/value strings) - Tags applied to the VM - `source_machine_tags` (object of key/value strings) - Tags applied to the VM
used to create the image. used to create the image.
- `image_acls` (array of strings) - The UUID's of the users which will have - `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 access to this image. When omitted only the owner (the Triton user whose
credentials are used) will have access to the image. credentials are used) will have access to the image.
- `image_description` (string) - Description of the image. Maximum 512 - `image_description` (string) - Description of the image. Maximum 512
characters. characters.
- `image_eula_url` (string) - URL of the End User License Agreement (EULA) for - `image_eula_url` (string) - URL of the End User License Agreement (EULA) for
the image. Maximum 128 characters. the image. Maximum 128 characters.
- `image_homepage` (string) - URL of the homepage where users can find - `image_homepage` (string) - URL of the homepage where users can find
information about the image. Maximum 128 characters. information about the image. Maximum 128 characters.
- `image_tags` (object of key/value strings) - Tag applied to the image. - `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. - `source_machine_image_filter` (object) - Filters used to populate the `source_machine_image` field.

View File

@ -73,7 +73,7 @@ builder.
five seconds and one minute 30 seconds, respectively. If this isn't five seconds and one minute 30 seconds, respectively. If this isn't
specified, the default is `10s` or 10 seconds. 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`. 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 - `floppy_dirs` (array of strings) - A list of directories to place onto