Skip to content

Commit 095944e

Browse files
committed
OSDOCS-12754:Restructuring PSC and WIF guides from procedural to concept subsections.
1 parent a17e59c commit 095944e

9 files changed

+55
-35
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,10 @@ Name: Installing, accessing, and deleting OpenShift Dedicated clusters
121121
Dir: osd_install_access_delete_cluster
122122
Distros: openshift-dedicated
123123
Topics:
124+
- Name: Private Service Connect overview
125+
File: creating-a-gcp-psc-enabled-private-cluster
124126
- Name: Creating a cluster on GCP with Workload Identity Federation
125127
File: creating-a-gcp-cluster-with-workload-identity-federation
126-
- Name: Creating a GCP Private Service Connect enabled private cluster
127-
File: creating-a-gcp-psc-enabled-private-cluster
128128
- Name: Creating a cluster on GCP
129129
File: creating-a-gcp-cluster
130130
#- Name: Creating a cluster on GCP with a Red Hat cloud account

architecture/osd-architecture-models-gcp.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,18 @@ toc::[]
99
With {product-title} on {GCP}, you can create clusters that are accessible over public or private networks.
1010

1111
include::modules/osd-gcp-architecture.adoc[leveloffset=+1]
12-
include::modules/private-service-connect-overview.adoc[leveloffset=+2]
13-
include::modules/osd-private-psc-architecture-model-gcp.adoc[leveloffset=+2]
14-
include::modules/osd-private-architecture-model-gcp.adoc[leveloffset=+2]
15-
include::modules/osd-public-architecture-model-gcp.adoc[leveloffset=+2]
12+
include::modules/osd-understanding-private-service-connect.adoc[leveloffset=+1]
13+
include::modules/private-service-connect-psc-architecture.adoc[leveloffset=+2]
14+
include::modules/osd-private-psc-architecture-model-gcp.adoc[leveloffset=+1]
15+
include::modules/osd-private-architecture-model-gcp.adoc[leveloffset=+1]
16+
include::modules/osd-public-architecture-model-gcp.adoc[leveloffset=+1]
1617

1718
[role="_additional-resources"]
1819
[id="osd-architecture-models-additional-resources"]
1920
== Additional resources
2021

21-
* xref:../osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc[Creating a GCP Private Service Connect enabled private cluster]
22+
* xref:../osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc#creating-a-gcp-psc-enabled-private-cluster[Private Service Connect overview]
23+
24+
* xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster-with-workload-identity-federation.adoc#osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on GCP with Workload Identity Federation]
2225

2326

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * osd-architecture-models-gcp.adoc
4+
// * osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc
5+
6+
:_mod-docs-content-type: CONCEPT
7+
[id="osd-understanding-private-service-connect_{context}"]
8+
= Understanding Private Service Connect
9+
10+
Private Service Connect (PSC), a capability of Google Cloud networking, enables private communication between services across different projects or organizations within GCP. Users that implement PSC as part of their network connectivity can deploy {product-title} clusters in a private and secured environment within {GCP} without any public facing cloud resources.
11+
12+
For more information about PSC, see link:https://cloud.google.com/vpc/docs/private-service-connect[Private Service Connect].
13+
14+
[IMPORTANT]
15+
====
16+
PSC is only available on {product-title} version 4.17 and later, and is only supported by the Customer Cloud Subscription (CCS) infrastructure type.
17+
====
18+

modules/private-service-connect-prereqs.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,12 @@ For information about how to create a VPC on {GCP}, see link:https://cloud.googl
2727
2828
In addition to the requirements listed above, clusters configured with the **Service Account authentication type** must grant the `IAP-Secured Tunnel User` role to `osd-ccs-admin` service account.
2929

30-
For more information about the prerequisites that must be completed before deploying an {product-title} on {GCP}, see _Additional resources_.
30+
For more information about the prerequisites that must be completed before deploying an {product-title} on {GCP}, see _Customer Requirements_.
31+
32+
[NOTE]
33+
====
34+
PSC is supported with the Customer Cloud Subscription (CCS) infrastructure type only. To create an {product-title} on {GCP} using PSC, see _Creating a cluster on GCP with Workload Identity Federation_.
35+
====
3136

3237
// [id="prereqs-wif-authentication_{context}"]
3338
// == Requirements when using Workload Identity Federation authentication type
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
11
// Module included in the following assemblies:
22
//
33
// * osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc
4+
// * architecture/osd-architecture-models-gcp.adoc
45

56
:_mod-docs-content-type: CONCEPT
6-
[id="private-service-connect-overview_{context}"]
7-
= Private Service Connect overview
8-
Private Service Connect (PSC), a capability of Google Cloud networking, enables private communication between services across different projects or organizations within GCP. Users that implement PSC as part of their network connectivity can deploy {product-title} clusters in a private and secured environment within {GCP} without any public facing cloud resources.
9-
For more information on PSC, see link:https://cloud.google.com/vpc/docs/private-service-connect[Private Service Connect].
10-
11-
[IMPORTANT]
12-
====
13-
Private Service Connect is supported by the Customer Cloud Subscription (CCS) infrastructure type only.
14-
====
15-
167
[id="psc-architecture_{context}"]
17-
== Private Service Connect architecture
8+
= Private Service Connect architecture
189

1910
The PSC architecture includes producer services and consumer services. Using PSC, the consumers can access producer services privately from inside their VPC network. Similarly, it allows producers to host services in their own separate VPC networks and offer a private connect to their consumers.
2011

@@ -32,3 +23,5 @@ The following image depicts how Red HAT SREs and other internal resources access
3223
3324
.PSC architecture overview
3425
image::psc_arch_2.png[PSC architecture overview]
26+
27+

osd_getting_started/osd-getting-started.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Complete the steps in one of the following sections to deploy {product-title} in
3131

3232
* *Creating a cluster on GCP with CCS*: You can install {product-title} in your own {GCP} account by using the CCS model.
3333

34-
** Red Hat recommends using GCP Workload Identity Federation (WIF) as the authentication type for installing and interacting with the {product-title} cluster deployed on {GCP} because it provides enhanced security. For more details, see xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster-with-workload-identity-federation.adoc[Creating a cluster on GCP with Workload Identity Federation].
34+
** Red Hat recommends using GCP Workload Identity Federation (WIF) as the authentication type for installing and interacting with the {product-title} cluster deployed on {GCP} because it provides enhanced security. For more information, see xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster-with-workload-identity-federation.adoc[Creating a cluster on GCP with Workload Identity Federation].
3535

36-
*** An {product-title} cluster deployed on {GCP} can be created in Private cluster mode, without any cloud resources. In this configuration, Red Hat uses Google Cloud Private Service Connect (PSC) to manage and monitor a cluster to avoid all public ingress network traffic. For more details, see xref:../osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc[Creating a GCP Private Service Connect enabled private cluster].
36+
** Red Hat also recommends creating an {product-title} cluster deployed on {GCP} in Private cluster mode with Private Service Connect (PSC) to manage and monitor a cluster to avoid all public ingress network traffic. For more information, see xref:../osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc#creating-a-gcp-psc-enabled-private-cluster[Private Service Connect overview].
3737

3838
** For installing and interacting with the {product-title} cluster deployed on the {GCP} using the Service Account authentication type, see xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc#osd-create-gcp-cluster-ccs_osd-creating-a-cluster-on-gcp[Creating a cluster on GCP].
3939

osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ include::modules/osd-create-cluster-red-hat-account.adoc[leveloffset=+1]
2929

3030
* For information about Workload Identity Federation, see xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster-with-workload-identity-federation.adoc#osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on GCP with Workload Identity Federation].
3131

32-
* For information about Private Service Connect (PSC), see xref:../osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc#private-service-connect-overview_osd-creating-a-gcp-psc-enabled-private-cluster[Private Service Connect overview].
32+
* For information about Private Service Connect (PSC), see xref:../osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc#creating-a-gcp-psc-enabled-private-cluster[Private Service Connect overview].
3333
* For information about configuring a proxy with {product-title}, see xref:../networking/configuring-cluster-wide-proxy.adoc#configuring-a-cluster-wide-proxy[Configuring a cluster-wide proxy].
3434
* For information about persistent storage for {product-title}, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#sdpolicy-storage_osd-service-definition[Storage] section in the {product-title} service definition.
3535
* For information about load balancers for {product-title}, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#load-balancers_osd-service-definition[Load balancers] section in the {product-title} service definition.
3636
* For more information about etcd encryption, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#etcd-encryption_osd-service-definition[etcd encryption service definition].
3737
* For information about the end-of-life dates for {product-title} versions, see the xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
38-
* For general information on Cloud network address translation(NAT) that is required for cluster-wide proxy, see link:https://cloud.google.com/nat/docs/overview[Cloud NAT overview] in the Google documentation.
39-
* For general information on Cloud routers that are required for the cluster-wide proxy, see link:https://cloud.google.com/network-connectivity/docs/router/concepts/overview[Cloud Router overview] in the Google documentation.
40-
* For information on creating VPCs within your Google Cloud Provider account, see link:https://cloud.google.com/vpc/docs/create-modify-vpc-networks[Create and manage VPC networks] in the Google documentation.
38+
* For general information about Cloud network address translation(NAT) that is required for cluster-wide proxy, see link:https://cloud.google.com/nat/docs/overview[Cloud NAT overview] in the Google documentation.
39+
* For general information about Cloud routers that are required for the cluster-wide proxy, see link:https://cloud.google.com/network-connectivity/docs/router/concepts/overview[Cloud Router overview] in the Google documentation.
40+
* For information about creating VPCs within your Google Cloud Provider account, see link:https://cloud.google.com/vpc/docs/create-modify-vpc-networks[Create and manage VPC networks] in the Google documentation.
4141
* For information about configuring identity providers, see xref:../authentication/sd-configuring-identity-providers.adoc#sd-configuring-identity-providers[Configuring identity providers].
4242
* For information about revoking cluster privileges, see xref:../authentication/osd-revoking-cluster-privileges.adoc#osd-revoking-cluster-privileges[Revoking privileges and access to an {product-title} cluster].
Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="osd-creating-a-gcp-psc"]
3-
= Creating a GCP Private Service Connect enabled private cluster
2+
[id="creating-a-gcp-psc-enabled-private-cluster"]
3+
= Private Service Connect overview
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: osd-creating-a-gcp-psc-enabled-private-cluster
66

77
toc::[]
88
You can create a private {product-title} cluster on {GCP} using Google Cloud's security-enhanced networking feature Private Service Connect (PSC).
99

10-
include::modules/private-service-connect-overview.adoc[leveloffset=+1]
11-
10+
include::modules/osd-understanding-private-service-connect.adoc[leveloffset=+1]
1211
include::modules/private-service-connect-prereqs.adoc[leveloffset=+1]
12+
include::modules/private-service-connect-psc-architecture.adoc[leveloffset=+1]
1313

14-
include::modules/private-service-connect-create.adoc[leveloffset=+1]
1514

15+
[id="next-steps-psc_{context}"]
16+
== Next steps
17+
* To learn more about {product-title} on {GCP} cluster prerequisites, see xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-requirements_gcp-ccs[Customer Requirements].
1618

17-
[id="additional-resources_{context}"]
18-
== Additional resources
19-
For information on {product-title} on {GCP} cluster prerequisites, see xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-requirements_gcp-ccs[Customer Requirements].
19+
* To configure your firewalls, see xref:../osd_planning/gcp-ccs.adoc#osd-gcp-psc-firewall-prerequisites_gcp-ccs[GCP firewall prerequisites].
2020

21-
For information about configuring your firewalls , see xref:../osd_planning/gcp-ccs.adoc#osd-gcp-psc-firewall-prerequisites_gcp-ccs[GCP firewall prerequisites].
21+
* To create an {product-title} on {GCP} using PSC with the Workload Identity Federation authentication type, see
22+
xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster-with-workload-identity-federation.adoc#osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on GCP with Workload Identity Federation].

osd_whats_new/osd-whats-new.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster-with-workload-i
2828
+
2929
PSC is a capability of Google Cloud networking that enables private communication between services across different GCP projects or organizations. Implementing PSC as part of your network connectivity allows you to deploy OpenShift Dedicated clusters in a private and secured environment within GCP without using any public-facing cloud resources.
3030
+
31-
For more information, see xref:../osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc[Creating a GCP Private Service Connect enabled private cluster].
31+
For more information, see xref:../osd_install_access_delete_cluster/creating-a-gcp-psc-enabled-private-cluster.adoc#creating-a-gcp-psc-enabled-private-cluster[Private Service Connect overview].
3232

3333
[id="osd-q3-2024_{context}"]
3434
=== Q3 2024

0 commit comments

Comments
 (0)