feat: show config.toml and user data in Terraform plan
#754
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Appreciated. Makes it easier to check for changes without deploying the module. Simplifies the development process. |
kayman-mk
requested changes
Mar 18, 2023
|
See #755 for KICS issue |
…ner into feat/show-config-files-in-diff
…ner into feat/show-config-files-in-diff
|
@kayman-mk apart from the PR linter error, this one is ready for re-review. |
kayman-mk
previously approved these changes
Mar 22, 2023
|
Tested an upgrade from 6.1.2 to this version. Looks good. |
kayman-mk
approved these changes
Mar 22, 2023
kayman-mk
changed the title
config.toml and user data in Terraform plan
kayman-mk
pushed a commit
that referenced
this pull request
Mar 22, 2023
🤖 I have created a release *beep* *boop* --- ## [6.2.0](6.1.2...6.2.0) (2023-03-22) ### Features * show `config.toml` and user data in Terraform plan ([#754](#754)) ([5b5c335](5b5c335)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Signed-off-by: Niek Palm <[email protected]> Co-authored-by: cattle-ops-releaser[bot] <126345536+cattle-ops-releaser[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kayman-mk
added a commit
that referenced
this pull request
May 3, 2023
## Description In #754 I unfortunately made a major oversight: the `local_file` doesn't persist between machines (duh 🤦🏾 ). So for example in a CI/CD pipeline the file is not present so it wants to render the whole file as new every time. This defeats the main purpose that I had intended for this feature... Also if the pipeline applies the plan, there will be a perpetual diff, even if you save the file in repository. I still think this is useful locally for debugging purposes, but therefore I propose we disable this mechanism by default. In addition, when these variables are enabled I changed the location to the Root module for easier access if you want to debug the rendered files. ## Migrations required YES/NO - Feature is quite new, if someone wants to use keep this as introduced they now need to explicitly enable it. ## Verification ```hcl output_runner_config_to_file = true output_user_data_to_file = true ``` Results:  --------- Co-authored-by: kayma <[email protected]> Co-authored-by: Matthias Kay <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What
Adds a new variable
show_user_data_in_planwhich isfalseby default (there could be sensitive data leaked).config.tomlto a fileWhy
config.tomlto a file we get an actual diff of theconfig.tomlwhen we change values in our Terraform plan. In addition this would help us with the refactoring work were currently doing.Migrations required
NO
Verification
show_user_data_in_plan = trueExample of
config.tomlshowing a diff in plan: