Skip to content

Commit e82d449

Browse files
authored
Merge pull request #95782 from openshift-cherrypick-robot/cherry-pick-95762-to-enterprise-4.19
[enterprise-4.19] OSDOCS-15190: Updated the name of Egress Lockdown to Egress Zero.
2 parents 79c0d82 + dc20d55 commit e82d449

13 files changed

+49
-65
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
// common attributes
2-
:product-short-name: OpenShift Dedicated
1+
// General Service Delivery Attributes attributes
32
:toc:
43
:toc-title:
54
:experimental:
65
:imagesdir: images
76
:OCP: OpenShift Container Platform
87
:OCP-short: OpenShift
9-
:ocp-version: 4.14
8+
:ocp-version: 4.19
109
:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
1110
:oc-first: pass:quotes[OpenShift CLI (`oc`)]
1211
:cluster-manager-first: Red Hat OpenShift Cluster Manager
@@ -37,7 +36,7 @@
3736
:es-op: OpenShift Elasticsearch Operator
3837
:logging-sd: Red Hat OpenShift Logging
3938
:log-plug: logging Console Plugin
40-
//
39+
//Serverless
4140
:ServerlessProductName: OpenShift Serverless
4241
:rh-openstack-first: Red Hat OpenStack Platform (RHOSP)
4342
:rh-openstack: RHOSP
@@ -49,20 +48,17 @@
4948
//Formerly known as CodeReady Containers and CodeReady Workspaces
5049
:openshift-local-productname: Red Hat OpenShift Local
5150
:openshift-dev-spaces-productname: Red Hat OpenShift Dev Spaces
51+
// ROSA with HCP specific attributes
52+
:product-title-short: ROSA with HCP
53+
:dedicated: OpenShift Dedicated
5254
:hcp: hosted control planes
55+
:hcp-title-first: Red Hat OpenShift Service on AWS (ROSA) with hosted control planes (HCP)
5356
:hcp-title: ROSA with HCP
54-
:hcp-title-first: {product-title} (ROSA) with {hcp} (HCP)
55-
:rosa-classic: ROSA (classic architecture)
56-
:rosa-classic-first: {product-title} (ROSA) (classic architecture)
57-
:egress-lockdown: {hcp-title} clusters with zero egress
58-
//ROSA CLI variables
59-
:zero-egress: zero egress
60-
//unclear whether this is going to be zero egress or egress lockdown
61-
// ROSA specific
62-
:rosa-first: Red{nbsp}Hat OpenShift Service on AWS (ROSA) with {hcp} (HCP)
63-
:rosa-short: ROSA with HCP
64-
:rosa-classic-first: {product-title} (ROSA) (classic architecture)
65-
:rosa-classic: Red{nbsp}Hat OpenShift Service on AWS (classic architecture)
57+
:rosa-classic-title: Red Hat OpenShift Service on AWS (classic architecture)
6658
:rosa-classic-short: ROSA (classic)
59+
:rosa-title: Red Hat OpenShift Service on AWS (ROSA) with hosted control planes (HCP)
60+
:rosa-short: ROSA with HCP
61+
:egress-zero: egress zero
62+
:egress-zero-title: {rosa-short} clusters with {egress-zero}
6763
:classic: {rosa-classic}
6864
:classic-short: {rosa-classic-short}

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -265,9 +265,8 @@ Topics:
265265
File: rosa-hcp-creating-cluster-with-aws-kms-key
266266
- Name: Creating a private cluster on ROSA with HCP
267267
File: rosa-hcp-aws-private-creating-cluster
268-
# Note the following title should use the same term as the {zero-egress} parameter does
269-
- Name: Creating a ROSA with HCP cluster with egress lockdown
270-
File: rosa-hcp-egress-lockdown-install
268+
- Name: Creating ROSA with HCP clusters with egress zero
269+
File: rosa-hcp-egress-zero-install
271270
- Name: Creating a ROSA with HCP cluster that uses direct authentication with an external OIDC identity provider
272271
File: rosa-hcp-sts-creating-a-cluster-ext-auth
273272
- Name: Creating ROSA with HCP clusters without a CNI plugin

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,9 +194,8 @@ Topics:
194194
File: rosa-hcp-creating-cluster-with-aws-kms-key
195195
- Name: Creating a private cluster on ROSA with HCP
196196
File: rosa-hcp-aws-private-creating-cluster
197-
# Note the following title should use the same term as the {zero-egress} parameter does
198-
- Name: Creating a ROSA with HCP cluster with egress lockdown
199-
File: rosa-hcp-egress-lockdown-install
197+
- Name: Creating ROSA with HCP clusters with egress zero
198+
File: rosa-hcp-egress-zero-install
200199
- Name: Creating a ROSA with HCP cluster that uses direct authentication with an external OIDC identity provider
201200
File: rosa-hcp-sts-creating-a-cluster-ext-auth
202201
---

modules/rosa-hcp-create-network.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_hcp/rosa-hcp-creating-cluster-with-aws-kms-key.adoc
4-
// * rosa_hcp/rosa-hcp-egress-lockdown-install.adoc
4+
// * rosa_hcp/rosa-hcp-egress-zero-install.adoc
55
// * rosa_hcp/rosa-hcp-quickstart-guide.adoc
66
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
77

8-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
8+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
99
:rosa-egress-lockdown:
1010
endif::[]
1111
:_mod-docs-content-type: PROCEDURE
@@ -433,6 +433,6 @@ TAGS kubernetes.io/role/elb <subnet_id> subnet 1
433433
* link:https://github.com/openshift/rosa/blob/master/cmd/create/network/templates/rosa-quickstart-default-vpc/cloudformation.yaml[Default VPC AWS CloudFormation template]
434434
endif::rosa-egress-lockdown[]
435435
436-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
436+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
437437
:!rosa-egress-lockdown:
438438
endif::[]

modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
44

55

6-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
6+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
77
:egress-lockdown:
88
endif::[]
99

@@ -70,6 +70,6 @@ ManagedOpenShift
7070

7171
For more information regarding AWS managed IAM policies for ROSA, see link:https://docs.aws.amazon.com/ROSA/latest/userguide/security-iam-awsmanpol.html[AWS managed IAM policies for ROSA].
7272

73-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
73+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
7474
:!egress-lockdown:
7575
endif::[]

modules/rosa-hcp-set-environment-variables.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// Module included in the following assemblies:
22
//
3-
// * rosa_hcp/rosa-hcp-egress-lockdown-install.adoc
3+
// * rosa_hcp/rosa-hcp-egress-zero-install.adoc
44

5-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
5+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
66
:rosa-egress-lockdown-install:
77
endif::[]
88

@@ -66,6 +66,6 @@ ifdef::rosa-egress-lockdown-install[]
6666
|===
6767
endif::rosa-egress-lockdown-install[]
6868

69-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
69+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
7070
:!rosa-egress-lockdown-install:
7171
endif::[]

modules/rosa-hcp-sts-creating-a-cluster-egress-lockdown-cli.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * rosa_hcp/rosa-hcp-disconnected-install.adoc
3+
// * rosa_hcp/rosa-hcp-egress-zero-install.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="rosa-hcp-sts-creating-a-cluster-egress-lockdown-cli_{context}"]
7-
= Creating a {hcp-title} cluster with egress lockdown using the CLI
7+
= Creating {egress-zero-title} using the CLI
88

99
When using the {product-title} (ROSA) command-line interface (CLI), `rosa`, to create a cluster, you can select the default options to create the cluster quickly.
1010

@@ -53,7 +53,7 @@ If you specified custom ARN paths when you created the associated account-wide r
5353
<3> If your billing account is different from your user account, add this argument and specify the AWS account that is responsible for all billing.
5454
--
5555
56-
* If you set the environment variables, create a cluster with egress lockdown that has a single, initial machine pool, using a privately available API, and a privately available Ingress by running the following command:
56+
* If you set the environment variables, create a cluster with {egress-zero} that has a single, initial machine pool, using a privately available API, and a privately available Ingress by running the following command:
5757
+
5858
[source,terminal]
5959
----

modules/rosa-hcp-vpc-manual.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
44

5-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
5+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
66
:rosa-egress-lockdown:
77
endif::[]
88

@@ -74,6 +74,6 @@ TAGS kubernetes.io/role/elb <subnet_id> subnet 1
7474
----
7575
endif::rosa-egress-lockdown[]
7676
77-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
77+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
7878
:!rosa-egress-lockdown:
7979
endif::[]

modules/rosa-hcp-vpc-terraform.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
44

5-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
5+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
66
:rosa-egress-lockdown:
77
endif::[]
88

@@ -188,6 +188,6 @@ TAGS kubernetes.io/role/elb <subnet_id> subnet 1
188188
* link:https://github.com/openshift-cs/terraform-vpc-example[Terraform VPC example]
189189
endif::rosa-egress-lockdown[]
190190
191-
ifeval::["{context}" == "rosa-hcp-egress-lockdown-install"]
191+
ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
192192
:!rosa-egress-lockdown:
193193
endif::[]

rosa_hcp/rosa-hcp-egress-lockdown-install.adoc renamed to rosa_hcp/rosa-hcp-egress-zero-install.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="rosa-hcp-egress-lockdown-install"]
3-
= Creating a {product-title} cluster with egress lockdown
2+
[id="rosa-hcp-egress-zero-install"]
3+
= Creating {egress-zero-title}
44
include::_attributes/attributes-openshift-dedicated.adoc[]
5-
:context: rosa-hcp-egress-lockdown-install
5+
:context: rosa-hcp-egress-zero-install
66
toc::[]
77

8-
Creating a {product-title} (ROSA) cluster with egress lockdown provides a way to enhance your cluster's stability and security by allowing your cluster to use the image registry in the local region if the cluster cannot access the internet. Your cluster first tries to pull the images from Quay, and when they aren't reached, it instead pulls the images from the image registry in the local region.
8+
Creating {egress-zero-title} provides a way to enhance your cluster's stability and security by allowing your cluster to use the image registry in the local region if the cluster cannot access the internet. Your cluster first tries to pull the images from Quay, and when they aren't reached, it instead pulls the images from the image registry in the local region.
99

10-
All public and private clusters with egress lockdown get their Red{nbsp}Hat container images from an Amazon Elastic Container Registry (ECR) located in the local region of the cluster instead of gathering these images from various endpoints and registries on the internet. ECR provides storage for OpenShift release images as well as Red{nbsp}Hat Operators. All requests for ECR are kept within your AWS network by serving them over a VPC endpoint within your cluster.
10+
All public and private clusters with {egress-zero} get their Red{nbsp}Hat container images from an Amazon Elastic Container Registry (ECR) located in the local region of the cluster instead of gathering these images from various endpoints and registries on the internet. ECR provides storage for OpenShift release images as well as Red{nbsp}Hat Operators. All requests for ECR are kept within your AWS network by serving them over a VPC endpoint within your cluster.
1111

12-
ROSA clusters with egress lockdown use AWS ECR to provision ROSA with HCP clusters without the need for public internet. Because necessary cluster lifecycle processes occur over AWS private networking, AWS ECR serves as a critical service for core cluster platform images. For more information on AWS ECR, see link:https://aws.amazon.com/ecr/[Amazon Elastic Container Registry].
12+
{egress-zero-title} use AWS ECR to provision your clusters without the need for public internet. Because necessary cluster lifecycle processes occur over AWS private networking, AWS ECR serves as a critical service for core cluster platform images. For more information on AWS ECR, see link:https://aws.amazon.com/ecr/[Amazon Elastic Container Registry].
1313

1414
You can create a fully operational cluster that does not require a public egress by configuring a virtual private cloud (VPC) and using the `--properties zero_egress:true` flag when creating your cluster.
1515

16-
See xref:../upgrading/rosa-hcp-upgrading.adoc#rosa-hcp-upgrading[Upgrading {product-title} clusters] to upgrade clusters using egress lockdown.
16+
See xref:../upgrading/rosa-hcp-upgrading.adoc#rosa-hcp-upgrading[Upgrading {product-title} clusters] to upgrade clusters using {egress-zero}.
1717

1818
[NOTE]
1919
====
20-
Clusters created in restricted network environments may be unable to use certain ROSA features including Red Hat Insights and Telemetry. These clusters may also experience potential failures for workloads that require public access to registries such as `quay.io`. When using clusters installed with egress lockdown, you can also install Red Hat-owned Operators from OperatorHub. For a complete list of Red Hat-owned Operators, see the link:https://catalog.redhat.com/search?searchType=software&target_platforms=Red%20Hat%20OpenShift&deployed_as=Operator&p=1&partnerName=Red%20Hat%2C%20Inc.%7CRed%20Hat[Red{nbsp}Hat Ecosystem Catalog]. Only the default Operator channel is mirrored for any Operator that is installed in egress lockdown.
20+
Clusters created in restricted network environments may be unable to use certain ROSA features including Red Hat Insights and Telemetry. These clusters may also experience potential failures for workloads that require public access to registries such as `quay.io`. When using clusters installed with {egress-zero}, you can also install Red Hat-owned Operators from OperatorHub. For a complete list of Red Hat-owned Operators, see the link:https://catalog.redhat.com/search?searchType=software&target_platforms=Red%20Hat%20OpenShift&deployed_as=Operator&p=1&partnerName=Red%20Hat%2C%20Inc.%7CRed%20Hat[Red{nbsp}Hat Ecosystem Catalog]. Only the default Operator channel is mirrored for any Operator that is installed with {egress-zero}.
2121
====
2222

2323
[discrete]
@@ -62,14 +62,14 @@ A physical connection might exist between machines on the internal network and a
6262

6363
[IMPORTANT]
6464
====
65-
* You can use egress lockdown on all supported versions of {product-title} that use the hosted control plane architecture; however, Red{nbsp}Hat suggests using the latest available z-stream release for each {ocp} version.
65+
* You can use {egress-zero} on all supported versions of {product-title} that use the hosted control plane architecture; however, Red{nbsp}Hat suggests using the latest available z-stream release for each {ocp} version.
6666
67-
* While you may install and upgrade your clusters as you would a regular cluster, due to an upstream issue with how the internal image registry functions in disconnected environments, your cluster that uses egress lockdown will not be able to fully use all platform components, such as the image registry. You can restore these features by using the latest ROSA version when upgrading or installing your cluster.
67+
* While you may install and upgrade your clusters as you would a regular cluster, due to an upstream issue with how the internal image registry functions in disconnected environments, your cluster that uses {egress-zero} will not be able to fully use all platform components, such as the image registry. You can restore these features by using the latest ROSA version when upgrading or installing your cluster.
6868
====
6969

7070
include::modules/rosa-hcp-set-environment-variables.adoc[leveloffset=+1]
7171

72-
[id="rosa-hcp-egress-lockdown-install-creating_{context}"]
72+
[id="rosa-hcp-egress-zero-install-creating_{context}"]
7373
== Creating a Virtual Private Cloud for your {hcp-title} clusters
7474

7575
You must have a Virtual Private Cloud (VPC) to create a {hcp-title} cluster. To pull images from the local ECR mirror over your VPC endpoint, you must configure a privatelink service connection and modify the default security groups with specific tags. Use one of the following methods to create a VPC:
@@ -97,7 +97,7 @@ include::snippets/vpc-troubleshooting.adoc[leveloffset=+2]
9797
* link:https://docs.aws.amazon.com/vpc/latest/userguide/vpc-getting-started.html[Get Started with Amazon VPC]
9898
* link:https://developer.hashicorp.com/terraform[HashiCorp Terraform documentation]
9999
* link:https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/deploy/subnet_discovery/[Subnet Auto Discovery]
100-
* link:https://github.com/openshift-cs/terraform-vpc-example/tree/main/zero-egress[Zero Egress Terraform VPC Example]
100+
* link:https://github.com/openshift-cs/terraform-vpc-example/tree/main/zero-egress[Egress zero Terraform VPC Example]
101101

102102
include::modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+1]
103103

0 commit comments

Comments
 (0)