Skip to content

[doc] Enhance installation page #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pchovelon wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[doc] Enhance installation page #100

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0631d45
Remove $ in the bloc code
pchovelon Mar 12, 2026
64ab489
Rewrite installation steps
pchovelon Mar 12, 2026
ad85285
Add cert-manager prerequisite in installation page
pchovelon Mar 12, 2026
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
17 changes: 12 additions & 5 deletions docs/docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,26 @@ sidebar_position: 2

# Installation

To install and use this plugin, Kubernetes and CloudNativePG users should :
## Prerequisite

1. Install the plugin by applying the manifest located in the
`kubernetes` directory :
`cert-manager` must be installed before pgBackRest plugin.
Copy link
Copy Markdown
Collaborator

@l00ptr l00ptr Mar 16, 2026

Choose a reason for hiding this comment

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

this is already listed on the introduction / first page. Do we need to list it again ?

Copy link
Copy Markdown
Collaborator Author

@pchovelon pchovelon Mar 19, 2026

Choose a reason for hiding this comment

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

I say yes :) or at least a text to show how to verify the requirements

Please follow steps in this [documentation](https://cert-manager.io/docs/installation/).

To install the plugin, users can follow one of the following methods :

1. Install the plugin by applying the production manifest located in the
`kubernetes` directory after cloning the [repository](https://github.com/dalibo/cnpg-plugin-pgbackrest) :

``` console
kubectl apply -k ./kubernetes/prod
```

Users can also use the manifest file from GitHub:
Or

2. Directly apply the manifest files from GitHub :

``` console
$ kubectl apply -f \
kubectl apply -f \
Copy link
Copy Markdown
Collaborator

@l00ptr l00ptr Mar 16, 2026

Choose a reason for hiding this comment

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

I don't know if we should remove the $. If so, we should also change the console type and review all places where we provide commands.

Copy link
Copy Markdown
Collaborator Author

@pchovelon pchovelon Mar 19, 2026

Choose a reason for hiding this comment

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

When using the shortcut to copy and paste code, the $ is taken and then we cannot paste text.
So I suggest to remove it, and remove it in all code blocs.

https://raw.githubusercontent.com/dalibo/cnpg-plugin-pgbackrest/main/manifest.yaml
```

Expand Down
Loading