redhat-developer · jmagak · Apr 3, 2025 · Apr 3, 2025 · Apr 3, 2025 · Apr 8, 2025
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1 +1,5 @@
-{}
+{
+    "cSpell.words": [
+        "preconfigured"
+    ]
+}
diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc
@@ -10,10 +10,13 @@
 :product: Red Hat Developer Hub
 :product-short: Developer Hub
 :product-very-short: RHDH
-:product-version: 1.5
-:product-bundle-version: 1.5.0
-:product-chart-version: 1.5.0
-:product-backstage-version: 1.35.0
+:product-local: Red Hat Developer Hub Local
+:product-local-very-short: RHDH Local
+:product-version: 1.6
+:product-bundle-version: 1.6.0
+:product-chart-version: 1.6.0
+:product-backstage-version: 1.36.1
+:product-version-next: 1.7
 :product-custom-resource-type: Backstage
 :rhdeveloper-name: Red Hat Developer
 :rhel: Red Hat Enterprise Linux
@@ -47,7 +50,7 @@
 :rhsso: RHSSO
 :rhbk-brand-name: Red Hat Build of Keycloak
 :rhbk: RHBK
-:keycloak-version: 24.0
+:keycloak-version: 26.0
 
 // RHTAP information
 :rhtap-version: 1.3
@@ -140,7 +143,7 @@
 :extend-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Extend
 :introduction-to-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/introduction_to_plugins/index
 :introduction-to-plugins-book-title: Introduction to plugins
-:configuring-dynamic-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/introduction_to_plugins/index
+:configuring-dynamic-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
 :configuring-dynamic-plugins-book-title: Configuring dynamic plugins
 :installing-and-viewing-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
 :installing-and-viewing-plugins-book-title: Installing and viewing plugins in {product}

diff --git a/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc b/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc
@@ -143,6 +143,64 @@ When using client credentials, the access type must be set to `confidential` and
 * `query-users`
 * `view-users`
 
+== Metrics
+
+The Keycloak backend plugin supports link:https://opentelemetry.io/[OpenTelemetry] metrics that you can use to monitor fetch operations and diagnose potential issues.
+
+=== Available Counters
+
+.Keycloak metrics
+[cols="60%,40%", frame="all", options="header"]
+|===
+|Metric Name
+|Description
+| `backend_keycloak_fetch_task_failure_count_total`       | Counts fetch task failures where no data was returned due to an error.
+| `backend_keycloak_fetch_data_batch_failure_count_total` | Counts partial data batch failures. Even if some batches fail, the plugin continues fetching others.
+|===
+
+=== Labels
+
+All counters include the `taskInstanceId` label, which uniquely identifies each scheduled fetch task. You can use this label to trace failures back to individual task executions. 
+
+Users can enter queries in the Prometheus UI or Grafana to explore and manipulate metric data. 
+
+In the following examples, a Prometheus Query Language (PromQL) expression returns the number of backend failures.
+
+.Example to get the number of backend failures associated with a `taskInstanceId` 
+[source,subs="+attributes,+quotes"]
+----
+backend_keycloak_fetch_data_batch_failure_count_total{taskInstanceId="df040f82-2e80-44bd-83b0-06a984ca05ba"} 1
+----
+
+.Example to get the number of backend failures during the last hour
+
+[source,subs="+attributes,+quotes"]
+----
+sum(backend_keycloak_fetch_data_batch_failure_count_total) - sum(backend_keycloak_fetch_data_batch_failure_count_total offset 1h)
+----
+
+[NOTE]
+====
+PromQL supports arithmetic operations, comparison operators, logical/set operations, aggregation, and various functions. Users can combine these features to analyze time-series data effectively.
+
+Additionally, the results can be visualized using Grafana.
+====
+
+// === Use Case Example
+
+// Imagine your Keycloak instance is under-provisioned (e.g., low CPU/RAM limits), and the plugin is configured to send many parallel API requests.  
+// This could cause request timeouts or throttling. The metrics described above can help detect such behavior early, allowing administrators to:
+
+// - Tune the plugin configuration (e.g., reduce parallelism)
+// - Increase resources on the Keycloak server
+// - Investigate network or permission issues
+
+=== Exporting Metrics
+
+You can export metrics using any OpenTelemetry-compatible backend, such as *Prometheus*.
+
+See the link:https://backstage.io/docs/tutorials/setup-opentelemetry[Backstage OpenTelemetry setup guide] for integration instructions.
+
 == Limitations
 
 If you have self-signed or corporate certificate issues, you can set the following environment variable before starting {product-short}:

diff --git a/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-readme.adoc
@@ -6,9 +6,7 @@ The Keycloak backend plugin, which integrates Keycloak into {product-short}, has
 * Synchronization of Keycloak users in a realm.
 * Synchronization of Keycloak groups and their users in a realm.
 
-== For administrators
-
-=== Installation
+== Installation
 
 The Keycloak plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows:
 
@@ -23,7 +21,7 @@ global:
         disabled: false
 ----
 
-=== Basic configuration
+== Basic configuration
 To enable the Keycloak plugin, you must set the following environment variables:
 
 * `KEYCLOAK_BASE_URL`
@@ -36,7 +34,7 @@ To enable the Keycloak plugin, you must set the following environment variables:
 
 * `KEYCLOAK_CLIENT_SECRET`
 
-=== Advanced configuration
+== Advanced configuration
 
 .Schedule configuration
 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
 * `query-users`
 * `view-users`
 
-=== Limitations
+== Limitations
 
 If you have self-signed or corporate certificate issues, you can set the following environment variable before starting {product-short}:
 
@@ -152,29 +150,3 @@ If you have self-signed or corporate certificate issues, you can set the followi
 The solution of setting the environment variable is not recommended.
 ====
 
-== For users
-
-=== Import of users and groups in {product-short} using the Keycloak plugin
-
-After configuring the plugin successfully, the plugin imports the users and groups each time when started.
-
-[NOTE]
-====
-If you set up a schedule, users and groups will also be imported.
-====
-
-After the first import is complete, you can select *User* to list the users from the catalog page:
-
-image::rhdh-plugins-reference/users.jpg[catalog-list]
-
-You can see the list of users on the page:
-
-image::rhdh-plugins-reference/user-list.jpg[user-list]
-
-When you select a user, you can see the information imported from Keycloak:
-
-image::rhdh-plugins-reference/user2.jpg[user-profile]
-
-You can also select a group, view the list, and select or view the information imported from Keycloak for a group:
-
-image::rhdh-plugins-reference/group1.jpg[group-profile]
diff --git a/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc b/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc
@@ -15,18 +15,11 @@ After configuring the plugin successfully, the plugin imports the users and grou
 If you set up a schedule, users and groups will also be imported.
 ====
 
-After the first import is complete, you can select *User* to list the users from the catalog page:
-
-image::rhdh-plugins-reference/users.jpg[catalog-list]
-
-You can see the list of users on the page:
-
-image::rhdh-plugins-reference/user-list.jpg[user-list]
-
-When you select a user, you can see the information imported from Keycloak:
-
-image::rhdh-plugins-reference/user2.jpg[user-profile]
-
-You can also select a group, view the list, and select or view the information imported from Keycloak for a group:
-
-image::rhdh-plugins-reference/group1.jpg[group-profile]
+.Procedure
+. in {product}, go to the *Catalog* page.
+. Select *User* from the entity type filter to display the list of imported users.
+. Browse the list of users displayed on the page.
+. Select a user to view detailed information imported from Keycloak.
+. To view groups, select *Group* from the entity type filter.
+. Browse the list of groups shown on the page.
+. From the list of groups, select a group to view the information imported from Keycloak.
diff --git a/assemblies/assembly-about-rhdh.adoc b/assemblies/assembly-about-rhdh.adoc
@@ -12,11 +12,18 @@ endif::[]
 
 :context: about-rhdh
 
-{product} ({product-very-short}) is an enterprise-grade internal developer portal designed to simplify and streamline software development processes. Combined with {ocp-brand-name}, {product-very-short} empowers platform engineering teams to create customized portals that improve developer productivity, accelerate onboarding, and enable faster application delivery. By reducing friction and complexity, {product-very-short} allows developers to focus on writing high-quality code while adhering to enterprise-class best practices.
+{product} ({product-very-short}) is an enterprise-grade internal developer portal (IDP) that helps simplify and accelerates software delivery. It provides a customizable web-based interface that centralizes access to key development resources, including source code repositories, CI and CD pipelines, APIs, documentation, and runtime environments.
 
-{product-very-short} integrates software templates, pre-designed solutions, and dynamic plugins into a centralized platform, providing tailored solutions for operations and development teams in a unified environment.
+{product} is designed for cloud-native environments, including supported Kubernetes platforms, {ocp-brand-name}, and hybrid infrastructure. By consolidating tools and standardizing development workflows, it helps teams deliver software faster with more consistency.
+
+Designed for enterprise-scale software teams, {product-very-short} helps developers focus on building software rather than managing tools. Developers can onboard quickly, create environments, and integrate with existing systems. With enterprise-grade security, role-based access control, and 24x7 support, teams stay productive while meeting compliance and reliability standards.
+
+include::modules/about/con_understanding-internal-developer-platforms.adoc[leveloffset=+1]
+
+// {product-very-short} integrates software templates, pre-designed solutions, and dynamic plugins into a centralized platform, providing tailored solutions for operations and development teams in a unified environment.
+
+// include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]
 
-include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]
 include::modules/about/con-integrations-in-rhdh.adoc[leveloffset=+1]
 include::modules/about/ref-supported-platforms.adoc[leveloffset=+1]
 include::modules/about/ref-rhdh-sizing.adoc[leveloffset=+1]

diff --git a/assemblies/assembly-about-software-catalogs.adoc b/assemblies/assembly-about-software-catalogs.adoc
@@ -0,0 +1,30 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: about-software-catalogs
+[id="{context}"]
+= About Software Catalogs
+
+The {product} Software Catalog is a centralized system that gives you visibility into all the software across your ecosystem, including services, websites, libraries, and data pipelines. You can use it to view ownership details and metadata for each component in one place.
+
+The metadata for the components in your Software Catalog is stored as YAML files that live alongside your code in your version control system. The version control repositories can include one or many metadata files. Software Catalog organizes items as entities, which include Components, Resources, and APIs, and other related types. Each entity includes associated metadata such as its owner, type, and other relevant details.
+
+By storing metadata in YAML files alongside the code, you allow {product} to process and display this information through a clear, visual interface. With the Software Catalog, you can manage and maintain your software, stay aware of all software available in your ecosystem, and take ownership of your services and tools.
+
+//[Add a Software Catalog screenshot of the latest build]
+
+The *Overview* page for a component provides key information such as links to the source code, documentation, dependencies, and ownership details. You can customize this page with plugins to suit specific needs.
+
+//[Add any Component screenshot of the latest build]
+
+include::modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc[leveloffset=+1]
+
+include::modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc[leveloffset=+2]
+
+include::modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc[leveloffset=+2]
+
+include::modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc[leveloffset=+1]
+
+include::modules/software-catalogs/proc-searching-and-filter-software-catalogs.adoc[leveloffset=+1]
+
+include::modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc[leveloffset=+1]
+
+include::modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc[leveloffset=+1]
diff --git a/assemblies/assembly-audit-log.adoc b/assemblies/assembly-audit-log.adoc
@@ -30,17 +30,9 @@ Audit logs are not forwarded to the internal log store by default because this d
 .Additional resources
 
 * For more information about logging in {ocp-short}, see link:https://docs.openshift.com/container-platform/latest/observability/logging/cluster-logging.html[About Logging]
-* For a complete list of fields that a {product-short} audit log can include, see xref:ref-audit-log-fields.adoc_{context}[]
-* For a list of scaffolder events that a {product-short} audit log can include, see xref:ref-audit-log-scaffolder-events.adoc_{context}[]
 
 include::modules/observe/con-audit-log-config.adoc[]
 
 include::modules/observe/proc-forward-audit-log-splunk.adoc[leveloffset=+2]
 
-include::modules/observe/proc-audit-log-view.adoc[]
-
-include::modules/observe/ref-audit-log-fields.adoc[leveloffset=+2]
-
-include::modules/observe/ref-audit-log-scaffolder-events.adoc[leveloffset=+2]
-
-include::modules/observe/ref-audit-log-catalog-events.adoc[leveloffset=+2]
+include::modules/observe/proc-audit-log-view.adoc[]
diff --git a/assemblies/assembly-authenticating-with-rhbk.adoc b/assemblies/assembly-authenticating-with-rhbk.adoc
@@ -1,11 +1,6 @@
 [id="assembly-authenticating-with-rhbk"]
 = Authenticating with {rhbk-brand-name} ({rhbk})
 
-[NOTE]
-====
-{rhsso} 7.6 is deprecated as an authentication provider. You can continue using {rhsso} until the end of its maintenance support. For more information, see link:https://access.redhat.com/support/policy/updates/jboss_notes#p_sso[{rhsso} lifecycle dates]. As an alternative, consider migrating to {rhbk-brand-name} ({rhbk}).
-====
-
 To authenticate users with {rhbk-brand-name} ({rhbk}):
 
 . xref:enabling-authentication-with-rhbk[Enable the OpenID Connect (OIDC) authentication provider in RHDH].

diff --git a/assemblies/assembly-configuring-a-floating-action-button.adoc b/assemblies/assembly-configuring-a-floating-action-button.adoc
@@ -5,4 +5,6 @@
 
 You can use the floating action button plugin to configure any action as a floating button in the {product-short} instance. The floating action button plugin is enabled by default. You can also configure floating action buttons to display as submenu options within the main floating action button by assigning the floating action buttons to the same `slot` field of your `dynamic-plugins.yaml` file.
 
-include::modules/configuring-a-floating-action-button/proc-configuring-floating-action-button-as-a-dynamic-plugin.adoc[leveloffset=+1]
+include::modules/configuring-a-floating-action-button/proc-configuring-floating-action-button-as-a-dynamic-plugin.adoc[leveloffset=+1]
+
+include::modules/configuring-a-floating-action-button/ref-floating-action-button-parameters.adoc[leveloffset=+1]
diff --git a/assemblies/assembly-configuring-authorization-in-rhdh.adoc b/assemblies/assembly-configuring-authorization-in-rhdh.adoc
@@ -1,26 +1,18 @@
 [id='configuring-authorization-in-rhdh']
 = Configuring authorization in {product}
 
-In link:{authorization-book-url}[{authentication-book-title}], you learnt how to authenticate users to {product}.
-{product-short} knowns who the users are.
+Administrators can authorize users to perform actions and define what users can do in {product-short}.
 
-In this book, learn how to authorize users to perform actions in {product-short}.
-Define what users can do in {product-short}.
+Role-based access control (RBAC) is a security concept that defines how to control access to resources in a system by specifying a mapping between users of the system and the actions that those users can perform on resources in the system.
+You can use RBAC to define roles with specific permissions and then assign the roles to users and groups.
 
-Role-Based Access Control (RBAC) is a security concept that controls access to resources in a system, and specifies a mapping between users of the system, and the actions they can perform on resources in the system.
-You define roles with specific permissions, and then assign the roles to users and groups.
+RBAC on {product-short} is built on top of the Permissions framework, which defines RBAC policies in code. Rather than defining policies in code, you can use the {product-short} RBAC feature to define policies in a declarative fashion by using a simple CSV based format. You can define the policies by using {product-short} web interface or REST API instead of editing the CSV directly.
 
-RBAC on {product-short} is built on top of the Permissions framework, which defines RBAC policies in code.
-Rather than defining policies in code,
-the {product-short} RBAC feature allows you
-to define policies in a declarative fashion using a simple CSV based format.
-You can define the policies by using {product-short} web interface or REST API, rather than editing the CSV directly.
+An administrator can define authorizations in {product-short} by taking the following steps:
 
-To define authorizations in {product-short}:
+. Enable the RBAC feature and give authorized users access to the feature.
 
-. The {product-short} administrator enables and gives access to the RBAC feature.
-
-. You define your roles and policies by combining the following methods:
+. Define roles and policies by combining the following methods:
 
 * The {product-short} policy administrator uses the {product-short} web interface or REST API.
 * The {product-short} administrator edits the main {product-short} configuration file.
@@ -43,6 +35,7 @@ include::assembly-managing-authorizations-by-using-external-files.adoc[leveloffs
 
 include::assembly-configuring-guest-access-with-rbac-ui.adoc[leveloffset=+1]
 
+include::assembly-delegating-rbac-access-rhdh.adoc[leveloffset=+1]
 
 include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
 
@@ -57,4 +50,3 @@ include::modules/authorization/con-user-stats-rhdh.adoc[leveloffset=+1]
 
 
 include::modules/authorization/proc-download-user-stats-rhdh.adoc[leveloffset=+2]
-
diff --git a/assemblies/assembly-configuring-default-secret-pvc-mounts.adoc b/assemblies/assembly-configuring-default-secret-pvc-mounts.adoc
@@ -0,0 +1,9 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="assembly-configuring-default-secret-pvc-mounts_{context}"]
+= Configuring default mounts for Secrets and PVCs
+
+You can configure Persistent Volume Claims (PVCs) and Secrets mount in your {product} deployment. Use annotations to define the custom mount paths and specify the containers to mount them to.
+
+include::modules/configuring-external-databases/proc-configuring-mount-paths.adoc[leveloffset=+1]
+
+include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+1]