diff --git a/docs/build-from-scratch.md b/docs/build-from-scratch.md index 42ebf7352..b6fcab650 100644 --- a/docs/build-from-scratch.md +++ b/docs/build-from-scratch.md @@ -93,11 +93,12 @@ When running Heptio Ark, you will need to account for the following (all of whic * Cloud provider credentials * Read/write access to volumes * Read/write access to object storage for backup data -* A [Config object][8] definition for the Ark server +* A [BackupStorageLocation][20] object definition for the Ark server +* (Optional) A [VolumeSnapshotLocation][21] object definition for the Ark server, to take PV snapshots ### Create a cluster -To provision a cluster on `aws` using Amazon’s official CloudFormation templates, here are two options: +To provision a cluster on AWS using Amazon’s official CloudFormation templates, here are two options: * EC2 [Quick Start for Kubernetes][17] @@ -138,7 +139,11 @@ You may create resources on a cluster using our [example configurations][19]. ##### Example -Here is how to setup using an existing cluster in AWS: At the root of the Ark repo, edit `examples/aws/00-ark-config.yaml` to point to your AWS S3 bucket and region. Note: you can run `aws s3api list-buckets` to get the name of all your buckets. +Here is how to setup using an existing cluster in AWS: At the root of the Ark repo: + +- Edit `examples/aws/05-ark-backupstoragelocation.yaml` to point to your AWS S3 bucket and region. Note: you can run `aws s3api list-buckets` to get the name of all your buckets. + +- (Optional) Edit `examples/aws/06-ark-volumesnapshotlocation.yaml` to point to your AWS region. Then run the commands below. @@ -148,12 +153,23 @@ Then run the commands below. kubectl apply -f examples/common/00-prereqs.yaml ``` -`00-ark-config.yaml` is a sample Ark config resource for AWS: +`10-deployment.yaml` is a sample Ark config resource for AWS: ```bash -kubectl apply -f examples/aws/00-ark-config.yaml +kubectl apply -f examples/aws/10-deployment.yaml ``` +And `05-ark-backupstoragelocation.yaml` specifies the location of your backup storage, together with the optional `06-ark-volumesnapshotlocation.yaml`: + +```bash +kubectl apply -f examples/aws/05-ark-backupstoragelocation.yaml +``` + +or + +```bash +kubectl apply -f examples/aws/05-ark-backupstoragelocation.yaml examples/aws/06-ark-volumesnapshotlocation.yaml +``` ### 3. Start the Ark server @@ -205,3 +221,5 @@ If you need to add or update the vendored dependencies, see [Vendoring dependenc [17]: https://aws.amazon.com/quickstart/architecture/heptio-kubernetes/ [18]: https://eksctl.io/ [19]: ../examples/README.md +[20]: /api-types/backupstoragelocation.md +[21]: /api-types/volumesnapshotlocation.md diff --git a/docs/gcp-config.md b/docs/gcp-config.md index 4b0795464..64d9e5434 100644 --- a/docs/gcp-config.md +++ b/docs/gcp-config.md @@ -1,6 +1,6 @@ # Run Ark on GCP -You can run Kubernetes on Google Cloud Platform in either of: +You can run Kubernetes on Google Cloud Platform in either: * Kubernetes on Google Compute Engine virtual machines * Google Kubernetes Engine @@ -9,7 +9,7 @@ If you do not have the `gcloud` and `gsutil` CLIs locally installed, follow the ## Create GCS bucket -Heptio Ark requires an object storage bucket in which to store backups, preferrably 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: +Heptio Ark 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: ```bash BUCKET= diff --git a/docs/upgrading-to-v0.10.md b/docs/upgrading-to-v0.10.md index fe2ea47a2..75f22d1c4 100644 --- a/docs/upgrading-to-v0.10.md +++ b/docs/upgrading-to-v0.10.md @@ -77,6 +77,6 @@ kubectl delete crd configs.ark.heptio.com ``` -[1]: /docs/api-types/backupstoragelocation.md -[2]: /docs/api-types/volumesnapshotlocation.md -[3]: /docs/storage-layout-reorg-v0.10.md +[1]: /api-types/backupstoragelocation.md +[2]: /api-types/volumesnapshotlocation.md +[3]: storage-layout-reorg-v0.10.md