github.com/verrazzano/verrazzano@v1.7.0/platform-operator/thirdparty/charts/rancher-backup/README.md (about)

     1  # Rancher Backup
     2  
     3  This chart provides ability to back up and restore the Rancher application running on any Kubernetes cluster.
     4  
     5  Refer [this](https://github.com/rancher/backup-restore-operator) repository for implementation details.
     6  
     7  -----
     8  
     9  ### Get Repo Info
    10  ```bash
    11  helm repo add rancher-chart https://charts.rancher.io
    12  helm repo update
    13  ```
    14  
    15  -----
    16  
    17  ### Install Chart
    18  ```bash
    19  helm install rancher-backup-crd rancher-chart/rancher-backup-crd -n cattle-resources-system --create-namespace
    20  helm install rancher-backup rancher-chart/rancher-backup -n cattle-resources-system
    21  ```
    22  
    23  -----
    24  
    25  ### Configuration
    26  The following table lists the configurable parameters of the rancher-backup chart and their default values:
    27  
    28  | Parameter   |      Description      |  Default |
    29  |----------|---------------|-------|
    30  | image.repository |  Container image repository | rancher/backup-restore-operator |
    31  | image.tag |    Container image tag  |   v0.1.0-rc1 |
    32  | s3.enabled | Configure S3 compatible default storage location. Current version supports S3 and MinIO |    false |
    33  | s3.credentialSecretName | Name of the Secret containing S3 credentials. This is an optional field. Skip this field in order to use IAM Role authentication. The Secret must contain following two keys, `accessKey` and `secretKey` |    "" |
    34  | s3.credentialSecretNamespace | Namespace of the Secret containing S3 credentials. This can be any namespace. |    "" |
    35  | s3.region | Region of the S3 Bucket (Required for S3, not valid for MinIO) |    "" |
    36  | s3.bucketName | Name of the Bucket |    "" |
    37  | s3.folder | Base folder within the Bucket (optional) |    "" |
    38  | s3.endpoint | Endpoint for the S3 storage provider |   "" |
    39  | s3.endpointCA | Base64 encoded CA cert for the S3 storage provider (optional) | "" |
    40  | s3.insecureTLSSkipVerify |  Skip SSL verification | false |
    41  | persistence.enabled |  Configure a Persistent Volume as the default storage location. It accepts either a StorageClass name to create a PVC, or directly accepts the PV to use. The Persistent Volume is mounted at `/var/lib/backups` in the operator pod | false |
    42  | persistence.storageClass |  StorageClass to use for dynamically provisioning the Persistent Volume, which will be used for storing backups | "" |
    43  | persistence.volumeName |  Persistent Volume to use for storing backups | "" |
    44  | persistence.size |  Requested size of the Persistent Volume (Applicable when using dynamic provisioning) | "" |
    45  | debug | Set debug flag for backup-restore deployment | false |
    46  | trace | Set trace flag for backup-restore deployment | false |
    47  | nodeSelector | https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector | {} |
    48  | tolerations | https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | [] |
    49  | affinity | https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity | {} |
    50  | serviceAccount.annotations | Annotations to apply to created service account | {} |
    51  
    52  -----
    53  
    54  ### CRDs
    55  
    56  Refer [this](https://github.com/rancher/backup-restore-operator#crds) section for information on CRDs that this chart installs. Also refer [this](https://github.com/rancher/backup-restore-operator/tree/master/examples) folder containing sample manifests for the CRDs.
    57  
    58  -----
    59  ### Upgrading Chart
    60  ```bash
    61  helm upgrade rancher-backup-crd -n cattle-resources-system
    62  helm upgrade rancher-backup -n cattle-resources-system
    63  ```
    64  
    65  -----
    66  ### Uninstall Chart
    67  
    68  ```bash
    69  helm uninstall rancher-backup -n cattle-resources-system
    70  helm uninstall rancher-backup-crd -n cattle-resources-system
    71  ```
    72