Skip to content

Commit d9affb5

Browse files
committed
OSDOCS-4806: Expanded OIDC config instructions
1 parent a1873c4 commit d9affb5

7 files changed

+31
-23
lines changed

modules/rosa-hcp-byo-oidc-options.adoc renamed to modules/rosa-sts-byo-oidc-options.adoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
// Module included in the following assemblies:
22
//
3-
// * rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc
4-
// * rosa_getting_started/quickstart.adoc
3+
// * rosa_architecture/rosa-oidc-overview.adoc
54
// * rosa_architecture/rosa-sts-about-iam-resources.adoc
65

76
:_content-type: CONCEPT
8-
[id="rosa-hcp-byo-oidc-options_{context}"]
7+
[id="rosa-sts-byo-oidc-options_{context}"]
98
= Parameter options for creating your own OpenID Connect configuration
109

1110
The following options may be added to the `rosa create oidc-config` command. All of these parameters are optional. Running the `rosa create oidc-config` command without parameters creates an unmanaged OIDC configuration.
1211

1312
[NOTE]
1413
====
15-
You are required to register the unmanaged OIDC configuration by posting a request to `/oidc_configs` through OCM. You receive an ID in the response. Use this ID to create a cluster.
14+
You are required to register the unmanaged OIDC configuration by posting a request to `/oidc_configs` through OpenShift Cluster Manager. You receive an ID in the response. Use this ID to create a cluster.
1615
====
1716

1817
[discrete]
19-
[id="rosa-oidc-raw-files_{context}"]
18+
[id="rosa-sts-byo-oidc-raw-files_{context}"]
2019
== raw-files
2120

2221
Allows you to provide raw files for the private RSA key. This key is named `rosa-private-key-oidc-<random_label_of_length_4>.key`. You also receive a discovery document, named `discovery-document-oidc-<random_label_of_length_4>.json`, and a JSON Web Key Set, named `jwks-oidc-<random_label_of_length_4>.json`.
@@ -30,12 +29,12 @@ $ rosa create oidc-config --raw-files
3029
----
3130

3231
[discrete]
33-
[id="rosa-oidc-mode_{context}"]
32+
[id="rosa-sts-byo-oidc-mode_{context}"]
3433
== mode
3534

36-
Allows you to specify the mode to create your OIDC configuration. With the `manual` option, you receive AWS commands that setup the OIDC configuration within an S3 bucket. This option stores the private key in the Secrets Manager. With the `manual` option, the OIDC Endpoint URL is the URL for the S3 bucket. You must retrieve the Secrets Manager ARN to register the OIDC configuration with OCM.
35+
Allows you to specify the mode to create your OIDC configuration. With the `manual` option, you receive AWS commands that set up the OIDC configuration in an S3 bucket. This option stores the private key in the Secrets Manager. With the `manual` option, the OIDC Endpoint URL is the URL for the S3 bucket. You must retrieve the Secrets Manager ARN to register the OIDC configuration with OpenShift Cluster Manager.
3736

38-
Using the `auto` option, you receive the same OIDC configuration and AWS resources as the `manual` mode. One change is that ROSA calls AWS, so you do not need to do anything else. The OIDC Endpoint URL is the URL for the S3 bucket. The CLI retrieves the Secrets Manager ARN, registers the OIDC configuration with OCM, and reports the second `rosa` command that the user can run to continue with the creation of the STS cluster.
37+
You receive the same OIDC configuration and AWS resources as the `manual` mode when using the `auto` option. A significant difference between the two options is that when using the `auto` option, ROSA calls AWS, so you do not need to take any further actions. The OIDC Endpoint URL is the URL for the S3 bucket. The CLI retrieves the Secrets Manager ARN, registers the OIDC configuration with OpenShift Cluster Manager, and reports the second `rosa` command that the user can run to continue with the creation of the STS cluster.
3938

4039
.Example
4140
[source,terminal]
@@ -44,7 +43,7 @@ $ rosa create oidc-config --mode=<auto|manual>
4443
----
4544

4645
[discrete]
47-
[id="rosa-oidc-managed_{context}"]
46+
[id="rosa-sts-byo-oidc-managed_{context}"]
4847
== managed
4948

5049
Creates an OIDC configuration that is hosted under Red Hat's AWS account. This command creates a private key that responds directly with an OIDC Config ID for you to use when creating the STS cluster.

modules/rosa-hcp-byo-oidc.adoc renamed to modules/rosa-sts-byo-oidc.adoc

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,36 @@
11
// Module included in the following assemblies:
22
//
3-
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
3+
// * rosa_architecture/rosa-oidc-overview.adoc
44
// * rosa_architecture/rosa-sts-about-iam-resources.adoc
5+
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
6+
// * rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc
7+
// * rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc
58

69
ifeval::["{context}" == "rosa-hcp-sts-creating-a-cluster-quickly"]
710
:rosa-hcp:
811
endif::[]
9-
ifeval::["{context}" == "rosa-sts-about-iam-resources"]
10-
:rosa-classic:
11-
endif::[]
1212

1313
:_content-type: PROCEDURE
14-
[id="rosa-hcp-byo-oidc_{context}"]
14+
[id="rosa-sts-byo-oidc_{context}"]
1515
= Creating an OpenID Connect configuration
1616

17-
When using a {hcp-title} cluster, you must create the OpenID Connect (OIDC) configuration prior to creating your cluster. This configuration is registered to be used with OCM.
17+
When using a
18+
ifdef::rosa-hcp[]
19+
{hcp-title} cluster, you must
20+
endif::rosa-hcp[]
21+
ifndef::rosa-hcp[]
22+
{product-title} cluster, you can
23+
endif::rosa-hcp[]
24+
create the OpenID Connect (OIDC) configuration prior to creating your cluster. This configuration is registered to be used with OpenShift Cluster Manager.
1825

1926
.Prerequisites
2027

2128
ifdef::rosa-hcp[]
2229
* You have completed the AWS prerequisites for {hcp-title}.
2330
endif::rosa-hcp[]
24-
ifdef::rosa-classic[]
31+
ifdef::rosa-hcp[]
2532
* You have completed the AWS prerequisites for {product-title}.
26-
endif::rosa-classic[]
33+
endif::rosa-hcp[]
2734
* You have installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your installation host.
2835

2936
.Procedure

rosa_architecture/rosa-oidc-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ include::modules/rosa-oidc-understanding.adoc[leveloffset=+1]
1616

1717
include::modules/rosa-oidc-config-overview.adoc[leveloffset=+1]
1818
[discrete]
19-
include::modules/rosa-hcp-byo-oidc.adoc[leveloffset=+3]
19+
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+3]
2020
[discrete]
21-
include::modules/rosa-hcp-byo-oidc-options.adoc[leveloffset=+3]
21+
include::modules/rosa-sts-byo-oidc-options.adoc[leveloffset=+3]
2222

2323
include::modules/rosa-sts-oidc-provider-command.adoc[leveloffset=+1]
2424

@@ -27,4 +27,4 @@ include::modules/rosa-sts-oidc-provider-command.adoc[leveloffset=+1]
2727
== Additional resources
2828

2929
* See xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-byo-odic-overview_rosa-sts-about-iam-resources[Creating an OpenID Connect Configuration] for the ROSA Classic instructions.
30-
* See xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-byo-oidc_rosa-hcp-sts-creating-a-cluster-quickly[Creating an OpenID Connect Configuration] for the {hcp-title} instructions.
30+
* See xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-sts-byo-oidc_rosa-hcp-sts-creating-a-cluster-quickly[Creating an OpenID Connect Configuration] for the {hcp-title} instructions.

rosa_architecture/rosa-sts-about-iam-resources.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ include::modules/rosa-sts-oidc-provider-command.adoc[leveloffset=+2]
9494

9595
include::modules/rosa-oidc-config-overview.adoc[leveloffset=+2]
9696
[discrete]
97-
include::modules/rosa-hcp-byo-oidc.adoc[leveloffset=+3]
97+
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+3]
9898
[discrete]
99-
include::modules/rosa-hcp-byo-oidc-options.adoc[leveloffset=+3]
99+
include::modules/rosa-sts-byo-oidc-options.adoc[leveloffset=+3]
100100

101101
include::modules/rosa-aws-scp.adoc[leveloffset=+1]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ include::modules/rosa-hcp-vpc-manual.adoc[leveloffset=+3]
103103

104104
include::modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+2]
105105

106-
include::modules/rosa-hcp-byo-oidc.adoc[leveloffset=+2]
106+
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+2]
107107

108108
include::modules/rosa-operator-config.adoc[leveloffset=+2]
109109

rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ include::modules/osd-aws-vpc-required-resources.adoc[leveloffset=+1]
4141
include::modules/rosa-sts-creating-a-cluster-quickly-ocm.adoc[leveloffset=+1]
4242
include::modules/rosa-sts-associating-your-aws-account.adoc[leveloffset=+2]
4343
include::modules/rosa-sts-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+2]
44+
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+2]
4445
include::modules/rosa-sts-creating-a-cluster-using-defaults-ocm.adoc[leveloffset=+2]
4546
include::modules/rosa-sts-creating-a-cluster-quickly-cli.adoc[leveloffset=+1]
4647

rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ include::modules/osd-aws-vpc-required-resources.adoc[leveloffset=+1]
3838
* For more information about the default components required for an AWS cluster, see link:https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html[Default VPCs] in the AWS documentation.
3939
* For instructions on creating a VPC in the AWS console, see link:https://docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html[Create a VPC] in the AWS documentation.
4040
41+
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+1]
4142
include::modules/rosa-sts-creating-a-cluster-using-customizations.adoc[leveloffset=+1]
4243
include::modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc[leveloffset=+2]
4344

0 commit comments

Comments
 (0)