Skip to main content

Setup guide

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

Install Using Terraform​

It is easy to install Rig with Terraform as well using Helm. The basic Terraform configuration for that is

provider "helm" {
  kubernetes {
    # Your kubernetes configuration
  }
}

resource "helm_release" "rig_operator" {
  name = "rig-operator"
  repository = "https://charts.rig.dev"
  chart = "rig-operator"
  version    = "1.0.43"
  namespace = "rig-system"
  create_namespace = true
}

resource "helm_release" "rig_platform" {
  name = "rig-platform"
  repository = "https://charts.rig.dev"
  chart = "rig-platform"
  version    = "1.0.58"
  namespace = "rig-system"
  create_namespace = true
  set { # Not recommended for production!
    name = "postgres.enabled"
    value = "true"
  }
  depends_on = [helm_release.rig_operator]
}

This contains just basic configuration for the rig-operator and rig-platform.

Extended installation guides​

For real-world scenarios, we recommend using the extended installation guides, available here:

Configuration​

The Rig Operator and Platform both have a values.yaml file which specify how to configure their respective Helm charts. The values files and their defaults can be found here

To overwrite a default value when deploying, either supply your own values filee using --values or use --set FIELD=VALUE flags whenrunning helm.