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. 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-system namespace).

• Provide your name and email address. You can provide your personal or work email address.

• Then, select KubeDB Community Edition in 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.txt file.

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.

• Helm 3 (Recommended)
• Helm 2
• YAML

$ 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             v2021.03.17   v2021.03.17 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler  v0.2.1        v0.2.1      KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog     v0.17.1       v0.17.1     KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-community   v0.17.1       v0.17.1     KubeDB Community by AppsCode - Community featur...
appscode/kubedb-crds        v0.17.1       v0.17.1     KubeDB Custom Resource Definitions
appscode/kubedb-enterprise  v0.4.1        v0.4.1      KubeDB Enterprise by AppsCode - Enterprise feat...

# Install KubeDB Community operator chart
$ helm install kubedb appscode/kubedb \
  --version v2021.03.17      \
  --namespace kube-system                       \
  --set-file global.license=/path/to/the/license.txt

$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update

$ helm search appscode/kubedb
NAME                        CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb             v2021.03.17   v2021.03.17 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler  v0.2.1        v0.2.1      KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog     v0.17.1       v0.17.1     KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-community   v0.17.1       v0.17.1     KubeDB Community by AppsCode - Community featur...
appscode/kubedb-crds        v0.17.1       v0.17.1     KubeDB Custom Resource Definitions
appscode/kubedb-enterprise  v0.4.1        v0.4.1      KubeDB Enterprise by AppsCode - Enterprise feat...

# Install KubeDB Community operator chart
$ helm install appscode/kubedb --name kubedb \
  --version v2021.03.17 \
  --namespace kube-system \
  --set-file global.license=/path/to/the/license.txt

$ 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             v2021.03.17   v2021.03.17 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler  v0.2.1        v0.2.1      KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog     v0.17.1       v0.17.1     KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-community   v0.17.1       v0.17.1     KubeDB Community by AppsCode - Community featur...
appscode/kubedb-crds        v0.17.1       v0.17.1     KubeDB Custom Resource Definitions
appscode/kubedb-enterprise  v0.4.1        v0.4.1      KubeDB Enterprise by AppsCode - Enterprise feat...

#  Install KubeDB Community operator chart
$ helm template kubedb appscode/kubedb \
  --version v2021.03.17       \
  --namespace kube-system                        \
  --set-file global.license=/path/to/the/license.txt    \
  --set global.skipCleaner=true | kubectl apply -f -

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"
NAMESPACE     NAME                                        READY   STATUS    RESTARTS   AGE
kube-system   kubedb-kubedb-community-7f4dc7c49c-l6ddf    1/1     Running   0          48s

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.