Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+49 −36
Open

Update docs with Orphan and MustCreate managementPolicies #993

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
699b2a0
Update docs with Orphan and MustCreate managementPolicies
bobh66 Sep 12, 2025
0062ad8
Fix vale errors
bobh66 Sep 13, 2025
8df9468
Fix formatting and spelling
bobh66 Sep 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions content/master/managed-resources/managed-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,22 +337,26 @@ Crossplane supports the following policies:
| `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. |
| `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. |
{{</table >}}

The following is a list of common policy combinations:
{{<table "table table-sm table-hover table-striped-columns" >}}
| Create | Delete | LateInitialize | Observe | Update | Description |
| :---: | :---: | :---: | :---: | :---: | --- |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | _Default policy_. Crossplane has full control over the resource. |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | After creation any changes made to the managed resource aren't passed to the external resource. Useful for immutable external resources. |
| {{<check>}} | {{<check>}} | | {{<check>}} | {{<check>}} | Prevent Crossplane from managing any settings not defined in the managed resource. Useful for immutable fields in an external resource. |
| {{<check>}} | {{<check>}} | | {{<check>}} | | Crossplane doesn't import any settings from the external resource and doesn't push changes to the managed resource. Crossplane recreates the external resource if it's deleted. |
| {{<check>}} | | {{<check>}} | {{<check>}} | {{<check>}} | Crossplane doesn't delete the external resource when deleting the managed resource. |
| {{<check>}} | | {{<check>}} | {{<check>}} | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't apply changes to the external resource after creation. |
| {{<check>}} | | | {{<check>}} | {{<check>}} | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't import any settings from the external resource. |
| {{<check>}} | | | {{<check>}} | | Crossplane creates the external resource but doesn't apply any changes to the external resource or managed resource. Crossplane can't delete the resource. |
| | | | {{<check>}} | | Crossplane only observes a resource. |
| | | | | | No policy set. An alternative method for [pausing](#paused) a resource. |
| Create | Delete | LateInitialize | Observe | Update | Orphan | MustCreate | Description |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |--- |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | | _Default policy_. Crossplane has full control over the resource. |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | | | After creation any changes made to the managed resource aren't passed to the external resource. Useful for immutable external resources. |
| {{<check>}} | {{<check>}} | | {{<check>}} | {{<check>}} | | | Prevent Crossplane from managing any settings not defined in the managed resource. Useful for immutable fields in an external resource. |
| {{<check>}} | {{<check>}} | | {{<check>}} | | | | Crossplane doesn't import any settings from the external resource and doesn't push changes to the managed resource. Crossplane recreates the external resource if it's deleted. |
| {{<check>}} | | {{<check>}} | {{<check>}} | {{<check>}} | | | Crossplane doesn't delete the external resource when deleting the managed resource. |
| {{<check>}} | | {{<check>}} | {{<check>}} | | | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't apply changes to the external resource after creation. |
| {{<check>}} | | | {{<check>}} | {{<check>}} | | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't import any settings from the external resource. |
| {{<check>}} | | | {{<check>}} | | | | Crossplane creates the external resource but doesn't apply any changes to the external resource or managed resource. Crossplane can't delete the resource. |
| | | | {{<check>}} | | | | Crossplane only observes a resource. |
| | | | | | | | No policy set. An alternative method for [pausing](#paused) a resource. |
| | | | | | {{<check>}} | | Crossplane doesn't delete the external resource when deleting the managed resource. Equivalent to Observe, Create, Update, LateInitialize. |
| | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | {{<check>}} | Crossplane has full control over the resource. The resource must not already exist when the Managed Resource is created. |
{{< /table >}}

<!-- vale off -->
Expand Down
28 changes: 16 additions & 12 deletions content/v1.20/concepts/managed-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,22 +447,26 @@ Crossplane supports the following policies:
| `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. |
|`MustCreate` | A stricter version of `Create` that requires the desired resource to _not_ already exist. |
{{</table >}}

The following is a list of common policy combinations:
{{<table "table table-sm table-hover table-striped-columns" >}}
| Create | Delete | LateInitialize | Observe | Update | Description |
| :---: | :---: | :---: | :---: | :---: | --- |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | _Default policy_. Crossplane has full control over the resource. |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | After creation any changes made to the managed resource aren't passed to the external resource. Useful for immutable external resources. |
| {{<check>}} | {{<check>}} | | {{<check>}} | {{<check>}} | Prevent Crossplane from managing any settings not defined in the managed resource. Useful for immutable fields in an external resource. |
| {{<check>}} | {{<check>}} | | {{<check>}} | | Crossplane doesn't import any settings from the external resource and doesn't push changes to the managed resource. Crossplane recreates the external resource if it's deleted. |
| {{<check>}} | | {{<check>}} | {{<check>}} | {{<check>}} | Crossplane doesn't delete the external resource when deleting the managed resource. |
| {{<check>}} | | {{<check>}} | {{<check>}} | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't apply changes to the external resource after creation. |
| {{<check>}} | | | {{<check>}} | {{<check>}} | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't import any settings from the external resource. |
| {{<check>}} | | | {{<check>}} | | Crossplane creates the external resource but doesn't apply any changes to the external resource or managed resource. Crossplane can't delete the resource. |
| | | | {{<check>}} | | Crossplane only observes a resource. Used for [observe only resources]({{<ref "../guides/import-existing-resources#import-resources-automatically">}}). |
| | | | | | No policy set. An alternative method for [pausing](#paused) a resource. |
| Create | Delete | LateInitialize | Observe | Update | Orphan | MustCreate | Description |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |--- |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | | _Default policy_. Crossplane has full control over the resource. |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | | | After creation any changes made to the managed resource aren't passed to the external resource. Useful for immutable external resources. |
| {{<check>}} | {{<check>}} | | {{<check>}} | {{<check>}} | | | Prevent Crossplane from managing any settings not defined in the managed resource. Useful for immutable fields in an external resource. |
| {{<check>}} | {{<check>}} | | {{<check>}} | | | | Crossplane doesn't import any settings from the external resource and doesn't push changes to the managed resource. Crossplane recreates the external resource if it's deleted. |
| {{<check>}} | | {{<check>}} | {{<check>}} | {{<check>}} | | | Crossplane doesn't delete the external resource when deleting the managed resource. |
| {{<check>}} | | {{<check>}} | {{<check>}} | | | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't apply changes to the external resource after creation. |
| {{<check>}} | | | {{<check>}} | {{<check>}} | | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't import any settings from the external resource. |
| {{<check>}} | | | {{<check>}} | | | | Crossplane creates the external resource but doesn't apply any changes to the external resource or managed resource. Crossplane can't delete the resource. |
| | | | {{<check>}} | | | | Crossplane only observes a resource. |
| | | | | | | | No policy set. An alternative method for [pausing](#paused) a resource. |
| | | | | | {{<check>}} | | Crossplane doesn't delete the external resource when deleting the managed resource. Equivalent to Observe, Create, Update, LateInitialize. |
| } | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | {{<check>}} | _Default policy_. Crossplane has full control over the resource. The resource must not already exist when the Managed Resource is created. |
{{< /table >}}

<!-- vale off -->
Expand Down
28 changes: 16 additions & 12 deletions content/v2.0/managed-resources/managed-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,22 +337,26 @@ Crossplane supports the following policies:
| `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. |
| `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. |
{{</table >}}

The following is a list of common policy combinations:
{{<table "table table-sm table-hover table-striped-columns" >}}
| Create | Delete | LateInitialize | Observe | Update | Description |
| :---: | :---: | :---: | :---: | :---: | --- |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | _Default policy_. Crossplane has full control over the resource. |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | After creation any changes made to the managed resource aren't passed to the external resource. Useful for immutable external resources. |
| {{<check>}} | {{<check>}} | | {{<check>}} | {{<check>}} | Prevent Crossplane from managing any settings not defined in the managed resource. Useful for immutable fields in an external resource. |
| {{<check>}} | {{<check>}} | | {{<check>}} | | Crossplane doesn't import any settings from the external resource and doesn't push changes to the managed resource. Crossplane recreates the external resource if it's deleted. |
| {{<check>}} | | {{<check>}} | {{<check>}} | {{<check>}} | Crossplane doesn't delete the external resource when deleting the managed resource. |
| {{<check>}} | | {{<check>}} | {{<check>}} | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't apply changes to the external resource after creation. |
| {{<check>}} | | | {{<check>}} | {{<check>}} | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't import any settings from the external resource. |
| {{<check>}} | | | {{<check>}} | | Crossplane creates the external resource but doesn't apply any changes to the external resource or managed resource. Crossplane can't delete the resource. |
| | | | {{<check>}} | | Crossplane only observes a resource. |
| | | | | | No policy set. An alternative method for [pausing](#paused) a resource. |
| Create | Delete | LateInitialize | Observe | Update | Orphan | MustCreate | Description |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |--- |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | | _Default policy_. Crossplane has full control over the resource. |
| {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | | | After creation any changes made to the managed resource aren't passed to the external resource. Useful for immutable external resources. |
| {{<check>}} | {{<check>}} | | {{<check>}} | {{<check>}} | | | Prevent Crossplane from managing any settings not defined in the managed resource. Useful for immutable fields in an external resource. |
| {{<check>}} | {{<check>}} | | {{<check>}} | | | | Crossplane doesn't import any settings from the external resource and doesn't push changes to the managed resource. Crossplane recreates the external resource if it's deleted. |
| {{<check>}} | | {{<check>}} | {{<check>}} | {{<check>}} | | | Crossplane doesn't delete the external resource when deleting the managed resource. |
| {{<check>}} | | {{<check>}} | {{<check>}} | | | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't apply changes to the external resource after creation. |
| {{<check>}} | | | {{<check>}} | {{<check>}} | | | Crossplane doesn't delete the external resource when deleting the managed resource. Crossplane doesn't import any settings from the external resource. |
| {{<check>}} | | | {{<check>}} | | | | Crossplane creates the external resource but doesn't apply any changes to the external resource or managed resource. Crossplane can't delete the resource. |
| | | | {{<check>}} | | | | Crossplane only observes a resource. |
| | | | | | | | No policy set. An alternative method for [pausing](#paused) a resource. |
| | | | | | {{<check>}} | | Crossplane doesn't delete the external resource when deleting the managed resource. Equivalent to Observe, Create, Update, LateInitialize. |
| } | {{<check>}} | {{<check>}} | {{<check>}} | {{<check>}} | | {{<check>}} | _Default policy_. Crossplane has full control over the resource. The resource must not already exist when the Managed Resource is created. |
{{< /table >}}

<!-- vale off -->
Expand Down
1 change: 1 addition & 0 deletions utils/vale/styles/Crossplane/crossplane-words.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ MRD
MRD's
MRDs
MRs
MustCreate
Operation-specific
PatchSet
PatchSets
Expand Down