From 4f371de134df7cd37b92a82ad73bcb522826cb95 Mon Sep 17 00:00:00 2001 From: badra001 Date: Thu, 5 Jan 2023 11:33:26 -0500 Subject: [PATCH] update docs --- README.md | 12 ++++++++++++ main.tf | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/README.md b/README.md index beea888..61b1ce3 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,18 @@ git push The `variables.auto.tfvars` is there to enable this directory to be used for key rotation with the `rotate-keys.py` script. +## Changes when running plan or apply +You may see a `tf-plan` and a `tf-apply` inform you of changes to two different resources in a directory where you have used +this access key enablement: + +* module.NAME.local\_sensitive\_file.access\_key\_file[0] +* module.NAME.null\_resource.access\_key\_file\_decrypt\_key[0] + +This is because these resources are populated from `data` sources with a `templatefile()`. As such, it does not know +the output of the template until run time, so it re-generates that data. If there are no changes to the key, it will simple +create these files with the same content as before. This is not harmful, but it is important to understand when you see changes +in a plan you know you didn't make. + ## Requirements No requirements. diff --git a/main.tf b/main.tf index b306ac5..1a5ea6f 100644 --- a/main.tf +++ b/main.tf @@ -71,6 +71,18 @@ * ``` * * The `variables.auto.tfvars` is there to enable this directory to be used for key rotation with the `rotate-keys.py` script. +* +* ## Changes when running plan or apply +* You may see a `tf-plan` and a `tf-apply` inform you of changes to two different resources in a directory where you have used +* this access key enablement: +* +* * module.NAME.local_sensitive_file.access_key_file[0] +* * module.NAME.null_resource.access_key_file_decrypt_key[0] +* +* This is because these resources are populated from `data` sources with a `templatefile()`. As such, it does not know +* the output of the template until run time, so it re-generates that data. If there are no changes to the key, it will simple +* create these files with the same content as before. This is not harmful, but it is important to understand when you see changes +* in a plan you know you didn't make. */ locals {