Skip to content

Commit 1f40a5c

Browse files
committed
CQA for authentication
1 parent 4111de6 commit 1f40a5c

29 files changed

Lines changed: 85 additions & 118 deletions

_topic_maps/_topic_map_osd.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -394,9 +394,9 @@ Topics:
394394
File: managing-oauth-access-tokens
395395
# - Name: Understanding identity provider configuration
396396
# File: understanding-identity-provider
397-
- Name: Configuring identity providers
397+
- Name: Configure identity providers
398398
File: sd-configuring-identity-providers
399-
- Name: Revoking privileges and access to an OpenShift Dedicated cluster
399+
- Name: Revoke privileges and access to an OpenShift Dedicated cluster
400400
File: osd-revoking-cluster-privileges
401401
# - Name: Configuring identity providers
402402
# Dir: identity_providers
@@ -419,7 +419,7 @@ Topics:
419419
# File: configuring-google-identity-provider
420420
# - Name: Configuring an OpenID Connect identity provider
421421
# File: configuring-oidc-identity-provider
422-
- Name: Managing administration roles and users
422+
- Name: Manage administration roles and users
423423
File: osd-admin-roles
424424
- Name: Using RBAC to define and apply permissions
425425
File: using-rbac

_topic_maps/_topic_map_rosa.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ Topics:
637637
File: using-service-accounts-in-applications
638638
- Name: Using a service account as an OAuth client
639639
File: using-service-accounts-as-oauth-client
640-
- Name: Assuming an AWS IAM role for a service account
640+
- Name: Assume an AWS IAM role for a service account
641641
File: assuming-an-aws-iam-role-for-a-service-account
642642
- Name: Scoping tokens
643643
File: tokens-scoping

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,7 @@ Topics:
540540
File: using-service-accounts-in-applications
541541
- Name: Using a service account as an OAuth client
542542
File: using-service-accounts-as-oauth-client
543-
- Name: Assuming an AWS IAM role for a service account
543+
- Name: Assume an AWS IAM role for a service account
544544
File: assuming-an-aws-iam-role-for-a-service-account
545545
- Name: Scoping tokens
546546
File: tokens-scoping

authentication/assuming-an-aws-iam-role-for-a-service-account.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="assuming-an-aws-iam-role-for-a-service-account"]
3-
= Assuming an AWS IAM role for a service account
3+
= Assume an AWS IAM role for a service account
44

55
include::_attributes/common-attributes.adoc[]
66
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
@@ -34,7 +34,7 @@ include::modules/deploying-a-pod-that-includes-an-aws-sdk.adoc[leveloffset=+2]
3434
include::modules/verifying-the-assumed-iam-role-in-your-pod.adoc[leveloffset=+2]
3535

3636
[role="_additional-resources"]
37-
[id="additional-resources_configuring-alert-notifications"]
37+
[id="additional-resources_assuming-an-aws-iam-role-for-a-service-account"]
3838
== Additional resources
3939

4040
* link:https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html[AWS documentation on IAM roles for service accounts]

authentication/osd-admin-roles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="osd-admin-roles"]
3-
= Managing administration roles and users
3+
= Manage administration roles and users
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55

66
:context: osd-admin-roles

authentication/osd-revoking-cluster-privileges.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="osd-revoking-cluster-privileges"]
3-
= Revoking privileges and access to an {product-title} cluster
3+
= Revoke privileges and access to an {product-title} cluster
44

55
include::_attributes/attributes-openshift-dedicated.adoc[]
66
:context: osd-revoking-cluster-privileges

authentication/sd-configuring-identity-providers.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ include::modules/config-htpasswd-idp-webui.adoc[leveloffset=+2]
2626
include::modules/config-htpasswd-idp-from-file.adoc[leveloffset=+2]
2727
ifdef::openshift-rosa-hcp,openshift-rosa[]
2828
include::modules/rosa-config-htpasswd-idp-cli.adoc[leveloffset=+2]
29-
include::modules/rosa-config-htpasswd-idp-cli-file.adoc[leveloffset=+3]
29+
include::modules/rosa-config-htpasswd-idp-cli-file.adoc[leveloffset=+2]
3030
include::modules/config-htpasswd-idp-terraform.adoc[leveloffset=+2]
3131
endif::openshift-rosa-hcp,openshift-rosa[]
3232
ifdef::openshift-dedicated[]
@@ -43,5 +43,5 @@ ifdef::openshift-rosa[]
4343
* xref:../rosa_getting_started/rosa-sts-getting-started-workflow.adoc#rosa-sts-understanding-the-deployment-workflow[Understanding the ROSA with STS deployment workflow]
4444
endif::openshift-rosa[]
4545
* link:https://httpd.apache.org/docs/current/misc/password_encryptions.html[Apache Password Formats]
46-
* link:https://developers.google.com/identity/protocols/OpenIDConnect[Google's OpenID Connect integration]
47-
* link:http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth[Authorization Code Flow]
46+
* link:https://developers.google.com/identity/protocols/OpenIDConnect[Google OpenID Connect integration]
47+
* link:https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth[Authorization Code Flow]

modules/assuming-an-aws-iam-role-in-your-own-pods.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="assuming-an-aws-iam-role-in-your-own-pods_{context}"]
7-
= Assuming an AWS IAM role in your own pods
7+
= Assume an AWS IAM role in your own pods
88

99
[role="_abstract"]
1010
You can enable a service account to assume an AWS Identity and Access Management (IAM) role in a pod deployed in a user-defined project.

modules/config-github-idp.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="config-github-idp_{context}"]
8-
= Configuring a GitHub identity provider
8+
= Configure a GitHub identity provider
99

1010
[role="_abstract"]
11-
Configure a GitHub identity provider to validate user names and passwords against GitHub or GitHub Enterprise's OAuth authentication server and access your {product-title} cluster. OAuth facilitates a token exchange flow between {product-title} and GitHub or GitHub Enterprise.
11+
Configure a GitHub identity provider to validate user names and passwords against the GitHub or GitHub Enterprise OAuth authentication server and access your {product-title} cluster. OAuth facilitates a token exchange flow between {product-title} and GitHub or GitHub Enterprise.
1212

1313
[WARNING]
1414
====
@@ -17,7 +17,7 @@ Configuring GitHub authentication allows users to log in to {product-title} with
1717

1818
.Prerequisites
1919

20-
* The OAuth application must be created directly within the GitHub link:https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings[organization settings] by the GitHub organization administrator.
20+
* The OAuth application is created directly within the GitHub link:https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings[organization settings] by the GitHub organization administrator.
2121
* link:https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams[GitHub organizations or teams] are set up in your GitHub account.
2222
2323
.Procedure
@@ -30,13 +30,13 @@ Configuring GitHub authentication allows users to log in to {product-title} with
3030
+
3131
[NOTE]
3232
====
33-
You can also click the *Add Oauth configuration* link in the warning message displayed after cluster creation to configure your identity providers.
33+
You can also click the *Add OAuth configuration* link in the warning message displayed after cluster creation to configure your identity providers.
3434
====
3535

3636
. Select *GitHub* from the drop-down menu.
3737

3838
. Enter a unique name for the identity provider. This name cannot be changed later.
39-
** An *OAuth callback URL* is automatically generated in the provided field. You will use this to register the GitHub application.
39+
** An *OAuth callback URL* is automatically generated in the provided field. Use this to register the GitHub application.
4040
+
4141
----
4242
https://oauth-openshift.apps.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>

modules/config-gitlab-idp.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="config-gitlab-idp_{context}"]
8-
= Configuring a GitLab identity provider
8+
= Configure a GitLab identity provider
99

1010
[role="_abstract"]
11-
Configure a GitLab identity provider to use link:https://gitlab.com/[GitLab.com] or any other GitLab instance as an identity provider.
11+
Configure a GitLab identity provider to use GitLab.com or any other GitLab instance as an identity provider so that users can log in to your cluster with their GitLab credentials.
1212

1313
.Prerequisites
1414

15-
- If you use GitLab version 7.7.0 to 11.0, you connect using the link:http://doc.gitlab.com/ce/integration/oauth_provider.html[OAuth integration]. If you use GitLab version 11.1 or later, you can use link:https://docs.gitlab.com/ce/integration/openid_connect_provider.html[OpenID Connect] (OIDC) to connect instead of OAuth.
15+
* If you use GitLab version 7.7.0 to 11.0, you connect using the link:https://docs.gitlab.com/ee/integration/oauth_provider.html[OAuth integration]. If you use GitLab version 11.1 or later, you can use link:https://docs.gitlab.com/ee/integration/openid_connect_provider.html[OpenID Connect] (OIDC) to connect instead of OAuth.
1616
1717
.Procedure
1818

@@ -24,13 +24,13 @@ Configure a GitLab identity provider to use link:https://gitlab.com/[GitLab.com]
2424
+
2525
[NOTE]
2626
====
27-
You can also click the *Add Oauth configuration* link in the warning message displayed after cluster creation to configure your identity providers.
27+
You can also click the *Add OAuth configuration* link in the warning message displayed after cluster creation to configure your identity providers.
2828
====
2929

3030
. Select *GitLab* from the drop-down menu.
3131

3232
. Enter a unique name for the identity provider. This name cannot be changed later.
33-
** An *OAuth callback URL* is automatically generated in the provided field. You will provide this URL to GitLab.
33+
** An *OAuth callback URL* is automatically generated in the provided field. Provide this URL to GitLab.
3434
+
3535
ifndef::openshift-rosa-hcp[]
3636
----

0 commit comments

Comments
 (0)