Installation

There are three ways to run the Regorule Operator:

  1. Helm managed Docker container deployment on Kubernetes

  2. As a Docker container

  3. Build from source.

Helm

Helm allows you to download and deploy Stackable operators on Kubernetes and is by far the easiest installation method. First ensure that you have installed the Stackable Operators Helm repository:

$ helm repo add stackable https://repo.stackable.tech/repository/helm-stable/

Then install the Stackable Regorule Operator

$ helm install regorule-operator stackable/regorule-operator

Helm will deploy the operator in a Kubernetes container and apply the CRDs for the Regorule service. You are now ready to deploy the Stackable Regorule Operator in Kubernetes.

Docker

This Operator is published as a Docker image:

docker.stackable.tech/stackable/regorule-operator

When installing manually with Docker you will need to install the Stackable CRDs for the Regorule Operator in your Kubernetes environment. These are available on the Stackable GitHub repository for this operator.

$ kubectl apply -f regorule.crd.yaml

To run it straight from Docker you can use this command:

docker run \
    --name regorule-operator \
    --network host \
    --env KUBECONFIG=/home/stackable/.kube/config \
    --mount type=bind,source="$HOME/.kube/config",target="/home/stackable/.kube/config" \
    docker.stackable.tech/stackable/regorule-operator:latest

Building the operator from source

This operator is written in Rust and is developed against the latest stable Rust release (1.57 at the time of writing).

cargo run -- crd | kubectl apply -f -
cargo run -- run