Skip to content

Commit 2fe7b0a

Browse files
jneczyporjneczypor
committed
OSDOCS-9589
1 parent c5848c5 commit 2fe7b0a

File tree

7 files changed

+193
-96
lines changed

7 files changed

+193
-96
lines changed

‎_topic_maps/_topic_map_rosa.yml

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ Distros: openshift-rosa
2828
Topics:
2929
- Name: Welcome
3030
File: index
31+
- Name: Learn more about ROSA with HCP
32+
File: about-hcp
3133
- Name: Legal notice
3234
File: legal-notice
3335
Distros: openshift-rosa

‎modules/rosa-architecture.adoc

+23-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_architecture/rosa_architecture_sub/rosa-architecture-models.adoc
4-
[id="rosa-architecture_{context}"]
5-
= ROSA architecture on public and private networks
64

7-
You can install ROSA using either a public or private network. Configure a private cluster and private network connection during or after the cluster creation process.
8-
Red Hat manages the cluster with limited access through a public network. For more information, see xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-service-definition[ROSA service definition].
5+
[id="rosa-classic-architecture_{context}"]
6+
= ROSA Classic architecture
7+
8+
In {product-rosa} (ROSA) Classic, both the control plane and the worker nodes are deployed in your VPC subnets.
9+
10+
[id="rosa-classic-architecture-networks_{context}"]
11+
== ROSA Classic architecture on public and private networks
12+
13+
With ROSA Classic, you can create clusters that are accessible over public or private networks.
14+
15+
You can customize access patterns for your API server endpoint and Red Hat SRE management in the following ways:
16+
17+
* Public - API server endpoint and application routes are internet-facing.
18+
19+
* Private - API server endpoint and application routes are private. Private ROSA Classic clusters use some public subnets, but no control plane or worker nodes are deployed in public subnets.
20+
21+
* Private with AWS PrivateLink - API server endpoint and application routes are private. Public subnets or NAT gateways are not required in your VPC for egress. ROSA SRE management uses AWS PrivateLink.
22+
23+
The following image depicts the architecture of a ROSA Classic cluster deployed on both public and private networks.
924

1025
.ROSA Classic deployed on public and private networks
1126
image::156_OpenShift_ROSA_Arch_0621_private_public_classic.png[ROSA deployed on public and private networks]
1227

13-
If you are using {hcp-title-first}, you can create your clusters on public and private networks as well. The following images depict the architecture of both public and private networks.
28+
ROSA Classic clusters include infrastructure nodes where OpenShift components such as the ingress controller, image registry, and monitoring are deployed. The infrastructure nodes and the OpenShift components deployed on them are managed by ROSA Service SREs.
1429

15-
.ROSA with HCP deployed on a public network
16-
image::ROSA-HCP-and-ROSA-Classic-public.png[ROSA with HCP deployed on a public network]
30+
The following types of clusters are available with ROSA Classic:
1731

18-
.ROSA with HCP deployed on a private network
19-
image::ROSA-HCP-and-ROSA-Classic-private.png[ROSA with HCP deployed on a private network]
32+
* Single zone cluster - The control plane and worker nodes are hosted on a single availability zone.
2033

21-
Alternatively, you can install a ROSA Classic cluster using AWS PrivateLink, which is hosted on private subnets only.
34+
* Multi-zone cluster - The control plane is hosted on three availability zones with an option to run worker nodes on one or three availability zones.

‎modules/rosa-hcp-architecture.adoc

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_architecture_sub/rosa-architecture-models.adoc
4+
5+
[id="rosa-hcp-architecture_{context}"]
6+
= ROSA with HCP architecture
7+
8+
In {hcp-title-first}, the ROSA service hosts a highly-available, single-tenant OpenShift control plane. The hosted control plane is deployed across 3 availability zones with 2 API server instances and 3 etcd instances.
9+
10+
You can create a ROSA with HCP cluster with or without an internet-facing API server. Private API servers are only accessible from your VPC subnets. You access the hosted control plane through an AWS PrivateLink endpoint.
11+
12+
The worker nodes are deployed in your AWS account and run on your VPC private subnets. You can add additional private subnets from one or more availability zones to ensure high availability. Worker nodes are shared by OpenShift components and applications. OpenShift components such as the ingress controller, image registry, and monitoring are deployed on the worker nodes hosted on your VPC.
13+
14+
[id="rosa-hcp-network-architecture_{context}"]
15+
== ROSA with HCP architecture on public and private networks
16+
With ROSA with HCP, you can create your clusters on public or private networks. The following images depict the architecture of both public and private networks.
17+
18+
.ROSA with HCP deployed on a public network
19+
image::ROSA-HCP-and-ROSA-Classic-public.png[ROSA with HCP deployed on a public network]
20+
21+
.ROSA with HCP deployed on a private network
22+
image::ROSA-HCP-and-ROSA-Classic-private.png[ROSA with HCP deployed on a private network]

‎modules/rosa-hcp-classic-comparison.adoc

+29-78
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,48 @@
11
// Module included in the following assemblies:
22
//
3-
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
3+
// * rosa-architecture-models.adoc
44

55
:_mod-docs-content-type: CONCEPT
66
[id="rosa-hcp-classic-comparison_{context}"]
7-
= Comparing ROSA with hosted control planes and ROSA Classic
8-
9-
{hcp-title-first} offers a different way to create a managed {product-title} (ROSA) cluster. {hcp-title} offers a reduced-cost solution with focuses on reliability and efficiency. With a focus on efficiency, you can quickly create a new cluster and deploy applications in minutes.
10-
11-
{hcp-title} requires only a minimum of two nodes making it ideal for smaller projects while still being able to scale to support larger projects and enterprises.
7+
= Comparing ROSA with HCP and ROSA Classic
128

139
.ROSA architectures comparison table
1410

1511
[cols="3a,8a,8a",options="header"]
1612
|===
1713
| {nbsp} +
18-
| Hosted Control Plane
19-
| Classic
20-
21-
| *Cluster infrastructure hosting*
22-
| {hcp-title} deploys control plane components, such as etcd, API server, and oauth, that are hosted separately on AWS in a Red Hat-owned and managed account.
23-
| ROSA Classic deploys the control plane components side by side with infrastructure and worker nodes that are hosted together in the customer’s same AWS account.
24-
25-
| *Provisioning Time*
26-
| Approximately 10 minutes
27-
| Approximately 40 minutes
14+
| *Hosted Control Plane (HCP)*
15+
| *Classic*
2816

29-
| *Architecture*
30-
|
31-
* Underlying control plane infrastructure is fully managed
32-
* Customer can access control plane infrastructure through dedicated and explicitly exposed endpoints
33-
* Worker nodes are hosted in the customer's AWS account
34-
|
35-
* Customer is responsible for hosting control plane and AWS infrastructure, while still being _managed_ by Red Hat
36-
* Worker nodes are hosted in the customer's AWS account
17+
| *Control plane hosting*
18+
| Control plane components, such as the API server etcd database, are hosted in a Red Hat-owned AWS account.
19+
| Control plane components, such as the API server etcd database, are hosted in a customer-owned AWS account.
3720

38-
| *Minimum Amazon EC2 footprint*
39-
| One cluster requires a minimum of two nodes
40-
| One cluster requires a minimum of seven nodes
21+
| *Virtual Private Cloud (VPC)*
22+
| Worker nodes communicate with the control plane over link:https://docs.aws.amazon.com/vpc/latest/privatelink/what-is-privatelink.html[AWS PrivateLink].
23+
| Worker nodes and control plane nodes are deployed in the customer's VPC.
4124

42-
| *Deployment*
43-
|
44-
* Deploy using the ROSA CLI (`rosa`)
45-
* Customers provision "Hosted Clusters" that deploy the control plane components into Red Hat's AWS account
46-
* Customers provision "Machine Pools" that deploy worker nodes into the customer's AWS account
47-
|
48-
* Deploy using the ROSA CLI or the web UI
49-
* Full cluster provisioning occurs in customer's AWS account
50-
51-
| *Upgrades*
52-
| Selectively upgrade control plane and machine pools separately
53-
| Entire cluster is upgraded at one time
54-
55-
| *Regional Availability*
56-
|
57-
* US East - N. Virginia (us-east-1)
58-
* US East - Ohio (us-east-2)
59-
* US West - Oregon (us-west-2)
60-
* Africa - Cape Town (af-south-1)
61-
* Asia Pacific - Hyderabad (ap-south-2)
62-
* Asia Pacific - Jakarta (ap-southeast-3)
63-
* Asia Pacific - Melbourne (ap-southeast-4)
64-
* Asia Pacific - Mumbai (ap-south-1)
65-
* Asia Pacific - Seoul (ap-northeast-2)
66-
* Asia Pacific - Singapore (ap-southeast-1)
67-
* Asia Pacific - Sydney (ap-southeast-2)
68-
* Asia Pacific - Tokyo (ap-northeast-1)
69-
* Canada - Central (ca-central-1)
70-
* Europe - Frankfurt (eu-central-1)
71-
* Europe - Ireland (eu-west-1)
72-
* Europe - London (eu-west-2)
73-
* Europe - Milan (eu-south-1)
74-
* Europe - Stockholm (eu-north-1)
75-
* Middle East - Bahrain (me-south-1)
76-
| For AWS Region availability, see link:https://docs.aws.amazon.com/general/latest/gr/rosa.html[Red Hat OpenShift Service on AWS endpoints and quotas] in the AWS documentation.
77-
78-
| *Compliance*
79-
|
80-
* Compliance certifications and FIPS are not yet available.
81-
|
82-
* Compliance specifics are located in the {product-title} documentation.
83-
|===
25+
| *Multi-zone deployment*
26+
| The control plane is always deployed across multiple availability zones (AZs).
27+
| The control plane can be deployed within a single AZ or across multiple AZs.
8428

85-
[id="rosa-hcp-classic-comparison-networks_{context}"]
86-
== ROSA architecture network comparisons
29+
| *Machine pools*
30+
| Each machine pool is deployed in a single AZ (private subnet).
31+
| Machine pools can be deployed in single AZ or across multiple AZs.
8732

88-
ROSA Classic and ROSA with HCP offer options to install your cluster on public and private networks. The following images show the differences between these options.
33+
| *Infrastructure Nodes*
34+
| Does not use any dedicated nodes to host platform components, such as ingress and image registry.
35+
| Uses 2 (single-AZ) or 3 (multi-AZ) dedicated nodes to host platform components.
8936

90-
.ROSA Classic deployed on public and private networks
91-
image::156_OpenShift_ROSA_Arch_0621_private_public_classic.png[ROSA deployed on public and private networks]
37+
| *OpenShift Capabilities*
38+
| Platform monitoring, image registry, and the ingress controller are deployed in the worker nodes.
39+
| Platform monitoring, image registry, and the ingress controller are deployed in the dedicated infrastructure nodes.
9240

93-
.ROSA with HCP deployed on a public network
94-
image::ROSA-HCP-and-ROSA-Classic-public.png[ROSA with HCP deployed on a public network]
41+
| *Cluster upgrades*
42+
| The control plane and each machine pool can be upgraded separately.
43+
| The entire cluster must be upgraded at the same time.
9544

96-
.ROSA with HCP deployed on a private network
97-
image::ROSA-HCP-and-ROSA-Classic-private.png[ROSA with HCP deployed on a private network]
45+
| *Minimum EC2 footprint*
46+
| 2 EC2 instances are needed to create a cluster.
47+
| 7 (single-AZ) or 9 (multi-AZ) EC2 instances are needed to create a cluster.
48+
|===

‎rosa_architecture/rosa_architecture_sub/rosa-architecture-models.adoc

+16-6
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,26 @@
22
[id="rosa-architecture-models"]
33
= Architecture models
44
include::_attributes/attributes-openshift-dedicated.adoc[]
5+
include::_attributes/common-attributes.adoc[]
56
:context: rosa-architecture-models
67

78
toc::[]
89

9-
ROSA has two installation offerings. The architecture supports the following network configuration types:
10+
{product-rosa} (ROSA) has the following cluster topologies:
1011

11-
* Public network
12-
* Private network
13-
* AWS PrivateLink (ROSA Classic only)
12+
* Hosted control plane (HCP) - The control plane is hosted in a Red Hat account and the worker nodes are deployed in the customer's AWS account.
13+
* Classic - The control plane and the worker nodes are deployed in the customer's AWS account.
1414
15+
include::modules/rosa-hcp-classic-comparison.adoc[leveloffset=+1]
16+
17+
.Additional resources
18+
19+
* For AWS region availability, see the xref:../../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-sdpolicy-regions-az_rosa-hcp-service-definition[{hcp-title} regions and availability zones].
20+
21+
* For compliance status, see the xref:../../rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc#rosa-policy-compliance_rosa-policy-process-security[security and regulation compliance] documentation.
22+
23+
24+
include::modules/rosa-hcp-architecture.adoc[leveloffset=+1]
1525
include::modules/rosa-architecture.adoc[leveloffset=+1]
16-
include::modules/osd-aws-privatelink-architecture.adoc[leveloffset=+1]
17-
include::modules/rosa-architecture-local-zones.adoc[leveloffset=+1]
26+
include::modules/osd-aws-privatelink-architecture.adoc[leveloffset=+2]
27+
include::modules/rosa-architecture-local-zones.adoc[leveloffset=+2]

‎rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc

+1-2
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ Since it is not possible to upgrade or convert existing ROSA clusters to a {hcp}
2626
====
2727

2828
.Further reading
29+
* For a comparison between {hcp-title} and ROSA Classic, see the xref:../rosa_architecture/rosa_architecture_sub/rosa-architecture-models.adoc#rosa-hcp-classic-comparison_rosa-architecture-models[Comparing architecture models] documentation.
2930
* See the AWS documentation for information about link:https://docs.aws.amazon.com/rosa/latest/userguide/getting-started-hcp.html[Getting started with ROSA with HCP using the ROSA CLI in auto mode].
3031
31-
include::modules/rosa-hcp-classic-comparison.adoc[leveloffset=+1]
32-
3332
.Additional resources
3433

3534
For a full list of the supported certificates, see the xref:../rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc#rosa-policy-compliance_rosa-policy-process-security[Compliance] section of "Understanding process and security for Red Hat OpenShift Service on AWS".

‎welcome/about-hcp.adoc

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="about-hcp"]
3+
= Learn more about ROSA with HCP
4+
include::_attributes/common-attributes.adoc[]
5+
include::_attributes/attributes-openshift-dedicated.adoc[]
6+
:context: about-hcp
7+
8+
toc::[]
9+
10+
{hcp-title-first} offers a reduced-cost solution to create a managed ROSA cluster with a focus on efficiency. You can quickly create a new cluster and deploy applications in minutes.
11+
12+
== Key features of {hcp-title}
13+
14+
* {hcp-title} requires a minimum of only two nodes, making it ideal for smaller projects while still being able to scale to support larger projects and enterprises.
15+
16+
* The underlying control plane infrastructure is fully managed. Control plane components, such as the API server and etcd database, are hosted in a Red Hat-owned AWS account.
17+
18+
* Provisioning time is approximately 10 minutes.
19+
20+
* Customers can upgrade the control plane and machine pools separately, which means they do not have to shut down the entire cluster during upgrades.
21+
22+
== Getting started with {hcp-title}
23+
24+
Use the following sections to find content to help you learn about and use {hcp-title}.
25+
26+
[id="architect"]
27+
=== Architect
28+
29+
[options="header",cols="3*"]
30+
|===
31+
| Learn about {hcp-title} |Plan {hcp-title} deployment |Additional resources
32+
33+
| xref:../rosa_architecture/rosa_architecture_sub/rosa-basic-architecture-concepts.adoc#rosa-basic-architecture-concepts[ROSA architecture concepts]
34+
| xref:../rosa_backing_up_and_restoring_applications/backing-up-applications.adoc#rosa-backing-up-applications[Back up and restore]
35+
| xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} life cycle]
36+
37+
| xref:../rosa_architecture/rosa_architecture_sub/rosa-architecture-models.adoc#rosa-architecture-models[{hcp-title} architecture]
38+
|
39+
| xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-hcp-service-definition[{hcp-title} service definition]
40+
41+
|
42+
|
43+
| xref:../support/index.adoc#support-overview[Getting support]
44+
|===
45+
46+
47+
[id="cluster-administrator"]
48+
=== Cluster Administrator
49+
50+
[options="header",cols="4*"]
51+
|===
52+
|Learn about {hcp-title} |Deploy {hcp-title} |Manage {hcp-title} |Additional resources
53+
54+
| xref:../rosa_architecture/rosa_architecture_sub/rosa-architecture-models.adoc#rosa-architecture-models[{hcp-title} architecture]
55+
| xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[Installing {hcp-title}]
56+
| xref:../logging/cluster-logging.adoc#cluster-logging[Logging]
57+
| xref:../support/index.adoc#support-overview[Getting Support]
58+
59+
| link:https://learn.openshift.com/?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[OpenShift Interactive Learning Portal]
60+
| xref:../storage/index.adoc#storage-overview[Storage]
61+
| xref:../monitoring/monitoring-overview.adoc#monitoring-overview_virt-monitoring-overview[Monitoring overview]
62+
| xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} life cycle]
63+
64+
|
65+
| xref:../rosa_backing_up_and_restoring_applications/backing-up-applications.adoc#rosa-backing-up-applications[Back up and restore]
66+
|
67+
|
68+
69+
|
70+
| xref:../upgrading/rosa-hcp-upgrading.adoc#rosa-hcp-upgrading[Upgrading]
71+
|
72+
|
73+
74+
|===
75+
76+
77+
[id="Developer"]
78+
=== Developer
79+
80+
[options="header",cols="3*"]
81+
|===
82+
|Learn about application development in {hcp-title} |Deploy applications |Additional resources
83+
84+
| link:https://developers.redhat.com/[Red Hat Developers site]
85+
| xref:../applications/index.adoc#building-applications-overview[Building applications overview]
86+
| xref:../support/index.adoc#support-overview[Getting support]
87+
88+
| link:https://developers.redhat.com/products/openshift-dev-spaces/overview[{openshift-dev-spaces-productname} (formerly Red Hat CodeReady Workspaces)]
89+
| xref:../operators/index.adoc#operators-overview[Operators overview]
90+
|
91+
92+
|
93+
| xref:../openshift_images/index.adoc#overview-of-images[Images]
94+
|
95+
96+
|
97+
| xref:../cli_reference/odo-important-update.adoc#odo-important_update[Developer-focused CLI]
98+
|
99+
100+
|===

0 commit comments

Comments
 (0)