Track default population in inputs #349
Conversation
Add a reserved property to each map value present in an input bag that tracks which keys in the map were populated using default values. When performing default application, only use a value from an old input bag if it was itself a default value. This allows the following sequence of events: - Create a resource with a value explicitly specified for property P - Remove the value for property P and update the resource. The new value for property P will be whatever its default value is, if any. Fixes pulumi/pulumi-aws#439.
| @@ -843,7 +883,42 @@ func CoerceTerraformString(schType schema.ValueType, stringValue string) (interf | |||
| return stringValue, nil | |||
| } | |||
|
|
|||
| func extractInputsFromOutputs(urn resource.URN, outs resource.PropertyMap, | |||
| func propagateDefaultAnnotations(oldInput, newInput resource.PropertyValue) { | |||
There was a problem hiding this comment.
This code is latent, and will become active once pulumi/pulumi#2531 and an as-of-yet-unpublished PR land.
In essence: once we begin refreshing inputs, doing so will destroy the __defaults annotations this PR adds. In order to avoid that, we need to hand Read the current inputs as well as the current state. We can then propagate the __defaults annotations for properties whose values have not changed.
These changes expose a resource's old inputs to the provider when performing a refresh. The provider can take advantage of this to maintain the accuracy of any additional data or metadata in the resource's inputs that may need to be updated during the refresh. This is required for the complete implementation of pulumi/pulumi-terraform#349. Without access to the old inputs for a resource, TF-based providers would lose all information about default population during a refresh.
These changes expose a resource's old inputs to the provider when performing a refresh. The provider can take advantage of this to maintain the accuracy of any additional data or metadata in the resource's inputs that may need to be updated during the refresh. This is required for the complete implementation of pulumi/pulumi-terraform#349. Without access to the old inputs for a resource, TF-based providers would lose all information about default population during a refresh.
These changes take advantage of the newly-added support for returning inputs from Read to update a resource's inputs as part of a refresh. As a consequence, the Pulumi engine will now properly detect drift between the actual state of a resource and the desired state described by the program and generate appropriate update or replace steps. As part of these changes, a resource's old inputs are now passed to the provider when performing a refresh. The provider can take advantage of this to maintain the accuracy of any additional data or metadata in the resource's inputs that may need to be updated during the refresh. This is required for the complete implementation of pulumi/pulumi-terraform#349. Without access to the old inputs for a resource, TF-based providers would lose all information about default population during a refresh.
this makes it possible to retain default lists during refresh
|
Ping. |
|
Code-gen tests will fail here b/c of the update to |
There was a problem hiding this comment.
Took me a little bit to wrap my head around __defaults, but I get it now and LGTM. Only thing I'd suggest is an additional doc comment on __defaults, something like this:
"__defaults is the set of input property keys whose values were not present in the original user input but instead were derived from provider defaults. A key's absence in __defaults implies that the old state's value for that key should not be used when applying defaults, since the old state's value was itself not a default."
Co-Authored-By: pgavlin <pgavlin@gmail.com>
|
A demonstration of the effects of this change may prove useful. Below is a before/after of a stack that creates a versioned S3 bucket and then attempts to disable versioning. In the before case, Before: https://asciinema.org/a/Drf7Mx4QLRd4fIZeL6UjbgKLY |
Add a reserved property to each map value present in an input bag that
tracks which keys in the map were populated using default values. When
performing default application, only use a value from an old input bag
if it was itself a default value.
This allows the following sequence of events:
for property P will be whatever its default value is, if any.
Fixes pulumi/pulumi-aws#439.