diff --git a/documentation/web/docs/user/backup_and_restore.md b/documentation/web/docs/user/backup_and_restore.md index b88c5d5e7..cb2224b28 100644 --- a/documentation/web/docs/user/backup_and_restore.md +++ b/documentation/web/docs/user/backup_and_restore.md @@ -348,8 +348,8 @@ Klio will choose the latest backup available in case the `backupID` field is omitted. ::: -Create a corresponding `PluginConfiguration` that specifies which backup to -restore: +Create a corresponding `PluginConfiguration` that tells Klio how to reach the server +holding the backups: ```yaml apiVersion: klio.cnpg.io/v1alpha1 diff --git a/documentation/web/docs/user/concepts/architectures.md b/documentation/web/docs/user/concepts/architectures.md index 97ab62642..2c401d4f1 100644 --- a/documentation/web/docs/user/concepts/architectures.md +++ b/documentation/web/docs/user/concepts/architectures.md @@ -126,6 +126,7 @@ worker nodes for Klio pods using Kubernetes taints and tolerations. (DR) strategies. It's physically and logically separate from the primary Kubernetes cluster and typically consists of an external object storage system, such as Amazon S3, Google Cloud Storage, or Azure Blob Storage. +Klio currently supports Amazon S3 and S3-compatible storage providers. Storing backups off-site ensures **geographical redundancy**, protecting data against a full cluster or site failure. diff --git a/documentation/web/docs/user/concepts/wal_streaming.md b/documentation/web/docs/user/concepts/wal_streaming.md index 8ee5d4a4e..8408893de 100644 --- a/documentation/web/docs/user/concepts/wal_streaming.md +++ b/documentation/web/docs/user/concepts/wal_streaming.md @@ -53,8 +53,7 @@ approach: - **Improved efficiency and scalability:** A single, continuously running WAL streamer process replaces the need to spawn a new process for each WAL - segment, resulting in lower CPU and I/O usage and better scalability during - periods of high WAL volume. + segment, resulting in better scalability during periods of high WAL volume. - **Enhanced security:** WAL data is encrypted end-to-end, both in transit and at rest, providing protection not available with the traditional diff --git a/documentation/web/docs/user/klio_server.md b/documentation/web/docs/user/klio_server.md index 6a8b00ad3..a370e013a 100644 --- a/documentation/web/docs/user/klio_server.md +++ b/documentation/web/docs/user/klio_server.md @@ -147,7 +147,9 @@ Queue Size = WAL_segments_per_hour × max_backlog_hours × 300 bytes × 2 Where: - **WAL_segments_per_hour**: How many WAL segments your database generates per - hour (check with `pg_stat_archiver` or monitor WAL production) + hour. Estimate it by sampling `pg_current_wal_lsn()` at two points in + time, computing the difference with `pg_wal_lsn_diff()`, then dividing by + `wal_segment_size`, scaling the results to one hour. - **max_backlog_hours**: Maximum duration the Tier 2 WAL replication backlog can grow before the queue fills up and tasks are lost. Backlog builds up when Tier 2 replication falls behind Tier 1 ingestion — for example, during diff --git a/documentation/web/docs/user/plugin_configuration.md b/documentation/web/docs/user/plugin_configuration.md index 2bce818e3..ab58b537b 100644 --- a/documentation/web/docs/user/plugin_configuration.md +++ b/documentation/web/docs/user/plugin_configuration.md @@ -118,7 +118,7 @@ The `plugins` section in the `Cluster` specification requires: :::note Even though the Klio plugin is used to archive WAL files on the Klio server, it does not use the `archiveCommand` parameter in the PostgreSQL configuration, -as the WAL are streamed directly to the Klio server. Thus, you must not set +as the WALs are streamed directly to the Klio server. Thus, you must not set `isWALArchiver: true` in the plugin configuration. ::: diff --git a/documentation/web/docs/user/quickstart.md b/documentation/web/docs/user/quickstart.md index 4a4850b30..0ebd2cd00 100644 --- a/documentation/web/docs/user/quickstart.md +++ b/documentation/web/docs/user/quickstart.md @@ -416,8 +416,8 @@ kubectl apply -f cluster-example.yaml ``` :::warning Order matters -The `PluginConfiguration` must exist before the `Cluster`. If it does -not, the Klio plugin gates reconciliation and the cluster waits +The `PluginConfiguration` must exist before creating or updating the `Cluster`. +If it does not, the Klio plugin gates reconciliation and the cluster waits without progressing until you create it. :::