Skip to content

Commit b1a5dde

Browse files
1gtmEmruz Hossain
andauthored
[cherry-pick] Update documentation for KubeDB v1alpha2 (#616) (#673)
/cherry-pick Signed-off-by: Emruz Hossain <emruz@appscode.com> Tasks: - [x] Update existing documentation - [x] Add auto-backup documentation - [x] Add backup/restore customization documentation - [x] Test docs rendering locally Co-authored-by: Emruz Hossain <emruz@appscode.com>
1 parent 3ac327b commit b1a5dde

29 files changed

+2770
-30
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
apiVersion: stash.appscode.com/v1beta1
2+
kind: BackupBlueprint
3+
metadata:
4+
name: elasticsearch-backup-template
5+
spec:
6+
# ============== Blueprint for Repository ==========================
7+
backend:
8+
gcs:
9+
bucket: stash-testing
10+
prefix: stash-backup/${TARGET_NAMESPACE}/${TARGET_APP_RESOURCE}/${TARGET_NAME}
11+
storageSecretName: gcs-secret
12+
# ============== Blueprint for BackupConfiguration =================
13+
task:
14+
name: elasticsearch-backup-7.3.2-v6
15+
schedule: "*/5 * * * *"
16+
interimVolumeTemplate:
17+
metadata:
18+
name: ${TARGET_APP_RESOURCE}-${TARGET_NAME} # To ensure that the PVC names are unique for different database
19+
spec:
20+
accessModes: [ "ReadWriteOnce" ]
21+
storageClassName: "standard"
22+
resources:
23+
requests:
24+
storage: 1Gi
25+
retentionPolicy:
26+
name: 'keep-last-5'
27+
keepLast: 5
28+
prune: true
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: Elasticsearch
3+
metadata:
4+
name: es-demo-2
5+
namespace: demo-2
6+
annotations:
7+
stash.appscode.com/backup-blueprint: elasticsearch-backup-template
8+
stash.appscode.com/schedule: "*/3 * * * *"
9+
spec:
10+
version: 7.9.1-xpack
11+
replicas: 1
12+
storageType: Durable
13+
storage:
14+
resources:
15+
requests:
16+
storage: 1Gi
17+
storageClassName: standard
18+
terminationPolicy: WipeOut
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: Elasticsearch
3+
metadata:
4+
name: es-demo-3
5+
namespace: demo-3
6+
annotations:
7+
stash.appscode.com/backup-blueprint: elasticsearch-backup-template
8+
params.stash.appscode.com/args: --ignoreType=settings,template
9+
spec:
10+
version: 7.9.1-xpack
11+
replicas: 1
12+
storageType: Durable
13+
storage:
14+
resources:
15+
requests:
16+
storage: 1Gi
17+
storageClassName: standard
18+
terminationPolicy: WipeOut
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
apiVersion: kubedb.com/v1alpha2
2+
kind: Elasticsearch
3+
metadata:
4+
name: es-demo
5+
namespace: demo
6+
annotations:
7+
stash.appscode.com/backup-blueprint: elasticsearch-backup-template
8+
spec:
9+
version: 7.9.1-xpack
10+
replicas: 1
11+
storageType: Durable
12+
storage:
13+
resources:
14+
requests:
15+
storage: 1Gi
16+
storageClassName: standard
17+
terminationPolicy: WipeOut

docs/auto-backup/images/es-demo-2.png

48 KB
Loading

docs/auto-backup/images/es-demo-3.png

48.4 KB
Loading

docs/auto-backup/images/es-demo.png

51.3 KB
Loading

0 commit comments

Comments
 (0)