This guide walks you through setting up Newt on Kubernetes using Helm. This guide assumes you already are familiar with Kubernetes concepts and you fulfill the following Global prerequisites:

​
Global Prerequisites

  • Kubernetes Cluster (v1.28.15+)
  • Access to the Kubernetes Cluster
  • Helm (v3.0+) installed, see Helm install docs
Recommended: Helm Chart Installation.

​
Helm Installation

All Fossorial Helm charts are available on Artifact Hub. See Fossorial Charts.

​
Install Newt

1

Add Fossorial Helm repo

helm repo add fossorial https://charts.fossorial.io
helm repo update fossorial
helm search repo fossorial
2

Prepare Installation files

Prepare your Newt credentials:
newt-cred.env
PANGOLIN_ENDPOINT=<your-endpoint>
NEWT_ID=<your-id>
NEWT_SECRET=<your-secret>
Prepare a values file with your desired configuration.
See Newt chart values configuration options.
values-newt.yaml
newtInstances:
  - name: main
    enabled: true
    auth:
      existingSecretName: newt-cred
      keys:
        endpointKey: PANGOLIN_ENDPOINT
        idKey: NEWT_ID
        secretKey: NEWT_SECRET
3

Newt Installation

Create a Kubernetes Secret from the env file created earlier:
kubectl create secret generic newt-cred -n newt --from-env-file=newt-cred.env
Install Newt with Helm:
helm install my-newt fossorial/newt \
  -n newt --create-namespace \
  -f values-newt.yaml
Change the release name (my-newt), namespace (newt), and values filename as needed.
4

Upgrade or rollback

# Update repo to get latest charts
helm repo update fossorial
# Upgrade Newt (after editing values)
helm upgrade my-newt fossorial/newt -n newt -f values-newt.yaml

# Roll back to a previous revision
helm rollback my-newt 1 -n newt

​
Customizing Your Values

All configuration options are documented in the respective repositories:

​
References