Update language around setting Kubernetes pod name in container info #701
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
💚 Build Succeeded
Expand to view the summary
Build stats
|
estolfo
commented
Oct 6, 2022
specs/agents/metadata.md
Outdated
| @@ -108,7 +107,9 @@ On Linux, the container ID and some of the Kubernetes metadata can be extracted | |||
|
|
|||
| If we match, then the basename is assumed to be a container ID. | |||
|
|
|||
| If the Kubernetes pod name is not the hostname, it can be overridden by the `KUBERNETES_POD_NAME` environment variable, using the [Downward API](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/). In a similar manner, you can inform the agent of the node name and namespace, using the environment variables `KUBERNETES_NODE_NAME` and `KUBERNETES_NAMESPACE`. | |||
| Sometimes the `KUBERNETES_POD_NAME` is set using the [Downward API](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/), | |||
| so we set the pod name to its value if it exists. Otherwise, we set the pod name to the hostname, because by default, Kubernetes will set the hostname to the pod name. | |||
There was a problem hiding this comment.
Suggested change
| so we set the pod name to its value if it exists. Otherwise, we set the pod name to the hostname, because by default, Kubernetes will set the hostname to the pod name. | |
| so we set the pod name to its value if it exists. Otherwise, we set the pod name to the hostname, because that's the default value Kubernetes uses. |
felixbarny
reviewed
Oct 6, 2022
trentm
reviewed
Oct 6, 2022
basepi
reviewed
Oct 10, 2022
estolfo
force-pushed
the
kubernetes-pod-name
branch
from
4d82638 to
1a82dcb
Compare
trentm
approved these changes
Oct 13, 2022
specs/agents/metadata.md
Outdated
| If the Kubernetes pod name is not the hostname, it can be overridden by the `KUBERNETES_POD_NAME` environment variable, using the [Downward API](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/). In a similar manner, you can inform the agent of the node name and namespace, using the environment variables `KUBERNETES_NODE_NAME` and `KUBERNETES_NAMESPACE`. | ||
| Sometimes the `KUBERNETES_POD_NAME` is set using the [Downward API](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/), | ||
| so we set the pod name to its value if it exists. | ||
| In a similar manner, you can inform the agent of the node name and namespace, using the environment variables `KUBERNETES_NODE_NAME` and `KUBERNETES_NAMESPACE`. |
There was a problem hiding this comment.
nit: Perhaps also mention KUBERNETES_POD_UID to set/override metadata.system.kubernetes.pid.uid? Though that's adding scope. :)
There was a problem hiding this comment.
I added the KUBERNETES_POD_UID to the spec. I don't know why it wasn't mentioned, unless I'm missing some special logic?
There was a problem hiding this comment.
I don't know why it wasn't mentioned, unless I'm missing some special logic?
I think it was just overlooked when added. AFAICT all the agents implement reading KUBERNETES_POD_UID.
david-luna
approved these changes
Sep 13, 2023
estolfo
force-pushed
the
kubernetes-pod-name
branch
from
b4ac13c to
924c2ff
Compare
SylvainJuge
approved these changes
Dec 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most agents already set the Kubernetes pod name correctly but the spec language was a bit misleading. This PR makes it more precise how the pod name should be set.