Update docs with Orphan and MustCreate managementPolicies#993
Update docs with Orphan and MustCreate managementPolicies#993bobh66 wants to merge 3 commits intocrossplane:masterfrom
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| | `LateInitialize` | Crossplane initializes some external resource settings not defined in the `spec.forProvider` of the managed resource. See [the late initialization]({{<ref "./managed-resources#late-initialization" >}}) section for more details. | | ||
| | `Observe` | Crossplane only observes the resource and doesn't make any changes. Used for [observe only resources]({{<ref "../guides/import-existing-resources#import-resources-automatically">}}). | | ||
| | `Update` | Crossplane changes the external resource when changing the managed resource. | | ||
| |`Orphan` | Shorthand for the combination `Observe`, `Create`, `Update`, `LateInitialize`. Supports migration from the deprecated `deletionPolicy` attribute. | |
There was a problem hiding this comment.
i think it's reasonable to only update master. i don't think we'd backport these new policies to previous releases, so only having it in the latest docs makes sense.
|
convert to draft as we don't have alignment in |
|
@haarchri I merged those two PRs based on @jbw976 approvals and the fact that any other solution will require additional fields added to the API. Neither PR is an ideal solution but unless we want to rework |
| | `Observe` | Crossplane only observes the resource and doesn't make any changes. Used for observe only resources. | | ||
| | `Update` | Crossplane changes the external resource when changing the managed resource. | | ||
| |`Orphan` | Shorthand for the combination `Observe`, `Create`, `Update`, `LateInitialize`. Supports migration from the deprecated `deletionPolicy` attribute. | | ||
| |`MustCreate` | A stricter version of `Create` that requires the desired resource to _not_ already exist. | |
There was a problem hiding this comment.
and the Providers needs to update the runtime before this is possible at all
There was a problem hiding this comment.
That's a generic problem with all crossplane-runtime changes that need to be picked up by providers. There is no good way to identify when a specific change is available in a specific provider. I can mention it here but without a good way to track implementation in the providers I don't know how much it will help?
Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>
Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>
Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>
8df9468 to
a765c17
Compare

Updated documentation of managed resources to include the new
OrphanandMustCreateManagement Policies.Related PRs:
crossplane/crossplane-runtime#873
crossplane/crossplane-runtime#864