Skip to content

Commit 3a89a4d

Browse files
Gerry-Fordejmagak
Gerry-Forde
and
jmagak
authored
RHIDP-6792 - Move Dynamic Plugin Auth provider to Tech Preview Section (#1219)
* RHIDP-6792 - Move Dynamic Plugin Auth provider to Tech Preview Section * Update modules/release-notes/ref-release-notes-technology-preview.adoc Co-authored-by: Judith Magak <[email protected]> --------- Co-authored-by: Judith Magak <[email protected]>
1 parent 8467720 commit 3a89a4d

File tree

2 files changed

+59
-59
lines changed

2 files changed

+59
-59
lines changed

‎modules/release-notes/ref-release-notes-new-features.adoc‎

Lines changed: 0 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -37,65 +37,6 @@ The global header plugin also introduces new mount points in the dynamic plugin
3737

3838
For more information about global header, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/customizing_red_hat_developer_hub/index#configuring-the-global-header-in-rhdh[Configuring the global header in {product}].
3939

40-
[id="feature-rhidp-5484"]
41-
== Support for loading authentication providers from dynamic plugins
42-
43-
{product} {product-version} introduces support for loading authentication providers or modules from dynamic plugins, enabling greater flexibility and customization. The key improvements include:
44-
45-
* Environment variable control:
46-
** A new `ENABLE_AUTH_PROVIDER_MODULE_OVERRIDE` environment variable determines whether the backend installs the default authentication provider module.
47-
** When the new environment variable is enabled, dynamic plugins can be used to supply custom authentication providers.
48-
49-
* Custom sign-in page support:
50-
+
51-
--
52-
** A new `signInPage` configuration allows front-end dynamic plugins to provide a custom `SignInPage` component.
53-
+
54-
.Example configuration
55-
[source,yaml]
56-
----
57-
dynamicPlugins:
58-
frontend:
59-
my-plugin-package:
60-
signInPage:
61-
importName: CustomSignInPage
62-
----
63-
64-
** The exported `CustomSignInPage` will be mapped to `components.SignInPage` during front-end initialization.
65-
--
66-
67-
* Authentication provider settings:
68-
+
69-
--
70-
** A new `providerSettings` configuration field allows front-end dynamic plugins to define authentication provider settings for display in the *Authentication Providers* tab on the *Settings* page.
71-
+
72-
.Example configuration
73-
[source,yaml]
74-
----
75-
dynamicPlugins:
76-
frontend:
77-
my-plugin-package:
78-
providerSettings:
79-
- title: Github Two
80-
description: Sign in with GitHub Org Two
81-
provider: core.auth.github-two
82-
----
83-
84-
** Each `providerSettings` entry creates a corresponding row in the *Authentication Providers* tab. The provider field must match the string used in `createApiRef` when defining the API reference:
85-
+
86-
.Example configuration
87-
[source,javascript]
88-
----
89-
export const ghTwoAuthApiRef: ApiRef<
90-
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
91-
> = createApiRef({
92-
id: 'core.auth.github-two', // <--- this string
93-
})
94-
----
95-
--
96-
97-
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/authentication_in_red_hat_developer_hub/index[Authentication in {product}].
98-
9940
[id="feature-rhidp-5513"]
10041
== Floating action button support for plugins
10142

‎modules/release-notes/ref-release-notes-technology-preview.adoc‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,62 @@ For more information about Extensions, see link:https://docs.redhat.com/en/docum
2222
.Additional resources
2323
* link:https://issues.redhat.com/browse/RHIDP-2757[RHIDP-2757]
2424

25+
[id="technology-preview-rhidp-5484"]
26+
== Loading authentication providers from dynamic plugins
27+
28+
In {product} {product-version}, loading authentication providers or modules from dynamic plugins is available as a Technology Preview feature, enabling greater flexibility and customization. The key improvements include:
29+
30+
* Environment variable control:
31+
** A new `ENABLE_AUTH_PROVIDER_MODULE_OVERRIDE` environment variable determines whether the backend installs the default authentication provider module.
32+
** When the new environment variable is enabled, dynamic plugins can be used to supply custom authentication providers.
33+
34+
* Custom sign-in page support:
35+
+
36+
--
37+
** A new `signInPage` configuration allows front-end dynamic plugins to provide a custom `SignInPage` component.
38+
+
39+
.Example configuration
40+
[source,yaml]
41+
----
42+
dynamicPlugins:
43+
frontend:
44+
my-plugin-package:
45+
signInPage:
46+
importName: CustomSignInPage
47+
----
48+
49+
** The exported `CustomSignInPage` will be mapped to `components.SignInPage` during front-end initialization.
50+
--
51+
52+
* Authentication provider settings:
53+
+
54+
--
55+
** A new `providerSettings` configuration field allows front-end dynamic plugins to define authentication provider settings for display in the *Authentication Providers* tab on the *Settings* page.
56+
+
57+
.Example configuration
58+
[source,yaml]
59+
----
60+
dynamicPlugins:
61+
frontend:
62+
my-plugin-package:
63+
providerSettings:
64+
- title: Github Two
65+
description: Sign in with GitHub Org Two
66+
provider: core.auth.github-two
67+
----
68+
69+
** Each `providerSettings` entry creates a corresponding row in the *Authentication Providers* tab. The provider field must match the string used in `createApiRef` when defining the API reference:
70+
+
71+
.Example configuration
72+
[source,javascript]
73+
----
74+
export const ghTwoAuthApiRef: ApiRef<
75+
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
76+
> = createApiRef({
77+
id: 'core.auth.github-two', // <--- this string
78+
})
79+
----
80+
--
81+
82+
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/authentication_in_red_hat_developer_hub/index[Authentication in {product}].
83+

0 commit comments

Comments
 (0)