Update logs-in-kubernetes docs to warn users about daemonsets #4160
Conversation
|
💻 Deploy preview available: |
This reverts commit 8196de7.
|
Not sure if the recommendation for docs would be stacked tips or all in one admonition, let me know. |
Yeah... we try to avoid that wherever possible. Sometimes it's the only way to get the point across, sometimes we can rework the doc structure to combine admonitions... or write the info into body text. There's no explicit guidance for this in the Writer's Toolkit. In this case though, the new test addition looks more like a note to me. A tip is helpful extra info that be skipped... in this case that looks like it's important information. |
| @@ -166,6 +166,12 @@ Replace the following values: | |||
| You can get pods logs through the log files on each node. In this guide, you get the logs through the Kubernetes API because it doesn't require system privileges for {{< param "PRODUCT_NAME" >}}. | |||
| {{< /admonition >}} | |||
|
|
|||
| {{< admonition type="tip" >}} | |||
There was a problem hiding this comment.
| {{< admonition type="tip" >}} | |
| {{< admonition type="note" >}} |
I think this could be better as a note. It's not something the user can ignore/skip if they have deployed things as a daemonset.
PR Description
Add a tip for ensuring that you use the appropriate configuration to not collect duplicate logs when deploying Alloy as a daemonset.
Which issue(s) this PR fixes
See #1185 (comment)