Skip to content
This repository has been archived by the owner on Feb 9, 2022. It is now read-only.

Commit

Permalink
docs: rename quickstart env var GCLOUD_REGION to GCLOUD_ZONE
Browse files Browse the repository at this point in the history
The user should specify the GCE zone (not region). Corrected this
mistake and also renamed the variable to `GCLOUD_ZONE`.

Fixes #285
  • Loading branch information
Sameer Naik committed Jan 4, 2019
1 parent 5fb3bad commit ab7782c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/quickstart-gke.md
Expand Up @@ -25,7 +25,7 @@ In this section, you will deploy a Google Kubernetes Engine (GKE) cluster using
export BKPR_DNS_ZONE="my-domain.com"
export GCLOUD_USER="$(gcloud info --format='value(config.account)')"
export GCLOUD_PROJECT="my-gce-project"
export GCLOUD_REGION="us-east1-d"
export GCLOUD_ZONE="us-east1-d"
export GCLOUD_AUTHZ_DOMAIN="my-domain.com"
export GCLOUD_K8S_CLUSTER="my-gke-cluster"
export GCLOUD_K8S_VERSION="1.11"
Expand All @@ -34,10 +34,10 @@ In this section, you will deploy a Google Kubernetes Engine (GKE) cluster using
- `BKPR_DNS_ZONE` specifies the DNS suffix for the externally-visible websites and services deployed in the cluster. A TLD or a sub-domain may be used.
- `GCLOUD_USER` specifies the email address used to authenticate to Google Cloud Platform.
- `GCLOUD_PROJECT` specifies the Google Cloud project. `gcloud projects list` lists your Google Cloud projects.
- `GCLOUD_REGION` specifies the Google Cloud region. `gcloud compute regions list` lists the available Google Cloud regions.
- `GCLOUD_ZONE` specifies the Google Cloud zone. `gcloud compute zones list` lists the Google Cloud zones.
- `GCLOUD_AUTHZ_DOMAIN` specifies the email domain of authorized users and needs to be a [G Suite](https://gsuite.google.com/) domain. Alternatively, you could specify the value `*`, but be __WARNED__ that this will authorize any Google account holder to authenticate with OAuth to your cluster services.
- `GCLOUD_K8S_CLUSTER` specifies the name of the GKE cluster.
- `GCLOUD_K8S_VERSION` specifies the version of Kubernetes to use for creating the cluster. The [BKPR Kubernetes version support matrix](../README.md#kubernetes-version-support-matrix-for-bkpr-10) lists the base Kubernetes versions supported by BKPR. `gcloud container get-server-config --project ${GCLOUD_PROJECT} --zone ${GCLOUD_REGION}` lists the versions available in your region.
- `GCLOUD_K8S_VERSION` specifies the version of Kubernetes to use for creating the cluster. The [BKPR Kubernetes version support matrix](../README.md#kubernetes-version-support-matrix-for-bkpr-10) lists the base Kubernetes versions supported by BKPR. `gcloud container get-server-config --project ${GCLOUD_PROJECT} --zone ${GCLOUD_ZONE}` lists the versions available in your region.

* Create an OAuth Client ID by following these steps:

Expand Down Expand Up @@ -83,7 +83,7 @@ Specify the displayed OAuth client id and secret in the `GCLOUD_OAUTH_CLIENT_KEY
* Set the default region:

```bash
gcloud config set compute/zone ${GCLOUD_REGION}
gcloud config set compute/zone ${GCLOUD_ZONE}
```

* Create the GKE cluster:
Expand All @@ -93,7 +93,7 @@ Specify the displayed OAuth client id and secret in the `GCLOUD_OAUTH_CLIENT_KEY
--project ${GCLOUD_PROJECT} \
--num-nodes 3 \
--machine-type n1-standard-2 \
--zone ${GCLOUD_REGION} \
--zone ${GCLOUD_ZONE} \
--cluster-version ${GCLOUD_K8S_VERSION}
```

Expand Down

0 comments on commit ab7782c

Please sign in to comment.