docs: add upgrades page

Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
This commit is contained in:
Gabriele Bartolini 2025-10-24 16:42:10 +03:00 committed by Marco Nenciarini
parent ef4d26d83c
commit 1ea72438b3
No known key found for this signature in database
GPG Key ID: 589F03F01BA55038
3 changed files with 27 additions and 5 deletions

View File

@ -1,3 +1,4 @@
nonResourceURLs
AccessDenied AccessDenied
AdditionalContainerArgs AdditionalContainerArgs
Akamai Akamai
@ -49,6 +50,7 @@ SPDX
SPDX SPDX
SSL SSL
ServerRecoveryWindow ServerRecoveryWindow
ServiceAccount
Slonik Slonik
TLS TLS
TODO TODO
@ -106,6 +108,7 @@ involvedObject
io io
isWALArchiver isWALArchiver
jq jq
json
jsonpath jsonpath
kb kb
krew krew
@ -131,7 +134,9 @@ recoverability
repos repos
retentionCheckInterval retentionCheckInterval
retentionPolicy retentionPolicy
roleRef
rolebinding rolebinding
rolebindings
rollout rollout
rpc rpc
sc sc

View File

@ -1,8 +1,8 @@
--- ---
sidebar_position: 41 sidebar_position: 90
--- ---
# Resource Name Migration Guide # Resource name migration guide
<!-- SPDX-License-Identifier: CC-BY-4.0 --> <!-- SPDX-License-Identifier: CC-BY-4.0 -->
@ -64,7 +64,7 @@ Please refer to the [Installation](installation.mdx) section to deploy the new p
:::danger Verify Resources Before Deletion :::danger Verify Resources Before Deletion
**IMPORTANT**: The old resource names are generic and could potentially belong to other components in your cluster. **IMPORTANT**: The old resource names are generic and could potentially belong to other components in your cluster.
**Before deleting each resource, verify it belongs to the barman plugin by checking:** **Before deleting each resource, verify it belongs to the Barman Cloud plugin by checking:**
- For `objectstore-*` roles: Look for `barmancloud.cnpg.io` in the API groups - For `objectstore-*` roles: Look for `barmancloud.cnpg.io` in the API groups
- For `metrics-*` roles: Check if they reference the `plugin-barman-cloud` ServiceAccount in `cnpg-system` namespace - For `metrics-*` roles: Check if they reference the `plugin-barman-cloud` ServiceAccount in `cnpg-system` namespace
- For other roles: Look for labels like `app.kubernetes.io/name: plugin-barman-cloud` - 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
removing anything. removing anything.
::: :::
**Only proceed if you've verified these resources belong to the barman plugin (see warning above).** **Only proceed if you've verified these resources belong to the Barman Cloud
plugin (see warning above).**
For each resource below, first verify it belongs to barman, then delete it: For each resource below, first verify it belongs to barman, then delete it:
@ -124,7 +125,7 @@ kubectl delete clusterrole metrics-reader
The `metrics-reader` role is particularly dangerous to delete blindly. Many monitoring systems use this exact name. Only delete it if: The `metrics-reader` role is particularly dangerous to delete blindly. Many monitoring systems use this exact name. Only delete it if:
1. You've verified it ONLY grants access to `/metrics` 1. You've verified it ONLY grants access to `/metrics`
2. No other rolebindings reference it (checked with the jq command above) 2. No other rolebindings reference it (checked with the jq command above)
3. You're certain it was created by the barman plugin 3. You're certain it was created by the Barman Cloud plugin
If you're unsure, it's safer to leave it and let the new `barman-plugin-metrics-reader` role coexist with it. If you're unsure, it's safer to leave it and let the new `barman-plugin-metrics-reader` role coexist with it.
::: :::

16
web/docs/upgrades.mdx Normal file
View File

@ -0,0 +1,16 @@
---
sidebar_position: 25
---
# Upgrades
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
You can upgrade the plugin simply by installing the new version. Unless
explicitly stated below or in the release notes, no special steps are required.
## Upgrading to version 0.8.x from previous versions
Version **0.8.0** introduces breaking changes to resource naming.
To complete the upgrade successfully, follow the instructions in the
["Resource name migration guide"](resource-name-migration.md).