Skip to content

docs: add rootless UBI client installation guide - #973

Open
jnfrati wants to merge 1 commit into
mainfrom
feat/rootless-ubi-docs
Open

jnfrati wants to merge 1 commit into
mainfrom
feat/rootless-ubi-docs

Conversation

@jnfrati

@jnfrati jnfrati commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a dedicated rootless UBI installation page, an installation-sidebar entry, and a link from the Docker guide's Rootless Image section.
  • Use ghcr.io/netbirdio/netbird:0.79.0-rootless-ubi by default, document AMD64/ARM64 support, and note that Docker Hub publication is pending.
  • Source-verify image defaults, entrypoint, state paths, health checks, and networking behavior with pinned upstream references.
  • Include Podman/Docker and Kubernetes/OpenShift examples without privileged mode, custom SCCs, or added Linux capabilities.
  • Cover setup keys, self-hosted management URLs, persistent identity and UID ownership, routing peers, SOCKS5, DNS, and ICMP limitations.

Validation

  • npm run lint:mdx — passed (297 MDX files).
  • npm run build — passed.
  • YAML examples parsed; restricted pod security constraints checked.
  • Production preview checked in a browser, including the updated version, sidebar navigation, and Docker cross-link.
  • GHCR 0.79.0 manifest checked for AMD64/ARM64 platforms and source revision.

Container and OpenShift execution were not tested; the local Docker daemon was unavailable.

Summary by CodeRabbit

  • Documentation
    • Added a new Rootless UBI installation guide covering Podman, Docker, Kubernetes, and OpenShift deployments.
    • Documented configuration, persistent state, readiness checks, routing-peer usage, and rootless networking limitations.
    • Added a link to the guide in the Install NetBird documentation navigation.
    • Added a cross-reference from the Docker rootless image documentation.

@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 11, 2026 5:30pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 32 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: bf5c542c-64d8-43c9-9af7-a5337608e7ad

📥 Commits

Reviewing files that changed from the base of the PR and between 8d39df9 and 523bac2.

📒 Files selected for processing (1)
  • src/pages/get-started/install/rootless-ubi.mdx

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: d4593b30-25ca-4751-9595-e98f3e509e2d

📥 Commits

Reviewing files that changed from the base of the PR and between b046b65 and 8d39df9.

📒 Files selected for processing (3)
  • src/components/NavigationDocs.jsx
  • src/pages/get-started/install/docker.mdx
  • src/pages/get-started/install/rootless-ubi.mdx

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Adds a Rootless UBI installation page, links it from the Install NetBird menu, and cross-references it from the Docker installation guide. The page covers image configuration, local and cluster deployment, persistent state, readiness checks, routing peers, and limitations.

Changes

Rootless UBI documentation

Layer / File(s) Summary
Image contract and local usage
src/pages/get-started/install/rootless-ubi.mdx, src/pages/get-started/install/docker.mdx, src/components/NavigationDocs.jsx
Documents the image tags, defaults, environment variables, entrypoint behavior, local Podman or Docker usage, and navigation links.
Cluster deployment and lifecycle
src/pages/get-started/install/rootless-ubi.mdx
Documents Kubernetes and OpenShift deployment manifests, security contexts, persistent state, single-writer usage, and readiness checks.
Routing behavior and limitations
src/pages/get-started/install/rootless-ubi.mdx
Documents routing-peer setup, userspace forwarding, SOCKS5 access, and rootless UBI limitations.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Other

Suggested reviewers: sunsetdrifter

Merge Risk: ⚪ Minimal · up to 8d39d

The new installation guide and navigation do not present a concrete merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a rootless UBI client installation guide.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/rootless-ubi-docs

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.

❤️ Share

A rabbit hops through rootless land
With UBI tucked close at hand
No TUN, no cap, just paths to run
Persistent state beneath the sun
Docs now guide each careful step

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant