Skip to content

Latest commit

 

History

History
73 lines (66 loc) · 2.56 KB

user_guide.md

File metadata and controls

73 lines (66 loc) · 2.56 KB
title menuTitle description weight disableToc tags
Kahu User Guide
User Guide
User guide for the Kahu (Container Data Backup & Restore) project
10
false
user guide
kahu
soda-cdm

Kahu features can be realised through deployment on kubernetes(k8s) cluster. For kahu deployment steps and options, please refer deployment guide

Follow below steps to experience typical usecase which kahu provides

  1. Clone kahu project to get usage examples
git clone https://github.com/soda-cdm/kahu.git
cd kahu/examples
  1. Create backup location. In this example, backup location is created using nfs provider
kubectl create -f backuplocation.yaml

Typical usecases

Backup and restore applications at namespace scope

  1. Create an application with its all resources at "deafult" namespace.

  2. Create backup object at namespace level

kubectl apply -f backup-namespace.yaml
  1. Verify the state of backup object in the cluster
kubectl get backups
  1. Once the backup stage is "Finished", restore an application from backup by creating restore object. Edit restore.yaml to update "backupName" and "namespaceMapping" with desired values. This sample yaml uses "restore-ns" as the namespace to restore resources of "default" namespace
kubectl apply -f restore.yaml
  1. Verify the state of restore object in the cluster
kubectl get restores
  1. Once the restore stage is "Finished", verify the restore of application resources by checking resources as "restore-ns" namespace
kubectl get all -n restore-ns

Backup and restore a specific resource

  1. Create 2 pods namely pod1234, pod5678 in "default" namespace

  2. Create backup object to backup only pod1234

kubectl apply -f backup-specific-resource.yaml
  1. Verify the state of backup object in the cluster
kubectl get backups
  1. Once the backup stage is "Finished", restore an application from backup by creating restore object. Edit restore.yaml to update "backupName" and "namespaceMapping" with desired values. This sample yaml uses "restore-ns" as the namespace to restore resources of "default" namespace
kubectl apply -f restore.yaml
  1. Verify the state of restore object in the cluster
kubectl get restores
  1. Once the restore stage is "Finished", verify the restore of application resources by checking resources as "restore-ns" namespace. Only pod1234 is expected to be restored back
kubectl get all -n restore-ns