You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
New to KubeDB? Please start here.
Deploy PerconaXtraDB from private Docker registry
KubeDB operator supports using private Docker registry. This tutorial will show you how to use KubeDB to run PerconaXtraDB database using private Docker images.
Before You Begin
Read concept of PerconaXtraDB Version Catalog to learn detail concepts of
PerconaXtraDBVersion
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 perconaxtradb, push
DB_IMAGE
,EXPORTER_IMAGE
,INITCONTAINER_IMAGE
of following PerconaXtraDBVersions, wheredeprecated
is not true, to your private registry.
$ kubectl get perconaxtradbversions -n kube-system -o=custom-columns=NAME:.metadata.name,VERSION:.spec.version,DB_IMAGE:.spec.db.image,EXPORTER_IMAGE:.spec.exporter.image,INITCONTAINER_IMAGE:.spec.initContainer.image,DEPRECATED:.spec.deprecated
NAME VERSION DB_IMAGE EXPORTER_IMAGE INITCONTAINER_IMAGE DEPRECATED
8.0.26 8.0.26 percona/percona-xtradb-cluster:8.0.26 prom/mysqld-exporter:v0.13.0 kubedb/percona-xtradb-init:0.2.0 <none>
8.0.28 8.0.28 percona/percona-xtradb-cluster:8.0.28 prom/mysqld-exporter:v0.13.0 kubedb/percona-xtradb-init:0.2.0 <none>
Docker hub repositories:
Update KubeDB catalog for private Docker registry. Ex:
apiVersion: catalog.kubedb.com/v1alpha1 kind: PerconaXtraDBVersion metadata: name: 8.0.26 spec: db: image: PRIVATE_REGISTRY/mysql:8.0.26 exporter: image: PRIVATE_REGISTRY/mysqld-exporter:v0.11.0 initContainer: image: PRIVATE_REGISTRY/busybox podSecurityPolicies: databasePolicyName: perconaxtra-db version: 8.0.26
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 pxregistrykey \
--docker-server=DOCKER_REGISTRY_SERVER \
--docker-username=DOCKER_USER \
--docker-email=DOCKER_EMAIL \
--docker-password=DOCKER_PASSWORD
secret/pxregistrykey 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 PerconaXtraDB database from Private Registry
While deploying PerconaXtraDB
from private repository, you have to add pxregistrykey
secret in PerconaXtraDB
spec.imagePullSecrets
.
Below is the PerconaXtraDB CRD object we will create.
apiVersion: kubedb.com/v1alpha2
kind: PerconaXtraDB
metadata:
name: px-pvt-reg
namespace: demo
spec:
version: "8.0.26"
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
podTemplate:
spec:
imagePullSecrets:
- name: pxregistrykey
terminationPolicy: WipeOut
Now run the command to deploy this PerconaXtraDB
object:
$ kubectl apply -f https://github.com/kubedb/docs/raw/v2023.02.28/docs/guides/percona-xtradb/private-registry/quickstart/examples/demo.yaml
perconaxtradb.kubedb.com/px-pvt-reg created
To check if the images pulled successfully from the repository, see if the PerconaXtraDB
is in running state:
$ kubectl get pods -n demo
NAME READY STATUS RESTARTS AGE
px-pvt-reg-0 1/1 Running 0 56s
Cleaning up
To cleanup the Kubernetes resources created by this tutorial, run:
$ kubectl delete perconaxtradb -n demo px-pvt-reg
perconaxtradb.kubedb.com "px-pvt-reg" deleted
$ kubectl delete ns demo
namespace "demo" deleted