Conversation
Move the backup specific page to usage page and rename it to operations.
below backup & restore operation. We should probably move those information into the configuration page.
pchovelon
reviewed
Mar 12, 2026
Collaborator
pchovelon
left a comment
pchovelon
left a comment
There was a problem hiding this comment.
Here is my review :)
I think it's a good job that clarify a lot of part.
| To run pgBackRest with parameters not directly managed by this plugin, | ||
| the `CustomEnvVar` option can be used. | ||
|
|
||
| ## Supported repositories type (S3 and Azure) |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Supported repositories type (S3 and Azure) | |
| ## Supported repositories types (S3 and Azure) |
|
|
||
| ## Supported repositories type (S3 and Azure) | ||
|
|
||
| The pgBackRest plugin enables PostgreSQL backup files to be stored in: |
Collaborator
There was a problem hiding this comment.
Suggested change
| The pgBackRest plugin enables PostgreSQL backup files to be stored in: | |
| The pgBackRest plugin enables backup and WAL files to be stored in: |
"PostgreSQL" here could be confusing. I suggest to remove it and add WAL files in sentence.
|
|
||
| The pgBackRest plugin enables PostgreSQL backup files to be stored in: | ||
|
|
||
| - Amazon s3 |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Amazon s3 | |
| - Amazon S3, or S3 compatible solutions |
| - Amazon s3 | ||
| - Microsoft Azure Blob Storage | ||
|
|
||
| The plugin relies on the protocols that pgBackRest supports natively. To |
Collaborator
There was a problem hiding this comment.
Suggested change
| The plugin relies on the protocols that pgBackRest supports natively. To | |
| The plugin relies on pgBackRest protocols. To |
|
|
||
| The plugin relies on the protocols that pgBackRest supports natively. To | ||
| configure the repositories for pgBackRest, you must define a `Stanza` | ||
| object, which establishes the link between your PostgreSQL `Cluster` and |
Collaborator
There was a problem hiding this comment.
Suggested change
| object, which establishes the link between your PostgreSQL `Cluster` and | |
| object, which establishes the link between one PostgreSQL `Cluster` and |
Maybe use "one" to be sure people understand that one stanza = one cluster
| your backup : | ||
|
|
||
| ``` console | ||
| kubectl cnpg backup cluster-demo -m plugin --plugin-name pgbackrest.dalibo.com |
Collaborator
There was a problem hiding this comment.
Suggested change
| kubectl cnpg backup cluster-demo -m plugin --plugin-name pgbackrest.dalibo.com | |
| kubectl cnpg backup cluster-sample -m plugin --plugin-name pgbackrest.dalibo.com |
| Or with the `cnpg` plugin: | ||
|
|
||
| ``` console | ||
| $ kubectl cnpg backup cluster-demo -m plugin --plugin-name pgbackrest.dalibo.com \ |
Collaborator
There was a problem hiding this comment.
Suggested change
| $ kubectl cnpg backup cluster-demo -m plugin --plugin-name pgbackrest.dalibo.com \ | |
| kubectl cnpg backup cluster-demo -m plugin --plugin-name pgbackrest.dalibo.com \ |
remove $ because if users use copy button of the code block, it is useless.
| also be defined under the specification (`spec`). | ||
|
|
||
| Here is a full example of a scheduled backup definition using the | ||
| pgbackrest plugin : |
Collaborator
There was a problem hiding this comment.
Suggested change
| pgbackrest plugin : | |
| pgBackRest plugin : |
|
|
||
| ## WAL Archiving | ||
|
|
||
| WAL archiving can be customized through the `pgbackrest` CRD. It is |
Collaborator
There was a problem hiding this comment.
pgbackrest CRD ? did you mean Stanza ?
|
|
||
| As stated in the | ||
| [documentation](https://pgbackrest.org/user-guide.html#quickstart/configure-stanza), | ||
| a *stanza* is specific to a PostgreSQL instance cluster. |
Collaborator
There was a problem hiding this comment.
Suggested change
| a *stanza* is specific to a PostgreSQL instance cluster. | |
| a *stanza* is specific to a PostgreSQL instance. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.