You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
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. Enterprise Edition can be used to manage KubeDB custom resources in any Kubernetes namespace.
- 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 30 days trial license from here.
Get a Trial License
In this section, we are going to show you how you can get a 30 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-systemnamespace). - Provide your name and email address. You must provide your work email address.
- Then, select
KubeDB Enterprise 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 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.
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
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.15.0-rc.1 v0.15.0-rc.1 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-crds v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.6.0-rc.1 v0.6.0-rc.1 KubeDB Dashboard by AppsCode
appscode/kubedb-grafana-dashboards v2022.12.24-rc.1 v2022.12.24-rc.1 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-metrics v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB State Metrics
appscode/kubedb-ops-manager v0.17.0-rc.1 v0.17.0-rc.1 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB Opscenter by AppsCode
appscode/kubedb-provisioner v0.30.0-rc.1 v0.30.0-rc.1 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.6.0-rc.1 v0.6.0-rc.1 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui-server v0.6.0-rc.1 v0.6.0-rc.1 A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server v0.6.0-rc.1 v0.6.0-rc.1 KubeDB Webhook Server by AppsCode
# Install KubeDB Enterprise edition
$ helm install kubedb appscode/kubedb \
--version v2022.12.24-rc.1 \
--namespace kubedb --create-namespace \
--set kubedb-provisioner.enabled=true \
--set kubedb-ops-manager.enabled=true \
--set kubedb-autoscaler.enabled=true \
--set kubedb-dashboard.enabled=true \
--set kubedb-schema-manager.enabled=true \
--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 procedure 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 v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.15.0-rc.1 v0.15.0-rc.1 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-crds v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.6.0-rc.1 v0.6.0-rc.1 KubeDB Dashboard by AppsCode
appscode/kubedb-grafana-dashboards v2022.12.24-rc.1 v2022.12.24-rc.1 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-metrics v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB State Metrics
appscode/kubedb-ops-manager v0.17.0-rc.1 v0.17.0-rc.1 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2022.12.24-rc.1 v2022.12.24-rc.1 KubeDB Opscenter by AppsCode
appscode/kubedb-provisioner v0.30.0-rc.1 v0.30.0-rc.1 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.6.0-rc.1 v0.6.0-rc.1 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui-server v0.6.0-rc.1 v0.6.0-rc.1 A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server v0.6.0-rc.1 v0.6.0-rc.1 KubeDB Webhook Server by AppsCode
# Install KubeDB Enterprise operator chart
$ helm template kubedb appscode/kubedb \
--version v2022.12.24-rc.1 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt \
--set kubedb-provisioner.enabled=true \
--set kubedb-ops-manager.enabled=true \
--set kubedb-autoscaler.enabled=true \
--set kubedb-dashboard.enabled=true \
--set kubedb-schema-manager.enabled=true \
--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-autoscaler-b5dd47dc5-bxnrq 1/1 Running 0 48s
kubedb-kubedb-dashboard-99db95dc4-j78w2 1/1 Running 0 48s
kubedb-kubedb-ops-manager-6f766b86c6-h9m66 1/1 Running 0 48s
kubedb-kubedb-provisioner-6fd44d5784-d8v9c 1/1 Running 0 48s
kubedb-kubedb-schema-manager-f65c79878-tnftp 1/1 Running 0 48s
kubedb-kubedb-webhook-server-6cf469bdf4-72wvz 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.