Skip to content

CNTRLPLANE-945: improve logging, add startup probe to Keycloak Deployment #30184

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
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

CNTRLPLANE-945: improve logging, add startup probe to Keycloak Deployment #30184

wants to merge 3 commits into from
+34 −25

Conversation

everettraven
Copy link
Contributor

@everettraven everettraven commented Aug 27, 2025 •
edited
Loading

We noticed in a few job runs that our tests were failing due to Keycloak Deployment availability checks timing out.

This PR:

  • Updates our logging behavior to tie into the Ginkgo logr.Logger implementation so we can avoid using standard library print statements for additional debugging logic
  • Adds a startup probe for the Keycloak Deployment. It looks like our availability issues stemmed from the liveness/readiness probes hitting connection refused errors because Keycloak hadn't successfully started yet. This lead to Kubelet restarting the Keycloak Pod indefinitely. Chose a ~200 second startup window for Keycloak before it gets restarted and this seems to have resolved our issues.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 27, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Aug 27, 2025 •
edited by openshift-ci bot
Loading

@everettraven: This pull request references CNTRLPLANE-945 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 story to target the "4.20.0" version, but no target version was set.

In response to this:

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.

@everettraven
Copy link
Contributor Author

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 27, 2025
@everettraven
Copy link
Contributor Author

/payload-aggregate periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview 10

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 27, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/383244d0-8356-11f0-96bf-b354a4277ec6-0

@everettraven
Copy link
Contributor Author

/payload-aggregate periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview 10

@openshift-ci openshift-ci bot requested review from ibihim and sjenning August 27, 2025 14:59
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 27, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/60b24f90-8356-11f0-9950-efea8bdabbd2-0

@everettraven
Copy link
Contributor Author

/payload-job periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview

@everettraven
Copy link
Contributor Author

/payload-job periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 27, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/c0a057a0-8363-11f0-86d8-6d93f003bb3d-0

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 27, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/c7e96c90-8363-11f0-96f4-ffe5ba70a924-0

@everettraven
Copy link
Contributor Author

/payload-job periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 27, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/8e52f9e0-836a-11f0-85f3-e31393781287-0

@everettraven
Copy link
Contributor Author

/payload-job periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 28, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/39887500-8411-11f0-8611-e6ba04d74a76-0

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 28, 2025
@everettraven
Copy link
Contributor Author

/payload-aggregate periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview 5

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 28, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/48fdd2f0-8411-11f0-996e-0929bfc43bd8-0

@everettraven
Copy link
Contributor Author

/payload-aggregate periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview 10

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 28, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/db8fde10-8434-11f0-9c69-64695eb201e2-0

@everettraven
Copy link
Contributor Author

/payload-aggregate periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview 10

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 28, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/e9dc2550-8434-11f0-8078-a62d61f4c0fe-0

@openshift-trt openshift-trt
Copy link

openshift-trt bot commented Aug 28, 2025

Job Failure Risk Analysis for sha: 7c333fe

Job Name Failure Risk
pull-ci-openshift-origin-main-e2e-aws-disruptive IncompleteTests
Tests for this run (106) are below the historical average (948): IncompleteTests (not enough tests ran to make a reasonable risk analysis; this could be due to infra, installation, or upgrade problems)

@liouk
Copy link
Member

liouk commented Aug 29, 2025

/retest-required

@liouk
Copy link
Member

liouk commented Aug 29, 2025

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 29, 2025
@everettraven
authentication/oidc: add a startup probe to Keycloak deployment
b3471fa 
so that liveness and readiness probes don't fail
prematurely, causing Kubelet to restart the Keycloak
Pod before it has finished starting up.

Signed-off-by: Bryce Palmer <bpalmer@redhat.com>
@everettraven everettraven force-pushed the oidc/keycloak-deploy-logging branch from 7c333fe to b3471fa Compare August 29, 2025 12:01
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Aug 29, 2025
@everettraven everettraven changed the title CNTRLPLANE-945: wip: authentication/oidc: use ginkgo logr for logging CNTRLPLANE-945: improve logging, add startup probe to Keycloak Deployment Aug 29, 2025
@liouk
Copy link
Member

liouk commented Aug 29, 2025

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 29, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Aug 29, 2025 •
edited by openshift-ci bot
Loading

@everettraven: This pull request references CNTRLPLANE-945 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 story to target the "4.20.0" version, but no target version was set.

In response to this:

We noticed in a few job runs that our tests were failing due to Keycloak Deployment availability checks timing out.

This PR:

  • Updates our logging behavior to tie into the Ginkgo logr.Logger implementation so we can avoid using standard library print statements for additional debugging logic
  • Adds a startup probe for the Keycloak Deployment. It looks like our availability issues stemmed from the liveness/readiness probes hitting connection refused errors because Keycloak hadn't successfully started yet. This lead to Kubelet restarting the Keycloak Pod indefinitely. Chose a ~200 second startup window for Keycloak before it gets restarted and this seems to have resolved our issues.

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.

@everettraven
Copy link
Contributor Author

Verified that this fixes the problem due to consistently green periodic runs after pushing the startup probe change.

/hold cancel

@openshift-ci openshift-ci bot removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged. labels Aug 29, 2025
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 29, 2025

@everettraven: The following test 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/verify b3471fa link true /test verify

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.

@everettraven
Copy link
Contributor Author

Holding to verify changes against existing periodic jobs.

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 29, 2025
@everettraven
Copy link
Contributor Author

/payload-job periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-rollback-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-uid-extra-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-uid-extra-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-configure-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-configure-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-uid-extra-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-rollback-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-configure-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-rollback-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-uid-extra-techpreview

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 29, 2025

@everettraven: trigger 12 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-rollback-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-uid-extra-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-uid-extra-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-configure-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-configure-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-uid-extra-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-rollback-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-configure-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-rollback-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-uid-extra-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/da44f0d0-84df-11f0-8619-278b047008e7-0

@liouk
Copy link
Member

liouk commented Aug 29, 2025

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 29, 2025
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 29, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: everettraven, liouk

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

@everettraven
authentication/oidc: improve rollout waiting logic
8c81b4e 
by re-using the existing WaitForOperatorsToSettle utility
function. This change ensures that we wait for all cluster-operators
to have settled prior to continuing any testing behaviors.

Signed-off-by: Bryce Palmer <bpalmer@redhat.com>
@everettraven everettraven force-pushed the oidc/keycloak-deploy-logging branch from 32ebe9f to 8c81b4e Compare August 29, 2025 20:23
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Aug 29, 2025
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 29, 2025

New changes are detected. LGTM label has been removed.

@everettraven
Copy link
Contributor Author

/payload-job periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-rollback-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-uid-extra-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-uid-extra-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-configure-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-configure-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-uid-extra-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-rollback-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-configure-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-rollback-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-uid-extra-techpreview

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 29, 2025

@everettraven: trigger 12 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-rollback-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-uid-extra-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-uid-extra-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-vsphere-external-oidc-configure-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-configure-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-rollback-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-azure-external-oidc-uid-extra-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-configure-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-rollback-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-configure-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-rollback-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-aws-external-oidc-uid-extra-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/26bf4790-8516-11f0-84bc-5d6a3e4c968f-0

@openshift-trt openshift-trt
Copy link

openshift-trt bot commented Aug 30, 2025

Job Failure Risk Analysis for sha: 8c81b4e

Job Name Failure Risk
pull-ci-openshift-origin-main-e2e-openstack-ovn IncompleteTests
Tests for this run (21) are below the historical average (2920): IncompleteTests (not enough tests ran to make a reasonable risk analysis; this could be due to infra, installation, or upgrade problems)

1 similar comment
@openshift-trt openshift-trt
Copy link

openshift-trt bot commented Aug 30, 2025

Job Failure Risk Analysis for sha: 8c81b4e

Job Name Failure Risk
pull-ci-openshift-origin-main-e2e-openstack-ovn IncompleteTests
Tests for this run (21) are below the historical average (2920): IncompleteTests (not enough tests ran to make a reasonable risk analysis; this could be due to infra, installation, or upgrade problems)

@everettraven
Copy link
Contributor Author

/payload-job periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-uid-extra-techpreview periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-rollback-techpreview

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 30, 2025

@everettraven: trigger 2 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-uid-extra-techpreview
  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-rollback-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/147ee0f0-8551-11f0-9f11-020560a8cc98-0

@everettraven
Copy link
Contributor Author

/payload-aggregate periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-uid-extra-techpreview 10

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 30, 2025

@everettraven: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-cluster-authentication-operator-release-4.20-periodics-e2e-gcp-external-oidc-uid-extra-techpreview

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/f4e46a00-8585-11f0-815a-6a9dda982413-0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ibihim ibihim Awaiting requested review from ibihim

@sjenning sjenning Awaiting requested review from sjenning

Assignees

@liouk liouk

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@everettraven @openshift-ci-robot @liouk