Kubernetes - Gorbit Documentation

Check out our Resourcing Guide before getting started.

Guide

The Gorbit Helm chart packages all the required services (API, web, PostgreSQL, Vespa, etc.) into a single deployment. By default, persistent volumes will be created for stateful services (e.g. PostgreSQL, Vespa).

Add the Gorbit Helm repository

helm repo add gorbit https://gorbit-dot-app.github.io/gorbit/
helm repo update
helm search repo gorbit

Install Gorbit

Install into its own namespace (recommended):

kubectl create namespace gorbit
helm install gorbit gorbit/gorbit -n gorbit

This will pull the latest Gorbit chart and deploy all dependencies.

Verify the installation

helm list -n gorbit
kubectl get pods -n gorbit

Wait until all pods are in a Running state before accessing Gorbit.

Access Gorbit

By default, the chart exposes Gorbit via a Kubernetes Service. For local testing, you can port-forward:

kubectl -n gorbit port-forward service/gorbit-nginx 8080:80

Then open http://localhost:8080.

Configure Gorbit

Configure your deployment by modifying the values.yaml file in the gorbit/deployment/helm/charts/gorbit directory.You’ll need to restart Gorbit after changing any values.yaml variables.

helm upgrade gorbit gorbit/gorbit -n gorbit -f deployment/helm/charts/gorbit/values.yaml

See the Helm chart README for advanced options such as running as non-root and testing with Kind.

Next Steps

Configure Authentication

Set up authentication for your Gorbit deployment with OAuth, OIDC, or SAML.

More Gorbit Configuration Options

Learn about all available configuration options for your Gorbit deployment.

Docker Terraform

​Guide

​Next Steps

Configure Authentication

More Gorbit Configuration Options

Guide

Next Steps