mirror of https://github.com/colanode/colanode.git synced 2025-12-16 03:37:51 +01:00

Files

Ylber Gashi af44d9bc16 Add Helm charts for Kubernetes self-hosting (#87 )

* Add Helm chart for Kubernetes deployment and reorganize hosting setup

- Created Helm chart for deploying Colanode on Kubernetes with PostgreSQL, Redis, and MinIO configurations
- Moved Docker Compose files to /hosting folder for better organization
- Added health check endpoints for database, Redis, and S3 services
- Introduced Dockerfile for PostgreSQL with pgvector extension to support Helm deployment
- Added GitHub Actions workflow for building and publishing Helm chart
- Updated README with Kubernetes deployment instructions

* Renames and restructure

* Update Helm chart workflow for Colanode deployment

* Remove health check route and related configurations from the server and Kubernetes deployment files.

---------

Co-authored-by: Hakan Shehu <hakanshehu15@gmail.com>

2025-06-25 19:06:35 +02:00

3.5 KiB

Raw Blame History

Colanode Kubernetes Deployment

A Helm chart for deploying Colanode on Kubernetes.

Overview

This chart deploys a complete Colanode instance with all required dependencies:

Colanode Server: The main application server
PostgreSQL: Database with pgvector extension for vector operations
Redis/Valkey: Message queue and caching
MinIO: S3-compatible object storage for files and avatars

Prerequisites

Kubernetes 1.19+
Helm 3.0+
Ingress controller (if ingress is enabled)

Installation

Quick Start

# Add the chart repository (if publishing to a Helm repo)
helm repo add colanode https://static.colanode.com/hosting/kubernetes/chart

# Install with default values
helm install my-colanode colanode/colanode

# Or install from local chart
helm install my-colanode ./hosting/kubernetes/chart

Custom Installation

# Install with custom values
helm install my-colanode ./hosting/kubernetes/chart \
  --set colanode.ingress.hosts[0].host=colanode.example.com \
  --set colanode.config.SERVER_NAME="My Colanode Instance"

Configuration

Core Settings

Parameter	Description	Default
`colanode.replicaCount`	Number of Colanode replicas	`1`
`colanode.image.repository`	Colanode image repository	`ghcr.io/colanode/server`
`colanode.image.tag`	Colanode image tag	`latest`
`colanode.config.SERVER_NAME`	Server display name	`Colanode K8s`

Ingress Configuration

Parameter	Description	Default
`colanode.ingress.enabled`	Enable ingress	`true`
`colanode.ingress.hosts[0].host`	Hostname for the ingress	`chart-example.local`
`colanode.ingress.className`	Ingress class name	`""`

Dependencies

Parameter	Description	Default
`postgresql.enabled`	Enable PostgreSQL deployment	`true`
`redis.enabled`	Enable Redis deployment	`true`
`minio.enabled`	Enable MinIO deployment	`true`

Important Notes

Security Settings

The chart includes global.security.allowInsecureImages: true because we use a custom PostgreSQL image with the pgvector extension. This setting is required by Bitnami Helm charts when using non-official images.

Storage

By default, the chart configures persistent storage for:

PostgreSQL: 8Gi
Redis: 8Gi
MinIO: 10Gi

Adjust these values based on your requirements.

Accessing Colanode

After installation, you can access Colanode through:

Ingress (recommended): Configure your ingress host and access via HTTP/HTTPS
Port forwarding: kubectl port-forward svc/my-colanode 3000:3000
LoadBalancer: Change service type to LoadBalancer if supported by your cluster

Uninstall

helm uninstall my-colanode

Development

To modify the chart:

Edit values in /hosting/kubernetes/chart/values.yaml
Update templates in /hosting/kubernetes/chart/templates/
Test with helm template or helm install --dry-run

3.5 KiB Raw Blame History