Skip to main content

Installing Rig in a Kubernetes Cluster

Rig consists of two components which together gives the full experience of Rig.dev.

  • rig-operator: our open source components which provide higher level APIs in kubernetes, which encapsulate multiple low level resources in a single CRD.
  • rig-platform: our paid product which further builds on the primitives provided by rig-operator.

Kubernetes Cluster Installation​

Prerequisites

Make sure that you have a running Kubernetes cluster, and that you have Helm installed.

For a quick installation in an existing Kubernetes cluster, you can follow the steps here.

  1. Install the Rig Operator:
helm upgrade --install rig-operator rig-operator \
    --repo https://charts.rig.dev \
    --version 1.0.44 \
    --namespace rig-system \
    --create-namespace
  1. Install the Rig Platform:
helm upgrade --install rig-platform rig-platform \
    --repo https://charts.rig.dev \
    --version 1.0.70 \
    --namespace rig-system \
    --create-namespace \
    --set postgres.enabled=true
  1. Bootstrap your first user and project by running:
kubectl exec -it -n rig-system deploy/rig-platform -- rig-admin init
  1. Access the dashboard at http://localhost:4747 after starting port-forwarding:
kubectl port-forward -n rig-system service/rig-platform 4747
Note

As part of the quick installation, a small PostgresSQL instance is installed in your cluster, for the Platform to use. This is not recommended for production environments.

Note

Dashboard metrics require a metrics-server in the kubernetes cluster. While available in most kubernetes clusters, See here for instructions on how to install it, if missing: https://github.com/kubernetes-sigs/metrics-server

For a more in-depth guide, see the Operator and Platform sections.