Document Windows node support for the collector - #260
Merged
Merged
Conversation
Chart 0.6.0 can collect from Windows nodes, but nothing on this page said so or explained why it needs separate configuration. Adds a Windows Nodes section covering: why a second DaemonSet is required (one pod template cannot carry both a Linux and a Windows image, and the Linux daemon mounts host paths Windows pods do not support), the one-line opt-in, what is and is not collected, the Server 2019 tag override, and the common options (tolerations, host log path, runAsUserName, resources). Two things it calls out because they are easy to get wrong: - extraEnvs is per-collector and Helm replaces lists rather than merging, so a deployment that injects the Scout secret by env var needs its own copy under windowsDaemon.extraEnvs. Deployments that set scout.apiKey directly need nothing. - the agent Service is named after the Helm release, so with the install command on this page it is scout-agent-collector, matching the endpoint already used further down the page. Marked experimental: it is disabled by default and has not yet run on a live Windows node group.
The install guide pins 0.6.0, so what older chart versions did with Linux collectors on Windows nodes is not something a reader needs. Documentation should describe how the thing works, not how it used to be broken -- that belongs in release notes. Also drops "new and" from the experimental note: the status is what matters and it stays accurate, where novelty dates itself.
The Quick Start on the same page already installs --version 0.6.0, so repeating a pinned helm upgrade here implied the reader was on an older release and had to upgrade to get this. It is an install guide: enabling Windows is one more values block, applied by the command already given. Also drops the "the values.yaml you already use" framing for the same reason -- it assumed an existing deployment the page has not described.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds a Windows Nodes section to the Kubernetes install guide. Chart
0.6.0can collect from Windows nodes, but nothing on this page said so or explained why it needs separate configuration.What it covers
scout.windowsDaemon.enabled: truerunAsUserName, resourcesTwo things called out because they are easy to get wrong
extraEnvsis per-collector, and Helm replaces lists rather than merging them. A deployment that injects the Scout secret via env var needs its own copy underwindowsDaemon.extraEnvs; one that setsscout.apiKeydirectly needs nothing. Getting this wrong gives a pod stuck inCreateContainerConfigErroror silently unauthenticated exports.The agent Service is named after the Helm release. With the
helm install scout ...command on this page that isscout-agent-collector, notscout-collector-agent-collector— which is what I first wrote, and which matches the endpoint already used further down the page at line 511.Verification
Every snippet was rendered against the published 0.6.0 chart from
charts.base14.io, not a local copy:enabled: truealone renders the Windows resources and inherits auth from the existingscout.*valuesrunAsUserName,tolerationsandhostLogPathrender together as documentedMarked experimental: it is off by default and has not yet run on a live Windows node group.
🤖 Generated with Claude Code