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

docs: final observability edits #9377

Merged
merged 3 commits into from
May 20, 2024

Conversation

kkunapuli
Copy link
Contributor

@kkunapuli kkunapuli commented May 15, 2024

Ticket

Description

Add note on transformation of labels, in the case of workspace, username, or other pod labels containing special characters.

Test Plan

Checklist

  • Changes have been manually QA'd
  • User-facing API changes need the "User-facing API Change" label.
  • Release notes should be added as a separate file under docs/release-notes/.
    See Release Note for details.
  • Licenses should be included for new code which was copied and/or modified from any external code.

@cla-bot cla-bot bot added the cla-signed label May 15, 2024
@determined-ci determined-ci requested a review from a team May 15, 2024 22:00
@determined-ci determined-ci added the documentation Improvements or additions to documentation label May 15, 2024
@kkunapuli kkunapuli marked this pull request as ready for review May 15, 2024 22:02
Copy link
Contributor

@NicholasBlaskey NicholasBlaskey left a comment

Choose a reason for hiding this comment

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

LGTM

as ``label_determined_ai_<label_name>``, e.g. ``label_determined_ai_container_id``.
as ``label_determined_ai_<label_name>``, e.g. ``label_determined_ai_container_id``. Kubernetes
limits characters allowed in pod labels to alphanumeric characters, underscores, hyphens, and dots.
Other characters in Determined resource names will be converted to an underscore, ``_``, before
Copy link
Contributor

Choose a reason for hiding this comment

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

what happens if the label is too long?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The label is truncated if it's more than 63 characters it is truncated. Then, any non-alphanumeric characters at the end are removed ... so the final label can be less than 63 characters.

63 characters is a lot; I don't think users would run into this very often. Do you think it's an important detail to include?

Copy link
Contributor

Choose a reason for hiding this comment

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

I was just curious. Might be good to include if someone does have long names for whatever reason

as ``label_determined_ai_<label_name>``, e.g. ``label_determined_ai_container_id``. Kubernetes
limits characters allowed in pod labels to alphanumeric characters, underscores, hyphens, and dots.
Other characters in Determined resource names will be converted to an underscore, ``_``, before
being added as a pod label.
Copy link
Member

Choose a reason for hiding this comment

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

Viewing Metrics

The Determined Master assigns specific state values to the pods it creates. These pod labels can be accessed via the kube_pod_labels metric from "kube-state-metrics". Label names are formatted as label_determined_ai_<label_name>, such as label_determined_ai_container_id.

Kubernetes restricts pod labels to alphanumeric characters, underscores, hyphens, and dots. Any other characters in Determined resource names will be converted underscores (_) before being added as a pod label.

Copy link
Member

@tara-det-ai tara-det-ai left a comment

Choose a reason for hiding this comment

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

suggested edits

@determined-ci determined-ci requested a review from a team May 20, 2024 15:06
@kkunapuli kkunapuli merged commit f48e2ba into observability_feature_branch May 20, 2024
81 of 100 checks passed
kkunapuli added a commit that referenced this pull request May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants