Skip to content

Helm Deployment Examples

This directory contains example values files for deploying DocShare on Kubernetes with Helm.

Available Examples

Example Description Use Case
minimal.yaml Basic deployment with bundled PostgreSQL Development, evaluation
production.yaml Production-ready with TLS and replicas Production deployments
external-db.yaml External PostgreSQL database Managed database services
ha.yaml High availability with multiple replicas Large-scale deployments

Quick Reference

Minimal

helm install docshare oci://ghcr.io/hayward-solutions/charts/docshare \
  --namespace docshare --create-namespace \
  -f examples/helm/minimal.yaml

Production

helm install docshare oci://ghcr.io/hayward-solutions/charts/docshare \
  --namespace docshare --create-namespace \
  -f examples/helm/production.yaml

With External Database

helm install docshare oci://ghcr.io/hayward-solutions/charts/docshare \
  --namespace docshare --create-namespace \
  -f examples/helm/external-db.yaml

Prerequisites

  • Kubernetes 1.26+
  • Helm 3.12+
  • AWS S3 bucket (or S3-compatible storage)
  • (Optional) cert-manager for TLS

AWS S3 Configuration

api:
  serviceAccount:
    annotations:
      eks.amazonaws.com/role-arn: arn:aws:iam::123456789:role/docshare-s3-role

s3:
  region: us-east-1
  bucket: docshare-prod

Option 2: Static Credentials

s3:
  region: us-east-1
  accessKey: your-access-key
  secretKey: your-secret-key
  bucket: docshare-prod

Option 3: Existing Secret

s3:
  region: us-east-1
  bucket: docshare-prod
  existingSecret: my-s3-secret

For detailed configuration, see the Helm documentation.