New to KubeDB? Please start here.

Deploy ProxySQL from private Docker registry

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

Before You Begin

• Read concept of ProxySQLVersion Catalog to learn detail concepts of ProxySQLVersion 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 a private repository of docker hub.

• You have to push the required images from KubeDB’s Dockerhub account into your private registry. For proxysql, push PROXYSQL_IMAGE, EXPORTER_IMAGE of following ProxySQLVersion, where deprecated is not true, to your private registry. Currently, KubeDB includes the following ProxySQLVersion object.

  $ kubectl get proxysqlversions  -o=custom-columns=NAME:.metadata.name,VERSION:.spec.version,PROXYSQL_IMAGE:.spec.proxysql.image,EXPORTER_IMAGE:.spec.exporter.image,DEPRECATED:.spec.deprecated
  NAME     VERSION   PROXYSQL_IMAGE          EXPORTER_IMAGE                   DEPRECATED
  2.0.4    2.0.4     kubedb/proxysql:v2.0.4   kubedb/proxysql-exporter:v1.1.0   <none>
  

  Docker hub repositories:

  • kubedb/operator
  • kubedb/proxysql
  • kubedb/proxysql-exporter

• Update KubeDB catalog for private Docker registry. Ex:

  apiVersion: catalog.kubedb.com/v1alpha1
  kind: ProxySQLVersion
  metadata:
    name: 2.0.4
  spec:
    exporter:
      image: PRIVATE_DOCKER_REGISTRY:v1.1.0
    podSecurityPolicies:
      databasePolicyName: proxysql-db
    proxysql:
      image: PRIVATE_DOCKER_REGISTRY:v2.0.4
    version: 2.0.4
  

• 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 Kubernetes 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 the appropriate value. Follow the steps to install KubeDB operator properly in the cluster so that to points to the DOCKER_REGISTRY you wish to pull images from.

Deploy ProxySQL from Private Registry

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

apiVersion: kubedb.com/v1alpha2
kind: ProxySQL
metadata:
  name: proxysql-pvt-reg
  namespace: demo
spec:
  version: "2.0.4"
  replicas: 1
  mode: GroupReplication
  backend:
    ref:
      apiGroup: "kubedb.com"
      kind: MySQL
      name: my-group
    replicas: 3
  podTemplate:
    spec:
      imagePullSecrets:
      - name: myregistrykey

Now run the command to deploy this ProxySQL object:

$ kubectl create -f https://github.com/kubedb/docs/raw/v2022.02.22/docs/examples/proxysql/private-registry.yaml
proxysql.kubedb.com/proxysql-pvt-reg created

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

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

Cleaning up

To clean up the Kubernetes resources created by this tutorial, run:

kubectl delete -n demo proxysql/proxysql-pvt-reg
kubectl delete ns demo

Next Steps

• Monitor your ProxySQL with KubeDB using out-of-the-box builtin-Prometheus.
• Monitor your ProxySQL with KubeDB using out-of-the-box Prometheus operator.
• Use custom config file to configure ProxySQL here.
• Detail concepts of ProxySQL CRD here.
• Detail concepts of ProxySQLVersion CRD here.
• Want to hack on KubeDB? Check our contribution guidelines.