Skip to content

Commit 675fe3c

Browse files
committed
Testing CQA bot
1 parent 2540074 commit 675fe3c

20 files changed

Lines changed: 207 additions & 60 deletions

cloud_experts_osd_tutorials/cloud-experts-osd-create-new-limit-egress.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
88
toc::[]
99

1010
[role="_abstract"]
11-
Use this guide to implement egress restrictions for {product-title} on {GCP} by using {GCP}'s Next Generation Firewall (NGFW). NGFW is a fully distributed firewall service that allows fully qualified domain name (FQDN) objects in firewall policy rules. This is necessary for many of the external endpoints that {product-title} relies on.
11+
Implement egress restrictions for {product-title} on {GCP} by using Next Generation Firewall (NGFW), which allows fully qualified domain name (FQDN)-based firewall rules required for {product-title} external endpoints.
1212

1313
include::modules/cloud-experts-osd-limit-egress-ngfw-prereqs.adoc[leveloffset=+1]
1414

@@ -28,5 +28,4 @@ include::modules/cloud-experts-osd-limit-egress-ngfw-create-osd-gcp-cluster.adoc
2828

2929
include::modules/cloud-experts-osd-limit-egress-ngfw-delete-osd-gcp-cluster.adoc[leveloffset=+1]
3030

31-
include::modules/cloud-experts-osd-limit-egress-ngfw-clean-resources.adoc[leveloffset=+1]
32-
31+
include::modules/cloud-experts-osd-limit-egress-ngfw-clean-resources.adoc[leveloffset=+1]

cloud_experts_osd_tutorials/cloud-experts-osd-update-component-routes.adoc

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,29 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
88
toc::[]
99

1010
[role="_abstract"]
11-
This guide demonstrates how to modify the hostname and TLS certificate of the Web console, OAuth server, and Downloads component routes in {product-title} on {GCP} version 4.14 and above.{fn-supported-versions}
12-
13-
The changes that we make to the component routes{fn-term-component-routes} in this guide are described in greater detail in the link:https://docs.openshift.com/container-platform/latest/authentication/configuring-internal-oauth.html#customizing-the-oauth-server-url_configuring-internal-oauth[Customing the internal OAuth server URL], link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/web_console/customizing-web-console#customizing-the-console-route_customizing-web-console[Customing the console route], and link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/web_console/customizing-web-console#customizing-the-download-route_customizing-web-console[Customing the download route] {product-title} documentation.
14-
15-
[id="prerequisites_{context}"]
16-
== Prerequisites
17-
* OCM CLI (`ocm`) version 1.0.5 or higher
18-
* gcloud CLI (`gcloud`)
19-
* An {product-title} on {GCP} cluster version 4.14 or higher
20-
// +
21-
// [NOTE]
22-
// ====
23-
// ROSA with HCP is not supported at this time.
24-
// ====
25-
// +
26-
* {oc-first}
27-
* `jq` CLI
28-
* Access to the cluster as a user with the `cluster-admin` role.
29-
* OpenSSL (for generating the demonstration SSL/TLS certificates)
11+
Modify the hostname and TLS certificate of the Web console, OAuth server, and Downloads component routes in {product-title} on {GCP} version 4.14 and above.{fn-supported-versions}
12+
13+
include::modules/cloud-experts-osd-update-component-routes-prereqs.adoc[leveloffset=+1]
3014

3115
include::modules/cloud-experts-osd-update-component-routes-environment-setup.adoc[leveloffset=+1]
16+
3217
include::modules/cloud-experts-osd-update-component-routes-find-current-component-routes.adoc[leveloffset=+1]
18+
3319
include::modules/cloud-experts-osd-update-component-routes-create-tls-certificates.adoc[leveloffset=+1]
20+
3421
include::modules/cloud-experts-osd-update-component-routes-add-certificates-as-secrets.adoc[leveloffset=+1]
22+
3523
include::modules/cloud-experts-osd-update-component-routes-find-lb-hostname.adoc[leveloffset=+1]
24+
3625
include::modules/cloud-experts-osd-update-component-routes-add-component-routes-to-dns.adoc[leveloffset=+1]
26+
3727
include::modules/cloud-experts-osd-update-component-routes-tls-using-ocm-cli.adoc[leveloffset=+1]
38-
include::modules/cloud-experts-osd-update-component-routes-reset-component-routes-to-default.adoc[leveloffset=+1]
28+
29+
include::modules/cloud-experts-osd-update-component-routes-reset-component-routes-to-default.adoc[leveloffset=+1]
30+
31+
[role="cloud-experts-osd-update-component-routes-additional-resources"]
32+
== Additional resources
33+
34+
* link:https://docs.openshift.com/container-platform/latest/authentication/configuring-internal-oauth.html#customizing-the-oauth-server-url_configuring-internal-oauth[Customizing the internal OAuth server URL]
35+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/web_console/customizing-web-console#customizing-the-console-route_customizing-web-console[Customizing the console route]
36+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/web_console/customizing-web-console#customizing-the-download-route_customizing-web-console[Customizing the download route]

modules/cloud-experts-osd-limit-egress-ngfw-clean-resources.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Cleaning up resources
88

99
[role="_abstract"]
10-
To prevent ongoing charges, after you delete your cluster you must manually delete the {GCP} networking infrastructure you created as part of this tutorial. Deleting the cluster will not automatically remove these underlying resources. You can clean up these resources using a combination of gcloud CLI commands and actions within the {GCP} console.
10+
Manually delete the {GCP} networking infrastructure after deleting your cluster to prevent ongoing charges. The cluster deletion does not automatically remove VPC networks, subnets, firewall policies, or DNS zones.
1111

1212
Before you begin the process of cleaning up the resources you created for this tutorial, run the following commands and complete any prompts.
1313

@@ -141,3 +141,8 @@ $ gcloud compute networks subnets delete ${prefix}-psc --region=${region}
141141
----
142142
$ gcloud compute networks delete ${prefix}-vpc
143143
----
144+
145+
[role="_additional-resources"]
146+
.Additional resources
147+
148+
* link:https://cloud.google.com/sdk/gcloud/reference[`gcloud` command-line tool reference ({GCP})]

modules/cloud-experts-osd-limit-egress-ngfw-create-a-cloud-router.adoc

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@
77
= Creating a Cloud Router and a Cloud Network Address Translation gateway
88

99
[role="_abstract"]
10-
The Network Address Translation (NAT) gateway enables internet connectivity for your private VMs by masquerading all their traffic under a single public IP address. As the designated exit point, it translates their internal IPs for any outbound requests, such as fetching updates. This process effectively grants them access to the internet without ever exposing their private addresses.
10+
Create a Cloud Router and Network Address Translation (NAT) gateway to enable internet connectivity for private VMs without exposing their internal IP addresses.
1111

1212
.Procedure
1313
. Reserve an IP address for Cloud NAT by running the following command:
1414
+
15-
1615
[source,terminal]
1716
----
1817
$ gcloud compute addresses create ${prefix}-${region}-cloudnatip \
@@ -36,4 +35,21 @@ $ gcloud compute routers nats create ${prefix}-cloudnat-${region} \
3635
--router=${prefix}-router --router-region ${region} \
3736
--nat-all-subnet-ip-ranges \
3837
--nat-external-ip-pool=${prefix}-${region}-cloudnatip
39-
----
38+
----
39+
40+
.Verification
41+
42+
* Verify the Cloud Router and NAT gateway were created by running the following command:
43+
+
44+
[source,terminal]
45+
----
46+
$ gcloud compute routers describe ${prefix}-router --region=${region}
47+
----
48+
+
49+
The output shows the router configuration including the NAT gateway you created.
50+
51+
[role="_additional-resources"]
52+
.Additional resources
53+
54+
* link:https://cloud.google.com/nat/docs/overview[Cloud NAT overview ({GCP})]
55+
* link:https://cloud.google.com/network-connectivity/docs/router[Cloud Router overview ({GCP})]

modules/cloud-experts-osd-limit-egress-ngfw-create-firewall-rules.adoc

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Creating the firewall rules
88

99
[role="_abstract"]
10-
You need to create some firewall rules to allow your cluster to access the Web.
10+
Create firewall rules to allow egress traffic to private IP ranges and required {product-title} domains while blocking unauthorized external access.
1111

1212
.Procedure
1313
. Create a blanket allow rule for private IP (RFC 1918) address space by running the following command:
@@ -43,4 +43,21 @@ $ gcloud compute network-firewall-policies rules create 600 \
4343
[IMPORTANT]
4444
====
4545
If there is not a matching rule that allows the traffic, it will be blocked by the firewall. To allow access to other resources, such as internal networks or other external endpoints, create additional rules with a priority of less than 1000. For more information on how to create firewall rules, see link:https://cloud.google.com/firewall/docs/use-network-firewall-policies[Use global network firewall policies and rules].
46-
====
46+
====
47+
48+
.Verification
49+
50+
* Verify the firewall rules were created by running the following command:
51+
+
52+
[source,terminal]
53+
----
54+
$ gcloud compute network-firewall-policies rules list --firewall-policy=${prefix} --global-firewall-policy
55+
----
56+
+
57+
The output shows the two rules you created with priorities 500 and 600.
58+
59+
[role="_additional-resources"]
60+
.Additional resources
61+
62+
* link:https://cloud.google.com/firewall/docs/firewalls[VPC firewall rules overview ({GCP})]
63+
* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/preparing_your_cloud_provider_infrastructure/cloud-experts-configuring-your-gcp-project-osd#osd-aws-privatelink-firewall-prerequisites_cloud-experts-configuring-your-gcp-project-osd[Firewall prerequisites for {GCP}]

modules/cloud-experts-osd-limit-egress-ngfw-create-osd-gcp-cluster.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44

55
:_mod-docs-content-type: REFERENCE
66
[id="cloud-experts-osd-limit-egress-ngfw-create-osd-gcp-cluster_{context}"]
7-
= Creating your cluster
7+
= Cluster creation
88

99
[role="_abstract"]
10-
You are now ready to create your {product-title} on {GCP} cluster. For more information, see link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/openshift_dedicated_clusters_on_google_cloud/osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on {GCP} with Workload Identity Federation authentication].
10+
Create your {product-title} cluster on {GCP} using the configured VPC network and subnets with egress firewall restrictions.
11+
12+
[role="_additional-resources"]
13+
.Additional resources
14+
* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/openshift_dedicated_clusters_on_google_cloud/osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on {GCP} with Workload Identity Federation authentication]

modules/cloud-experts-osd-limit-egress-ngfw-create-private-dns.adoc

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Creating private Domain Name System records for Private Google Access
88

99
[role="_abstract"]
10-
The private Domain Name System (DNS) zone optimizes how your resources connect to Google APIs by ensuring traffic never travels over the public internet. It functions by intercepting DNS requests for Google services and resolving them to private IP addresses, forcing the connection onto Google's internal network for a faster, more secure data exchange.
10+
Create a private Domain Name System (DNS) zone to route Google API traffic through Google's internal network for faster and more secure connections.
1111

1212
.Procedure
1313
. Create a private DNS zone for the googleapis.com domain by running the following command:
@@ -56,3 +56,20 @@ $ gcloud dns record-sets transaction add 199.36.153.4 199.36.153.5 199.36.153.6
5656
$ gcloud dns record-sets transaction execute \
5757
--zone=$prefix-googleapis
5858
----
59+
60+
.Verification
61+
62+
* Verify the private DNS zone and records were created by running the following command:
63+
+
64+
[source,terminal]
65+
----
66+
$ gcloud dns record-sets list --zone=${prefix}-googleapis
67+
----
68+
+
69+
The output shows the DNS zone with CNAME and A records for googleapis.com.
70+
71+
[role="_additional-resources"]
72+
.Additional resources
73+
74+
* link:https://cloud.google.com/vpc/docs/configure-private-google-access[Configure Private Google Access ({GCP})]
75+
* link:https://cloud.google.com/dns/docs/zones[DNS zones overview ({GCP})]

modules/cloud-experts-osd-limit-egress-ngfw-create-subnets.adoc

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Creating the VPC and subnets
88

99
[role="_abstract"]
10-
Before you can deploy a {GCP} NGFW, you must first create the Virtual Private Cloud (VPC) and subnets that you will use for {product-title}:
10+
Create the Virtual Private Cloud (VPC) and subnets required for deploying {GCP} Next Generation Firewall (NGFW) with {product-title}.
1111

1212
.Procedure
1313
. Create the VPC by running the following command:
@@ -52,4 +52,21 @@ $ gcloud compute networks subnets create ${prefix}-psc \
5252

5353
----
5454
+
55-
These examples use the subnet ranges of 10.0.2.0/23 for the worker subnet, 10.0.0.0/25 for the control plane subnet, and 10.0.0.128/29 for the PSC subnet. Modify the parameters to meet your needs. Ensure the parameter values are contained within the machine CIDR you set earlier in this tutorial.
55+
These examples use the subnet ranges of 10.0.2.0/23 for the worker subnet, 10.0.0.0/25 for the control plane subnet, and 10.0.0.128/29 for the PSC subnet. Modify the parameters to meet your needs. Ensure the parameter values are contained within the machine CIDR you set earlier in this tutorial.
56+
57+
.Verification
58+
59+
* Verify the VPC and subnets were created by running the following command:
60+
+
61+
[source,terminal]
62+
----
63+
$ gcloud compute networks subnets list --network=${prefix}-vpc
64+
----
65+
+
66+
The output shows the three subnets you created with their IP ranges and regions.
67+
68+
[role="_additional-resources"]
69+
.Additional resources
70+
71+
* link:https://cloud.google.com/vpc/docs/create-modify-vpc-networks[Create and manage VPC networks ({GCP})]
72+
* link:https://cloud.google.com/vpc/docs/subnets[Subnets overview ({GCP})]

modules/cloud-experts-osd-limit-egress-ngfw-delete-osd-gcp-cluster.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44

55
:_mod-docs-content-type: REFERENCE
66
[id="cloud-experts-osd-limit-egress-ngfw-delete-osd-gcp-cluster_{context}"]
7-
= Deleting your cluster
7+
= Cluster deletion
88

99
[role="_abstract"]
10-
To delete your cluster, see link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/openshift_dedicated_clusters_on_google_cloud/osd-deleting-a-cluster[Deleting an OpenShift Dedicated cluster on {GCP}].
10+
Delete your {product-title} cluster from {GCP} when you no longer need it, before cleaning up the network infrastructure.
11+
12+
[role="_additional-resources"]
13+
.Additional resources
14+
* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/openshift_dedicated_clusters_on_google_cloud/osd-deleting-a-cluster[Deleting an OpenShift Dedicated cluster on {GCP}]

modules/cloud-experts-osd-limit-egress-ngfw-deploy-policy.adoc

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Deploying a global network firewall policy
88

99
[role="_abstract"]
10-
You can use the `gcloud` CLI tool to create network firewall policies for your cluster.
10+
Create global network firewall policies to control egress traffic from your {product-title} cluster and associate them with your VPC network.
1111

1212
.Procedure
1313
. Create a global network firewall policy by running the following command:
@@ -28,4 +28,21 @@ $ gcloud compute network-firewall-policies associations create \
2828
--firewall-policy ${prefix} \
2929
--network ${prefix}-vpc \
3030
--global-firewall-policy
31-
----
31+
----
32+
33+
.Verification
34+
35+
* Verify the firewall policy was created and associated by running the following command:
36+
+
37+
[source,terminal]
38+
----
39+
$ gcloud compute network-firewall-policies describe ${prefix} --global
40+
----
41+
+
42+
The output shows the firewall policy configuration and its association with your VPC.
43+
44+
[role="_additional-resources"]
45+
.Additional resources
46+
47+
* link:https://cloud.google.com/firewall/docs/about-firewalls[Firewall overview ({GCP})]
48+
* link:https://cloud.google.com/firewall/docs/use-network-firewall-policies[Use global network firewall policies and rules ({GCP})]

0 commit comments

Comments
 (0)