Skip to content

Commit 536502f

Browse files
authored
Merge branch 'main' into rhdh-cli
2 parents af690b0 + 1e4feaf commit 536502f

File tree

36 files changed

+1047
-1059
lines changed

36 files changed

+1047
-1059
lines changed

artifacts/attributes.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,9 @@
9999
:release-notes-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/red_hat_developer_hub_release_notes/index
100100
:release-notes-book-title: {product} release notes
101101

102+
:getting-started-on-ocp-for-the-platform-engineer-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/getting_started_with_red_hat_developer_hub_on_red_hat_openshift_container_platform_for_the_platform_engineer/index
103+
:getting-started-on-ocp-for-the-platform-engineer-book-title: Getting started with {product} on {ocp-brand-name} for the platform engineer
104+
102105
:install-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Install
103106
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
104107
:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
@@ -113,6 +116,10 @@
113116
:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
114117
:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
115118

119+
:integrating-with-github-book-title: Integrating {product} with GitHub
120+
:integrating-with-github-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/integrating_red_hat_developer_hub_with_github/index
121+
122+
116123
:upgrade-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Upgrade
117124
:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
118125
:upgrading-book-title: Upgrading {product}

assemblies/assembly-authenticating-with-microsoft-azure.adoc

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
[id="assembly-authenticating-with-rhbk"]
22
= Authenticating with {rhbk-brand-name} ({rhbk})
33

4-
To authenticate users with {rhbk-brand-name} ({rhbk}):
54

6-
. xref:enabling-authentication-with-rhbk[Enable the OpenID Connect (OIDC) authentication provider in RHDH].
7-
. xref:provisioning-users-from-rhbk-to-the-software-catalog[Provision users from {rhbk-brand-name} ({rhbk}) to the software catalog].
5+
include::modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc[leveloffset=+1]
86

9-
include::modules/authentication/proc-enabling-authentication-with-rhbk.adoc[leveloffset=+1]
10-
11-
include::modules/authentication/proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc[leveloffset=+1]
127

138
include::modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc[leveloffset=+1]

assemblies/assembly-configuring-high-availability.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,13 @@
66

77
High availability (HA) is a system design approach that ensures a service remains continuously accessible, even during failures of individual components, by eliminating single points of failure. It introduces redundancy and failover mechanisms to minimize downtime and maintain operational continuity.
88

9-
{product} supports HA deployments on {ocp-brand-name} and {aks-name}. The HA deployments enable more resilient and reliable service availability across supported environments.
9+
{product} supports HA deployments on the following platforms:
10+
11+
* {ocp-brand-name}
12+
* {aks-name}
13+
* {eks-name}
14+
15+
The HA deployments enable more resilient and reliable service availability across supported environments.
1016

1117
In a single instance deployment, if a failure occurs, whether due to software crashes, hardware issues, or other unexpected disruptions, it would make the entire service unavailable, interrupting development workflows and access to key resources.
1218

assemblies/assembly-enabling-authentication.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ include::assembly-authenticating-with-rhbk.adoc[leveloffset=+1]
1616
include::modules/authentication/proc-enabling-user-authentication-with-github.adoc[leveloffset=+1]
1717

1818

19-
include::assembly-authenticating-with-microsoft-azure.adoc[leveloffset=+1]
19+
include::modules/authentication/proc-enabling-user-authentication-with-microsoft-azure.adoc[leveloffset=+1]
2020

modules/authentication/con-understanding-authentication-and-user-provisioning.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Catalog provider plugins handle this task asynchronously.
99
These plugins query the Identity Provider (IdP) for relevant user and group information, and create or update corresponding entities in the {product-short} catalog.
1010
Scheduled provisioning ensures that the catalog accurately reflects the users and groups in your organization.
1111

12-
When a user attempts to access {product-short}, {product-short} redirects them to a configured authentication provider, such as xref:assembly-authenticating-with-rhbk[{rhbk-brand-name} ({rhbk})], xref:enabling-user-authentication-with-github[GitHub], or xref:assembly-authenticating-with-microsoft-azure[{azure-brand-name}].
12+
When a user attempts to access {product-short}, {product-short} redirects them to a configured authentication provider, such as xref:assembly-authenticating-with-rhbk[{rhbk-brand-name} ({rhbk})], xref:enabling-user-authentication-with-github[GitHub], or xref:enabling-user-authentication-with-microsoft-azure[{azure-brand-name}].
1313
This external IdP is responsible for authenticating the user.
1414

1515
On successful authentication, the {product-short} authentication plugin, configured in your `{my-app-config-file}` file, processes the response from the IdP, resolves the identity in the {product-short} software catalog, and establishes a user session within {product-short}.

modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
To customize how {rhbk} users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.
55

66
.Prerequisites
7-
* You have xref:provisioning-users-from-rhbk-to-the-software-catalog[enabled provisioning users from {rhbk-brand-name} ({rhbk}) to the software catalog].
7+
* You have xref:enabling-user-authentication-with-rhbk[enabled provisioning users from {rhbk-brand-name} ({rhbk}) to the software catalog].
88

99
.Procedure
1010
. Create a new backend module with the `yarn new` command.

modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc

Lines changed: 0 additions & 172 deletions
This file was deleted.

modules/authentication/proc-enabling-user-authentication-with-github.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Enter your GitHub organization name, such as `__<your_github_organization_name>_
6161
This plugin ingests GitHub users and groups to the {product-short} software catalog.
6262
+
6363
.`dynamic-plugins.yaml` file fragment
64-
[code,yaml]
64+
[source,yaml]
6565
----
6666
plugins:
6767
- package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org'
@@ -207,3 +207,7 @@ WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-sh
207207
.. Your {product-short} sign-in page displays *Sign in using GitHub* and the Guest user sign-in is disabled.
208208
.. Log in with a GitHub account.
209209

210+
.Additional resources
211+
212+
* link:{integrating-with-github-book-url}[{integrating-with-github-book-title}].
213+

0 commit comments

Comments
 (0)