Skip to content

Commit

Permalink
Merge pull request #460 from mallardduck/readme-enhancements
Browse files Browse the repository at this point in the history
Update BRO readme
  • Loading branch information
ericpromislow authored Jun 7, 2024
2 parents 35b601a + b46b1d5 commit a800c1e
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 40 deletions.
44 changes: 32 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,40 @@
# Backup and Restore Operator

### Latest release
## Latest release

[![Latest](https://img.shields.io/badge/dynamic/yaml?label=backup-restore-operator&query=%24.entries%5B%27rancher-backup%27%5D%5B0%5D.appVersion&url=https%3A%2F%2Fcharts.rancher.io%2Findex.yaml)](https://github.com/rancher/backup-restore-operator/releases/latest)

### Description
## Description

* This operator provides ability to backup and restore Kubernetes applications (metadata) running on any cluster. It accepts a list of resources that need to be backed up for a particular application. It then gathers these resources by querying the Kubernetes API server, packages all the resources to create a tarball file and pushes it to the configured backup storage location. Since it gathers resources by querying the API server, it can back up applications from any type of Kubernetes cluster.
* The operator preserves the ownerReferences on all resources, hence maintaining dependencies between objects.
* It also provides encryption support, to encrypt user specified resources before saving them in the backup file. It uses the same encryption configuration that is used to enable [Kubernetes Encryption at Rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/). Follow the steps in [this section](https://ranchermanager.docs.rancher.com/reference-guides/backup-restore-configuration/backup-configuration#encryption) to configure this.
The Backup and Restore Operator provides the ability to back up and restore the Rancher application running on any Kubernetes cluster.

### Use Cases
- Performing a backup before upgrading Rancher and restoring after a failed upgrade.
- Restoring your *Rancher application* to a new cluster in a disaster recovery scenario.
- Migrating your *Rancher application* between Kubernetes distributions of the same version.
- (Optional) Storing and restoring backups using [Kubernetes Encryption at Rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/).

What the Backup Restore Operator is not:
- A downstream cluster snapshot tool,
- A replacement for Etcd cluster backups,
- Configured to back up user-created resources on the Rancher cluster.

### Branches and Releases

* the tag `v5.x.x` is cut from the `release/v5.0` branch for Rancher v2.9.x line
* the tag `v4.x.x` is cut from the `release/v4.0` branch for Rancher v2.8.x line
* the tag `v3.x.x` is cut from the `release/v3.0` branch for Rancher v2.7.x line
* the tag `v5.x.x` is cut from the `release/v5.0` branch for the Rancher v2.9.x line
* the tag `v4.x.x` is cut from the `release/v4.0` branch for the Rancher v2.8.x line
* the tag `v3.x.x` is cut from the `release/v3.0` branch for the Rancher v2.7.x line
----

### Quickstart
## Quickstart

If Rancher v2.5+ is installed, you can install the `backup-restore-operator`, from the [Cluster Explorer UI](https://ranchermanager.docs.rancher.com/pages-for-subheaders/backup-restore-and-disaster-recovery).
Otherwise, you can install the charts via `helm repo` by executing the commands below.
You will need to install the `backup-restore-operator`, from the [Cluster Explorer UI](https://ranchermanager.docs.rancher.com/pages-for-subheaders/backup-restore-and-disaster-recovery).
Within the App catalog look for the `Rancher Backups` application chart.

First, add our charts repository.
However, when performing a Rancher migration you will not have the UI installed.
So, you will need to install the charts via `helm repo` by executing the commands below.

First, add the `rancher-charts` charts repository.

```bash
helm repo add rancher-charts https://charts.rancher.io
Expand Down Expand Up @@ -59,6 +70,15 @@ kubectl delete namespace cattle-resources-system

----

## More Info

The default chart is built for the use case of backing up and restoring the Rancher application.
However, under the hood the Backup Restore Operator is a rather flexible extension for backup and restore of Kubernetes resources.

* This operator provides the ability to backup and restore Kubernetes applications (metadata) running on any cluster. It accepts a list of resources that need to be backed up for the application. It then gathers these resources by querying the Kubernetes API server, packages all the resources to create a tarball file, and pushes it to the configured backup storage location. Since it gathers resources by querying the API server, it can back up applications from any type of Kubernetes cluster.
* The operator preserves the `ownerReferences` on all resources, hence maintaining dependencies between objects.
* It also provides encryption support, to encrypt user specified resources before saving them in the backup file. It uses the same encryption configuration that is used to enable [Kubernetes Encryption at Rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/). Follow the steps in [this section](https://ranchermanager.docs.rancher.com/reference-guides/backup-restore-configuration/backup-configuration#encryption) to configure this.

### CRDs

It installs the following cluster-scoped CRDs:
Expand Down
28 changes: 0 additions & 28 deletions README.md.in

This file was deleted.

0 comments on commit a800c1e

Please sign in to comment.