Skip to content

Commit ff5b292

Browse files
authored
Merge pull request #84092 from EricPonvelle/Ext-Auth_Conditionals
Restored the Ext. Auth. installation for the ROSA doc set
2 parents 10deb57 + cf47eb7 commit ff5b292

File tree

3 files changed

+49
-14
lines changed

3 files changed

+49
-14
lines changed

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Topics:
3434
File: about-hcp
3535
- Name: AWS STS and ROSA with HCP explained
3636
File: cloud-experts-rosa-hcp-sts-explained
37+
- Name: Architecture models
38+
File: rosa-architecture-models
3739
- Name: Policies and service definition
3840
Dir: rosa_policy_service_definition
3941
Distros: openshift-rosa-hcp
@@ -120,8 +122,8 @@ Topics:
120122
# File: cloud-experts-deploy-api-data-protection
121123
# - Name: AWS Load Balancer Operator on ROSA
122124
# File: cloud-experts-aws-load-balancer-operator
123-
# - Name: Configuring Microsoft Entra ID (formerly Azure Active Directory) as an identity provider
124-
# File: cloud-experts-entra-id-idp
125+
- Name: Configuring Microsoft Entra ID (formerly Azure Active Directory) as an identity provider
126+
File: cloud-experts-entra-id-idp
125127
# - Name: Using AWS Secrets Manager CSI on ROSA with STS
126128
# File: cloud-experts-aws-secret-manager
127129
# - Name: Using AWS Controllers for Kubernetes on ROSA
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="rosa-architecture-models"]
3+
= Architecture models
4+
include::_attributes/attributes-openshift-dedicated.adoc[]
5+
include::_attributes/common-attributes.adoc[]
6+
:context: rosa-architecture-models
7+
8+
toc::[]
9+
10+
{product-rosa} (ROSA) has the following cluster topologies:
11+
12+
* Hosted control plane (HCP) - The control plane is hosted in a Red{nbsp}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.
14+
15+
include::modules/rosa-hcp-classic-comparison.adoc[leveloffset=+1]
16+
17+
.Additional resources
18+
19+
* xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-sdpolicy-regions-az_rosa-hcp-service-definition[Regions and availability zones]
20+
ifndef::openshift-rosa-hcp[]
21+
* xref:../rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc#rosa-policy-security-regulation-compliance_rosa-policy-process-security[Security and regulation compliance]
22+
endif::openshift-rosa-hcp[]
23+
24+
include::modules/rosa-hcp-architecture.adoc[leveloffset=+1]
25+
include::modules/rosa-architecture.adoc[leveloffset=+1]
26+
include::modules/osd-aws-privatelink-architecture.adoc[leveloffset=+2]
27+
include::modules/rosa-architecture-local-zones.adoc[leveloffset=+2]
28+
29+
ifndef::openshift-rosa-hcp[]
30+
.Additional resources
31+
32+
* xref:../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-configuring.html[Configuring machine pools in Local Zones]
33+
endif::openshift-rosa-hcp[]

rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@ include::snippets/imp-rosa-hcp-no-shared-vpc-support.adoc[leveloffset=+0]
2020
{hcp-title} clusters only support {sts-first} authentication.
2121
====
2222

23-
ifndef::openshift-rosa-hcp[]
2423
.Further reading
25-
* For a comparison between {hcp-title} and ROSA Classic, see the xref:../architecture/rosa-architecture-models.adoc#rosa-hcp-classic-comparison_rosa-architecture-models[Comparing architecture models] documentation.
24+
ifdef::openshift-rosa-hcp[]
25+
* For a comparison between {hcp-title} and ROSA Classic, see the xref:../rosa_architecture/rosa-architecture-models.adoc#rosa-hcp-classic-comparison_rosa-architecture-models[Comparing architecture models] documentation.
26+
endif::openshift-rosa-hcp[]
2627
* 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].
2728

28-
.Additional resources
29-
30-
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{nbsp}Hat OpenShift Service on AWS".
29+
//.Additional resources
30+
//
31+
//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{nbsp}Hat OpenShift Service on AWS".
3132

3233
[id="rosa-hcp-external-auth-prereqs"]
3334
== {hcp-title} Prerequisites
@@ -50,16 +51,17 @@ include::modules/rosa-hcp-sts-creating-a-cluster-external-auth-provider-cli.adoc
5051
[role="_additional-resources"]
5152
.Additional resources
5253
* For more information about configuring Entra ID for your IDP, see link:https://learn.microsoft.com/en-us/entra/fundamentals/whatis[What is Microsoft Entra ID?] in the Azure documentation or the xref:../cloud_experts_tutorials/cloud-experts-entra-id-idp.adoc#cloud-experts-entra-id-idp[Configuring Microsoft Entra ID (formerly Azure Active Directory) as an identity provider] tutorial section of the documentation.
53-
* For information about the similar `idps` tool in the ROSA CLI, see xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-idp_rosa-managing-objects-cli[`create idp`].
54-
* For more information about options in the ROSA CLI, see xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-external-auth-provider_rosa-managing-objects-cli[`create external-auth-provider`], xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-list-external-auth-provider_rosa-managing-objects-cli[`list external-auth-provider`], and xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-delete-external-auth-provider_rosa-managing-objects-cli[`delete external-auth-provider`].
54+
ifndef::openshift-rosa-hcp[]
55+
//* For information about the similar `idps` tool in the ROSA CLI, see xref:#../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-idp_rosa-managing-objects-cli[`create idp`].
56+
//* For more information about options in the ROSA CLI, see xref:#../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-external-auth-provider_rosa-managing-objects-cli[`create external-auth-provider`], xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-list-external-auth-provider_rosa-managing-objects-cli[`list external-auth-provider`], and xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-delete-external-auth-provider_rosa-managing-objects-cli[`delete external-auth-provider`].
5557

5658
// Step 3: Create, list, and revoke a break glass credential
5759
include::modules/rosa-hcp-sts-creating-a-break-glass-cred-cli.adoc[leveloffset=+1]
5860

5961
[role="_additional-resources"]
6062
.Additional resources
6163
* For more information about creating a {hcp-title} cluster with external authentication enabled, see xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc#rosa-hcp-sts-creating-a-cluster-external-auth-cluster-cli_rosa-hcp-sts-creating-a-cluster-ext-auth[Creating a ROSA with HCP cluster that uses external authentication providers].
62-
* For more information about CLI configurations, see xref:../cli_reference/openshift_cli/managing-cli-profiles.adoc#managing-cli-profiles[Managing CLI profiles].
64+
//* For more information about CLI configurations, see xref:#../cli_reference/openshift_cli/managing-cli-profiles.adoc#managing-cli-profiles[Managing CLI profiles].
6365

6466
include::modules/rosa-hcp-sts-accessing-a-break-glass-cred-cli.adoc[leveloffset=+1]
6567

@@ -76,12 +78,10 @@ include::modules/rosa-hcp-sts-creating-a-cluster-external-auth-provider-delete-c
7678
[id="additional-resources_rosa-sts-creating-a-cluster-ext-auth"]
7779
== Additional resources
7880

79-
* For steps to deploy a ROSA cluster using manual mode, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-creating-cluster-using-customizations_rosa-sts-creating-a-cluster-with-customizations[Creating a cluster using customizations].
80-
* For more information about the AWS Identity Access Management (IAM) resources required to deploy {product-title} with STS, see xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources for clusters that use STS].
81-
* To learn more about the default CIDR ranges for {product-title}, see xref:../networking/cidr-range-definitions.adoc#cidr-range-definitions[CIDR range definitions].
81+
// * To learn more about the default CIDR ranges for {product-title}, see xref:#../networking/cidr-range-definitions.adoc#cidr-range-definitions[CIDR range definitions].
8282
* For details about optionally setting an Operator role name prefix, see xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-operator-role-prefixes_rosa-sts-about-iam-resources[About custom Operator IAM role prefixes].
8383
* For information about the prerequisites to installing ROSA with STS, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS].
8484
* For details about using the `auto` and `manual` modes to create the required STS resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-understanding-deployment-modes_rosa-sts-creating-a-cluster-with-customizations[Understanding the auto and manual deployment modes].
8585
* For more information about using OpenID Connect (OIDC) identity providers in AWS IAM, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html[Creating OpenID Connect (OIDC) identity providers] in the AWS documentation.
8686
* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installations[Troubleshooting installations].
87-
* For steps to contact Red{nbsp}Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red{nbsp}Hat OpenShift Service on AWS].
87+
* For steps to contact Red{nbsp}Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red{nbsp}Hat OpenShift Service on AWS].

0 commit comments

Comments
 (0)