public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-05-16 01:53:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix links

Browse Source
This commit is contained in:
Catherine Luse
2020-09-28 22:15:49 -07:00
parent 42774e425e
commit 4d3458a10a
7 changed files with 22 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/backups/_index.md
+5 -5
View File
@@ -83,22 +83,22 @@ helm install rancher-backup rancherchart/rancher-backup -n cattle-resources-syst
# Backing up Rancher
A backup is performed by creating a Backup custom resource. For a tutorial, refer to [this page.](../back-up-rancher)
A backup is performed by creating a Backup custom resource. For a tutorial, refer to [this page.](./back-up-rancher)
# Restoring Rancher
A restore is performed by creating a Restore custom resource. For a tutorial, refer to [this page.](../restoring-rancher)
A restore is performed by creating a Restore custom resource. For a tutorial, refer to [this page.](./restoring-rancher)
# Migrating Rancher to a New Cluster
A migration is performed by following [these steps.](../migrating-rancher)
A migration is performed by following [these steps.](./migrating-rancher)
# Default Storage Location Configuration
Configure a storage location where all backups are saved by default. You will have the option to override this with each backup, but will be limited to using an S3-compatible or Minio object store.
For information on configuring these options, refer to [this page.](../storage-config)
For information on configuring these options, refer to [this page.](./configuration/storage-config)
### Example values.yaml for the rancher-backup Helm Chart
The example [values.yaml file](../example-values) can be used to configure the `rancher-backup` operator when the Helm CLI is used to install it.
The example [values.yaml file](./configuration/storage-config/#example-values-yaml-for-the-rancher-backup-helm-chart) can be used to configure the `rancher-backup` operator when the Helm CLI is used to install it.
content/rancher/v2.x/en/backups/back-up-rancher/_index.md
+3 -7
View File
@@ -14,7 +14,7 @@ Backups are created as .tar.gz files. These files can be pushed to S3 or Minio,
1. In the Rancher UI, go to the **Cluster Explorer.**
1. Click **Apps.**
1. Click `rancher-backup`.
1. Configure the default storage location. For help, refer to the [storage configuration section.](#configuring-the-storage-location)
1. Configure the default storage location. For help, refer to the [storage configuration section.](../configuration/storage-config)
### 2. Perform a Backup
@@ -44,13 +44,9 @@ To perform a backup, a custom resource of type Backup must be created.
retentionCount: 3
```
For help configuring the Backup, refer to the [configuration reference](../configuration/backup-config) and to the [examples.](../examples/#backup)
For help configuring the Backup, refer to the [configuration reference](../../configuration/backup-config) and to the [examples.](../../examples/backups)
Recurring backups are scheduled by editing the `Schedule` and `RetentionCount` fields. For more information, refer to the [Backup configuration reference.](../../backup-config/#schedule)
Recurring backups are scheduled by editing the `Schedule` and `RetentionCount` fields. For more information, refer to the [Backup configuration reference.](../configuration/backup-config/#schedule)
> **Important:** The `rancher-backup` operator doesn't save the EncryptionConfiguration file. The contents of the EncryptionConfiguration file must be saved when an encrypted backup is created, and the same file must be used when restoring from this backup.
1. Click **Create.**
content/rancher/v2.x/en/backups/configuration/backup-config/_index.md
+1 -3
View File
@@ -4,8 +4,6 @@ shortTitle: Backup
weight: 1
---
The OpenAPI schema for the Backup custom resource definition is [here.](https://github.com/rancher/rancher-backup/blob/master/crds/backup.yaml#L14)
The Backup custom resource accepts the following fields:
- [EncryptionConfigName](#encryptionconfigname)
@@ -64,7 +62,7 @@ The S3 storage location contains the following configuration fields:
| `folder` | The name of the folder in the S3 bucket where backup files will be stored. | |
| `region` | The AWS [region](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) where the S3 bucket is located. | ✓ |
| `endpoint` | The [endpoint](https://docs.aws.amazon.com/general/latest/gr/s3.html) that is used to access S3 in the region of your bucket. | ✓ |
| `endpointCA` | This should be the Base64 encoded CA cert. For an example, refer to the [example S3 compatible configuration.](#example-s3-storage-configuration) | |
| `endpointCA` | This should be the Base64 encoded CA cert. For an example, refer to the [example S3 compatible configuration.](#example-s3-compatible-storage-configuration) | |
| `insecureTLSSkipVerify` | Set to true if you are not using TLS. | |
### Example S3 Compatible Storage Configuration
content/rancher/v2.x/en/backups/configuration/restore-config/_index.md
+4 -5
View File
@@ -4,12 +4,11 @@ shortTitle: Restore
weight: 2
---
The OpenAPI schema for the Restore custom resource definition is [here.](https://github.com/rancher/rancher-backup/blob/master/crds/restore.yaml)
The Restore custom resource accepts the following fields:
- [BackupFilename]
- [EncryptionConfigName]
- [BackupFilename](#backupfilename)
- [EncryptionConfigName](#encryptionconfigname)
- [StorageLocation](#storagelocation)
### BackupFilename
@@ -35,7 +34,7 @@ This field is optional.
This field is optional.
Its fields are exactly same as ones for the `backup.StorageLocation` configuration in the [Backup custom resource.](../../backup-config/storagelocation)
Its fields are exactly same as ones for the `backup.StorageLocation` configuration in the [Backup custom resource.](../../configuration/backup-config/#storagelocation)
If the StorageLocation is specified, the operator will retrieve the backup location from that particular S3 bucket. If not specified, operator will try to find this file in the operator-level S3 store, and in the operator-level PVC store.
content/rancher/v2.x/en/backups/configuration/storage-config/_index.md
+1 -1
View File
@@ -54,7 +54,7 @@ Configure an existing PersistentVolume that will be used to store your backups.
Resources can be encrypted before they are saved in a backup file.
The `rancher-backup` operator uses the same process to encrypt the backups as is described in the [official Kubernetes documentation](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/) for encrypting data at rest.Encryption details are provided in an EncryptionConfiguration YAML file.
The `rancher-backup` operator uses the same process to encrypt the backups as is described in the [official Kubernetes documentation](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/) for encrypting data at rest. Encryption details are provided in an EncryptionConfiguration YAML file.
You can use any EncryptionConfiguration YAML, including one that is already used in your Kubernetes cluster.
content/rancher/v2.x/en/backups/examples/_index.md
+7 -3
View File
@@ -3,7 +3,7 @@ title: Examples
weight: 5
---
This section contains examples of Backup and Restore custom resources. The original source is [here.](https://github.com/rancher/rancher-backup/tree/master/examples)
This section contains examples of Backup and Restore custom resources.
The default backup storage location is configured when the `rancher-backup` operator is installed or upgraded.
@@ -29,6 +29,8 @@ Encrypted backups can only be restored if the Restore custom resource uses the s
# Backup
This section contains example Backup custom resources.
### Backup in the Default Location with Encryption
```yaml
@@ -131,7 +133,7 @@ spec:
### Backup from EC2 Nodes with IAM Permission to Access S3
This example shows that the AWS credential secret does not have to be provided to create a backup if the nodes running `rancher-backup` have [these permissions for access to S3.](../../configuration/backup-config/#iam-permissions-for-eC2-nodes-to-access-s3)
This example shows that the AWS credential secret does not have to be provided to create a backup if the nodes running `rancher-backup` have [these permissions for access to S3.](../configuration/backup-config/#iam-permissions-for-ec2-nodes-to-access-s3)
```yaml
apiVersion: resources.cattle.io/v1
@@ -151,6 +153,8 @@ spec:
# Restore
This section contains example Restore custom resources.
### Restore Using the Default Backup File Location
```yaml
@@ -235,7 +239,7 @@ spec:
### Restore from EC2 Nodes with IAM Permissions to Access S3
This example shows that the AWS credential secret does not have to be provided to restore from backup if the nodes running `rancher-backup` have [these permissions for access to S3.](../../configuration/backup-config/#iam-permissions-for-eC2-nodes-to-access-s3)
This example shows that the AWS credential secret does not have to be provided to restore from backup if the nodes running `rancher-backup` have [these permissions for access to S3.](../configuration/backup-config/#iam-permissions-for-ec2-nodes-to-access-s3)
```yaml
apiVersion: resources.cattle.io/v1
content/rancher/v2.x/en/backups/migrating-rancher/_index.md
+1 -1
View File
@@ -3,7 +3,7 @@ title: Migrating Rancher to a New Cluster
weight: 3
---
If you are migrating Rancher to a new Kubernetes cluster, you don't need to install Rancher on the new cluster first. If Rancher is restored to a new cluster with Rancher already installed, it can cause problems with [permissions](https://github.com/rancher/rancher-backup/issues/24) and [namespaces.](https://github.com/rancher/rancher-backup/issues/6)
If you are migrating Rancher to a new Kubernetes cluster, you don't need to install Rancher on the new cluster first. If Rancher is restored to a new cluster with Rancher already installed, it can cause problems.
### Prerequisites