Kubernetes: Using Helm

For installation to Kubernetes, a Helm chart is available in our charts repository. The source code of the chart(s) is available on GitHub fivenet-app/charts.

Before you begin, review the requirements and make sure your database, NATS server, storage, domain, and cluster ingress are ready.

0. Prerequisites

This guide assumes you have a working Kubernetes cluster and a Helm client installed. If you haven't set up a Kubernetes cluster yet, please refer to the Kubernetes installation guide. You can use any Kubernetes cluster, including local clusters like Minikube or KinD, or cloud providers like GKE, EKS, or AKS.

1. Add Helm Chart Repo

Add the FiveNet Helm chart repository to your Helm client:

helm repo add fivenet https://fivenet.app/charts
helm repo update

2. Create a Namespace

Create a dedicated namespace for FiveNet if you do not already have one:

kubectl create namespace fivenet

3. Get the Latest values.yaml

Retrieve the default values.yaml file for the Helm chart to start configuring your deployment:

helm show values fivenet/fivenet > values.yaml

4. Configure values.yaml

Edit the values.yaml file to suit your deployment needs. Follow the Configure FiveNet guide for the required settings in .fivenet.config, then use the Config File Reference for individual options.

At a minimum, you should review the FiveNet configuration, secrets, persistence, and how the deployment should be exposed in your cluster.

5. Install or Upgrade FiveNet

Deploy or update FiveNet in your Kubernetes cluster using the configured values.yaml file:

helm upgrade --install fivenet fivenet/fivenet \
  --namespace fivenet \
  -f values.yaml

6. Verify the Deployment

After the Helm release is installed, verify that the workloads are starting correctly:

kubectl get pods -n fivenet
helm status fivenet -n fivenet

Ensure that FiveNet is externally reachable as configured in your values.yaml file, for example through your configured Ingress, Service, hostnames, and TLS settings.

7. Post-Installation Steps

After installation, follow the post-installation steps to complete the setup.

Troubleshooting

For common issues during Kubernetes or Helm installation, such as database-related errors, refer to the Database and Installation Troubleshooting page.