core: Add support for marking outputs as sensitive #6559
Merged
Conversation
This file contains 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
This commit allows an output to be marked "sensitive", in which case the
value is redacted in the post-refresh and post-apply list of outputs.
For example, the configuration:
```
variable "input" {
default = "Hello world"
}
output "notsensitive" {
value = "${var.input}"
}
output "sensitive" {
sensitive = true
value = "${var.input}"
}
```
Would result in the output:
```
terraform apply
Apply complete! Resources: 0 added, 0 changed, 0 destroyed.
Outputs:
notsensitive = Hello world
sensitive = <sensitive>
```
The `terraform output` command continues to display the value as before.
Limitations: Note that sensitivity is not tracked internally, so if the
output is interpolated in another module into a resource, the value will
be displayed. The value is still present in the state.
|
Needs docs - basically just convert what you wrote for the commit message over onto this page https://www.terraform.io/docs/configuration/outputs.html |
| @@ -250,7 +251,7 @@ func (c *ApplyCommand) Run(args []string) int { | |||
| } | |||
|
|
|||
| if !c.Destroy { | |||
| if outputs := outputsAsString(state); outputs != "" { | |||
| if outputs := outputsAsString(state, ctx.Module().Config().Outputs); outputs != "" { | |||
There was a problem hiding this comment.
Module() and Config() are guaranteed to be non-nil?
There was a problem hiding this comment.
Yes, if we have got to this stage.
|
Functionality and code looking good. Two Qs inline. |
| state, and available using the `terraform output` command, so cannot be | ||
| relied on as a sole means of protecting values. | ||
| * sensitivity is not tracked internally, so if the output is interpolated in | ||
| another module into a resource, the value will be displayed. |
There was a problem hiding this comment.
nit - capitalize first words
|
Other than the tiny casing nit you are free to ignore - this LGTM! |
cristicalin
pushed a commit
to cristicalin/terraform
that referenced
this pull request
May 24, 2016
* core: Add support for marking outputs as sensitive
This commit allows an output to be marked "sensitive", in which case the
value is redacted in the post-refresh and post-apply list of outputs.
For example, the configuration:
```
variable "input" {
default = "Hello world"
}
output "notsensitive" {
value = "${var.input}"
}
output "sensitive" {
sensitive = true
value = "${var.input}"
}
```
Would result in the output:
```
terraform apply
Apply complete! Resources: 0 added, 0 changed, 0 destroyed.
Outputs:
notsensitive = Hello world
sensitive = <sensitive>
```
The `terraform output` command continues to display the value as before.
Limitations: Note that sensitivity is not tracked internally, so if the
output is interpolated in another module into a resource, the value will
be displayed. The value is still present in the state.
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This pull request allows an output to be marked "sensitive", in which case the value is redacted in the post-refresh and post-apply list of outputs.
The configuration:
Would result in the output:
The
terraform outputcommand continues to display the value as before.Note that sensitivity is not tracked internally, so if the output is interpolated in another module into a resource, the value will be displayed. The value is still present in the state.