You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
Local
Local backend refers to a local path inside stash sidecar container. Any Kubernetes supported persistent volume can be used here. Some examples are: emptyDir (for testing), NFS, Ceph, GlusterFS, etc. This tutorial will show you how to configure Restic and storage Secret for Local backend.
Create Storage Secret
To configure storage secret for this backend, following secret keys are needed:
| Key | Description |
|---|---|
RESTIC_PASSWORD | Required. Password used to encrypt snapshots by restic |
Create storage secret as below,
$ echo -n 'changeit' > RESTIC_PASSWORD
$ kubectl create secret generic local-secret --from-file=./RESTIC_PASSWORD
secret "local-secret" created
Verify that the secret has been created with respective keys,
$ kubectl get secret local-secret -o yaml
apiVersion: v1
data:
RESTIC_PASSWORD: Y2hhbmdlaXQ=
kind: Secret
metadata:
creationTimestamp: 2017-06-28T12:06:19Z
name: stash-local
namespace: default
resourceVersion: "1440"
selfLink: /api/v1/namespaces/default/secrets/stash-local
uid: 31a47380-5bfa-11e7-bb52-08002711f4aa
type: Opaque
Configure Restic
Now, you have to configure Restic crd to use Local backend. You have to provide previously created storage secret in spec.backend.storageSecretName field.
Following parameters are available for Local backend.
| Parameter | Description |
|---|---|
local.mountPath | Required. Path where this volume will be mounted in the sidecar container. Example: /repo |
local.subPath | Optional. Sub-path inside the referenced volume instead of its root. |
local.VolumeSource | Required. Any Kubernetes volume. Can be specified inlined. Example: hostPath |
Sample Restic for hostPath as Backend :
Below, the YAML for Restic crd configured to use hostPath as Local backend.
apiVersion: stash.appscode.com/v1alpha1
kind: Restic
metadata:
name: local-restic
namespace: default
spec:
selector:
matchLabels:
app: local-restic
fileGroups:
- path: /source/data
retentionPolicyName: 'keep-last-5'
backend:
local:
mountPath: /repo
hostPath:
path: /data/stash-test/restic-repo
storageSecretName: local-secret
schedule: '@every 1m'
volumeMounts:
- mountPath: /source/data
name: source-data
retentionPolicies:
- name: 'keep-last-5'
keepLast: 5
prune: true
Now, create the Restic we have configured above for local backend,
$ kubectl apply -f https://github.com/stashed/docs/raw/v2021.04.12/docs/examples/backends/local/local-restic-hostPath.yaml
restic "local-restic" created
Sample Restic for NFS Server as Backend :
Below, the YAML for Restic crd configured to use a NFS server as Local backend.
apiVersion: stash.appscode.com/v1alpha1
kind: Restic
metadata:
name: local-restic
namespace: default
spec:
selector:
matchLabels:
app: stash-demo
fileGroups:
- path: /source/data
retentionPolicyName: 'keep-last-5'
backend:
local:
mountPath: /safe/data
nfs:
server: "nfs-service.storage.svc.cluster.local" # use you own NFS server address
path: "/" # this path is relative to "/exports" path of NFS server
storageSecretName: local-secret
schedule: '@every 1m'
volumeMounts:
- mountPath: /source/data
name: source-data
retentionPolicies:
- name: 'keep-last-5'
keepLast: 5
prune: true
Now, create the Restic we have configured above for local backend,
$ kubectl apply -f https://github.com/stashed/docs/raw/v2021.04.12/docs/examples/backends/local/local-restic-nfs.yaml
restic "local-restic" created