docs: add Ansible IaC guide for tenant configuration#759
Conversation
📝 WalkthroughWalkthroughAdds a new documentation page for managing NetBird resources declaratively via the community.ansible_netbird Ansible collection, including prerequisites, authentication, an example playbook, module reference, and troubleshooting. Wires the page into site navigation and cross-links it from the automated-setup guide. ChangesAnsible Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
src/components/NavigationDocs.jsxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON src/pages/selfhosted/automated-setup.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON src/pages/selfhosted/iac/ansible.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
8d94e74 to
be642f9
Compare
Document the community.ansible_netbird collection for managing NetBird resources (users, groups, setup keys, policies, networks, DNS, posture checks) declaratively via the REST API. Adds a new Infrastructure as Code subsection under Self-Host NetBird with room for future entries. Cross-links from the Automated Setup PAT bootstrap page since the collection is the natural next step after obtaining the first token.
be642f9 to
7c86bd0
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/pages/selfhosted/iac/ansible.mdx`:
- Around line 1-160: The docs page currently links the NetBird REST API to a
stale internal path, so update the reference in the description/introduction
content to the existing public API docs target instead. Fix the markdown link
that points to the API introduction from the `description` export or nearby
prose in `ansible.mdx`, and use the public API page path already used elsewhere
in the site (or add a redirect if that’s the chosen docs pattern).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 87a1a4f8-6806-4cab-a0b0-782d50c7e7b0
📒 Files selected for processing (3)
src/components/NavigationDocs.jsxsrc/pages/selfhosted/automated-setup.mdxsrc/pages/selfhosted/iac/ansible.mdx
Summary
/selfhosted/iac/ansible, documenting thecommunity.ansible_netbirdcollection for managing tenant resources (users, groups, setup keys, policies, networks, DNS, posture checks, IdPs) declaratively against the REST API.selfhosted/automated-setup.mdxso operators who just minted their first PAT see the declarative next step.Scope notes
manage/peers/register-machines-using-setup-keys.mdx.examples/instead of mirroring playbooks that would rot.Summary by CodeRabbit
New Features
Documentation