docs: Uniform docs for user_data and remove some implementation details

This commit is contained in:
Rickard von Essen 2018-10-26 10:12:35 +02:00
parent 2b564eb563
commit cb9944e5e0
No known key found for this signature in database
GPG Key ID: 594C11A315EDF6E2
4 changed files with 14 additions and 16 deletions

View File

@ -177,10 +177,12 @@ builder.
- `TLSHandshakeTimeout` (int) - When happen "net/http: TLS handshake timeout" problem, set this environment variable - `TLSHandshakeTimeout` (int) - When happen "net/http: TLS handshake timeout" problem, set this environment variable
to a bigger such as `export TLSHandshakeTimeout=30`, it will set the TLS handshake timeout value to 30s. to a bigger such as `export TLSHandshakeTimeout=30`, it will set the TLS handshake timeout value to 30s.
- `user_data` (string) - The UserData of an instance must be encoded in `Base64` - `user_data` (string) - User data to apply when launching the instance. Note
format, and the maximum size of the raw data is `16 KB`. that you need to be careful about escaping characters due to the templates
being JSON. It is often more convenient to use `user_data_file`, instead.
- `user_data_file` (string) - The file name of the userdata. - `user_data_file` (string) - Path to a file that will be used for the user
data when launching the instance.
- `vpc_cidr_block` (string) - Value options: `192.168.0.0/16` and `172.16.0.0/16`. - `vpc_cidr_block` (string) - Value options: `192.168.0.0/16` and `172.16.0.0/16`.
When not specified, the default value is `172.16.0.0/16`. When not specified, the default value is `172.16.0.0/16`.

View File

@ -113,7 +113,7 @@ Providing `temp_resource_group_name` or `location` in combination with `build_re
`USGovernmentCloud` and `AzureUSGovernmentCloud` are also supported. `USGovernmentCloud` and `AzureUSGovernmentCloud` are also supported.
- `custom_data_file` (string) Specify a file containing custom data to inject into the cloud-init process. The contents - `custom_data_file` (string) Specify a file containing custom data to inject into the cloud-init process. The contents
of the file are read, base64 encoded, and injected into the ARM template. The custom data will be passed to of the file are read and injected into the ARM template. The custom data will be passed to
cloud-init for processing at the time of provisioning. See [documentation](http://cloudinit.readthedocs.io/en/latest/topics/examples.html) cloud-init for processing at the time of provisioning. See [documentation](http://cloudinit.readthedocs.io/en/latest/topics/examples.html)
to learn more about custom data, and how it can be used to influence the provisioning process. to learn more about custom data, and how it can be used to influence the provisioning process.

View File

@ -48,14 +48,12 @@ Platform](https://www.ncloud.com/).
access source (`0.0.0.0/0`) and allowed port (5985) must be created in access source (`0.0.0.0/0`) and allowed port (5985) must be created in
advance. advance.
- `user_data` (string) - Init script to run when an instance is created. - `user_data` (string) - User data to apply when launching the instance. Note
- For Linux servers, Python, Perl, and Shell scripts can be used. The that you need to be careful about escaping characters due to the templates
path of the script to run should be included at the beginning of the being JSON. It is often more convenient to use `user_data_file`, instead.
script, like \#!/usr/bin/env python, \#!/bin/perl, or \#!/bin/bash.
- For Windows servers, only Visual Basic scripts can be used. - `user_data_file` (string) - Path to a file that will be used for the user
- All scripts must be written in English. data when launching the instance.
- `user_data_file` (string) - A path to a file containing a `user_data`
script. See above for more information.
- `region` (string) - Name of the region where you want to create an image. - `region` (string) - Name of the region where you want to create an image.
(default: Korea) (default: Korea)

View File

@ -129,13 +129,11 @@ builder.
configuration. While this can be used to set metadata["user_data"] the explicit "user_data" and "user_data_file" values will have precedence. An instance's metadata can be obtained from at http://169.254.169.254 on the configuration. While this can be used to set metadata["user_data"] the explicit "user_data" and "user_data_file" values will have precedence. An instance's metadata can be obtained from at http://169.254.169.254 on the
launched instance. launched instance.
- `user_data` (string) - user_data to be used by cloud - `user_data` (string) - User data to be used by cloud-init. See [the Oracle docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails) for more details. Generally speaking, it is easier to use the `user_data_file`,
init. See [the Oracle docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails) for more details. Generally speaking, it is easier to use the `user_data_file`,
but you can use this option to put either the plaintext data or the base64 but you can use this option to put either the plaintext data or the base64
encoded data directly into your Packer config. encoded data directly into your Packer config.
- `user_data_file` (string) - Path to a file to be used as user_data by cloud - `user_data_file` (string) - Path to a file to be used as user data by cloud-init. See [the Oracle docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails) for more details. Example:
init. See [the Oracle docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails) for more details. Example:
`"user_data_file": "./boot_config/myscript.sh"` `"user_data_file": "./boot_config/myscript.sh"`
- `tags` (map of strings) - Add one or more freeform tags to the resulting custom image. See [the Oracle docs](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm) for more details. Example: - `tags` (map of strings) - Add one or more freeform tags to the resulting custom image. See [the Oracle docs](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm) for more details. Example: