Skip to content

Commit 2ccb8a5

Browse files
authored
docs: (PSKD-704) Update refs to GCP in Docs (#221)
* docs: (PSKD-704) Update GCP refs in documentation
1 parent f53d5e4 commit 2ccb8a5

File tree

7 files changed

+42
-42
lines changed

7 files changed

+42
-42
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# SAS Viya 4 Infrastructure as Code (IaC) for Google Cloud Platform (GCP)
1+
# SAS Viya 4 Infrastructure as Code (IaC) for Google Cloud
22

33
## Overview
44

5-
This project contains Terraform scripts to provision Google GCP infrastructure resources required to deploy SAS Viya 4 platform products. Here is a list of resources this project can create -
5+
This project contains Terraform scripts to provision Google Cloud infrastructure resources required to deploy SAS Viya 4 platform products. Here is a list of resources this project can create -
66

77
>- VPC Network and Network Firewalls
88
>- Managed Google Kubernetes Engine (GKE) cluster
@@ -13,14 +13,14 @@ This project contains Terraform scripts to provision Google GCP infrastructure r
1313
1414
[<img src="./docs/images/viya4-iac-gcp-diag.png" alt="Architecture Diagram" width="750"/>](./docs/images/viya4-iac-gcp-diag.png?raw=true)
1515

16-
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.
16+
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.
1717

1818
## Prerequisites
1919

2020
Operational knowledge of
2121
- [Terraform](https://www.terraform.io/intro/index.html)
2222
- [Docker](https://www.docker.com/)
23-
- [Google Cloud Platform](https://cloud.google.com/)
23+
- [Google Cloud](https://cloud.google.com/)
2424
- [Kubernetes](https://kubernetes.io/docs/concepts/)
2525

2626
### Required
@@ -46,28 +46,28 @@ Operational knowledge of
4646
Run these commands in a Terminal session:
4747

4848
```bash
49-
# clone this repo
49+
# clone this repository
5050
git clone https://github.com/sassoftware/viya4-iac-gcp
5151

5252
# move to directory
5353
cd viya4-iac-gcp
5454
```
5555

56-
### Authenticating Terraform to access GCP
56+
### Authenticating Terraform to access Google Cloud
5757

58-
See [Terraform GCP Authentication](./docs/user/TerraformGCPAuthentication.md) for details.
58+
See [Terraform Google Cloud Authentication](./docs/user/TerraformGCPAuthentication.md) for details.
5959

6060
### Customize Input Values
6161

6262
Create a file named `terraform.tfvars` to customize any input variable value documented in the [CONFIG-VARS.md](docs/CONFIG-VARS.md) file. For starters, you can copy one of the provided example variable definition files in `./examples` folder. For more details on the variables declared refer to the [CONFIG-VARS.md](docs/CONFIG-VARS.md) file.
6363

64-
**NOTE:** You will need to update the `cidr_blocks` in the [variables.tf](variables.tf) file to allow traffic from your current network. Without these rules, access to the cluster will only be allowed via the GCP Console.
64+
**NOTE:** You will need to update the `cidr_blocks` in the [variables.tf](variables.tf) file to allow traffic from your current network. Without these rules, access to the cluster will only be allowed via the Google Cloud Console.
6565

6666
When using a variable definition file other than `terraform.tfvars`, see [Advanced Terraform Usage](docs/user/AdvancedTerraformUsage.md) for additional command options.
6767

6868
## Creating and Managing the Cloud Resources
6969

70-
Create and manage the GCP cloud resources by either
70+
Create and manage the Google Cloud resources by either
7171

7272
- using [Terraform](docs/user/TerraformUsage.md) directly on your workstation, or
7373
- using a [Docker container](docs/user/DockerUsage.md).
@@ -87,11 +87,11 @@ See [troubleshooting](./docs/Troubleshooting.md) page.
8787
8888
## Additional Resources
8989

90-
### GCP
90+
### Google Cloud
9191

9292
- Google Cloud CLI - https://cloud.google.com/sdk/gcloud
93-
- Terraform on GCP - https://cloud.google.com/docs/terraform
94-
- Terraform and GCP Service Accounts - https://medium.com/@gmusumeci/how-to-create-a-service-account-for-terraform-in-gcp-google-cloud-platform-f75a0cf918d1
93+
- Terraform on Google Cloud - https://cloud.google.com/docs/terraform
94+
- Terraform and Google Cloud Service Accounts - https://medium.com/@gmusumeci/how-to-create-a-service-account-for-terraform-in-gcp-google-cloud-platform-f75a0cf918d1
9595
- GKE intro - https://cloud.google.com/kubernetes-engine
9696

9797
### Terraform

docs/CONFIG-VARS.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Supported configuration variables are listed in the table below. All variables
77
- [List of valid configuration variables](#list-of-valid-configuration-variables)
88
- [Table of Contents](#table-of-contents)
99
- [Required Variables](#required-variables)
10-
- [GCP Authentication](#gcp-authentication)
10+
- [Google Cloud Authentication](#gcp-authentication)
1111
- [Admin Access](#admin-access)
1212
- [Networking](#networking)
1313
- [Use Existing](#use-existing)
@@ -31,21 +31,21 @@ Terraform input variables can be set in the following ways:
3131

3232
| Name | Description | Type | Default | Notes |
3333
| :--- | :--- | :--- | :--- | :--- |
34-
| prefix | A prefix used in the name of all the GCP resources created by this script. | string | | The prefix string must start with a lowercase letter and contain only lowercase alphanumeric characters and dashes (-), but cannot end with a dash. |
35-
| location | The GCP Region (for example "us-east1") or GCP Zone (for example "us-east1-b") to provision all resources in this script. | string | | See [this topic](user/Locations.md) on how to chose a region or a zone. |
36-
| project | The ID of the GCP Project to use | string | | |
34+
| prefix | A prefix used in the name of all the Google Cloud resources created by this script. | string | | The prefix string must start with a lowercase letter and contain only lowercase alphanumeric characters and dashes (-), but cannot end with a dash. |
35+
| location | The Google Cloud Region (for example "us-east1") or Google Cloud Zone (for example "us-east1-b") to provision all resources in this script. | string | | See [this topic](user/Locations.md) on how to chose a region or a zone. |
36+
| project | The ID of the Google Cloud Project to use | string | | |
3737
| service_account_keyfile | Filename of the Service Account JSON file | string | Not required when running on a Google Cloud VM that is associated with the Service Account |
3838

39-
## GCP Authentication
39+
## Google Cloud Authentication
4040

41-
The Terraform process manages GCP resources on your behalf. In order to do so, it needs to know the credentials for a GCP identity with the required permissions.
41+
The Terraform process manages Google Cloud resources on your behalf. In order to do so, it needs to know the credentials for a Google Cloud identity with the required permissions.
4242

43-
For more detailed information on what is needed see [Authenticating Terraform to access GCP](https://github.com/sassoftware/viya4-iac-gcp/blob/main/docs/user/TerraformGCPAuthentication.md)
43+
For more detailed information on what is needed see [Authenticating Terraform to access Google Cloud](https://github.com/sassoftware/viya4-iac-gcp/blob/main/docs/user/TerraformGCPAuthentication.md)
4444

4545
## Admin Access
4646

47-
By default, the API of the GCP resources that are being created are only accessible through authenticated GCP clients (e.g. the Google Cloud Portal, the `gcloud` CLI, the Google Cloud Shell, etc.)
48-
To allow access for other administrative client applications (for example `kubectl`, `psql`, etc.), you need to open up the GCP firewall to allow access from your source IPs.
47+
By default, the API of the Google Cloud resources that are being created are only accessible through authenticated Google Cloud clients (e.g. the Google Cloud Portal, the `gcloud` CLI, the Google Cloud Shell, etc.)
48+
To allow access for other administrative client applications (for example `kubectl`, `psql`, etc.), you need to open up the Google Cloud firewall to allow access from your source IPs.
4949

5050
To do set these permissions as part of this Terraform script, specify ranges of IP addresses in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). Contact your Network Administrator to find the public CIDR range of your network.
5151

@@ -94,11 +94,11 @@ subnet_names = {
9494
}
9595
```
9696

97-
Note: The subnets for filestore and database can not the pre-created. GCP creates the subnets as part of the services.
97+
Note: The subnets for filestore and database can not the pre-created. Google Cloud creates the subnets as part of the services.
9898

9999
## General
100100

101-
The application of a Kubernetes version in GCP 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.
101+
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.
102102

103103
| Name | Description | Type | Default | Notes |
104104
| :--- | ---: | ---: | ---: | ---: |
@@ -114,7 +114,7 @@ The application of a Kubernetes version in GCP has some limitations when assigni
114114
| create_jump_public_ip | Add public ip to jump VM | bool | true | |
115115
| jump_vm_admin | OS Admin User for the Jump VM | string | "jumpuser" | |
116116
| jump_rwx_filestore_path | File store mount point on Jump server | string | "/viya-share" | |
117-
| tags | Map of common tags to be placed on all GCP resources created by this script | map | {} | |
117+
| tags | Map of common tags to be placed on all Google Cloud resources created by this script | map | {} | |
118118
| ssh_public_key | File name of public ssh key for jump and nfs VM | string | null | Required with `create_jump_vm=true` or `storage_type=standard` |
119119
| cluster_api_mode | Public or private IP for the cluster api| string|"public"|Valid Values: "public", "private" |
120120

docs/user/DockerUsage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ docker build --build-arg INSTALL_COMPONENTS="cloud-spanner-emulator" -t viya4-ia
3131
```
3232

3333

34-
### Service Account Keyfile for GCP Authentication
34+
### Service Account Keyfile for Google Cloud Authentication
3535

36-
Prepare a file with GCP authentication info, as described in [Authenticating Terraform to access GCP](./TerraformGCPAuthentication.md) and store it outside of this repo in a secure file, for example `$HOME/.viya4-tf-gcp-service-account.json`.
36+
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`.
3737

3838
### Docker Volume Mounts
3939

4040
Add volume mounts to the `docker run` command for all files and directories that must be accessible from inside the container.
41-
- `--volume=$HOME/.viya4-tf-gcp-service-account.json:/.viya4-tf-gcp-service-account.json` Service Account Key file for GCP authentication
41+
- `--volume=$HOME/.viya4-tf-gcp-service-account.json:/.viya4-tf-gcp-service-account.json` Service Account Key file for Google Cloud authentication
4242
- `--volume=$HOME/.ssh:/.ssh` for [`ssh_public_key`](../CONFIG-VARS.md#required-variables) variable in the `terraform.tfvars` file
4343
- `--volume=$(pwd):/workspace` for local directory where `terraform.tfvars` file resides and where `terraform.tfstate` file will be written. To grant Docker, permission to write to the local directory use [`--user` option](https://docs.docker.com/engine/reference/run/#user)
4444

docs/user/KubernetesVersions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Kubernetes Versions
22

3-
Setting versions within the Google Cloud Platform (GCP) environment is slightly different from setting a version within other cloud providers
3+
Setting versions within the Google Cloud environment is slightly different from setting a version within other cloud providers
44

55
There are two scenarios that are supported. These are:
66

docs/user/Locations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Resource Locations
22

3-
Google Cloud Platform resources are hosted in different data centers worldwide, divided into [Regions and Zones](https://cloud.google.com/compute/docs/regions-zones).
3+
Google Cloud resources are hosted in different data centers worldwide, divided into [Regions and Zones](https://cloud.google.com/compute/docs/regions-zones).
44

55
You control the location of your Viya4 IAC resources by setting the `location` variable to either a Region or a Zone.
66

docs/user/TerraformGCPAuthentication.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Authenticating Terraform to access GCP
1+
# Authenticating Terraform to access Google Cloud
22

3-
Terraform creates and destroys resources in the Google Cloud Platform on your behalf.
4-
In order to do so, it needs to authenticate itself to GCP with the appropriate permissions.
3+
Terraform creates and destroys resources in Google Cloud on your behalf.
4+
In order to do so, it needs to authenticate itself to Google Cloud with the appropriate permissions.
55

6-
This project uses a GCP Service Account to authenticate with GCP. You will need a Service Account with the appropriate permissions. You can use an existing Service Account, or preferably create a dedicated Service Account.
6+
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.
77

88
## Running Terraform outside Google Cloud
99

@@ -14,9 +14,9 @@ If you are running terraform outside of Google Cloud, generate a service account
1414
If you are running terraform on a VM in Google Cloud, you can [configure that VM instance to use your Service Account](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances#using). This will allow Terraform to authenticate to Google Cloud without having to bake in a separate credential/authentication file. Ensure that the scope of the VM is set to or includes https://www.googleapis.com/auth/cloud-platform.
1515

1616

17-
## Create a GCP Service Account
17+
## Create a Google Cloud Service Account
1818

19-
How to create a GCP Service Account: https://cloud.google.com/iam/docs/creating-managing-service-accounts
19+
How to create a Google Cloud Service Account: https://cloud.google.com/iam/docs/creating-managing-service-accounts
2020

2121
gcloud CLI Example:
2222

@@ -44,7 +44,7 @@ The Service Account will need the following [IAM roles](https://cloud.google.com
4444
| `roles/iam.serviceAccountUser` | Service Account User | Terraform Kubernetes Engine Module |
4545
| `roles/resourcemanager.projectIamAdmin` | Project IAM Admin | Terraform Kubernetes Engine Module |
4646

47-
How to modify IAM access to GCP resources: https://cloud.google.com/iam/docs/granting-changing-revoking-access
47+
How to modify IAM access to Google Cloud resources: https://cloud.google.com/iam/docs/granting-changing-revoking-access
4848

4949
gcloud CLI Example:
5050
```bash
@@ -96,7 +96,7 @@ roles/resourcemanager.projectIamAdmin
9696

9797
## Create the Service Account Keyfile
9898

99-
When running terraform on a workstation outside of the Google Cloud Platform, 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).
99+
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).
100100

101101
Managing key files using the Cloud Console: https://console.cloud.google.com/apis/credentials/serviceaccountkey
102102

@@ -110,11 +110,11 @@ gcloud iam service-accounts keys create ${SA_KEY_FILE} --iam-account ${SA_NAME}@
110110
chmod 500 ${SA_KEY_FILE} # secure the keyfile
111111
```
112112

113-
## Terraform project variables to authenticate with GCP
113+
## Terraform project variables to authenticate with Google Cloud
114114

115115
As part of your [Terraform input variables](../../README.md#customize-input-values), set these values:
116116

117117
| Name | Description |
118118
| :--- | :--- |
119-
| project | The GCP Project to use |
120-
| service_account_keyfile | Filename of the Service Account JSON file. Alternatively, you can set the `GOOGLE_APPLICATION_CREDENTIAL` environment variable. Note that you do not need to set this variable when running on a GCP VM that is associated with the Service Account. |
119+
| project | The Google Cloud Project to use |
120+
| service_account_keyfile | Filename of the Service Account JSON file. Alternatively, you can set the `GOOGLE_APPLICATION_CREDENTIAL` environment variable. Note that you do not need to set this variable when running on a Google Cloud VM that is associated with the Service Account. |

docs/user/TerraformUsage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ When using the Terraform CLI, make sure you have all the necessary tools [instal
66

77
## Preparation
88

9-
### Set GCP Authentication
9+
### Set Google Cloud Authentication
1010

11-
Prepare a file with authentication info, as described in [Authenticating Terraform to access GCP](./TerraformGCPAuthentication.md).
11+
Prepare a file with authentication information, as described in [Authenticating Terraform to access Google Cloud](./TerraformGCPAuthentication.md).
1212

1313
### Prepare Variable Definitions (.tfvars) File
1414

0 commit comments

Comments
 (0)