Merge branch 'main' into RHIDP-5421

Author: Gerry-Forde

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]

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.

assemblies/assembly-configuring-authorization-in-rhdh.adoc

@@ -43,6 +43,7 @@ include::assembly-managing-authorizations-by-using-external-files.adoc[leveloffs
 
 include::assembly-configuring-guest-access-with-rbac-ui.adoc[leveloffset=+1]
 
+include::modules/authorization/proc-delegating-rbac-access.adoc[leveloffset=+1]
 
 include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
 

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]

assemblies/assembly-configuring-high-availability.adoc

@@ -3,11 +3,19 @@
 [id="{context}"]
 = Configuring high availability in {product}
 
-Previously, {product} supports a single-instance application. With this configuration, if the instance fails due to software crashes, hardware issues, or other unexpected disruptions, the entire {product} service becomes unavailable, preventing the development workflows or access to the resources. With high availability, you receive a failover mechanism that ensures the service is available even if one or more components fail. By increasing the number of replicas, you introduce redundancy to help increase higher productivity and minimize disruption.
 
-As an administrator, you can configure high availability in {product}. Once you set the high availability option in {product-short}, the {ocp-brand-name} built-in Load Balancer manages the ingress traffic and distributes the load to each pod. The {product-very-short} backend also manages concurrent requests or conflicts on the same resource. 
+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.
 
-You can configure high availability in {product-short} by scaling your `replicas` to a number greater than 1 in your configuration file. The configuration file that you use depends on the method that you used to install your {product-short} instance. If you used the Operator to install your {product-short} instance, configure the replica values in your `{product-custom-resource-type}` custom resource. If you used the Helm chart to install your {product-short} instance, configure the replica values in your Helm chart.
+{product} supports HA deployments on {ocp-brand-name} and {aks-name}. The HA deployments enable more resilient and reliable service availability across supported environments.
+
+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.
+
+With HA enabled, you can scale the number of backend replicas to introduce redundancy. This setup ensures that if one pod or component fails, others continue to serve requests without disruption. The built-in load balancer manages ingress traffic and distributes the load across the available pods. Meanwhile, the {product-very-short} backend manages concurrent requests and resolves resource-level conflicts effectively.
+
+As an administrator, you can configure high availability by adjusting replica values in your configuration file:
+
+* If you installed using the Operator, configure the replica values in your `{product-custom-resource-type}` custom resource.
+* If you used the Helm chart, set the replica values in the Helm configuration.
 
 include::modules/configuring-high-availability/proc-configuring-high-availability-in-rhdh-operator-deployment.adoc[leveloffset=+1]
 

assemblies/assembly-configuring-the-global-header.adoc

@@ -6,7 +6,7 @@
 As an administrator, you can configure the {product} global header to create a consistent and flexible navigation bar across your {product-short} instance.
 By default, the {product-short} global header includes the following components:
 
-* *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}
+* *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}
 * *Support* button that can link an internal or external support page
 * *Notifications* button displays alerts and updates from plugins and external services
 * *Search* input field allows users to find services, components, documentation, and other resources within {product-short}

assemblies/assembly-logging-with-amazon-cloudwatch.adoc

@@ -0,0 +1,16 @@
+[id="assembly-logging-with-amazon-cloudwatch_{context}"]
+= Logging with Amazon CloudWatch
+
+Logging within the {product} relies on the link:https://github.com/winstonjs/winston[Winston library].
+The default logging level is `info`.
+To have more detailed logs, set the `LOG_LEVEL` environment variable to `debug` in your {product} instance.
+
+
+include::modules/observe/proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-operator.adoc[leveloffset=+1]
+
+
+include::modules/observe/proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-helm-chart.adoc[leveloffset=+1]
+
+
+include::modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc[leveloffset=+1]
+

assemblies/assembly-managing-labels-annotations-topology.adoc

@@ -0,0 +1,20 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="assembly-managing-labels-annotations-topology"]
+= Managing labels and annotations for Topology plugins
+:context: assembly-managing-labels-annotations-topology
+
+include::modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc[leveloffset=+1]
+
+include::modules/dynamic-plugins/proc-entity-annotation-or-label.adoc[leveloffset=+1]
+
+include::modules/dynamic-plugins/proc-namespace-annotation.adoc[leveloffset=+1]
+
+include::modules/dynamic-plugins/proc-label-selector-query-annotation.adoc[leveloffset=+1]
+
+include::modules/dynamic-plugins/proc-icon-displayed-in-the-node.adoc[leveloffset=+1]
+
+include::modules/dynamic-plugins/proc-app-grouping.adoc[leveloffset=+1]
+
+include::modules/dynamic-plugins/proc-node-connector.adoc[leveloffset=+1]
+
+For more information about the labels and annotations, see _Guidelines for labels and annotations for OpenShift applications_.

assemblies/assembly-monitoring-and-logging-with-aws.adoc

@@ -0,0 +1,11 @@
+[id="assembly-monitoring-and-logging-with-aws_{context}"]
+= Monitoring and logging {product} on {aws-brand-name} ({aws-short})
+
+You can configure {product} to use Amazon CloudWatch for real-time monitoring and Amazon Prometheus for comprehensive logging.
+This is convenient when hosting {product-short} on {aws-brand-name} ({aws-short}) infrastructure.
+
+include::assembly-monitoring-with-amazon-prometheus.adoc[leveloffset=+1]
+
+
+include::assembly-logging-with-amazon-cloudwatch.adoc[leveloffset=+1]
+

assemblies/assembly-monitoring-with-amazon-prometheus.adoc

@@ -0,0 +1,22 @@
+[id="assembly-monitoring-with-amazon-prometheus_{context}"]
+= Monitoring with Amazon Prometheus
+
+You can configure {product} to use Amazon Prometheus for comprehensive logging.
+Amazon Prometheus extracts data from pods that have specific pod annotations.
+
+== Prerequisites
+
+* You link:https://docs.aws.amazon.com/eks/latest/userguide/prometheus.htm[configured Prometheus for your {eks-name} ({eks-short}) clusters].
+* You link:https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-create-workspace.html[created an Amazon managed service for the Prometheus workspace].
+* You link:https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-ingest-metrics.html[configured Prometheus to import the {product-short} metrics].
+* You ingested Prometheus metrics into the created workspace.
+
+
+include::modules/observe/proc-configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-operator.adoc[leveloffset=+1]
+
+
+include::modules/observe/proc-configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-helm-chart.adoc[leveloffset=+1]
+
+
+
+