Skip to content

Commit 056705f

Browse files
authored
fix: properly describe service GCP service account keys rotation (#35)
The procedure previously described explains how to rotate GCP service account keys, not API keys (which are another way to authenticate to _some_ Google Cloud APIs). In this commit, I'm updating the terminology to reflect this fact.
1 parent e0664cf commit 056705f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

content/docs/tutorials/gcp.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: GCP
33
---
44

5-
*This tutorial provides step-by-step instructions on how to rotate a Google Cloud Platform (GCP) API key.*
5+
*This tutorial provides step-by-step instructions on how to rotate a Google Cloud Platform (GCP) Service Account key.*
66

77
---
8-
## Generate a new GCP API Key
8+
## Generate a new GCP Service Account Key
99

1010
### Step 1 - Navigate to the relevant Service Account page
1111
#### 1a. Navigate to the impacted GCP project
@@ -19,12 +19,12 @@ In the `IAM & Admin` tab dropdown, click on `Service Accounts` to view your exis
1919

2020
![](/images/gcp/2.png)
2121

22-
Click on the service account you want to create the API key for.
22+
Click on the service account you want to create the Service Account key for.
2323

2424
![](/images/gcp/3.png)
2525

2626

27-
### Step 2 - Generate a new GCP API key
27+
### Step 2 - Generate a new GCP Service Account key
2828

2929
#### 2a. Create a new key
3030
Click on the `Keys` tab. Click on the `Add Key` button and then select `Create new key`.
@@ -33,16 +33,16 @@ Click on the `Keys` tab. Click on the `Add Key` button and then select `Create n
3333
Choose the key type (`JSON` or `P12`) and click `Create`.
3434
![](/images/gcp/5.png)
3535
#### 2c. New key automatically downloads to your computer
36-
The new API key will be downloaded to your computer. Make sure to store it in a secure location.
36+
The new Service Account key will be downloaded to your computer. Make sure to store it in a secure location.
3737
![](/images/gcp/6.png)
3838

3939
---
40-
## Replace the Leaked GCP API Key
40+
## Replace the Leaked GCP Service Account Key
4141

42-
Replace the leaked GCP API Key with the new one in all impacted applications and services.
42+
Replace the leaked GCP Service Account Key with the new one in all impacted applications and services.
4343

4444
---
45-
## Revoke the Leaked GCP API Key
45+
## Revoke the Leaked GCP Service Account Key
4646

4747
#### *Note: deleting the project that contains the key, does not ensure swift deactivation of that key. GCP services and traffic can remain active up to 30 days after scheduling a project for deletion*
4848

@@ -58,13 +58,13 @@ In the `IAM & Admin` tab dropdown, click on `Service Accounts` to view your exis
5858

5959
![](/images/gcp/2.png)
6060

61-
Click on the service account you want to revoke the API key for.
61+
Click on the service account you want to revoke the Service Account key for.
6262

6363
![](/images/gcp/3.png)
6464

6565

6666

67-
### Step 2 - Revoke the leaked GCP API key
67+
### Step 2 - Revoke the leaked GCP Service Account key
6868

6969
#### 2a. Delete the relevant key
7070
Click on the `Keys` tab. Click on the `Delete` icon at the end of the row of the key you want to delete.
@@ -77,4 +77,4 @@ A message will pop up informing you that the key has been deleted.
7777

7878
---
7979
## Resources
80-
- [GCP API Key Documentation](https://cloud.google.com/docs/authentication/api-keys#introduction)
80+
- [GCP Service Account Key Documentation](https://cloud.google.com/iam/docs/keys-create-delete)

0 commit comments

Comments
 (0)