Add description for pruneObjectBehavior #79
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/hold |
mprahl
reviewed
Nov 10, 2022
api/v1/configurationpolicy_types.go
Outdated
| @@ -27,7 +27,8 @@ type RemediationAction string | |||
| // +kubebuilder:validation:Enum=low;Low;medium;Medium;high;High;critical;Critical | |||
| type Severity string | |||
|
|
|||
| // PruneObjectBehavior : DeleteAll, DeleteIfCreated, or None | |||
| // PruneObjectBehavior is used to clean up resources that are created by the | |||
There was a problem hiding this comment.
Since we use the term objects in the ConfigurationPolicy API:
Suggested change
| // PruneObjectBehavior is used to clean up resources that are created by the | |
| // PruneObjectBehavior is used to remove objects that are manage by the |
mprahl
reviewed
Nov 10, 2022
api/v1/configurationpolicy_types.go
Outdated
| @@ -27,7 +27,8 @@ type RemediationAction string | |||
| // +kubebuilder:validation:Enum=low;Low;medium;Medium;high;High;critical;Critical | |||
| type Severity string | |||
|
|
|||
| // PruneObjectBehavior : DeleteAll, DeleteIfCreated, or None | |||
| // PruneObjectBehavior is used to clean up resources that are created by the | |||
| // policy. Values: DeleteAll, DeleteIfCreated, or None (default) | |||
There was a problem hiding this comment.
I think the values come up nicely with kubectl explain since the enum is set.
Suggested change
| // policy. Values: DeleteAll, DeleteIfCreated, or None (default) | |
| // policy upon policy deletion. |
mprahl
reviewed
Nov 10, 2022
api/v1/configurationpolicy_types.go
Outdated
| @@ -27,7 +27,8 @@ type RemediationAction string | |||
| // +kubebuilder:validation:Enum=low;Low;medium;Medium;high;High;critical;Critical | |||
| type Severity string | |||
|
|
|||
| // PruneObjectBehavior : DeleteAll, DeleteIfCreated, or None | |||
| // PruneObjectBehavior is used to remove objects that are created by the | |||
There was a problem hiding this comment.
Suggested change
| // PruneObjectBehavior is used to remove objects that are created by the | |
| // PruneObjectBehavior is used to remove objects that are managed by the |
Adding a description to the pruning parameter in the CRD Refs: - stolostron/backlog#26528 Signed-off-by: Gus Parvin <gparvin@redhat.com>
mprahl
approved these changes
Nov 10, 2022
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: gparvin, mprahl The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/unhold |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding a description to the pruning parameter in the CRD
Refs:
Signed-off-by: Gus Parvin gparvin@redhat.com