Skip to content

Commit

Permalink
docs: (PSKD-704) Update GCP refs in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
riragh committed Sep 12, 2024
1 parent e4d2a23 commit a1ca275
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This project contains Terraform scripts to provision Google Cloud infrastructure
[<img src="./docs/images/viya4-iac-gcp-diag.png" alt="Architecture Diagram" width="750"/>](./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&reg; Viya&reg; 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&reg; Viya&reg; platform Operations](https://documentation.sas.com/?cdcId=itopscdc&cdcVersion=default&docsetId=itopswlcm&docsetTarget=home.htm) documentation for more details.

## Prerequisites

Expand Down Expand Up @@ -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
Expand All @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion docs/CONFIG-VARS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | ---: | ---: | ---: | ---: |
Expand Down
2 changes: 1 addition & 1 deletion docs/user/DockerUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/user/TerraformGCPAuthentication.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/user/TerraformUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

1 comment on commit a1ca275

@supear
Copy link
Contributor

@supear supear commented on a1ca275 Sep 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+2

Please sign in to comment.