You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
New to KubeDB? Please start here.
Installation Guide
There are 2 parts to installing KubeDB. You need to install a Kubernetes operator in your cluster using scripts or via Helm and download kubedb cli on your workstation. You can also use kubectl cli with KubeDB custom resource objects.
Install KubeDB Operator
To use kubedb, you will need to install KubeDB operator. KubeDB operator can be installed via a script or as a Helm chart.
Using Helm 3
KubeDB can be installed via Helm using the chart from AppsCode Charts Repository. To install the chart with the release name kubedb-operator:
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/kubedb --version v2020.07.10-beta.0
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2020.07.10-beta.0 v2020.07.10-beta.0 KubeDB by AppsCode - Production ready databases on Kubern...
appscode/kubedb-catalog v2020.07.10-beta.0 v2020.07.10-beta.0 KubeDB Catalog by AppsCode - Catalog for database versions
# Step 1: Install kubedb operator chart
$ helm install kubedb-operator appscode/kubedb --version v2020.07.10-beta.0 --namespace kube-system
# Step 2: wait until crds are registered
$ kubectl get crds -l app=kubedb -w
NAME AGE
elasticsearches.kubedb.com 12s
elasticsearchversions.kubedb.com 8s
etcds.kubedb.com 8s
etcdversions.kubedb.com 8s
memcacheds.kubedb.com 6s
memcachedversions.kubedb.com 6s
mongodbs.kubedb.com 7s
mongodbversions.kubedb.com 6s
mysqls.kubedb.com 7s
mysqlversions.kubedb.com 7s
postgreses.kubedb.com 8s
postgresversions.kubedb.com 7s
redises.kubedb.com 6s
redisversions.kubedb.com 6s
# Step 3(a): Install KubeDB catalog of database versions
$ helm install kubedb-catalog appscode/kubedb-catalog --version v2020.07.10-beta.0 --namespace kube-system
# Step 3(b): Or, if previously installed, upgrade KubeDB catalog of database versions
$ helm upgrade kubedb-catalog appscode/kubedb-catalog --version v2020.07.10-beta.0 --namespace kube-system
To see the detailed configuration options, visit here.
Using Helm 2
KubeDB can be installed via Helm using the chart from AppsCode Charts Repository. To install the chart with the release name kubedb-operator:
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search appscode/kubedb --version v2020.07.10-beta.0
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2020.07.10-beta.0 v2020.07.10-beta.0 KubeDB by AppsCode - Production ready databases on Kubern...
appscode/kubedb-catalog v2020.07.10-beta.0 v2020.07.10-beta.0 KubeDB Catalog by AppsCode - Catalog for database versions
# Step 1: Install kubedb operator chart
$ helm install appscode/kubedb --name kubedb-operator --version v2020.07.10-beta.0 \
--namespace kube-system
# Step 2: wait until crds are registered
$ kubectl get crds -l app=kubedb -w
NAME AGE
elasticsearches.kubedb.com 12s
elasticsearchversions.kubedb.com 8s
etcds.kubedb.com 8s
etcdversions.kubedb.com 8s
memcacheds.kubedb.com 6s
memcachedversions.kubedb.com 6s
mongodbs.kubedb.com 7s
mongodbversions.kubedb.com 6s
mysqls.kubedb.com 7s
mysqlversions.kubedb.com 7s
postgreses.kubedb.com 8s
postgresversions.kubedb.com 7s
redises.kubedb.com 6s
redisversions.kubedb.com 6s
# Step 3(a): Install KubeDB catalog of database versions
$ helm install appscode/kubedb-catalog --name kubedb-catalog --version v2020.07.10-beta.0 \
--namespace kube-system
# Step 3(b): Or, if previously installed, upgrade KubeDB catalog of database versions
$ helm upgrade kubedb-catalog appscode/kubedb-catalog --version v2020.07.10-beta.0 \
--namespace kube-system
To see the detailed configuration options, visit here.
Using YAML
If you prefer to not use Helm, you can generate YAMLs from KubeDB chart and deploy using kubectl. Here we are going to show the prodecure using Helm 3.
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/kubedb --version v2020.07.10-beta.0
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2020.07.10-beta.0 v2020.07.10-beta.0 KubeDB by AppsCode - Production ready databases on Kubern...
appscode/kubedb-catalog v2020.07.10-beta.0 v2020.07.10-beta.0 KubeDB Catalog by AppsCode - Catalog for database versions
# Step 1: Install kubedb operator chart
$ helm template kubedb-operator appscode/kubedb \
--version v2020.07.10-beta.0 \
--namespace kube-system \
--no-hooks | kubectl apply -f -
# Step 2: wait until crds are registered
$ kubectl get crds -l app=kubedb -w
NAME AGE
elasticsearches.kubedb.com 12s
elasticsearchversions.kubedb.com 8s
etcds.kubedb.com 8s
etcdversions.kubedb.com 8s
memcacheds.kubedb.com 6s
memcachedversions.kubedb.com 6s
mongodbs.kubedb.com 7s
mongodbversions.kubedb.com 6s
mysqls.kubedb.com 7s
mysqlversions.kubedb.com 7s
postgreses.kubedb.com 8s
postgresversions.kubedb.com 7s
redises.kubedb.com 6s
redisversions.kubedb.com 6s
# Step: Install/Upgrade KubeDB catalog of database versions
$ helm template kubedb-catalog appscode/kubedb-catalog \
--version v2020.07.10-beta.0 \
--namespace kube-system \
--no-hooks | kubectl apply -f -
To see the detailed configuration options, visit here.
Installing in GKE Cluster
If you are installing KubeDB on a GKE cluster, you will need cluster admin permissions to install KubeDB operator. Run the following command to grant admin permision to the cluster.
$ kubectl create clusterrolebinding "cluster-admin-$(whoami)" \
--clusterrole=cluster-admin \
--user="$(gcloud config get-value core/account)"
Verify operator installation
To check if KubeDB operator pods have started, run the following command:
$ kubectl get pods --all-namespaces -l app=kubedb --watch
Once the operator pods are running, you can cancel the above command by typing Ctrl+C.
Now, to confirm CRD groups have been registered by the operator, run the following command:
$ kubectl get crd -l app=kubedb
Now, you are ready to create your first database using KubeDB.
Configuring RBAC
KubeDB installer will create 3 user facing cluster roles:
| ClusterRole | Aggregates To | Desription |
|---|---|---|
| kubedb:core:admin | admin | Allows edit access to all KubeDB CRDs, intended to be granted within a namespace using a RoleBinding. This grants ability to wipeout databases and delete their record. |
| kubedb:core:edit | edit | Allows edit access to all KubeDB CRDs, intended to be granted within a namespace using a RoleBinding. |
| kubedb:core:view | view | Allows read-only access to KubeDB CRDs, intended to be granted within a namespace using a RoleBinding. |
These user facing roles supports ClusterRole Aggregation feature in Kubernetes 1.9 or later clusters.
Detect KubeDB operator version
To detect KubeDB operator version, exec into the operator pod and run /operator version command.
$ kubectl exec -it deploy/kubedb-operator -n kube-system -- /operator version
Version = v2020.07.10-beta.0
VersionStrategy = tag
GitTag = v2020.07.10-beta.0
GitBranch = release-0.13
CommitHash = 1e407192f56c449b4445d6514c26b7545dcda38d
CommitTimestamp = 2019-08-22T12:10:07
GoVersion = go1.12.9
Compiler = gcc
Platform = linux/amd64