1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-14 11:57:37 +00:00
ArangoDB Kubernetes Operator - Start ArangoDB on Kubernetes in 5min
Find a file
2019-06-07 12:02:04 +02:00
.vscode Undo some VScode change. 2019-05-16 10:48:27 +02:00
dashboard Updated manifest to 0.3.11 2019-06-07 11:29:38 +02:00
deps More Go 1.12 2019-05-07 10:10:23 +02:00
docs Add a note. 2019-05-17 16:05:39 +02:00
examples Experimental tool to reboot a cluster from volumes. 2019-03-12 15:51:32 +01:00
manifests Updated manifest to 0.3.11 2019-06-07 11:29:38 +02:00
pkg Increase some timeouts. 2019-05-24 15:41:31 +02:00
scripts Fixed some inconsistent naming. 2019-03-11 10:38:57 +01:00
tests Add metrics test. 2019-05-17 12:17:07 +02:00
tools Get rid of automatic CHANGELOG generation. 2019-02-19 17:42:21 +01:00
.dockerignore Added dashboard to dockerignore 2018-07-09 16:25:41 +02:00
.gitignore Excluded .envrc 2018-06-07 09:25:08 +02:00
CHANGELOG.md CHANGELOG. 2019-06-07 11:24:50 +02:00
Dockerfile Initial API objects & vendoring 2018-02-09 11:11:33 +01:00
Dockerfile.test Creating test framework 2018-02-20 09:49:01 +01:00
go.mod Intermediate commit. 2019-05-14 15:51:47 +02:00
go.sum Intermediate commit. 2019-05-14 15:51:47 +02:00
Jenkinsfile.groovy Added more test environment for license stuff. 2018-12-03 14:34:58 +01:00
LICENSE Add LICENSE 2018-04-03 08:20:49 +02:00
lifecycle.go Minor 2018-08-30 08:23:13 +02:00
main.go More Go 1.12 2019-05-07 10:10:23 +02:00
MAINTAINERS.md Finishing touches to MAINTAINERS file. 2019-04-08 11:52:11 +02:00
Makefile Check variables before codegen. 2019-06-03 18:53:31 +02:00
README.md Feature-wise production readiness. 2019-06-07 12:02:04 +02:00
reboot.go Added labels. 2019-03-15 10:00:20 +01:00
storage.go Rename repository to kube-arangodb 2018-03-13 16:25:33 +01:00
VERSION Updated to 0.3.11+git 2019-06-07 11:29:54 +02:00

ArangoDB Kubernetes Operator

Docker Pulls

ArangoDB Kubernetes Operator helps do run ArangoDB deployments on Kubernetes clusters.

To get started, follow the Installation instructions below and/or read the tutorial.

State

The ArangoDB Kubernetes Operator is still in development.

Running ArangoDB deployments (single, active-failover or cluster) is reasonably stable, and we're in the process of validating production readiness of various Kubernetes platforms.

The feature set of the ArangoDB Kubernetes Operator is close to what it is intended to be.

Documentation

Production readiness state

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".

The following table has the general readiness state, the table below covers individual newer features separately.

Platform Kubernetes version ArangoDB version ArangoDB K8s Operator Version State Production ready Remarks
Google GKE 1.10 >= 3.3.13 Runs Yes Don't use micro nodes
Google GKE 1.11 >= 3.3.13 Runs Yes Don't use micro nodes
Amazon EKS 1.11 >= 3.3.13 Runs Yes
Pivotal PKS 1.11 >= 3.3.13 Runs Yes
IBM Cloud 1.11 >= 3.4.5 >= 0.3.11 Runs Yes
IBM Cloud 1.12 >= 3.4.5 >= 0.3.11 Runs Yes
Amazon & Kops 1.10 >= 3.3.13 Runs No
Azure AKS 1.10 >= 3.3.13 Runs No
OpenShift 1.10 >= 3.3.13 Runs No
Bare metal (kubeadm) 1.10 >= 3.3.13 Runs Yes
Bare metal (kubeadm) 1.11 >= 3.3.13 Runs Yes
Bare metal (kubeadm) 1.12 >= 3.3.13 Runs In progress
Bare metal (kubeadm) 1.13 >= 3.3.13 Runs Yes
Bare metal (kubeadm) 1.14 >= 3.3.13 Runs In progress
Minikube 1.10 >= 3.3.13 Runs Not intended
Docker for Mac Edge 1.10 >= 3.3.13 Runs Not intended
Scaleway Kubernetes 1.10 >= 3.3.13 ? No

Feature-wise production readiness table:

Feature ArangoDB K8s Operator Version Production Readiness Remarks
Pod Disruption Budgets 0.3.10 new - alpha
0.3.11 beta
Volume Resizing 0.3.10 new - beta
0.3.11 beta
Disabling of liveness probes 0.3.10 new - beta
0.3.11 production ready
Volume Claim Templates 0.3.11 new - alpha
Prometheus Metrics export 0.3.11 new - alpha needs Prometheus
User sidecar containers 0.3.11 new - alpha

Installation of latest release using Kubectl

kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/0.3.11/manifests/arango-crd.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/0.3.11/manifests/arango-deployment.yaml
# To use `ArangoLocalStorage`, also run
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/0.3.11/manifests/arango-storage.yaml
# To use `ArangoDeploymentReplication`, also run
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/0.3.11/manifests/arango-deployment-replication.yaml

This procedure can also be used for upgrades and will not harm any running ArangoDB deployments.

Installation of latest release using Helm

Only use this procedure for a new install of the operator. See below for upgrades.

# The following will install the custom resources required by the operators.
helm install https://github.com/arangodb/kube-arangodb/releases/download/0.3.11/kube-arangodb-crd.tgz
# The following will install the operator for `ArangoDeployment` &
# `ArangoDeploymentReplication` resources.
helm install https://github.com/arangodb/kube-arangodb/releases/download/0.3.11/kube-arangodb.tgz
# To use `ArangoLocalStorage`, also run
helm install https://github.com/arangodb/kube-arangodb/releases/download/0.3.11/kube-arangodb-storage.tgz

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
intent-camel    	1       	Mon Apr  8 11:37:52 2019	DEPLOYED	kube-arangodb-storage-0.3.10-preview	           	default  
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

helm delete intent-camel
helm delete vetoed-ladybird

but not delete steely-mule. Then you could install the new version with helm install as normal:

# The following will install the operator for `ArangoDeployment` &
# `ArangoDeploymentReplication` resources.
helm install https://github.com/arangodb/kube-arangodb/releases/download/0.3.11/kube-arangodb.tgz
# To use `ArangoLocalStorage`, also run
helm install https://github.com/arangodb/kube-arangodb/releases/download/0.3.11/kube-arangodb-storage.tgz

Building

DOCKERNAMESPACE=<your dockerhub account> make
kubectl apply -f manifests/arango-deployment-dev.yaml
# To use `ArangoLocalStorage`, also run
kubectl apply -f manifests/arango-storage-dev.yaml
# To use `ArangoDeploymentReplication`, also run
kubectl apply -f manifests/arango-deployment-replication-dev.yaml