[DOCS-14989] Break up EUDM setup guide into pages per OS - #38311
[DOCS-14989] Break up EUDM setup guide into pages per OS#38311evazorro wants to merge 18 commits into
Conversation
Preview links (active after the
|
This comment has been minimized.
This comment has been minimized.
Old - thanks for removing it from the draft. I've asked the team to remove it from the conf yaml example if its still in there.
Let's state to use the most recent version everywhere. I believe its 7.80 but might be 7.81 by the time this is merged.
It should match Datadog's Mac Agent min version, which is 11. |
Co-authored-by: Erica Ho <109224841+eho1307@users.noreply.github.com>
eho1307
left a comment
eho1307
left a comment
There was a problem hiding this comment.
Approved pending the last two comments
|
@eho1307 thanks! Last couple things before docs team review + merge:
|
|
yes please list them! cc @jack0x2 |
|
|
||
| 1. In Datadog, navigate to [{{< ui >}}Fleet Automation{{< /ui >}} > {{< ui >}}Install Agents{{< /ui >}} > {{< ui >}}Windows{{< /ui >}}][102]. | ||
| 1. Click {{< ui >}}Select API Key{{< /ui >}} and choose an API key. | ||
| 1. Copy the provided installation command beginning with `[System.Net.ServicePointManager]::SecurityProtocol =`. |
There was a problem hiding this comment.
cross-referencing the SecurityProtocol partial PowerShell snippet like this is kind of cryptic.
I'd prefer to include a screenshot or simply duplicate the install command here as we do on other EUDM docs tabs.
Duplicating the installation command may be preferable for the moment because the Fleet Automation setup page does not currently include a "End User Device" toggle to add the (already supported) $env:DD_INFRASTRUCTURE_MODE="end_user_device" install time option, which we should prefer over asking the customer to manually add the option to datadog.yaml
There was a problem hiding this comment.
The reason I didn't include the full command is that Datadog constructs it with your selected API key and site filled in, so it's better if users copy it directly from there.
I didn't realize the end user device environment variable isn't included in that command, though. Personally, I would prioritize adding it to the Fleet Automation UI rather than working around it in the docs by asking readers to modify a command before running it. (Plus most of the time, people will just copy-paste without reading or modifying!)
| Write-Host 'Datadog Agent uninstalled.' | ||
| ``` | ||
|
|
||
| ### Enable Network Path (optional) |
There was a problem hiding this comment.
why do we have different Network Path instructions between the two tabs? Shouldn't we standardize on one method, preferably using Fleet Automation?
There was a problem hiding this comment.
It depends what we want to show: as I understand it, the purpose of the MDM tab content is to show how you can use Intune (or other MDMs) to deploy EUDM to many devices at once. If we prefer that people use Fleet Automation to turn on additional features like network path, rather than packaging it as part of the initial MDM deploy, then we should show that.
This is perhaps a question for your team, or for @eho1307.
| - **Status** is `Running`. | ||
| - `infrastructure_mode: end_user_device` is set. | ||
|
|
||
| 1. In Datadog, go to [**Infrastructure** > **End User Devices**][103]. Your device appears within 5-10 minutes. If it does not appear after 15 minutes, verify your API key and confirm that the configuration was saved and the Agent was restarted. |
There was a problem hiding this comment.
each item in the Verify the installation section is numbered 1., the numbering does not continue.
There was a problem hiding this comment.
Markdown allows using all 1.s in source and it will automatically number the list for you when rendering.
I think what you're pointing out here though is that there's a misalignment in the follow-on items, which is breaking the list into two. I'll fix that.
| - **Status** is `Running`. | ||
| - `infrastructure_mode: end_user_device` is set. | ||
|
|
||
| 1. In Datadog, go to [**Infrastructure** > **End User Devices**][103]. Your device appears within 5-10 minutes. If it does not appear after 15 minutes, verify your API key and confirm that the configuration was saved and the Agent was restarted. |
There was a problem hiding this comment.
lets put the fleet automation link first, the Agent status output is quite verbose and you have to scroll up a lot to get the the relevant section, which is output first.
There was a problem hiding this comment.
Yup, that's why I asked about a filtered version of the command here: https://docs.google.com/document/d/1J0XESPBbl0uJBqMYItPvMVIGMDORfeKqGO_GNDf9gII/edit?disco=AAAB_-04RWM
| ``` | ||
|
|
||
| 1. Navigate to {{< ui >}}Settings{{< /ui >}}. | ||
| 1. Add a new parameter to the end of the YAML file: |
There was a problem hiding this comment.
Instead of launching the gui we should use the DD_INFRASTRUCTURE_MODE="end_user_device" arg during the running of the install script.
There was a problem hiding this comment.
This involves the same issue as this comment: #38311 (comment)
Namely, it would be better if the user could just copy the full command from Datadog and use it as-is. However, right now there's no way to toggle including that setting in the command.
We can work around it in the docs, but it's the difference between
1. Choose your API key, then copy the command and run it.
and
1. Choose your API key.
2. Copy this command, change the API key to the one you just picked (displayed
in the UI), and also change DDSITE if your Datadog site is not US-1.
cc @eho1307
There was a problem hiding this comment.
We're a while away from adding it into Fleet so can we document it here?
Co-authored-by: Jack Phillips <jack.phillips@datadoghq.com>
4 participants
What does this PR do? What is the motivation?
Breaks up the EUDM setup page into multiple pages, each covering installing on a single device or multiple devices by operating system.
Open questions/todos
[RESOLVED - not waiting on Linux for this PR] Linux is currently commented out, waiting on draft copy from @eho1307.
[RESOLVED] There's an example config in the google doc draft for the macOS install that says network path tracing isn't supported for macOS. I'm assuming that's just old or a mistake, but I left that section out of the draft for now.
[RESOLVED] I found some discrepancies on minimum versions -- @eho1307 can you confirm?:
Minimum Datadog Agent version
Should these differ by OS, or should they all match?
macOS minimum OS version
Is 11 or 12 the minimum, and is it a hard requirement?
Merge readiness
AI assistance
Wrote a draft and compared it to Claude's version, borrowed some things from that. Used Claude to do the nav file hookup.
Additional notes