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

[bitnami/zookeeper] Expose appProtocol, scheme, and tlsConfig for Istio compatibility #29683

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

cpepper96
Copy link

Description of the change

Hi folks, this PR is to expose the appProtocol field for the metrics Service and the scheme and tlsConfig fields for the ServiceMonitor.

Benefits

This will enable Prometheus metrics to be configured properly when deploying ZooKeeper to a cluster configured with Istio. The metrics service port name is tcp-metrics causing Istio to automatically select the TCP protocol for this service which causes an error. By exposing the appProtocol field we can override this selection with the correct protocol (in this case, http).

Similarly for the ServiceMonitor object, exposing the scheme and tlsConfig will enable Prometheus metrics to be integrated with Istio.

Possible drawbacks

I made the appProtocol, scheme, and tlsConfig values optional and empty by default to ensure backwards compatibility.

Checklist

  • Chart version bumped in Chart.yaml according to semver. This is not necessary when the changes only affect README.md files.
  • Variables are documented in the values.yaml and added to the README.md using readme-generator-for-helm
  • Title of the pull request follows this pattern [bitnami/<name_of_the_chart>] Descriptive title
  • All commits signed off and in agreement of Developer Certificate of Origin (DCO)

cpepper96 and others added 4 commits September 30, 2024 16:37
Signed-off-by: Jerod Culpepper <jcpepper@defenseunicorns.com>
Signed-off-by: Jerod Culpepper <jcpepper@defenseunicorns.com>
Signed-off-by: Jerod Culpepper <jcpepper@defenseunicorns.com>
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
@carrodher carrodher added verify Execute verification workflow for these changes in-progress labels Oct 2, 2024
@github-actions github-actions bot removed the triage Triage is needed label Oct 2, 2024
@github-actions github-actions bot removed the request for review from carrodher October 2, 2024 19:39
@github-actions github-actions bot requested a review from juan131 October 2, 2024 19:39
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
Copy link
Contributor

@juan131 juan131 left a comment

Choose a reason for hiding this comment

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

Thanks so much for this contribution! Please take a look at my comments when you have a chance.

Comment on lines +24 to +26
{{- if .Values.metrics.service.appProtocol }}
appProtocol: {{ .Values.metrics.service.appProtocol }}
{{- end }}
Copy link
Contributor

Choose a reason for hiding this comment

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

Can't we simply rename the port name to http-metrics?

@@ -28,4 +28,4 @@ maintainers:
name: zookeeper
sources:
- https://github.com/bitnami/charts/tree/main/bitnami/zookeeper
version: 13.4.14
version: 13.4.15
Copy link
Contributor

Choose a reason for hiding this comment

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

Please bump minor version instead given you're adding new chart parameters

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in-progress verify Execute verification workflow for these changes zookeeper
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants