Skip to content

Commit 158c2eb

Browse files
authored
Merge pull request #87870 from xJustin/OSDOCS-11833-auth-book-hcp
OSDOCS-11833 Auth book integration
2 parents 3fdf4f4 + 465028d commit 158c2eb

25 files changed

+202
-115
lines changed

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,85 @@ Topics:
472472
- Name: Adding additional constraints for IP-based AWS role assumption
473473
File: rosa-adding-additional-constraints-for-ip-based-aws-role-assumption
474474
---
475+
Name: Authentication and authorization
476+
Dir: authentication
477+
Distros: openshift-rosa-hcp
478+
Topics:
479+
- Name: Authentication and authorization overview
480+
File: index
481+
- Name: Understanding authentication
482+
File: understanding-authentication
483+
# - Name: Configuring the internal OAuth server
484+
# File: configuring-internal-oauth
485+
# - Name: Configuring OAuth clients
486+
# File: configuring-oauth-clients
487+
- Name: Managing user-owned OAuth access tokens
488+
File: managing-oauth-access-tokens
489+
# - Name: Understanding identity provider configuration
490+
# File: understanding-identity-provider
491+
- Name: Configuring identity providers
492+
File: sd-configuring-identity-providers
493+
# - Name: Configuring identity providers
494+
# Dir: identity_providers
495+
# Topics:
496+
# - Name: Configuring an htpasswd identity provider
497+
# File: configuring-htpasswd-identity-provider
498+
# - Name: Configuring a Keystone identity provider
499+
# File: configuring-keystone-identity-provider
500+
# - Name: Configuring an LDAP identity provider
501+
# File: configuring-ldap-identity-provider
502+
# - Name: Configuring a basic authentication identity provider
503+
# File: configuring-basic-authentication-identity-provider
504+
# - Name: Configuring a request header identity provider
505+
# File: configuring-request-header-identity-provider
506+
# - Name: Configuring a GitHub or GitHub Enterprise identity provider
507+
# File: configuring-github-identity-provider
508+
# - Name: Configuring a GitLab identity provider
509+
# File: configuring-gitlab-identity-provider
510+
# - Name: Configuring a Google identity provider
511+
# File: configuring-google-identity-provider
512+
# - Name: Configuring an OpenID Connect identity provider
513+
# File: configuring-oidc-identity-provider
514+
- Name: Using RBAC to define and apply permissions
515+
File: using-rbac
516+
# - Name: Removing the kubeadmin user
517+
# File: remove-kubeadmin
518+
#- Name: Configuring LDAP failover
519+
# File: configuring-ldap-failover
520+
- Name: Understanding and creating service accounts
521+
File: understanding-and-creating-service-accounts
522+
- Name: Using service accounts in applications
523+
File: using-service-accounts-in-applications
524+
- Name: Using a service account as an OAuth client
525+
File: using-service-accounts-as-oauth-client
526+
- Name: Assuming an AWS IAM role for a service account
527+
File: assuming-an-aws-iam-role-for-a-service-account
528+
- Name: Scoping tokens
529+
File: tokens-scoping
530+
- Name: Using bound service account tokens
531+
File: bound-service-account-tokens
532+
- Name: Managing security context constraints
533+
File: managing-security-context-constraints
534+
- Name: Understanding and managing pod security admission
535+
File: understanding-and-managing-pod-security-admission
536+
# - Name: Impersonating the system:admin user
537+
# File: impersonating-system-admin
538+
- Name: Syncing LDAP groups
539+
File: ldap-syncing
540+
# - Name: Managing cloud provider credentials
541+
# Dir: managing_cloud_provider_credentials
542+
# Topics:
543+
# - Name: About the Cloud Credential Operator
544+
# File: about-cloud-credential-operator
545+
# - Name: Mint mode
546+
# File: cco-mode-mint
547+
# - Name: Passthrough mode
548+
# File: cco-mode-passthrough
549+
# - Name: Manual mode with long-term credentials for components
550+
# File: cco-mode-manual
551+
# - Name: Manual mode with short-term credentials for components
552+
# File: cco-short-term-creds
553+
---
475554
Name: Upgrading
476555
Dir: upgrading
477556
Distros: openshift-rosa-hcp

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
[id="assuming-an-aws-iam-role-for-a-service-account"]
33
= Assuming an AWS IAM role for a service account
44
include::_attributes/common-attributes.adoc[]
5-
ifdef::openshift-rosa,openshift-dedicated[]
5+
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
66
include::_attributes/attributes-openshift-dedicated.adoc[]
7-
endif::openshift-rosa,openshift-dedicated[]
7+
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
88
:context: assuming-an-aws-iam-role-for-a-service-account
99

1010
toc::[]
1111

1212
[role="_abstract"]
13-
ifdef::openshift-rosa[]
13+
ifdef::openshift-rosa,openshift-rosa-hcp[]
1414
In {product-title} clusters that use the AWS Security Token Service (STS), the OpenShift API server can be enabled to project signed service account tokens that can be used to assume an AWS Identity and Access Management (IAM) role in a pod. If the assumed IAM role has the required AWS permissions, the pods can authenticate against the AWS API using temporary STS credentials to perform AWS operations.
15-
endif::openshift-rosa[]
15+
endif::openshift-rosa,openshift-rosa-hcp[]
1616

1717
You can use the pod identity webhook to project service account tokens to assume an AWS Identity and Access Management (IAM) role for your own workloads. If the assumed IAM role has the required AWS permissions, the pods can run AWS SDK operations by using temporary STS credentials.
1818

@@ -37,6 +37,6 @@ include::modules/verifying-the-assumed-iam-role-in-your-pod.adoc[leveloffset=+2]
3737

3838
* For more information about installing and using the AWS Boto3 SDK for Python, see the link:https://boto3.amazonaws.com/v1/documentation/api/latest/index.html[AWS Boto3 documentation].
3939

40-
ifdef::openshift-rosa,openshift-dedicated[]
40+
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
4141
* For general information about webhook admission plugins for OpenShift, see link:https://docs.openshift.com/container-platform/4.18/architecture/admission-plug-ins.html#admission-webhooks-about_admission-plug-ins[Webhook admission plugins] in the OpenShift Container Platform documentation.
42-
endif::openshift-rosa,openshift-dedicated[]
42+
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]

authentication/bound-service-account-tokens.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ include::modules/bound-sa-tokens-configuring-externally.adoc[leveloffset=+1]
2121
.Additional resources
2222

2323
// This xref target does not exist in the OSD/ROSA docs.
24-
ifndef::openshift-dedicated,openshift-rosa[]
24+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2525
* xref:../nodes/nodes/nodes-nodes-rebooting.adoc#nodes-nodes-rebooting-gracefully_nodes-nodes-rebooting[Rebooting a node gracefully]
26-
endif::openshift-dedicated,openshift-rosa[]
26+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2727

2828
* xref:../authentication/understanding-and-creating-service-accounts.adoc#service-accounts-managing_understanding-service-accounts[Creating service accounts]
2929

authentication/index.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ include::modules/authentication-authorization-common-terms.adoc[leveloffset=+1]
1010
[id="authentication-overview"]
1111
== About authentication in {product-title}
1212
To control access to an {product-title} cluster,
13-
ifndef::openshift-dedicated,openshift-rosa[]
13+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1414
a cluster administrator
15-
endif::openshift-dedicated,openshift-rosa[]
16-
ifdef::openshift-dedicated,openshift-rosa[]
15+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
16+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1717
an administrator with the `dedicated-admin` role
18-
endif::openshift-dedicated,openshift-rosa[]
18+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1919
can configure xref:../authentication/understanding-authentication.adoc#understanding-authentication[user authentication] and ensure only approved users access the cluster.
2020

2121
To interact with an {product-title} cluster, users must first authenticate to the {product-title} API in some way. You can authenticate by providing an xref:../authentication/understanding-authentication.adoc#rbac-api-authentication_understanding-authentication[OAuth access token or an X.509 client certificate] in your requests to the {product-title} API.
@@ -25,11 +25,11 @@ To interact with an {product-title} cluster, users must first authenticate to th
2525
If you do not present a valid access token or certificate, your request is unauthenticated and you receive an HTTP 401 error.
2626
====
2727

28-
ifdef::openshift-dedicated,openshift-rosa[]
28+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2929
An administrator can configure authentication by configuring an identity provider. You can define any xref:../authentication/sd-configuring-identity-providers.adoc#understanding-idp-supported_sd-configuring-identity-providers[supported identity provider in {product-title}] and add it to your cluster.
30-
endif::openshift-dedicated,openshift-rosa[]
30+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3131

32-
ifndef::openshift-dedicated,openshift-rosa[]
32+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3333
An administrator can configure authentication through the following tasks:
3434

3535
* Configuring an identity provider: You can define any xref:../authentication/understanding-identity-provider.adoc#supported-identity-providers[supported identity provider in {product-title}] and add it to your cluster.
@@ -50,7 +50,7 @@ When users send a request for an OAuth token, they must specify either a default
5050

5151
* Managing cloud provider credentials using the xref:../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[Cloud Credentials Operator]: Cluster components use cloud provider credentials to get permissions required to perform cluster-related tasks.
5252
* Impersonating a system admin user: You can grant cluster administrator permissions to a user by xref:../authentication/impersonating-system-admin.adoc#impersonating-system-admin[impersonating a system admin user].
53-
endif::openshift-dedicated,openshift-rosa[]
53+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5454

5555
[id="authorization-overview"]
5656
== About authorization in {product-title}
@@ -68,25 +68,25 @@ You can manage authorization for {product-title} through the following tasks:
6868

6969
* Creating a xref:../authentication/using-rbac.adoc#creating-local-role_using-rbac[local role] and assigning it to a user or group.
7070

71-
ifndef::openshift-dedicated,openshift-rosa[]
71+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7272
* Creating a cluster role and assigning it to a user or group: {product-title} includes a set of xref:../authentication/using-rbac.adoc#default-roles_using-rbac[default cluster roles]. You can create additional xref:../authentication/using-rbac.adoc#creating-cluster-role_using-rbac[cluster roles] and xref:../authentication/using-rbac.adoc#adding-roles_using-rbac[add them to a user or group].
73-
endif::openshift-dedicated,openshift-rosa[]
74-
ifdef::openshift-dedicated,openshift-rosa[]
73+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
74+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7575
* Assigning a cluster role to a user or group: {product-title} includes a set of xref:../authentication/using-rbac.adoc#default-roles_using-rbac[default cluster roles]. You can xref:../authentication/using-rbac.adoc#adding-roles_using-rbac[add them to a user or group].
76-
endif::openshift-dedicated,openshift-rosa[]
76+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7777

78-
ifndef::openshift-dedicated,openshift-rosa[]
78+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7979
* Creating a cluster-admin user: By default, your cluster has only one cluster administrator called `kubeadmin`. You can xref:../authentication/using-rbac.adoc#creating-cluster-admin_using-rbac[create another cluster administrator]. Before creating a cluster administrator, ensure that you have configured an identity provider.
8080
+
8181
[NOTE]
8282
====
8383
After creating the cluster admin user, xref:../authentication/remove-kubeadmin.adoc#removing-kubeadmin_removing-kubeadmin[delete the existing kubeadmin user] to improve cluster security.
8484
====
85-
endif::openshift-dedicated,openshift-rosa[]
85+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
8686

87-
ifdef::openshift-rosa[]
87+
ifdef::openshift-rosa,openshift-rosa-hcp[]
8888
* Creating cluster-admin and dedicated-admin users: The user who created the {product-title} cluster can grant access to other xref:../authentication/using-rbac.adoc#rosa-create-cluster-admins_using-rbac[`cluster-admin`] and xref:../authentication/using-rbac.adoc#rosa-create-dedicated-cluster-admins_using-rbac[`dedicated-admin`] users.
89-
endif::openshift-rosa[]
89+
endif::openshift-rosa,openshift-rosa-hcp[]
9090

9191
ifdef::openshift-dedicated[]
9292
* Granting administrator privileges to users: You can xref:../authentication/using-rbac.adoc#osd-grant-admin-privileges_using-rbac[grant `dedicated-admin` privileges to users].

authentication/ldap-syncing.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ toc::[]
99
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
1010
As an administrator,
1111
endif::[]
12-
ifdef::openshift-dedicated,openshift-rosa[]
12+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1313
As an administrator with the `dedicated-admin` role,
14-
endif::openshift-dedicated,openshift-rosa[]
14+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1515
you can use groups to manage users, change
1616
their permissions, and enhance collaboration. Your organization may have already
1717
created user groups and stored them in an LDAP server. {product-title} can sync
@@ -20,28 +20,28 @@ your groups in one place. {product-title} currently supports group sync with
2020
LDAP servers using three common schemas for defining group membership: RFC 2307,
2121
Active Directory, and augmented Active Directory.
2222

23-
ifndef::openshift-dedicated,openshift-rosa[]
23+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2424
For more information on configuring LDAP, see
2525
xref:../authentication/identity_providers/configuring-ldap-identity-provider.adoc#configuring-ldap-identity-provider[Configuring an LDAP identity provider].
26-
endif::openshift-dedicated,openshift-rosa[]
26+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2727

28-
ifdef::openshift-dedicated,openshift-rosa[]
28+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2929
For more information on configuring LDAP, see
3030
xref:../authentication/sd-configuring-identity-providers.adoc#config-ldap-idp_sd-configuring-identity-providers[Configuring an LDAP identity provider].
31-
endif::openshift-dedicated,openshift-rosa[]
31+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3232

3333
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
3434
[NOTE]
3535
====
3636
You must have `cluster-admin` privileges to sync groups.
3737
====
3838
endif::[]
39-
ifdef::openshift-dedicated,openshift-rosa[]
39+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4040
[NOTE]
4141
====
4242
You must have `dedicated-admin` privileges to sync groups.
4343
====
44-
endif::openshift-dedicated,openshift-rosa[]
44+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4545

4646
include::modules/ldap-syncing-about.adoc[leveloffset=+1]
4747
include::modules/ldap-syncing-config-rfc2307.adoc[leveloffset=+2]
@@ -54,7 +54,7 @@ include::modules/ldap-syncing-running-subset.adoc[leveloffset=+2]
5454
include::modules/ldap-syncing-pruning.adoc[leveloffset=+1]
5555

5656
// OSD and ROSA dedicated-admins cannot create the cluster roles and cluster role bindings required for this procedure.
57-
ifndef::openshift-dedicated,openshift-rosa[]
57+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5858
// Automatically syncing LDAP groups
5959
include::modules/ldap-auto-syncing.adoc[leveloffset=+1]
6060

@@ -63,7 +63,7 @@ include::modules/ldap-auto-syncing.adoc[leveloffset=+1]
6363

6464
* xref:../authentication/identity_providers/configuring-ldap-identity-provider.adoc#configuring-ldap-identity-provider[Configuring an LDAP identity provider]
6565
* xref:../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs-creating-cron_nodes-nodes-jobs[Creating cron jobs]
66-
endif::openshift-dedicated,openshift-rosa[]
66+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
6767
6868
include::modules/ldap-syncing-examples.adoc[leveloffset=+1]
6969
include::modules/ldap-syncing-rfc2307.adoc[leveloffset=+2]

authentication/managing-security-context-constraints.adoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Default SCCs are created during installation and when you install some Operators
1313
[IMPORTANT]
1414
====
1515
Do not modify the default SCCs. Customizing the default SCCs can lead to issues when some of the platform pods deploy or
16-
ifndef::openshift-rosa[]
16+
ifndef::openshift-rosa,openshift-rosa-hcp[]
1717
{product-title}
1818
endif::[]
19-
ifdef::openshift-rosa[]
19+
ifdef::openshift-rosa,openshift-rosa-hcp[]
2020
ROSA
21-
endif::openshift-rosa[]
21+
endif::openshift-rosa,openshift-rosa-hcp[]
2222
is upgraded. Additionally, the default SCC values are reset to the defaults during some cluster upgrades, which discards all customizations to those SCCs.
23-
ifdef::openshift-origin,openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-rosa[]
23+
ifdef::openshift-origin,openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2424
2525
Instead of modifying the default SCCs, create and modify your own SCCs as needed. For detailed steps, see xref:../authentication/managing-security-context-constraints.adoc#security-context-constraints-creating_configuring-internal-oauth[Creating security context constraints].
2626
endif::[]
@@ -47,4 +47,9 @@ include::modules/security-context-constraints-command-reference.adoc[leveloffset
4747
[id="additional-resources_configuring-internal-oauth"]
4848
== Additional resources
4949

50-
* xref:../support/getting-support.adoc#getting-support[Getting support]
50+
ifndef::openshift-rosa-hcp[]
51+
* xref:../support/getting-support.adoc#getting-support[Getting support]
52+
endif::openshift-rosa-hcp[]
53+
ifdef::openshift-rosa-hcp[]
54+
* link:https://docs.openshift.com/rosa/support/getting-support.html[Getting support]
55+
endif::openshift-rosa-hcp[]

authentication/sd-configuring-identity-providers.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ toc::[]
88

99
After your {product-title} cluster is created, you must configure identity providers to determine how users log in to access the cluster.
1010

11-
ifdef::openshift-rosa[]
11+
ifdef::openshift-rosa,openshift-rosa-hcp[]
1212
The following topics describe how to configure an identity provider using {cluster-manager} console. Alternatively, you can use the ROSA CLI (`rosa`) to configure an identity provider and access the cluster.
13-
endif::openshift-rosa[]
13+
endif::openshift-rosa,openshift-rosa-hcp[]
1414

1515
include::modules/understanding-idp.adoc[leveloffset=+1]
1616
include::modules/identity-provider-parameters.adoc[leveloffset=+2]

authentication/understanding-and-managing-pod-security-admission.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,17 @@ include::modules/security-context-constraints-psa-label.adoc[leveloffset=+1]
3434
include::modules/security-context-constraints-psa-rectifying.adoc[leveloffset=+1]
3535

3636
// OSD and ROSA dedicated-admin users cannot use the must-gather tool.
37-
ifndef::openshift-dedicated,openshift-rosa[]
37+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3838
// Identifying pod security violations
3939
include::modules/security-context-constraints-psa-alert-eval.adoc[leveloffset=+2]
40-
endif::openshift-dedicated,openshift-rosa[]
40+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4141

4242
[role="_additional-resources"]
4343
[id="additional-resources_managing-pod-security-admission"]
4444
== Additional resources
4545

46+
// Module not included in the HCP distro
47+
ifndef::openshift-rosa-hcp[]
4648
* xref:../security/audit-log-view.adoc#nodes-nodes-audit-log-basic-viewing_audit-log-view[Viewing audit logs]
49+
endif::openshift-rosa-hcp[]
4750
* xref:../authentication/managing-security-context-constraints.adoc#managing-pod-security-policies[Managing security context constraints]

0 commit comments

Comments
 (0)