Small improvements to recordDiff #248
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
mprahl
commented
May 21, 2024
mprahl
commented
May 21, 2024
mprahl
force-pushed
the
recorddiff
branch
2 times, most recently
from
44a8192
to
b791c44
Compare
Merged
dockerymick
suggested changes
May 21, 2024
api/v1/configurationpolicy_types.go
Outdated
Comment on lines
202
to
208
| // RecordDiff specifies whether and where to log the difference between the object on the cluster | ||
| // and the `objectDefinition` in the policy. The supported options are `InStatus` to record the | ||
| // difference in the policy status field, `Log` to log the difference in the | ||
| // config-policy-controller pod, and `None` to not log the diff. The default value is `None` for | ||
| // object kinds that include sensitive data including `ConfigMap`, `OAuthAccessToken`, | ||
| // `OAuthAuthorizeTokens`, `Route`, and `Secret` or when a policy template references sensitive | ||
| // data. For all other kinds, the default value is `InStatus`. |
There was a problem hiding this comment.
Suggested change
| // RecordDiff specifies whether and where to log the difference between the object on the cluster | |
| // and the `objectDefinition` in the policy. The supported options are `InStatus` to record the | |
| // difference in the policy status field, `Log` to log the difference in the | |
| // config-policy-controller pod, and `None` to not log the diff. The default value is `None` for | |
| // object kinds that include sensitive data including `ConfigMap`, `OAuthAccessToken`, | |
| // `OAuthAuthorizeTokens`, `Route`, and `Secret` or when a policy template references sensitive | |
| // data. For all other kinds, the default value is `InStatus`. | |
| // RecordDiff specifies whether and where to log the difference between the object on the cluster | |
| // and the `objectDefinition` parameter in the policy. The supported options are `InStatus` to record the | |
| // difference in the policy status field, `Log` to log the difference in the | |
| // `config-policy-controlle`r pod, and `None` to not log the difference. The default value is `None` for | |
| // object kinds that include sensitive data including resources such as, `ConfigMap`, `OAuthAccessToken`, | |
| // `OAuthAuthorizeTokens`, `Route`, and `Secret`, or when a policy template references sensitive | |
| // data. For all other kinds, the default value is `InStatus`. |
There was a problem hiding this comment.
I decided to not use the resources such as suggestion since I think it's already clear enough with just object kinds.
Comment on lines
2797
to
2800
| `# This diff may contain sensitive data. The spec["object-templates"][%d]["recordDiff"] field must be set `+ | ||
| `to "InStatus" for the diff to be recorded in the policy status. Consider existing access to the `+ | ||
| `ConfigurationPolicy objects and the etcd encryption configuration before proceeding.`, | ||
| objectTemplateIndex, |
There was a problem hiding this comment.
Does the other syntax bold the parameters? Also for this statement, saying "changes" instead of "differences" is more clear. However, I like "differences" for the sake of consistency. The extra tick marks from is a bit confusing for me. To be specific and if it is supported, please monospace "spec", "object-templates.recordDiff", "InStatus", "ConfigurationPolicy"
Suggested change
| `# This diff may contain sensitive data. The spec["object-templates"][%d]["recordDiff"] field must be set `+ | |
| `to "InStatus" for the diff to be recorded in the policy status. Consider existing access to the `+ | |
| `ConfigurationPolicy objects and the etcd encryption configuration before proceeding.`, | |
| objectTemplateIndex, | |
| `# This diff might contain sensitive data. The spec field, ["object-templates"][%d]["recordDiff"] fmust be set `+ | |
| `to "InStatus" for the differences to be recorded in the policy status. Consider existing access to the `+ | |
| `ConfigurationPolicy objects and the etcd encryption configuration before you proceed.`, | |
| objectTemplateIndex, |
There was a problem hiding this comment.
The syntax of spec["object-templates"][%d]["recordDiff"] is the JSON notation to access the field which is why it's specified this way. This would make sense to the user since they write their configuration policy in JSON or YAML (which is a superset of JSON).
dhaiducek
reviewed
May 21, 2024
dhaiducek
reviewed
May 21, 2024
mprahl
force-pushed
the
recorddiff
branch
2 times, most recently
from
d049c5c
to
e22b067
Compare
|
Thanks for the reviews @dhaiducek and @dockerymick . This is ready for another round. |
dhaiducek
reviewed
May 21, 2024
Signed-off-by: mprahl <mprahl@users.noreply.github.com>
This provides more context as to why it may be unsafe to enable it. Signed-off-by: mprahl <mprahl@users.noreply.github.com>
dockerymick
suggested changes
May 21, 2024
...s/kustomize_configurationpolicy/policy.open-cluster-management.io_configurationpolicies.yaml
Outdated
Show resolved
Hide resolved
deploy/crds/policy.open-cluster-management.io_configurationpolicies.yaml
Outdated
Show resolved
Hide resolved
Signed-off-by: mprahl <mprahl@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dhaiducek, 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 |
openshift-merge-bot
bot
merged commit 8f2947e
into
open-cluster-management-io:main
9 checks passed
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.
See each commit for details.