Skip to main content

Platform Installation

Local Installation​

Rig can run locally in both Kubernetes (KIND) and in a local Docker environment.

Prerequisites

Make sure that you have the CLI Installed.

Option 1: Docker​

To create a Rig setup on your local machine within Docker, simply run the following command:

rig dev docker create

The above command will guide you through the installation. If anything goes wrong, you can always run the command again.

Option 2: Kubernetes (KIND)​

To easily create a Rig Kubernetes setup on your local machine, Rig comes with support for starting up a KIND cluster on your local machine. Run the following command:

rig dev kind create

Kubernetes Cluster Installation​

See here for how to setup Rig on an already existing Kubernetes cluster.

Next step​

And that's it, you're now ready to login on the dashboard at http://localhost:4747.

Setup Rig​

The next step is to do some simple setup of Rig. This amounts to creating yourself a new Admin user and create a proejct. The Rig docker image comes with a rig-admin tool, that can be used for exactly this:

kubectl exec -it --namespace rig-system deploy/rig-platform \
  -- rig-admin init

Configuration​

For more information about how to configure Rig, see the configuration section.

See also

Was this page helpful?