docs: backup how to (#30)

* backup how-to

* add how-to to menu

docs/for-ops/console/backups.md

@@ -19,16 +19,14 @@ All known Builds on the platform are listed here. Builds can be sorted based on:
 ## Create a backup
 
 :::note
-Backup schedules can only be created by platform administrators
+Backup can only be created by platform administrators
 :::
 
+1. Select the Team name in the top bar to set the context to the namespace that contains the PV to backup
 1. Enter a name for the backup
 2. Add the schedule of the backup. The schedule is a cron-type expression to schedule the backup. Defaults to once a day at 00:00. Create your cron-type expression [here](https://crontab.guru/).
 3. (optional) Select `Snapshot Volumes` to snapshot volumes. This only applies to Persistent Volumes in Azure, GCE, and AWS.
-4. Add a label selector. Make sure your workload has the correct labels. Workloads created in Otomi always have the following labels:
-
-- name: `app`
-- value: `name of the workload`
+4. Add a label selector. Make sure your workload has the correct labels.
 
 5. (optional) Change the default TTL (expiration of the backup). Defaults to 7 days.
 6. Click `Submit`

docs/for-ops/how-to/create-and-restore-backups.md

@@ -0,0 +1,120 @@
+---
+slug: backups
+title: Create/Restore backups
+sidebar_label: Backups
+---
+
+When Velero is activated on the platform level, platform admins can create backups of Persistent Volumes (PVs) in Team namespaces using Otomi Console. When creating backups using Otomi Console, a Velero `schedule` resource is created that will create the backup at a specified time, defined by a Cron expression.
+
+In this how-to, we'll create a backup of a PV using Otomi and then restore it using the velero CLI integrated into the Otomi Shell.
+
+## Prerequisites
+
+To perform this how-to, first make sure Velero is enabled. Velero requires object storage to be be configured. By default Velero uses the local Minio provided by Otomi.
+
+When Otomi installs Velero, the Velero plug-in for Azure, AWS and Google are configured by default. Velero also has support for backing up and restoring Kubernetes volumes using [Restic](https://velero.io/docs/v1.3.2/restic/#limitations). Note that Restic is not configured by default.
+
+For this how-to we'll use the PV of a Team's private Prometheus instance, so make sure Prometheus is also enabled. The Prometheus pod in the team namespace does not have the `backup.velero.io/backup-volumes` annotation. 
+
+Add the annotation:
+
+1. In Otomi Console, click on `Shell` in the bottom of the left menu
+2. Run the following cmd in the shell:
+
+```shell
+kubectl get po -n team-demo
+NAME                              READY   STATUS    RESTARTS   AGE
+prometheus-demo-po-prometheus-0   3/3     Running   0          52m
+
+kubectl get pod prometheus-demo-po-prometheus-0 -n team-demo -o yaml
+```
+
+In the output you will see that the volume used by Prometheus is `prometheus-demo-po-prometheus-db`:
+```yaml
+Volumes:
+  prometheus-demo-po-prometheus-db:
+    Type:       PersistentVolumeClaim (a reference to a PersistentVolumeClaim in the same namespace)
+    ClaimName:  prometheus-demo-po-prometheus-db-prometheus-demo-po-prometheus-0
+    ReadOnly:   false
+```
+
+3. Annotate the pod:
+
+```shell
+kubectl -n team-demo annotate pod prometheus-demo-po-prometheus-0 backup.velero.io/backup-volumes=prometheus-demo-po-prometheus-db
+pod/prometheus-demo-po-prometheus-0 annotate
+```
+
+and verify the pod has been annotated:
+
+```shell
+kubectl -n team-demo describe pod prometheus-demo-po-prometheus-0 | grep Annotations
+Annotations: backup.velero.io/backup-volumes: prometheus-demo-po-prometheus-db
+```
+
+## Create a backup schedule using Otomi
+
+1. Select the Team name in the top bar to set the context to the namespace that contains the PV to backup. In this how-to we'll use the team `demo`.
+2. In Otomi Console, click on `Backup` in the left menu under `Platform` and click on `Create`.
+3. Enter a name for the backup. In this how-to we'll use the name `prom`.
+4. Add the schedule of the backup. The schedule is a cron-type expression to schedule the backup. Defaults to once a day at 00:00. Create your cron-type expression [here](https://crontab.guru/).
+5. Using snapshots only applies to Persistent Volumes in Azure, GCE, and AWS
+6. In this how-to, we'll create a backup of the private Prometheus PV in the `demo` team. 
+
+- In Otomi Console, click on `Shell` in the bottom of the left menu.
+- Run the following cmd in the shell:
+
+```shell
+kubectl get statefulset prometheus-demo-po-prometheus -n team-demo --show-labels
+\NAME                            READY   AGE   LABELS
+prometheus-demo-po-prometheus   1/1     77m   app.kubernetes.io/instance=prometheus-demo,app.kubernetes.io/managed-by=Helm,app.kubernetes.io/part-of=demo-po,app.kubernetes.io/version=46.4.1,app=demo-po-prometheus,chart=kube-prometheus-stack-46.4.1,heritage=Helm,operator.prometheus.io/mode=server,operator.prometheus.io/name=demo-po-prometheus,operator.prometheus.io/shard=0,prometheus=team-demo,release=prometheus-demo
+```
+
+- click on `Add Item` and fill in the following:
+
+```yaml
+name: prometheus
+value: team-demo
+```
+
+7. Use the default TTL (expiration of the backup). Defaults to 7 days.
+8. Click `Submit`
+
+## Check if the schedule is created
+
+1. In Otomi Console, click on `Shell` in the bottom of the left menu
+2. Run the following cmd in the shell:
+
+```shell
+velero get schedules
+NAME                    STATUS    CREATED                         SCHEDULE     BACKUP TTL   LAST BACKUP   SELECTOR   PAUSED
+team-demo-backup-prom   Enabled   2023-09-24 11:50:59 +0000 UTC   55 * * * *   168h0m0s     n/a           <none>     false
+```
+
+## Check if the backup is created
+
+- Run the following cmd in the shell:
+
+```shell
+velero get backups
+NAME                                   STATUS      ERRORS   WARNINGS   CREATED                         EXPIRES   STORAGE LOCATION   SELECTOR
+team-demo-backup-prom-20230924115514   Completed   0        0          2023-09-24 11:55:14 +0000 UTC   6d        otomi              prometheus=team-demo
+```
+
+You can see the status of the backup is `Completed`. The backup is now stored in the local Minio.
+
+## Restore the backup
+
+Now the backup is created, we can restore the backup.
+
+- Run the following cmd in the shell:
+
+```shell
+velero restore create --from-backup team-demo-backup-prom-20230924115514
+Restore request "team-demo-backup-prom-20230924115514-20230924133133" submitted successfully.
+Run `velero restore describe team-demo-backup-prom-20230924115514-20230924133133` or `velero restore logs team-demo-backup-prom-20230924115514-20230924133133` for more details.
+```
+
+## Create custom backups
+
+Otomi only provides an easy self-service option for administrators to schedule backups of persistent volumes. The shell in Otomi includes the Velero CLI, so if you're confortable with Velero you can also create you're own custom backups. Check the docs on [https://velero.io/](https://velero.io/) for more information.

sidebar-docs.js

@@ -45,6 +45,7 @@ module.exports = {
           "for-ops/how-to/use-team-admin",
           "for-ops/how-to/core-only",
           "for-ops/how-to/install-with-dns",
+          "for-ops/how-to/create-and-restore-backups"
         ],
       },
       {