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

fix documentation for helm extraPorts #1998

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

Conversation

jkruke
Copy link

@jkruke jkruke commented Oct 29, 2024

PR Description

Which issue(s) this PR fixes

Fixes #1997

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added

@jkruke jkruke requested a review from a team as a code owner October 29, 2024 17:23
@CLAassistant
Copy link

CLAassistant commented Oct 29, 2024

CLA assistant check
All committers have signed the CLA.

@clayton-cornell
Copy link
Contributor

clayton-cornell commented Oct 29, 2024

@jkruke Don't forget to sign the CLA so we can move forward with your PR.

The Helm chart tests are not up to date. Please run make generate-helm-tests and commit changes!

@jkruke
Copy link
Author

jkruke commented Oct 30, 2024

@clayton-cornell The CLA is now signed and I ran the helm tests.
Due to the results, I realized that k8s pod ports need hostPort, but a service needs port.
So I changed the service templates to use hostPort instead of the (not documented) port.

@clayton-cornell
Copy link
Contributor

@grafana/grafana-alloy-maintainers Can one of you take a look at this one? My Helm knowledge isn't strong enough to check/verify these changes.

@wildum
Copy link
Contributor

wildum commented Nov 4, 2024

@petewall could you check this change to the helm chart please

Copy link
Contributor

@petewall petewall left a comment

Choose a reason for hiding this comment

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

Is this a breaking change for anyone who has deployed alloy with the port and not hostPort?

@jkruke
Copy link
Author

jkruke commented Nov 4, 2024

Is this a breaking change for anyone who has deployed alloy with the port and not hostPort?

Yes it is, because port would have no effect anymore and hostPort would be required if using a service.
Probably it would be more clean (and non-breaking) to stick to extraPorts.hostPort and extraPorts.port but just to extend the extraPorts documentation by mentioning port ("The port that will be exposed by the service.").

I easily could change that again. How do you think about it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs feedback: Helm chart alloy.extraPorts.hostPort should be port instead
5 participants