Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

K8SPXC-1476 disable PVC resize and do hotfix release 1-14-1 #180

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
site/
Pipfile
Pipfile.lock
__pycache__/
38 changes: 38 additions & 0 deletions docs/ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# *Percona Operator for MySQL based on Percona XtraDB Cluster* 1.14.1

* **Date**

October 16, 2024

* **Installation**

[Installing Percona Operator for MySQL based on Percona XtraDB Cluster](../System-Requirements.md#installation-guidelines)

## Bugs Fixed

* {{ k8spxcjira(1476) }}: Fix a bug where upgrade could put the cluster into a non-operational state if using Storage Classes without the Volume expansion capabilities, by introducing a new `enableVolumeExpansion` Custom Resource option toggling this functionality

## Deprecation, Change, Rename and Removal

* The new `enableVolumeExpansion` Custom Resource option allows to disable the [automated storage scaling with Volume Expansion capability](../scaling.md#automated-scaling-with-volume-expansion-capability). The default value of this option is `false`, which means that the automated scaling is turned off by default.

## Supported Platforms

The Operator was developed and tested with Percona XtraDB Cluster versions 8.0.35-27.1 and 5.7.44-31.65. Other options may also work but have not been tested. Other software components include:

* Percona XtraBackup versions 2.4.29-1 and 8.0.35-30.1
* HAProxy 2.8.5-1
* ProxySQL 2.5.5-1.1
* LogCollector based on fluent-bit 2.1.10-1
* PMM Client 2.41.1

The following platforms were tested and are officially supported by the Operator
1.14.1:

* [Google Kubernetes Engine (GKE) :octicons-link-external-16:](https://cloud.google.com/kubernetes-engine) 1.25 - 1.29
* [Amazon Elastic Container Service for Kubernetes (EKS) :octicons-link-external-16:](https://aws.amazon.com) 1.24 - 1.29
* [Azure Kubernetes Service (AKS) :octicons-link-external-16:](https://azure.microsoft.com/en-us/services/kubernetes-service/) 1.26 - 1.28
* [OpenShift :octicons-link-external-16:](https://www.redhat.com/en/technologies/cloud-computing/openshift) 4.12.50 - 4.14.13
* [Minikube :octicons-link-external-16:](https://minikube.sigs.k8s.io/docs/) 1.32.0

This list only includes the platforms that the Percona Operators are specifically tested on as part of the release process. Other Kubernetes flavors and versions depend on the backward compatibility offered by Kubernetes itself.
1 change: 1 addition & 0 deletions docs/ReleaseNotes/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Percona Operator for MySQL based on Percona XtraDB Cluster Release Notes

* [*Percona Operator for MySQL based on Percona XtraDB Cluster* 1.14.1 (2024-10-16)](Kubernetes-Operator-for-PXC-RN1.14.1.md)
* [*Percona Operator for MySQL based on Percona XtraDB Cluster* 1.15.0 (2024-08-20)](Kubernetes-Operator-for-PXC-RN1.15.0.md)
* [*Percona Operator for MySQL based on Percona XtraDB Cluster* 1.14.0 (2024-03-04)](Kubernetes-Operator-for-PXC-RN1.14.0.md)
* [*Percona Operator for MySQL based on Percona XtraDB Cluster* 1.13.0 (2023-07-11)](Kubernetes-Operator-for-PXC-RN1.13.0.md)
Expand Down
12 changes: 6 additions & 6 deletions docs/System-Requirements.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# System requirements

The Operator was developed and tested with Percona XtraDB Cluster versions 8.0.36-28.1 and 5.7.44-31.65. Other options may also work but have not been tested.
The Operator was developed and tested with Percona XtraDB Cluster versions 8.0.35-27.1 and 5.7.44-31.65. Other options may also work but have not been tested.

## Supported platforms

The following platforms were tested and are officially supported by the Operator
{{ release }}:

* [Google Kubernetes Engine (GKE) :octicons-link-external-16:](https://cloud.google.com/kubernetes-engine) 1.27 - 1.30
* [Amazon Elastic Container Service for Kubernetes (EKS) :octicons-link-external-16:](https://aws.amazon.com) 1.28 - 1.30
* [Azure Kubernetes Service (AKS) :octicons-link-external-16:](https://azure.microsoft.com/en-us/services/kubernetes-service/) 1.28 - 1.30
* [OpenShift :octicons-link-external-16:](https://www.redhat.com/en/technologies/cloud-computing/openshift) 4.13.46 - 4.16.7
* [Minikube :octicons-link-external-16:](https://minikube.sigs.k8s.io/docs/) 1.33.1 based on Kubernetes 1.30.0
* [Google Kubernetes Engine (GKE) :octicons-link-external-16:](https://cloud.google.com/kubernetes-engine) 1.25 - 1.29
* [Amazon Elastic Container Service for Kubernetes (EKS) :octicons-link-external-16:](https://aws.amazon.com) 1.24 - 1.29
* [Azure Kubernetes Service (AKS) :octicons-link-external-16:](https://azure.microsoft.com/en-us/services/kubernetes-service/) 1.26 - 1.28
* [OpenShift :octicons-link-external-16:](https://www.redhat.com/en/technologies/cloud-computing/openshift) 4.12.50 - 4.14.13
* [Minikube :octicons-link-external-16:](https://minikube.sigs.k8s.io/docs/) 1.32.0

Other Kubernetes platforms may also work but have not been tested.

Expand Down
20 changes: 14 additions & 6 deletions docs/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,33 @@ Percona Operator for MySQL based on Percona XtraDB Cluster.
| Image | Digest |
|:-----------------------------------------------------------------------|:-----------------------------------------------------------------|
| **Images released with the Operator version {{ release }}:** | |
| percona/percona-xtradb-cluster-operator:1.15.0 (x86_64) | b8c271e3a53b86b4a5201e051d211b8ef27601b8c06848fde7d2056efbd635bf |
| percona/percona-xtradb-cluster-operator:1.15.0 (ARM64) | 7cf8004be6c4754857dd7e8c2f108c1473c32cdba0251b5d5e73a0b6046d147f |
| percona/percona-xtradb-cluster-operator:1.14.1 (x86_64) | 591d25164446e6e7fe7b6b6b66829bdf2487e4309a4411d859bb310867e33580 |
| percona/percona-xtradb-cluster-operator:1.14.1 (ARM64) | 001c85b7348c68f96846925fa4baeae7df040e4e238303e0e358737eb73323cb |
| percona/percona-xtradb-cluster-operator:1.14.1-haproxy | 15b9dad6d59c7995456b92fb1b5c17501ecbc8bafb758ff6e7417d409f06bbbd |
| percona/percona-xtradb-cluster-operator:1.14.1-proxysql | 333d0949eb048e927ac62389a5ced838dfdffe89605b30e543c10c59feb6dca2 |
| percona/percona-xtradb-cluster-operator:1.14.1-pxc8.0-backup-pxb8.0.35 | a9cd538dc713462b147a9866152bda042e326b125a9f6bd5684b9b46e75a8b01 |
| percona/percona-xtradb-cluster-operator:1.14.1-pxc5.7-backup-pxb2.4.29 | e4871437d1a6952f67c43bd10a236dd36c72519220971a8ce644e9320a2a642e |
| percona/percona-xtradb-cluster-operator:1.14.1-logcollector | f8f56b8da5b1d9859dded3f89b7ce41c5b3ceba6d78f7d4152bd0b14bafc60f4 |
| percona/pmm-client:2.41.1 | b10b771da20150390c8151cd1a3213a43348ec699064c953b2ad10783f8d7b1c |
| percona/haproxy:2.8.5 | fe63b0e7d503b25ab3d6f4aeb2e983868fe50bf85ebc91c713a990306718a8a2 |
| percona/proxysql2:2.5.5 | d95b0c6782447fef22adea3e8b8143e79a6a757666ffd34a8c3eddd9f82d629c |
| percona/percona-xtradb-cluster-operator:1.15.0-pxc8.0-backup-pxb8.0.35 | 6395019766db6118f61b8085c720d1d574c73511f84c9db5d222460f790649fb |
| percona/percona-xtradb-cluster-operator:1.15.0-pxc5.7-backup-pxb2.4.29 | dfe6545b83b18450a3243441e6b43c3a6ed05dcc24a464286ffb9a7328fdb13f |
| percona/percona-xtradb-cluster-operator:1.15.0-logcollector-fluentbit3.1.4 | 24b068d55559cbe5dbadc2f52e5c096f7df60374e47c6b4d1a5e331fd2a75014 |
| percona/percona-xtradb-cluster-operator:1.14.1-pxc8.0-backup-pxb8.0.35 | 6395019766db6118f61b8085c720d1d574c73511f84c9db5d222460f790649fb |
| percona/percona-xtradb-cluster-operator:1.14.1-pxc5.7-backup-pxb2.4.29 | dfe6545b83b18450a3243441e6b43c3a6ed05dcc24a464286ffb9a7328fdb13f |
| percona/percona-xtradb-cluster-operator:1.14.1-logcollector-fluentbit3.1.4 | 24b068d55559cbe5dbadc2f52e5c096f7df60374e47c6b4d1a5e331fd2a75014 |
| percona/pmm-client:2.42.0 | 14cb96de47e3bc239bf285f22ec6f170b4a1181301b19100f5b7dc22c210bf8c |
| percona/percona-xtradb-cluster:8.0.36-28.1 | ed99f585a27257726a985fee5f50cd957f94f5b9ae70a5d2f0fa1e68336f3abe |
| percona/percona-xtradb-cluster:8.0.36-28.1 | b5cc4034ccfb0186d6a734cb749ae17f013b027e9e64746b2c876e8beef379b3 |
| percona/percona-xtradb-cluster:8.0.35-27.1 | 1ef24953591ef1c1ce39576843d5615d4060fd09458c7a39ebc3e2eda7ef486b |
| percona/percona-xtradb-cluster:8.0.32-24.2 | 1f978ab8912e1b5fc66570529cb7e7a4ec6a38adbfce1ece78159b0fcfa7d47a |
| percona/percona-xtradb-cluster:8.0.31-23.2 | ed1ceea0b594ae34a92c891b4e42bc543d24999c82e47382cf53e33be4ae1d71 |
| percona/percona-xtradb-cluster:8.0.29-21.1 | 96c6bb8189280aeb773e74ed46aa41c01781b62947ed70c89efeb9f41c367ee7 |
| percona/percona-xtradb-cluster:8.0.25-15.1 | 529e979c86442429e6feabef9a2d9fc362f4626146f208fbfac704e145a492dd |
| percona/percona-xtradb-cluster:5.7.44-31.65 | 36fafdef46485839d4ff7c6dc73b4542b07031644c0152e911acb9734ff2be85 |
| percona/percona-xtradb-cluster:5.7.42-31.65 | 9dab86780f86ec9caf8e1032a563c131904b75a37edeaec159a93f7d0c16c603 |
| percona/percona-xtradb-cluster:5.7.39-31.61 | 9013170a71559bbac92ba9c2e986db9bda3a8a9e39ee1ee350e0ee94488bb6d7 |
| percona/percona-xtradb-cluster:5.7.36-31.55 | c7bad990fc7ca0fde89240e921052f49da08b67c7c6dc54239593d61710be504 |
| percona/percona-xtradb-cluster:5.7.34-31.51 | f8d51d7932b9bb1a5a896c7ae440256230eb69b55798ff37397aabfd58b80ccb |


Image tags are starting with the Operator's version and include a number of
optional fields: the Percona XtraDB Cluster version ("pxc8.0.36"), name of the
actual component in the image ("haproxy", "backup", etc.), and the version of
Expand Down
8 changes: 8 additions & 0 deletions docs/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ Enables or disables schema validation before applying `cr.yaml` file (works only
| ----------- | ---------- |
| :material-toggle-switch-outline: boolean | `true` |

### `enableVolumeExpansion`

Enables or disables [automatic storage scaling / volume expansion](scaling.md#automated-scaling-with-volume-expansion-capability).

| Value type | Example |
| ----------- | ---------- |
| :material-toggle-switch-outline: boolean | `false` |

### `pause`

Pause/resume: setting it to `true` gracefully stops the cluster, and setting it to `false` after shut down starts the cluster back.
Expand Down
20 changes: 16 additions & 4 deletions docs/scaling.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,22 @@ $ kubectl describe sc <storage class name> | grep allowVolumeExpansion
allowVolumeExpansion: true
```

The Operator versions 1.14.0 and higher will automatically expand such storage
for you when you change the
`pxc.volumeSpec.persistentVolumeClaim.resources.requests.storage` option in the
Custom Resource.
You can enable automated scaling with the [enableVolumeExpansion](operator.md#enablevolumeexpansion) Custom Resource option (turned off by default). When enabled, the Operator will automatically expand such storage for you when you change the `pxc.volumeSpec.persistentVolumeClaim.resources.requests.storage` option in the Custom Resource:

```yaml
spec:
...
enableVolumeExpansion: true
...
pxc:
...
volumeSpec:
...
persistentVolumeClaim:
resources:
requests:
storage: <NEW STORAGE SIZE>
```

!!! warning

Expand Down
5 changes: 5 additions & 0 deletions docs/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ 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.

!!! warning

The Operator versions 1.14.0 **should be excluded** from the incremental upgrades sequence in favor of [1.14.1](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.1.md) release.
* Direct upgrades from 1.13.0 to 1.14.1 are supported.

### Manual upgrade

The upgrade includes the following steps.
Expand Down
2 changes: 2 additions & 0 deletions docs/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Cluster components:

| Operator | [MySQL :octicons-link-external-16:](https://www.percona.com/software/mysql-database/percona-server) | [Percona XtraBackup :octicons-link-external-16:](https://www.percona.com/software/mysql-database/percona-xtrabackup) | [HA Proxy :octicons-link-external-16:](https://www.haproxy.org/) | [ProxySQL :octicons-link-external-16:](https://proxysql.com/) |
|:--------|:--------|:-----|:-------|:-------|
| [1.14.1](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.1.md) | 8.0, 5.7 | 8.0.35-30.1 for MySQL 8.0, 2.4.29-1 for MySQL 5.7 | 2.8.5-1 | 2.5.5-1.1 |
| [1.15.0](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.15.0.md) | 8.0, 5.7 | 8.0.35-30.1 for MySQL 8.0, 2.4.29-1 for MySQL 5.7 | 2.8.5 | 2.5.5 |
| [1.14.0](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.0.md) | 8.0, 5.7 | 8.0.35-30.1 for MySQL 8.0, 2.4.29-1 for MySQL 5.7 | 2.8.5-1 | 2.5.5-1.1 |
| [1.13.0](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.13.0.md) | 8.0, 5.7 | 8.0.32-26 for MySQL 8.0, 2.4.28 for MySQL 5.7 | 2.6.12 | 2.5.1-1.1 |
Expand All @@ -26,6 +27,7 @@ Platforms:

| Operator | [GKE :octicons-link-external-16:](https://cloud.google.com/kubernetes-engine) | [EKS :octicons-link-external-16:](https://aws.amazon.com) | [Openshift :octicons-link-external-16:](https://www.redhat.com/en/technologies/cloud-computing/openshift) | [AKS :octicons-link-external-16:](https://azure.microsoft.com/en-us/services/kubernetes-service/) | [Minikube :octicons-link-external-16:](https://github.com/kubernetes/minikube) |
|:--------|:------------|:------------|:------------|:--------------|:--------------------|
| [1.14.1](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.1.md) | 1.25 - 1.29 | 1.24 - 1.29 | 4.12.50 - 4.14.13 | 1.26 - 1.28 | 1.32.0 |
| [1.15.0](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.15.0.md) | 1.27 - 1.30 | 1.28 - 1.30 | 4.13.46 - 4.16.7 | 1.28 - 1.30 | 1.33.1 |
| [1.14.0](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.0.md) | 1.25 - 1.29 | 1.24 - 1.29 | 4.12.50 - 4.14.13 | 1.26 - 1.28 | 1.32.0 |
| [1.13.0](ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.13.0.md) | 1.24 - 1.27 | 1.23 - 1.27 | 4.10 - 4.13 | 1.24 - 1.26 | 1.30 |
Expand Down
15 changes: 8 additions & 7 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ plugins:
with-pdf:
output_path: "_pdf/percona-operator-for-mysql-pxc.pdf"
cover_title: "Operator for MySQL based on Percona XtraDB Cluster documentation"
cover_subtitle: 1.15.0 (August 20, 2024)
cover_subtitle: 1.14.1 (October 16, 2024)
author: "Percona Technical Documentation Team"
cover_logo: docs/assets/images/PerconaLogostackedlightbackground.svg
custom_template_path: _resource/templates
Expand All @@ -136,18 +136,18 @@ extra: # Used in main.html template and can't be externalized
updated_text: '<i class="uil uil-refresh"></i> Page updated'
commandName: 'kubectl'
clusterName: 'cluster1'
release: '1.15.0'
apiversion: '1-15-0'
certmanagerversion: '1.15.2'
release: '1.14.1'
apiversion: '1-14-1'
certmanagerversion: '1.14.2'
fluentbitrecommended: '3.1.4'
haproxyrecommended: '2.8.5'
proxysqlrecommended: '2.5.5'
pxb80recommended: '8.0.35'
pxb80recommended: '8.0.35-27.1'
pxb57recommended: '2.4.29'
pxc57recommended: '5.7.44-31.65'
pxc80recommended: '8.0.36-28.1'
pmm2recommended: '2.42.0'
gkerecommended: '1.30'
pmm2recommended: '2.41.1'
gkerecommended: '1.29'
version:
provider: mike

Expand Down Expand Up @@ -245,6 +245,7 @@ nav:
- "Trademark policy": trademark-policy.md
- Release Notes:
- "Release notes index": ReleaseNotes/index.md
- "Percona Operator for MySQL based on Percona XtraDB Cluster 1.14.1 (2024-10-16)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.1.md
- "Percona Operator for MySQL based on Percona XtraDB Cluster 1.15.0 (2024-08-20)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.15.0.md
- "Percona Operator for MySQL based on Percona XtraDB Cluster 1.14.0 (2024-03-04)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.0.md
- "Percona Operator for MySQL based on Percona XtraDB Cluster 1.13.0 (2023-07-11)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.13.0.md
Expand Down