You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: web/docs/resource-name-migration.md
+22-38Lines changed: 22 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,19 +7,22 @@ sidebar_position: 41
7
7
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
8
8
9
9
:::warning
10
-
Before running the migration script or applying the manifest, please:
11
-
1.**Review the complete manifest** at [migration-rbac.yaml](/migration-rbac.yaml) to understand what changes will be made
10
+
Before proceeding with the migration process, please:
11
+
1.**Read this guide in its entirety** to understand what changes will be made
12
12
2.**Test in a non-production environment** first if possible
13
13
3.**Ensure you have proper backups** of your cluster configuration
14
14
15
-
This migration will delete old RBAC resources and create new ones. While the operation is designed to be safe, you should review and understand the changes before proceeding. The maintainers of this project are not responsible for any issues that may arise during migration.
15
+
This migration will delete old RBAC resources only after the plugin-barman-cloud upgrade. While the operation is
16
+
designed to be safe, you should review and understand the changes before proceeding. The maintainers of this project
17
+
are not responsible for any issues that may arise during migration.
16
18
17
19
**Note:** This guide assumes you are using the default `cnpg-system` namespace.
18
20
:::
19
21
20
22
## Overview
21
23
22
-
Starting from version 0.8.0, the plugin-barman-cloud deployment manifests use more specific, prefixed resource names to avoid conflicts with other components deployed in the same Kubernetes cluster.
24
+
Starting from version **0.8.0**, the plugin-barman-cloud deployment manifests use more specific, prefixed resource names
25
+
to avoid conflicts with other components deployed in the same Kubernetes cluster.
23
26
24
27
## What Changed
25
28
@@ -44,14 +47,22 @@ The following resources have been renamed to use proper prefixes:
44
47
45
48
## Why This Change?
46
49
47
-
Using generic names for cluster-wide resources is discouraged as they may conflict with other components deployed in the same cluster. The new names make it clear that these resources belong to the barman-cloud plugin and help avoid naming collisions.
50
+
Using generic names for cluster-wide resources is discouraged as they may conflict with other components deployed in
51
+
the same cluster. The new names make it clear that these resources belong to the barman-cloud plugin and help avoid
52
+
naming collisions.
48
53
49
54
## Migration Instructions
50
55
51
-
The migration process is straightforward and can be completed with a few kubectl commands.
56
+
This three steps migration process is straightforward and can be completed with a few kubectl commands.
57
+
58
+
### Step 1: Upgrade plugin-barman-cloud
59
+
60
+
Please refer to the [Installation](installation.mdx) section to deploy the new plugin-barman-cloud release.
61
+
62
+
### Step 2: Delete Old Cluster-scoped Resources
52
63
53
64
:::danger Verify Resources Before Deletion
54
-
**IMPORTANT**: The old resource names are generic and could potentially belong to other components in your cluster.
65
+
**IMPORTANT**: The old resource names are generic and could potentially belong to other components in your cluster.
55
66
56
67
**Before deleting each resource, verify it belongs to the barman plugin by checking:**
57
68
- For `objectstore-*` roles: Look for `barmancloud.cnpg.io` in the API groups
@@ -60,15 +71,14 @@ The migration process is straightforward and can be completed with a few kubectl
60
71
61
72
If a resource doesn't have these indicators, **DO NOT DELETE IT** as it may belong to another application.
62
73
63
-
In Step 1 below, carefully review the output of each verification command before proceeding with the delete.
74
+
Carefully review the output of each verification command before proceeding with the `delete`.
64
75
:::
65
76
66
77
:::tip Dry Run First
67
-
You can add `--dry-run=client` to any `kubectl delete` command to preview what would be deleted without actually removing anything.
78
+
You can add `--dry-run=client` to any `kubectl delete` command to preview what would be deleted without actually
79
+
removing anything.
68
80
:::
69
81
70
-
### Step 1: Delete Old Cluster-scoped Resources
71
-
72
82
**Only proceed if you've verified these resources belong to the barman plugin (see warning above).**
73
83
74
84
For each resource below, first verify it belongs to barman, then delete it:
@@ -121,7 +131,7 @@ If you're unsure, it's safer to leave it and let the new `barman-plugin-metrics-
121
131
122
132
If any resource is not found during the `describe` command, that's okay - it means it was never created or already deleted. Simply skip the delete command for that resource.
123
133
124
-
### Step 2: Delete Old Namespace-scoped Resources
134
+
### Step 3: Delete Old Namespace-scoped Resources
125
135
126
136
Delete the old namespace-scoped resources in the `cnpg-system` namespace:
The new manifest will create all RBAC resources with the `barman-plugin-` prefix in the `cnpg-system` namespace. You can review the complete YAML at [migration-rbac.yaml](/migration-rbac.yaml).
159
-
:::
160
-
161
146
## Impact
162
147
163
-
-**Downtime:** The migration requires a brief interruption as the old resources are deleted and new ones are created. The plugin controller may need to restart.
164
148
-**Permissions:** If you have custom RBAC rules or tools that reference the old resource names, they will need to be updated.
165
149
-**External Users:** If end users have been granted the `objectstore-viewer-role` or `objectstore-editor-role`, they will need to be re-granted the new role names (`barman-plugin-objectstore-viewer-role` and `barman-plugin-objectstore-editor-role`).
0 commit comments