From c2c5cb99c229cf6cd6b580cf44c077e4c256e19a Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Mon, 18 Jan 2021 15:03:37 -0800 Subject: [PATCH 1/2] Update prerequisites in GCP install docs --- docs/clusters/aws/install.md | 2 +- docs/clusters/gcp/install.md | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/clusters/aws/install.md b/docs/clusters/aws/install.md index 70fcc23145..89c805c9a8 100644 --- a/docs/clusters/aws/install.md +++ b/docs/clusters/aws/install.md @@ -2,7 +2,7 @@ ## Prerequisites -1. [Docker](https://docs.docker.com/install) +1. [Docker](https://docs.docker.com/install) must be installed and running on your machine 1. Subscribe to the [EKS-optimized AMI with GPU Support](https://aws.amazon.com/marketplace/pp/B07GRHFXGM) (for GPU clusters) 1. An IAM user with `AdministratorAccess` and programmatic access (see [security](security.md) if you'd like to use less privileged credentials after spinning up your cluster) 1. You may need to [request a limit increase](https://console.aws.amazon.com/servicequotas/home?#!/services/ec2/quotas) for your desired instance type diff --git a/docs/clusters/gcp/install.md b/docs/clusters/gcp/install.md index 227ea56b70..39ded84660 100644 --- a/docs/clusters/gcp/install.md +++ b/docs/clusters/gcp/install.md @@ -1,10 +1,13 @@ # Install -## Spin up Cortex on your GCP account +## Prerequisites -Make sure [Docker](https://docs.docker.com/install) is running on your machine. +1. [Docker](https://docs.docker.com/install) must be installed and running on your machine +1. You may need to [request a quota increase](https://cloud.google.com/compute/quotas) for your desired instance type and/or GPU type +1. Export the `GOOGLE_APPLICATION_CREDENTIALS` environment variable, containing the path to your GCP credentials file (e.g. `export GOOGLE_APPLICATION_CREDENTIALS=~/.config/gcloud/myproject-8a41417a968a.json`) +1. If you haven't done so already, enable the Kubernetes Engine API in your GCP project ([here](https://console.developers.google.com/apis/api/container.googleapis.com/overview)) -If you're using GPUs, make sure your GPU quota is sufficient (see [here](https://cloud.google.com/compute/quotas)). +## Spin up Cortex on your GCP account ```bash # install the CLI From 6c036d339ada4410a3ae89e06f81ac7d85f41501 Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Mon, 18 Jan 2021 15:19:51 -0800 Subject: [PATCH 2/2] Address comment --- docs/clusters/aws/install.md | 2 +- docs/clusters/gcp/install.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/clusters/aws/install.md b/docs/clusters/aws/install.md index 89c805c9a8..272e61d727 100644 --- a/docs/clusters/aws/install.md +++ b/docs/clusters/aws/install.md @@ -2,7 +2,7 @@ ## Prerequisites -1. [Docker](https://docs.docker.com/install) must be installed and running on your machine +1. [Docker](https://docs.docker.com/install) must be installed and running on your machine (to verify, check that running `docker ps` does not return an error) 1. Subscribe to the [EKS-optimized AMI with GPU Support](https://aws.amazon.com/marketplace/pp/B07GRHFXGM) (for GPU clusters) 1. An IAM user with `AdministratorAccess` and programmatic access (see [security](security.md) if you'd like to use less privileged credentials after spinning up your cluster) 1. You may need to [request a limit increase](https://console.aws.amazon.com/servicequotas/home?#!/services/ec2/quotas) for your desired instance type diff --git a/docs/clusters/gcp/install.md b/docs/clusters/gcp/install.md index 39ded84660..9a11e4153d 100644 --- a/docs/clusters/gcp/install.md +++ b/docs/clusters/gcp/install.md @@ -2,7 +2,7 @@ ## Prerequisites -1. [Docker](https://docs.docker.com/install) must be installed and running on your machine +1. [Docker](https://docs.docker.com/install) must be installed and running on your machine (to verify, check that running `docker ps` does not return an error) 1. You may need to [request a quota increase](https://cloud.google.com/compute/quotas) for your desired instance type and/or GPU type 1. Export the `GOOGLE_APPLICATION_CREDENTIALS` environment variable, containing the path to your GCP credentials file (e.g. `export GOOGLE_APPLICATION_CREDENTIALS=~/.config/gcloud/myproject-8a41417a968a.json`) 1. If you haven't done so already, enable the Kubernetes Engine API in your GCP project ([here](https://console.developers.google.com/apis/api/container.googleapis.com/overview))