Skip to content

Commit

Permalink
Update docs to state Kubernetes v1.11 is needed
Browse files Browse the repository at this point in the history
Closes: vmware-tanzu#2856

Signed-off-by: Nolan Brubaker <[email protected]>
  • Loading branch information
nrb committed May 11, 2021
1 parent 4d173d7 commit 656a04b
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 4 deletions.
10 changes: 9 additions & 1 deletion site/content/docs/main/basic-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ layout: docs
Use this doc to get a basic installation of Velero.
Refer [this document](customize-installation.md) to customize your installation.


## Prerequisites

- Access to a Kubernetes cluster, v1.10 or later, with DNS and container networking enabled.
- Access to a Kubernetes cluster, v1.11 or later, with DNS and container networking enabled.
- `kubectl` installed locally

Velero uses object storage to store backups and associated artifacts. It also optionally integrates with supported block storage systems to snapshot your persistent volumes. Before beginning the installation process, you should identify the object storage provider and optional block storage provider(s) you'll be using from the list of [compatible providers][0].
Expand All @@ -21,8 +22,10 @@ Velero does not officially support Windows. In testing, the Velero team was able

If you want to perform your own testing of Velero on Windows, you must deploy Velero as a Windows container. Velero does not provide official Windows images, but its possible for you to build your own Velero Windows container image to use. Note that you must build this image on a Windows node.


## Install the CLI


### Option 1: macOS - Homebrew

On macOS, you can use [Homebrew](https://brew.sh) to install the `velero` client:
Expand Down Expand Up @@ -50,6 +53,7 @@ On Windows, you can use [Chocolatey](https://chocolatey.org/install) to install
choco install velero
```


## Install and configure the server components

There are two supported methods for installing the Velero server components:
Expand All @@ -61,6 +65,8 @@ Velero uses storage provider plugins to integrate with a variety of storage syst

_Note: if your object storage provider is different than your volume snapshot provider, follow the installation instructions for your object storage provider first, then return here and follow the instructions to [add your volume snapshot provider][4]._



## Command line Autocompletion

Please refer to [this part of the documentation][5].
Expand All @@ -71,3 +77,5 @@ Please refer to [this part of the documentation][5].
[3]: overview-plugins.md
[4]: customize-installation.md#install-an-additional-volume-snapshot-provider
[5]: customize-installation.md#optional-velero-cli-configurations


2 changes: 1 addition & 1 deletion site/content/docs/main/contributions/tencent-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can deploy Velero on Tencent [TKE](https://cloud.tencent.com/document/produc

- Registered [Tencent Cloud Account](https://cloud.tencent.com/register).
- [Tencent Cloud COS](https://console.cloud.tencent.com/cos) service, referred to as COS, has been launched
- A Kubernetes cluster has been created, cluster version v1.10 or later, and the cluster can use DNS and Internet services normally. If you need to create a TKE cluster, refer to the Tencent [create a cluster](https://cloud.tencent.com/document/product/457/32189) documentation.
- A Kubernetes cluster has been created, cluster version v1.11 or later, and the cluster can use DNS and Internet services normally. If you need to create a TKE cluster, refer to the Tencent [create a cluster](https://cloud.tencent.com/document/product/457/32189) documentation.

## Create a Tencent Cloud COS bucket

Expand Down
3 changes: 2 additions & 1 deletion site/content/docs/main/restic.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cross-volume-type data migrations.

- Understand how Velero performs [backups with the restic integration](#how-backup-and-restore-work-with-restic).
- [Download][3] the latest Velero release.
- Kubernetes v1.10.0 and later. Velero's restic integration requires the Kubernetes [MountPropagation feature][6], which is enabled by default in Kubernetes v1.10.0 and later.
- Kubernetes v1.11.0 and later. Velero's restic integration requires the Kubernetes [MountPropagation feature][6], which is enabled by default in Kubernetes v1.11.0 and later.

### Install restic

Expand Down Expand Up @@ -526,3 +526,4 @@ To solve this, a controller was written by Thomann Bits&Beats: [velero-pvc-watch
[8]: https://docs.microsoft.com/en-us/azure/aks/azure-files-dynamic-pv
[9]: https://github.com/restic/restic/issues/1800
[11]: customize-installation.md#default-pod-volume-backup-to-restic

2 changes: 1 addition & 1 deletion site/content/docs/main/tilt.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ files in this directory are gitignored so you may configure your setup according

## Prerequisites
1. [Docker](https://docs.docker.com/install/) v19.03 or newer
1. A Kubernetes cluster v1.10 or greater (does not have to be Kind)
1. A Kubernetes cluster v1.11 or greater (does not have to be Kind)
1. [Tilt](https://docs.tilt.dev/install.html) v0.12.0 or newer
1. Clone the [Velero project](https://github.com/vmware-tanzu/velero) repository
locally
Expand Down

0 comments on commit 656a04b

Please sign in to comment.