Skip to content

Commit

Permalink
Address review comments, and unify language
Browse files Browse the repository at this point in the history
Signed-off-by: Nolan Brubaker <brubakern@vmware.com>
  • Loading branch information
nrb committed Apr 19, 2019
1 parent 687410f commit 9610812
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 20 deletions.
24 changes: 14 additions & 10 deletions docs/aws-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ If you do not have the `aws` CLI locally installed, follow the [user guide][5] t

1. Download the [latest official release's](https://github.com/heptio/velero/releases) tarball for your client platform.

_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. The code in the master branch
of the Velero repository is under active development and is not guaranteed to be stable!_

1. Extract the tarball:
```bash
tar -xvf <RELEASE-TARBALL-NAME>.tar.gz -C /dir/to/extract/to
Expand All @@ -27,16 +31,17 @@ If you do not have the `aws` CLI locally installed, follow the [user guide][5] t
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:
```bash
BUCKET=<YOUR_BUCKET>
aws s3api create-bucket \
--bucket <YOUR_BUCKET> \
--bucket $BUCKET \
--region <YOUR_REGION> \
--create-bucket-configuration LocationConstraint=<YOUR_REGION>
```
NOTE: us-east-1 does not support a `LocationConstraint`. If your region is `us-east-1`, omit the bucket configuration:
```bash
aws s3api create-bucket \
--bucket <YOUR_BUCKET> \
--bucket $BUCKET \
--region us-east-1
```
Expand All @@ -55,8 +60,7 @@ For more information, see [the AWS documentation on IAM users][14].
2. Attach policies to give `velero` the necessary permissions:

```bash
BUCKET=<YOUR_BUCKET>
cat > velero-policy.json <<EOF
cat > velero-policy.!json <<EOF
{
"Version": "2012-10-17",
"Statement": [
Expand Down Expand Up @@ -141,8 +145,8 @@ Install Velero, including all prerequisites, into the cluster and start the depl
```bash
velero install \
--bucket <YOUR_BUCKET> \
--provider aws \
--bucket $BUCKET \
--secret-file ./credentials-velero
--backup-location-config region=<YOUR_REGION> \
--snapshot-location-config region=<YOUR_REGION> \
Expand All @@ -151,14 +155,14 @@ velero install \
Additionally, you can specify `--use-restic` to enable restic support, and `--wait` to wait for the deployment to be ready.
For more complex installation needs (such as changing the namespace), use either the Helm chart, or add `--dry-run -o yaml` options for generating the YAML representation for the installation.
For more complex installation needs, use either the Helm chart, or add `--dry-run -o yaml` options for generating the YAML representation for the installation.
## Setting AWS_CLUSTER_NAME
## Setting AWS_CLUSTER_NAME (Optional)
* (Optional) If you have multiple clusters and you want to support migration of resources between them, you can use `kubectl edit deploy/velero -n velero` to edit your deployment:
* If you have multiple clusters and you want to support migration of resources between them, you can use `kubectl edit deploy/velero -n velero` to edit your deployment:
* Uncomment the environment variable `AWS_CLUSTER_NAME` and replace `<YOUR_CLUSTER_NAME>` with the current cluster's name. When restoring backup, it will make Velero (and cluster it's running on) claim ownership of AWS volumes created from snapshots taken on different cluster.
* Add the environment variable `AWS_CLUSTER_NAME` under `spec.template.spec.env`, with the current cluster's name. When restoring backup, it will make Velero (and cluster it's running on) claim ownership of AWS volumes created from snapshots taken on different cluster.
The best way to get the current cluster's name is to either check it with used deployment tool or to read it directly from the EC2 instances tags.
The following listing shows how to get the cluster's nodes EC2 Tags. First, get the nodes external IDs (EC2 IDs):
Expand Down Expand Up @@ -296,7 +300,7 @@ It can be set up for Velero by creating a role that will have required permissio
If you run the nginx example, in file `config/nginx-app/with-pv.yaml`:
* Replace `<YOUR_STORAGE_CLASS_NAME>` with `standard`. This is GCP's default `StorageClass` name.
* Replace `<YOUR_STORAGE_CLASS_NAME>` with `gp2`. This is AWS's default `StorageClass` name.
[0]: namespace.md
[5]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html
Expand Down
17 changes: 14 additions & 3 deletions docs/azure-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ consider using Premium Managed Disks, which are SSD backed.

1. Download the [latest official release's](https://github.com/heptio/velero/releases) tarball for your client platform.

_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. The code in the master branch
of the Velero repository is under active development and is not guaranteed to be stable!_

1. Extract the tarball:
```bash
tar -xvf <RELEASE-TARBALL-NAME>.tar.gz -C /dir/to/extract/to
Expand Down Expand Up @@ -67,7 +71,8 @@ az storage account create \
Create the blob container named `velero`. Feel free to use a different name, preferably unique to a single Kubernetes cluster. See the [FAQ][20] for more details.
```bash
az storage container create -n velero --public-access off --account-name $AZURE_STORAGE_ACCOUNT_ID
BLOB_CONTAINER=velero
az storage container create -n $BLOB_CONTAINER --public-access off --account-name $AZURE_STORAGE_ACCOUNT_ID
```
## Get resource group for persistent volume snapshots
Expand Down Expand Up @@ -134,16 +139,22 @@ Install Velero, including all prerequisites, into the cluster and start the depl

```bash
velero install \
--bucket <YOUR_BLOB_CONTAINER> \
--provider azure \
--bucket $BLOB_CONTAINER \
--secret-file ./credentials-velero \
--backup-location-config resourceGroup=<YOUR_STORAGE_RESOURCE_GROUP>,storageAccount=<YOUR_STORAGE_ACCOUNT> \
--snapshot-location-config timeout=<YOUR_TIMEOUT>
```

Additionally, you can specify `--use-restic` to enable restic support, and `--wait` to wait for the deployment to be ready.

For more complex installation needs (such as changing the namespace), use either the Helm chart, or add `--dry-run -o yaml` options for generating the YAML representation for the installation.
For more complex installation needs, use either the Helm chart, or add `--dry-run -o yaml` options for generating the YAML representation for the installation.

## Installing the nginx example (optional)

If you run the nginx example, in file `config/nginx-app/with-pv.yaml`:

* Replace `<YOUR_STORAGE_CLASS_NAME>` with `default`. This is Azure's default `StorageClass` name.
[0]: namespace.md
[8]: api-types/volumesnapshotlocation.md#azure
Expand Down
6 changes: 5 additions & 1 deletion docs/gcp-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ If you do not have the `gcloud` and `gsutil` CLIs locally installed, follow the

1. Download the [latest official release's](https://github.com/heptio/velero/releases) tarball for your client platform.

_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. The code in the master branch
of the Velero repository is under active development and is not guaranteed to be stable!_

1. Extract the tarball:
```bash
tar -xvf <RELEASE-TARBALL-NAME>.tar.gz -C /dir/to/extract/to
Expand Down Expand Up @@ -113,8 +117,8 @@ Install Velero, including all prerequisites, into the cluster and start the depl

```bash
velero install \
--bucket <YOUR_BUCKET> \
--provider gcp \
--bucket $BUCKET \
--secret-file ./credentials-velero
```

Expand Down
7 changes: 4 additions & 3 deletions docs/install-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,13 @@ For details, see the documentation topics for individual cloud providers.
The Velero client includes an `install` command to specify the settings for each supported cloud provider. You can install Velero for the included cloud providers using the following command:

```bash
# velero install \
--bucket <YOUR_BUCKET> \
velero install \
--provider <YOUR_PROVIDER> \
--bucket <YOUR_BUCKET> \
--secret-file <PATH_TO_FILE> \
[--backup-location-config]
[--snapshot-location-config]
[-namepsace]
```
For provider-specific instructions, see:
Expand All @@ -34,7 +35,7 @@ For provider-specific instructions, see:

To see the YAML applied by the `velero install` command, use the `--dry-run -o yaml` arguments.

For more complex installation needs, use either the YAML generated, or the Helm chart.
For more complex installation needs, use either the generated YAML, or the Helm chart.

## On-premises

Expand Down
6 changes: 3 additions & 3 deletions docs/namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ First, ensure you've [downloaded & extracted the latest release][0].
Then, install Velero using the `--namespace` flag:

```bash
# velero install --bucket <YOUR_BUCKET> --provider <YOUR_PROVIDER> --namespace <YOUR_NAMESPACE>
velero install --bucket <YOUR_BUCKET> --provider <YOUR_PROVIDER> --namespace <YOUR_NAMESPACE>
```


Expand All @@ -18,8 +18,8 @@ Then, install Velero using the `--namespace` flag:

To specify the namespace for all Velero client commands, run:

```
velero client config set namespace=<NAMESPACE_VALUE>
```bash
velero client config set namespace=<NAMESPACE_VALUE>
```


Expand Down

0 comments on commit 9610812

Please sign in to comment.