Skip to content

Commit 1ea7243

Browse files
gbartolinimnencia
authored andcommitted
docs: add upgrades page
Signed-off-by: Gabriele Bartolini <[email protected]>
1 parent ef4d26d commit 1ea7243

File tree

3 files changed

+27
-5
lines changed

3 files changed

+27
-5
lines changed

.wordlist.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
nonResourceURLs
12
AccessDenied
23
AdditionalContainerArgs
34
Akamai
@@ -49,6 +50,7 @@ SPDX
4950
SPDX
5051
SSL
5152
ServerRecoveryWindow
53+
ServiceAccount
5254
Slonik
5355
TLS
5456
TODO
@@ -106,6 +108,7 @@ involvedObject
106108
io
107109
isWALArchiver
108110
jq
111+
json
109112
jsonpath
110113
kb
111114
krew
@@ -131,7 +134,9 @@ recoverability
131134
repos
132135
retentionCheckInterval
133136
retentionPolicy
137+
roleRef
134138
rolebinding
139+
rolebindings
135140
rollout
136141
rpc
137142
sc

web/docs/resource-name-migration.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
sidebar_position: 41
2+
sidebar_position: 90
33
---
44

5-
# Resource Name Migration Guide
5+
# Resource name migration guide
66

77
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
88

@@ -64,7 +64,7 @@ Please refer to the [Installation](installation.mdx) section to deploy the new p
6464
:::danger Verify Resources Before Deletion
6565
**IMPORTANT**: The old resource names are generic and could potentially belong to other components in your cluster.
6666

67-
**Before deleting each resource, verify it belongs to the barman plugin by checking:**
67+
**Before deleting each resource, verify it belongs to the Barman Cloud plugin by checking:**
6868
- For `objectstore-*` roles: Look for `barmancloud.cnpg.io` in the API groups
6969
- For `metrics-*` roles: Check if they reference the `plugin-barman-cloud` ServiceAccount in `cnpg-system` namespace
7070
- For other roles: Look for labels like `app.kubernetes.io/name: plugin-barman-cloud`
@@ -79,7 +79,8 @@ You can add `--dry-run=client` to any `kubectl delete` command to preview what w
7979
removing anything.
8080
:::
8181

82-
**Only proceed if you've verified these resources belong to the barman plugin (see warning above).**
82+
**Only proceed if you've verified these resources belong to the Barman Cloud
83+
plugin (see warning above).**
8384

8485
For each resource below, first verify it belongs to barman, then delete it:
8586

@@ -124,7 +125,7 @@ kubectl delete clusterrole metrics-reader
124125
The `metrics-reader` role is particularly dangerous to delete blindly. Many monitoring systems use this exact name. Only delete it if:
125126
1. You've verified it ONLY grants access to `/metrics`
126127
2. No other rolebindings reference it (checked with the jq command above)
127-
3. You're certain it was created by the barman plugin
128+
3. You're certain it was created by the Barman Cloud plugin
128129

129130
If you're unsure, it's safer to leave it and let the new `barman-plugin-metrics-reader` role coexist with it.
130131
:::

web/docs/upgrades.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
sidebar_position: 25
3+
---
4+
5+
# Upgrades
6+
7+
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
8+
9+
You can upgrade the plugin simply by installing the new version. Unless
10+
explicitly stated below or in the release notes, no special steps are required.
11+
12+
## Upgrading to version 0.8.x from previous versions
13+
14+
Version **0.8.0** introduces breaking changes to resource naming.
15+
To complete the upgrade successfully, follow the instructions in the
16+
["Resource name migration guide"](resource-name-migration.md).

0 commit comments

Comments
 (0)