Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ The Nexus Repository Manager is a front-end plugin that enables you to view the
.Prerequisites

- Your {product-short} application is installed and running.
- You have installed the Nexus Repository Manager plugin. For the installation process, see <<Installing and configuring the Nexus Repository Manager plugin>>.
- You have installed the Nexus Repository Manager plugin. For the installation process, see documentation on Installing and configuring the Nexus Repository Manager plugin.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we’re including the statement, could you please clarify why the link is being removed?


.Procedure

Expand All @@ -100,3 +100,8 @@ The *BUILD ARTIFACTS* tab contains a list of build artifacts and related informa

image::rhdh-plugins-reference/nexus-repository-manager.png[nexus-repository-manager-tab]
--

[role="_additional-resources"]
.Additional resources

* <<Installing and configuring the Nexus Repository Manager plugin>>
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ The Nexus Repository Manager is a front-end plugin that enables you to view the
.Prerequisites

- Your {product-short} application is installed and running.
- You have installed the Nexus Repository Manager plugin.
//For the installation process, see xref:installing-configuring-nexus-plugin[Installing and configuring the Nexus Repository Manager plugin].
- You have installed the Nexus Repository Manager plugin.

.Procedure

Expand All @@ -31,3 +30,8 @@ The *BUILD ARTIFACTS* tab contains a list of build artifacts and related informa

image::rhdh-plugins-reference/nexus-repository-manager.png[nexus-repository-manager-tab]
--

//[role="_additional-resources"]
//.Additional resources

//* xref:installing-configuring-nexus-plugin[Installing and configuring the Nexus Repository Manager plugin]
12 changes: 9 additions & 3 deletions artifacts/rhdh-plugins-reference/ocm/ocm-plugin-readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The Red Hat Plug-ins for Backstage (RHPIB) packages are hosted in a separate NPM
----
# update your .npmrc or .yarnrc file
yarn config set "@redhat:registry" https://npm.registry.redhat.com
# then pull a package
# then pull a package
yarn add @redhat/backstage-plugin-quay
----

Expand All @@ -49,7 +49,7 @@ If you are interested in Resource discovery and do not want any of the front-end
==== Prerequisites

* OCM is deployed and configured on a Kubernetes cluster.
* https://backstage.io/docs/features/kubernetes[Kubernetes plugin for Backstage] is installed.
* Kubernetes plugin for Backstage is installed.
* A `ClusterRole` is granted to `ServiceAccount` accessing the hub cluster as follows:
+
--
Expand Down Expand Up @@ -410,7 +410,7 @@ The OCM plugin integrates your Backstage instance with multi-cluster engines and
==== Prerequisites

* Your Backstage application is installed and running.
* You have installed the OCM plugin. For the installation process, see <<Installation>>.
* You have installed the OCM plugin.

==== Procedure

Expand All @@ -437,3 +437,9 @@ You are redirected to the cluster-specific page, which consists of:

image::ocm-plugin-user2.png[ocm-plugin-ui]
--

[role="_additional-resources"]
.Additional resources

* <<Installing OCM plugin>>
* link:https://backstage.io/docs/features/kubernetes[Installing Kubernetes plugin for Backstage]
9 changes: 7 additions & 2 deletions artifacts/rhdh-plugins-reference/quay/quay-plugin-readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Red Hat Plug-ins for Backstage (RHPIB) packages are hosted in a separate NPM
----
# update your .npmrc or .yarnrc file
yarn config set "@redhat:registry" https://npm.registry.redhat.com
# then pull a package
# then pull a package
yarn add @redhat/backstage-plugin-quay
----

Expand Down Expand Up @@ -105,7 +105,7 @@ Quay is a front-end plugin that enables you to view the information about the co
.Prerequisites

* Your {product-short} application is installed and running.
* You have installed the Quay plugin. For installation process, see <<installation,Installation>>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than removing the links, I’d suggest keeping them and ensuring they follow a clear structure that aligns with our migration strategy, which we may need to address in the future. Please feel free to create a Jira for the link improvement effort if needed.

* You have installed the Quay plugin.

.Procedure

Expand All @@ -125,3 +125,8 @@ The vulnerabilities page displays the associated advisory with a link, severity,
image::quay-plugin-backstage3.png[quay-tab-vulnerabilities]
+
The advisory link redirects to the Red Hat Security Advisory page that contains detailed information about the advisory, including the solution.

[role="_additional-resources"]
.Additional resources

* <<installation,Installing the Quay plugin>>
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ You can use the Tekton plugin to visualize the results of CI/CD pipeline runs on

.Prerequisites
* You have installed and configured the `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` dynamic plugins.
//For more information about installing dynamic plugins, see xref:rhdh-installing-dynamic-plugins[].
//Cannot xref across titles. Convert xref to a link.

* You have configured the Kubernetes plugin to connect to the cluster using a `ServiceAccount`.

Expand Down Expand Up @@ -141,3 +139,8 @@ global:
disabled: false
----
--

//[role="_additional-resources"]
//.Additional resources

//* xref:rhdh-installing-dynamic-plugins[Installing dynamic plugins]
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ You can use the Tekton plugin to visualize the results of CI/CD pipeline runs on

.Prerequisites
* You have installed and configured the `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` dynamic plugins.
//For more information about installing dynamic plugins, see xref:rhdh-installing-dynamic-plugins[].
//Cannot xref across titles. Convert xref to a link.

* You have configured the Kubernetes plugin to connect to the cluster using a `ServiceAccount`.

Expand Down Expand Up @@ -152,7 +150,7 @@ You can use the Tekton front-end plugin to view `PipelineRun` resources.

.Prerequisites
* You have installed the Red Hat Developer Hub (RHDH).
* You have installed the Tekton plugin. For the installation process, see xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin].
* You have installed the Tekton plugin.

.Procedure
. Open your RHDH application and select a component from the *Catalog* page.
Expand All @@ -165,3 +163,9 @@ image::rhdh-plugins-reference/tekton-plugin-pipeline.png[ci-cd-tab-tekton]
. Click the expand row button besides PipelineRun name in the list to view the PipelineRun visualization. The pipeline run resource includes tasks to complete. When you hover the mouse pointer on a task card, you can view the steps to complete that particular task.
+
image::rhdh-plugins-reference/tekton-plugin-pipeline-expand.png[ci-cd-tab-tekton]

[role="_additional-resources"]
.Additional resources

* xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin]
//* xref:rhdh-installing-dynamic-plugins[]
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ You can use the Tekton front-end plugin to view `PipelineRun` resources.

.Prerequisites
* You have installed the Red Hat Developer Hub (RHDH).
* You have installed the Tekton plugin. For the installation process, see xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin].
* You have installed the Tekton plugin.

.Procedure
. Open your RHDH application and select a component from the *Catalog* page.
Expand All @@ -20,3 +20,8 @@ image::rhdh-plugins-reference/tekton-plugin-pipeline.png[ci-cd-tab-tekton]
. Click the expand row button besides PipelineRun name in the list to view the PipelineRun visualization. The pipeline run resource includes tasks to complete. When you hover the mouse pointer on a task card, you can view the steps to complete that particular task.
+
image::rhdh-plugins-reference/tekton-plugin-pipeline-expand.png[ci-cd-tab-tekton]

[role="_additional-resources"]
.Additional resources

* xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin]
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Red Hat Plug-ins for Backstage (RHPIB) packages are hosted in a separate NPM
----
# update your .npmrc or .yarnrc file
yarn config set "@redhat:registry" https://npm.registry.redhat.com
# then pull a package
# then pull a package
yarn add @redhat/backstage-plugin-quay
----

Expand All @@ -25,10 +25,10 @@ Using this configuration, you can proceed with the installation of the individua
endif::[]
.Prerequisites

* The Kubernetes plugins including `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` are installed and configured by following the https://backstage.io/docs/features/kubernetes/installation[installation] and https://backstage.io/docs/features/kubernetes/configuration[configuration] guides.
* The Kubernetes plugins including `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` are installed and configured by following the _installation_ and _configuration_ guides.
* The Kubernetes plugin is configured and connects to the cluster using a `ServiceAccount`.
* The https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`] must be granted to `ServiceAccount` accessing the cluster. If you have the {product-short} Kubernetes plugin configured, then the `ClusterRole` is already granted.
* The following must be added in``customResources`` component in the https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters[`app-config.yaml`] file to view the OpenShift route:
* The `ClusterRole` must be granted to `ServiceAccount` accessing the cluster. If you have the {product-short} Kubernetes plugin configured, then the `ClusterRole` is already granted.
* The following must be added in``customResources`` component in the `app-config.yaml` file to view the OpenShift route:
+
--
[source,yaml]
Expand All @@ -41,7 +41,7 @@ endif::[]
plural: 'routes'
----

Also, ensure that the route is granted a https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`]. You can use the following code to grant the `ClusterRole` to the route :
Also, ensure that the route is granted a `ClusterRole`. You can use the following code to grant the `ClusterRole` to the route :

[source,yaml]
----
Expand All @@ -63,7 +63,7 @@ Also, ensure that the route is granted a https://backstage.io/docs/features/kube
----
--

* The following permission must be granted to the https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`] to be able to view the pod logs:
* The following permission must be granted to the `ClusterRole` to be able to view the pod logs:
+
--
[source,yaml]
Expand All @@ -86,7 +86,7 @@ Also, ensure that the route is granted a https://backstage.io/docs/features/kube
----
--

* The following code must be added in `customResources` component in the https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters[`app-config.yaml`] file to view the Tekton PipelineRuns list in the side panel and to view the latest PipelineRun status in the Topology node decorator:
* The following code must be added in `customResources` component in the `app-config.yaml` file to view the Tekton PipelineRuns list in the side panel and to view the latest PipelineRun status in the Topology node decorator:
+
--
[source,yaml]
Expand All @@ -105,7 +105,7 @@ Also, ensure that the route is granted a https://backstage.io/docs/features/kube
plural: 'taskruns'
----

Also, ensure that the Pipeline, PipelineRun, and TaskRun are granted a https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`]. You can use the following code to grant the `ClusterRole` to Pipeline, PipelineRun, and TaskRun:
Also, ensure that the Pipeline, PipelineRun, and TaskRun are granted a `ClusterRole`. You can use the following code to grant the `ClusterRole` to Pipeline, PipelineRun, and TaskRun:

[source,yaml]
----
Expand All @@ -127,7 +127,7 @@ Also, ensure that the Pipeline, PipelineRun, and TaskRun are granted a https://b
----
--

* The following configuration must be added in`customResources` component in the https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters[`app-config.yaml`] file to view the edit code decorator:
* The following configuration must be added in`customResources` component in the `app-config.yaml` file to view the edit code decorator:
+
--
[source,yaml]
Expand All @@ -140,7 +140,7 @@ Also, ensure that the Pipeline, PipelineRun, and TaskRun are granted a https://b
plural: 'checlusters'
----

Also, ensure that the `CheCluster` is granted a https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`] as shown in the following example code:
Also, ensure that the `CheCluster` is granted a `ClusterRole` as shown in the following example code:

[source,yaml]
----
Expand Down Expand Up @@ -177,7 +177,7 @@ annotations:
app.openshift.io/vcs-ref: <GIT_REPO_BRANCH>
----

If Red Hat OpenShift Dev Spaces (RHODS) is installed and configured and Git URL annotations are also added in the workload YAML file, then clicking on the edit code decorator redirects you to the RHODS instance. For more information about installing RHODS, see https://access.redhat.com/documentation/en-us/red_hat_openshift_dev_spaces/3.7/html/administration_guide/installing-devspaces[Administration guide] of RHODS.
If Red Hat OpenShift Dev Spaces (RHODS) is installed and configured and Git URL annotations are also added in the workload YAML file, then clicking on the edit code decorator redirects you to the RHODS instance. For more information about installing RHODS, see Administration guide of RHODS.

When you deploy your application using the OCP git import flow, then you do not need to add the labels as import flow to the workload YAML file. Otherwise, you would need to add the labels to the workload YAML file manually.

Expand Down Expand Up @@ -386,7 +386,7 @@ Topology is a front-end plugin that enables you to view the workloads as nodes t
.Prerequisites

* Your {product-short} application is installed and running.
* You have installed the Topology plugin. For the installation process, see <<Installation>>.
* You have installed the Topology plugin.

.Procedure

Expand All @@ -410,3 +410,13 @@ image::topology-tab-user3.png[topology-tab-open-url]

When you click on the open URL button, it allows you to access the associated *Ingresses* and runs your application in a new tab.
--

[role="_additional-resources"]
.Additional resources

* <<Installing Topology plugin>>
* link:https://backstage.io/docs/features/kubernetes/installation[Installation guide]
* link:https://backstage.io/docs/features/kubernetes/configuration[Configuration guide]
* link:https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`]
* link:https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters[`app-config.yaml` file to view the OpenShift route]
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_dev_spaces/3.7/html/administration_guide/installing-devspaces[Administration guide of RHODS]
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Consider configuring {product-short} to discover and ingest your GitHub reposito
If a repository contains a `catalog-info.yaml` file, {product-short} ingests the repository into the catalog as a component.

.Prerequisites
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
* You added a custom {product-short} application configuration, and have sufficient permissions to modify it.

* You have sufficient permissions in GitHub to create and manage a link:https://docs.github.com/en/apps/overview[GitHub App].
* You have sufficient permissions in GitHub to create and manage a GitHub App.

.Procedure
. To allow {product-short} to access the GitHub API, create a GitHub App.
Expand Down Expand Up @@ -152,3 +152,9 @@ integrations:
${GITHUB_INTEGRATION_PRIVATE_KEY_FILE}
----

[role="_additional-resources"]
.Additional resources

* link:{configuring-book-url}[Adding a custom {product-short} application configuration]

* link:https://docs.github.com/en/apps/overview[GitHub App]
9 changes: 7 additions & 2 deletions modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can enable and view metrics for a {product} Helm deployment from the *Develo

.Prerequisites

* Your {ocp-short} cluster has link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[monitoring for user-defined projects] enabled.
* Your {ocp-short} cluster has monitoring for user-defined projects enabled.
* You have installed {product} on {ocp-short} using the Helm chart.

.Procedure
Expand Down Expand Up @@ -41,4 +41,9 @@ image::rhdh/upgrade-helm-metrics.png[]
.Verification

. From the *Developer* perspective in the {ocp-short} web console, select the *Observe* view.
. Click the *Metrics* tab to view metrics for {product} pods.
. Click the *Metrics* tab to view metrics for {product} pods.

[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[Monitoring for user-defined projects]
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can enable and view metrics for an Operator-installed {product} instance fro

.Prerequisites

* Your {ocp-short} cluster has link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[monitoring for user-defined projects] enabled.
* Your {ocp-short} cluster has monitoring for user-defined projects enabled.
* You have installed {product} on {ocp-short} using the {product} Operator.
* You have installed the {openshift-cli}.

Expand Down Expand Up @@ -66,3 +66,8 @@ oc apply -f <filename>
. From the *Developer* perspective in the {ocp-short} web console, select the *Observe* view.
. Click the *Metrics* tab to view metrics for {product} pods.
. From the Developer perspective in the {ocp-short} web console, click **Project > Services** and verify the labels for `backstage-developer-hub`.

[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[Monitoring for user-defined projects]
12 changes: 8 additions & 4 deletions modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@

.Prerequisites
* CloudWatch Container Insights is used to capture logs and metrics for {eks-brand-name}.
For more information, see https://docs.aws.amazon.com/prescriptive-guidance/latest/implementing-logging-monitoring-cloudwatch/kubernetes-eks-logging.html[Logging for {eks-brand-name}] documentation.

* To capture the logs and metrics, link:https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-setup-EKS-addon.html[install the Amazon CloudWatch Observability EKS add-on] in your cluster.
For more information, see Logging for {eks-brand-name} documentation.
* To capture the logs and metrics, install the Amazon CloudWatch Observability EKS add-on in your cluster.
Following the setup of Container Insights, you can access container logs using Logs Insights or Live Tail views.

* CloudWatch names the log group where all container logs are consolidated in the following manner:
+
[subs="+quotes"]
Expand All @@ -23,3 +21,9 @@ Following the setup of Container Insights, you can access container logs using L
fields @timestamp, @message, kubernetes.container_name
| filter kubernetes.container_name in ["install-dynamic-plugins", "backstage-backend"]
----

[role="_additional-resources"]
.Additional resources

* link:https://docs.aws.amazon.com/prescriptive-guidance/latest/implementing-logging-monitoring-cloudwatch/kubernetes-eks-logging.html[Logging for {eks-brand-name} documentation]
* link:https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-setup-EKS-addon.html[Installing the Amazon CloudWatch Observability EKS add-on]
Loading