Exivity Helm Chart

This Helm chart deploys Exivity, a comprehensive cloud metering and billing solution, on Kubernetes clusters.

Prerequisites

• Kubernetes 1.20+
• Helm 3.0+
• A StorageClass that supports ReadWriteMany access mode (recommended for multi-node HA; ReadWriteOnce can be sufficient for single-node deployments)

Best Practices

For prescriptive guidance on single-node, multi-node, and multi-site deployments, see the Exivity Kubernetes best-practice documentation on docs.exivity.com.

Getting Started

1. Add the Helm Repository

helm repo add exivity https://charts.exivity.com
helm repo update

2. Install the Chart

Install Exivity with your desired release name:

helm upgrade --install exivity exivity/exivity \
    --namespace exivity \
    --create-namespace \
    --wait \
    --set storage.storageClass=<your-storage-class>

Replace <your-storage-class> with your preferred storage class. Multi-node deployments require storage that supports ReadWriteMany access mode. Single-node deployments can use ReadWriteOnce storage when all pods run on the same node. For local-path style storage, plan PVC sizes against actual node disk capacity because these provisioners may not reserve or enforce aggregate free space across PVCs.

3. Storage Solutions

Exivity is tested with various storage solutions including NFS and Longhorn. Here are examples for common setups:

NFS Storage with nfs-ganesha-server-and-external-provisioner

# Install NFS server provisioner
helm repo add nfs-ganesha-server-and-external-provisioner https://kubernetes-sigs.github.io/nfs-ganesha-server-and-external-provisioner/
helm install nfs-server nfs-ganesha-server-and-external-provisioner/nfs-server-provisioner \
    --namespace nfs-server \
    --create-namespace \
    --wait \
    --set persistence.enabled=true \
    --set persistence.size=5Gi \
    --set storageClass.name=nfs-client

# Then install Exivity
helm upgrade --install exivity exivity/exivity \
    --namespace exivity \
    --create-namespace \
    --wait \
    --set storage.storageClass=nfs-client

Longhorn Storage

If you're using Longhorn, you can install Exivity with:

Note: Longhorn is the preferred storage option for HA deployments when it is available in your environment. For multi-node deployments, configure Longhorn with three replicas per volume.

helm upgrade --install exivity exivity/exivity \
    --namespace exivity \
    --create-namespace \
    --wait \
    --set storage.storageClass=longhorn

Configuration

Basic Configuration

Parameter	Description	Default
licence	Exivity license key (use "demo" for evaluation)	"demo"
storage.storageClass	Storage class for persistent volumes	""
ingress.enabled	Enable ingress	true
ingress.host	Hostname for the ingress	"exivity"

Example: Custom Values

Create a values.yaml file:

licence: "your-license-key"
storage:
  storageClass: "nfs-client"
ingress:
  enabled: true
  host: "exivity.example.com"
  tls:
    enabled: true
    secret: "exivity-tls"

Install with custom values:

helm upgrade --install exivity exivity/exivity \
    --namespace exivity \
    --create-namespace \
    --values values.yaml

Advanced Configuration

For detailed configuration options, see the examples directory:

• GUI as Website - Configure ingress for web access
• External PostgreSQL - Use external PostgreSQL
• External RabbitMQ - Use external RabbitMQ
• Larger PostgreSQL - Scale PostgreSQL resources
• Best Practice: Single Node - Starting values for single-node deployments
• Best Practice: Multi Node - Starting values for multi-node HA deployments
• Best Practice: Multi Site Active/Passive - Starting values for GitOps-managed active/passive deployments

Accessing Exivity

After installation, Exivity will be available at:

• With Ingress: http(s)://<your-hostname>/

Uninstalling

To uninstall the chart:

helm uninstall exivity -n exivity

Support

For more detailed installation instructions, visit the Exivity Installation Guide.