ALTCHA Sentinel Helm Chart

Important

0.8.x -> 0.9.x: As of version 0.9.x, this chart uses a StatefulSet instead of a Deployment to support per-replica persistent volumes. If you are upgrading from an older version, manually delete the existing deployment. If you need to migrate data from the previous PVC, use a migration Job or copy data manually.

Overview

This Helm chart deploys ALTCHA Sentinel on a Kubernetes cluster.

Prerequisites

• Kubernetes 1.19+
• Helm 3.2.0+
• PV provisioner support in the underlying infrastructure

Installation

Add the Helm repository

helm repo add altcha-org https://altcha-org.github.io/helm-charts

Install the chart

helm install altcha-sentinel altcha-org/sentinel

Configuration

The following table lists the configurable parameters of the ALTCHA Sentinel chart and their default values.

Parameter	Description	Default
replicaCount	Number of replicas	1
image.repository	Container image repository	ghcr.io/altcha-org/sentinel
image.tag	Container image tag	""
image.pullPolicy	Container image pull policy	IfNotPresent
service.type	Kubernetes Service type	LoadBalancer
service.port	Service external port	80
service.targetPort	Container port	8080
persistence.enabled	Enable persistence	true
persistence.accessMode	PVC access mode	ReadWriteOnce
persistence.size	PVC size	10Gi
persistence.storageClass	PVC storage class	"" (uses default)
persistence.mountPath	Mount path for volume	/data
env	Direct environment variables	[]
envFrom	Load environment from ConfigMaps/Secrets	[]
extraEnvVars	Extra environment variables with complex definitions	[]

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example:

helm install altcha-sentinel \
  --set persistence.size=20Gi \
  altcha-org/sentinel

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example:

helm install altcha-sentinel -f values.yaml altcha-org/sentinel

Environment Variables

The chart supports three ways to configure environment variables:

Direct Environment Variables

Use the env parameter to set simple environment variables:

env:
  - name: LOG_LEVEL
    value: "debug"
  - name: SMTP_URL
    value: "your-smtp-url"

Environment Variables from ConfigMaps or Secrets

Use the envFrom parameter to load entire ConfigMaps or Secrets as environment variables:

envFrom:
  - configMapRef:
      name: my-app-config
  - secretRef:
      name: my-app-secrets

Complex Environment Variables

Use the extraEnvVars parameter for environment variables that reference specific keys from ConfigMaps or Secrets:

extraEnvVars:
  - name: REDIS_URL
    valueFrom:
      secretKeyRef:
        name: redis-secret
        key: connection-string
  - name: CONFIG_VALUE
    valueFrom:
      configMapKeyRef:
        name: app-config
        key: config-value

Complete Example

Here's a complete example using all three methods:

# values.yaml
env:
  - name: LOG_LEVEL
    value: "info"
  - name: PASSWORD_LOGIN_ENABLED
    value: "0"

envFrom:
  - configMapRef:
      name: sentinel-config
  - secretRef:
      name: sentinel-secrets

extraEnvVars:
  - name: SMTP_URL
    valueFrom:
      secretKeyRef:
        name: credentials
        key: smtp-url
  - name: BASE_URL
    valueFrom:
      configMapKeyRef:
        name: feature-config
        key: base-url

Then install with:

helm install altcha-sentinel -f values.yaml altcha-org/sentinel

Persistence

The ALTCHA Sentinel chart persists data to a Kubernetes PersistentVolume by default. The persistent volume claim is created with the following settings by default:

• 10Gi storage size
• ReadWriteOnce access mode
• Mounted at /data in the container

Upgrading

To upgrade your release with new configuration:

helm upgrade altcha-sentinel altcha-org/sentinel -f values.yaml

Uninstalling

To uninstall/delete the altcha-sentinel deployment:

helm delete altcha-sentinel

The command removes all the Kubernetes components associated with the chart and deletes the release.