[hotfix] docs(flowker): add v2.1 upgrade guide#1381
Open
gandalf-at-lerian wants to merge 1 commit into
Open
Conversation
Requested-by: @guimoreirar
WalkthroughThis pull request adds a new Helm chart upgrade documentation file ( ChangesFlowker Upgrade Documentation
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@charts/flowker/docs/UPGRADE-2.1.md`:
- Around line 21-52: Add a clear distinction between required and optional new
config values by annotating each key (e.g., flowker.secrets.MONGO_URI,
flowker.secrets.AUDIT_DB_PASSWORD,
flowker.configmap.AUDIT_DB_HOST/AUDIT_DB_NAME/AUDIT_DB_PORT) as "required" if
needed for core functionality or migration, and group feature flags (e.g.,
flowker.configmap.MULTI_TENANT_ENABLED,
flowker.configmap.FAULT_INJECTION_ENABLED,
flowker.configmap.SKIP_LIB_COMMONS_TELEMETRY,
flowker.configmap.SSRF_ALLOW_PRIVATE) into a separate "optional / feature flags"
subsection; explicitly call out connection-related values (MONGO_URI,
MULTI_TENANT_REDIS_HOST/PORT/PASSWORD, AUDIT_DB_*) and migration path
(flowker.configmap.AUDIT_MIGRATIONS_PATH) as required for successful upgrade
steps, and include a short note on defaults and when each optional flag must be
set.
- Line 3: The header line containing the concatenated topic links
("**[Overview](`#overview`)**- **[Version changes](`#version-changes`)**...") should
be split into a readable list; update the string in UPGRADE-2.1.md by replacing
the single concatenated line with either a bulleted list or separate lines so
each link is on its own line (e.g., "- **[Overview](`#overview`)**", "- **[Version
changes](`#version-changes`)**", etc.), preserving the existing Markdown link text
and anchors and removing the run-together hyphens so links render clearly.
🪄 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: ASSERTIVE
Plan: Pro
Run ID: 99d11e54-7c64-4fc4-859e-5356d0d4e9b2
📒 Files selected for processing (1)
charts/flowker/docs/UPGRADE-2.1.md
| @@ -0,0 +1,131 @@ | |||
| # Helm Upgrade from v2.0.x to v2.1.x | |||
| ## Topics | |||
| - **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Template changes](#template-changes)**- **[Migration steps](#migration-steps)**- **[Preview changes before upgrading](#preview-changes-before-upgrading)**- **[Command to upgrade](#command-to-upgrade)** | |||
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial | 💤 Low value
Consider formatting the topic links for better readability.
The topic links are concatenated on a single line. Consider formatting them as a bulleted list or adding line breaks between links to improve readability.
📖 Suggested formatting improvement
-## Topics
-- **[Overview](`#overview`)**- **[Version changes](`#version-changes`)**- **[Configuration changes](`#configuration-changes`)**- **[Template changes](`#template-changes`)**- **[Migration steps](`#migration-steps`)**- **[Preview changes before upgrading](`#preview-changes-before-upgrading`)**- **[Command to upgrade](`#command-to-upgrade`)**
+## Topics
+- **[Overview](`#overview`)**
+- **[Version changes](`#version-changes`)**
+- **[Configuration changes](`#configuration-changes`)**
+- **[Template changes](`#template-changes`)**
+- **[Migration steps](`#migration-steps`)**
+- **[Preview changes before upgrading](`#preview-changes-before-upgrading`)**
+- **[Command to upgrade](`#command-to-upgrade`)**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Template changes](#template-changes)**- **[Migration steps](#migration-steps)**- **[Preview changes before upgrading](#preview-changes-before-upgrading)**- **[Command to upgrade](#command-to-upgrade)** | |
| - **[Overview](`#overview`)** | |
| - **[Version changes](`#version-changes`)** | |
| - **[Configuration changes](`#configuration-changes`)** | |
| - **[Template changes](`#template-changes`)** | |
| - **[Migration steps](`#migration-steps`)** | |
| - **[Preview changes before upgrading](`#preview-changes-before-upgrading`)** | |
| - **[Command to upgrade](`#command-to-upgrade`)** |
🤖 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 `@charts/flowker/docs/UPGRADE-2.1.md` at line 3, The header line containing the
concatenated topic links ("**[Overview](`#overview`)**- **[Version
changes](`#version-changes`)**...") should be split into a readable list; update
the string in UPGRADE-2.1.md by replacing the single concatenated line with
either a bulleted list or separate lines so each link is on its own line (e.g.,
"- **[Overview](`#overview`)**", "- **[Version changes](`#version-changes`)**",
etc.), preserving the existing Markdown link text and anchors and removing the
run-together hyphens so links render clearly.
Comment on lines
+21
to
+52
| ```yaml | ||
| flowker.configmap.AUDIT_DB_HOST: "" | ||
| flowker.configmap.AUDIT_DB_NAME: "flowker_audit" | ||
| flowker.configmap.AUDIT_DB_PORT: "5432" | ||
| flowker.configmap.AUDIT_DB_SSL_MODE: "disable" | ||
| flowker.configmap.AUDIT_DB_USER: "flowker_audit" | ||
| flowker.configmap.AUDIT_MIGRATIONS_PATH: "/migrations" | ||
| flowker.configmap.DEPLOYMENT_MODE: "local" | ||
| flowker.configmap.FAULT_INJECTION_ENABLED: "false" | ||
| flowker.configmap.MULTI_TENANT_ALLOW_INSECURE_HTTP: "false" | ||
| flowker.configmap.MULTI_TENANT_CACHE_TTL_SEC: "120" | ||
| flowker.configmap.MULTI_TENANT_CIRCUIT_BREAKER_THRESHOLD: "5" | ||
| flowker.configmap.MULTI_TENANT_CIRCUIT_BREAKER_TIMEOUT_SEC: "30" | ||
| flowker.configmap.MULTI_TENANT_CONNECTIONS_CHECK_INTERVAL_SEC: "30" | ||
| flowker.configmap.MULTI_TENANT_ENABLED: "false" | ||
| flowker.configmap.MULTI_TENANT_IDLE_TIMEOUT_SEC: "300" | ||
| flowker.configmap.MULTI_TENANT_MAX_TENANT_POOLS: "100" | ||
| flowker.configmap.MULTI_TENANT_REDIS_HOST: "" | ||
| flowker.configmap.MULTI_TENANT_REDIS_PORT: "6379" | ||
| flowker.configmap.MULTI_TENANT_REDIS_TLS: "false" | ||
| flowker.configmap.MULTI_TENANT_TIMEOUT: "30" | ||
| flowker.configmap.MULTI_TENANT_URL: "" | ||
| flowker.configmap.PLUGIN_AUTH_ADDRESS: "" | ||
| flowker.configmap.PLUGIN_AUTH_ENABLED: "false" | ||
| flowker.configmap.SKIP_LIB_COMMONS_TELEMETRY: "false" | ||
| flowker.configmap.SSRF_ALLOW_PRIVATE: "false" | ||
| flowker.secrets.AUDIT_DB_PASSWORD: "lerian" | ||
| flowker.secrets.MONGO_TLS_CA_CERT: "" | ||
| flowker.secrets.MONGO_URI: "mongodb://flowker:lerian@flowker-mongodb:27017/flowker?authSource=flowker" | ||
| flowker.secrets.MULTI_TENANT_REDIS_PASSWORD: "" | ||
| flowker.secrets.MULTI_TENANT_SERVICE_API_KEY: "" | ||
| ``` |
There was a problem hiding this comment.
Clarify which new values are required versus optional.
The "Added values" section lists many new configuration options, but the documentation doesn't clearly indicate which values are required for a successful upgrade versus which are optional feature flags. Consider adding annotations or a separate subsection to distinguish required values (e.g., MONGO_URI in secrets) from optional feature configurations (e.g., MULTI_TENANT_ENABLED, FAULT_INJECTION_ENABLED).
This would help users prioritize their configuration review during migration step 3.
🧰 Tools
🪛 Betterleaks (1.2.0)
[high] 49-49: Detected a MongoDB connection string with embedded credentials, potentially exposing direct database access and sensitive application data.
(mongodb-connection-string)
🤖 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 `@charts/flowker/docs/UPGRADE-2.1.md` around lines 21 - 52, Add a clear
distinction between required and optional new config values by annotating each
key (e.g., flowker.secrets.MONGO_URI, flowker.secrets.AUDIT_DB_PASSWORD,
flowker.configmap.AUDIT_DB_HOST/AUDIT_DB_NAME/AUDIT_DB_PORT) as "required" if
needed for core functionality or migration, and group feature flags (e.g.,
flowker.configmap.MULTI_TENANT_ENABLED,
flowker.configmap.FAULT_INJECTION_ENABLED,
flowker.configmap.SKIP_LIB_COMMONS_TELEMETRY,
flowker.configmap.SSRF_ALLOW_PRIVATE) into a separate "optional / feature flags"
subsection; explicitly call out connection-related values (MONGO_URI,
MULTI_TENANT_REDIS_HOST/PORT/PASSWORD, AUDIT_DB_*) and migration path
(flowker.configmap.AUDIT_MIGRATIONS_PATH) as required for successful upgrade
steps, and include a short note on defaults and when each optional flag must be
set.
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
Requested by: @guimoreirar