-
Notifications
You must be signed in to change notification settings - Fork 149
Update docs with Orphan and MustCreate managementPolicies #993
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
jbw976
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good content wise @bobh66, thank you! I'll add an approval when:
- the code PRs are merged, so we know they are shipping
- we remove the docs updates for previous versions - only master is needed IMO
| | `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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bobh66 this comments is still valid
|
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and the Providers needs to update the runtime before this is possible at all
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <[email protected]>
Signed-off-by: Bob Haddleton <[email protected]>
Signed-off-by: Bob Haddleton <[email protected]>
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