You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-readme.adoc
+4-32Lines changed: 4 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,7 @@ The Keycloak backend plugin, which integrates Keycloak into {product-short}, has
6
6
* Synchronization of Keycloak users in a realm.
7
7
* Synchronization of Keycloak groups and their users in a realm.
8
8
9
-
== For administrators
10
-
11
-
=== Installation
9
+
== Installation
12
10
13
11
The Keycloak plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows:
14
12
@@ -23,7 +21,7 @@ global:
23
21
disabled: false
24
22
----
25
23
26
-
=== Basic configuration
24
+
== Basic configuration
27
25
To enable the Keycloak plugin, you must set the following environment variables:
28
26
29
27
* `KEYCLOAK_BASE_URL`
@@ -36,7 +34,7 @@ To enable the Keycloak plugin, you must set the following environment variables:
36
34
37
35
* `KEYCLOAK_CLIENT_SECRET`
38
36
39
-
=== Advanced configuration
37
+
== Advanced configuration
40
38
41
39
.Schedule configuration
42
40
You can configure a schedule in the `app-config.yaml` file, as follows:
@@ -140,7 +138,7 @@ When using client credentials, the access type must be set to `confidential` and
140
138
* `query-users`
141
139
* `view-users`
142
140
143
-
=== Limitations
141
+
== Limitations
144
142
145
143
If you have self-signed or corporate certificate issues, you can set the following environment variable before starting {product-short}:
146
144
@@ -152,29 +150,3 @@ If you have self-signed or corporate certificate issues, you can set the followi
152
150
The solution of setting the environment variable is not recommended.
153
151
====
154
152
155
-
== For users
156
-
157
-
=== Import of users and groups in {product-short} using the Keycloak plugin
158
-
159
-
After configuring the plugin successfully, the plugin imports the users and groups each time when started.
160
-
161
-
[NOTE]
162
-
====
163
-
If you set up a schedule, users and groups will also be imported.
164
-
====
165
-
166
-
After the first import is complete, you can select *User* to list the users from the catalog page:
Copy file name to clipboardExpand all lines: assemblies/assembly-configuring-the-global-header.adoc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
As an administrator, you can configure the {product} global header to create a consistent and flexible navigation bar across your {product-short} instance.
7
7
By default, the {product-short} global header includes the following components:
8
8
9
-
* *Create* button provides quick access to a variety of templates, enabling users to efficiently set up services, backend and front-end plugins within {product-short}
9
+
* *Self-service* button provides quick access to a variety of templates, enabling users to efficiently set up services, backend and front-end plugins within {product-short}
10
10
* *Support* button that can link an internal or external support page
11
11
* *Notifications* button displays alerts and updates from plugins and external services
12
12
* *Search* input field allows users to find services, components, documentation, and other resources within {product-short}
Copy file name to clipboardExpand all lines: modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
= Customizing your {product} global header
3
3
4
4
You can use the `red-hat-developer-hub.backstage-plugin-global-header` dynamic plugin to extend the global header with additional buttons and customize the order and position of icons and features. Additionally, you can create and integrate your custom dynamic header plugins using the mount points provided by this new header feature, allowing you to further tailor to suit your needs.
5
-
For more information on enabling dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
5
+
For more information about enabling dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
6
6
7
7
.Default global header configuration
8
8
@@ -42,7 +42,7 @@ For more information on enabling dynamic plugins, see link:{installing-and-viewi
42
42
config:
43
43
priority: 90
44
44
props:
45
-
title: Create...
45
+
title: Self-service
46
46
icon: add
47
47
to: create
48
48
- mountPoint: global.header/component
@@ -76,7 +76,7 @@ For more information on enabling dynamic plugins, see link:{installing-and-viewi
76
76
----
77
77
<1> *search*: Hides the *Search* modal in the sidebar menu. Change it to `true` to display the *Search* modal in the sidebar.
78
78
<2> *settings*: Hides the *Settings* button in the sidebar menu. Change it to `true` to display the *Settings* button in the sidebar.
79
-
<3> `default.main-menu-items`: Hides the *Create* button from the sidebar menu. Remove this field to display the *Create* button in the sidebar.
79
+
<3> `default.main-menu-items`: Hides the *Self-service* button from the sidebar menu. Remove this field to display the *Self-service* button in the sidebar.
80
80
<4> *position*: Defines the position of the header. Options: `above-main-content` or `above-sidebar`.
81
81
82
82
To extend the functionality of the default global header, include any the following attributes in your global header entry:
@@ -91,16 +91,16 @@ The `red-hat-developer-hub.backstage-plugin-global-header` package (enabled by d
91
91
92
92
- **`SearchComponent`**: Adds a search bar (enabled by default).
93
93
- **`Spacer`**: Adds spacing in the header to position buttons at the end. Useful when you disable `SearchComponent`.
94
-
- **`HeaderIconButton`**: Adds an icon button. By default, the *Create* icon button remains enabled.
94
+
- **`HeaderIconButton`**: Adds an icon button. By default, the *Self-service* icon button remains enabled.
95
95
- **`SupportButton`**: Adds a *Support* icon button, allowing users to configure a link to an internal or external page. Enabled by default but requires additional configuration to display.
96
96
- **`NotificationButton`**: Adds a *Notifications* icon button to display unread notifications in real time and navigate to the *Notifications* page. Enabled by default (requires the notifications plugin).
97
97
- **`Divider`**: Adds a vertical divider. By default, a divider appears between the profile dropdown and other header components.
98
98
- **`ProfileDropdown`**: Adds a profile dropdown showing the logged-in user's name. By default, it contains two menu items.
99
99
- **`MenuItemLink`**: Adds a link item in a dropdown menu. By default, the profile dropdown includes a link to the *Settings* page.
100
100
- **`LogoutButton`**: Adds a logout button in the profile dropdown (enabled by default).
101
-
- **`CreateDropdown`**: Adds a *Create* dropdown button (disabled by default). The menu items are configurable.
102
-
- **`SoftwareTemplatesSection`**: Adds a list of software template links to the *Create* dropdown menu (disabled by default). You must enable `CreateDropdown`.
103
-
- **`RegisterAComponentSection`**: Adds a link to the *Register a Component* page in the *Create* dropdown menu (disabled by default). You must enable `CreateDropdown`.
101
+
- **`CreateDropdown`**: Adds a *Self-service* dropdown button (disabled by default). The menu items are configurable.
102
+
- **`SoftwareTemplatesSection`**: Adds a list of software template links to the *Self-service* dropdown menu (disabled by default). You must enable `CreateDropdown`.
103
+
- **`RegisterAComponentSection`**: Adds a link to the *Register a Component* page in the *Self-service* dropdown menu (disabled by default). You must enable `CreateDropdown`.
104
104
105
105
`config.position`::
106
106
Specifies the position of the header. Supported values are `above-main-content` and `above-sidebar`.
Copy file name to clipboardExpand all lines: modules/customizing-templates/proc-creating-templates.adoc
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -14,10 +14,10 @@ You can create a template by using the Template Editor.
14
14
+
15
15
image::rhdh/template-editor.png[Template Editor]
16
16
** Open the URL `\https://<rhdh_url>/create/edit` for your {product} instance.
17
-
** Click *Create...* in the navigation menu of the {product} console, then click the overflow menu button and select *Template editor*.
17
+
** Click *Self-service* in the navigation menu of the {product} console, then click the overflow menu button and select *Template editor*.
18
18
. Click *Edit Template Form*.
19
19
. Optional: Modify the YAML definition for the parameters of your template. For more information about these parameters, see <<Creating a template as a YAML file>>.
20
-
. In the *Name ** field, enter a unique name for your template.
20
+
. In the *Name* field, enter a unique name for your template.
21
21
. From the *Owner* drop-down menu, choose an owner for the template.
22
22
. Click *Next*.
23
23
. In the *Repository Location* view, enter the following information about the hosted repository that you want to publish the template to:
Copy file name to clipboardExpand all lines: modules/customizing-templates/ref-creating-templates.adoc
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -57,8 +57,8 @@ spec:
57
57
# ...
58
58
----
59
59
<1> Specify a name for the template.
60
-
<2> Specify a title for the template. This is the title that is visible on the template tile in the *Create...* view.
61
-
<3> Specify a description for the template. This is the description that is visible on the template tile in the *Create...* view.
60
+
<2> Specify a title for the template. This is the title that is visible on the template tile in the *Self-service* view.
61
+
<3> Specify a description for the template. This is the description that is visible on the template tile in the *Self-service* view.
62
62
<4> Specify the ownership of the template. The `owner` field provides information about who is responsible for maintaining or overseeing the template within the system or organization. In the provided example, the `owner` field is set to `backstage/techdocs-core`. This means that this template belongs to the `techdocs-core` project in the `backstage` namespace.
63
63
<5> Specify the component type. Any string value is accepted for this required field, but your organization should establish a proper taxonomy for these. {product} instances may read this field and behave differently depending on its value. For example, a `website` type component may present tooling in the {product} interface that is specific to just websites.
0 commit comments