From 4e0b0c87bb552b4c2c8b84458bd42edb2eee44b9 Mon Sep 17 00:00:00 2001 From: Steve Kriss Date: Fri, 22 Feb 2019 12:18:17 -0700 Subject: [PATCH] add more documentation about using official releases Signed-off-by: Steve Kriss --- README.md | 11 ++++++++++- docs/aws-config.md | 17 +++++++++++++++++ docs/azure-config.md | 17 +++++++++++++++++ docs/gcp-config.md | 16 ++++++++++++++++ docs/get-started.md | 10 +++++++--- docs/ibm-config.md | 16 ++++++++++++++++ 6 files changed, 83 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 999f5b0fe..10b282824 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,19 @@ Velero consists of: 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 +command-line client **and** version-specific sample YAML files for deploying Velero to your cluster. +Follow the instructions under the **Install** section of [our documentation][29] 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 -[The documentation][29] provides a getting started guide, plus information about building from source, architecture, extending Velero, and more. +[The documentation][29] provides a getting started guide, plus information about building from source, architecture, extending Velero, and more. + +Please use the version selector at the top of the site to ensure you are using the appropriate documentation for your version of Velero. ## Troubleshooting diff --git a/docs/aws-config.md b/docs/aws-config.md index ca4e44770..bcb74a64a 100644 --- a/docs/aws-config.md +++ b/docs/aws-config.md @@ -2,6 +2,7 @@ To set up Velero on AWS, you: +* Download an official release of Velero * Create your S3 bucket * Create an AWS IAM user for Velero * Configure the server @@ -9,6 +10,22 @@ To set up Velero on AWS, you: If you do not have the `aws` CLI locally installed, follow the [user guide][5] to set it up. +## Download Velero + +1. Download the [latest release's](https://github.com/heptio/velero/releases) tarball for your client platform. + +1. Extract the tarball: + ```bash + tar -xvf .tar.gz -C /dir/to/extract/to + ``` + We'll refer to the directory you extracted to as the "Velero directory" in subsequent steps. + +1. Move the `velero` binary from the Velero directory to somewhere in your PATH. + +_We strongly recommend that you use an [official release](https://github.com/heptio/velero/releases) of Velero. The tarballs for each release contain the +`velero` command-line client **and** version-specific sample YAML files for deploying Velero to your cluster. 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!_ + ## Create S3 bucket Velero requires an object storage bucket to store backups in, preferrably unique to a single Kubernetes cluster (see the [FAQ][20] for more details). Create an S3 bucket, replacing placeholders appropriately: diff --git a/docs/azure-config.md b/docs/azure-config.md index 2e5bfbbb2..38c2edbf6 100644 --- a/docs/azure-config.md +++ b/docs/azure-config.md @@ -2,6 +2,7 @@ To configure Velero on Azure, you: +* Download an official release of Velero * Create your Azure storage account and blob container * Create Azure service principal for Velero * Configure the server @@ -20,6 +21,22 @@ az login Ensure that the VMs for your agent pool allow Managed Disks. If I/O performance is critical, consider using Premium Managed Disks, which are SSD backed. +## Download Velero + +1. Download the [latest release's](https://github.com/heptio/velero/releases) tarball for your client platform. + +1. Extract the tarball: + ```bash + tar -xvf .tar.gz -C /dir/to/extract/to + ``` + We'll refer to the directory you extracted to as the "Velero directory" in subsequent steps. + +1. Move the `velero` binary from the Velero directory to somewhere in your PATH. + +_We strongly recommend that you use an [official release](https://github.com/heptio/velero/releases) of Velero. The tarballs for each release contain the +`velero` command-line client **and** version-specific sample YAML files for deploying Velero to your cluster. 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!_ + ## Create Azure storage account and blob container Velero requires a storage account and blob container in which to store backups. diff --git a/docs/gcp-config.md b/docs/gcp-config.md index 8e357742d..79b6220a5 100644 --- a/docs/gcp-config.md +++ b/docs/gcp-config.md @@ -7,6 +7,22 @@ You can run Kubernetes on Google Cloud Platform in either: If you do not have the `gcloud` and `gsutil` CLIs locally installed, follow the [user guide][16] to set them up. +## Download Velero + +1. Download the [latest release's](https://github.com/heptio/velero/releases) tarball for your client platform. + +1. Extract the tarball: + ```bash + tar -xvf .tar.gz -C /dir/to/extract/to + ``` + We'll refer to the directory you extracted to as the "Velero directory" in subsequent steps. + +1. Move the `velero` binary from the Velero directory to somewhere in your PATH. + +_We strongly recommend that you use an [official release](https://github.com/heptio/velero/releases) of Velero. The tarballs for each release contain the +`velero` command-line client **and** version-specific sample YAML files for deploying Velero to your cluster. 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!_ + ## Create GCS bucket Velero requires an object storage bucket in which to store backups, preferably unique to a single Kubernetes cluster (see the [FAQ][20] for more details). Create a GCS bucket, replacing the placeholder with the name of your bucket: diff --git a/docs/get-started.md b/docs/get-started.md index d910a374c..e43d1eb10 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -17,18 +17,22 @@ If you encounter issues with installing or configuring, see [Debugging Installat * A DNS server on the cluster * `kubectl` installed -### Download +## Download Velero -1. Download the [latest release's][26] tarball for your platform. +1. Download the [latest release's](https://github.com/heptio/velero/releases) tarball for your client platform. 1. Extract the tarball: ```bash - tar -xzf .tar.gz -C /dir/to/extract/to + tar -xvf .tar.gz -C /dir/to/extract/to ``` We'll refer to the directory you extracted to as the "Velero directory" in subsequent steps. 1. Move the `velero` binary from the Velero directory to somewhere in your PATH. +_We strongly recommend that you use an [official release](https://github.com/heptio/velero/releases) of Velero. The tarballs for each release contain the +`velero` command-line client **and** version-specific sample YAML files for deploying Velero to your cluster. 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!_ + #### MacOS Installation On Mac, you can use [HomeBrew](https://brew.sh) to install the `velero` client: diff --git a/docs/ibm-config.md b/docs/ibm-config.md index 39e3d01bd..4c8709e86 100644 --- a/docs/ibm-config.md +++ b/docs/ibm-config.md @@ -3,11 +3,27 @@ You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any To set up IBM Cloud Object Storage (COS) as Velero's destination, you: +* Download an official release of Velero * Create your COS instance * Create an S3 bucket * Define a service that can store data in the bucket * Configure and start the Velero server +## Download Velero + +1. Download the [latest release's](https://github.com/heptio/velero/releases) tarball for your client platform. + +1. Extract the tarball: + ```bash + tar -xvf .tar.gz -C /dir/to/extract/to + ``` + We'll refer to the directory you extracted to as the "Velero directory" in subsequent steps. + +1. Move the `velero` binary from the Velero directory to somewhere in your PATH. + +_We strongly recommend that you use an [official release](https://github.com/heptio/velero/releases) of Velero. The tarballs for each release contain the +`velero` command-line client **and** version-specific sample YAML files for deploying Velero to your cluster. 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!_ ## Create COS instance If you don’t have a COS instance, you can create a new one, according to the detailed instructions in [Creating a new resource instance][1].