Skip to content

helm: Add ability to set scheme for probes#4478

Open
gambtho wants to merge 1 commit intokubernetes-sigs:mainfrom
gambtho:thgamble/4406
Open

helm: Add ability to set scheme for probes#4478
gambtho wants to merge 1 commit intokubernetes-sigs:mainfrom
gambtho:thgamble/4406

Conversation

@gambtho
Copy link
Contributor

@gambtho gambtho commented Jan 29, 2026 •
edited
Loading

Summary

  • Adds configurable probe settings to the Helm chart to support TLS termination at the backend server
  • When TLS is enabled, liveness and readiness probes can now correctly use HTTPS instead of HTTP
  • Adds full probe timing configuration (initialDelaySeconds, periodSeconds, timeoutSeconds, successThreshold, failureThreshold)

New Configuration Options

probes:
  scheme: HTTPS  # HTTP or HTTPS (default: HTTP)
  livenessProbe:
    initialDelaySeconds: 0
    periodSeconds: 10
    timeoutSeconds: 1
    successThreshold: 1
    failureThreshold: 3
  readinessProbe:
    initialDelaySeconds: 0
    periodSeconds: 10
    timeoutSeconds: 1
    successThreshold: 1
    failureThreshold: 3

Example Usage with TLS

config:
  tlsCertPath: "/headlamp-cert/tls.crt"
  tlsKeyPath: "/headlamp-cert/tls.key"

probes:
  scheme: HTTPS  # Required when TLS is enabled at backend

volumes:
  - name: headlamp-cert
    secret:
      secretName: headlamp-tls

volumeMounts:
  - name: headlamp-cert
    mountPath: /headlamp-cert

Test Plan

  • Verified helm template renders correctly with default HTTP scheme
  • Verified helm template renders correctly with HTTPS scheme
  • Deployed to test cluster with TLS enabled and HTTPS probes
  • Confirmed pod starts successfully and probes work correctly
  • Updated all expected test templates

Fixes #4406

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 29, 2026
@illume illume requested a review from Copilot February 1, 2026 11:32
illume
illume requested changes Feb 1, 2026
View reviewed changes
Copy link
Contributor

@illume illume left a comment

Choose a reason for hiding this comment

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

Thanks for this!

Can you please check the chart tests? There's a Github check failing.

make helm-template-test

(Also please rebase against main to remove the merge commit?)

Copilot AI reviewed Feb 1, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds configurable probe settings to the Headlamp Helm chart to support TLS termination at the backend server. When TLS is enabled, health probes need to use HTTPS instead of HTTP, which was previously not configurable and caused probe failures.

Changes:

  • Added probes configuration section to values.yaml with configurable scheme (HTTP/HTTPS) and timing parameters for liveness and readiness probes
  • Updated JSON schema to validate probe configuration
  • Modified deployment template to use configurable probe settings
  • Updated all test expected outputs to include new probe configuration fields
  • Added documentation to README explaining probe configuration usage with TLS

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
charts/headlamp/values.yaml Added probe configuration with default values for scheme, liveness, and readiness probe timing
charts/headlamp/values.schema.json Added JSON schema validation for probe configuration
charts/headlamp/templates/deployment.yaml Updated deployment template to use configurable probe scheme and timing parameters
charts/headlamp/tests/test_cases/tls-added.yaml Added HTTPS scheme to TLS test case
charts/headlamp/tests/expected_templates/*.yaml Updated 19 expected test outputs with new probe configuration fields
charts/headlamp/README.md Added documentation table and example for probe configuration with TLS

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gambtho gambtho force-pushed the thgamble/4406 branch 2 times, most recently from 30b0236 to 28d9213 Compare February 1, 2026 12:27
@illume illume requested a review from Copilot February 1, 2026 12:29
Copilot AI reviewed Feb 1, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 25 out of 25 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@scottmbaker scottmbaker mentioned this pull request Feb 4, 2026
Open
illume
illume approved these changes Feb 12, 2026
View reviewed changes
Copy link
Contributor

@illume illume left a comment

Choose a reason for hiding this comment

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

Thanks 🎉

I'll leave this open for a while longer before merging to give people more a chance to give their feedback.

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 12, 2026
illume
illume requested changes Feb 12, 2026
View reviewed changes
Copy link
Contributor

@illume illume left a comment

Choose a reason for hiding this comment

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

Oh, there's a test failure in the GitHub check. Can you please have a look?

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Feb 12, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gambtho
Once this PR has been reviewed and has the lgtm label, please assign yolossn for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details 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

@k8s-ci-robot k8s-ci-robot removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 12, 2026
@illume illume added charts blocker Completely prevents the user from using the software. labels Feb 12, 2026
skoeva
skoeva requested changes Feb 12, 2026
View reviewed changes
Copy link
Contributor

@skoeva skoeva left a comment

Choose a reason for hiding this comment

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

looks like the CI is still failing, here are the steps to follow from the output:

Test failed! To update expected templates to match current output:
  1. Review the differences above carefully
  2. If the changes are related to version, run:
     make helm-update-template-version
     This will update ALL expected templates with current Helm version
  3. Verify the changes and commit them

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

Reviewers

Copilot code review Copilot Copilot left review comments

@illume illume illume requested changes

@skoeva skoeva skoeva requested changes

@ashu8912 ashu8912 Awaiting requested review from ashu8912

Assignees

No one assigned

Labels

blocker Completely prevents the user from using the software. charts cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add ability to set scheme for probes

4 participants

@gambtho @k8s-ci-robot @illume @skoeva