From 191094edccd5a100080c8ede82abf84fc7e3f521 Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Mon, 20 Jul 2020 16:20:47 +0200 Subject: [PATCH] better `disable_stop_instance` docs --- builder/amazon/common/run_config.go | 41 +++++++------------ .../amazon/common/RunConfig-not-required.mdx | 41 +++++++------------ 2 files changed, 30 insertions(+), 52 deletions(-) diff --git a/builder/amazon/common/run_config.go b/builder/amazon/common/run_config.go index 82fe519be..9f5479f6e 100644 --- a/builder/amazon/common/run_config.go +++ b/builder/amazon/common/run_config.go @@ -89,34 +89,23 @@ type RunConfig struct { // which will stop the instance for you. If this is set to `true`, Packer // *will not* stop the instance but will assume that you will send the stop // signal yourself through your final provisioner. You can do this with a - // [windows-shell - // provisioner](/docs/provisioners/windows-shell). - // Note that Packer will still wait for the instance to be stopped, and - // failing to send the stop signal yourself, when you have set this flag to - // `true`, will cause a timeout. - // Example of a valid shutdown command: - // - // - // - // - // ```json - // "provisioners: [{ - // "type": "windows-shell", - // "inline": ["\"c:\\Program Files\\Amazon\\Ec2ConfigService\\ec2config.exe\" -sysprep"] - // }] + // [windows-shell provisioner](/docs/provisioners/windows-shell). Note that + // Packer will still wait for the instance to be stopped, and failing to + // send the stop signal yourself, when you have set this flag to `true`, + // will cause a timeout. + // + // An example of a valid windows shutdown command in a `windows-shell` + // provisioner is : + // ```shell-session + // ec2config.exe -sysprep // ``` - // - // - // - // - // ```hcl - // provisioner "windows-shell"{ - // inline = ["\"c:\\Program Files\\Amazon\\Ec2ConfigService\\ec2config.exe\" -sysprep"] - // } + // or + // ```sell-session + // "%programfiles%\amazon\ec2configservice\"ec2config.exe -sysprep"" // ``` - // - // - // + // -> Note: The double quotation marks in the command are not required if + // your CMD shell is already in the + // `C:\Program Files\Amazon\EC2ConfigService\` directory. DisableStopInstance bool `mapstructure:"disable_stop_instance" required:"false"` // Mark instance as [EBS // Optimized](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html). diff --git a/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx b/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx index 46ce71d43..5072ccc00 100644 --- a/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx +++ b/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx @@ -19,34 +19,23 @@ which will stop the instance for you. If this is set to `true`, Packer *will not* stop the instance but will assume that you will send the stop signal yourself through your final provisioner. You can do this with a - [windows-shell - provisioner](/docs/provisioners/windows-shell). - Note that Packer will still wait for the instance to be stopped, and - failing to send the stop signal yourself, when you have set this flag to - `true`, will cause a timeout. - Example of a valid shutdown command: - - - - - ```json - "provisioners: [{ - "type": "windows-shell", - "inline": ["\"c:\\Program Files\\Amazon\\Ec2ConfigService\\ec2config.exe\" -sysprep"] - }] + [windows-shell provisioner](/docs/provisioners/windows-shell). Note that + Packer will still wait for the instance to be stopped, and failing to + send the stop signal yourself, when you have set this flag to `true`, + will cause a timeout. + + An example of a valid windows shutdown command in a `windows-shell` + provisioner is : + ```shell-session + ec2config.exe -sysprep ``` - - - - - ```hcl - provisioner "windows-shell"{ - inline = ["\"c:\\Program Files\\Amazon\\Ec2ConfigService\\ec2config.exe\" -sysprep"] - } + or + ```sell-session + "%programfiles%\amazon\ec2configservice\"ec2config.exe -sysprep"" ``` - - - + -> Note: The double quotation marks in the command are not required if + your CMD shell is already in the + `C:\Program Files\Amazon\EC2ConfigService\` directory. - `ebs_optimized` (bool) - Mark instance as [EBS Optimized](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html).