Skip to content

Adjust misleading macOS Agent version documentation#676

Merged
swang392 merged 1 commit intomainfrom
regis.desgroppes/adjust-misleading-macos-agent-version-doc
Oct 8, 2025
Merged

Adjust misleading macOS Agent version documentation#676
swang392 merged 1 commit intomainfrom
regis.desgroppes/adjust-misleading-macos-agent-version-doc

Conversation

@rdesgroppes
Copy link
Copy Markdown
Collaborator

@rdesgroppes rdesgroppes commented Oct 8, 2025

After merging #664, I realized the change I introduced to a table could be misinterpreted as suggesting that users should set datadog_agent_major_version to values like 7.69- or 7.70+, when in fact only 6 or 7 are valid inputs:

When the variable datadog_macos_download_url is not set, the official macOS DMG package corresponding to the datadog_agent_major_version is used:

Agent version Default macOS DMG package URL
6 https://install.datadoghq.com/datadog-agent-6-latest.dmg
7.69- https://install.datadoghq.com/datadog-agent-7-latest.dmg
7.70+ (Intel Mac) https://install.datadoghq.com/datadog-agent-7-latest.x86_64.dmg
7.70+ (Apple Silicon) https://install.datadoghq.com/datadog-agent-7-latest.arm64.dmg

Close to its former state, the proposed table aims at preventing confusion by separating user-provided configuration values from automatic resolution logic (where version ranges like 7.69- or 7.70+ are informational only):

Agent version Default macOS DMG package URL
6 https://install.datadoghq.com/datadog-agent-6-latest.dmg
7 https://install.datadoghq.com/datadog-agent-7-latest.dmg (7.69-)
https://install.datadoghq.com/datadog-agent-7-latest.x86_64.dmg (7.70+, Intel Mac)
https://install.datadoghq.com/datadog-agent-7-latest.arm64.dmg (7.70+, Apple Silicon)

@rdesgroppes rdesgroppes force-pushed the regis.desgroppes/adjust-misleading-macos-agent-version-doc branch from 0b0baf6 to b12f686 Compare October 8, 2025 10:06
After merging #664, I realized the change I introduced to a table could
be misinterpreted as suggesting that users should set
`datadog_agent_major_version` to values like `7.69-` or `7.70+`, when in
fact only `6` or `7` are valid inputs:

> When the variable `datadog_macos_download_url` is not set, the official macOS DMG package corresponding to the `datadog_agent_major_version` is used:
>
> | Agent version         | Default macOS DMG package URL                                   |
> |-----------------------|-----------------------------------------------------------------|
> | 6                     | https://install.datadoghq.com/datadog-agent-6-latest.dmg        |
> | 7.69-                 | https://install.datadoghq.com/datadog-agent-7-latest.dmg        |
> | 7.70+ (Intel Mac)     | https://install.datadoghq.com/datadog-agent-7-latest.x86_64.dmg |
> | 7.70+ (Apple Silicon) | https://install.datadoghq.com/datadog-agent-7-latest.arm64.dmg  |

Close to its [former
state](https://github.com/DataDog/ansible-datadog/blob/e8eb1616e897639c52260cc801439d5bbe7c43df/README.md#macos),
the proposed table aims at preventing confusion by separating
user-provided configuration values from automatic resolution logic
(where version ranges like `7.69-` or `7.70+` are informational only):

> | Agent version | Default macOS DMG package URL                                                         |
> |---------------|---------------------------------------------------------------------------------------|
> | 6             | https://install.datadoghq.com/datadog-agent-6-latest.dmg                              |
> | 7             | https://install.datadoghq.com/datadog-agent-7-latest.dmg (7.69-)                      |
> |               | https://install.datadoghq.com/datadog-agent-7-latest.x86_64.dmg (7.70+, Intel Mac)    |
> |               | https://install.datadoghq.com/datadog-agent-7-latest.arm64.dmg (7.70+, Apple Silicon) |
@rdesgroppes rdesgroppes force-pushed the regis.desgroppes/adjust-misleading-macos-agent-version-doc branch from b12f686 to 4ca7461 Compare October 8, 2025 10:15
@rdesgroppes rdesgroppes marked this pull request as ready for review October 8, 2025 10:19
@rdesgroppes rdesgroppes requested review from a team as code owners October 8, 2025 10:19
@swang392 swang392 merged commit 9fc02c7 into main Oct 8, 2025
135 checks passed
@swang392 swang392 deleted the regis.desgroppes/adjust-misleading-macos-agent-version-doc branch October 8, 2025 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants