Skip to content
Open
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
4 changes: 2 additions & 2 deletions documentation/web/docs/user/backup_and_restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Comment on lines -351 to +352

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC the Cluster is what has the backupID field, not the PluginConfiguration.


```yaml
apiVersion: klio.cnpg.io/v1alpha1
Expand Down
1 change: 1 addition & 0 deletions documentation/web/docs/user/concepts/architectures.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 1 addition & 2 deletions documentation/web/docs/user/concepts/wal_streaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion documentation/web/docs/user/klio_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I first thought "Klio does not use archiving, so pg_stat_archiver should not help", then I noticed the CNPG instance still has an archive_command even though using Klio. Nonetheless I still think this describes a better way to measure WAL volume?

- **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
Expand Down
2 changes: 1 addition & 1 deletion documentation/web/docs/user/plugin_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::

Expand Down
4 changes: 2 additions & 2 deletions documentation/web/docs/user/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::

Expand Down