Skip to content

Install Percona Server for MySQL on Google Kubernetes Engine (GKE)

This guide shows you how to deploy Percona Operator for MySQL on Google Kubernetes Engine (GKE). The document assumes some experience with the platform. For more information on the GKE, see the Kubernetes Engine Quickstart .

Prerequisites

All commands from this guide can be run either in the Google Cloud shell or in your local shell.

To use Google Cloud shell, you need nothing but a modern web browser.

If you would like to use your local shell, install the following:

  1. gcloud . This tool is part of the Google Cloud SDK. To install it, select your operating system on the official Google Cloud SDK documentation page and then follow the instructions.

  2. kubectl . It is the Kubernetes command-line tool you will use to manage and deploy applications. To install the tool, run the following command:

    $ gcloud auth login
    $ gcloud components install kubectl
    

Create and configure the GKE cluster

You can configure the settings using the gcloud tool. You can run it either in the Cloud Shell or in your local shell (if you have installed Google Cloud SDK locally on the previous step). The following command will create a cluster named my-cluster-name:

$ gcloud container clusters create my-cluster-name --project <project name> --zone us-central1-a --cluster-version 1.29 --machine-type n1-standard-4 --num-nodes=3

Note

You must edit the following command and other command-line statements to replace the <project name> placeholder with your project name. You may also be required to edit the zone location, which is set to us-central1 in the above example. Other parameters specify that we are creating a cluster with 3 nodes and with machine type of 4 vCPUs.

You may wait a few minutes for the cluster to be generated.

When the process is over, you can see it listed in the Google Cloud console

Select Kubernetes EngineClusters in the left menu panel:

image

Now you should configure the command-line access to your newly created cluster to make kubectl be able to use it.

In the Google Cloud Console, select your cluster and then click the Connect shown on the above image. You will see the connect statement which configures the command-line access. After you have edited the statement, you may run the command in your local shell:

$ gcloud container clusters get-credentials cluster1 --zone us-central1-a --project <project name>

Finally, use your Cloud Identity and Access Management (Cloud IAM) to control access to the cluster. The following command will give you the ability to create Roles and RoleBindings:

$ kubectl create clusterrolebinding cluster-admin-binding --clusterrole cluster-admin --user $(gcloud config get-value core/account)
Expected output
clusterrolebinding.rbac.authorization.k8s.io/cluster-admin-binding created

Install the Operator and deploy your MySQL cluster

  1. Deploy the Operator. By default deployment will be done in the default namespace. If that’s not the desired one, you can create a new namespace and/or set the context for the namespace as follows (replace the <namespace name> placeholder with some descriptive name):

    $ kubectl create namespace <namespace name>
    $ kubectl config set-context $(kubectl config current-context) --namespace=<namespace name>
    

    At success, you will see the message that namespace/<namespace name> was created, and the context (gke_<project name>_<zone location>_<cluster name>) was modified.

    Deploy the Operator using the following command:

    $ kubectl apply -f https://raw.githubusercontent.com/percona/percona-server-mysql-operator/v0.7.0/deploy/bundle.yaml
    
    Expected output
    customresourcedefinition.apiextensions.k8s.io/perconaservermysqlbackups.ps.percona.com created
    customresourcedefinition.apiextensions.k8s.io/perconaservermysqlrestores.ps.percona.com created
    customresourcedefinition.apiextensions.k8s.io/perconaservermysqls.ps.percona.com created
    serviceaccount/percona-server-mysql-operator created
    role.rbac.authorization.k8s.io/percona-server-mysql-operator-leaderelection created
    role.rbac.authorization.k8s.io/percona-server-mysql-operator created
    rolebinding.rbac.authorization.k8s.io/percona-server-mysql-operator-leaderelection created
    rolebinding.rbac.authorization.k8s.io/percona-server-mysql-operator created
    configmap/percona-server-mysql-operator-config created
    deployment.apps/percona-server-mysql-operator created
    
  2. The operator has been started, and you can deploy your MySQL cluster:

    $ kubectl apply -f https://raw.githubusercontent.com/percona/percona-server-mysql-operator/v0.7.0/deploy/cr.yaml
    
    Expected output
    perconaservermysql.ps.percona.com/cluster1 created
    

    Note

    This deploys default MySQL cluster configuration. Please see deploy/cr.yaml and Custom Resource Options for the configuration options. You can clone the repository with all manifests and source code by executing the following command:

    $ git clone -b v0.7.0 https://github.com/percona/percona-server-mysql-operator
    

    After editing the needed options, apply your modified deploy/cr.yaml file as follows:

    $ kubectl apply -f deploy/cr.yaml
    

    The creation process may take some time. When the process is over your cluster will obtain the ready status. You can check it with the following command:

    $ kubectl get ps
    
    Expected output
    NAME       REPLICATION   ENDPOINT                   STATE   MYSQL   ORCHESTRATOR   HAPROXY   ROUTER   AGE
    cluster1   async         cluster1-haproxy.default   ready   3       3              3                  5m50s
    
You can also track the creation process in Google Cloud console via the Object Browser

When the creation process is finished, it will look as follows:

image

Verifying the cluster operation

It may take ten minutes to get the cluster started. When kubectl get ps command finally shows you the cluster status as ready, you can try to connect to the cluster.

To connect to Percona Server for MySQL you will need the password for the root user. Passwords are stored in the Secrets object, which was generated during the previous steps.

Here’s how to get it:

  1. List the Secrets objects.

    $ kubectl get secrets
    
    It will show you the list of Secrets objects (by default the Secrets object you are interested in has cluster1-secrets name).

  2. Use the following command to get the password of the root user. Substitute cluster1 with your value, if needed:

    $ kubectl get secret cluster1-secrets -o yaml
    

    The command returns the YAML file with generated Secrets, including the root password, which should look as follows:

    ...
    data:
      ...
      root: <base64-encoded-password>
    
  3. The actual password is base64-encoded. Use the following command to bring it back to a human-readable form:

    $ echo '<base64-encoded-password>' | base64 --decode
    
  4. Run a container with mysql tool and connect its console output to your terminal. The following command will do this, naming the new Pod percona-client:

    $ kubectl run -i --rm --tty percona-client --image=percona:8.0 --restart=Never -- bash -il
    

    It may require some time to execute the command and deploy the correspondent Pod.

  5. Now run mysql tool in the percona-client command shell using the password obtained from the Secret instead of the <root password> placeholder. The command will look different depending on whether the cluster uses load balancing with HAProxy (the default behavior) or uses MySQL Router (can be used with Group Replication clusters):

    $ mysql -h cluster1-haproxy -uroot -p<root password>
    
    $ mysql -h cluster1-router -uroot -p<root password>
    
    Expected output
    mysql: [Warning] Using a password on the command line interface can be insecure.
    Welcome to the MySQL monitor.  Commands end with ; or \g.
    Your MySQL connection id is 4065
    Server version: 8.0.29-21 Percona Server (GPL), Release 21, Revision c59f87d2854
    
    Copyright (c) 2009-2022 Percona LLC and/or its affiliates
    Copyright (c) 2000, 2022, Oracle and/or its affiliates.
    
    Oracle is a registered trademark of Oracle Corporation and/or its
    affiliates. Other names may be trademarks of their respective
    owners.
    
    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
    
    mysql>
    

    The following example uses the MySQL prompt to check the max_connections variable:

    mysql> SHOW VARIABLES LIKE "max_connections";
    
    Expected output
    +-----------------+-------+
    | Variable_name   | Value |
    +-----------------+-------+
    | max_connections | 158   |
    +-----------------+-------+
    1 row in set (0.02 sec)
    
    mysql> 
    

Troubleshooting

If kubectl get ps command doesn’t show ready status too long, you can check the creation process with the kubectl get pods command:

$ kubectl get pods
Expected output
NAME                                            READY   STATUS    RESTARTS      AGE
cluster1-haproxy-0                              2/2     Running   0             44m
cluster1-haproxy-1                              2/2     Running   0             44m
cluster1-haproxy-2                              2/2     Running   0             44m
cluster1-mysql-0                                3/3     Running   0             46m
cluster1-mysql-1                                3/3     Running   2 (44m ago)   45m
cluster1-mysql-2                                3/3     Running   2 (42m ago)   43m
cluster1-orc-0                                  2/2     Running   0             46m
cluster1-orc-1                                  2/2     Running   0             45m
cluster1-orc-2                                  2/2     Running   0             44m
percona-server-mysql-operator-7c984f7c9-mgwh4   1/1     Running   0             47m

If the command output had shown some errors, you can examine the problematic Pod with the kubectl describe <pod name> command as follows:

$ kubectl describe pod cluster1-mysql-2

Review the detailed information for Warning statements and then correct the configuration. An example of a warning is as follows:

Warning FailedScheduling 68s (x4 over 2m22s) default-scheduler 0/1 nodes are available: 1 node(s) didn’t match pod affinity/anti-affinity, 1 node(s) didn’t satisfy existing pods anti-affinity rules.

Alternatively, you can examine your Pods via the object browser

The errors will look as follows:

image

Clicking the problematic Pod will bring you to the details page with the same warning:

image

Removing the GKE cluster

There are several ways that you can delete the cluster.

You can clean up the cluster with the gcloud command as follows:

$ gcloud container clusters delete <cluster name>

The return statement requests your confirmation of the deletion. Type y to confirm.

Also, you can delete your cluster via the Google Cloud console

Just click the Delete popup menu item in the clusters list:

image

The cluster deletion may take time.

Warning

After deleting the cluster, all data stored in it will be lost!

Get expert help

If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services. Join K8S Squad to benefit from early access to features and “ask me anything” sessions with the Experts.


Last update: 2024-05-02