97 node migration#100
Merged
Merged
Conversation
…on into 97-node-migration # Conflicts: # src/versions/v0.0.12.md
Contributor
|
Warning Review limit reached
More reviews will be available in 48 minutes and 38 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR documents the FLAME Node Helm chart v0.1.0 release, a breaking-change version that restructures values configuration: Changesv0.1.0 Release and Configuration Migration
Sequence DiagramsequenceDiagram
participant Operator
participant Guide as Installation Guide
participant Helm as Helm Values
participant Cluster as K8s Cluster
Operator->>Guide: Review prerequisites (K8s, DNS)
Operator->>Guide: Prepare values.yaml with expose config
Operator->>Helm: Configure hub.auth.clientID/clientSecret
Operator->>Helm: Select expose.type: ingress|gateway|none
Operator->>Helm: Configure userIdp.provider and ui.idp
Operator->>Helm: Optionally enable dataStore subchart
Operator->>Cluster: Apply Helm chart with new values
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly Related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Closed
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/public/files/values_no_reverse_proxy_example.yaml (1)
15-20:⚠️ Potential issue | 🟠 Major | ⚡ Quick winUpdate this example to the v0.1.0 Keycloak values schema.
This sample still uses the pre-migration
keycloak.auth.adminUser/adminPasswordkeys, while the release notes in this PR move those credentials tokeycloakx.auth.adminUsername/adminPassword. As written, this example is inconsistent with the documented breaking change and is likely to misconfigure fresh installs.Suggested fix
-keycloak: +keycloakx: auth: - adminUser: admin + adminUsername: admin adminPassword: admin proxyHeaders: ""🤖 Prompt for 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. In `@src/public/files/values_no_reverse_proxy_example.yaml` around lines 15 - 20, The example YAML uses the old Keycloak keys keycloak.auth.adminUser and keycloak.auth.adminPassword; update it to the v0.1.0 schema by renaming the top-level key from keycloak to keycloakx and changing auth.adminUser to auth.adminUsername (leave the adminPassword key name as adminPassword), i.e., replace keycloak.auth.adminUser -> keycloakx.auth.adminUsername and keycloak -> keycloakx so the example matches the documented breaking change.
🤖 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`:
- Around line 7-9: Update stale "robot credentials" references to the new
terminology "client credentials": change the intro link target from
node-registration#robot-credentials to node-registration#client-credentials,
replace the phrase "Credentials for your node's robot were generated and saved"
with "Client credentials for your node were generated and saved", and update any
later mentions (e.g., the note about the values file containing "robot
credentials") to read "client credentials"; ensure you update both the block
around the initial list and the later occurrences referenced (lines ~223-224) so
all anchors and descriptive text consistently use client credentials.
- Around line 103-111: Update the wording that currently calls the Ingress API
“deprecated”: change the phrase to indicate the Ingress API is a stable/frozen
API (e.g., "the Ingress API is stable/frozen") and clarify that Gateway API is
recommended for newer features; update the sentence containing "Most kubernetes
distributions previously used only the Ingress API for routing traffic, but that
has been recently deprecated in favor of the new Gateway API" to instead state
that Ingress is stable/frozen while Gateway provides newer features and is the
recommended option, keeping the rest of the helm-chart guidance (supporting both
APIs and suggesting "ingress" if unsure) intact and keeping links to the Gateway
API install guide.
In `@src/guide/deployment/node-registration.md`:
- Line 64: Update the sentence that currently reads "required for the deploying
the FLAME Node" to correct grammar by changing it to "required for deploying the
FLAME Node"; locate the exact sentence in
src/guide/deployment/node-registration.md (the phrase "required for the
deploying the FLAME Node") and replace it with the corrected wording.
In `@src/versions/v0.0.11.md`:
- Around line 11-12: Replace the ambiguous link text "[here]" in the sentence
about private buckets with a descriptive title using the destination page's
title ("Bucket setup for data store" or the page's exact title from the docs) so
the changelog link is accessible and markdownlint-compliant; update the sentence
that currently contains the link to use that descriptive text for the URL (refer
to the line mentioning "Full documentation on how to do this can be found
[here](https://docs.privateaim.net/guide/admin/bucket-setup-for-data-store.html)").
In `@src/versions/v0.1.0.md`:
- Around line 121-123: Duplicate mapping for `.dataStore.minio` appears twice in
the migration table; remove the redundant entry so only one `.dataStore.minio`
row remains (keep the `.victorialogs.ingress.enabled` row intact) and ensure
table alignment/spacing stays consistent after deleting the duplicate line.
---
Outside diff comments:
In `@src/public/files/values_no_reverse_proxy_example.yaml`:
- Around line 15-20: The example YAML uses the old Keycloak keys
keycloak.auth.adminUser and keycloak.auth.adminPassword; update it to the v0.1.0
schema by renaming the top-level key from keycloak to keycloakx and changing
auth.adminUser to auth.adminUsername (leave the adminPassword key name as
adminPassword), i.e., replace keycloak.auth.adminUser ->
keycloakx.auth.adminUsername and keycloak -> keycloakx so the example matches
the documented breaking change.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: cc0987f1-cdb8-4fe7-a015-e161bd581b1d
📒 Files selected for processing (9)
src/.vitepress/routes/sidebar/versions.tssrc/guide/admin/data-store-management.mdsrc/guide/deployment/node-installation.mdsrc/guide/deployment/node-registration.mdsrc/public/files/values_no_reverse_proxy_example.yamlsrc/public/files/values_separate_idp.yamlsrc/versions/v0.0.10.mdsrc/versions/v0.0.11.mdsrc/versions/v0.1.0.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Documentation