KubeStash

KubeStash by AppsCode is a cloud native data backup and recovery solution for Kubernetes workloads. If you are running production workloads in Kubernetes, you might want to take backup of your disks, databases etc. Traditional tools are too complex to set up and maintain in a dynamic compute environment like Kubernetes. KubeStash is a Kubernetes operator that uses restic or Kubernetes CSI Driver VolumeSnapshotter functionality to address these issues. Using KubeStash, you can backup Kubernetes volumes mounted in workloads, stand-alone volumes and databases. Users may even extend KubeStash via addons for any custom workload.

Here, we are going to give you an overview of KubeStash documentation structure.

Concepts

Concept explains some significant aspect of KubeStash. This is where you can learn about what KubeStash does and how it does it.

• KubeStash Overview Provides an introduction to KubeStash and gives an overview of the features it provides.
• KubeStash Architecture Provides an overview of KubeStash architecture, and it’s core components.
• KubeStash API Introduces KubeStash CRDs.

Setup

Setup contains instruction for installing, uninstalling, and upgrading KubeStash.

• Install KubeStash: Provides installation instructions for KubeStash and its various components.
  • KubeStash: Provides installation instructions for KubeStash.
  • kubeStash kubectl Plugin: Provides installation instructions for KubeStash kubectl plugin.
  • Troubleshooting: Provides troubleshooting guide for various installation problems.
• Uninstall KubeStash: Provides uninstallation instructions for KubeStash and its various components.
  • KubeStash: Provides uninstallation instructions for KubeStash.
  • KubeStash kubectl Plugin: Provides uninstallation instructions for KubeStash kubectl plugin.
• Upgrade KubeStash: Provides instruction for updating KubeStash license and upgrading between various KubeStash versions.

Guides

Guides show how to perform different operations with KubeStash.

• Supported Backends: Describes how to configure different storage for storing backed up data.
• Workload Volume Backup: Shows how to use KubeStash to backup and restore volumes of a workload (i.e. Deployment, StatefulSet, DaemonSet, etc).
• Stand-alone Volume Backup: Shows how to use KubeStash to backup and restore stand-alone volumes(i.e. PersistentVolumeClaim).
• Auto Backup: Shows how to configure automatic backup of any stateful workload in your cluster.
• Volume Snapshot: Shows how KubeStash takes snapshot of PersistentVolumeClaims and restore them from snapshot using Kubernetes VolumeSnapshot API.
• Platforms: Shows how to use KubeStash to backup and restore volumes of a Kubernetes workload running in different platforms.
• Hooks: Shows how to execute different actions before/after the backup/restore process.
• CLI: Shows how to manage KubeStash objects quickly and easily using KubeStash kubectl plugin.
• Security: Describes different built-in cluster security support by KubeStash.

We’re always looking for help improving our documentation, so please don’t hesitate to file an issue if you see some problem.