Skip to content

Commit

Permalink
Undo some changes, fix access editing
Browse files Browse the repository at this point in the history
  • Loading branch information
sajibcse68 committed Nov 22, 2017
1 parent cae892f commit 8085441
Show file tree
Hide file tree
Showing 11 changed files with 64 additions and 64 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Expand Up @@ -28,7 +28,7 @@ aliases:
## Features
- Fast, secure, efficient backup of any kubernetes [volumes](https://kubernetes.io/docs/concepts/storage/volumes/).
- Automates configuration of `restic` for periodic backup.
- Store backed up files in various cloud storage provider, including S3, GCS, Azure, OpenStack stash, DigitalOcean Spaces etc.
- Store backed up files in various cloud storage provider, including S3, GCS, Azure, OpenStack Swift, DigitalOcean Spaces etc.
- Prometheus ready metrics for backup process.

## Supported Versions
Expand Down
44 changes: 22 additions & 22 deletions docs/backends.md
Expand Up @@ -2,17 +2,17 @@
title: Backends | Stash
description: Backends of Stash
menu:
product_stash_0.7.1:
product_stash_0.5.1:
identifier: backends-stash
name: Backends
parent: getting-started
weight: 25
product_name: stash
left_menu: product_stash_0.7.1
left_menu: product_stash_0.5.1
section_menu_id: getting-started
url: /products/stash/0.7.1/getting-started/backends/
url: /products/stash/0.5.1/getting-started/backends/
aliases:
- /products/stash/0.7.1/backends/
- /products/stash/0.5.1/backends/
---

> New to Stash? Please start [here](/docs/tutorial.md).
Expand Down Expand Up @@ -350,8 +350,8 @@ spec:
```


### OpenStack stash
Stash supports [OpenStack stash as backend](https://restic.readthedocs.io/en/stable/manual.html#openstack-stash). To configure this backend, following secret keys are needed:
### OpenStack Swift
Stash supports [OpenStack Swift as backend](https://restic.readthedocs.io/en/stable/manual.html#openstack-swift). To configure this backend, following secret keys are needed:

| Key | Description |
|--------------------------|------------------------------------------------------------|
Expand Down Expand Up @@ -383,19 +383,19 @@ $ echo -n '<your-tenant-name>' > OS_TENANT_NAME
$ echo -n '<your-username>' > OS_USERNAME
$ echo -n '<your-password>' > OS_PASSWORD
$ echo -n '<your-region>' > OS_REGION_NAME
$ kubectl create secret generic stash-secret \
$ kubectl create secret generic swift-secret \
--from-file=./RESTIC_PASSWORD \
--from-file=./OS_AUTH_URL \
--from-file=./OS_TENANT_ID \
--from-file=./OS_TENANT_NAME \
--from-file=./OS_USERNAME \
--from-file=./OS_PASSWORD \
--from-file=./OS_REGION_NAME
secret "stash-secret" created
secret "swift-secret" created
```

```yaml
$ kubectl get secret stash-secret -o yaml
$ kubectl get secret swift-secret -o yaml

apiVersion: v1
data:
Expand All @@ -409,52 +409,52 @@ data:
kind: Secret
metadata:
creationTimestamp: 2017-07-03T19:17:39Z
name: stash-secret
name: swift-secret
namespace: default
resourceVersion: "36381"
selfLink: /api/v1/namespaces/default/secrets/stash-secret
selfLink: /api/v1/namespaces/default/secrets/swift-secret
uid: 47b4bcab-6024-11e7-879a-080027726d6b
type: Opaque
```

Now, you can create a Restic tpr using this secret. Following parameters are available for `stash` backend.
Now, you can create a Restic tpr using this secret. Following parameters are available for `Swift` backend.

| Parameter | Description |
|-------------------|-----------------------------------------------------------------------------|
| `stash.container` | `Required`. Name of Storage container |
| `stash.prefix` | `Optional`. Path prefix into bucket where repository will be created. |
| `swift.container` | `Required`. Name of Storage container |
| `swift.prefix` | `Optional`. Path prefix into bucket where repository will be created. |

```console
$ kubectl create -f ./docs/examples/backends/stash/stash-restic.yaml
restic "stash-restic" created
$ kubectl create -f ./docs/examples/backends/swift/swift-restic.yaml
restic "swift-restic" created
```

```yaml
$ kubectl get restic stash-restic -o yaml
$ kubectl get restic swift-restic -o yaml

apiVersion: stash.appscode.com/v1alpha1
kind: Restic
metadata:
creationTimestamp: 2017-06-28T13:31:14Z
name: stash-restic
name: swift-restic
namespace: default
resourceVersion: "7070"
selfLink: /apis/stash.appscode.com/v1alpha1/namespaces/default/restics/stash-restic
selfLink: /apis/stash.appscode.com/v1alpha1/namespaces/default/restics/swift-restic
uid: 0e8eb89b-5c06-11e7-bb52-08002711f4aa
spec:
selector:
matchLabels:
app: stash-restic
app: swift-restic
fileGroups:
- path: /source/data
retentionPolicy:
keepLast: 5
prune: true
backend:
stash:
swift:
container: stashqa
prefix: demo
storageSecretName: stash-secret
storageSecretName: swift-secret
schedule: '@every 1m'
volumeMounts:
- mountPath: /source/data
Expand Down
8 changes: 4 additions & 4 deletions docs/concept.md
Expand Up @@ -2,17 +2,17 @@
title: Concept | Stash
description: Concepts of Stash
menu:
product_stash_0.7.1:
product_stash_0.5.1:
identifier: concept-stash
name: Concept
parent: getting-started
weight: 30
product_name: stash
left_menu: product_stash_0.7.1
left_menu: product_stash_0.5.1
section_menu_id: getting-started
url: /products/stash/0.7.1/getting-started/concept/
url: /products/stash/0.5.1/getting-started/concept/
aliases:
- /products/stash/0.7.1/concept/
- /products/stash/0.5.1/concept/
---

> New to Stash? Please start [here](/docs/tutorial.md).
Expand Down
8 changes: 4 additions & 4 deletions docs/examples/backends/swift/swift-restic.yaml
@@ -1,22 +1,22 @@
apiVersion: stash.appscode.com/v1alpha1
kind: Restic
metadata:
name: stash-restic
name: swift-restic
namespace: default
spec:
selector:
matchLabels:
app: stash-restic
app: swift-restic
fileGroups:
- path: /source/data
retentionPolicy:
keepLast: 5
prune: true
backend:
stash:
swift:
container: stashqa
prefix: demo
storageSecretName: stash-secret
storageSecretName: swift-secret
schedule: '@every 1m'
volumeMounts:
- mountPath: /source/data
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/backends/swift/swift-secret.yaml
Expand Up @@ -10,9 +10,9 @@ data:
kind: Secret
metadata:
creationTimestamp: 2017-07-03T19:17:39Z
name: stash-secret
name: swift-secret
namespace: default
resourceVersion: "36381"
selfLink: /api/v1/namespaces/default/secrets/stash-secret
selfLink: /api/v1/namespaces/default/secrets/swift-secret
uid: 47b4bcab-6024-11e7-879a-080027726d6b
type: Opaque
16 changes: 8 additions & 8 deletions docs/install.md
Expand Up @@ -2,17 +2,17 @@
title: Install | Stash
description: Install of Stash
menu:
product_stash_0.7.1:
product_stash_0.5.1:
identifier: install-stash
name: Install
parent: getting-started
weight: 35
product_name: stash
left_menu: product_stash_0.7.1
left_menu: product_stash_0.5.1
section_menu_id: getting-started
url: /products/stash/0.7.1/getting-started/install/
url: /products/stash/0.5.1/getting-started/install/
aliases:
- /products/stash/0.7.1/install/
- /products/stash/0.5.1/install/
---

> New to Stash? Please start [here](/docs/tutorial.md).
Expand All @@ -24,11 +24,11 @@ Stash can be installed using YAML files includes in the [/hack/deploy](/hack/dep

```console
# Install without RBAC roles
$ kubectl apply -f https://raw.githubusercontent.com/appscode/stash/0.7.1/hack/deploy/without-rbac.yaml
$ kubectl apply -f https://raw.githubusercontent.com/appscode/stash/0.5.1/hack/deploy/without-rbac.yaml


# Install with RBAC roles
$ kubectl apply -f https://raw.githubusercontent.com/appscode/stash/0.7.1/hack/deploy/with-rbac.yaml
$ kubectl apply -f https://raw.githubusercontent.com/appscode/stash/0.5.1/hack/deploy/with-rbac.yaml
```

## Using Helm
Expand Down Expand Up @@ -80,13 +80,13 @@ $ POD_NAMESPACE=kube-system
$ POD_NAME=$(kubectl get pods -n $POD_NAMESPACE -l app=stash -o jsonpath={.items[0].metadata.name})
$ kubectl exec -it $POD_NAME -c operator -n $POD_NAMESPACE stash version

Version = 0.7.1
Version = 0.5.1
VersionStrategy = tag
Os = alpine
Arch = amd64
CommitHash = 85b0f16ab1b915633e968aac0ee23f877808ef49
GitBranch = release-0.5
GitTag = 0.7.1
GitTag = 0.5.1
CommitTimestamp = 2017-10-10T05:24:23

$ kubectl exec -it $POD_NAME -c operator -n $POD_NAMESPACE restic version
Expand Down
8 changes: 4 additions & 4 deletions docs/monitoring.md
Expand Up @@ -2,17 +2,17 @@
title: Monitoring | Stash
description: monitoring of Stash
menu:
product_stash_0.7.1:
product_stash_0.5.1:
identifier: monitoring-stash
name: Monitoring
parent: getting-started
weight: 40
product_name: stash
left_menu: product_stash_0.7.1
left_menu: product_stash_0.5.1
section_menu_id: getting-started
url: /products/stash/0.7.1/getting-started/monitoring/
url: /products/stash/0.5.1/getting-started/monitoring/
aliases:
- /products/stash/0.7.1/monitoring/
- /products/stash/0.5.1/monitoring/
---

> New to Stash? Please start [here](/docs/tutorial.md).
Expand Down
8 changes: 4 additions & 4 deletions docs/rbac.md
Expand Up @@ -2,17 +2,17 @@
title: rbac | Stash
description: rbac of Stash
menu:
product_stash_0.7.1:
product_stash_0.5.1:
identifier: rbac-stash
name: RBAC
parent: getting-started
weight: 45
product_name: stash
left_menu: product_stash_0.7.1
left_menu: product_stash_0.5.1
section_menu_id: getting-started
url: /products/stash/0.7.1/getting-started/rbac/
url: /products/stash/0.5.1/getting-started/rbac/
aliases:
- /products/stash/0.7.1/rbac/
- /products/stash/0.5.1/rbac/
---

# Configuring RBAC
Expand Down
12 changes: 6 additions & 6 deletions docs/tutorial.md
Expand Up @@ -2,17 +2,17 @@
title: Tutorial | Stash
description: tutorial of Stash
menu:
product_stash_0.7.1:
product_stash_0.5.1:
identifier: tutorial-stash
name: Tutorial
parent: getting-started
weight: 45
product_name: stash
left_menu: product_stash_0.7.1
left_menu: product_stash_0.5.1
section_menu_id: getting-started
url: /products/stash/0.7.1/getting-started/tutorial/
url: /products/stash/0.5.1/getting-started/tutorial/
aliases:
- /products/stash/0.7.1/tutorial/
- /products/stash/0.5.1/tutorial/
---

# Using Stash
Expand Down Expand Up @@ -131,7 +131,7 @@ spec:
Here,
- `spec.selector` is used to select workloads upon which this `Restic` configuration will be applied. `Restic` always selects workloads in the same Kubernetes namespace. In this tutorial, labels of `busybox` Deployment match this `Restic`'s selectors. If multiple `Restic` objects are matched to a given workload, Stash operator will error out and avoid adding sidecar container.
- `spec.fileGroups` indicates an array of local paths that will be backed up using restic. For each path, users can also define the retention policy for old snapshots. Here, we are backing up the `/source/data` folder and only keeping the last 5 snapshots.
- `spec.backend.local` indicates that restic will store the snapshots in a local path `/safe/data`. For the purpose of this tutorial, we are using an `emptyDir` to store the snapshots. But any Kubernetes volume that can be mounted locally can be used as a backend (example, NFS, Ceph, etc). Stash can also store snapshots in cloud storage solutions like S3, GCS, Azure, etc. To use a remote backend, you need to configure the storage secret to include your cloud provider credentials and set one of `spec.backend.(s3|gcs|azure|stash)`. Please visit [here](https://github.com/appscode/stash/blob/master/docs/backends.md) for more detailed examples.
- `spec.backend.local` indicates that restic will store the snapshots in a local path `/safe/data`. For the purpose of this tutorial, we are using an `emptyDir` to store the snapshots. But any Kubernetes volume that can be mounted locally can be used as a backend (example, NFS, Ceph, etc). Stash can also store snapshots in cloud storage solutions like S3, GCS, Azure, etc. To use a remote backend, you need to configure the storage secret to include your cloud provider credentials and set one of `spec.backend.(s3|gcs|azure|swift)`. Please visit [here](https://github.com/appscode/stash/blob/master/docs/backends.md) for more detailed examples.

- `spec.backend.storageSecretName` points to the Kubernetes secret created earlier in this tutorial. `Restic` always points to secrets in its own namespace. This secret is used to pass restic repository password and other cloud provider secrets to `restic` binary.
- `spec.schedule` is a [cron expression](https://github.com/robfig/cron/blob/v2/doc.go#L26) that indicates that file groups will be backed up every 1 minute.
Expand Down Expand Up @@ -212,7 +212,7 @@ spec:
fieldRef:
apiVersion: v1
fieldPath: metadata.name
image: appscode/stash:0.7.1
image: appscode/stash:0.5.1
imagePullPolicy: IfNotPresent
name: stash
resources: {}
Expand Down
8 changes: 4 additions & 4 deletions docs/uninstall.md
Expand Up @@ -2,17 +2,17 @@
title: Uninstall | Stash
description: uninstall of Stash
menu:
product_stash_0.7.1:
product_stash_0.5.1:
identifier: uninstall-stash
name: Uninstall
parent: getting-started
weight: 50
product_name: stash
left_menu: product_stash_0.7.1
left_menu: product_stash_0.5.1
section_menu_id: getting-started
url: /products/stash/0.7.1/getting-started/uninstall/
url: /products/stash/0.5.1/getting-started/uninstall/
aliases:
- /products/stash/0.7.1/uninstall/
- /products/stash/0.5.1/uninstall/
---

> New to Stash? Please start [here](/docs/tutorial.md).
Expand Down
10 changes: 5 additions & 5 deletions docs/workloads.md
Expand Up @@ -2,17 +2,17 @@
title: Workloads | Stash
description: workloads of Stash
menu:
product_stash_0.7.1:
product_stash_0.5.1:
identifier: workloads-stash
name: Workloads
parent: getting-started
weight: 55
product_name: stash
left_menu: product_stash_0.7.1
left_menu: product_stash_0.5.1
section_menu_id: getting-started
url: /products/stash/0.7.1/getting-started/workloads/
url: /products/stash/0.5.1/getting-started/workloads/
aliases:
- /products/stash/0.7.1/workloads/
- /products/stash/0.5.1/workloads/
---

> New to Stash? Please start [here](/docs/tutorial.md).
Expand Down Expand Up @@ -79,7 +79,7 @@ spec:
fieldRef:
apiVersion: v1
fieldPath: metadata.name
image: appscode/stash:0.7.1
image: appscode/stash:0.5.1
imagePullPolicy: IfNotPresent
name: stash
volumeMounts:
Expand Down

0 comments on commit 8085441

Please sign in to comment.