Skip to content

Commit ac057f4

Browse files
mnenciagbartolini
andauthored
doc: define a PVC group (cloudnative-pg#1344)
Closes cloudnative-pg#1343 Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com> Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com> Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
1 parent f1a2597 commit ac057f4

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/src/before_you_start.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ specific to Kubernetes and PostgreSQL.
2020
| [Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) | An *operator* is a custom resource that automates those steps that are normally performed by a human operator when managing one or more applications or given services. An operator assists Kubernetes in making sure that the resource's defined state always matches the observed one. |
2121
| [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) | `kubectl` is the command-line tool used to manage a Kubernetes cluster. |
2222

23-
CloudNativePG requires Kubernetes 1.21 or higher.
23+
CloudNativePG requires a Kubernetes version supported by the community. Please refer to the
24+
["Supported releases"](supported_releases.md) page for details.
2425

2526
## PostgreSQL terminology
2627

@@ -34,6 +35,9 @@ CloudNativePG requires Kubernetes 1.21 or higher.
3435
| Replica Cluster | A CloudNativePG `Cluster` that is in continuous recovery mode from a selected PostgreSQL cluster, normally residing outside the Kubernetes cluster. It is a feature that enables multi-cluster deployments in private, public, hybrid, and multi-cloud contexts. |
3536
| Designated Primary | A PostgreSQL standby instance in a replica cluster that is in continuous recovery from another PostgreSQL cluster and that is designated to become primary in case the replica cluster becomes primary. |
3637
| Superuser | In PostgreSQL a *superuser* is any role with both `LOGIN` and `SUPERUSER` privileges. For security reasons, CloudNativePG performs administrative tasks by connecting to the `postgres` database as the `postgres` user via `peer` authentication over the local Unix Domain Socket. |
38+
| [WAL](https://www.postgresql.org/docs/current/wal-intro.html) | Write-Ahead Logging (WAL) is a standard method for ensuring data integrity in database management systems. |
39+
| PVC group | A PVC group in CloudNativePG's terminology is a group of related PVCs belonging to the same PostgreSQL instance, namely the main volume containing the PGDATA (`storage`) and the volume for WALs (`walStorage`).|
40+
3741

3842
## Cloud terminology
3943

docs/src/storage.md

+3
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ Additionally, it supports the creation of clusters with a separate PVC
7171
on which to store PostgreSQL Write-Ahead Log (WAL), as explained in the
7272
["Volume for WAL" section](#volume-for-wal) below.
7373

74+
In CloudNativePG, the volumes attached to a single PostgreSQL instance
75+
are defined as **PVC group**.
76+
7477
## Configuration via a storage class
7578

7679
The easier way to configure the storage for a PostgreSQL class is to just

0 commit comments

Comments
 (0)