You are looking at the documentation of a prior release. To read the documentation of the latest release, please visit here.
New to Stash? Please start here.
Snapshot is a representation of backup snapshot in a Kubernetes native way. Stash uses an Aggregated API Server to provide
list capabilities for snapshots from the backend.
This enables you to view some useful information such as
backed up path etc of a snapshot. This also provides the capability to restore a specific snapshot.
Like other official Kuberentes resources, a
Status sections. However, unlike other Kubernetes resources, it does not have a
Snapshot object is shown below,
apiVersion: repositories.stash.appscode.com/v1alpha1 kind: Snapshot metadata: creationTimestamp: "2019-04-25T05:05:06Z" labels: repository: local-repo name: local-repo-d421fe22 namespace: demo selfLink: /apis/repositories.stash.appscode.com/v1alpha1/namespaces/demo/snapshots/local-repo-d421fe22 uid: d421fe22de090511a74b8ab5f1f307f2fa4e0d8e2f624a7481095db828127147 status: gid: 0 hostname: host-0 paths: - /source/data tree: bb1d63756e937c001cf48ed062c69a9968978821a328f5ab06873f3b90346da2 uid: 0 username: ""
Here, we are going to describe the various sections of a
metadata.name specifies the name of the
Snapshot object. It follows the following pattern,
<Repository crd name>-<first 8 digits of snapshot id>.
metadata.uid specifies the complete id of the respective restic snapshot in the backend.
metadata.creationTimestamp represents the time when the snapshot was created.
Snapshot object holds
Repository name as a label in
metadata.labels section. This helps a user to query the snapshots of a particular
Snapshot object has the following fields in
status.gid indicates the group identifier of the user who took this backup.
status.hostname indicates the name of the host whose data was backed up in this snapshot. For
ReplicationController it is host-0. For
DaemonSet, hostname is the respective node name where daemon pod is running. For
StatefulSet, hostname is host-<pod ordinal> for the respective pods.
status.paths indicates the paths that have been backed up in this snapshot.
tree of the restic snapshot. For more details, please visit here.
uid of the user who took this backup. For
root user it is 0.
status.username indicates the name of the user who runs the backup process that took the backup.
status.tags indicates the tags of the snapshot.
# List Snapshots of all Repositories in the current namespace $ kubectl get snapshot # List Snapshots of all Repositories of all namespaces $ kubectl get snapshot --all-namespaces # List Snapshots of all Repositories of a particular namespace $ kubectl get snapshot -n demo # List Snapshots of a particular Repository $ kubectl get snapshot -l repository=local-repo # List Snapshots from multiple Repositories $ kubectl get snapshot -l 'repository in (local-repo,gcs-repo)'
Viewing information of a particular Snapshot:
$ kubectl get snapshot [-n <namespace>] <snapshot name> -o yaml # Example: $ kubectl get snapshot -n demo local-repo-02b0ed42 -o yaml
apiVersion: repositories.stash.appscode.com/v1alpha1 kind: Snapshot metadata: creationTimestamp: "2019-04-25T06:01:04Z" labels: repository: local-repo name: local-repo-02b0ed42 namespace: demo selfLink: /apis/repositories.stash.appscode.com/v1alpha1/namespaces/demo/snapshots/local-repo-02b0ed42 uid: 02b0ed42791d2d13756cb9e2d05db42f514d51e23028f42bcbe3a152978aa499 status: gid: 0 hostname: host-0 paths: - /source/data tree: bb1d63756e937c001cf48ed062c69a9968978821a328f5ab06873f3b90346da2 uid: 0 username: ""
Snapshots listing facility with the help of an Aggregated API Server. Your cluster must support Aggregated API Server. Otherwise, you won’t be able to perform
list operation on
If you are using local backend, the respective pod that took the backup must be in
Running state. It is not necessary if you use cloud backends.