Upgrade Database and Operator¶

Starting from the version 1.1.0, Percona Operator for MySQL based on Percona XtraDB Cluster allows upgrades to newer versions. The upgradable components of the cluster are the following ones:

the Operator;
Custom Resource Definition (CRD),
Database Management System (Percona XtraDB Cluster).

The list of recommended upgrade scenarios includes two variants:

Upgrade to the new versions of the Operator and Percona XtraDB Cluster,
Minor Percona XtraDB Cluster version upgrade without the Operator upgrade.

Upgrading the Operator and CRD¶

Note

The Operator supports last 3 versions of the CRD, so it is technically possible to skip upgrading the CRD and just upgrade the Operator. If the CRD is older than the new Operator version by no more than three releases, you will be able to continue using the old CRD and even carry on Percona XtraDB Cluster minor version upgrades with it. But the recommended way is to update the Operator and CRD.

Only the incremental update to a nearest version of the Operator is supported (for example, update from 1.4.0 to 1.5.0). To update to a newer version, which differs from the current version by more than one, make several incremental updates sequentially.

Manual upgrade¶

The upgrade includes the following steps.

Update the Custom Resource Definition for the Operator, taking it from the official repository on Github, and do the same for the Role-based access control:

$ kubectl apply -f https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/v1.13.0/deploy/crd.yaml
$ kubectl apply -f https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/v1.13.0/deploy/rbac.yaml

Now you should apply a patch to your deployment, supplying necessary image name with a newer version tag. You can find the proper image name for the current Operator release in the list of certified images (for older releases, please refer to the old releases documentation archive). For example, updating to the 1.13.0 version should look as follows.
```
$ kubectl patch deployment percona-xtradb-cluster-operator \
  -p'{"spec":{"template":{"spec":{"containers":[{"name":"percona-xtradb-cluster-operator","image":"percona/percona-xtradb-cluster-operator:1.13.0"}]}}}}'
```
The deployment rollout will be automatically triggered by the applied patch. You can track the rollout process in real time with the kubectl rollout status command with the name of your cluster:
```
$ kubectl rollout status deployments percona-xtradb-cluster-operator
```
Note

Labels set on the Operator Pod will not be updated during upgrade.

Upgrade via helm¶

If you have installed the Operator using Helm, you can upgrade the Operator with the helm upgrade command.

In case if you installed the Operator with no customized parameters, the upgrade can be done as follows:
```
$ helm upgrade my-op percona/pxc-operator --version 1.13.0
```
The my-op parameter in the above example is the name of a release object which which you have chosen for the Operator when installing its Helm chart.

If the Operator was installed with some customized parameters, you should list these options in the upgrade command.
Note

You can get list of used options in YAML format with the helm get values my-op -a > my-values.yaml command, and this file can be directly passed to the upgrade command as follows:
```
$ helm upgrade my-op percona/pxc-operator --version 1.13.0 -f my-values.yaml
```

Update the Custom Resource Definition for the Operator, taking it from the official repository on Github, and do the same for the Role-based access control:

$ kubectl apply -f https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/v1.13.0/deploy/crd.yaml
$ kubectl apply -f https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/v1.13.0/deploy/rbac.yaml

Note

You can use helm upgrade to upgrade the Operator only. The Database Management System (Percona XtraDB Cluster) should be upgraded in the same way whether you used helm to install it or not.

Upgrading Percona XtraDB Cluster¶

The following section presumes that you are upgrading your cluster within the Smart Update strategy, when the Operator controls how the objects are updated. Smart Update strategy is on when the updateStrategy key in the Custom Resource configuration file is set to SmartUpdate (this is the default value and the recommended way for upgrades).

Note

As an alternative, the updateStrategy key can be set to RollingUpdate and OnDelete. You can find out more about it in the appropriate section.

Manual upgrade¶

Manual update of Percona XtraDB Cluster can be done as follows:

Make sure that spec.updateStrategy option in the Custom Resource is set to SmartUpdate, spec.upgradeOptions.apply option is set to Never or Disabled (this means that the Operator will not carry on upgrades automatically).
```
...
spec:
  updateStrategy: SmartUpdate
  upgradeOptions:
    apply: Disabled
    ...
```

Now apply a patch to your Custom Resource, setting necessary Custom Resource version and image names with a newer version tag.

Note

Check the version of the Operator you have in your Kubernetes environment. Please refer to the Operator upgrade guide to upgrade the Operator and CRD, if needed.

Patching Custom Resource is done with the kubectl patch pxc command. Actual image names can be found in the list of certified images (for older releases, please refer to the old releases documentation archive). For example, updating cluster1 cluster to the 1.13.0 version should look as follows:

For Percona XtraDB Cluster 8.0For Percona XtraDB Cluster 5.7

$ kubectl patch pxc cluster1 --type=merge --patch '{
   "spec": {
       "crVersion":"1.13.0",
       "pxc":{ "image": "percona/percona-xtradb-cluster:8.0.32-24.2" },
       "proxysql": { "image": "percona/percona-xtradb-cluster-operator:1.13.0-proxysql" },
       "haproxy":  { "image": "percona/percona-xtradb-cluster-operator:1.13.0-haproxy" },
       "backup":   { "image": "percona/percona-xtradb-cluster-operator:1.13.0-pxc8.0-backup" },
       "logcollector": { "image": "percona/percona-xtradb-cluster-operator:1.13.0-logcollector" },
       "pmm":      { "image": "percona/pmm-client:2.38.0" }
   }}'

$ kubectl patch pxc cluster1 --type=merge --patch '{
   "spec": {
       "crVersion":"1.13.0",
       "pxc":{ "image": "percona/percona-xtradb-cluster:5.7.42-31.65" },
       "proxysql": { "image": "percona/percona-xtradb-cluster-operator:1.13.0-proxysql" },
       "haproxy":  { "image": "percona/percona-xtradb-cluster-operator:1.13.0-haproxy" },
       "backup":   { "image": "percona/percona-xtradb-cluster-operator:1.13.0-pxc5.7-backup" },
       "logcollector": { "image": "percona/percona-xtradb-cluster-operator:1.13.0-logcollector" },
       "pmm":      { "image": "percona/pmm-client:2.38.0" }
   }}'

Warning

The above command upgrades various components of the cluster including PMM Client. It is highly recommended to upgrade PMM Server before upgrading PMM Client. If it wasn’t done and you would like to avoid PMM Client upgrade, remove it from the list of images, reducing the last of two patch commands as follows:

For Percona XtraDB Cluster 8.0For Percona XtraDB Cluster 5.7

$ kubectl patch pxc cluster1 --type=merge --patch '{
   "spec": {
       "crVersion":"1.13.0",
       "pxc":{ "image": "percona/percona-xtradb-cluster:8.0.32-24.2" },
       "proxysql": { "image": "percona/percona-xtradb-cluster-operator:1.13.0-proxysql" },
       "haproxy":  { "image": "percona/percona-xtradb-cluster-operator:1.13.0-haproxy" },
       "backup":   { "image": "percona/percona-xtradb-cluster-operator:1.13.0-pxc8.0-backup" },
       "logcollector": { "image": "percona/percona-xtradb-cluster-operator:1.13.0-logcollector" }
   }}'

$ kubectl patch pxc cluster1 --type=merge --patch '{
   "spec": {
       "crVersion":"1.13.0",
       "pxc":{ "image": "percona/percona-xtradb-cluster:5.7.42-31.65" },
       "proxysql": { "image": "percona/percona-xtradb-cluster-operator:1.13.0-proxysql" },
       "haproxy":  { "image": "percona/percona-xtradb-cluster-operator:1.13.0-haproxy" },
       "backup":   { "image": "percona/percona-xtradb-cluster-operator:1.13.0-pxc5.7-backup" },
       "logcollector": { "image": "percona/percona-xtradb-cluster-operator:1.13.0-logcollector" }
   }}'

The deployment rollout will be automatically triggered by the applied patch. You can track the rollout process in real time with the kubectl rollout status command with the name of your cluster:
```
$ kubectl rollout status sts cluster1-pxc
```

Automated upgrade¶

Smart Update strategy allows you to automate upgrades even more. In this case the Operator can either detect the availability of the new Percona XtraDB Cluster version, or rely on the user’s choice of the version. To check the availability of the new version, the Operator will query a special Version Service server at scheduled times to obtain fresh information about version numbers and valid image paths.

If the current version should be upgraded, the Operator updates the Custom Resource to reflect the new image paths and carries on sequential Pods deletion, allowing StatefulSet to redeploy the cluster Pods with the new image. You can configure Percona XtraDB Cluster upgrade via the deploy/cr.yaml configuration file as follows:

Make sure that spec.updateStrategy option is set to SmartUpdate.
Change spec.crVersion option to match the version of the Custom Resource Definition upgrade you have done while upgrading the Operator:
```
...
spec:
  crVersion: 1.13.0
  ...
```
Note

If you don’t update crVersion, minor version upgrade is the only one to occur. For example, the image percona-xtradb-cluster:8.0.25-15.1 can be upgraded to percona-xtradb-cluster:8.0.27-18.1.
Change the upgradeOptions.apply option from Disabled to one of the following values:
- Recommended - scheduled upgrades will choose the most recent version of software flagged as “Recommended” (for clusters created from scratch, the Percona XtraDB Cluster 8.0 version will be selected instead of the Percona XtraDB Cluster 5.7 one regardless of the image path; for already existing clusters, the 8.0 vs. 5.7 branch choice will be preserved),
- 8.0-recommended, 5.7-recommended - same as above, but preserves specific major Percona XtraDB Cluster version for newly provisioned clusters (ex. 8.0 will not be automatically used instead of 5.7),
- Latest - automatic upgrades will choose the most recent version of the software available,
- 8.0-latest, 5.7-latest - same as above, but preserves specific major Percona XtraDB Cluster version for newly provisioned clusters (ex. 8.0 will not be automatically used instead of 5.7),
- version number - specify the desired version explicitly (version numbers are specified as 8.0.32-24.2, 5.7.42-31.65, etc.). Actual versions can be found in the list of certified images (for older releases, please refer to the old releases documentation archive).
Make sure the upgradeOptions.versionServiceEndpoint key is set to a valid Version Server URL (otherwise upgrades will not occur).
Percona’s Version Service (default)Version Service inside your cluster
You can use the URL of the official Percona’s Version Service (default). Set upgradeOptions.versionServiceEndpoint to https://check.percona.com.
Alternatively, you can run Version Service inside your cluster. This can be done with the kubectl command as follows:
$ kubectl run version-service --image=perconalab/version-service --env="SERVE_HTTP=true" --port 11000 --expose
Note

Version Service is never checked if automatic updates are disabled in the upgradeOptions.apply option. If automatic updates are enabled, but the Version Service URL can not be reached, no updgrades will be performed.
Use the upgradeOptions.schedule option to specify the update check time in CRON format.

The following example sets the midnight update checks with the official Percona’s Version Service:
```
spec:
  updateStrategy: SmartUpdate
  upgradeOptions:
    apply: Recommended
    versionServiceEndpoint: https://check.percona.com
    schedule: "0 0 * * *"
...
```
Note

You can force an immediate upgrade by changing the schedule to * * * * * (continuously check and upgrade) and changing it back to another more conservative schedule when the upgrade is complete.
Don’t forget to apply your changes to the Custom Resource in the usual way:
```
$ kubectl apply -f deploy/cr.yaml
```

More on upgrade strategies¶

The recommended way to upgrade your cluster is to use the Smart Update strategy, when the Operator controls how the objects are updated. Smart Update strategy is on when the updateStrategy key in the Custom Resource configuration file is set to SmartUpdate (this is the default value and the recommended way for upgrades).

Alternatively, you can set this key to RollingUpdate or OnDelete, which means that you will have to follow the low-level Kubernetes way of database upgrades. But take into account, that SmartUpdate strategy is not just for simplifying upgrades. Being turned on, it allows to disable automatic upgrades, and still controls restarting Pods in a proper order for changes triggered by other events, such as updating a ConfigMap, rotating a password, or changing resource values. That’s why SmartUpdate strategy is useful even when you have no plans to automate upgrades at all.

Contact Us

For free technical help, visit the Percona Community Forum.

To report bugs or submit feature requests, open a JIRA ticket.

For paid support and managed or consulting services , contact Percona Sales.

Last update: 2023-10-12