From f0b8e87f8961d60b33e2ef3cde7acf18d4a530d7 Mon Sep 17 00:00:00 2001 From: hossainemruz Date: Wed, 2 Oct 2019 13:27:45 +0600 Subject: [PATCH] Prepare for 3.4.17 release --- Makefile | 4 +- README.md | 8 ++-- chart/stash-mongodb/Chart.yaml | 4 +- chart/stash-mongodb/README.md | 18 ++++----- chart/stash-mongodb/templates/_helpers.tpl | 2 +- chart/stash-mongodb/values.yaml | 2 +- docs/_index.md | 2 +- .../backupconfiguration-replicaset.yaml | 2 +- .../replicaset/mongodb-replicaset-ssl.yaml | 2 +- .../backup/replicaset/mongodb-replicaset.yaml | 2 +- .../backup/replicaset/standalone-backup.yaml | 2 +- .../backupconfiguration-sharding.yaml | 2 +- .../backup/sharding/mongodb-sharding-ssl.yaml | 2 +- .../backup/sharding/mongodb-sharding.yaml | 2 +- .../backup/sharding/standalone-backup.yaml | 2 +- .../standalone/backupconfiguration.yaml | 2 +- .../backup/standalone/mongodb-ssl.yaml | 2 +- docs/examples/backup/standalone/mongodb.yaml | 2 +- .../restored-mongodb-replicaset.yaml | 2 +- .../replicaset/restored-standalone.yaml | 2 +- .../replicaset/restoresession-replicaset.yaml | 2 +- .../replicaset/restoresession-standalone.yaml | 2 +- .../sharding/restored-mongodb-sharding.yaml | 2 +- .../restore/sharding/restored-standalone.yaml | 2 +- .../sharding/restoresession-sharding.yaml | 2 +- .../sharding/restoresession-standalone.yaml | 2 +- .../restore/standalone/restored-mongodb.yaml | 2 +- .../restore/standalone/restoresession.yaml | 2 +- docs/mongodb-replicaset.md | 38 +++++++++--------- docs/mongodb-sharding.md | 40 +++++++++---------- docs/mongodb.md | 28 ++++++------- 31 files changed, 94 insertions(+), 94 deletions(-) diff --git a/Makefile b/Makefile index 58d897a30..33e22429b 100644 --- a/Makefile +++ b/Makefile @@ -59,8 +59,8 @@ BIN_PLATFORMS := $(DOCKER_PLATFORMS) OS := $(if $(GOOS),$(GOOS),$(shell go env GOOS)) ARCH := $(if $(GOARCH),$(GOARCH),$(shell go env GOARCH)) -BASEIMAGE_PROD ?= mongo:3.4.22 -BASEIMAGE_DBG ?= mongo:3.4.22 +BASEIMAGE_PROD ?= mongo:3.4.17 +BASEIMAGE_DBG ?= mongo:3.4.17 IMAGE := $(REGISTRY)/$(BIN) VERSION_PROD := $(VERSION) diff --git a/README.md b/README.md index 67f22ba1f..d7c40e60c 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,22 @@ MongoDB backup and restore plugin for [Stash by AppsCode](https://appscode.com/p ## Install -Install MongoDB 3.4 backup or restore plugin for Stash as below. +Install MongoDB 3.4.17 backup or restore plugin for Stash as below. ```console helm repo add appscode https://charts.appscode.com/stable/ helm repo update -helm install appscode/stash-mongodb --name=stash-mongodb-3.4 --version=3.4 +helm install appscode/stash-mongodb --name=stash-mongodb-3.4.17 --version=3.4.17 ``` To install catalog for all supported MongoDB versions, please visit [here](https://github.com/stashed/catalog). ## Uninstall -Uninstall MongoDB 3.4 backup or restore plugin for Stash as below. +Uninstall MongoDB 3.4.17 backup or restore plugin for Stash as below. ```console -helm delete stash-mongodb-3.4 +helm delete stash-mongodb-3.4.17 ``` ## Support diff --git a/chart/stash-mongodb/Chart.yaml b/chart/stash-mongodb/Chart.yaml index 8e4f84b5e..825d09568 100644 --- a/chart/stash-mongodb/Chart.yaml +++ b/chart/stash-mongodb/Chart.yaml @@ -1,8 +1,8 @@ apiVersion: v1 description: 'stash-mongodb - MongoDB database backup and restore plugin for Stash by AppsCode' name: stash-mongodb -version: 3.4 -appVersion: 3.4 +version: 3.4.17 +appVersion: 3.4.17 home: https://github.com/stashed/mongodb icon: https://cdn.appscode.com/images/icon/stash.png sources: diff --git a/chart/stash-mongodb/README.md b/chart/stash-mongodb/README.md index d7e642d47..cc427768e 100644 --- a/chart/stash-mongodb/README.md +++ b/chart/stash-mongodb/README.md @@ -7,12 +7,12 @@ ```console helm repo add appscode https://charts.appscode.com/stable/ helm repo update -helm install appscode/stash-mongodb --name=stash-mongodb-3.4 --version=3.4 +helm install appscode/stash-mongodb --name=stash-mongodb-3.4.17 --version=3.4.17 ``` ## Introduction -This chart installs necessary `Function` and `Task` definition to backup or restore MongoDB database 3.4 using Stash. +This chart installs necessary `Function` and `Task` definition to backup or restore MongoDB database 3.4.17 using Stash. ## Prerequisites @@ -32,20 +32,20 @@ helm repo add appscode https://charts.appscode.com/stable/ helm repo update ``` -- Install the chart with the release name `stash-mongodb-3.4` run the following command, +- Install the chart with the release name `stash-mongodb-3.4.17` run the following command, ```console -helm install appscode/stash-mongodb --name=stash-mongodb-3.4 --version=3.4 +helm install appscode/stash-mongodb --name=stash-mongodb-3.4.17 --version=3.4.17 ``` -The above commands installs `Functions` and `Task` crds that are necessary to backup MongoDB database 3.4 using Stash. +The above commands installs `Functions` and `Task` crds that are necessary to backup MongoDB database 3.4.17 using Stash. ## Uninstalling the Chart -To uninstall/delete the `stash-mongodb-3.4` run the following command, +To uninstall/delete the `stash-mongodb-3.4.17` run the following command, ```console -helm delete stash-mongodb-3.4 +helm delete stash-mongodb-3.4.17 ``` The command removes all the Kubernetes components associated with the chart and deletes the release. @@ -58,7 +58,7 @@ The following table lists the configurable parameters of the `stash-mongodb` cha | ----------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------- | | `docker.registry` | Docker registry used to pull respective images | `stashed` | | `docker.image` | Docker image used to backup/restore MongoDB database | `stash-mongodb` | -| `docker.tag` | Tag of the image that is used to backup/restore MongoDB database. This is usually same as the database version it can backup. | `3.4` | +| `docker.tag` | Tag of the image that is used to backup/restore MongoDB database. This is usually same as the database version it can backup. | `3.4.17` | | `backup.mgArgs` | Optional arguments to pass to `mongodump` command during bakcup process | | | `restore.mgArgs` | Optional arguments to pass to `mongorestore` command during restore process | | @@ -67,5 +67,5 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm For example: ```console -helm install --name stash-mongodb-3.4 --set docker.registry=my-registry appscode/stash-mongodb +helm install --name stash-mongodb-3.4.17 --set docker.registry=my-registry appscode/stash-mongodb ``` diff --git a/chart/stash-mongodb/templates/_helpers.tpl b/chart/stash-mongodb/templates/_helpers.tpl index 5109e7689..cf76aa679 100644 --- a/chart/stash-mongodb/templates/_helpers.tpl +++ b/chart/stash-mongodb/templates/_helpers.tpl @@ -31,7 +31,7 @@ Create chart name and version as used by the chart label. {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} {{- end -}} -# default labels for stash-mongodb resources +# default labels for posgres-stash resources {{- define "stash-mongodb.labels" -}} app.kubernetes.io/name: {{ include "stash-mongodb.name" . }} helm.sh/chart: {{ include "stash-mongodb.chart" . }} diff --git a/chart/stash-mongodb/values.yaml b/chart/stash-mongodb/values.yaml index 9a178cde9..01bedf04b 100644 --- a/chart/stash-mongodb/values.yaml +++ b/chart/stash-mongodb/values.yaml @@ -6,7 +6,7 @@ docker: registry: stashed image: stash-mongodb - tag: 3.4 + tag: 3.4.17 # optional argument to send mongodump or mongorestore command backup: diff --git a/docs/_index.md b/docs/_index.md index 8624ef31f..a4b7bdbce 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -5,6 +5,6 @@ menu: identifier: stash-mongodb-guides-{{ .subproject_version }} name: {{ .subproject_version }} parent: stash-mongodb-guides - weight: 10 + weight: 15 menu_name: product_stash_{{ .version }} --- diff --git a/docs/examples/backup/replicaset/backupconfiguration-replicaset.yaml b/docs/examples/backup/replicaset/backupconfiguration-replicaset.yaml index 9f1ae2ec2..8bbedab69 100644 --- a/docs/examples/backup/replicaset/backupconfiguration-replicaset.yaml +++ b/docs/examples/backup/replicaset/backupconfiguration-replicaset.yaml @@ -6,7 +6,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo-replicaset target: diff --git a/docs/examples/backup/replicaset/mongodb-replicaset-ssl.yaml b/docs/examples/backup/replicaset/mongodb-replicaset-ssl.yaml index 07f69c2f9..426f99497 100644 --- a/docs/examples/backup/replicaset/mongodb-replicaset-ssl.yaml +++ b/docs/examples/backup/replicaset/mongodb-replicaset-ssl.yaml @@ -4,7 +4,7 @@ metadata: name: sample-mgo-rs-ssl namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" replicas: 3 replicaSet: name: rs0 diff --git a/docs/examples/backup/replicaset/mongodb-replicaset.yaml b/docs/examples/backup/replicaset/mongodb-replicaset.yaml index 9e802d727..67dc613cb 100644 --- a/docs/examples/backup/replicaset/mongodb-replicaset.yaml +++ b/docs/examples/backup/replicaset/mongodb-replicaset.yaml @@ -4,7 +4,7 @@ metadata: name: sample-mgo-rs namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" replicas: 3 replicaSet: name: rs0 diff --git a/docs/examples/backup/replicaset/standalone-backup.yaml b/docs/examples/backup/replicaset/standalone-backup.yaml index 64496942c..952cb6b11 100644 --- a/docs/examples/backup/replicaset/standalone-backup.yaml +++ b/docs/examples/backup/replicaset/standalone-backup.yaml @@ -35,7 +35,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo-custom target: diff --git a/docs/examples/backup/sharding/backupconfiguration-sharding.yaml b/docs/examples/backup/sharding/backupconfiguration-sharding.yaml index 1f7785b7c..f969f911e 100644 --- a/docs/examples/backup/sharding/backupconfiguration-sharding.yaml +++ b/docs/examples/backup/sharding/backupconfiguration-sharding.yaml @@ -6,7 +6,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo-sharding target: diff --git a/docs/examples/backup/sharding/mongodb-sharding-ssl.yaml b/docs/examples/backup/sharding/mongodb-sharding-ssl.yaml index 90027ca56..4de3c7656 100644 --- a/docs/examples/backup/sharding/mongodb-sharding-ssl.yaml +++ b/docs/examples/backup/sharding/mongodb-sharding-ssl.yaml @@ -4,7 +4,7 @@ metadata: name: sample-mgo-sh-ssl namespace: demo spec: - version: 3.4-v4 + version: 3.4.17 shardTopology: configServer: replicas: 3 diff --git a/docs/examples/backup/sharding/mongodb-sharding.yaml b/docs/examples/backup/sharding/mongodb-sharding.yaml index 72fe104a1..20d1429e4 100644 --- a/docs/examples/backup/sharding/mongodb-sharding.yaml +++ b/docs/examples/backup/sharding/mongodb-sharding.yaml @@ -4,7 +4,7 @@ metadata: name: sample-mgo-sh namespace: demo spec: - version: 3.4-v4 + version: 3.4.17 shardTopology: configServer: replicas: 3 diff --git a/docs/examples/backup/sharding/standalone-backup.yaml b/docs/examples/backup/sharding/standalone-backup.yaml index 797ded4a8..8171e0f86 100644 --- a/docs/examples/backup/sharding/standalone-backup.yaml +++ b/docs/examples/backup/sharding/standalone-backup.yaml @@ -35,7 +35,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo-custom target: diff --git a/docs/examples/backup/standalone/backupconfiguration.yaml b/docs/examples/backup/standalone/backupconfiguration.yaml index 4c87e0087..2f98b58b5 100644 --- a/docs/examples/backup/standalone/backupconfiguration.yaml +++ b/docs/examples/backup/standalone/backupconfiguration.yaml @@ -6,7 +6,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo target: diff --git a/docs/examples/backup/standalone/mongodb-ssl.yaml b/docs/examples/backup/standalone/mongodb-ssl.yaml index 06e0e5b79..889094378 100644 --- a/docs/examples/backup/standalone/mongodb-ssl.yaml +++ b/docs/examples/backup/standalone/mongodb-ssl.yaml @@ -4,7 +4,7 @@ metadata: name: sample-mongodb-ssl namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable storage: storageClassName: "standard" diff --git a/docs/examples/backup/standalone/mongodb.yaml b/docs/examples/backup/standalone/mongodb.yaml index 07ebe7bd1..a77ef91c4 100644 --- a/docs/examples/backup/standalone/mongodb.yaml +++ b/docs/examples/backup/standalone/mongodb.yaml @@ -4,7 +4,7 @@ metadata: name: sample-mongodb namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable storage: storageClassName: "standard" diff --git a/docs/examples/restore/replicaset/restored-mongodb-replicaset.yaml b/docs/examples/restore/replicaset/restored-mongodb-replicaset.yaml index 0fe748f81..79293da33 100644 --- a/docs/examples/restore/replicaset/restored-mongodb-replicaset.yaml +++ b/docs/examples/restore/replicaset/restored-mongodb-replicaset.yaml @@ -4,7 +4,7 @@ metadata: name: restored-mgo-rs namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" databaseSecret: secretName: sample-mgo-rs-auth replicas: 3 diff --git a/docs/examples/restore/replicaset/restored-standalone.yaml b/docs/examples/restore/replicaset/restored-standalone.yaml index 18517e28b..68a5528cd 100644 --- a/docs/examples/restore/replicaset/restored-standalone.yaml +++ b/docs/examples/restore/replicaset/restored-standalone.yaml @@ -4,7 +4,7 @@ metadata: name: restored-mongodb namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable databaseSecret: secretName: sample-mgo-rs-auth diff --git a/docs/examples/restore/replicaset/restoresession-replicaset.yaml b/docs/examples/restore/replicaset/restoresession-replicaset.yaml index 8c84d0c2f..8b209775d 100644 --- a/docs/examples/restore/replicaset/restoresession-replicaset.yaml +++ b/docs/examples/restore/replicaset/restoresession-replicaset.yaml @@ -7,7 +7,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo-replicaset target: diff --git a/docs/examples/restore/replicaset/restoresession-standalone.yaml b/docs/examples/restore/replicaset/restoresession-standalone.yaml index e781e92bf..b0872f41c 100644 --- a/docs/examples/restore/replicaset/restoresession-standalone.yaml +++ b/docs/examples/restore/replicaset/restoresession-standalone.yaml @@ -7,7 +7,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo-custom target: diff --git a/docs/examples/restore/sharding/restored-mongodb-sharding.yaml b/docs/examples/restore/sharding/restored-mongodb-sharding.yaml index cda5b6083..6e55874a6 100644 --- a/docs/examples/restore/sharding/restored-mongodb-sharding.yaml +++ b/docs/examples/restore/sharding/restored-mongodb-sharding.yaml @@ -6,7 +6,7 @@ metadata: spec: databaseSecret: secretName: sample-mgo-sh-auth - version: 3.4-v4 + version: 3.4.17 shardTopology: configServer: replicas: 3 diff --git a/docs/examples/restore/sharding/restored-standalone.yaml b/docs/examples/restore/sharding/restored-standalone.yaml index 3e7a49777..a50071b61 100644 --- a/docs/examples/restore/sharding/restored-standalone.yaml +++ b/docs/examples/restore/sharding/restored-standalone.yaml @@ -4,7 +4,7 @@ metadata: name: restored-mongodb namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable databaseSecret: secretName: sample-mgo-sh-auth diff --git a/docs/examples/restore/sharding/restoresession-sharding.yaml b/docs/examples/restore/sharding/restoresession-sharding.yaml index 696e3e318..cd79909f9 100644 --- a/docs/examples/restore/sharding/restoresession-sharding.yaml +++ b/docs/examples/restore/sharding/restoresession-sharding.yaml @@ -7,7 +7,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo-sharding target: diff --git a/docs/examples/restore/sharding/restoresession-standalone.yaml b/docs/examples/restore/sharding/restoresession-standalone.yaml index e781e92bf..b0872f41c 100644 --- a/docs/examples/restore/sharding/restoresession-standalone.yaml +++ b/docs/examples/restore/sharding/restoresession-standalone.yaml @@ -7,7 +7,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo-custom target: diff --git a/docs/examples/restore/standalone/restored-mongodb.yaml b/docs/examples/restore/standalone/restored-mongodb.yaml index cc3351d56..46b958383 100644 --- a/docs/examples/restore/standalone/restored-mongodb.yaml +++ b/docs/examples/restore/standalone/restored-mongodb.yaml @@ -4,7 +4,7 @@ metadata: name: restored-mongodb namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable databaseSecret: secretName: sample-mongodb-auth diff --git a/docs/examples/restore/standalone/restoresession.yaml b/docs/examples/restore/standalone/restoresession.yaml index a70d28a97..34b7fe0e9 100644 --- a/docs/examples/restore/standalone/restoresession.yaml +++ b/docs/examples/restore/standalone/restoresession.yaml @@ -7,7 +7,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo target: diff --git a/docs/mongodb-replicaset.md b/docs/mongodb-replicaset.md index 3b6bf1e48..9bb6c6e33 100644 --- a/docs/mongodb-replicaset.md +++ b/docs/mongodb-replicaset.md @@ -60,7 +60,7 @@ metadata: name: sample-mgo-rs namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" replicas: 3 replicaSet: name: rs0 @@ -88,7 +88,7 @@ Let's check if the database is ready to use, ```console $ kubectl get mg -n demo sample-mgo-rs NAME VERSION STATUS AGE -sample-mgo-rs 3.4-v4 Running 1m +sample-mgo-rs 3.4.17 Running 1m ``` The database is `Running`. Verify that KubeDB has created a Secret and a Service for this database using the following commands, @@ -132,7 +132,7 @@ metadata: app.kubernetes.io/instance: sample-mgo-rs app.kubernetes.io/managed-by: kubedb.com app.kubernetes.io/name: mongodb - app.kubernetes.io/version: 3.4-v4 + app.kubernetes.io/version: 3.4.17 kubedb.com/kind: MongoDB kubedb.com/name: sample-mgo-rs name: sample-mgo-rs @@ -149,7 +149,7 @@ spec: secret: name: sample-mgo-rs-auth type: kubedb.com/mongodb - version: "3.4.22" + version: "3.4.17" ``` Stash uses the `AppBinding` crd to connect with the target database. It requires the following two fields to set in AppBinding's `Spec` section. @@ -179,7 +179,7 @@ metadata: name: sample-mgo-rs-ssl namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" replicas: 3 replicaSet: name: rs0 @@ -206,7 +206,7 @@ metadata: app.kubernetes.io/instance: sample-mgo-rs-ssl app.kubernetes.io/managed-by: kubedb.com app.kubernetes.io/name: mongodb - app.kubernetes.io/version: 3.4-v4 + app.kubernetes.io/version: 3.4.17 kubedb.com/kind: MongoDB kubedb.com/name: sample-mgo-rs-ssl name: sample-mgo-rs-ssl @@ -224,7 +224,7 @@ spec: secret: name: sample-mgo-rs-ssl-cert type: kubedb.com/mongodb - version: 3.4.22 + version: 3.4.17 ``` Here, `mongo-sh-rs-cert` contains few required certificates, and one of them is `client.pem` which is required to backup/restore ssl enabled mongodb server using stash-mongodb. @@ -358,7 +358,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo-replicaset target: @@ -445,8 +445,8 @@ Now, wait for a moment. Stash will pause the BackupConfiguration. Verify that th ```console $ kubectl get backupconfiguration -n demo sample-mgo-rs-backup -NAME TASK SCHEDULE PAUSED AGE -sample-mgo-rs-backup mongodb-backup-3.4 */5 * * * * true 26m +NAME TASK SCHEDULE PAUSED AGE +sample-mgo-rs-backup mongodb-backup-3.4.17 */5 * * * * true 26m ``` Notice the `PAUSED` column. Value `true` for this field means that the BackupConfiguration has been paused. @@ -467,7 +467,7 @@ metadata: name: restored-mgo-rs namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" databaseSecret: secretName: sample-mgo-rs-auth replicas: 3 @@ -502,7 +502,7 @@ If you check the database status, you will see it is stuck in `Initializing` sta ```console $ kubectl get mg -n demo restored-mgo-rs NAME VERSION STATUS AGE -restored-mgo-rs 3.4-v4 Initializing 2m +restored-mgo-rs 3.4.17 Initializing 2m ``` **Create RestoreSession:** @@ -533,7 +533,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo-replicaset target: @@ -584,7 +584,7 @@ At first, check if the database has gone into `Running` state by the following c ```console $ kubectl get mg -n demo restored-mgo-rs NAME VERSION STATUS AGE -restored-mgo-rs 3.4-v4 Running 3m +restored-mgo-rs 3.4.17 Running 3m ``` Now, exec into the database pod and list available tables, @@ -681,7 +681,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo-custom target: @@ -725,7 +725,7 @@ metadata: name: restored-mongodb namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable databaseSecret: secretName: sample-mgo-rs-auth @@ -754,7 +754,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo-custom target: @@ -772,14 +772,14 @@ mongodb.kubedb.com/restored-mongodb created $ kubectl get mg -n demo restored-mongodb NAME VERSION STATUS AGE -restored-mongodb 3.4-v4 Initializing 56s +restored-mongodb 3.4.17 Initializing 56s $ kubectl create -f https://github.com/stashed/mongodb/raw/{{< param "info.subproject_version" >}}/docs/examples/restore/replicaset/restoresession-standalone.yaml restoresession.stash.appscode.com/sample-mongodb-restore created $ kubectl get mg -n demo restored-mongodb NAME VERSION STATUS AGE -restored-mongodb 3.4-v4 Running 2m +restored-mongodb 3.4.17 Running 2m ``` Now, exec into the database pod and list available tables, diff --git a/docs/mongodb-sharding.md b/docs/mongodb-sharding.md index 7c5c21dc7..d8cbc7b76 100644 --- a/docs/mongodb-sharding.md +++ b/docs/mongodb-sharding.md @@ -20,7 +20,7 @@ Stash 0.9.0+ supports taking [backup](https://docs.mongodb.com/manual/tutorial/b - At first, you need to have a Kubernetes cluster, and the `kubectl` command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using Minikube. - Install Stash in your cluster following the steps [here](/docs/setup/install.md). -- Install MongoDB addon for Stash following the steps [here](/docs/addons/mongodb/setup/install.md) +- Install MongoDB addon for Stash following the steps [here](/docs/addons/mongodb/setup/install.md). - Install [KubeDB](https://kubedb.com) in your cluster following the steps [here](https://kubedb.com/docs/setup/install/). This step is optional. You can deploy your database using any method you want. We are using KubeDB because KubeDB simplifies many of the difficult or tedious management tasks of running a production grade databases on private and public clouds. - If you are not familiar with how Stash backup and restore MongoDB databases, please check the following guide [here](/docs/addons/mongodb/overview.md). @@ -60,7 +60,7 @@ metadata: name: sample-mgo-sh namespace: demo spec: - version: 3.4-v4 + version: 3.4.17 shardTopology: configServer: replicas: 3 @@ -98,7 +98,7 @@ Let's check if the database is ready to use, ```console $ kubectl get mg -n demo sample-mgo-sh NAME VERSION STATUS AGE -sample-mgo-sh 3.4-v4 Running 35m +sample-mgo-sh 3.4.17 Running 35m ``` The database is `Running`. Verify that KubeDB has created a Secret and a Service for this database using the following commands, @@ -145,7 +145,7 @@ metadata: app.kubernetes.io/instance: sample-mgo-sh app.kubernetes.io/managed-by: kubedb.com app.kubernetes.io/name: mongodb - app.kubernetes.io/version: 3.4-v4 + app.kubernetes.io/version: 3.4.17 kubedb.com/kind: MongoDB kubedb.com/name: sample-mgo-sh name: sample-mgo-sh @@ -165,7 +165,7 @@ spec: secret: name: sample-mgo-sh-auth type: kubedb.com/mongodb - version: 3.4.22 + version: 3.4.17 ``` Stash uses the `AppBinding` crd to connect with the target database. It requires the following two fields to set in AppBinding's `Spec` section. @@ -196,7 +196,7 @@ metadata: name: sample-mgo-sh-ssl namespace: demo spec: - version: 3.4-v4 + version: 3.4.17 shardTopology: configServer: replicas: 3 @@ -233,7 +233,7 @@ metadata: app.kubernetes.io/instance: sample-mgo-sh-ssl app.kubernetes.io/managed-by: kubedb.com app.kubernetes.io/name: mongodb - app.kubernetes.io/version: 3.4-v4 + app.kubernetes.io/version: 3.4.17 kubedb.com/kind: MongoDB kubedb.com/name: sample-mgo-sh-ssl name: sample-mgo-sh-ssl @@ -254,7 +254,7 @@ spec: secret: name: sample-mgo-sh-ssl-cert type: kubedb.com/mongodb - version: 3.4.22 + version: 3.4.17 ``` Here, `sample-mgo-sh-cert` contains few required certificates, and one of them is `client.pem` which is required to backup/restore ssl enabled mongodb server using stash-mongodb. @@ -384,7 +384,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo-sharding target: @@ -471,8 +471,8 @@ Now, wait for a moment. Stash will pause the BackupConfiguration. Verify that th ```console $ kubectl get backupconfiguration -n demo sample-mgo-sh-backup -NAME TASK SCHEDULE PAUSED AGE -sample-mgo-sh-backup mongodb-backup-3.4 */5 * * * * true 26m +NAME TASK SCHEDULE PAUSED AGE +sample-mgo-sh-backup mongodb-backup-3.4.17 */5 * * * * true 26m ``` Notice the `PAUSED` column. Value `true` for this field means that the BackupConfiguration has been paused. @@ -495,7 +495,7 @@ metadata: spec: databaseSecret: secretName: sample-mgo-sh-auth - version: 3.4-v4 + version: 3.4.17 shardTopology: configServer: replicas: 3 @@ -538,7 +538,7 @@ If you check the database status, you will see it is stuck in `Initializing` sta ```console $ kubectl get mg -n demo restored-mgo-sh NAME VERSION STATUS AGE -restored-mgo-sh 3.4-v4 Initializing 48m +restored-mgo-sh 3.4.17 Initializing 48m ``` **Create RestoreSession:** @@ -569,7 +569,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo-sharding target: @@ -620,7 +620,7 @@ At first, check if the database has gone into `Running` state by the following c ```console $ kubectl get mg -n demo restored-mgo-sh NAME VERSION STATUS AGE -restored-mgo-sh 3.4-v4 Running 2h +restored-mgo-sh 3.4.17 Running 2h ``` Now, find out the `mongos` pod, @@ -723,7 +723,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo-custom target: @@ -767,7 +767,7 @@ metadata: name: restored-mongodb namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable databaseSecret: secretName: sample-mgo-sh-auth @@ -796,7 +796,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo-custom target: @@ -814,14 +814,14 @@ mongodb.kubedb.com/restored-mongodb created $ kubectl get mg -n demo restored-mongodb NAME VERSION STATUS AGE -restored-mongodb 3.4-v4 Initializing 56s +restored-mongodb 3.4.17 Initializing 56s $ kubectl create -f https://github.com/stashed/mongodb/raw/{{< param "info.subproject_version" >}}/docs/examples/restore/sharding/restoresession-standalone.yaml restoresession.stash.appscode.com/sample-mongodb-restore created $ kubectl get mg -n demo restored-mongodb NAME VERSION STATUS AGE -restored-mongodb 3.4-v4 Running 56s +restored-mongodb 3.4.17 Running 56s ``` Now, exec into the database pod and list available tables, diff --git a/docs/mongodb.md b/docs/mongodb.md index eafabc876..f49514d21 100644 --- a/docs/mongodb.md +++ b/docs/mongodb.md @@ -60,7 +60,7 @@ metadata: name: sample-mongodb namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable storage: storageClassName: "standard" @@ -86,7 +86,7 @@ Let's check if the database is ready to use, ```console $ kubectl get mg -n demo sample-mongodb NAME VERSION STATUS AGE -sample-mongodb 3.4-v4 Running 2m9s +sample-mongodb 3.4.17 Running 2m9s ``` The database is `Running`. Verify that KubeDB has created a Secret and a Service for this database using the following commands, @@ -129,7 +129,7 @@ metadata: app.kubernetes.io/instance: sample-mongodb app.kubernetes.io/managed-by: kubedb.com app.kubernetes.io/name: mongodb - app.kubernetes.io/version: 3.4-v4 + app.kubernetes.io/version: 3.4.17 kubedb.com/kind: MongoDB kubedb.com/name: sample-mongodb name: sample-mongodb @@ -143,7 +143,7 @@ spec: secret: name: sample-mongodb-auth type: kubedb.com/mongodb - version: "3.4.22" + version: "3.4.17" ``` Stash uses the `AppBinding` crd to connect with the target database. It requires the following two fields to set in AppBinding's `Spec` section. @@ -172,7 +172,7 @@ metadata: name: sample-mongodb-ssl namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable storage: storageClassName: "standard" @@ -195,7 +195,7 @@ metadata: app.kubernetes.io/instance: sample-mongodb-ssl app.kubernetes.io/managed-by: kubedb.com app.kubernetes.io/name: mongodb - app.kubernetes.io/version: 3.4-v4 + app.kubernetes.io/version: 3.4.17 kubedb.com/kind: MongoDB kubedb.com/name: sample-mongodb-ssl name: sample-mongodb-ssl @@ -210,7 +210,7 @@ spec: secret: name: sample-mongodb-ssl-cert type: kubedb.com/mongodb - version: "3.4.22" + version: "3.4.17" ``` Here, `sample-mongodb-cert` contains few required certificates, and one of them is `client.pem` which is required to backup/restore ssl enabled mongodb server using stash-mongodb. @@ -359,7 +359,7 @@ metadata: spec: schedule: "*/5 * * * *" task: - name: mongodb-backup-3.4 + name: mongodb-backup-3.4.17 repository: name: gcs-repo target: @@ -446,8 +446,8 @@ Now, wait for a moment. Stash will pause the BackupConfiguration. Verify that th ```console $ kubectl get backupconfiguration -n demo sample-mongodb-backup -NAME TASK SCHEDULE PAUSED AGE -sample-mongodb-backup mongodb-backup-3.4 */5 * * * * true 26m +NAME TASK SCHEDULE PAUSED AGE +sample-mongodb-backup mongodb-backup-3.4.17 */5 * * * * true 26m ``` Notice the `PAUSED` column. Value `true` for this field means that the BackupConfiguration has been paused. @@ -468,7 +468,7 @@ metadata: name: restored-mongodb namespace: demo spec: - version: "3.4-v4" + version: "3.4.17" storageType: Durable databaseSecret: secretName: sample-mongodb-auth @@ -501,7 +501,7 @@ If you check the database status, you will see it is stuck in `Initializing` sta ```console $ kubectl get mg -n demo restored-mongodb NAME VERSION STATUS AGE -restored-mongodb 3.4-v4 Initializing 17s +restored-mongodb 3.4.17 Initializing 17s ``` **Create RestoreSession:** @@ -530,7 +530,7 @@ metadata: kubedb.com/kind: MongoDB spec: task: - name: mongodb-restore-3.4 + name: mongodb-restore-3.4.17 repository: name: gcs-repo target: @@ -581,7 +581,7 @@ At first, check if the database has gone into `Running` state by the following c ```console $ kubectl get mg -n demo restored-mongodb NAME VERSION STATUS AGE -restored-mongodb 3.4-v4 Running 105m +restored-mongodb 3.4.17 Running 105m ``` Now, find out the database pod by the following command,