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

connect/docs: clarify service.port for each context #10677

Open
shoenig opened this issue Jun 1, 2021 · 0 comments
Open

connect/docs: clarify service.port for each context #10677

shoenig opened this issue Jun 1, 2021 · 0 comments
Labels
hcc/jira stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/docs Documentation issues and enhancements type/enhancement

Comments

@shoenig
Copy link
Member

shoenig commented Jun 1, 2021

The group.service.port value serves more than one purpose, given the context of the service. This has lead to some confusion, particularly when setting up connect services where folks sometimes incorrectly (out of habit) use a port label instead of directly setting the numeric port.

I suspect we could emit a warning (or even error?) on job submission when a connect sidecar-using service sets the service.port value to a label instead of literal port.

If the docs had a table under the service.port parameter, we could describe what is expected in each context, e.g.

service kind port value
normal numeric or port mapping label
uses connect sidecar numeric
ingress gateway port mapping label (optional)
terminating gateway none (optional)
mesh gateway external port mapping label
@shoenig shoenig added type/enhancement theme/docs Documentation issues and enhancements stage/accepted Confirmed, and intend to work on. No timeline committment though. labels Jun 1, 2021
@shoenig shoenig self-assigned this Jun 1, 2021
@shoenig shoenig removed their assignment Jun 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hcc/jira stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/docs Documentation issues and enhancements type/enhancement
Projects
None yet
Development

No branches or pull requests

2 participants