From e8afb6fcf36fb569008585801e80fa1915b3f387 Mon Sep 17 00:00:00 2001 From: Rickard von Essen Date: Fri, 26 Oct 2018 10:23:50 +0200 Subject: [PATCH] docs: user_script add note that Packer will not automatically wait for completion. --- website/source/docs/builders/alicloud-ecs.html.md | 2 ++ website/source/docs/builders/amazon-ebs.html.md | 2 ++ website/source/docs/builders/amazon-ebssurrogate.html.md | 2 ++ website/source/docs/builders/amazon-ebsvolume.html.md | 2 ++ website/source/docs/builders/amazon-instance.html.md | 2 ++ website/source/docs/builders/cloudstack.html.md | 2 ++ website/source/docs/builders/digitalocean.html.md | 2 ++ website/source/docs/builders/hetzner-cloud.html.md | 2 ++ website/source/docs/builders/ncloud.html.md | 2 ++ website/source/docs/builders/openstack.html.md | 2 ++ website/source/docs/builders/oracle-oci.html.md | 2 ++ 11 files changed, 22 insertions(+) diff --git a/website/source/docs/builders/alicloud-ecs.html.md b/website/source/docs/builders/alicloud-ecs.html.md index 99dac76d6..4547e1528 100644 --- a/website/source/docs/builders/alicloud-ecs.html.md +++ b/website/source/docs/builders/alicloud-ecs.html.md @@ -180,6 +180,8 @@ builder. - `user_data` (string) - User data 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 `user_data_file`, instead. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the instance. diff --git a/website/source/docs/builders/amazon-ebs.html.md b/website/source/docs/builders/amazon-ebs.html.md index 42619c1d7..5203b07ce 100644 --- a/website/source/docs/builders/amazon-ebs.html.md +++ b/website/source/docs/builders/amazon-ebs.html.md @@ -478,6 +478,8 @@ builder. - `user_data` (string) - User data 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 `user_data_file`, instead. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the instance. diff --git a/website/source/docs/builders/amazon-ebssurrogate.html.md b/website/source/docs/builders/amazon-ebssurrogate.html.md index 0212a8ed2..4416aca6d 100644 --- a/website/source/docs/builders/amazon-ebssurrogate.html.md +++ b/website/source/docs/builders/amazon-ebssurrogate.html.md @@ -474,6 +474,8 @@ builder. - `user_data` (string) - User data 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 `user_data_file`, instead. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the instance. diff --git a/website/source/docs/builders/amazon-ebsvolume.html.md b/website/source/docs/builders/amazon-ebsvolume.html.md index c5f0700c6..b9e78b6b2 100644 --- a/website/source/docs/builders/amazon-ebsvolume.html.md +++ b/website/source/docs/builders/amazon-ebsvolume.html.md @@ -384,6 +384,8 @@ builder. - `user_data` (string) - User data 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 `user_data_file`, instead. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the instance. diff --git a/website/source/docs/builders/amazon-instance.html.md b/website/source/docs/builders/amazon-instance.html.md index cdd8cd4e0..254cae975 100644 --- a/website/source/docs/builders/amazon-instance.html.md +++ b/website/source/docs/builders/amazon-instance.html.md @@ -467,6 +467,8 @@ builder. - `user_data` (string) - User data 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 `user_data_file`, instead. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the instance. diff --git a/website/source/docs/builders/cloudstack.html.md b/website/source/docs/builders/cloudstack.html.md index be87cc86c..4e937463e 100644 --- a/website/source/docs/builders/cloudstack.html.md +++ b/website/source/docs/builders/cloudstack.html.md @@ -171,6 +171,8 @@ builder. - `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. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the instance. This file will be parsed as a diff --git a/website/source/docs/builders/digitalocean.html.md b/website/source/docs/builders/digitalocean.html.md index 6d5be6fb7..fc8562092 100644 --- a/website/source/docs/builders/digitalocean.html.md +++ b/website/source/docs/builders/digitalocean.html.md @@ -84,6 +84,8 @@ builder. default state timeout is "6m". - `user_data` (string) - User data to launch with the Droplet. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the Droplet. diff --git a/website/source/docs/builders/hetzner-cloud.html.md b/website/source/docs/builders/hetzner-cloud.html.md index a743dcd83..f6b8892db 100644 --- a/website/source/docs/builders/hetzner-cloud.html.md +++ b/website/source/docs/builders/hetzner-cloud.html.md @@ -61,6 +61,8 @@ builder. - `poll_interval` (string) - Configures the interval in which actions are polled by the client. Default `500ms`. Increase this interval if you run into rate limiting errors. - `user_data` (string) - User data to launch with the server. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the server. diff --git a/website/source/docs/builders/ncloud.html.md b/website/source/docs/builders/ncloud.html.md index 2f9caaf31..7f70f307a 100644 --- a/website/source/docs/builders/ncloud.html.md +++ b/website/source/docs/builders/ncloud.html.md @@ -51,6 +51,8 @@ Platform](https://www.ncloud.com/). - `user_data` (string) - User data 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 `user_data_file`, instead. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the instance. diff --git a/website/source/docs/builders/openstack.html.md b/website/source/docs/builders/openstack.html.md index ab75b1071..4c59519cc 100644 --- a/website/source/docs/builders/openstack.html.md +++ b/website/source/docs/builders/openstack.html.md @@ -255,6 +255,8 @@ builder. - `user_data` (string) - User data 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 `user_data_file`, instead. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `user_data_file` (string) - Path to a file that will be used for the user data when launching the instance. diff --git a/website/source/docs/builders/oracle-oci.html.md b/website/source/docs/builders/oracle-oci.html.md index e7efe57cc..a6b781017 100644 --- a/website/source/docs/builders/oracle-oci.html.md +++ b/website/source/docs/builders/oracle-oci.html.md @@ -132,6 +132,8 @@ launched instance. - `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`, but you can use this option to put either the plaintext data or the base64 encoded data directly into your Packer config. + Packer will not automatically wait for a user script to finish before + shutting down the instance this must be handled in a provisioner. - `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: `"user_data_file": "./boot_config/myscript.sh"`