You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
Install KubeDB Community Edition
KubeDB Community edition is available under AppsCode-Community-1.0.0 license and free to use for both commercial and non-commercial purposes. Community Edition only manages KubeDB custom resources in the demo Kubernetes namespace. It comes with the cluster provisioning functionalities. However, it lacks some advanced features such as database backup/recovery, upgrading version, horizontal and vertical scaling, TLS/SSL support via cert-manager, updating configuration post provisioning, connection pooling, etc. compared to the Enterprise edition. A full features comparison between the KubeDB Community edition and Enterprise edition can be found here.
To use the KubeDB Community edition, you can grab 1 year free license from here. After that, you can issue another license for one more year. Typically we release a new version of the operator at least quarterly. So, you can just grab a new license every time you upgrade the operator.
Get a License
In this section, we are going to show you how you can get a 1 year free license for the KubeDB Community edition. You can get a license for your Kubernetes cluster by going through the following steps:
At first, go to AppsCode License Server and fill-up the form. It will ask for your Name, Email, the product you want to install, and your cluster ID (UID of the
kube-systemnamespace).Provide your name and email address. You can provide your personal or work email address.
Then, select
KubeDB Community Editionin the product field.Now, provide your cluster-ID. You can get your cluster ID easily by running the following command:
$ kubectl get ns kube-system -o=jsonpath='{.metadata.uid}'Then, you have to agree with the terms and conditions. We recommend reading it before checking the box.
Now, you can submit the form. After you submit the form, the AppsCode License server will send an email to the provided email address with a link to your license file.
Navigate to the provided link and save the license into a file. Here, we save the license to a
license.txtfile.
Here is a screenshot of the license form.
You can create licenses for as many clusters as you want. You can upgrade your license any time without re-installing KubeDB by following the upgrading guide from here.
KubeDB licensing process has been designed to work with CI/CD workflow. You can automatically obtain a license from your CI/CD pipeline by following the guide from here.
Install
KubeDB operator can be installed as a Helm chart or simply as Kubernetes manifests.
Using Helm 3
KubeDB can be installed via Helm using the chart from AppsCode Charts Repository. To install, follow the steps below:
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/kubedb
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2023.01.17 v2023.01.17 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.15.1 v0.15.1 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2023.01.17 v2023.01.17 KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-crds v2023.01.17 v2023.01.17 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.6.1 v0.6.1 KubeDB Dashboard by AppsCode
appscode/kubedb-grafana-dashboards v2023.01.17 v2023.01.17 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-metrics v2023.01.17 v2023.01.17 KubeDB State Metrics
appscode/kubedb-ops-manager v0.17.1 v0.17.1 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2023.01.17 v2023.01.17 KubeDB Opscenter by AppsCode
appscode/kubedb-provisioner v0.30.1 v0.30.1 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.6.1 v0.6.1 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui-server v0.6.1 v0.6.1 A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server v0.6.1 v0.6.1 KubeDB Webhook Server by AppsCode
# Install KubeDB Community edition
$ helm install kubedb appscode/kubedb \
--version v2023.01.17 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
If you are using private Docker registries using self-signed certificates, please pass the registry domains to the operator like below:
# Install KubeDB Community edition
$ helm install kubedb appscode/kubedb \
--version v2023.01.17 \
--namespace kubedb --create-namespace \
--set global.insecureRegistries[0]=hub.example.com \
--set global.insecureRegistries[1]=hub2.example.com \
--set-file global.license=/path/to/the/license.txt
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
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2023.01.17 v2023.01.17 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.15.1 v0.15.1 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2023.01.17 v2023.01.17 KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-crds v2023.01.17 v2023.01.17 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.6.1 v0.6.1 KubeDB Dashboard by AppsCode
appscode/kubedb-grafana-dashboards v2023.01.17 v2023.01.17 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-metrics v2023.01.17 v2023.01.17 KubeDB State Metrics
appscode/kubedb-ops-manager v0.17.1 v0.17.1 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2023.01.17 v2023.01.17 KubeDB Opscenter by AppsCode
appscode/kubedb-provisioner v0.30.1 v0.30.1 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.6.1 v0.6.1 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui-server v0.6.1 v0.6.1 A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server v0.6.1 v0.6.1 KubeDB Webhook Server by AppsCode
# Install KubeDB Community operator chart
$ helm template kubedb appscode/kubedb \
--version v2023.01.17 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt \
--set global.skipCleaner=true | kubectl apply -f -
If you are using private Docker registries using self-signed certificates, please pass the registry domains to the operator like below:
# Install KubeDB Community edition
$ helm template kubedb appscode/kubedb \
--version v2023.01.17 \
--namespace kubedb --create-namespace \
--set global.insecureRegistries[0]=hub.example.com \
--set global.insecureRegistries[1]=hub2.example.com \
--set-file global.license=/path/to/the/license.txt \
--set global.skipCleaner=true | kubectl apply -f -
To see the detailed configuration options, visit here.
Verify installation
To check if KubeDB operator pods have started, run the following command:
$ watch kubectl get pods --all-namespaces -l "app.kubernetes.io/instance=kubedb"
NAME READY STATUS RESTARTS AGE
kubedb-kubedb-provisioner-b6696cffc-kfgmg 1/1 Running 0 69s
kubedb-kubedb-webhook-server-7dbddc467f-n4zkw 1/1 Running 0 69s
Once the operator pod is 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.kubernetes.io/name=kubedb
Now, you are ready to create your first database using KubeDB.