Skip to content

K8s naming convention rational and additional documentation#2252

Merged
lmolkova merged 10 commits intoopen-telemetry:mainfrom
jinja2:k8s-naming
Jun 1, 2025
Merged

K8s naming convention rational and additional documentation#2252
lmolkova merged 10 commits intoopen-telemetry:mainfrom
jinja2:k8s-naming

Conversation

@jinja2
Copy link
Copy Markdown
Contributor

@jinja2 jinja2 commented May 12, 2025

Fixes #2245

Changes

Adds rationale and further guidance for naming Kubernetes resources.

Merge requirement checklist

@github-actions github-actions bot added enhancement New feature or request area:k8s labels May 12, 2025
@jinja2 jinja2 marked this pull request as ready for review May 12, 2025 17:01
@jinja2 jinja2 requested review from a team as code owners May 12, 2025 17:01
@jinja2 jinja2 requested a review from a team May 12, 2025 17:36
@ChrsMark ChrsMark moved this to In Review in K8s SemConv SIG May 28, 2025
@lmolkova lmolkova moved this from Untriaged to Ready to be Merged in Semantic Conventions Triage May 29, 2025
@github-project-automation github-project-automation bot moved this from Ready to be Merged to Needs More Approval in Semantic Conventions Triage May 29, 2025
@lmolkova lmolkova moved this from Needs More Approval to Ready to be Merged in Semantic Conventions Triage May 29, 2025
@jinja2
Copy link
Copy Markdown
Contributor Author

jinja2 commented May 29, 2025

@open-telemetry/semconv-k8s-approvers made some further edits, I would appreciate a 2nd look. Should we make some exceptions for fields if they map directly to a field in k8s spec?

Copy link
Copy Markdown
Member

@trask trask left a comment

Choose a reason for hiding this comment

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

Thanks!

@github-project-automation github-project-automation bot moved this from Ready to be Merged to Needs More Approval in Semantic Conventions Triage May 29, 2025
@lmolkova
Copy link
Copy Markdown
Member

@jinja2 @joaopgrassi could we resolve open discussion (it seems that some changes have been made)?
Otherwise this PR should be good to merge.

@lmolkova lmolkova added this pull request to the merge queue Jun 1, 2025
Merged via the queue into open-telemetry:main with commit 2bc9789 Jun 1, 2025
14 checks passed
@github-project-automation github-project-automation bot moved this from In Review to Done in K8s SemConv SIG Jun 1, 2025
The following guidelines are specific to Kubernetes:

- [Service in Kubernetes](../non-normative/k8s-attributes.md#service-attributes)
- [Additional naming guidance for Kubernetes](../non-normative/naming-known-exceptions.md#kubernetes-naming-exceptions)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All: just a reminder that links should not point to page level 1 headings, because those don't exist in the published website. To see how this breaks the website build, visit https://github.com/open-telemetry/opentelemetry.io/actions/runs/15373995491/job/43256707459?pr=6948.

I'll submit a fix shortly.

Copy link
Copy Markdown
Contributor

@chalin chalin Jun 1, 2025

Choose a reason for hiding this comment

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

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

Labels

area:k8s enhancement New feature or request

Projects

Status: Done
Archived in project

Development

Successfully merging this pull request may close these issues.

Document rationale when conventions do not follow existing guidance

8 participants