Skip to content

[hotfix] docs(flowker): add v2.1 upgrade guide #1381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gandalf-at-lerian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[hotfix] docs(flowker): add v2.1 upgrade guide #1381

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 131 additions & 0 deletions charts/flowker/docs/UPGRADE-2.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)**
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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.


## Overview
This guide covers the `flowker` chart upgrade from `2.0.0` to `2.1.0-beta.6`. It was generated retroactively from the chart history and focuses on minor version changes; patch-only releases are intentionally ignored.

Because this is a minor upgrade, the expected path is an in-place Helm upgrade after reviewing new values and changed defaults.

## Version changes

| Field | Previous | Current |
|-------|----------|---------|
| Chart version | `2.0.0` | `2.1.0-beta.6` |
| App version | `1.0.0` | `1.0.0` |

## Configuration changes

### Added values

```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: ""
```
Comment on lines +21 to +52
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.


### Removed values

```yaml
flowker.configmap.MONGO_APP_USER: "flowker"
flowker.configmap.MONGO_CONNECT_TIMEOUT_MS: "10000"
flowker.configmap.MONGO_HOST: "flowker-mongodb"
flowker.configmap.MONGO_MAX_IDLE_TIME_MS: "60000"
flowker.configmap.MONGO_MIN_POOL_SIZE: "5"
flowker.configmap.MONGO_PORT: "27017"
flowker.configmap.MONGO_SOCKET_TIMEOUT_MS: "30000"
flowker.configmap.MONGO_URI: "mongodb://flowker:lerian@flowker-mongodb:27017/flowker?authSource=admin"
flowker.secrets.MONGO_APP_PASSWORD: "lerian"
```

### Changed operational values

```yaml
# flowker.configmap.MONGO_MAX_POOL_SIZE
# previous: "10"
# current: "20"
# flowker.configmap.SERVER_ADDRESS
# previous: ":4000"
# current: ":4021"
# flowker.configmap.SERVER_PORT
# previous: "4000"
# current: "4021"
# flowker.configmap.SWAGGER_HOST
# previous: ":4000"
# current: ":4021"
# flowker.service.port
# previous: 4000
# current: 4021
```

## Template changes

### Added files

- No chart files added.

### Removed files

- No chart files removed.

### Modified files

- `charts/flowker/CHANGELOG.md`
- `charts/flowker/Chart.yaml`
- `charts/flowker/README.md`
- `charts/flowker/templates/configmap.yaml`
- `charts/flowker/templates/deployment.yaml`
- `charts/flowker/templates/secrets.yaml`
- `charts/flowker/values-template.yaml`
- `charts/flowker/values.yaml`

## Migration steps

1. Read this guide and compare your custom values against `charts/flowker/values.yaml`.
2. Remove values that no longer exist in the chart before running the upgrade.
3. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings.
4. Render the chart locally with your production values and review the manifest diff.
5. Apply the upgrade in a controlled environment before production.

## Preview changes before upgrading

```bash
helm diff upgrade flowker ./charts/flowker \
--namespace <namespace> \
--values <your-values.yaml>
```

## Command to upgrade

```bash
helm upgrade flowker ./charts/flowker \
--namespace <namespace> \
--values <your-values.yaml>
```
Loading