Bitnami/charts
2
0
Fork 0
mirror of https://github.com/bitnami/charts.git synced 2026-08-10 14:15:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

[bitnami/rabbitmq-cluster-operator] docs: 📝 Add CRD upgrade instructions (#12021)

Browse Source 
* [bitnami/rabbitmq-cluster-operator] docs: 📝 Add CRD upgrade instructions

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

* docs: 📝 Add backup instructions

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>
This commit is contained in:
Javier J. Salmerón-García
2022-08-23 17:16:04 +02:00
committed by GitHub
parent 89bd1c5d1f
commit be91dea4a9
1 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bitnami/rabbitmq-cluster-operator/README.md
+18 -9
View File
@@ -7,7 +7,7 @@ The RabbitMQ Cluster Kubernetes Operator automates provisioning, management, and
[Overview of RabbitMQ Cluster Operator](https://github.com/rabbitmq/cluster-operator)
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
## TL;DR
```console
@@ -139,7 +139,6 @@ This solution allows to easily deploy multiple RabbitMQ instances compared to th
| `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` |
| `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` |
### Common parameters
| Name | Description | Value |
@@ -153,7 +152,6 @@ This solution allows to easily deploy multiple RabbitMQ instances compared to th
| `extraDeploy` | Array of extra objects to deploy with the release | `[]` |
| `diagnosticMode.enabled` | Enable diagnostic mode (all probes will be disabled) | `false` |
### RabbitMQ Cluster Operator Parameters
| Name | Description | Value |
@@ -237,7 +235,6 @@ This solution allows to easily deploy multiple RabbitMQ instances compared to th
| `clusterOperator.serviceAccount.annotations` | Add annotations | `{}` |
| `clusterOperator.serviceAccount.automountServiceAccountToken` | Automount API credentials for a service account. | `true` |
### RabbitMQ Cluster Operator Metrics parameters
| Name | Description | Value |
@@ -265,7 +262,6 @@ This solution allows to easily deploy multiple RabbitMQ instances compared to th
| `clusterOperator.metrics.serviceMonitor.relabelings` | Specify general relabeling | `[]` |
| `clusterOperator.metrics.serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` |
### RabbitMQ Messaging Topology Operator Parameters
| Name | Description | Value |
@@ -353,7 +349,6 @@ This solution allows to easily deploy multiple RabbitMQ instances compared to th
| `msgTopologyOperator.serviceAccount.annotations` | Add annotations | `{}` |
| `msgTopologyOperator.serviceAccount.automountServiceAccountToken` | Automount API credentials for a service account. | `true` |
### RabbitMQ Messaging Topology Operator parameters
| Name | Description | Value |
@@ -381,14 +376,12 @@ This solution allows to easily deploy multiple RabbitMQ instances compared to th
| `msgTopologyOperator.metrics.serviceMonitor.relabelings` | Specify general relabeling | `[]` |
| `msgTopologyOperator.metrics.serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` |
### cert-manager parameters
| Name | Description | Value |
| ---------------- | ----------------------------------------------------------------- | ------- |
| `useCertManager` | Deploy cert-manager objects (Issuer and Certificate) for webhooks | `false` |
See [readme-generator-for-helm](https://github.com/bitnami-labs/readme-generator-for-helm) to create the table.
The above parameters map to the env variables defined in [bitnami/rabbitmq-cluster-operator](https://github.com/bitnami/containers/tree/main/bitnami/rabbitmq-cluster-operator). For more information please refer to the [bitnami/rabbitmq-cluster-operator](https://github.com/bitnami/containers/tree/main/bitnami/rabbitmq-cluster-operator) image documentation.
@@ -466,6 +459,22 @@ Find more information about how to deal with common errors related to Bitnami's
## Upgrading
### Upgrading CRDs
By design, the `helm upgrade` command will not upgrade the `CustomResourceDefinition` objects, as stated in their [official documentation](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#some-caveats-and-explanations). This is done to avoid the potential risks of upgrading CRD objects, such as data loss.
In order to upgrade the CRD objects, perform the following steps:
- Perform a backup of your running RabbitMQ instances following the [official documentation](https://www.rabbitmq.com/backup.html).
- Execute the following commands (replace the VERSION placeholder):
```console
helm fetch bitnami/rabbitmq-cluster-operator --version VERSION
tar xf rabbitmq-cluster-operator-VERSION.tar.gz
kubectl apply -f rabbitmq-cluster-operator/crds
```
### To 2.0.0
This new version adds the following components:
@@ -503,4 +512,4 @@ Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.