HOSTEDCP-1553: Add annotation to customize log verbosity of kube-apiserver #4026

jared-hayes-dev · 2024-05-13T17:08:31Z

What this PR does / why we need it:
Adds annotation to support configuring kube-apiserver log verbosity to a value higher than default of 2.

Which issue(s) this PR fixes (optional, use fixes #<issue_number>(, fixes #<issue_number>, ...) format, where issue_number might be a GitHub issue, or a Jira story:
Fixes # https://issues.redhat.com/browse/OCPBUGS-32763

Checklist

Subject and description added to both, commit and PR.
Relevant issues have been referenced.
This change includes docs.
This change includes unit tests.

openshift-ci · 2024-05-13T17:08:52Z

Hi @jared-hayes-dev. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

rtheis · 2024-05-13T17:18:00Z

/ok-to-test

rtheis · 2024-05-13T17:26:29Z

/retitle HOSTEDCP-1553: Add annotation to customize log verbosity of kube-apiserver

openshift-ci-robot · 2024-05-13T17:26:36Z

@jared-hayes-dev: This pull request references HOSTEDCP-1553 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target the "4.16.0" version, but no target version was set.

In response to this:

What this PR does / why we need it:
Adds annotation to support configuring kube-apiserver log verbosity to a value higher than default of 2.

Which issue(s) this PR fixes (optional, use fixes #<issue_number>(, fixes #<issue_number>, ...) format, where issue_number might be a GitHub issue, or a Jira story:
Fixes # https://issues.redhat.com/browse/OCPBUGS-32763

Checklist

Subject and description added to both, commit and PR.

Relevant issues have been referenced.

This change includes docs.

This change includes unit tests.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

stevekuznetsov · 2024-05-13T22:47:17Z

control-plane-operator/controllers/hostedcontrolplane/kas/deployment.go

@@ -429,10 +429,17 @@ func buildKASContainerMain(image string, port int32, noProxyCIDRs []string, hcp
 		c.Command = []string{
 			"hyperkube",
 		}
+
+		// default to level of 2
+		kasVerbosityLevel := "-v2"


Just for my sanity, if we have --v=%d for others, mirror it here with --v=2

stevekuznetsov · 2024-05-13T22:47:36Z

control-plane-operator/controllers/hostedcontrolplane/kas/deployment.go

+
+		// default to level of 2
+		kasVerbosityLevel := "-v2"
+		if hcp.Annotations[hyperv1.KubeAPIServerVerbosityLevelAnnotation] != "" {


We should parse this as an integer and ignore it or error if it's not one - passing --v=whatever will crash the KAS.

stevekuznetsov · 2024-05-14T19:08:00Z

control-plane-operator/controllers/hostedcontrolplane/kas/deployment.go

+			kasAnnotationValue := hcp.Annotations[hyperv1.KubeAPIServerVerbosityLevelAnnotation]
+			_, err := strconv.Atoi(kasAnnotationValue)
+			// ensure integer value in annotation
+			if err == nil {


Not sure what our stance is for the other annotations-as-APIs but exposing the error, when one exists, into status somewhere would help users understand why their attempt at influencing the log level is being ignored.

@stevekuznetsov a comment in the Jira indicates that we probably need a logging section in the HCP CRD. This of course would take a fair amount of work. As a alternative to this PR as it is now and a full HCP CRD update, would it be acceptable to default KAS logging to v3 instead of v2? Or maybe allow IBM Cloud to just set v3? We (IBM) rely on v3 log level to help us debug problems.

@stevekuznetsov bump on above comment. Do you have any feedback on this? If more changes are required around logging we would prefer to just bump the default verbosity level instead if that is acceptable.

stevekuznetsov · 2024-05-14T19:08:09Z

control-plane-operator/controllers/hostedcontrolplane/kas/deployment.go

+			_, err := strconv.Atoi(kasAnnotationValue)
+			// ensure integer value in annotation
+			if err == nil {
+				kasVerbosityLevel = fmt.Sprintf("--v=%s", kasAnnotationValue)


%d, use the int

jeffnowicki · 2024-05-16T15:51:16Z

/jira refresh

openshift-ci-robot · 2024-05-16T15:51:19Z

@jeffnowicki: This pull request references HOSTEDCP-1553 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target only the "4.16.0" version, but multiple target versions were set.

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

jeffnowicki · 2024-05-16T15:52:03Z

/jira refresh

openshift-ci-robot · 2024-05-16T15:52:06Z

@jeffnowicki: This pull request references HOSTEDCP-1553 which is a valid jira issue.

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

jared-hayes-dev · 2024-05-16T17:12:39Z

/retest-required

jared-hayes-dev · 2024-05-21T14:58:56Z

/retest-required

jared-hayes-dev · 2024-05-23T20:14:31Z

/retest-required

muraee · 2024-05-27T07:52:49Z

/approve

rtheis · 2024-06-03T10:33:33Z

@jared-hayes-dev please rebase your PR.

jared-hayes-dev · 2024-06-03T23:56:08Z

/retest

jared-hayes-dev · 2024-06-04T03:57:30Z

/retest

rtheis · 2024-06-04T10:23:29Z

/retest

jared-hayes-dev · 2024-06-04T19:43:48Z

/retest

jared-hayes-dev · 2024-06-04T23:32:07Z

/retest

rtheis · 2024-06-05T10:04:04Z

/retest

jared-hayes-dev · 2024-06-06T15:01:28Z

/retest

rtheis

/lgtm

openshift-ci · 2024-06-06T17:48:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jared-hayes-dev, muraee, rtheis

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:

~~OWNERS~~ [muraee]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

jared-hayes-dev · 2024-06-06T18:02:42Z

/retest

openshift-ci · 2024-06-06T22:11:31Z

@jared-hayes-dev: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/e2e-ibmcloud-iks	`4aff1a1`	link	false	`/test e2e-ibmcloud-iks`
ci/prow/e2e-azure	`4aff1a1`	link	false	`/test e2e-azure`
ci/prow/e2e-ibmcloud-roks	`4aff1a1`	link	false	`/test e2e-ibmcloud-roks`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

jared-hayes-dev · 2024-06-06T22:14:03Z

/retest

rtheis · 2024-06-07T09:48:39Z

/cherry-pick release-4.16

rtheis · 2024-06-07T09:48:43Z

/cherry-pick release-4.15

rtheis · 2024-06-07T16:06:26Z

/cherry-pick release-4.16

openshift-cherrypick-robot · 2024-06-07T16:07:08Z

@rtheis: #4026 failed to apply on top of branch "release-4.16":

Applying: rebase + merge conflicts
Using index info to reconstruct a base tree...
M	api/hypershift/v1beta1/hostedcluster_types.go
M	hypershift-operator/controllers/hostedcluster/hostedcluster_controller.go
Falling back to patching base and 3-way merge...
Auto-merging hypershift-operator/controllers/hostedcluster/hostedcluster_controller.go
Auto-merging api/hypershift/v1beta1/hostedcluster_types.go
CONFLICT (content): Merge conflict in api/hypershift/v1beta1/hostedcluster_types.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 rebase + merge conflicts
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

rtheis · 2024-06-07T16:13:29Z

@jared-hayes-dev please manually cherry-pick this change to 4.16 and 4.15.

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. do-not-merge/needs-area needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 13, 2024

openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 13, 2024

openshift-ci bot changed the title ~~Add annotation to customize log verbosity of kube-apiserver~~ HOSTEDCP-1553: Add annotation to customize log verbosity of kube-apiserver May 13, 2024

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 13, 2024

stevekuznetsov reviewed May 13, 2024

View reviewed changes

stevekuznetsov reviewed May 14, 2024

View reviewed changes

jared-hayes-dev marked this pull request as ready for review May 16, 2024 14:54

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 16, 2024

openshift-ci bot requested review from enxebre and sjenning May 16, 2024 14:58

jared-hayes-dev force-pushed the kas-log-level-annotation branch from 0c57cab to 91a50a0 Compare May 23, 2024 15:07

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 27, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 31, 2024

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 1, 2024

Jared Hayes added 3 commits June 3, 2024 13:29

rebase + merge conflicts

fe5924f

pr feedback for syntax + validate annotation is integer

1d0375c

feedback from pr comments

4aff1a1

jared-hayes-dev force-pushed the kas-log-level-annotation branch from 91a50a0 to 4aff1a1 Compare June 3, 2024 20:29

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jun 3, 2024

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 3, 2024

rtheis approved these changes Jun 6, 2024

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 6, 2024

openshift-merge-bot bot merged commit a283cf0 into openshift:main Jun 7, 2024
13 of 16 checks passed

This was referenced Jun 7, 2024

Automated cherry pick of #4026: rebase + merge conflicts #4177

Open

Automated cherry pick of #4026: rebase + merge conflicts #4178

Open

HOSTEDCP-1553: Add annotation to customize log verbosity of kube-apiserver #4026

HOSTEDCP-1553: Add annotation to customize log verbosity of kube-apiserver #4026

Conversation

jared-hayes-dev commented May 13, 2024

openshift-ci bot commented May 13, 2024

rtheis commented May 13, 2024

rtheis commented May 13, 2024 • edited by openshift-ci bot

openshift-ci-robot commented May 13, 2024 • edited by openshift-ci bot

stevekuznetsov May 13, 2024

Choose a reason for hiding this comment

stevekuznetsov May 13, 2024

Choose a reason for hiding this comment

stevekuznetsov May 14, 2024

Choose a reason for hiding this comment

rtheis May 15, 2024

Choose a reason for hiding this comment

jared-hayes-dev May 23, 2024

Choose a reason for hiding this comment

stevekuznetsov May 14, 2024

Choose a reason for hiding this comment

jeffnowicki commented May 16, 2024

openshift-ci-robot commented May 16, 2024 • edited by openshift-ci bot

jeffnowicki commented May 16, 2024

openshift-ci-robot commented May 16, 2024 • edited by openshift-ci bot

jared-hayes-dev commented May 16, 2024

jared-hayes-dev commented May 21, 2024

jared-hayes-dev commented May 23, 2024

muraee commented May 27, 2024

rtheis commented Jun 3, 2024

jared-hayes-dev commented Jun 3, 2024

jared-hayes-dev commented Jun 4, 2024

rtheis commented Jun 4, 2024

jared-hayes-dev commented Jun 4, 2024

jared-hayes-dev commented Jun 4, 2024

rtheis commented Jun 5, 2024

jared-hayes-dev commented Jun 6, 2024

rtheis left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Jun 6, 2024

jared-hayes-dev commented Jun 6, 2024

openshift-ci bot commented Jun 6, 2024

jared-hayes-dev commented Jun 6, 2024

rtheis commented Jun 7, 2024

rtheis commented Jun 7, 2024

rtheis commented Jun 7, 2024

openshift-cherrypick-robot commented Jun 7, 2024

rtheis commented Jun 7, 2024

rtheis commented May 13, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 13, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 16, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 16, 2024 •

edited by openshift-ci bot