Skip to content

[NCM] Add public docs for rollbacks#38224

Open
zoedt wants to merge 5 commits into
masterfrom
zoe/ncm-rollbacks
Open

[NCM] Add public docs for rollbacks#38224
zoedt wants to merge 5 commits into
masterfrom
zoe/ncm-rollbacks

Conversation

@zoedt

@zoedt zoedt commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

  • we are adding public docs for releasing ncm rollbacks
  • doc for setting up based from here
  • rfc for rollbacks in general here + subsets of more documents underneath that main one

Merge readiness

  • create first draft
  • fill in TODOs
  • screenshots
  • approvals / address feedback
  • Ready for merge

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
  • 🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

AI assistance

Additional notes

@github-actions

Copy link
Copy Markdown
Contributor

@zoedt
zoedt marked this pull request as ready for review July 16, 2026 17:23
@zoedt
zoedt requested a review from a team as a code owner July 16, 2026 17:23
@zoedt

zoedt commented Jul 16, 2026

Copy link
Copy Markdown
Contributor Author

/review

### Private Action Runner

1. [Set up a Private Action Runner][1] on a host that the Agent's IPC port can reach.
2. Enable the `com.datadoghq.remoteaction.networkconfigmanagement` remote action bundle on the runner.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC when you enable the private action runner in your datadog.yaml you also need to provide a list of allowed actions, which has to explicitly contain com.datadoghq.remoteaction.networkconfigmanagement.rollbackConfig.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

double checked their public docs and amended list item 2, lemme know if that sounds more accurate? ty for the pointer!!

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Automated review by Claude. AI-generated; verify before acting.

Thanks for the new rollback docs. Blocking items before merge:

  • Two image alt attributes still say TODO: describe what this screenshot shows — please add real alt text for accessibility.
  • The image path exeuction_group_policy.png looks like a typo for execution_group_policy.png; please double-check the uploaded asset name.
  • Aruba (EOS) in the supported vendors list appears incorrect — the profile table in config_management.md lists EOS under Arista, and Aruba under AOS-CX / AOS-W.
  • The new page isn't wired into config/_default/menus/main.en.yaml, so it won't appear in the left nav under NDM > Configuration Management. Please add a menu entry (or confirm this page is intentionally discoverable only via cross-links).

A couple of smaller style nits inline as well.

Reviewed 5c21b19322ced31e9f1632c6c35b4fd8a9ff7199workflow run

Comment thread content/en/network_monitoring/devices/config_management_rollback.md Outdated
Comment thread content/en/network_monitoring/devices/config_management_rollback.md Outdated
Comment thread content/en/network_monitoring/devices/config_management_rollback.md Outdated
Comment thread content/en/network_monitoring/devices/config_management_rollback.md Outdated
Comment thread content/en/network_monitoring/devices/config_management_rollback.md Outdated
Comment thread content/en/network_monitoring/devices/config_management_rollback.md Outdated
{{< partial name="whats-next/whats-next.html" >}}

[1]: /actions/private_actions/
[2]: /network_monitoring/devices/config_management/#viewing-configurations

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: This new page doesn't appear in config/_default/menus/main.en.yaml. Users landing on the parent NCM page can follow the cross-link, but the rollback page won't be reachable from the left-nav. Consider adding an entry under ndm_config_management so it's discoverable in the side-nav.

@joepeeples joepeeples assigned joepeeples and unassigned joepeeples Jul 16, 2026
@joepeeples joepeeples added the WORK IN PROGRESS No review needed, it's a wip ;) label Jul 16, 2026
@joepeeples

Copy link
Copy Markdown
Contributor

Hi @zoedt, I added the Work In Progress label to this PR since it's still incomplete (needs screenshots, add page to the navigation menu, etc.). When the PR is fully complete and ready for review, you can remove the label and someone from the Docs team will review it then. Thanks!

@datadog-datadog-prod-us1-2

datadog-datadog-prod-us1-2 Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Pipelines

⚠️ Warnings

🚦 1 Pipeline job failed

DataDog/documentation | build_preview   View in Datadog   GitLab

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 82b3caa | Docs | Datadog PR Page | Give us feedback!

@github-actions github-actions Bot added the Images Images are added/removed with this PR label Jul 17, 2026
@zoedt zoedt removed the WORK IN PROGRESS No review needed, it's a wip ;) label Jul 17, 2026
@joepeeples

Copy link
Copy Markdown
Contributor

Opened DOCS-15135 to assign a Docs writer and follow up with editorial review.

@joepeeples joepeeples added the editorial review Waiting on a more in-depth review label Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorial review Waiting on a more in-depth review Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants