Skip to content

Commit

Permalink
Update backup/restore docs BOP-1113 (#102)
Browse files Browse the repository at this point in the history
Co-authored-by: Kory <[email protected]>
  • Loading branch information
tppolkow and KoryKessel-Mirantis authored Oct 2, 2024
1 parent 9a6e99d commit a8d4a98
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 13 deletions.
18 changes: 10 additions & 8 deletions content/docs/operations/backup-restore/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 2
---

MKE 4 supports backup and restore of cluster data through the use of the
[Velero](https://velero.io/) addon. Backup is enabled by default.
[Velero](https://velero.io/) add-on. Backup is enabled by default.

## Configuration

Expand All @@ -16,19 +16,19 @@ backup:
storage_provider:
type: InCluster
in_cluster_options:
exposed: true
enable_ui: true
distributed: false
```
By default, MKE 4 supports backups that use the in-cluster storage
provider, as indicated in the `type` option setting of `InCluster`. MKE 4
in-cluster backups are implemented using the [MinIO
addon](https://microk8s.io/docs/addon-minio).
add-on](https://min.io/).

The `exposed` option setting of `true` indicates that the MinIO service is
exposed through `NodePort`, which Velero requires to function correctly. Core
backup functionality should work, however, even if
the service is not exposed.
The `enable_ui` option setting of `true` indicates that the MinIO Console is
exposed through the Ingress and can be accessed through the UI. Core
backup functionality will work, however, even if
the UI is disabled.

The `distributed` option configures MinIO storage to run in distributed mode.

Expand Down Expand Up @@ -62,4 +62,6 @@ provider types, refer to:

- Backups must currently be restored in the same cluster in which the backup
was taken, and thus restoring a backup to a new set of nodes is not yet
supported for the in-cluster storage provider.
supported for the in-cluster storage provider.

- Backups must be downloaded and uploaded from the in-cluster storage provider using the MinIO Console, as the CLI does not currently support these actions.
2 changes: 1 addition & 1 deletion content/docs/operations/backup-restore/external.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Once you have configured the AWS backup storage and the MKE configuration file
has been applied, verify the existence of the `BackupStorageLocation` custom resource.

```shell
kubectl get backupstoragelocation -n mke
kubectl --kubeconfig <path-to-kubeconfig> get backupstoragelocation -n mke
```

After you run `mkectl apply` the output may require a few minutes to display.
Expand Down
Binary file added content/docs/operations/backup-restore/img_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 33 additions & 4 deletions content/docs/operations/backup-restore/in-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@ weight: 1
---

By default, MKE 4 stores backups and restores using the in-cluster storage
provider, the [MinIO addon](https://microk8s.io/docs/addon-minio).
provider, the [MinIO add-on](https://min.io/).

>The offered instructions assume that you have created a cluster and
{{< callout type="note" >}}
MinIO is not currently backed by persistent storage. For persistent storage of backups, use an external storage provider or download the MinIO backups.
{{< /callout >}}

{{< callout type="info" >}}
The offered instructions assume that you have created a cluster and
applied a blueprint with the default MKE backup configuration.
{{< /callout >}}

## Create an in-cluster backup

Expand Down Expand Up @@ -75,8 +81,8 @@ INFO[0027] Restore test-20240507173309 completed successfully
To list the restores, run:

```shell
mkectl restore list
```
mkectl restore list
```

Example output:

Expand All @@ -89,4 +95,27 @@ test-20240507173309 test Completed 2024-05-07 17:33:09 -0400 EDT 2024-
Optionally, you can view detailed logs by running the
`mkectl restore logs --name test-20240507173309` command.

## Accessing the MinIO Console

To access the MinIO Console:

1. Obtain the username from your cluster:

```shell
kubectl --kubeconfig <path_to_kubeconfig> get secret -n mke minio-credentials -o jsonpath='{.data.root-user}' | base64 -d
```

2. Obtain the password from your cluster:

```shell
kubectl --kubeconfig <path_to_kubeconfig> get secret -n mke minio-credentials -o jsonpath='{.data.root-password}' | base64 -d
```

3. Navigate to the external address for your ingress controller under `/minio/`.

Example:
`https://<external_address>/minio/`

4. Log in using the username and password. The Velero bucket displays under the Object browser, and you can download or upload backups, using the options provided by the MinIO UI.

![img_2.png](img_2.png)

0 comments on commit a8d4a98

Please sign in to comment.