Skip to content

Latest commit

 

History

History
138 lines (124 loc) · 5.92 KB

installation.md

File metadata and controls

138 lines (124 loc) · 5.92 KB
Raw

Operator Installation

Install on minikube

  1. Create minikube cluster.
minikube start
  1. Add the helm repo.
helm repo add immudb-operator-charts https://unagex.github.io/immudb-operator
helm repo update
  1. Install the operator in the namespace immudb-operator. See operator configuration for more customization.
helm install immudb-operator immudb-operator-charts/immudb-operator -n immudb-operator --create-namespace

Congratulations ! The operator is now installed. To test it, you can deploy a basic immudb (optional):

  1. Deploy an immudb database in the namespace default. See immudb configuration for more customization.
kubectl apply -f https://raw.githubusercontent.com/unagex/immudb-operator/main/config/samples/v1_immudb.yaml
  1. Access immudb web console.
 minikube service immudb-sample-http --url

Click on the first URL returned to access the immudb web console.

Install on Amazon Elastic Kubernetes Service (EKS)

You should have an EKS cluster already running. See the official documentation if that's not the case.

  1. Install the Amazon EBS CSI driver add-on on your EKS cluster. See the official documentation to add it.
  2. Grant permissions for your EKS cluster to interact with Amazon EBS volumes, you need to update the IAM roles associated with your EKS nodes. Here is the necessary policy to attach to your cluster role.
{
 "Version": "2012-10-17",
 "Statement": [{
  "Sid": "VisualEditor0",
  "Effect": "Allow",
  "Action": [
   "ec2:CreateVolume",
   "ec2:DeleteVolume",
   "ec2:AttachVolume",
   "ec2:DetachVolume",
   "ec2:DescribeVolumes",
   "ec2:CreateTags",
   "ec2:DeleteTags",
   "ec2:DescribeTags"
  ],
  "Resource": "*"
 }]
}
  1. Add the helm repo.
helm repo add immudb-operator-charts https://unagex.github.io/immudb-operator
helm repo update
  1. Install the operator in the namespace immudb-operator. See operator configuration for more customization.
helm install immudb-operator immudb-operator-charts/immudb-operator -n immudb-operator --create-namespace

Congratulations ! The operator is now installed. To test it, you can deploy a basic immudb (optional):

  1. Deploy an immudb database in the namespace default. See immudb configuration for more customization.
kubectl apply -f https://raw.githubusercontent.com/unagex/immudb-operator/main/config/samples/v1_immudb.yaml
  1. Access immudb web console on port 8080.
kubectl port-forward services/immudb-sample-http 8080:8080

Install on Google Kubernetes Engine (GKE)

You should have a GKE cluster already running. See the official documentation if that's not the case. The following has been tested on a GKE autopilot mode.

  1. Add the helm repo.
helm repo add immudb-operator-charts https://unagex.github.io/immudb-operator
helm repo update
  1. Install the operator in the namespace immudb-operator. See operator configuration for more customization.
helm install immudb-operator immudb-operator-charts/immudb-operator -n immudb-operator --create-namespace

Congratulations ! The operator is now installed. To test it, you can deploy a basic immudb (optional):

  1. Deploy an immudb database in the namespace default. See immudb configuration for more customization.
kubectl apply -f https://raw.githubusercontent.com/unagex/immudb-operator/main/config/samples/v1_immudb.yaml
  1. Access immudb web console on port 8080.
kubectl port-forward services/immudb-sample-http 8080:8080

Install on Azure Kubernetes Service (AKS)

You should have a AKS cluster already running. See the official documentation if that's not the case.

  1. Add the helm repo.
helm repo add immudb-operator-charts https://unagex.github.io/immudb-operator
helm repo update
  1. Install the operator in the namespace immudb-operator. See operator configuration for more customization.
helm install immudb-operator immudb-operator-charts/immudb-operator -n immudb-operator --create-namespace

Congratulations ! The operator is now installed. To test it, you can deploy a basic immudb (optional):

  1. Deploy an immudb database in the namespace default. See immudb configuration for more customization.
kubectl apply -f https://raw.githubusercontent.com/unagex/immudb-operator/main/config/samples/v1_immudb.yaml
  1. Access immudb web console on port 8080.
kubectl port-forward services/immudb-sample-http 8080:8080

Operator configuration

The operator Helm chart is deployed by default with this values.yaml. The following values can be overriden:

Name Type Default value
operator.image.repository string "ghcr.io/unagex/immudb-operator/controller"
operator.image.tag string Default to latest version at time of installation.
operator.image.pullPolicy string "IfNotPresent"
resources.limits.cpu string nil
resources.limits.memory string nil
resources.requests.cpu string nil
resources.requests.memory string nil
labels map[string]string nil