diff --git a/README.md b/README.md index d07923f..e6111d0 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This project contains Terraform scripts to provision Google Cloud infrastructure [Architecture Diagram](./docs/images/viya4-iac-gcp-diag.png?raw=true) -Once the cloud resources are provisioned, see the [viya4-deployment](https://github.com/sassoftware/viya4-deployment) repo to deploy SAS Viya 4 platform products. If you need more information on the SAS Viya 4 platform products refer to the official [SAS® Viya® platform Operations](https://documentation.sas.com/?cdcId=itopscdc&cdcVersion=default&docsetId=itopswlcm&docsetTarget=home.htm) documentation for more details. +Once the cloud resources are provisioned, see the [viya4-deployment](https://github.com/sassoftware/viya4-deployment) repository to deploy SAS Viya 4 platform products. If you need more information on the SAS Viya 4 platform products refer to the official [SAS® Viya® platform Operations](https://documentation.sas.com/?cdcId=itopscdc&cdcVersion=default&docsetId=itopswlcm&docsetTarget=home.htm) documentation for more details. ## Prerequisites @@ -46,7 +46,7 @@ Operational knowledge of Run these commands in a Terminal session: ```bash -# clone this repo +# clone this repository git clone https://github.com/sassoftware/viya4-iac-gcp # move to directory @@ -67,7 +67,7 @@ When using a variable definition file other than `terraform.tfvars`, see [Advanc ## Creating and Managing the Cloud Resources -Create and manage the Google cloud resources by either +Create and manage the Google Cloud resources by either - using [Terraform](docs/user/TerraformUsage.md) directly on your workstation, or - using a [Docker container](docs/user/DockerUsage.md). diff --git a/docs/CONFIG-VARS.md b/docs/CONFIG-VARS.md index 537bb7a..9f80726 100644 --- a/docs/CONFIG-VARS.md +++ b/docs/CONFIG-VARS.md @@ -98,7 +98,7 @@ Note: The subnets for filestore and database can not the pre-created. Google Clo ## General -The application of a Kubernetes version in Google Cloud has some limitations when assigning channels and versions to the cluster. The doc outlining on these limitations can be found in the [Kubernetes Versions](user/KubernetesVersions.md) guide. +The application of a Kubernetes version in Google Cloud has some limitations when assigning channels and versions to the cluster. The documentation that describes these limitations can be found in the [Kubernetes Versions](user/KubernetesVersions.md) guide. | Name | Description | Type | Default | Notes | | :--- | ---: | ---: | ---: | ---: | diff --git a/docs/user/DockerUsage.md b/docs/user/DockerUsage.md index 1b82473..766e33f 100644 --- a/docs/user/DockerUsage.md +++ b/docs/user/DockerUsage.md @@ -33,7 +33,7 @@ docker build --build-arg INSTALL_COMPONENTS="cloud-spanner-emulator" -t viya4-ia ### Service Account Keyfile for Google Cloud Authentication -Prepare a file with Google Cloud authentication info, as described in [Authenticating Terraform to access Google Cloud](./TerraformGCPAuthentication.md) and store it outside of this repo in a secure file, for example `$HOME/.viya4-tf-gcp-service-account.json`. +Prepare a file with Google Cloud authentication information, as described in [Authenticating Terraform to access Google Cloud](./TerraformGCPAuthentication.md) and store it outside of this repository in a secure file, for example `$HOME/.viya4-tf-gcp-service-account.json`. ### Docker Volume Mounts diff --git a/docs/user/TerraformGCPAuthentication.md b/docs/user/TerraformGCPAuthentication.md index b24c8a3..441cd12 100644 --- a/docs/user/TerraformGCPAuthentication.md +++ b/docs/user/TerraformGCPAuthentication.md @@ -1,6 +1,6 @@ # Authenticating Terraform to access Google Cloud -Terraform creates and destroys resources in the Google Cloud on your behalf. +Terraform creates and destroys resources in Google Cloud on your behalf. In order to do so, it needs to authenticate itself to Google Cloud with the appropriate permissions. This project uses a Google Cloud Service Account to authenticate with Google Cloud. You will need a Service Account with the appropriate permissions. You can use an existing Service Account, or preferably create a dedicated Service Account. @@ -96,7 +96,7 @@ roles/resourcemanager.projectIamAdmin ## Create the Service Account Keyfile -When running terraform on a workstation outside of the Google Cloud, you persist the Service Account information to a JSON file, and then [specify that file when running terraform](#Terraform-project-variables-to-authenticate-with-GCP). +When running terraform on a workstation outside of Google Cloud, you store the Service Account information in a JSON file, and then [specify that file when running terraform](#Terraform-project-variables-to-authenticate-with-GCP). Managing key files using the Cloud Console: https://console.cloud.google.com/apis/credentials/serviceaccountkey diff --git a/docs/user/TerraformUsage.md b/docs/user/TerraformUsage.md index c871c2d..69821a3 100644 --- a/docs/user/TerraformUsage.md +++ b/docs/user/TerraformUsage.md @@ -8,7 +8,7 @@ When using the Terraform CLI, make sure you have all the necessary tools [instal ### Set Google Cloud Authentication -Prepare a file with authentication info, as described in [Authenticating Terraform to access Google Cloud](./TerraformGCPAuthentication.md). +Prepare a file with authentication information, as described in [Authenticating Terraform to access Google Cloud](./TerraformGCPAuthentication.md). ### Prepare Variable Definitions (.tfvars) File