Install
Kubernetes

Overview

Run Relic from the chart with your own PostgreSQL and object storage, or with the services it runs.

Every release publishes the chart to oci://ghcr.io/relicbuild/charts/relic (source: helm/relic). It runs the server (two replicas) and the worker as Deployments. Relic needs a PostgreSQL database and object storage: connect your own, or let the chart run them in the cluster.

The chart needs Helm 3.17.0 or later.

Your own PostgreSQL and object storage

Turn off what the chart would run and give Relic the connection details in its credentials Secret:

ServiceTurn offConnect with
PostgreSQLcluster.enabled and cloudnative-pg.enableddatabaseURL in the Secret, for example postgres://relic:<password>@db.example.com:5432/relic?sslmode=require
Object storageseaweedfs.enabledobjectStorage.type (s3, azure or gcs), endpoint, region and the two bucket names in the values. In the Secret: objectStorageAccessKey and objectStorageSecretKey for S3, or objectStorageAzureConnectionString. objectStorage.defaultCredentials: true uses the platform's identity instead.

External PostgreSQL and External object storage give the steps; use both pages to bring both.

Services the chart runs

By default the chart installs these from their official charts. Values under each key pass through to that chart.

ServiceChart (values key)Details
CloudNativePG operatorcloudnative-pg (cloudnative-pg)CRDs in the chart's crds/ directory.
PostgreSQL, as a CloudNativePG Clustercnpg/cluster (cluster)Three 10Gi instances, database relic. CloudNativePG handles failover and the credentials.
SeaweedFS, with its S3 gatewayseaweedfs (seaweedfs)Generates the S3 key pair and creates the artifacts and temporary buckets.

monitoringStack.enabled adds a monitoring stack.

The CloudNativePG operator

One helm install installs the operator's CRDs, then the operator, then the Cluster. The operator's webhooks let the Cluster through while it starts. Upgrades change the Cluster in place.

A Kubernetes cluster can run only one operator. If yours already runs one, turn the bundled one off:

cloudnative-pg:
  enabled: false

If no operator is running, the chart stops and prints the install command.

Setups

SetupPostgreSQLObject storagePage
Everything in the clusterCloudNativePGSeaweedFSQuick start
Your own databaseyoursSeaweedFSExternal PostgreSQL
Your own object storeCloudNativePGyoursExternal object storage
Both externalyoursyoursBoth pages.