Skip to content
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

Jump to bottom

Update the recreateOption documentation based on feedback #270

Merged
merged 1 commit into from
Jun 21, 2024
Merged

Update the recreateOption documentation based on feedback #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions api/v1/configurationpolicy_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,11 @@ type ObjectTemplate struct {
ComplianceType ComplianceType `json:"complianceType"`
MetadataComplianceType MetadataComplianceType `json:"metadataComplianceType,omitempty"`

// RecreateOption describes whether to delete and recreate an object when an update is required. `IfRequired`
// will recreate the object when updating an immutable field. `Always` will always recreate the object if a mismatch
// is detected. `RecreateOption` has no effect when the `remediationAction` is `inform`. `IfRequired` has no effect
// on clusters without dry run update support. The default value is `None`.
//
// RecreateOption describes when to delete and recreate an object when an update is required. When you set the
// object to `IfRequired`, the policy recreates the object when updating an immutable field. When you set the
// parameter to `Always`, the policy recreates the object on any update. When you set the `remediationAction` to
// `inform`, the parameter value, `recreateOption`, has no effect on the object. The `IfRequired` value has no
// effect on clusters without dry-run update support. The default value is `None`.
//+kubebuilder:default=None
RecreateOption RecreateOption `json:"recreateOption,omitempty"`

Expand Down
9 changes: 5 additions & 4 deletions ...ustomize_configurationpolicy/policy.open-cluster-management.io_configurationpolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,10 +195,11 @@ spec:
recreateOption:
default: None
description: |-
RecreateOption describes whether to delete and recreate an object when an update is required. `IfRequired`
will recreate the object when updating an immutable field. `Always` will always recreate the object if a mismatch
is detected. `RecreateOption` has no effect when the `remediationAction` is `inform`. `IfRequired` has no effect
on clusters without dry run update support. The default value is `None`.
RecreateOption describes when to delete and recreate an object when an update is required. When you set the
object to `IfRequired`, the policy recreates the object when updating an immutable field. When you set the
parameter to `Always`, the policy recreates the object on any update. When you set the `remediationAction` to
`inform`, the parameter value, `recreateOption`, has no effect on the object. The `IfRequired` value has no
effect on clusters without dry-run update support. The default value is `None`.
enum:
- None
- IfRequired
Expand Down
9 changes: 5 additions & 4 deletions deploy/crds/policy.open-cluster-management.io_configurationpolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,11 @@ spec:
recreateOption:
default: None
description: |-
RecreateOption describes whether to delete and recreate an object when an update is required. `IfRequired`
will recreate the object when updating an immutable field. `Always` will always recreate the object if a mismatch
is detected. `RecreateOption` has no effect when the `remediationAction` is `inform`. `IfRequired` has no effect
on clusters without dry run update support. The default value is `None`.
RecreateOption describes when to delete and recreate an object when an update is required. When you set the
object to `IfRequired`, the policy recreates the object when updating an immutable field. When you set the
parameter to `Always`, the policy recreates the object on any update. When you set the `remediationAction` to
`inform`, the parameter value, `recreateOption`, has no effect on the object. The `IfRequired` value has no
effect on clusters without dry-run update support. The default value is `None`.
enum:
- None
- IfRequired
Expand Down