New to KubeDB? Please start here.

Deploy MySQL from private Docker registry

KubeDB operator supports using private Docker registry. This tutorial will show you how to use KubeDB to run MySQL database using private Docker images.

Before You Begin

• Read concept of MySQL Version Catalog to learn detail concepts of MySQLVersion object.

• You need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using kind.

• You will also need a docker private registry or private repository. In this tutorial we will use private repository of docker hub.

• You have to push the required images from KubeDB’s Docker hub account into your private registry. For mysql, push DB_IMAGE, EXPORTER_IMAGE, REPLICATION_MODE_DETECTOR_IMAGE(only required for Group Replication), INITCONTAINER_IMAGE of following MySQLVersions, where deprecated is not true, to your private registry.

  $ kubectl get mysqlversions -n kube-system  -o=custom-columns=NAME:.metadata.name,VERSION:.spec.version,DB_IMAGE:.spec.db.image,EXPORTER_IMAGE:.spec.exporter.image,REPLICATION_MODE_DETECTOR_IMAGE:.spec.replicationModeDetector.image,INITCONTAINER_IMAGE:.spec.initContainer.image,DEPRECATED:.spec.deprecated
  NAME        VERSION   DB_IMAGE                  EXPORTER_IMAGE                   REPLICATION_MODE_DETECTOR_IMAGE           INITCONTAINER_IMAGE   DEPRECATED
  5.7.25-v2   5.7.25    kubedb/mysql:5.7.25-v2    kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  5.7.29-v1   5.7.29    suaas21/mysql:5.7.29-v1   kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  5.7.31-v1   5.7.31    suaas21/mysql:5.7.31-v1   kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  5.7.33      5.7.33    suaas21/mysql:5.7.33      kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  8.0.14-v2   8.0.14    kubedb/mysql:8.0.14-v2    kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  8.0.20-v1   8.0.20    kubedb/mysql:8.0.20-v1    kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  8.0.21-v1   8.0.21    suaas21/mysql:8.0.21-v1   kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  8.0.23      8.0.23    suaas21/mysql:8.0.23      kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  8.0.3-v2    8.0.3     kubedb/mysql:8.0.3-v2     kubedb/mysqld-exporter:v0.11.0   kubedb/replication-mode-detector:v0.3.2   kubedb/toybox:0.8.4   <none>
  

  Docker hub repositories:

  • kubedb/operator
  • kubedb/mysql
  • kubedb/mysql-tools
  • kubedb/mysqld-exporter

• Update KubeDB catalog for private Docker registry. Ex:

  apiVersion: catalog.kubedb.com/v1alpha1
  kind: MySQLVersion
  metadata:
    name: 8.0.23
  spec:
    db:
      image: PRIVATE_REGISTRY/mysql:8.0.23
    distribution: Oracle
    exporter:
      image: PRIVATE_REGISTRY/mysqld-exporter:v0.11.0
    initContainer:
      image: PRIVATE_REGISTRY/toybox:0.8.4
    podSecurityPolicies:
      databasePolicyName: mysql-db
    replicationModeDetector:
      image: PRIVATE_REGISTRY/replication-mode-detector:v0.4.0
    stash:
      addon:
        backupTask:
          name: mysql-backup-8.0.21
        restoreTask:
          name: mysql-restore-8.0.21
    upgradeConstraints:
      denylist:
        groupReplication:
        - < 8.0.23
        standalone:
        - < 8.0.23
    version: 8.0.23
  

• To keep things isolated, this tutorial uses a separate namespace called demo throughout this tutorial. Run the following command to prepare your cluster for this tutorial:

  $ kubectl create ns demo
  namespace/demo created
  

Create ImagePullSecret

ImagePullSecrets is a type of a Kubernete Secret whose sole purpose is to pull private images from a Docker registry. It allows you to specify the url of the docker registry, credentials for logging in and the image name of your private docker image.

Run the following command, substituting the appropriate uppercase values to create an image pull secret for your private Docker registry:

$ kubectl create secret docker-registry -n demo myregistrykey \
  --docker-server=DOCKER_REGISTRY_SERVER \
  --docker-username=DOCKER_USER \
  --docker-email=DOCKER_EMAIL \
  --docker-password=DOCKER_PASSWORD
secret/myregistrykey created

If you wish to follow other ways to pull private images see official docs of kubernetes.

NB: If you are using kubectl 1.9.0, update to 1.9.1 or later to avoid this issue.

Install KubeDB operator

When installing KubeDB operator, set the flags --docker-registry and --image-pull-secret to appropriate value. Follow the steps to install KubeDB operator properly in cluster so that to points to the DOCKER_REGISTRY you wish to pull images from.

Deploy MySQL database from Private Registry

While deploying MySQL from private repository, you have to add myregistrykey secret in MySQL spec.imagePullSecrets. Below is the MySQL CRD object we will create.

apiVersion: kubedb.com/v1alpha2
kind: MySQL
metadata:
  name: mysql-pvt-reg
  namespace: demo
spec:
  version: "8.0.23"
  storage:
    storageClassName: "standard"
    accessModes:
    - ReadWriteOnce
    resources:
      requests:
        storage: 1Gi
  podTemplate:
    spec:
      imagePullSecrets:
      - name: myregistrykey

Now run the command to deploy this MySQL object:

$ kubectl create -f https://github.com/kubedb/docs/raw/v2021.04.16/docs/guides/mysql/private-registry/yamls/standalone.yaml
mysql.kubedb.com/mysql-pvt-reg created

To check if the images pulled successfully from the repository, see if the MySQL is in running state:

$ kubectl get pods -n demo
NAME              READY     STATUS    RESTARTS   AGE
mysql-pvt-reg-0   1/1       Running   0          56s

Cleaning up

To cleanup the Kubernetes resources created by this tutorial, run:

kubectl patch -n demo mysql/mysql-pvt-reg -p '{"spec":{"terminationPolicy":"WipeOut"}}' --type="merge"
kubectl delete -n demo mysql/mysql-pvt-reg

kubectl patch -n demo drmn/mysql-pvt-reg -p '{"spec":{"wipeOut":true}}' --type="merge"
kubectl delete -n demo drmn/mysql-pvt-reg

kubectl delete ns demo

Next Steps

• Initialize MySQL with Script.
• Monitor your MySQL database with KubeDB using out-of-the-box Prometheus operator.
• Monitor your MySQL database with KubeDB using out-of-the-box builtin-Prometheus.
• Detail concepts of MySQL object.
• Detail concepts of MySQLVersion object.
• Want to hack on KubeDB? Check our contribution guidelines.