Skip to content

Commit b43b5c8

Browse files
committed
docs
Signed-off-by: Gabriele Bartolini <[email protected]>
1 parent ffd2d52 commit b43b5c8

File tree

1 file changed

+35
-15
lines changed

1 file changed

+35
-15
lines changed

README.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -99,26 +99,40 @@ The cert-manager API is ready
9999

100100
Both checks are necessary to proceed with the installation.
101101

102-
### Step 2 - install the barman-cloud plugin
102+
### Step 2 - Install the barman-cloud Plugin
103103

104-
**TODO:** temporary section - to be rewritten when manifests are available
104+
> **Note:** This section is temporary and will be updated once manifests are
105+
> included as part of the release process.
105106
106-
The plugin can be installed via its manifest:
107+
Use the following command to download the plugin's codebase, including its
108+
manifest:
107109

108110
```sh
109-
# Download the plugin-barman-cloud codebase, including its manifest
110-
$ curl -Lo plugin-barman-cloud.tgz https://api.github.com/repos/cloudnative-pg/plugin-barman-cloud/tarball/main
111+
curl -Lo plugin-barman-cloud.tgz \
112+
https://api.github.com/repos/cloudnative-pg/plugin-barman-cloud/tarball/main
113+
```
114+
115+
Extract the downloaded archive into a temporary directory (this folder can be
116+
deleted after the installation):
117+
118+
```sh
119+
tar xvzf plugin-barman-cloud.tgz
120+
```
121+
122+
Change to the root directory of the extracted repository:
111123

112-
# Expand it in a temporary folder (this can be deleted after the plugin is installed)
113-
$ tar xvzf plugin-barman-cloud.tgz
124+
```sh
125+
cd cloudnative-pg-plugin-barman-cloud*
126+
```
114127

115-
# From now on, the proposed commands are supposed to be invoked from
116-
# the repository root directory
117-
$ cd cloudnative-pg-plugin-barman-cloud*
128+
Use `kubectl` to apply the manifest for the latest commit in the `main` branch:
118129

119-
# Apply the manifest for the latest commit in the `main` branch
120-
$ kubectl apply -k kubernetes/
130+
```sh
131+
kubectl apply -k kubernetes/
121132
```
133+
134+
Example output:
135+
122136
```output
123137
customresourcedefinition.apiextensions.k8s.io/objectstores.barmancloud.cnpg.io created
124138
serviceaccount/plugin-barman-cloud created
@@ -139,16 +153,22 @@ certificate.cert-manager.io/barman-cloud-server created
139153
issuer.cert-manager.io/selfsigned-issuer created
140154
```
141155

142-
Once the plugin is installed, the following command will wait until the plugin
143-
is ready to be used:
156+
After these steps, the plugin will be successfully installed. Make sure it is
157+
ready to use by checking the deployment status as follows:
144158

145159
```sh
146-
$ kubectl rollout status deployment -n cnpg-system barman-cloud
160+
kubectl rollout status deployment \
161+
-n cnpg-system barman-cloud
147162
```
163+
164+
Example output:
165+
148166
```output
149167
deployment "barman-cloud" successfully rolled out
150168
```
151169

170+
This confirms that the plugin is deployed and operational.
171+
152172
## Usage
153173

154174
### The BarmanObjectStore object

0 commit comments

Comments
 (0)