Add an ignoreChanges resource option #2657
Conversation
Fixes #2277. Adds a new ignoreChanges resource option that allows specifying a list of property names whose values will be ignored during updates. The property values will be used for Create, but will be ignored for purposes of updates, and as a result also cannot trigger replacements. This is a feature of the Pulumi engine, not of the resource providers, so no new logic is needed in providers to support this feature. Instead, the engine simply replaces the values of input properties in the goal state with old inputs for properties marked as `ignoreChanges`. Currently, only top level properties may be specified in `ignoreChanges`. In the future, this could be extended to support paths to nested properties (including into array elements) with a JSONPath/JMESPath syntax.
| /** | ||
| * Ignore changes to any of the specified properties. | ||
| */ | ||
| ignoreChanges?: string[]; |
There was a problem hiding this comment.
I noticed that you added this to ResourceOptions instead of CustomResourceOptions. What does ignoreChanges mean on component resource, since there are no CRUD operations associated with components?
There was a problem hiding this comment.
Technically, the feature does apply to both Component and Custom resources, so I think this is technically correct. That said, I'm not sure practically what impact it can have to ignore changes on a component (though in the UI and checkpoint, this will have the effect of ignoring input property changes). But I think that's more about some of the current oddness around input/output properties on components generally. I think for orthogonality purposes, it does make sense to keep this as is.
Can we open an issue for Python? The linked issue will be closed as soon as this PR merges. |
| @@ -177,6 +177,7 @@ export function registerResource(res: Resource, t: string, name: string, custom: | |||
| req.setProvider(resop.providerRef); | |||
| req.setDependenciesList(Array.from(resop.allDirectDependencyURNs)); | |||
| req.setDeletebeforereplace((<any>opts).deleteBeforeReplace || false); | |||
| req.setIgnorechangesList(opts.ignoreChanges || []); | |||
There was a problem hiding this comment.
Can you add a test that exercises this code path in the language host?
Also add SDK test coverage for JavaScript ignoreChanges.
I've added the Python support to this PR. |
| @@ -87,6 +92,7 @@ def __init__(self, | |||
| self.provider = provider | |||
| self.providers = providers | |||
| self.delete_before_replace = delete_before_replace | |||
| self.ignore_changes = ignore_changes | |||
There was a problem hiding this comment.
Can you add a :param directive for this new parameter after line 87? This is what Sphinx picks up when it generates documentation.
Fixes #2277.
Adds a new ignoreChanges resource option that allows specifying a list of property names whose values will be ignored during updates. The property values will be used for Create, but will be ignored for purposes of updates, and as a result also cannot trigger replacements.
This is a feature of the Pulumi engine, not of the resource providers, so no new logic is needed in providers to support this feature. Instead, the engine simply replaces the values of input properties in the goal state with old inputs for properties marked as
ignoreChanges.Currently, only top level properties may be specified in
ignoreChanges. In the future, this could be extended to support paths to nested properties (including into array elements) with a JSONPath/JMESPath syntax.