doc: add Kubernetes deployment guide with Helm chart options #209
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,92 @@ | ||||||
| --- | ||||||
| description: Learn how to deploy Flowise on Kubernetes using Helm | ||||||
| --- | ||||||
|
|
||||||
| # Kubernetes | ||||||
|
|
||||||
| *** | ||||||
|
|
||||||
| Deploy Flowise on Kubernetes using community-maintained Helm charts. | ||||||
|
|
||||||
| ## HelmForge Chart | ||||||
|
|
||||||
| [HelmForge](https://helmforge.dev) provides a Helm chart that supports both standalone and queue deployment modes. | ||||||
|
|
||||||
| * Chart source: [github.com/helmforgedev/charts](https://github.com/helmforgedev/charts/tree/main/charts/flowise) | ||||||
| * ArtifactHub: [artifacthub.io/packages/helm/helmforge/flowise](https://artifacthub.io/packages/helm/helmforge/flowise) | ||||||
|
|
||||||
| ### Prerequisites | ||||||
|
|
||||||
| * A running Kubernetes cluster (v1.26+) | ||||||
| * [Helm](https://helm.sh/docs/intro/install/) v3 installed | ||||||
|
|
||||||
| ### Install | ||||||
|
|
||||||
| ```bash | ||||||
| helm repo add helmforge https://repo.helmforge.dev | ||||||
| helm repo update | ||||||
| helm install flowise helmforge/flowise | ||||||
| ``` | ||||||
|
|
||||||
| Or install directly from the OCI registry: | ||||||
|
|
||||||
| ```bash | ||||||
| helm install flowise oci://ghcr.io/helmforgedev/helm/flowise | ||||||
| ``` | ||||||
|
|
||||||
| ### Standalone Mode (default) | ||||||
|
|
||||||
| The default installation runs Flowise as a single Deployment with SQLite and local storage. This is suitable for evaluation and small workloads. | ||||||
|
|
||||||
| ### Queue Mode | ||||||
|
|
||||||
| For scalable production deployments, enable queue mode with separate main and worker pods backed by Redis and PostgreSQL: | ||||||
|
|
||||||
| ```bash | ||||||
| helm install flowise helmforge/flowise \ | ||||||
| --set architecture=queue \ | ||||||
| --set postgresql.enabled=true \ | ||||||
| --set redis.enabled=true | ||||||
| ``` | ||||||
|
|
||||||
| Queue mode deploys: | ||||||
|
|
||||||
| * **Main pod** — serves the web UI and API | ||||||
| * **Worker pods** — process AI execution tasks from the Redis queue | ||||||
| * **PostgreSQL** — persistent database (bundled subchart or external) | ||||||
| * **Redis** — message queue (bundled subchart or external) | ||||||
|
|
||||||
| ### Ingress | ||||||
|
|
||||||
| Enable ingress to expose the Flowise UI: | ||||||
|
|
||||||
| ```yaml | ||||||
| # values.yaml | ||||||
| ingress: | ||||||
| enabled: true | ||||||
| ingressClassName: nginx | ||||||
| hosts: | ||||||
| - host: flowise.example.com | ||||||
| paths: | ||||||
| - path: / | ||||||
| pathType: Prefix | ||||||
| tls: | ||||||
| - secretName: flowise-tls | ||||||
| hosts: | ||||||
| - flowise.example.com | ||||||
| ``` | ||||||
|
|
||||||
| ```bash | ||||||
| helm install flowise helmforge/flowise -f values.yaml | ||||||
|
Contributor
There was a problem hiding this comment. The
Suggested change
|
||||||
| ``` | ||||||
|
|
||||||
| For full configuration options and architecture details, see the [chart documentation](https://helmforge.dev/docs/charts/flowise). | ||||||
|
|
||||||
| ## Cowboysysop Chart | ||||||
|
|
||||||
| An alternative community chart is available from [cowboysysop](https://artifacthub.io/packages/helm/cowboysysop/flowise). | ||||||
|
|
||||||
| ```bash | ||||||
| helm repo add cowboysysop https://cowboysysop.github.io/charts/ | ||||||
| helm install flowise cowboysysop/flowise | ||||||
| ``` | ||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better readability and clarity, consider using more descriptive link texts instead of repeating parts of the URLs. This helps users understand the destination of the link at a glance.