Using the ArangoDB Kubernetes Operator

    If you have available, we recommend installation using Helm.

    To install the ArangoDB Kubernetes Operator with helm, run the following commands (replace <version> with the that you want to install):

    This installs operators for the ArangoDeployment and ArangoDeploymentReplication resource types.

    If you want to avoid the installation of the operator for the ArangoDeploymentReplication resource type, add --set=DeploymentReplication.Create=false to the helm install command.

    To use ArangoLocalStorage resources, also run:

      Installation with Kubectl

      To install the ArangoDB Kubernetes Operator without Helm, run (replace <version> with the version of the operator that you want to install):

      1. export URLPREFIX=https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests
      2. kubectl apply -f $URLPREFIX/arango-crd.yaml
      3. kubectl apply -f $URLPREFIX/arango-deployment.yaml

      To use ArangoLocalStorage resources, also run:

      To use ArangoDeploymentReplication resources, also run:

      1. kubectl apply -f $URLPREFIX/arango-deployment-replication.yaml

      You can find the latest release of the ArangoDB Kubernetes Operator .

      Once the operator is running, you can create your ArangoDB database deployment by creating a custom resource and deploying it into your Kubernetes cluster.

      1. kubectl apply -f examples/simple-cluster.yaml

      To remove an existing ArangoDB deployment, delete the custom resource. The operator will then delete all created resources.

      For example:

      Note that this will also delete all data in your ArangoDB deployment!

      If you want to keep your data, make sure to create a backup before removing the deployment.

      To remove the entire ArangoDB Kubernetes Operator, remove all clusters first and then remove the operator by running:

      1. helm delete <release-name-of-kube-arangodb-chart>
      2. # If `ArangoLocalStorage` operator is installed
      1. kubectl delete deployment arango-deployment-operator
      2. # If `ArangoLocalStorage` operator is installed
      3. kubectl delete deployment -n kube-system arango-storage-operator
      4. # If `ArangoDeploymentReplication` operator is installed