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.

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

Add explanation for state-into-spec in LoggingLogMetric reference doc #2000

Conversation

maqiuyujoyce
Copy link
Collaborator

@maqiuyujoyce maqiuyujoyce commented Jun 12, 2024

Change description

Added warning to the reference doc as the behavior for the state-into-spec annotation is changed after LoggingLogMetric uses the direct controller.

Also did a small clean up for the note in AlloyDBInstance.

Tests you have done

  • Run make ready-pr to ensure this PR is ready for review.
  • [N/A] Perform necessary E2E testing for changed resources.

@@ -6,6 +6,14 @@
{% block body %}
{{template "alphadisclaimer.tmpl" .}}

Caution: After
[v1.118.1](https://github.com/GoogleCloudPlatform/k8s-config-connector/releases/tag/v1.118.1),
`cnrm.cloud.google.com/state-into-spec` annotation is ignored during
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe change "ignored" to "dropped" (and remove the corresponding doc from the doc)? ignore is ambiguous because it could mean no-op or keeping-the-existing-behavior (previous default is merge) 

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about directly mentioning it is no-op? I think "dropped" might also be misleading because it could indicate the annotation won't be persisted in the KRM object, but when we do kubectl describe, we actually can still see this annotation if it is configured explicitly.

I think we can say something like:

Caution: After
[v1.118.1](https://github.com/GoogleCloudPlatform/k8s-config-connector/releases/tag/v1.118.1),
`cnrm.cloud.google.com/state-into-spec` annotation is no longer used during
LoggingLogMetric reconciliation, and [externally-managed
fields](https://cloud.google.com/config-connector/docs/concepts/managing-fields-externally)
in the existing LoggingLogMetric resources are considered managed, i.e.
Kubernetes _is_ the source of truth for these values.

@tarynlucas do you have any suggestions?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The suggested edit LGTM! I think "no longer used" makes sense since we're explaining this as a changed behavior from a previous version.

One nit: I think in the last sentence we're putting the emphasis on the wrong thing ("is"): could we change this to say something like "...considered managed, meaning Kubernetes is the source of truth for these values instead of [whatever the pre-1.118.1 behavior was]."

Also do we mean Kubernetes resources or objects? Just saying "Kubernetes is a the source of truth" seems a bit unclear to me, but maybe I'm just not familiar with the context.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to "no longer used" I like it as well.

@yuwenma
Copy link
Collaborator

yuwenma commented Jun 13, 2024

/lgtm

Thank you! One minor comment. Shall we drop the State-into-Spec annotation from the Cloud doc?

@google-oss-prow google-oss-prow bot added the lgtm label Jun 13, 2024
@maqiuyujoyce
Copy link
Collaborator Author

Thank you! One minor comment. Shall we drop the State-into-Spec annotation from the Cloud doc?

We should. Though because this is configured in a shared template, removing it just for LLM may not be very straight-forward. I plan to tackle it separately.

@google-oss-prow google-oss-prow bot removed the lgtm label Jun 13, 2024
@yuwenma
Copy link
Collaborator

yuwenma commented Jun 17, 2024

Thank you! One minor comment. Shall we drop the State-into-Spec annotation from the Cloud doc?

We should. Though because this is configured in a shared template, removing it just for LLM may not be very straight-forward. I plan to tackle it separately.

Okay, that's fair.

@yuwenma
Copy link
Collaborator

yuwenma commented Jun 17, 2024

/lgtm
/approve

Thanks!

@google-oss-prow google-oss-prow bot added the lgtm label Jun 17, 2024
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: yuwenma

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit 11b6ed5 into GoogleCloudPlatform:master Jun 17, 2024
13 checks passed
@yuwenma yuwenma added this to the 1.119 milestone Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants