New to KubeStash? Please start here.

KubeStash kubectl Plugin

KubeStash gives you kubectl plugin support named kubectl kubestash cli. kubectl kubestash cli can be used to manage KubeStash objects quickly and easily. It performs various operations like coping KubeStash objects, cloning PVC, unlock Repository, triggering an instant backup, etc. To install KubeStash kubectl plugin on your workstation, follow the steps here.

Available Command

Available command for kubectl kubestash cli are:

Copy Command

kubectl kubestash cp command is used to copy objects like, Secret and VolumeSnapshot, from one namespace to another namespace.

Copy Secret

To copy a Secret, you need to provide Secret name and destination namespace. The available flags are:

Format:

kubectl kubestash cp secret <secret-name> [flags]

Example:

$ kubectl kubestash cp secret my-secret --namespace=demo --to-namespace=demo1

Copy VolumeSnapshot

To copy a VolumeSnapshot, you need to provide VolumeSnapshot name and destination namespace. The available flags are:

Example:

$ kubectl kubestash cp volumesnapshot my-vol-snap --namespace=demo --to-namespace=demo1

Clone PVC

kubectl kubestash clone pvc command is used to clone PVC from one namespace to another namespace. When we run the command the cloning process consists of the following steps:

• At first, It creates a BackupStorage in the source namespace (if no storage is provided).
• It creates a RetentionPolicy in the source namespace.
• Using these BackupStorage and RetentionPolicy, it creates a BackupConfiguration targeting the PVC to take backup.
• After the backup process succeeded, It creates a RestoreSession in the source namespace with the target in destination namespace.
• finally, It restores the backed up data into VolumeClaimTemplate in the destination namespace.

To clone a PVC, you can provide the reference of the existing BackupStorage if you already have one; otherwise, you have to provide the backend information. Additionally, you need to provide the encryption secret reference. The available flags are:

If you want to use existing BackupStorage, then provide storage-name and storage-namespace flags and there is no need to provide the provider, bucket, endpoint, region, max-connections, storage-secret and prefix flags.

Format:

kubectl kubestash clone pvc <pvc-name> [flags]

Example:

$ kubectl kubestash clone pvc my-pvc -n demo --to-namespace=demo-1 --storage-secret=<storage-secret> --bucket=<bucket> --prefix=<prefix> --provider=<provider> --encrypt-secret=<encryption-secret> --encrypt-secret-namespace=<encryption-secret-namespace>

Download Snapshot

kubectl kubestash download command is used to download the components of a snapshot from backend repository into your local machine. To download the snapshot you have to provide Snapshot name and download directory. The available flags are:

Format:

kubectl kubestash download <snapshot-name> [flags]

Example:

$ kubectl kubestash download demo-storage-sample-backup-frequent-backup-1699355040 --namespace=demo --destination=/home/user/downloads/ 

Trigger an Instant Backup

kubectl kubestash trigger command is used to take an instant backup in KubeStash. To trigger an instant backup, you need to have a BackupConfiguration in your cluster. You need to provide the BackupConfiguration name. You can also provide the namespace by using the --namespace flag. This flag indicates the namespace where the trigger backup will be occurred. To trigger backup for specific sessions, you need to provide the session names (comma seperated) by using the --sessions flag. If you want to trigger backup for all the sessions present in the BackupConfiguration, then this flag should be omitted.

Format:

$ kubectl kubestash trigger <backupconfig-name> [flags]

Example:

$ kubectl kubestash trigger my-config --namespace=demo --sessions=frequent-backup,everyday-backup

Unlock Repository

kubectl kubestash unlock is used to remove lock from the backend repository.

To unlock the Repository, you need to provide a Repository name. You can also provide the namespace by using the --namespace flag. This flag indicates the Repository namespace.

A Repository can have multiple components. To unlock the repository for a specific component, you need to provide the component paths (comma seperated) by using the --paths flag. You can find the paths in the status.componentPaths section of the respective Repository. If you want to unlock all the components of the respective Repository, then this flag should be omitted.

Format:

kubectl kubestash unlock <repository-name> [flags]

Example:

$ kubectl kubestash unlock demo-repo --namespace=demo --paths=repository/v1/frequent-backup/pod-0,repository/v1/frequent-backup/pod-1

Pause Backup

kubectl kubestash pause command is used to pause KubeStash backup temporarily. To pause a backup you have to provide the BackupConfiguration name. You can also provide the namespace by using the --namespace flag. This flag indicates the BackupConfiguration namespace.

Format:

kubectl kubestash pause <backupconfiguration-name> [flags]

Example:

$ kubectl kubestash pause sample-backupconfig -n demo

Resume Backup

To resume a backup you have to provide the BackupConfiguration name. You can also provide the namespace by using the --namespace flag. This flag indicates the BackupConfiguration namespace.

Format:

kubectl kubestash resume <backupconfiguration-name> [flags]

Example:

$ kubectl kubestash resume sample-backupconfig -n demo

Debug Command

kubectl kubestash debug command is used to debug KubeStash resources. This command describes the necessary resources and shows logs from the related pods which makes the debugging process quicker and easier.

Debug Backup

To debug a backup you have to provide the BackupConfiguration name. You can also provide the namespace by using the --namespace flag. This flag indicates the BackupConfiguration namespace.

Format:

kubectl kubestash debug backup <backupconfiguration-name> [flags]

Example:

$ kubectl kubestash debug backup sample-backupconfig --namespace=demo

Debug Restore

To debug a restore you have to provide the RestoreSession name. You can also provide the namespace by using the --namespace flag. This flag indicates the RestoreSession namespace.

Format:

kubectl kubestash debug restore <restoresession-name> [flags]

Example:

$ kubectl kubestash debug restore sample-restore --namespace=demo 

Debug Operator

To debug the KubeStash operator you need to run the following command:

$ kubectl kubestash debug operator

Password Command

kubectl kubestash pw command is used to manage passwords (keys) of restic repositories.

Password Add

This command is used to add a new password (key) to restic repositories. You have to provide the information of the new password by using flags. The available flags are:

Format

kubectl kubestash pw add <repository-name> [flags]

Example

kubectl kubestash pw add demo-repo --namespace=demo --user=root --host=demo-host --new-password-file=pass.txt

Password List

This command is used to list restic passwords (keys) of restic repositories. You can also provide the list of component paths (restic repositories) for which to list the passwords by using --paths flag. You can also provide the namespace by using the --namespace flag. This flag indicates the Repository namespace.

Format

kubectl kubestash pw list <repository-name> [flags]

Example

kubectl kubestash pw list demo-repo --namespace=demo --paths=repository/v1/frequent-backup/pod-0,repository/v1/frequent-backup/pod-1

Password Update

This command is used to update the current password (key) of restic repositories. The available flags for this command are:

Format

kubectl kubestash pw update <repository-name> [flags]

Example

kubectl kubestash pw update demo-repo --namespace=demo --paths=repository/v1/frequent-backup/pod-0,repository/v1/frequent-backup/pod-1 --new-password-file=pass.txt

Password Remove

This command is used to remove passwords (keys) from restic repositories. The available flags for this command are:

Format

kubectl kubestash pw remove <repository-name> [flags]

Example

kubectl kubestash pw remove demo-repo --namespace=demo --id-paths=a30343d8:repository/v1/frequent-backup/pod-2