v1.3.0 docs site

Signed-off-by: Steve Kriss <krisss@vmware.com>
2026-08-15 19:56:06 +00:00 · 2020-02-28 09:44:04 -07:00
parent ba7f8d2e62
commit b7f6b5170d
54 changed files with 43 additions and 26 deletions
@@ -56,10 +56,10 @@ defaults:
      gh: https://github.com/vmware-tanzu/velero/tree/master
      layout: "docs"
  - scope:
-      path: docs/v1.3.0-beta.2
+      path: docs/v1.3.0
    values:
-      version: v1.3.0-beta.2
-      gh: https://github.com/vmware-tanzu/velero/tree/v1.3.0-beta.2
+      version: v1.3.0
+      gh: https://github.com/vmware-tanzu/velero/tree/v1.3.0
      layout: "docs"
  - scope:
      path: docs/v1.2.0
@@ -157,10 +157,10 @@ collections:
  - casestudies

 versioning: true
-latest: v1.2.0
+latest: v1.3.0
 versions:
 - master
- v1.3.0-beta.2
+- v1.3.0
 - v1.2.0
 - v1.1.0
 - v1.0.0
@@ -13,8 +13,8 @@ toc:
        url: /basic-install
      - page: Customize Installation
        url: /customize-installation
-      - page: Upgrade to 1.2
-        url: /upgrade-to-1.2
+      - page: Upgrade to 1.3
+        url: /upgrade-to-1.3
      - page: Supported providers
        url: /supported-providers
      - page: Evaluation install 
@@ -3,7 +3,7 @@
 # that the navigation for older versions still work.

 master: master-toc
-v1.3.0-beta.2: v1-3-0-beta-2-toc
+v1.3.0: v1-3-0-toc
 v1.2.0: v1-2-0-toc
 v1.1.0: v1-1-0-toc
 v1.0.0: v1-0-0-toc
@@ -13,8 +13,8 @@ toc:
        url: /basic-install
      - page: Customize Installation
        url: /customize-installation
-      - page: Upgrade to 1.2
-        url: /upgrade-to-1.2
+      - page: Upgrade to 1.3
+        url: /upgrade-to-1.3
      - page: Supported providers
        url: /supported-providers
      - page: Evaluation install 
@@ -39,6 +39,8 @@ toc:
        url: /namespace
      - page: Extend with hooks
        url: /hooks
+      - page: CSI Support (beta)
+        url: /csi
  - title: Plugins
    subfolderitems:
      - page: Overview
@@ -27,7 +27,7 @@ If you encounter issues, review the [troubleshooting docs][30], [file an issue][

 ## Contributing

-If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing](https://velero.io/docs/v1.3.0-beta.2/start-contributing/) documentation for guidance on how to setup Velero for development.
+If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing](https://velero.io/docs/v1.3.0/start-contributing/) documentation for guidance on how to setup Velero for development.

 ## Changelog

@@ -52,7 +52,7 @@ Example:

 We use a package to generate mocks for our interfaces.

-Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/v1.3.0-beta.2/pkg/restic/mocks/restorer.go
+Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/v1.3.0/pkg/restic/mocks/restorer.go

 Run:

@@ -241,5 +241,5 @@ After creating the Velero server in your cluster, try this example:

 ## Additional Reading 

-* [Official Velero Documentation](https://velero.io/docs/v1.3.0-beta.2/)
+* [Official Velero Documentation](https://velero.io/docs/v1.3.0/)
 * [Oracle Cloud Infrastructure Documentation](https://docs.cloud.oracle.com/)
@@ -0,0 +1,15 @@
+# Container Storage Interface Snapshot Support in Velero
+
+_This feature is under development. Documentation may not be up-to-date and features may not work as expected._
+
+Velero supports taking Container Storage Interface (CSI) snapshots as a beta feature on clusters that meet the following prerequisites.
+
+ 1. The cluster is Kubernetes version 1.17 or greater.
+ 1. The cluster is running a CSI driver capable of support volume snapshots at the [v1beta1 API level](https://kubernetes.io/blog/2019/12/09/kubernetes-1-17-feature-cis-volume-snapshot-beta/).
+ 1. The Velero server is running with the `--features EnableCSI` feature flag to enable CSI logic in Velero's core.
+ 1. The Velero [CSI plugin](https://github.com/vmware-tanzu/velero-plugin-for-csi/) is installed to integrate with the CSI volume snapshot APIs.
+
+# Roadmap
+
+Velero's support level for CSI volume snapshotting will follow upstream Kubernetes support for it, and will reach general availability sometime
+after volume snapshotting is GA in upstream Kubernetes. Beta support is expected to launch in Velero v1.4.
@@ -87,5 +87,5 @@ Once parsed into a `[]string`, the features can then be registered using the `Ne
 Velero adds the `LD_LIBRARY_PATH` into the list of environment variables to provide the convenience for plugins that requires C libraries/extensions in the runtime.

 [1]: https://github.com/vmware-tanzu/velero-plugin-example
-[2]: https://github.com/vmware-tanzu/velero/blob/v1.3.0-beta.2/pkg/plugin/logger.go
-[3]: https://github.com/vmware-tanzu/velero/blob/v1.3.0-beta.2/pkg/restore/restic_restore_action.go
+[2]: https://github.com/vmware-tanzu/velero/blob/v1.3.0/pkg/plugin/logger.go
+[3]: https://github.com/vmware-tanzu/velero/blob/v1.3.0/pkg/restore/restic_restore_action.go
@@ -22,7 +22,7 @@ Examples of cases where Velero is useful:

 Yes, with some exceptions. For example, when Velero restores pods it deletes the `nodeName` from the
 pod so that it can be scheduled onto a new node. You can see some more examples of the differences
-in [pod_action.go](https://github.com/vmware-tanzu/velero/blob/v1.3.0-beta.2/pkg/restore/pod_action.go)
+in [pod_action.go](https://github.com/vmware-tanzu/velero/blob/v1.3.0/pkg/restore/pod_action.go)

 ## I'm using Velero in multiple clusters. Should I use the same bucket to store all of my backups?

@@ -77,5 +77,5 @@ velero backup logs nginx-hook-test | grep hookCommand


 [1]: api-types/backup.md
-[2]: https://github.com/vmware-tanzu/velero/blob/v1.3.0-beta.2/examples/nginx-app/with-pv.yaml
+[2]: https://github.com/vmware-tanzu/velero/blob/v1.3.0/examples/nginx-app/with-pv.yaml
 [3]: cloud-common.md
@@ -22,7 +22,7 @@ rootBucket/
  "metadata": {
    "name": "test-backup",
    "namespace": "velero",
-    "selfLink": "/apis/velero.io/v1/namespaces/velero/backups/testtest",
+    "selfLink": "/apis/velero.io/v1/namespaces/velero/backups/test-backup",
    "uid": "a12345cb-75f5-11e7-b4c2-abcdef123456",
    "resourceVersion": "337075",
    "creationTimestamp": "2017-07-31T13:39:15Z"
@@ -17,5 +17,5 @@ Please browse our list of resources, including a playlist of past online communi

 If you are ready to jump in and test, add code, or help with documentation, please use the navigation on the left under `Contribute`.

-[1]: https://github.com/vmware-tanzu/velero/blob/v1.3.0-beta.2/CODE_OF_CONDUCT.md
-[2]: https://github.com/vmware-tanzu/velero/blob/v1.3.0-beta.2/CONTRIBUTING.md
+[1]: https://github.com/vmware-tanzu/velero/blob/v1.3.0/CODE_OF_CONDUCT.md
+[2]: https://github.com/vmware-tanzu/velero/blob/v1.3.0/CONTRIBUTING.md
@@ -23,7 +23,7 @@ If you're not yet running Velero v1.2, see the following:

    ```bash
    Client:
-        Version: v1.3.0-beta.2
+        Version: v1.3.0
        Git commit: <git SHA>
    ```

@@ -31,12 +31,12 @@ If you're not yet running Velero v1.2, see the following:

    ```bash
    kubectl set image deployment/velero \
-        velero=velero/velero:v1.3.0-beta.2 \
+        velero=velero/velero:v1.3.0 \
        --namespace velero

    # optional, if using the restic daemon set
    kubectl set image daemonset/restic \
-        restic=velero/velero:v1.3.0-beta.2 \
+        restic=velero/velero:v1.3.0 \
        --namespace velero
    ```

@@ -50,11 +50,11 @@ If you're not yet running Velero v1.2, see the following:

    ```bash
    Client:
-        Version: v1.3.0-beta.2
+        Version: v1.3.0
        Git commit: <git SHA>

    Server:
-        Version: v1.3.0-beta.2
+        Version: v1.3.0
    ```

 [0]: basic-install.md#install-the-cli
@@ -18,7 +18,7 @@ Alternatively, for quickly loading the website, under the `velero/site/` directo
 bundle exec jekyll serve --livereload --future
 ```

-For more information on how to run the website locally, please see our [jekyll documentation](https://github.com/vmware-tanzu/velero/blob/v1.3.0-beta.2/site/README-JEKYLL.md).
+For more information on how to run the website locally, please see our [jekyll documentation](https://github.com/vmware-tanzu/velero/blob/v1.3.0/site/README-JEKYLL.md).

 ## Adding a blog post