From 33ee8a410c92d5ecc2f069d63b1325a8b7ef836b Mon Sep 17 00:00:00 2001 From: tuathail Date: Sat, 31 Oct 2020 01:09:21 +0000 Subject: [PATCH] website: Add note re: private_key configuration to intro (#24463) --- website/intro/examples/index.html.markdown | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/intro/examples/index.html.markdown b/website/intro/examples/index.html.markdown index 8a0318a945..0328ada4ec 100644 --- a/website/intro/examples/index.html.markdown +++ b/website/intro/examples/index.html.markdown @@ -45,6 +45,11 @@ cd terraform-provider-aws/examples/two-tier ``` You can then use your preferred code editor to browse and read the configurations. + +Note that in this example, the connection block defaults to using a local SSH agent for authentication with the instance. +Therefore ensure that the appropriate private key has been added to the agent before running the below steps. +Alternatively, as can be seen in some of the other examples, the `private_key` argument can also be used. + To try out an example, run Terraform's init and apply commands while in the example's directory: ```