From b37ac7447a9ed2408424754aa803f567dc4004b4 Mon Sep 17 00:00:00 2001 From: Julia Bier Date: Thu, 5 Jun 2025 16:41:03 -0400 Subject: [PATCH 1/3] Remove references to deprecated resourceset --- .../backup-restore-configuration/backup-configuration.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/reference-guides/backup-restore-configuration/backup-configuration.md b/docs/reference-guides/backup-restore-configuration/backup-configuration.md index 054a6de3daa..2ece25be1a0 100644 --- a/docs/reference-guides/backup-restore-configuration/backup-configuration.md +++ b/docs/reference-guides/backup-restore-configuration/backup-configuration.md @@ -33,12 +33,6 @@ While you can create your own ResourceSets to back up custom applications, two R `rancher-resource-set-full` includes all essential secrets in the backup files to ensure Rancher continues running smoothly after a restore or migration. To avoid storing sensitive information in plain text, we strongly advise you to enable encryption with a strong key. -:::note Important: - -`rancher-resource-set` is also included by default with the `rancher-backup` operator. However, this ResourceSet is deprecated and is only being kept for backwards compatibility reasons. `rancher-resource-set` will be removed in Rancher v2.12. Please update your Backup custom resources to use either `rancher-resource-set-full` or `rancher-resource-set-basic`. - -::: - | YAML Directive Name | Description | | ---------------- | ---------------- | | `resourceSetName` | Provide the name of the ResourceSet to define which resources will be included in this backup. | From c8d8f830a1bafb0663d789171bbdaa7b82f08f2f Mon Sep 17 00:00:00 2001 From: Julia Bier Date: Mon, 21 Jul 2025 12:44:19 -0400 Subject: [PATCH 2/3] Remove references to deprecated resourceset v2.12 --- .../backup-restore-configuration/backup-configuration.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/versioned_docs/version-2.12/reference-guides/backup-restore-configuration/backup-configuration.md b/versioned_docs/version-2.12/reference-guides/backup-restore-configuration/backup-configuration.md index 054a6de3daa..2ece25be1a0 100644 --- a/versioned_docs/version-2.12/reference-guides/backup-restore-configuration/backup-configuration.md +++ b/versioned_docs/version-2.12/reference-guides/backup-restore-configuration/backup-configuration.md @@ -33,12 +33,6 @@ While you can create your own ResourceSets to back up custom applications, two R `rancher-resource-set-full` includes all essential secrets in the backup files to ensure Rancher continues running smoothly after a restore or migration. To avoid storing sensitive information in plain text, we strongly advise you to enable encryption with a strong key. -:::note Important: - -`rancher-resource-set` is also included by default with the `rancher-backup` operator. However, this ResourceSet is deprecated and is only being kept for backwards compatibility reasons. `rancher-resource-set` will be removed in Rancher v2.12. Please update your Backup custom resources to use either `rancher-resource-set-full` or `rancher-resource-set-basic`. - -::: - | YAML Directive Name | Description | | ---------------- | ---------------- | | `resourceSetName` | Provide the name of the ResourceSet to define which resources will be included in this backup. | From a41254e72d7156d98d876d9fd80e31e19ec81f58 Mon Sep 17 00:00:00 2001 From: Julia Bier Date: Mon, 21 Jul 2025 14:39:07 -0400 Subject: [PATCH 3/3] Remove remaining references to deprecated resoruceset --- .../backup-restore-and-disaster-recovery/back-up-rancher.md | 4 ++-- .../backup-restore-and-disaster-recovery.md | 2 +- .../backup-restore-and-disaster-recovery/back-up-rancher.md | 4 ++-- .../backup-restore-and-disaster-recovery.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md index 9d3a6307a5f..2edb0398c8c 100644 --- a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md +++ b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md @@ -70,7 +70,7 @@ To perform a backup, a custom resource of type Backup must be created. folder: rancher region: us-west-2 endpoint: s3.us-west-2.amazonaws.com - resourceSetName: rancher-resource-set + resourceSetName: rancher-resource-set-full encryptionConfigSecretName: encryptionconfig schedule: "@every 1h" retentionCount: 10 @@ -78,7 +78,7 @@ To perform a backup, a custom resource of type Backup must be created. :::note - When creating the Backup resource using YAML editor, the `resourceSetName` must be set to `rancher-resource-set` + When creating the Backup resource using YAML editor, the `resourceSetName` must be set to `rancher-resource-set-full` or `rancher-resource-set-basic`. ::: diff --git a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md index 71467ac7403..c3b26afd434 100644 --- a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md +++ b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md @@ -28,7 +28,7 @@ The `rancher-backup` operator introduces three custom resources: Backups, Restor The ResourceSet defines which Kubernetes resources need to be backed up. The ResourceSet is not available to be configured in the Rancher UI because the values required to back up Rancher are predefined. This ResourceSet should not be modified. -When a Backup custom resource is created, the `rancher-backup` operator calls the `kube-apiserver` to get the resources in the ResourceSet (specifically, the predefined `rancher-resource-set`) that the Backup custom resource refers to. +When a Backup custom resource is created, the `rancher-backup` operator calls the `kube-apiserver` to get the resources in the ResourceSet that the Backup custom resource refers to. The operator then creates the backup file in the .tar.gz format and stores it in the location configured in the Backup resource. diff --git a/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md b/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md index 9d3a6307a5f..2edb0398c8c 100644 --- a/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md +++ b/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md @@ -70,7 +70,7 @@ To perform a backup, a custom resource of type Backup must be created. folder: rancher region: us-west-2 endpoint: s3.us-west-2.amazonaws.com - resourceSetName: rancher-resource-set + resourceSetName: rancher-resource-set-full encryptionConfigSecretName: encryptionconfig schedule: "@every 1h" retentionCount: 10 @@ -78,7 +78,7 @@ To perform a backup, a custom resource of type Backup must be created. :::note - When creating the Backup resource using YAML editor, the `resourceSetName` must be set to `rancher-resource-set` + When creating the Backup resource using YAML editor, the `resourceSetName` must be set to `rancher-resource-set-full` or `rancher-resource-set-basic`. ::: diff --git a/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md b/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md index 71467ac7403..c3b26afd434 100644 --- a/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md +++ b/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/backup-restore-and-disaster-recovery.md @@ -28,7 +28,7 @@ The `rancher-backup` operator introduces three custom resources: Backups, Restor The ResourceSet defines which Kubernetes resources need to be backed up. The ResourceSet is not available to be configured in the Rancher UI because the values required to back up Rancher are predefined. This ResourceSet should not be modified. -When a Backup custom resource is created, the `rancher-backup` operator calls the `kube-apiserver` to get the resources in the ResourceSet (specifically, the predefined `rancher-resource-set`) that the Backup custom resource refers to. +When a Backup custom resource is created, the `rancher-backup` operator calls the `kube-apiserver` to get the resources in the ResourceSet that the Backup custom resource refers to. The operator then creates the backup file in the .tar.gz format and stores it in the location configured in the Backup resource.