Reorg install and plugin docs (#1916)

* Reorg plugin docs Signed-off-by: Carlisia <[email protected]> * Improve install docs Signed-off-by: Carlisia <[email protected]> * Change path Signed-off-by: Carlisia <[email protected]> * Fix broken links Signed-off-by: Carlisia <[email protected]> * Address more feedback Signed-off-by: Carlisia <[email protected]> * One more fix Signed-off-by: Carlisia <[email protected]> * Minor changes to address feedback Signed-off-by: Carlisia <[email protected]> * More fixes Signed-off-by: Carlisia <[email protected]>
vmware-tanzu · Oct 2, 2019 · aa9ca9a · aa9ca9a
1 parent 81a4fcb
commit aa9ca9a
Show file tree

Hide file tree

Showing 19 changed files with 255 additions and 273 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 ## Overview
 
-Velero (formerly Heptio Ark) gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. Velero lets you:
+Velero (formerly Heptio Ark) gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. You can run Velero with a cloud provider or on-premises. Velero lets you:
 
 * Take backups of your cluster and restore in case of loss.
 * Migrate cluster resources to other clusters.
@@ -15,16 +15,7 @@ Velero consists of:
 * A server that runs on your cluster
 * A command-line client that runs locally
 
-You can run Velero in clusters on a cloud provider or on-premises. For detailed information, see [Compatible Storage Providers][99].
-
-## Installation
-
-We strongly recommend that you use an [official release][6] of Velero. The tarballs for each release contain the
-`velero` command-line client. Follow the [installation instructions][28] to get started.
-
-_The code and sample YAML files in the master branch of the Velero repository are under active development and are not guaranteed to be stable. Use them at your own risk!_
-
-## More information
+## Documentation
 
 [The documentation][29] provides a getting started guide, plus information about building from source, architecture, extending Velero, and more.
 
@@ -56,5 +47,4 @@ See [the list of releases][6] to find out about feature changes.
 [28]: https://velero.io/docs/install-overview
 [29]: https://velero.io/docs/
 [30]: https://velero.io/docs/troubleshooting
-[99]: https://velero.io/docs/support-matrix
-[100]: /site/docs/master/img/velero.png
+[100]: https://velero.io/docs/master/img/velero.png
diff --git a/examples/README.md b/examples/README.md
@@ -7,5 +7,5 @@ This directory contains sample YAML config files that can be used for exploring
 * `nginx-app/`: A sample nginx app that can be used to test backups and restores.
 
 
-[0]: /docs/get-started.md
+[0]: /docs/contributions/minio.md
 [1]: https://github.com/minio/minio
diff --git a/site/_data/master-toc.yml b/site/_data/master-toc.yml
@@ -4,27 +4,27 @@ toc:
       - page: About Velero
         url: /index.html
       - page: How Velero works
-        url: /about
+        url: /how-velero-works
       - page: About locations
         url: /locations
-      - page: Supported platforms
-        url: /support-matrix
   - title: Install
     subfolderitems:
       - page: Overview
         url: /install-overview
       - page: Upgrade to 1.1
         url: /upgrade-to-1.1
-      - page: Quick start with in-cluster MinIO
-        url: /get-started
-      - page: Run on AWS
-        url: /aws-config
-      - page: Run on Azure
-        url: /azure-config
-      - page: Run on GCP
-        url: /gcp-config
-      - page: Restic setup
+      - page: Requirements
+        url: /install-requirements
+      - page: Supported providers
+        url: /supported-providers
+      - page: Evaluation install 
+        url: /contributions/minio
+      - page: Restic integration
         url: /restic
+      - page: Examples
+        url: /examples
+      - page: Uninstalling
+        url: /uninstalling
   - title: Use
     subfolderitems:
       - page: Disaster recovery
@@ -37,10 +37,14 @@ toc:
         url: /restore-reference
       - page: Run in any namespace
         url: /namespace
-      - page: Extend with plugins
-        url: /plugins
       - page: Extend with hooks
         url: /hooks
+  - title: Plugins
+    subfolderitems:
+      - page: Overview
+        url: /overview-plugins
+      - page: Custom plugins
+        url: /custom-plugins
   - title: Troubleshoot
     subfolderitems:
       - page: Troubleshooting

diff --git a/site/_posts/2019-10-01-announcing-gh-move.md b/site/_posts/2019-10-01-announcing-gh-move.md
@@ -40,6 +40,6 @@ As always, we welcome feedback and participation in the development of Velero. A
 
 [1]: https://github.com/vmware-tanzu
 [2]: https://blogs.vmware.com/cloudnative/2019/10/01/open-source-in-vmware-tanzu/
-[3]: ../docs/master/support-matrix
+[3]: ../docs/master/supported-providers
 [4]: https://velero.io/docs/master/
 [5]: https://github.com/vmware-tanzu/velero/issues#workspaces/velero-5c59c15e39d47b774b5864e3/board?milestones=v1.2%232019-10-31&filterLogic=any&repos=99143276&showPipelineDescriptions=false
diff --git a/site/docs/master/README.md b/site/docs/master/README.md
@@ -4,7 +4,7 @@
 
 ## Overview
 
-Velero (formerly Heptio Ark) gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. Velero lets you:
+Velero (formerly Heptio Ark) gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. You can run Velero with a cloud provider or on-premises. Velero lets you:
 
 * Take backups of your cluster and restore in case of loss.
 * Migrate cluster resources to other clusters.
@@ -15,16 +15,7 @@ Velero consists of:
 * A server that runs on your cluster
 * A command-line client that runs locally
 
-You can run Velero in clusters on a cloud provider or on-premises. For detailed information, see [Compatible Storage Providers][99].
-
-## Installation
-
-We strongly recommend that you use an [official release][6] of Velero. The tarballs for each release contain the
-`velero` command-line client. Follow the [installation instructions][28] to get started.
-
-_The code and sample YAML files in the master branch of the Velero repository are under active development and are not guaranteed to be stable. Use them at your own risk!_
-
-## More information
+## Documentation
 
 [The documentation][29] provides a getting started guide, plus information about building from source, architecture, extending Velero, and more.
 
@@ -53,13 +44,11 @@ See [the list of releases][6] to find out about feature changes.
 [11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
 [12]: https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md
 [14]: https://github.com/kubernetes/kubernetes
-
 [24]: https://groups.google.com/forum/#!forum/projectvelero
 [25]: https://kubernetes.slack.com/messages/velero
 
 [28]: install-overview.md
 [29]: https://velero.io/docs/master/
 [30]: troubleshooting.md
 
-[99]: support-matrix.md
 [100]: img/velero.png
diff --git a/site/docs/master/ibm-config.md → site/docs/master/contributions/ibm-config.md b/site/docs/master/ibm-config.md → site/docs/master/contributions/ibm-config.md
diff --git a/site/docs/master/get-started.md → site/docs/master/contributions/minio.md b/site/docs/master/get-started.md → site/docs/master/contributions/minio.md
@@ -1,9 +1,9 @@
-## Getting started
+## Quick start evaluation install with Minio
 
 The following example sets up the Velero server and client, then backs up and restores a sample application.
 
 For simplicity, the example uses Minio, an S3-compatible storage service that runs locally on your cluster.
-For additional functionality with this setup, see the docs on how to [expose Minio outside your cluster][31].
+For additional functionality with this setup, see the section below on how to [expose Minio outside your cluster][1].
 
 **NOTE** The example lets you explore basic Velero functionality. Configuring Minio for production is out of scope.
 
@@ -202,8 +202,6 @@ When you run commands to get logs or describe a backup, the Velero server genera
 
 You can also specify a `publicUrl` config field for the pre-signed URL in your backup storage location config.
 
-For basic instructions on how to install the Velero server and client, see [the getting started example][1].
-
 ### Expose Minio with Service of type NodePort
 
 The Minio deployment by default specifies a Service of type `ClusterIP`. You can change this to `NodePort` to easily expose a cluster service externally if you can reach the node from your Velero client.
@@ -260,11 +258,9 @@ In this case:
 
 1.  Edit your `BackupStorageLocation` YAML, adding `publicUrl: <URL_AND_PORT_OF_INGRESS>` as a field under `spec.config`.
 
-
-[1]: get-started.md
-[3]: install-overview.md
-[17]: restic.md
-[18]: debugging-restores.md
+[1]: #expose-minio-with-service-of-type-nodeport
+[3]: ../install-overview.md
+[17]: ../restic.md
+[18]: ../debugging-restores.md
 [26]: https://github.com/vmware-tanzu/velero/releases
 [30]: https://godoc.org/github.com/robfig/cron
-[31]: #expose-minio-outside-your-cluster
diff --git a/site/docs/master/oracle-config.md → ...ocs/master/contributions/oracle-config.md b/site/docs/master/oracle-config.md → ...ocs/master/contributions/oracle-config.md
diff --git a/site/docs/master/examples.md b/site/docs/master/examples.md
@@ -0,0 +1,63 @@
+## Examples
+
+After you set up the Velero server, try these examples:
+
+### Basic example (without PersistentVolumes)
+
+1. Start the sample nginx app:
+
+    ```bash
+    kubectl apply -f examples/nginx-app/base.yaml
+    ```
+
+1. Create a backup:
+
+    ```bash
+    velero backup create nginx-backup --include-namespaces nginx-example
+    ```
+
+1. Simulate a disaster:
+
+    ```bash
+    kubectl delete namespaces nginx-example
+    ```
+
+    Wait for the namespace to be deleted.
+
+1. Restore your lost resources:
+
+    ```bash
+    velero restore create --from-backup nginx-backup
+    ```
+
+### Snapshot example (with PersistentVolumes)
+
+> NOTE: For Azure, you must run Kubernetes version 1.7.2 or later to support PV snapshotting of managed disks.
+
+1. Start the sample nginx app:
+
+    ```bash
+    kubectl apply -f examples/nginx-app/with-pv.yaml
+    ```
+
+1. Create a backup with PV snapshotting:
+
+    ```bash
+    velero backup create nginx-backup --include-namespaces nginx-example
+    ```
+
+1. Simulate a disaster:
+
+    ```bash
+    kubectl delete namespaces nginx-example
+    ```
+
+    Because the default [reclaim policy][1] for dynamically-provisioned PVs is "Delete", these commands should trigger your cloud provider to delete the disk that backs the PV. Deletion is asynchronous, so this may take some time. **Before continuing to the next step, check your cloud provider to confirm that the disk no longer exists.**
+
+1. Restore your lost resources:
+
+    ```bash
+    velero restore create --from-backup nginx-backup
+    ```
+
+[1]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming
diff --git a/site/docs/master/about.md → site/docs/master/how-velero-works.md b/site/docs/master/about.md → site/docs/master/how-velero-works.md