K8SPG-882 Added a deprecation warning to setting Patroni version

Author: nastena1606

.vscode/settings.json

@@ -1,2 +1,11 @@
 {
+    "cSpell.words": [
+        "crunchydata",
+        "Patroni",
+        "pgadmin",
+        "pgbackrest",
+        "pgbouncer",
+        "pgwal",
+        "subdoc"
+    ]
 }

docs/annotations.md

@@ -113,8 +113,8 @@ Use **Annotations** when:
 | `pgv2.percona.com/monitor-user-secret-hash`                 | Custom Resource       | Hash of the monitor user secret, used to detect changes and trigger updates. | `b6e1a2c3...` |
 | `pgv2.percona.com/backup-in-progress`                       | Custom Resource        | Indicates a backup that is currently running for the cluster.                     | `true`                       |
 | `pgv2.percona.com/cluster-bootstrap-restore`                | Custom Resource       | Marks that the cluster was bootstrapped from a restore.                      | `2024-07-01T12:34:56Z`       |
-| `pgv2.percona.com/patroni-version`                          | Pods, StatefulSets         | The Patroni version running in the Pod or StatefulSet.                       | `3.3.0`                      |
-| `pgv2.percona.com/custom-patroni-version`                   | Pods, StatefulSets         | Custom Patroni version specified by the user.                                | `3.3.0-percona`              |
+| `pgv2.percona.com/patroni-version`                          | Pods, StatefulSets         | The Patroni version running in the Pod or StatefulSet.                       | `{{patronirecommended}}`                      |
+| `pgv2.percona.com/custom-patroni-version`                   | Pods, StatefulSets         | Custom Patroni version specified by the user. Deprecated and ignored starting with version 2.8.0 | `3.3.0-percona`              |
 | `kubectl.kubernetes.io/default-container` | Pods | Defines a default container used when the `-c` flag is not passed when executing to a Pod.|
 
 ## Setting labels and annotations in the Custom Resource
@@ -252,6 +252,10 @@ Metadata can be used as an additional way to influence the Operator behavior by
 
 ### Customizing Patroni version
 
+!!! note 
+
+    This behavior is deprecated and the annotation is ignored starting with version 2.8.0.
+
 Starting from the Operator 2.6.0, Percona distribution for PostgreSQL comes with Patroni 4.x, which introduces breaking changes compared to previously used 3.x versions. To maintain backward compatibility, the Operator needs to detect the Patroni version used in the image. For this, it runs a temporary Pod named `cluster_name-patroni-version-check` with the following default resources:
 
 ```yaml

docs/operator.md

@@ -18,7 +18,7 @@ for PostgreSQL Cluster; it should include only [URL-compatible characters :octic
 
 * <a name="finalizers-delete-backups"></a> `finalizers.percona.com/delete-backups` if present, activates the [Finalizer :octicons-link-external-16:](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers) which deletes all the [backups](backups.md) of the database cluster from all configured repos on cluster deletion event (off by default). **`delete-backups` finalizer is in tech preview state, and it is not yet recommended for production environments.**
 
-## Toplevel `spec` elements
+## Top level `spec` elements
 
 The spec part of the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml) file contains the following:
 
@@ -80,7 +80,7 @@ Port number used by a standby copy to connect to the primary cluster.
 
 ### `openshift`
 
-Set to `true` if the cluster is being deployed on OpenShift, set to `false` otherwise, or  unset it for autodetection.
+Set to `true` if the cluster is being deployed on OpenShift, set to `false` otherwise, or  unset it for auto-detection.
 
 | Value type | Example |
 | ---------- | ------- |
@@ -854,7 +854,7 @@ The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.
 
 ### `instances.priorityClassName`
 
-The [Kuberentes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for PostgreSQL instance Pods.
+The [Kubernetes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for PostgreSQL instance Pods.
 
 | Value type | Example |
 | ---------- | ------- |
@@ -902,7 +902,7 @@ The [Kubernetes PersistentVolumeClaim :octicons-link-external-16:](https://kuber
 
 ### `instances.dataVolumeClaimSpec.storageClassName`
 
-Set the [Kubernetes storage class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/storage-classes/) to use with PosgreSQL Cluster [PersistentVolumeClaim :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) for the PostgreSQL storage.
+Set the [Kubernetes storage class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/storage-classes/) to use with PostgreSQL Cluster [PersistentVolumeClaim :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) for the PostgreSQL storage.
 
 | Value type | Example |
 | ---------- | ------- |
@@ -1140,15 +1140,15 @@ The number of retries to make a backup with incremental pauses of 10 seconds, 20
 
 ### `backups.pgbackrest.jobs.restartPolicy`
 
-The [Kuberentes Pod restart policy :octicons-link-external-16:](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) for pgBackRest jobs.
+The [Kubernetes Pod restart policy :octicons-link-external-16:](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) for pgBackRest jobs.
 
 | Value type | Example |
 | ---------- | ------- |
 | :material-code-string: string | `OnFailure` |
 
 ### `backups.pgbackrest.jobs.priorityClassName`
 
-The [Kuberentes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for pgBackRest jobs.
+The [Kubernetes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for pgBackRest jobs.
 
 | Value type | Example |
 | ---------- | ------- |
@@ -1277,7 +1277,7 @@ The [Kubernetes memory limits :octicons-link-external-16:](https://kubernetes.io
 
 ### `backups.pgbackrest.repoHost.priorityClassName`
 
-The [Kuberentes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for pgBackRest repo.
+The [Kubernetes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for pgBackRest repo.
 
 | Value type | Example |
 | ---------- | ------- |
@@ -1423,7 +1423,7 @@ The [Kubernetes PersistentVolumeClaim :octicons-link-external-16:](https://kuber
 
 ### `backups.pgbackrest.repos.volume.volumeClaimSpec.storageClassName`
 
-Set the [Kubernetes Storage Class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/storage-classes/) to use with the Percona Operator for PosgreSQL backups stored on [Persistent Volume](backups-storage.md#__tabbed_1_4).
+Set the [Kubernetes Storage Class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/storage-classes/) to use with the Percona Operator for PostgreSQL backups stored on [Persistent Volume](backups-storage.md#__tabbed_1_4).
 
 | Value type | Example |
 | ---------- | ------- |
@@ -1740,7 +1740,7 @@ The [Kubernetes annotations :octicons-link-external-16:](https://kubernetes.io/d
 
 | Value type | Example |
 | ---------- | ------- |
-| :material-label-outline: label | `pg-cluster-annot: cluster1` |
+| :material-label-outline: label | `my-annotation: value1` |
 
 ### `proxy.pgBouncer.expose.labels`