Skip to content

Commit a6cbb66

Browse files
authored
Merge pull request #85242 from mletalie/OSDOCS-11894
[OSDOCS-11894] Explain why and in what context are the required GCP APIs used by OSD
2 parents 03ca787 + d4b64d7 commit a6cbb66

File tree

1 file changed

+34
-24
lines changed

1 file changed

+34
-24
lines changed

modules/ccs-gcp-customer-procedure.adoc

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,61 +29,71 @@ To use {product-title} in your GCP project, the following GCP organizational pol
2929
. link:https://cloud.google.com/service-usage/docs/enable-disable#enabling[Enable] the following required APIs in the project that hosts your {product-title} cluster:
3030
+
3131
.Required API services
32-
[cols="2a,3a",options="header"]
32+
[cols="2a,3a,3a",options="header"]
3333

3434
|===
3535

36-
|API service |Console service name
36+
|API service |Console service name |Purpose
3737

38-
|link:https://console.cloud.google.com/apis/library/deploymentmanager.googleapis.com?pli=1&project=openshift-gce-devel&folder=&organizationId=[Cloud Deployment Manager V2 API]
38+
|link:https://cloud.google.com/deployment-manager/docs/apis#google-cloud-deployment-manager-v2-api[Cloud Deployment Manager V2 API]
3939
|`deploymentmanager.googleapis.com`
40+
|Used for automated deployment and management of infrastructure resources.
4041

41-
|link:https://console.cloud.google.com/apis/library/compute.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Compute Engine API]
42+
|link:https://cloud.google.com/compute/docs/reference/rest/v1[Compute Engine API]
4243
|`compute.googleapis.com`
44+
|Used for creating and managing virtual machines, firewalls, networks, persistent disk volumes, and load balancers.
4345

44-
|link:https://console.cloud.google.com/apis/library/cloudapis.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Google Cloud APIs]
45-
|`cloudapis.googleapis.com`
46+
// |link:https://cloud.google.com/apis/docs/overview[Google Cloud APIs]
47+
// |`cloudapis.googleapis.com`
48+
// |
4649

47-
|link:https://console.cloud.google.com/apis/library/cloudresourcemanager.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Cloud Resource Manager API]
50+
|link:https://cloud.google.com/resource-manager/reference/rest[Cloud Resource Manager API]
4851
|`cloudresourcemanager.googleapis.com`
52+
|Used for getting projects, getting or setting an IAM policy for projects, validating required permissions, and tagging.
4953

50-
|link:https://console.cloud.google.com/apis/library/dns.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Google DNS API]
54+
|link:https://cloud.google.com/dns/docs/reference/rest/v1[Cloud DNS API]
5155
|`dns.googleapis.com`
56+
|Used for creating DNS zones and managing DNS records for the cluster domains.
5257

53-
|link:https://console.cloud.google.com/apis/library/networksecurity.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Network Security API]
54-
|`networksecurity.googleapis.com`
58+
// |link:https://cloud.google.com/firewall/docs/reference/network-security/rest[Network Security API]
59+
// |`networksecurity.googleapis.com`
60+
// |Purpose
5561

56-
|link:https://console.cloud.google.com/apis/library/iamcredentials.googleapis.com[IAM Service Account Credentials API]
62+
|link:https://cloud.google.com/iam/docs/reference/credentials/rest[IAM Service Account Credentials API]
5763
|`iamcredentials.googleapis.com`
64+
|Used for creating short-lived credentials for impersonating IAM service accounts.
5865

59-
|link:https://console.cloud.google.com/apis/library/iam.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Identity and Access Management (IAM) API]
66+
|link:https://cloud.google.com/iam/docs/reference/rest[Identity and Access Management (IAM) API]
6067
|`iam.googleapis.com`
68+
|Used for managing the IAM configuration for the cluster.
6169

62-
|link:https://console.cloud.google.com/apis/library/servicemanagement.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Service Management API]
70+
|link:https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest[Service Management API]
6371
|`servicemanagement.googleapis.com`
72+
|Used indirectly to fetch quota information for GCP resources.
6473

65-
|link:https://console.cloud.google.com/apis/library/serviceusage.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Service Usage API]
74+
|link:https://cloud.google.com/service-usage/docs/reference/rest[Service Usage API]
6675
|`serviceusage.googleapis.com`
76+
|Used for determining what services are available in the customer’s Google Cloud account.
6777

68-
|link:https://console.cloud.google.com/apis/library/storage-api.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Google Cloud Storage JSON API]
78+
|link:https://cloud.google.com/storage/docs/json_api[Cloud Storage JSON API]
6979
|`storage-api.googleapis.com`
80+
|Used for accessing Cloud Storage for the image registry, ignition, and cluster backups (if applicable).
7081

71-
|link:https://console.cloud.google.com/apis/library/storage-component.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Cloud Storage]
82+
|link:https://cloud.google.com/storage/docs/apis[Cloud Storage]
7283
|`storage-component.googleapis.com`
84+
|Used for managing Cloud Storage for the image registry, ignition, and cluster backups (if applicable).
7385

74-
|link:https://console.cloud.google.com/apis/library/orgpolicy.googleapis.com?project=openshift-gce-devel&folder=&organizationId=[Organization Policy API]
86+
|link:https://cloud.google.com/resource-manager/docs/reference/orgpolicy/rest[Organization Policy API]
7587
|`orgpolicy.googleapis.com`
88+
|Used to identify governance rules applied to customer’s Google Cloud that might impact cluster creation or management.
7689

77-
|link:https://console.cloud.google.com/marketplace/product/google/iap.googleapis.com?q=search&referrer=search&hl=en&project=openshift-gce-devel[Cloud Identity-Aware Proxy API]
90+
|link:https://cloud.google.com/iap/docs/reference/rest[Cloud Identity-Aware Proxy API]
7891
|`iap.googleapis.com` ^[*]^
92+
|Used in emergency situations to troubleshoot cluster nodes that are otherwise inaccessible.
7993

80-
|===
94+
This API is required for clusters deployed with Private Service Connect.
8195

82-
+
83-
[.small]
84-
--
85-
*Required for clusters deployed with Private Service Connect.
86-
--
96+
|===
8797

8898

8999
. To ensure that Red Hat can perform necessary actions, you must create an `osd-ccs-admin` IAM link:https://cloud.google.com/iam/docs/creating-managing-service-accounts#creating_a_service_account[service account] user within the GCP project.

0 commit comments

Comments
 (0)