How to deploy a node with Argo/FluxCD

[brucetony]

Summary by CodeRabbit

• Documentation
  • Expanded the deployment guide with clearer Kubernetes and Helm setup instructions.
  • Added guidance for routing, RBAC, proxies, certificates, storage, hostnames, and port forwarding.
  • Documented ArgoCD/CD deployment requirements, including Kubernetes Secrets and Helm configuration.
  • Added troubleshooting and configuration guidance for Gateway API checks, offline mode, storage classes, and optional node data stores.

[coderabbitai]

Warning

Review limit reached

@brucetony, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 42 minutes

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

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ce2ff15e-7508-4114-b2e5-cca2419707cd

📥 Commits

Reviewing files that changed from the base of the PR and between 3a5d4d0 and e8b9815.

📒 Files selected for processing (1)

• src/guide/deployment/node-installation.md

📝 Walkthrough

Walkthrough

The deployment guide was reformatted and expanded with Kubernetes, routing, RBAC, proxy, certificate, storage, hostname, port-forwarding, and CD deployment guidance. It adds required pre-generated Secrets and Helm values for ArgoCD and other CD workflows.

Changes

Deployment guide

Layer / File(s)	Summary
Deployment foundations and access src/guide/deployment/node-installation.md	The guide updates Kubernetes and Helm setup, routing, Gateway API validation, Keycloak, RBAC, and external identity-provider configuration.
Network, storage, and local access src/guide/deployment/node-installation.md	The guide expands proxy and certificate settings, storage-class examples, port forwarding, and manual hostname mapping.
CD deployment secrets and data store src/guide/deployment/node-installation.md	The guide documents pre-generated Kubernetes Secrets, Helm references for CD deployments, and optional node data-store settings.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• PrivateAIM/documentation#100: Continues deployment documentation for routing, authentication, secrets, and data-store settings.
• PrivateAIM/documentation#104: Expands related storage-class and node data-store documentation.

Suggested reviewers: sirherr

🚥 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 identifies the main documentation change: deploying a node with ArgoCD or FluxCD.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 💡 1

⚔️ Resolve merge conflicts 💡

• Resolve merge conflict in branch argo-secrets

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch argo-secrets

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 14

🤖 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/guide/deployment/node-installation.md`:
- Line 135: Update the RBAC heading to use the hyphenated wording “Role-Based
Access Control (RBAC)”.
- Around line 317-319: In the deployment documentation text, update the phrase
“pre-mature SSL termination” to “premature SSL termination” while leaving the
surrounding content unchanged.
- Around line 441-442: Correct the spelling in the FLAME Node deployment
guidance by changing “thee are” to “there are” in the sentence describing
configuration options for accessing the Node UI.
- Around line 513-514: In the hosts-file location sentence, replace the
incorrect phrase “and it Windows” with “and on Windows,” preserving the
surrounding Unix and Windows path guidance.
- Line 27: Update the Markdown link in the quick-start tip to replace the vague
“here” anchor with descriptive text identifying the microk8s and Helm
quick-start guide, while preserving the existing destination.
- Around line 576-579: Update the “Pregenerating Secrets” section to warn that
populated Kubernetes Secret manifests must never be committed, since base64
encoding is not confidential. State that committed manifests must contain
placeholders only, and recommend Sealed Secrets, External Secrets, or SOPS for
GitOps deployments.
- Around line 199-202: In the Node UI RBAC setup instructions, remove the extra
article in the sentence beginning “Once a the role,” changing it to “Once the
role” while leaving the surrounding guidance unchanged.
- Around line 164-165: Update the “Disabling RBAC” note to explicitly state that
setting roleClaimName to an empty string disables RBAC and grants authenticated
users full access.
- Around line 125-126: Update the gateway prerequisites section to check for an
installed and ready Gateway controller and an accepted GatewayClass in addition
to the existing Gateway API CRD commands. Only state that expose.type: "gateway"
is usable when all required checks pass; otherwise retain the unavailable
guidance.
- Around line 156-158: Align the deployment guide’s bundled-Keycloak RBAC
example and the warning around roleClaimName with the current flame-node chart
default of global_access.roles, or explicitly pin the guide to the chart version
using resource_access.node-ui.roles. Ensure the documented claim path and
warning consistently describe the default chart behavior, while retaining the
custom-IDP guidance.
- Around line 108-111: Update the Kubernetes routing description to characterize
the Ingress API as feature-frozen and still supported, rather than recently
deprecated; retain the recommendation of Gateway API for new capabilities and
the existing guidance about choosing an API.
- Around line 553-555: Update the deployment instructions around the
pregenerated Secret manifests to explicitly set the Helm release namespace with
--namespace <NAMESPACE>, or specify the equivalent destination namespace in
Argo/Flux examples, matching the namespace used by the Secret manifests.
- Around line 311-313: Update the noProxy guidance in the FLAME Node Kubernetes
installation documentation to describe entries as domains or hosts rather than
DNS A records, recommend adding the cluster DNS domain such as .cluster.local,
and remove the duplicated “the.”
- Around line 585-595: Update the Secret example under keycloakClientSecrets to
include the required nodeUiClientSecret data key alongside
hubAdapterClientSecret and podOrcClientSecret, using a base64-encoded value
placeholder.

🪄 Autofix

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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 53bcae2c-9ee0-486c-b9b8-b8e876aae594

📥 Commits

Reviewing files that changed from the base of the PR and between 5726a73 and 3a5d4d0.

📒 Files selected for processing (1)

• src/guide/deployment/node-installation.md