Update docs (Minio, Rook, NFS) (#625)

Tasks:
- [x] Move Minio doc under platforms
- [x] Move Rook doc under platforms
- [x] Use NFS volume instead of `hostPath`

api/crds/recovery.yaml

@@ -9,10 +9,10 @@ metadata:
 spec:
   additionalPrinterColumns:
   - JSONPath: .spec.repository.namespace
-    name: RepositoryNamespace
+    name: Repository-Namespace
     type: string
   - JSONPath: .spec.repository.name
-    name: RepositoryName
+    name: Repository-Name
     type: string
   - JSONPath: .spec.snapshot
     name: Snapshot

api/crds/repository.yaml

@@ -9,11 +9,11 @@ metadata:
 spec:
   additionalPrinterColumns:
   - JSONPath: .status.backupCount
-    name: BackupCount
+    name: Backup-Count
     type: integer
   - JSONPath: .status.lastBackupTime
     format: date-time
-    name: LastSuccessfulBackup
+    name: Last-Successful-Backup
     type: date
   - JSONPath: .metadata.creationTimestamp
     name: Age

api/crds/restic.yaml

@@ -15,7 +15,7 @@ spec:
     name: Schedule
     type: string
   - JSONPath: .spec.type
-    name: BackupType
+    name: Backup-Type
     priority: 10
     type: string
   - JSONPath: .spec.paused

apis/stash/v1alpha1/crd.go

@@ -44,7 +44,7 @@ func (c Restic) CustomResourceDefinition() *apiextensions.CustomResourceDefiniti
 				JSONPath: ".spec.schedule",
 			},
 			{
-				Name:     "BackupType",
+				Name:     "Backup-Type",
 				Type:     "string",
 				JSONPath: ".spec.type",
 				Priority: 10,
@@ -88,12 +88,12 @@ func (c Recovery) CustomResourceDefinition() *apiextensions.CustomResourceDefini
 		EnableStatusSubresource: EnableStatusSubresource,
 		AdditionalPrinterColumns: []apiextensions.CustomResourceColumnDefinition{
 			{
-				Name:     "RepositoryNamespace",
+				Name:     "Repository-Namespace",
 				Type:     "string",
 				JSONPath: ".spec.repository.namespace",
 			},
 			{
-				Name:     "RepositoryName",
+				Name:     "Repository-Name",
 				Type:     "string",
 				JSONPath: ".spec.repository.name",
 			},
@@ -141,12 +141,12 @@ func (c Repository) CustomResourceDefinition() *apiextensions.CustomResourceDefi
 		EnableStatusSubresource: EnableStatusSubresource,
 		AdditionalPrinterColumns: []apiextensions.CustomResourceColumnDefinition{
 			{
-				Name:     "BackupCount",
+				Name:     "Backup-Count",
 				Type:     "integer",
 				JSONPath: ".status.backupCount",
 			},
 			{
-				Name:     "LastSuccessfulBackup",
+				Name:     "Last-Successful-Backup",
 				Type:     "date",
 				JSONPath: ".status.lastBackupTime",
 				Format:   "date-time",

docs/concepts/crds/recovery.md

@@ -85,6 +85,6 @@ Stash operator updates `.status` of a Recovery CRD when the recovery operation i
 - To run backup in offline mode see [here](/docs/guides/offline_backup.md)
 - See the list of supported backends and how to configure them [here](/docs/guides/backends/overview.md).
 - See working examples for supported workload types [here](/docs/guides/workloads.md).
-- Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
+- Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring/overview.md).
 - Learn about how to configure [RBAC roles](/docs/guides/rbac.md).
 - Want to hack on Stash? Check our [contribution guidelines](/docs/CONTRIBUTING.md).

docs/concepts/crds/repository.md

@@ -123,7 +123,7 @@ $ kubectl get repository -l node-name=minikube
 
 ## Deleting Repository
 
-Stash allows the users to delete **only `Repository` crd** or **`Repository` crd with respective restic repository**. Here, we will show how to perform these delete operations.
+Stash allows the users to delete **only `Repository` crd** or **`Repository` crd with respective restic repository**. Here, we are going to show how to perform these delete operations.
 
 ### Delete only Repository crd
 
@@ -215,6 +215,6 @@ If everything goes well, respective restic repository will be deleted from the b
 - To run backup in offline mode see [here](/docs/guides/offline_backup.md)
 - See the list of supported backends and how to configure them [here](/docs/guides/backends/overview.md).
 - See working examples for supported workload types [here](/docs/guides/workloads.md).
-- Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
+- Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring/overview.md).
 - Learn about how to configure [RBAC roles](/docs/guides/rbac.md).
 - Want to hack on Stash? Check our [contribution guidelines](/docs/CONTRIBUTING.md).

docs/concepts/crds/restic.md

@@ -156,6 +156,6 @@ For more details about how to disable and resume Restic see [here](/docs/guides/
 - To run backup in offline mode see [here](/docs/guides/offline_backup.md)
 - See the list of supported backends and how to configure them [here](/docs/guides/backends/overview.md).
 - See working examples for supported workload types [here](/docs/guides/workloads.md).
-- Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
+- Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring/overview.md).
 - Learn about how to configure [RBAC roles](/docs/guides/rbac.md).
 - Want to hack on Stash? Check our [contribution guidelines](/docs/CONTRIBUTING.md).

docs/concepts/crds/snapshot.md

@@ -172,6 +172,6 @@ snapshot "statefulset.stash-demo-0-d690726d" deleted
 - To run backup in offline mode see [here](/docs/guides/offline_backup.md)
 - See the list of supported backends and how to configure them [here](/docs/guides/backends/overview.md).
 - See working examples for supported workload types [here](/docs/guides/workloads.md).
-- Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
+- Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring/overview.md).
 - Learn about how to configure [RBAC roles](/docs/guides/rbac.md).
 - Want to hack on Stash? Check our [contribution guidelines](/docs/CONTRIBUTING.md).

docs/examples/backends/local/local-restic-nfs.yaml

@@ -0,0 +1,27 @@
+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

docs/examples/tutorial/busybox.yaml → docs/examples/backup/deployment.yaml

@@ -1,20 +1,23 @@
-apiVersion: apps/v1beta1
+apiVersion: apps/v1
 kind: Deployment
 metadata:
   labels:
     app: stash-demo
   name: stash-demo
-  namespace: default
+  namespace: demo
 spec:
   replicas: 1
+  selector:
+    matchLabels:
+      app: stash-demo
   template:
     metadata:
       labels:
         app: stash-demo
       name: busybox
     spec:
       containers:
-      - command:
+      - args:
         - sleep
         - "3600"
         image: busybox
@@ -25,6 +28,6 @@ spec:
           name: source-data
       restartPolicy: Always
       volumes:
-      - gitRepo:
-          repository: https://github.com/appscode/stash-data.git
-        name: source-data
+      - name: source-data
+        configMap:
+          name: stash-sample-data

docs/examples/tutorial/restic.yaml → docs/examples/backup/restic.yaml

@@ -1,8 +1,8 @@
 apiVersion: stash.appscode.com/v1alpha1
 kind: Restic
 metadata:
-  name: stash-demo
-  namespace: default
+  name: local-restic
+  namespace: demo
 spec:
   selector:
     matchLabels:
@@ -13,9 +13,10 @@ spec:
   backend:
     local:
       mountPath: /safe/data
-      hostPath:
-        path: /data/stash-test/restic-repo
-    storageSecretName: stash-demo
+      nfs:
+        server: "nfs-service.storage.svc.cluster.local"
+        path: "/"
+    storageSecretName: local-secret
   schedule: '@every 1m'
   volumeMounts:
   - mountPath: /source/data

docs/examples/tutorial/restic_offline.yaml → docs/examples/backup/restic_offline.yaml

@@ -1,8 +1,8 @@
 apiVersion: stash.appscode.com/v1alpha1
 kind: Restic
 metadata:
-  name: stash-demo
-  namespace: default
+  name: offline-restic
+  namespace: demo
 spec:
   selector:
     matchLabels:
@@ -14,9 +14,10 @@ spec:
   backend:
     local:
       mountPath: /safe/data
-      hostPath:
-        path: /data/stash-test/restic-repo
-    storageSecretName: stash-demo
+      nfs:
+        server: "nfs-service.storage.svc.cluster.local"
+        path: "/"
+    storageSecretName: local-secret
   schedule: '@every 5m'
   volumeMounts:
   - mountPath: /source/data