Skip to content

Docs: Clarify service.port allowed value types #26344

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

Merged
merged 1 commit into from
Jul 24, 2025
Merged

Docs: Clarify service.port allowed value types #26344

merged 1 commit into from
Jul 24, 2025

Conversation

aimeeu
Copy link
Contributor

@aimeeu aimeeu commented Jul 24, 2025

Description

  • Add table to service.port parameter entry to clarify allowed port value types by service kind. See the Jira ticket for more context. Note that I added a row for using connect native since the example on the connect page shows a port label.
  • Update a few outdated links to Consul native docs.

Links

Jira: CE-855

https://nomad-git-ce855-hashicorp.vercel.app/nomad/docs/job-specification/service#port

Contributor Checklist

  • Changelog Entry If this PR changes user-facing behavior, please generate and add a
    changelog entry using the make cl command.
  • Testing Please add tests to cover any new functionality or to demonstrate bug fixes and
    ensure regressions will be caught.
  • Documentation If the change impacts user-facing functionality such as the CLI, API, UI,
    and job configuration, please update the Nomad website documentation to reflect this. Refer to
    the website README for docs guidelines. Please also consider whether the
    change requires notes within the upgrade guide.

Reviewer Checklist

  • Backport Labels Please add the correct backport labels as described by the internal
    backporting document.
  • Commit Type Ensure the correct merge method is selected which should be "squash and merge"
    in the majority of situations. The main exceptions are long-lived feature branches or merges where
    history should be preserved.
  • Enterprise PRs If this is an enterprise only PR, please add any required changelog entry
    within the public repository.

@aimeeu aimeeu added the theme/docs Documentation issues and enhancements label Jul 24, 2025
@aimeeu aimeeu requested a review from a team as a code owner July 24, 2025 17:32
@aimeeu aimeeu added the backport/website This will backport PR changes to `stable-website` && the latest release-branch label Jul 24, 2025
@aimeeu aimeeu requested review from a team as code owners July 24, 2025 17:32
@aimeeu aimeeu added backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/1.8.x backport to 1.8.x release line backport/ent/1.9.x+ent Changes are backported to 1.9.x+ent backport/1.9.x backport to 1.9.x release line backport/1.10.x backport to 1.10.x release line labels Jul 24, 2025
Copy link
Member

@gulducat gulducat left a comment

Choose a reason for hiding this comment

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

lgtm!

| -------- | ------- |
| Normal | Numeric or port mapping label |
| Uses [`connect` native][connect-native] | Numeric or port mapping label |
| Uses [`connect` sidecar][connect-sidecar] | Numeric |
Copy link
Member

Choose a reason for hiding this comment

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

ah yeah, in particular this one needing to be a number can be pretty confusing if you're accustomed to labels elsewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/ent/1.9.x+ent Changes are backported to 1.9.x+ent backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.8.x backport to 1.8.x release line backport/1.9.x backport to 1.9.x release line backport/1.10.x backport to 1.10.x release line theme/docs Documentation issues and enhancements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants