Install KubeDB Enterprise Edition

KubeDB Enterprise edition is the open core version of KubeDB. It includes all the features (clustering, etc.) of KubeDB Community Edition and extends it by automating Day 2 operations, improving security and productivity.

  • Back and recovery - KubeDB will provide backup & recovery of databases using Stash.
  • Upgrade and Scaling - KubeDB will provide operator managed human-in-the-loop patch and minor upgrade, downgrade and scaling operations
  • SSL Support - KubeDB Enterprise operator supports SSL certificate management for supported database types via Jetstack’s cert-manager project.
  • User Management with HashiCorp Vault - KubeDB supports user management using HashiCorp Vault via KubeVault project.
  • Web Dashboard - KubeDB Enterprise offers a web based management console with Prometheus and Grafana integration for monitoring.
  • Connection Pooling - KubeDB Enterprise edition offers PgBouncer support for PostgreSQL and ProxySQL support for MySQL and Percona XtraDB.

A full features comparison between KubeDB Enterprise Edition and community version can be found here.

If you are willing to try KubeDB Enterprise Edition, you can grab a 14 days trial license from here.

Get a Trial License

In this section, we are going to show you how you can get a 14 days trial license for KubeDB Enterprise 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 must provide your work email address.
  • Then, select KubeDB Enterprise 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.

KubeDB Backend Overview
Fig: KubeDB 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.

Get an Enterprise License

If you are interested in purchasing Enterprise license, please contact us via [email protected] for further discussion. You can also set up a meeting via our calendly link.

If you are willing to purchasing Enterprise license but need more time to test in your dev cluster, feel free to contact [email protected]. We will be happy to extend your trial period.

Install

To activate the Enterprise features, you need to install both KubeDB Community operator and Enterprise operator chart. These operators can be installed as a Helm chart or simply as Kubernetes manifests. If you have already installed the Community operator, only install the Enterprise operator (step 4 in the following secttion).

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 --version v0.15.1
NAME                        CHART VERSION APP VERSION   DESCRIPTION
appscode/kubedb             v0.15.1  v0.15.1  KubeDB by AppsCode - Production ready databases on Kubernetes
appscode/kubedb-catalog     v0.15.1  v0.15.1  KubeDB Catalog by AppsCode - Catalog for database versions

$ helm search repo appscode/kubedb-enterprise --version v0.2.1
NAME                        CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb-enterprise  v0.2.1  v0.2.1  KubeDB Enterprise by AppsCode - Enterprise features for KubeDB

# Step 1: Install KubeDB Community operator chart
$ helm install kubedb-community appscode/kubedb \
  --version v0.15.1      \
  --namespace kube-system                       \
  --set-file license=/path/to/the/license.txt

# 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 v0.15.1              \
  --namespace kube-system

# Step 3(b): Or, if previously installed, upgrade KubeDB catalog of database versions
$ helm upgrade kubedb-catalog appscode/kubedb-catalog   \
  --version v0.15.1              \
  --namespace kube-system

# Step 4: Install KubeDB Enterprise operator chart
$ helm install kubedb-enterprise appscode/kubedb-enterprise  \
  --version v0.2.1                  \
  --namespace kube-system                                    \
  --set-file license=/path/to/the/license.txt

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:

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

$ helm search repo appscode/kubedb --version v0.15.1
NAME                        CHART VERSION APP VERSION   DESCRIPTION
appscode/kubedb             v0.15.1  v0.15.1  KubeDB by AppsCode - Production ready databases on Kubernetes
appscode/kubedb-catalog     v0.15.1  v0.15.1  KubeDB Catalog by AppsCode - Catalog for database versions

$ helm search repo appscode/kubedb-enterprise --version v0.2.1
NAME                        CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb-enterprise  v0.2.1  v0.2.1  KubeDB Enterprise by AppsCode - Enterprise features for KubeDB

# Step 1: Install KubeDB Community operator chart
$ helm install appscode/kubedb --name kubedb-community \
  --version v0.15.1     \
  --namespace kube-system                      \
  --set-file license=/path/to/the/license.txt

# 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 v0.15.1                     \
  --namespace kube-system

# Step 3(b): Or, if previously installed, upgrade KubeDB catalog of database versions
$ helm upgrade kubedb-catalog appscode/kubedb-catalog          \
  --version v0.15.1                     \
  --namespace kube-system

# Step 4: Install KubeDB Enterprise operator chart
$ helm install appscode/kubedb-enterprise --name kubedb-enterprise   \
  --version v0.2.1                          \
  --namespace kube-system                                            \
  --set-file 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 --version v0.15.1
NAME                        CHART VERSION APP VERSION   DESCRIPTION
appscode/kubedb             v0.15.1  v0.15.1  KubeDB by AppsCode - Production ready databases on Kubernetes
appscode/kubedb-catalog     v0.15.1  v0.15.1  KubeDB Catalog by AppsCode - Catalog for database versions

$ helm search repo appscode/kubedb-enterprise --version v0.2.1
NAME                        CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb-enterprise  v0.2.1  v0.2.1  KubeDB Enterprise by AppsCode - Enterprise features for KubeDB

# Step 1: Install KubeDB Community operator chart
$ helm template kubedb-community appscode/kubedb \
  --version v0.15.1      \
  --namespace kube-system                       \
  --set-file license=/path/to/the/license.txt   \
  --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
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: Install/Upgrade KubeDB catalog of database versions
$ helm template kubedb-catalog appscode/kubedb-catalog   \
  --version v0.15.1               \
  --namespace kube-system                                \
  --no-hooks | kubectl apply -f -

# Step 1: Install KubeDB Enterprise operator chart
$ helm template kubedb-enterprise appscode/kubedb-enterprise   \
  --version v0.2.1                    \
  --namespace kube-system                                      \
  --set-file license=/path/to/the/license.txt                  \
  --no-hooks | 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:

$ kubectl get pods --all-namespaces -l app.kubernetes.io/name=kubedb --watch

NAMESPACE     NAME                     READY     STATUS    RESTARTS   AGE
kube-system   kubedb-859d6bdb56-m9br5  1/1       Running   2          5s

$ kubectl get pods --all-namespaces -l app.kubernetes.io/name=kubedb-enterprise --watch

NAMESPACE     NAME                                READY   STATUS    RESTARTS   AGE
kube-system   kubedb-enterprise-568c884795-hzbgg  2/2     Running   0          5h35m

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.