Skip to content

Commit 9f459f1

Browse files
committed
OSDOCS-14108
1 parent 0fa5e1f commit 9f459f1

9 files changed

+36
-4
lines changed

modules/authentication-authorization-common-terms.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ manual mode::
4949
In manual mode, a user manages cloud credentials instead of the Cloud Credential Operator (CCO).
5050
endif::openshift-dedicated,openshift-rosa[]
5151

52-
ifndef::openshift-dedicated,openshift-rosa[]
52+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5353
mint mode::
5454
Mint mode is the default and recommended best practice setting for the Cloud Credential Operator (CCO) to use on the platforms for which it is supported. In this mode, the CCO uses the provided administrator-level cloud credential to create new credentials for components in the cluster with only the specific permissions that are required.
55-
endif::openshift-dedicated,openshift-rosa[]
55+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5656

5757
namespace::
5858
A namespace isolates specific system resources that are visible to all processes. Inside a namespace, only processes that are members of that namespace can see those resources.

modules/config-github-idp.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,16 @@ https://oauth-openshift.apps.<cluster_name>.<cluster_domain>/oauth2callback/<idp
4545
+
4646
For example:
4747
+
48+
ifndef::openshift-rosa-hcp[]
4849
----
4950
https://oauth-openshift.apps.openshift-cluster.example.com/oauth2callback/github
5051
----
52+
endif::openshift-rosa-hcp[]
53+
ifdef::openshift-rosa-hcp[]
54+
----
55+
https://oauth.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>
56+
----
57+
endif::openshift-rosa-hcp[]
5158

5259
. link:https://docs.github.com/en/developers/apps/creating-an-oauth-app[Register an application on GitHub].
5360

modules/config-gitlab-idp.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,16 @@ You can also click the *Add Oauth configuration* link in the warning message dis
3333
. Enter a unique name for the identity provider. This name cannot be changed later.
3434
** An *OAuth callback URL* is automatically generated in the provided field. You will provide this URL to GitLab.
3535
+
36+
ifndef::openshift-rosa-hcp[]
3637
----
3738
https://oauth-openshift.apps.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>
3839
----
40+
endif::openshift-rosa-hcp[]
41+
ifdef::openshift-rosa-hcp[]
42+
----
43+
https://oauth.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>
44+
----
45+
endif::openshift-rosa-hcp[]
3946
+
4047
For example:
4148
+

modules/config-google-idp.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,16 @@ You can also click the *Add Oauth configuration* link in the warning message dis
3636
. Enter a unique name for the identity provider. This name cannot be changed later.
3737
** An *OAuth callback URL* is automatically generated in the provided field. You will provide this URL to Google.
3838
+
39+
ifndef::openshift-rosa-hcp[]
3940
----
4041
https://oauth-openshift.apps.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>
4142
----
43+
endif::openshift-rosa-hcp[]
44+
ifdef::openshift-rosa-hcp[]
45+
----
46+
https://oauth.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>
47+
----
48+
endif::openshift-rosa-hcp[]
4249
+
4350
For example:
4451
+

modules/config-openid-idp.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,16 @@ You can also click the *Add Oauth configuration* link in the warning message dis
7373
. Enter a unique name for the identity provider. This name cannot be changed later.
7474
** An *OAuth callback URL* is automatically generated in the provided field.
7575
+
76+
ifndef::openshift-rosa-hcp[]
7677
----
7778
https://oauth-openshift.apps.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>
7879
----
80+
endif::openshift-rosa-hcp[]
81+
ifdef::openshift-rosa-hcp[]
82+
----
83+
https://oauth.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>
84+
----
85+
endif::openshift-rosa-hcp[]
7986
+
8087
For example:
8188
+

modules/oauth-server-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[id="oauth-server-overview_{context}"]
88
= {product-title} OAuth server
99

10-
The {product-title} master includes a built-in OAuth server. Users obtain OAuth
10+
The {product-title} Control Plane includes a built-in OAuth server. Users obtain OAuth
1111
access tokens to authenticate themselves to the API.
1212

1313
When a person requests a new OAuth token, the OAuth server uses the configured

modules/oauth-token-requests.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@ cannot display interactive login pages, such as the CLI. Therefore,
4141
{product-title} supports authenticating using a `WWW-Authenticate`
4242
challenge in addition to interactive login flows.
4343

44+
ifndef::openshift-rosa-hcp[]
4445
If an authenticating proxy is placed in front of the
4546
`<namespace_route>/oauth/authorize` endpoint, it sends unauthenticated,
4647
non-browser user-agents `WWW-Authenticate` challenges rather than
4748
displaying an interactive login page or redirecting to an interactive
4849
login flow.
50+
endif::openshift-rosa-hcp[]
4951

5052
[NOTE]
5153
====

modules/rosa-create-cluster-admins.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ cluster-admins rh-rosa-test-user
4343
dedicated-admins rh-rosa-test-user
4444
----
4545
+
46+
ifndef::openshift-rosa-hcp[]
4647
. Enter the following command to verify that your user now has `cluster-admin` access. A cluster administrator can run this command without errors, but a dedicated administrator cannot.
4748
+
4849
[source,terminal]
@@ -62,3 +63,4 @@ service/api ClusterIP 172.30.23.241 <none> 443/TCP 18h
6263
NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
6364
daemonset.apps/apiserver 3 3 3 3 3 node-role.kubernetes.io/master= 18h
6465
----
66+
endif::openshift-rosa-hcp[]

modules/setting-up-an-aws-iam-role-a-service-account.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ In {product-title} with STS clusters, the OIDC provider is created during instal
4545
]
4646
}
4747
----
48-
<1> Replace `<oidc_provider_arn>` with the ARN of your OIDC provider, for example `arn:aws:iam::<aws_account_id>:oidc-provider/rh-oidc.s3.us-east-1.amazonaws.com/1v3r0n44npxu4g58so46aeohduomfres`.
48+
<1> Replace `<oidc_provider_arn>` with the ARN of your OIDC provider, for example link:https://rh-oidc.s3.us-east-1.amazonaws.com/1v3r0n44npxu4g58so46aeohduomfres[`arn:aws:iam::<aws_account_id>:oidc-provider/rh-oidc.s3.us-east-1.amazonaws.com/1v3r0n44npxu4g58so46aeohduomfres`.] You can retrieve the ARN by using the `rosa describe cluster` CLI command.
4949
<2> Limits the role to the specified project and service account. Replace `<oidc_provider_name>` with the name of your OIDC provider, for example `rh-oidc.s3.us-east-1.amazonaws.com/1v3r0n44npxu4g58so46aeohduomfres`. Replace `<project_name>:<service_account_name>` with your project name and service account name, for example `my-project:test-service-account`.
5050
+
5151
[NOTE]

0 commit comments

Comments
 (0)