2018-02-06 07:16:21 +00:00
# ArangoDB Kubernetes Operator
2018-09-11 13:03:30 +00:00
[](https://hub.docker.com/r/arangodb/kube-arangodb/)
2019-07-04 13:37:01 +00:00
ArangoDB Kubernetes Operator helps to run ArangoDB deployments
2018-04-06 11:58:19 +00:00
on Kubernetes clusters.
2018-02-06 07:16:21 +00:00
2018-04-06 11:58:19 +00:00
To get started, follow the Installation instructions below and/or
2020-01-07 12:23:35 +00:00
read the [tutorial ](https://www.arangodb.com/docs/stable/tutorials-kubernetes.html ).
2018-04-06 11:58:19 +00:00
## State
2022-03-24 23:19:51 +00:00
The ArangoDB Kubernetes Operator is Production ready.
2018-02-06 07:16:21 +00:00
2018-04-04 14:48:43 +00:00
[Documentation ](./docs/README.md )
2018-03-12 11:18:50 +00:00
2018-06-19 10:02:21 +00:00
### Production readiness state
2019-06-07 10:02:04 +00:00
Beginning with Version 0.3.11 we maintain a production readiness
state for individual new features, since we expect that new
features will first be released with an "alpha" or "beta" readiness
state and over time move to full "production readiness".
2020-07-22 12:24:22 +00:00
Operator will supports versions supported on providers and maintained by Kubernetes.
Once version is not supported anymore it will go into "Deprecating" state and will be marked as deprecated on Minor release.
2022-03-24 23:19:51 +00:00
Kubernetes versions starting from 1.18 are supported and tested, charts and manifests can use API Versions which are not present in older versions.
2020-09-17 21:20:22 +00:00
2019-06-07 10:02:04 +00:00
The following table has the general readiness state, the table below
covers individual newer features separately.
2022-03-24 23:19:51 +00:00
| Platform | Kubernetes Version | ArangoDB Version | State | Remarks | Provider Remarks |
|---------------------|--------------------|------------------|------------|------------------------------------------------------------------|------------------------------------|
| Google GKE | 1.17 | >= 3.6.0 | Deprecated | Don't use micro nodes. Support will be dropped in Operator 1.5.0 | |
| Google GKE | 1.18 | >= 3.6.0 | Production | Don't use micro nodes | |
| Google GKE | 1.19 | >= 3.6.0 | Production | Don't use micro nodes | |
| Google GKE | 1.20 | >= 3.6.0 | Production | Don't use micro nodes | |
| Google GKE | 1.21 | >= 3.6.0 | Production | Don't use micro nodes | |
| Google GKE | 1.22 | >= 3.6.0 | Production | Don't use micro nodes | |
| Azure AKS | 1.19 | >= 3.6.0 | Production | | |
| Azure AKS | 1.20 | >= 3.6.0 | Production | | |
| Azure AKS | 1.21 | >= 3.6.0 | Production | | |
| Azure AKS | 1.22 | >= 3.6.0 | Production | | |
| Amazon EKS | 1.16 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | [Amazon EKS ](./docs/providers/eks ) |
| Amazon EKS | 1.17 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | [Amazon EKS ](./docs/providers/eks ) |
| Amazon EKS | 1.18 | >= 3.6.0 | Production | | [Amazon EKS ](./docs/providers/eks ) |
| Amazon EKS | 1.19 | >= 3.6.0 | Production | | [Amazon EKS ](./docs/providers/eks ) |
| Amazon EKS | 1.20 | >= 3.6.0 | Production | | [Amazon EKS ](./docs/providers/eks ) |
| Amazon EKS | 1.21 | >= 3.6.0 | Production | | [Amazon EKS ](./docs/providers/eks ) |
| IBM Cloud | 1.17 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
| IBM Cloud | 1.18 | >= 3.6.0 | Production | | |
| IBM Cloud | 1.19 | >= 3.6.0 | Production | | |
| IBM Cloud | 1.20 | >= 3.6.0 | Production | | |
| IBM Cloud | 1.21 | >= 3.6.0 | Production | | |
| OpenShift | 3.11 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
2022-03-31 17:08:32 +00:00
| OpenShift | 4.2-4.9 | >= 3.6.0 | Production | | |
2022-03-24 23:19:51 +00:00
| BareMetal (kubeadm) | 1.16 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
| BareMetal (kubeadm) | 1.17 | >= 3.6.0 | Deprecated | Support will be dropped in Operator 1.5.0 | |
| BareMetal (kubeadm) | 1.18 | >= 3.6.0 | Production | | |
| BareMetal (kubeadm) | 1.19 | >= 3.6.0 | Production | | |
| BareMetal (kubeadm) | 1.20 | >= 3.6.0 | Production | | |
| BareMetal (kubeadm) | 1.21 | >= 3.6.0 | Production | | |
2022-03-31 17:08:32 +00:00
| BareMetal (kubeadm) | 1.22 | >= 3.6.0 | Production | | |
| BareMetal (kubeadm) | 1.23 | >= 3.6.0 | Production | | |
2022-03-24 23:19:51 +00:00
| Minikube | 1.18+ | >= 3.6.0 | Devel Only | | |
| Other | 1.18+ | >= 3.6.0 | Devel Only | | |
2018-06-19 10:02:21 +00:00
2019-06-07 10:02:04 +00:00
Feature-wise production readiness table:
2018-08-20 14:25:07 +00:00
2021-08-23 14:22:50 +00:00
| Feature | Operator Version | ArangoDB Version | ArangoDB Edition | State | Enabled | Flag | Remarks |
|-----------------------------------------|------------------|------------------|-----------------------|--------------|---------|--------------------------------------------|--------------------------------------------------------------------------|
| Pod Disruption Budgets | 0.3.10 | Any | Community, Enterprise | Alpha | True | N/A | N/A |
| Pod Disruption Budgets | 0.3.11 | Any | Community, Enterprise | Production | True | N/A | N/A |
| Volume Resizing | 0.3.10 | Any | Community, Enterprise | Alpha | True | N/A | N/A |
| Volume Resizing | 0.3.11 | Any | Community, Enterprise | Production | True | N/A | N/A |
| Disabling of liveness probes | 0.3.10 | Any | Community, Enterprise | Alpha | True | N/A | N/A |
| Disabling of liveness probes | 0.3.11 | Any | Community, Enterprise | Production | True | N/A | N/A |
| Volume Claim Templates | 0.3.11 | Any | Community, Enterprise | Alpha | True | N/A | N/A |
| Volume Claim Templates | 1.0.0 | Any | Community, Enterprise | Production | True | N/A | N/A |
| Prometheus Metrics Exporter | 0.3.11 | Any | Community, Enterprise | Alpha | True | N/A | Prometheus required |
| Prometheus Metrics Exporter | 1.0.0 | Any | Community, Enterprise | Production | True | N/A | Prometheus required |
| Sidecar Containers | 0.3.11 | Any | Community, Enterprise | Alpha | True | N/A | N/A |
| Sidecar Containers | 1.0.0 | Any | Community, Enterprise | Production | True | N/A | N/A |
| Operator Single Mode | 1.0.4 | Any | Community, Enterprise | Production | False | --mode.single | Only 1 instance of Operator allowed in namespace when feature is enabled |
| TLS SNI Support | 1.0.3 | >= 3.7.0 | Enterprise | Production | True | --deployment.feature.tls-sni | N/A |
| TLS Runtime Rotation Support | 1.0.4 | > 3.7.0 | Enterprise | Alpha | False | --deployment.feature.tls-rotation | N/A |
| TLS Runtime Rotation Support | 1.1.0 | > 3.7.0 | Enterprise | Production | True | --deployment.feature.tls-rotation | N/A |
| JWT Rotation Support | 1.0.4 | > 3.7.0 | Enterprise | Alpha | False | --deployment.feature.jwt-rotation | N/A |
| JWT Rotation Support | 1.1.0 | > 3.7.0 | Enterprise | Production | True | --deployment.feature.jwt-rotation | N/A |
| Encryption Key Rotation Support | 1.0.4 | > 3.7.0 | Enterprise | Alpha | False | --deployment.feature.encryption-rotation | N/A |
| Encryption Key Rotation Support | 1.1.0 | > 3.7.0 | Enterprise | Production | True | --deployment.feature.encryption-rotation | N/A |
| Encryption Key Rotation Support | 1.2.0 | > 3.7.0 | Enterprise | NotSupported | False | --deployment.feature.encryption-rotation | N/A |
2021-10-26 09:17:48 +00:00
| Version Check | 1.1.4 | >= 3.7.0 | Community, Enterprise | Alpha | False | --deployment.feature.upgrade-version-check | N/A |
| Operator Maintenance Management Support | 1.0.7 | >= 3.7.0 | Community, Enterprise | Alpha | False | --deployment.feature.maintenance | N/A |
| Operator Maintenance Management Support | 1.2.0 | >= 3.7.0 | Community, Enterprise | Production | True | --deployment.feature.maintenance | N/A |
| Operator Internal Metrics Exporter | 1.1.9 | >= 3.7.0 | Community, Enterprise | Alpha | False | --deployment.feature.metrics-exporter | N/A |
| Operator Internal Metrics Exporter | 1.2.0 | >= 3.7.0 | Community, Enterprise | Production | True | --deployment.feature.metrics-exporter | N/A |
| Operator Internal Metrics Exporter | 1.2.3 | >= 3.7.0 | Community, Enterprise | Production | True | --deployment.feature.metrics-exporter | It is always enabled |
2021-08-23 14:22:50 +00:00
| Operator Ephemeral Volumes | 1.2.2 | >= 3.7.0 | Community, Enterprise | Alpha | False | --deployment.feature.ephemeral-volumes | N/A |
2019-02-26 08:56:28 +00:00
2019-09-25 10:38:10 +00:00
## Release notes for 0.3.16
In this release we have reworked the Helm charts. One notable change is
that we now create a new service account specifically for the operator.
The actual deployment still runs by default under the `default` service
account unless one changes that. Note that the service account under
which the ArangoDB runs needs a small set of extra permissions. For
the `default` service account we grant them when the operator is
deployed. If you use another service account you have to grant these
permissions yourself. See
[here ](docs/Manual/Deployment/Kubernetes/DeploymentResource.md#specgroupserviceaccountname-string )
for details.
2019-04-08 09:42:21 +00:00
## Installation of latest release using Kubectl
```bash
2022-06-07 19:19:21 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.13/manifests/arango-crd.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.13/manifests/arango-deployment.yaml
2019-04-08 09:42:21 +00:00
# To use `ArangoLocalStorage`, also run
2022-06-07 19:19:21 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.13/manifests/arango-storage.yaml
2019-04-08 09:42:21 +00:00
# To use `ArangoDeploymentReplication`, also run
2022-06-07 19:19:21 +00:00
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/1.2.13/manifests/arango-deployment-replication.yaml
2019-04-08 09:42:21 +00:00
```
This procedure can also be used for upgrades and will not harm any
running ArangoDB deployments.
2020-06-17 06:29:11 +00:00
## Installation of latest release using kustomize
Installation using [kustomize ](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/ ) looks like installation from yaml files,
but user is allowed to modify namespace or resource names without yaml modifications.
IT is recommended to use kustomization instead of handcrafting namespace in yaml files - kustomization will replace not only resource namespaces,
but also namespace references in resources like ClusterRoleBinding.
Example kustomization file:
```
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namespace: my-custom-namespace
bases:
- https://github.com/arangodb/kube-arangodb/manifests/kustomize/deployment/?ref=1.0.3
```
2019-04-08 09:42:21 +00:00
## Installation of latest release using Helm
Only use this procedure for a new install of the operator. See below for
upgrades.
2018-08-20 14:25:07 +00:00
```bash
2018-10-30 16:13:06 +00:00
# The following will install the custom resources required by the operators.
2022-06-07 19:19:21 +00:00
helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.13/kube-arangodb-crd-1.2.13.tgz
2018-08-20 14:25:07 +00:00
# The following will install the operator for `ArangoDeployment` &
2018-11-09 04:34:54 +00:00
# `ArangoDeploymentReplication` resources.
2022-06-07 19:19:21 +00:00
helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.13/kube-arangodb-1.2.13.tgz
2019-09-23 07:00:10 +00:00
# To use `ArangoLocalStorage`, set field `operator.features.storage` to true
2022-06-07 19:19:21 +00:00
helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.13/kube-arangodb-1.2.13.tgz --set "operator.features.storage=true"
2018-08-20 14:25:07 +00:00
```
2019-04-08 09:42:21 +00:00
## Upgrading the operator using Helm
To upgrade the operator to the latest version with Helm, you have to
delete the previous deployment and then install the latest. **HOWEVER** :
You *must not delete* the deployment of the custom resource definitions
(CRDs), or your ArangoDB deployments will be deleted!
Therefore, you have to use `helm list` to find the deployments for the
operator (`kube-arangodb`) and of the storage operator
(`kube-arangodb-storage`) and use `helm delete` to delete them using the
automatically generated deployment names. Here is an example of a `helm
list` output:
```
% helm list
NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE
steely-mule 1 Sun Mar 31 21:11:07 2019 DEPLOYED kube-arangodb-crd-0.3.9 default
vetoed-ladybird 1 Mon Apr 8 11:36:58 2019 DEPLOYED kube-arangodb-0.3.10-preview default
```
So here, you would have to do
2018-03-20 10:33:37 +00:00
```bash
2019-04-08 09:42:21 +00:00
helm delete vetoed-ladybird
```
but **not delete `steely-mule`** . Then you could install the new version
with `helm install` as normal:
```bash
# The following will install the operator for `ArangoDeployment` &
# `ArangoDeploymentReplication` resources.
2022-06-07 19:19:21 +00:00
helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.13/kube-arangodb-1.2.13.tgz
2019-09-23 07:00:10 +00:00
# To use `ArangoLocalStorage`, set field `operator.features.storage` to true
2022-06-07 19:19:21 +00:00
helm install https://github.com/arangodb/kube-arangodb/releases/download/1.2.13/kube-arangodb-1.2.13.tgz --set "operator.features.storage=true"
2018-03-20 10:33:37 +00:00
```
2018-03-12 11:18:50 +00:00
## Building
```bash
2019-06-25 11:55:48 +00:00
DOCKERNAMESPACE=< your dockerhub account > make
2018-03-19 10:09:20 +00:00
kubectl apply -f manifests/arango-deployment-dev.yaml
# To use `ArangoLocalStorage`, also run
kubectl apply -f manifests/arango-storage-dev.yaml
2018-06-19 09:47:56 +00:00
# To use `ArangoDeploymentReplication`, also run
kubectl apply -f manifests/arango-deployment-replication-dev.yaml
2018-03-12 11:18:50 +00:00
```
2021-05-25 09:41:29 +00:00
## ArangoExporter
[ArangoExporter ](https://github.com/arangodb-helper/arangodb-exporter ) project has been merged with ArangoOperator.
Starting from ArangoDB 3.6 Servers expose metrics endpoint with prometheus compatible format. From this point Exporter
is used only for TLS and/or Authentication termination to be compatible with all Prometheus installations.
ArangoExporter documentation can be found [here ](./docs/design/exporter.md )
