diff --git a/.gitignore b/.gitignore index cbacf51e7a..fb41723bd2 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,5 @@ titles-generated/ .vscode .cache/ .vscode/ +linkchecker-out.csv +linkchecker-out.html diff --git a/.htmltest.yml b/.htmltest.yml index 9d386e9175..8a73af5ee4 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -10,4 +10,10 @@ OutputDir: .cache/htmltest IgnoreDirectoryMissingTrailingSlash: true IgnoreSSLVerify: true IgnoreURLs: # List URLS that are not published, false positives, websites refusing crawlers + # Unauthorized (403) + - https://docs.redhat.com/en/documentation/red_hat_developer_hub + - https://developers.redhat.com - https://docs.github.com/ + - https://entra.microsoft.com + - https://openai.com/api/ + - https://platform.openai.com/docs/overview diff --git a/.linkcheckerrc b/.linkcheckerrc new file mode 100644 index 0000000000..2e915ad13c --- /dev/null +++ b/.linkcheckerrc @@ -0,0 +1,14 @@ +; Run linkchecker with the configuration file: +; linkchecker -f .linkcheckerrc titles-generated/main/ + +[filtering] +checkextern=True +ignore= + brand.css + lang.css + http://creativecommons.org/licenses/by-sa/3.0/ + https://access.redhat.com/downloads/content/480/ + +[output] +fileoutput=html,csv +log=failures diff --git a/.vale-styles/config/vocabularies/RHDH/accept.txt b/.vale-styles/config/vocabularies/RHDH/accept.txt new file mode 100644 index 0000000000..907ac9240c --- /dev/null +++ b/.vale-styles/config/vocabularies/RHDH/accept.txt @@ -0,0 +1 @@ +scaffolder diff --git a/.vale-styles/config/vocabularies/RHDH/reject.txt b/.vale-styles/config/vocabularies/RHDH/reject.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/.vale.ini b/.vale.ini index b3e6e7a295..e6c7307923 100644 --- a/.vale.ini +++ b/.vale.ini @@ -12,6 +12,8 @@ MinAlertLevel = suggestion # Styles to download: Packages = RedHat +Vocab = RHDH + # Display alerts on AsciiDoc files: [*.adoc] # Apply these styles: diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index e6e93d2730..7103481ee1 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -18,60 +18,67 @@ :product-backstage-version: 1.39.1 :product-version-next: 1.7 :product-custom-resource-type: Backstage -:rhdeveloper-name: Red Hat Developer -:rhel: Red Hat Enterprise Linux -:odf-name: OpenShift Data Foundation +:product-docs-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub +:product-docs-link: link:{product-docs-url}/{product-version} +:backstage: Backstage +// Minimum and current latest supported versions +:ansible-automation-platform-version: 2.4 +:keycloak-version: 26.0 +:kubernetes-version: 1.24 +:ocp-version-min: 4.14 +:ocp-version: 4.18 +:osd-version: 4 +:rhoserverless-version: 1.36 +// Product recurrent configuration items (in alphabetical order) :my-app-config-config-map: my-rhdh-app-config :my-app-config-file: app-config.yaml +:my-extra-file-configmap: my-project-configmap :my-product-cr-name: my-rhdh-custom-resource -:my-product-namespace: my-rhdh-project -:my-product-secrets: my-rhdh-secrets :my-product-database-certificates-secrets: my-rhdh-database-certificates-secrets :my-product-database-secrets: my-rhdh-database-secrets -:my-product-url: https://____ -:my-extra-file-configmap: my-project-configmap +:my-product-domain: ____ +:my-product-namespace: my-rhdh-project +:my-product-secrets: my-rhdh-secrets +:my-product-url: https://____ -// Red Hat Platforms +// Red Hat Platforms (in alphabetical order) +:logging-brand-name: Red Hat OpenShift Logging +:logging-short: OpenShift Logging +:ls-brand-name: Red Hat Developer Lightspeed for {product} +:ls-short: Developer Lightspeed for {product-very-short} :ocp-brand-name: Red Hat OpenShift Container Platform :ocp-short: OpenShift Container Platform :ocp-very-short: RHOCP +:odf-name: OpenShift Data Foundation :osd-brand-name: Red Hat OpenShift Dedicated :osd-short: OpenShift Dedicated -:logging-brand-name: Red Hat OpenShift Logging -:logging-short: OpenShift Logging -// minimum and current latest supported versions -:ocp-version-min: 4.14 -:ocp-version: 4.18 -:kubernetes-version: 1.24 -// First mention of OpenShift CLI or `oc` in a module -:openshift-cli: pass:quotes[OpenShift CLI (`oc`)] -:rhsso-brand-name: Red Hat Single-Sign On -:rhsso: RHSSO -:rhbk-brand-name: Red Hat Build of Keycloak -:rhbk: RHBK -:keycloak-version: 26.0 - -// RHADS information +:rcs-name: Road-Core Service +:rcs-short: RCS +:rhacs-brand-name: Red Hat Advanced Cluster Security +:rhacs-short: Advanced Cluster Security +:rhacs-very-short: ACS :rhads-brand-name: Red Hat Advanced Developer Suite - secure supply chain :rhads-very-short: RHADS - ssc - -// TAS information +:rhbk-brand-name: Red Hat Build of Keycloak +:rhbk: RHBK +:rhdeveloper-name: Red Hat Developer +:rhel: Red Hat Enterprise Linux +:rhoai-brand-name: Red Hat OpenShift AI +:rhoserverless-brand-name: Red Hat OpenShift Serverless +:rhsso-brand-name: Red Hat Single-Sign On +:rhsso: RHSSO :rhtas-brand-name: Red Hat Trusted Artifact Signer :rhtas-short: Trusted Artifact Signer :rhtas-very-short: TAS - -// TPA information :rhtpa-brand-name: Red Hat Trusted Profile Analyzer :rhtpa-short: Trusted Profile Analyzer :rhtpa-very-short: TPA -// ACS information -:rhacs-brand-name: Red Hat Advanced Cluster Security -:rhacs-short: Advanced Cluster Security -:rhacs-very-short: ACS - -// Partner Platforms +// Partner Platforms (in alphabetical order) +:aks-brand-name: Microsoft Azure Kubernetes Service +:aks-name: Azure Kubernetes Service +:aks-short: AKS :aws-brand-name: Amazon Web Services :aws-short: AWS :azure-brand-name: Microsoft Azure @@ -79,93 +86,78 @@ :eks-brand-name: Amazon Elastic Kubernetes Service :eks-name: Elastic Kubernetes Service :eks-short: EKS -:aks-brand-name: Microsoft Azure Kubernetes Service -:aks-name: Azure Kubernetes Service -:aks-short: AKS -:gke-brand-name: Google Kubernetes Engine -:gke-short: GKE :gcp-brand-name: Google Cloud Platform :gcp-short: GCP +:gke-brand-name: Google Kubernetes Engine +:gke-short: GKE -//Developer Lightspeed -:ls-brand-name: Red Hat Developer Lightspeed for {product} -:ls-short: Developer Lightspeed for {product-very-short} -:rcs-name: Road-Core Service -:rcs-short: RCS -:rhoai-brand-name: Red Hat OpenShift AI -// Links - +// First mention of OpenShift CLI or `oc` in a module +:openshift-cli: pass:quotes[OpenShift CLI (`oc`)] -:discover-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Discover -:about-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/about_red_hat_developer_hub/index +// Links and their title (in alphabetical order) +:about-book-link: {product-docs-link}/html-single/about_red_hat_developer_hub/index :about-book-title: About {product} - -:release-notes-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Release Notes -:release-notes-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/red_hat_developer_hub_release_notes/index -:release-notes-book-title: {product} release notes - -:getting-started-on-ocp-for-the-platform-engineer-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/getting_started_with_red_hat_developer_hub_on_red_hat_openshift_container_platform_for_the_platform_engineer/index +:adoption-insights-link: {product-docs-link}/html-single/adoption_insights_in_red_hat_developer_hub/index +:adoption-insights-title: Adoption Insights in {product} +:ansible-automation-platform-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{ansible-automation-platform-version} +:audit-log-book-link: {product-docs-link}/html-single/audit_logs_in_red_hat_developer_hub/index +:audit-log-book-title: Audit logs in {product} +:authentication-book-link: {product-docs-link}/html-single/authentication_in_red_hat_developer_hub/index +:authentication-book-title: Authentication in {product} +:authorization-book-link: {product-docs-link}/html-single/authorization_in_red_hat_developer_hub/index +:authorization-book-title: Authorization in {product} +:configure-category-link: {product-docs-link}/#Configure +:configuring-book-link: {product-docs-link}/html-single/configuring_red_hat_developer_hub/index +:configuring-book-title: Configuring {product} +:configuring-dynamic-plugins-book-link: {product-docs-link}/html-single/configuring_dynamic_plugins/index +:configuring-dynamic-plugins-book-title: Configuring dynamic plugins +:control-access-category-link: {product-docs-link}/#Control access +:customizing-book-link: {product-docs-link}/html-single/customizing_red_hat_developer_hub/index +:customizing-book-title: Customizing {product} +:discover-category-link: {product-docs-link}/#Discover +:dynamic-plugins-reference-book-link: {product-docs-link}/html-single/dynamic_plugins_reference/index +:dynamic-plugins-reference-book-title: Dynamic plugins reference +:extend-category-link: {product-docs-link}/#Extend +:getting-started-on-ocp-for-the-platform-engineer-book-link: {product-docs-link}/html-single/getting_started_with_red_hat_developer_hub_on_red_hat_openshift_container_platform_for_the_platform_engineer/index :getting-started-on-ocp-for-the-platform-engineer-book-title: Getting started with {product} on {ocp-brand-name} for the platform engineer - -:install-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Install -:installing-on-ocp-book-title: Installing {product} on {ocp-short} -:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index -:installing-on-eks-book-title: Installing {product} on {eks-brand-name} -:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index +:install-category-link: {product-docs-link}/#Install +:installing-and-viewing-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index +:installing-and-viewing-plugins-book-title: Installing and viewing plugins in {product} +:installing-in-air-gap-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index +:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment +:installing-on-aks-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index :installing-on-aks-book-title: Installing {product} on {aks-brand-name} -:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index -:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name} -:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index +:installing-on-eks-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index +:installing-on-eks-book-title: Installing {product} on {eks-brand-name} +:installing-on-gke-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index :installing-on-gke-book-title: Installing {product} on {gke-brand-name} -:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index -:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment -:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index +:installing-on-ocp-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index +:installing-on-ocp-book-title: Installing {product} on {ocp-short} +:installing-on-osd-on-gcp-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index +:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name} +:installing-rhdh-orch-on-ocp-book-link: {product-docs-link}/html-single/installing_rhdh_with_orchestrator_plugin_on_{ocp-short}_using_operator_in_an_air-gapped_environment/index :installing-rhdh-orch-on-ocp-book-title: Installing RHDH with the Orchestrator Plugin on {ocp-short} using the {product} Operator -:installing-rhdh-orch-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_rhdh_with_orchestrator_plugin_on_{ocp-short}_using_operator_in_an_air-gapped_environment/index - - +:integrating-with-github-book-link: {product-docs-link}/html-single/integrating_red_hat_developer_hub_with_github/index :integrating-with-github-book-title: Integrating {product} with GitHub -:integrating-with-github-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/integrating_red_hat_developer_hub_with_github/index - - -:upgrade-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Upgrade -:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index -:upgrading-book-title: Upgrading {product} - -:configure-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Configure -:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_red_hat_developer_hub/index -:configuring-book-title: Configuring {product} -:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing_red_hat_developer_hub/index -:customizing-book-title: Customizing {product} -:techdocs-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/techdocs_for_red_hat_developer_hub/index -:techdocs-book-title: TechDocs for {product} - -:control-access-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Control access -:authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication_in_red_hat_developer_hub/index -:authentication-book-title: Authentication in {product} -:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization_in_red_hat_developer_hub/index -:authorization-book-title: Authorization in {product} - -:observability-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Observability -:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_logs_in_red_hat_developer_hub/index -:audit-log-book-title: Audit logs in {product} -:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index +:introduction-to-plugins-book-link: {product-docs-link}/html-single/introduction_to_plugins/index +:introduction-to-plugins-book-title: Introduction to plugins +:monitoring-and-logging-book-link: {product-docs-link}/html-single/monitoring_and_logging/index :monitoring-and-logging-book-title: Monitoring and logging -:telemetry-data-collection-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/telemetry_data_collection/index +:observability-category-link: {product-docs-link}/#Observability +:odf-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/{ocp-version} +:ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version} +:osd-docs-link: link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-version} +:release-notes-book-link: {product-docs-link}/html-single/red_hat_developer_hub_release_notes/index +:release-notes-book-title: {product} release notes +:release-notes-category-link: {product-docs-link}/#Release Notes +:rhbk-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/{keycloak-version} +:rhoserverless-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/{rhoserverless-version} +:techdocs-book-link: {product-docs-link}/html-single/techdocs_for_red_hat_developer_hub/index +:techdocs-book-title: TechDocs for {product} +:telemetry-data-collection-book-link: {product-docs-link}/html-single/telemetry_data_collection_and_analysis/index :telemetry-data-collection-book-title: Telemetry data collection - -: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/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} -:using-dynamic-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 +:upgrade-category-link: {product-docs-link}/#Upgrade +:upgrading-book-link: {product-docs-link}/html-single/upgrading_red_hat_developer_hub/index +:upgrading-book-title: Upgrading {product} +:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index :using-dynamic-plugins-book-title: Using dynamic plugins -:dynamic-plugins-reference-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/dynamic_plugins_reference/index -:dynamic-plugins-reference-book-title: Dynamic plugins reference - -:adoption-insights-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/adoption_insights_in_red_hat_developer_hub/index -:adoption-insights-title: Adoption Insights in {product} - diff --git a/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc b/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc index fed17a1a3b..94cac31f41 100644 --- a/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc +++ b/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc @@ -37,7 +37,7 @@ annotations: ... # The label that Argo CD uses to fetch all the applications. The format to be used is label.key=label.value. For example, rht-gitops.com/janus-argocd=quarkus-app. - argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}' + argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}' ---- * (Optional) Add the following annotation to the entity’s `catalog-info.yaml` file to switch between Argo CD instances as shown in the following example: @@ -49,7 +49,7 @@ annotations: ... # The Argo CD instance name used in `app-config.yaml`. - argocd/instance-name: '${ARGOCD_INSTANCE}' + argocd/instance-name: '${ARGOCD_INSTANCE}' ---- + @@ -81,7 +81,7 @@ The optional Argo CD Rollouts feature enhances Kubernetes by providing advanced .Prerequisites -* The Backstage Kubernetes plugin (`@backstage/plugin-kubernetes`) is installed and configured. +* The Backstage Kubernetes plugin (`@backstage/plugin-kubernetes`) is installed and configured. ** To install and configure Kubernetes plugin in Backstage, see link:https://backstage.io/docs/features/kubernetes/installation/[Installaltion] and link:https://backstage.io/docs/features/kubernetes/configuration/[Configuration] guide. @@ -213,7 +213,7 @@ If using the label selector annotation (backstage.io/kubernetes-label-selector), . Open {Product} interface and navigate to the entity you configured. -. Select the *CD* tab and then select the *GitOps application*. The side panel opens. +. Select the *CD* tab and then select the *GitOps application*. The side panel opens. . In the *Resources* table of the side panel, verify that the following resources are displayed: @@ -231,6 +231,5 @@ If using the label selector annotation (backstage.io/kubernetes-label-selector), [role="_additional-resources"] .Additional resources -* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-book-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{release-notes-book-title}_. -* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]. +* link:{installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}] diff --git a/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc index 306101bfc2..eea4ba9436 100644 --- a/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc +++ b/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc @@ -12,7 +12,7 @@ You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflo . Select the *Catalog* tab and choose the component that you want to use. -. Select the *CD* tab to view insights into deployments managed by Argo CD. +. Select the *CD* tab to view insights into deployments managed by Argo CD. + image::rhdh-plugins-reference/argocd.png[CD tab Argo CD] @@ -33,4 +33,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary] [role="_additional-resources"] .Additional resources -* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]. +* {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}] diff --git a/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc b/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc index c82da2d9f4..77cff46996 100644 --- a/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc +++ b/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc @@ -10,7 +10,7 @@ You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflo . Select the *Catalog* tab and choose the component that you want to use. -. Select the *CD* tab to view insights into deployments managed by Argo CD. +. Select the *CD* tab to view insights into deployments managed by Argo CD. + image::rhdh-plugins-reference/argocd.png[CD tab Argo CD] @@ -31,4 +31,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary] [role="_additional-resources"] .Additional resources -* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]. +* {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}] diff --git a/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc b/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc index ece6fdd6ac..7dd2bd2089 100644 --- a/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc +++ b/artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc @@ -160,13 +160,13 @@ The Keycloak backend plugin supports link:https://opentelemetry.io/[OpenTelemetr === 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. +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. +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` +.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 @@ -188,7 +188,7 @@ 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. +// 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) @@ -199,7 +199,7 @@ Additionally, the results can be visualized using Grafana. 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. +See the link:https://backstage.io/docs/tutorials/setup-opentelemetry//[Backstage OpenTelemetry setup guide] for integration instructions. == Limitations @@ -211,4 +211,4 @@ If you have self-signed or corporate certificate issues, you can set the followi [NOTE] ==== The solution of setting the environment variable is not recommended. -==== \ No newline at end of file +==== diff --git a/assemblies/assembly-audit-log.adoc b/assemblies/assembly-audit-log.adoc index baeb4476f0..817efe5478 100644 --- a/assemblies/assembly-audit-log.adoc +++ b/assemblies/assembly-audit-log.adoc @@ -2,7 +2,9 @@ = Audit logs in {product} :context: assembly-audit-log -Audit logs are a chronological set of records documenting the user activities, system events, and data changes that affect your {product} users, administrators, or components. Administrators can view {product-short} audit logs in the {ocp-short} web console to monitor scaffolder events, changes to the RBAC system, and changes to the Catalog database. Audit logs include the following information: +Audit logs are a chronological set of records documenting the user activities, system events, and data changes that affect your {product} users, administrators, or components. +Administrators can view {product-short} audit logs in the {ocp-short} web console to monitor scaffolder events, changes to the RBAC system, and changes to the Catalog database. +Audit logs include the following information: * Name of the audited event * Actor that triggered the audited event, for example, terminal, port, IP address, or hostname @@ -13,7 +15,8 @@ Audit logs are a chronological set of records documenting the user activities, s You can use the information in the audit log to achieve the following goals: Enhance security:: -Trace activities, including those initiated by automated systems and software templates, back to their source. Know when software templates are executed, as well as the details of application and component installations, updates, configuration changes, and removals. +Trace activities, including those initiated by automated systems and software templates, back to their source. +Know when software templates are executed, and the details of application and component installations, updates, configuration changes, and removals. Automate compliance:: Use streamlined processes to view log data for specified points in time for auditing purposes or continuous compliance maintenance. @@ -23,16 +26,16 @@ Use access records and activity details to fix issues with software templates or [NOTE] ==== -Audit logs are not forwarded to the internal log store by default because this does not provide secure storage. You are responsible for ensuring that the system to which you forward audit logs is compliant with your organizational and governmental regulations, and is properly secured. +Audit logs are not forwarded to the internal log store by default because this does not provide secure storage. +You are responsible for ensuring that the system to which you forward audit logs is compliant with your organizational and governmental regulations, and is properly secured. ==== -[role="_additional-resources"] -.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] +include::modules/observe/con-audit-log-config.adoc[leveloffset=+1] -include::modules/observe/con-audit-log-config.adoc[] +include::modules/observe/proc-forward-audit-log-splunk.adoc[leveloffset=+1] -include::modules/observe/proc-forward-audit-log-splunk.adoc[leveloffset=+2] +include::modules/observe/proc-audit-log-view.adoc[leveloffset=+1] -include::modules/observe/proc-audit-log-view.adoc[] \ No newline at end of file +[role="_additional-resources"] +.Additional resources +* {ocp-docs-link}/observability/logging/cluster-logging.html[About Logging in {ocp-brand-name}] diff --git a/assemblies/assembly-configuring-techdocs.adoc b/assemblies/assembly-configuring-techdocs.adoc index dc67415448..57607bd257 100644 --- a/assemblies/assembly-configuring-techdocs.adoc +++ b/assemblies/assembly-configuring-techdocs.adoc @@ -14,11 +14,6 @@ You can use a CI/CD pipeline with the repository that has a dedicated job to gen After you configure {odf-name} to store the files that TechDocs generates, you can configure the TechDocs plugin to use the {odf-name} for cloud storage. -[role="_additional-resources"] -.Additional resources - -* For more information, see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}]. - //configuring storage include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1] @@ -39,3 +34,7 @@ include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operato //configuring CI/CD include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources + +* {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}] diff --git a/assemblies/assembly-configuring-templates.adoc b/assemblies/assembly-configuring-templates.adoc index 057396db7b..d28a76e523 100644 --- a/assemblies/assembly-configuring-templates.adoc +++ b/assemblies/assembly-configuring-templates.adoc @@ -3,13 +3,14 @@ [id="{context}"] = About Software Templates -Software Templates in {product} provide a streamlined way to create software components and publish them to different version control repositories like Git. Platform engineers create and maintain Software Templates in {product}. +Software Templates in {product} provide a streamlined way to create software components and publish them to different version control repositories such as Git. +Platform engineers create and maintain Software Templates in {product}. -You can configure Software Templates to create software components, and publish these components to Git repositories. Once the components are published to Git repositories, register these components in the Software Catalog. +You can configure Software Templates to create software components, and publish these components to Git repositories. +Once the components are published to Git repositories, register these components in the Software Catalog. -A template is a form composed of different UI fields that is defined in a YAML file. Software Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally. - -* See link:https://developers.redhat.com/articles/2025/03/17/10-tips-better-backstage-software-templates#[10 tips for better Backstage Software Templates]. +A template is a form composed of different UI fields that is defined in a YAML file. +Software Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally. include::modules/customizing-templates/proc-creating-templates.adoc[leveloffset=+1] include::modules/customizing-templates/ref-creating-templates.adoc[leveloffset=+1] @@ -20,7 +21,8 @@ include::modules/customizing-templates/proc-versioning-software-templates.adoc[l [role="_additional-resources"] .Additional resources -* link:{authentication-book-url}#assembly-auth-provider-github[Enabling the GitHub authentication provider] -* link:https://backstage.io/docs/features/software-templates/writing-templates[Backstage documentation - Writing Templates] -* link:https://backstage.io/docs/features/software-templates/builtin-actions[Backstage documentation - Builtin actions] -* link:https://backstage.io/docs/features/software-templates/writing-custom-actions[Backstage documentation - Writing Custom Actions] +* link:https://developers.redhat.com/articles/2025/03/17/10-tips-better-backstage-software-templates#[10 tips for better {backstage} Software Templates] +* {authentication-book-link}#assembly-auth-provider-github[Enabling the GitHub authentication provider] +* link:https://backstage.io/docs/features/software-templates/writing-templates/[{backstage} documentation - Writing Templates] +* link:https://backstage.io/docs/features/software-templates/builtin-actions/[{backstage} documentation - Built-in actions] +* link:https://backstage.io/docs/features/software-templates/writing-custom-actions/[{backstage} documentation - Writing Custom Actions] diff --git a/assemblies/assembly-customizing-the-tech-radar-page.adoc b/assemblies/assembly-customizing-the-tech-radar-page.adoc index 0ec1a64d5f..d2d4435843 100644 --- a/assemblies/assembly-customizing-the-tech-radar-page.adoc +++ b/assemblies/assembly-customizing-the-tech-radar-page.adoc @@ -1,7 +1,7 @@ [id='proc-customizing-the-tech-radar-page_{context}'] = Customizing the Tech Radar page in {product} -In {product}, the Tech Radar page is provided by the `tech-radar` dynamic plugin, which is disabled by default. For information about enabling dynamic plugins in {product} see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}]. +In {product}, the Tech Radar page is provided by the `tech-radar` dynamic plugin, which is disabled by default. For information about enabling dynamic plugins in {product} see {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}]. In {product}, you can configure Learning Paths by passing the data into the `{my-app-config-file}` file as a proxy. The base Tech Radar URL must include the `/developer-hub/tech-radar` proxy. diff --git a/assemblies/assembly-disabling-telemetry-data-collection.adoc b/assemblies/assembly-disabling-telemetry-data-collection.adoc index 421d49db5b..8440fc1d62 100644 --- a/assemblies/assembly-disabling-telemetry-data-collection.adoc +++ b/assemblies/assembly-disabling-telemetry-data-collection.adoc @@ -4,8 +4,8 @@ To disable telemetry data collection, you must disable the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator configuration. -As an administrator, you can disable the telemetry data collection feature based on your needs. For example, in an air-gapped environment, you can disable this feature to avoid needless outbound requests affecting the responsiveness of the {product-very-short} application. For more details, see the link:{telemetry-data-collection-book-url}#proc-disabling-telemetry-using-operator_title-telemetry[Disabling telemetry data collection in {product-very-short}] section. +As an administrator, you can disable the telemetry data collection feature based on your needs. For example, in an air-gapped environment, you can disable this feature to avoid needless outbound requests affecting the responsiveness of the {product-very-short} application. include::modules/analytics/proc-disabling-telemetry-using-operator.adoc[leveloffset=+1] -include::modules/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+1] \ No newline at end of file +include::modules/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+1] diff --git a/assemblies/assembly-install-rhdh-airgapped-environment-k8s-helm.adoc b/assemblies/assembly-install-rhdh-airgapped-environment-k8s-helm.adoc index f6e0087a46..8d6b9eb021 100644 --- a/assemblies/assembly-install-rhdh-airgapped-environment-k8s-helm.adoc +++ b/assemblies/assembly-install-rhdh-airgapped-environment-k8s-helm.adoc @@ -1,19 +1,19 @@ [id="assembly-install-rhdh-airgapped-environment-k8s-helm_{context}"] = Installing {product} on a supported Kubernetes platform in an air-gapped environment with the Helm chart -If you are using a supported Kubernetes platform in a fully disconnected or partially disconnected environment, you can install {product} by using the Helm chart. Supported Kubernetes platforms include the following: +If you are using a supported Kubernetes platform in a fully disconnected or partially disconnected environment, you can install {product} by using the Helm chart. +Supported Kubernetes platforms include the following: * {aks-brand-name} * {eks-brand-name} * {gke-brand-name} -[role="_additional-resources"] -.Additional resources -* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-helm_title-install-rhdh-aks[Deploying {product-short} on {aks-short} with the Helm chart]. -* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/proc-rhdh-deploy-eks-helm_title-install-rhdh-eksp[Installing {product-short} on {eks-short} with the Helm chart], -* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/installing_red_hat_developer_hub_on_google_kubernetes_engine/proc-rhdh-deploy-gke-helm_title-install-rhdh-gke[Installing {product-short} on {gke-short} with the Helm chart]. - include::modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc[leveloffset=+1] include::modules/installation/proc-install-rhdh-airgapped-partial-k8s-helm.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* {installing-on-aks-book-link}#proc-rhdh-deploy-aks-helm_title-install-rhdh-aks[Deploying {product-short} on {aks-short} with the Helm chart] +* {installing-on-eks-book-link}#proc-rhdh-deploy-eks-helm_title-install-rhdh-eks[Installing {product-short} on {eks-short} with the Helm chart] +* {installing-on-gke-book-link}#proc-rhdh-deploy-gke-helm_title-install-rhdh-gke[Installing {product-short} on {gke-short} with the Helm chart] diff --git a/assemblies/assembly-install-rhdh-airgapped-environment-ocp-helm.adoc b/assemblies/assembly-install-rhdh-airgapped-environment-ocp-helm.adoc index 660e97488c..e92110d573 100644 --- a/assemblies/assembly-install-rhdh-airgapped-environment-ocp-helm.adoc +++ b/assemblies/assembly-install-rhdh-airgapped-environment-ocp-helm.adoc @@ -5,8 +5,8 @@ You can install {product} in a fully disconnected or partially disconnected envi [role="_additional-resources"] .Additional resources -* For more information about registry authentication, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. +* For more information about registry authentication, see link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. include::modules/installation/proc-install-rhdh-helm-airgapped-full.adoc[leveloffset=+1] -include::modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc[leveloffset=+1] \ No newline at end of file +include::modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc[leveloffset=+1] diff --git a/assemblies/assembly-monitoring-with-amazon-prometheus.adoc b/assemblies/assembly-monitoring-with-amazon-prometheus.adoc index 5f31e876df..948aabb432 100644 --- a/assemblies/assembly-monitoring-with-amazon-prometheus.adoc +++ b/assemblies/assembly-monitoring-with-amazon-prometheus.adoc @@ -6,7 +6,7 @@ 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/eks/latest/userguide/prometheus.html[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. diff --git a/assemblies/assembly-rhdh-observability.adoc b/assemblies/assembly-rhdh-observability.adoc index 79d9b799a8..3b383fe7d8 100644 --- a/assemblies/assembly-rhdh-observability.adoc +++ b/assemblies/assembly-rhdh-observability.adoc @@ -12,4 +12,4 @@ include::modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc[leveloffset=+ [role="_additional-resources"] .Additional resources -* link:https://docs.openshift.com/container-platform/latest/observability/monitoring/managing-metrics.html[{ocp-short} - Managing metrics] +* {ocp-docs-link}/html-single/monitoring/index[Configuring and using the monitoring stack in {ocp-brand-name}] diff --git a/assemblies/assembly-techdocs-addons-installing.adoc b/assemblies/assembly-techdocs-addons-installing.adoc index 9acaa7ef95..9c52ceecd1 100644 --- a/assemblies/assembly-techdocs-addons-installing.adoc +++ b/assemblies/assembly-techdocs-addons-installing.adoc @@ -14,5 +14,5 @@ include::modules/techdocs/proc-techdocs-addon-install-helm.adoc[] include::modules/techdocs/proc-techdocs-addon-install-third-party.adoc[] .Additional resources -* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_and_viewing_plugins_in_red_hat_developer_hub/rhdh-installing-rhdh-plugins_title-plugins-rhdh-about[Installing dynamic plugins in Red Hat Developer Hub] -* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_and_viewing_plugins_in_red_hat_developer_hub/assembly-third-party-plugins[Third-party plugins in Red Hat Developer Hub] +* {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}] +* {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}] diff --git a/assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc b/assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc index 27b4366094..e6d3c28d27 100644 --- a/assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc +++ b/assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc @@ -15,9 +15,9 @@ include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+3 [NOTE] ==== -* For more information about configuring KeyCloak, see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}]. +* For more information about configuring KeyCloak, see {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}]. -* For more information about configuring TechDocs, see link:{customizing-book-url}#configuring-techdocs[Configuring TechDocs]. +* For more information about configuring TechDocs, see {customizing-book-link}#configuring-techdocs[Configuring TechDocs]. ==== // Technology preview support statement @@ -29,7 +29,7 @@ include::../modules/dynamic-plugins/ref-rh-tech-preview-plugins.adoc[leveloffset //[NOTE] //==== -//* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See link:{configuring-dynamic-plugins-book-url}#rhdh-compatible-plugins[Other installable plugins] in _{configuring-dynamic-plugins-book-title}_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix]. +//* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See {configuring-dynamic-plugins-book-link}#rhdh-compatible-plugins[Other installable plugins] in _{configuring-dynamic-plugins-book-title}_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix]. //==== // Community plugins diff --git a/modules/about/con_understanding-internal-developer-platforms.adoc b/modules/about/con_understanding-internal-developer-platforms.adoc index a3161ad6b9..f6c202d6d0 100644 --- a/modules/about/con_understanding-internal-developer-platforms.adoc +++ b/modules/about/con_understanding-internal-developer-platforms.adoc @@ -62,9 +62,9 @@ Support growing teams and applications while maintaining access to the same tool [role="_additional-resources"] .Additional resources -* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html/customizing_red_hat_developer_hub/configuring-templates[Configuring templates] -* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html/techdocs_for_red_hat_developer_hub/index[TechDocs for {product}] -* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html-single/customizing_red_hat_developer_hub/index#proc-customize-rhdh-learning-paths_configuring-templates[Customizing the Learning Paths in {product}] -* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html/introduction_to_plugins/index[Introduction to plugins] +* {customizing-book-link}#configuring-templates[Configuring templates] +* {techdocs-book-link}[{techdocs-book-title}] +* {customizing-book-link}#proc-customize-rhdh-learning-paths_configuring-templates[Customizing the Learning Paths in {product}] +* {introduction-to-plugins-book-link}[{introduction-to-plugins-book-title}] * xref:integrations-in-rhdh_{context}[Integrations in {product}] -* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html/authorization_in_red_hat_developer_hub/index[Authorization in {product}] +* {authentication-book-link}[{authentication-book-title}] diff --git a/modules/about/ref-customer-support-info.adoc b/modules/about/ref-customer-support-info.adoc index 47ce75481b..d55a54c42f 100644 --- a/modules/about/ref-customer-support-info.adoc +++ b/modules/about/ref-customer-support-info.adoc @@ -1,7 +1,7 @@ [id="ref-customer-support-info_{context}"] = Red Hat Developer Hub support -If you experience difficulty with a procedure described in this documentation, visit the http://access.redhat.com[Red Hat Customer Portal]. You can use the Red Hat Customer Portal for the following purposes: +If you experience difficulty with a procedure described in this documentation, visit the https://access.redhat.com[Red Hat Customer Portal]. You can use the Red Hat Customer Portal for the following purposes: * To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products. * To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for {company-name} Global Support Services (GSS). For support case creation, select *{product}* as the product and select the appropriate product version. diff --git a/modules/authentication/con-understanding-authentication-and-user-provisioning.adoc b/modules/authentication/con-understanding-authentication-and-user-provisioning.adoc index 415f8100fc..d4c8d5f6b4 100644 --- a/modules/authentication/con-understanding-authentication-and-user-provisioning.adoc +++ b/modules/authentication/con-understanding-authentication-and-user-provisioning.adoc @@ -1,8 +1,9 @@ +:_mod-docs-content-type: CONCEPT = Understanding authentication and user provisioning This module provides an overview of how authentication and user provisioning function within {product}. Learn about the process from creating user and group entities in the software catalog to user sign-in, and how authentication and catalog plugins enable each step. -Understanding this process is essential for successfully link:{configuring-book-url}[configuring your {product-short} instance], link:{authorization-book-url}[securing access through authorization], and enabling features that rely on synchronized user and group data. +Understanding this process is essential for successfully {configuring-book-link}[configuring your {product-short} instance], {authorization-book-link}[securing access through authorization], and enabling features that rely on synchronized user and group data. To fully enable catalog features, provision user and group data from the Identity Provider to the {product-short} software catalog. Catalog provider plugins handle this task asynchronously. diff --git a/modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc b/modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc index 180ed590f1..3f9cafcd83 100644 --- a/modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc +++ b/modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc @@ -5,11 +5,11 @@ On a Helm-based installation, you can configure {product-short} to log in as a Guest user and access {product-short} features. .Prerequisites -* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. -* You link:{configuring-book-url}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[use the {product} Helm chart to run {product-short}]. +* You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You {configuring-book-link}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[use the {product} Helm chart to run {product-short}]. .Procedure -* To enable the guest user in your {product-short} custom configuration, link:{configuring-book-url}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[configure your {product} Helm Chart] with following content: +* To enable the guest user in your {product-short} custom configuration, {configuring-book-link}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[configure your {product} Helm Chart] with following content: + .{product} Helm Chart configuration fragment [source,yaml] diff --git a/modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc b/modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc index 420c517afa..d596c81836 100644 --- a/modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc +++ b/modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc @@ -5,11 +5,11 @@ After an Operator-based installation, you can configure {product-short} to log in as a Guest user and access {product-short} features. .Prerequisites -* You link:[installed {product-short} by using the Operator]. -* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You {configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configurationn[use the {product} Operator to run {product-short}]. .Procedure -* To enable the guest user in your {product-short} custom configuration, link:{configuring-book-url}#provisioning-your-custom-configuration[edit your {product-short} application configuration] with following content: +* To enable the guest user in your {product-short} custom configuration, {configuring-book-link}#provisioning-your-custom-configuration[edit your {product-short} application configuration] with following content: + .`{my-app-config-file}` fragment [source,yaml] diff --git a/modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc b/modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc index b8b047927b..d729e538a3 100644 --- a/modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc +++ b/modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc @@ -1,3 +1,4 @@ +:_mod-docs-content-type: PROCEDURE [id="creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog"] = Creating a custom transformer to provision users from {rhbk-brand-name} ({rhbk}) to the software catalog diff --git a/modules/authentication/proc-enabling-user-authentication-with-github.adoc b/modules/authentication/proc-enabling-user-authentication-with-github.adoc index 3c1463afb9..5028d5d022 100644 --- a/modules/authentication/proc-enabling-user-authentication-with-github.adoc +++ b/modules/authentication/proc-enabling-user-authentication-with-github.adoc @@ -1,10 +1,11 @@ +:_mod-docs-content-type: PROCEDURE [id="enabling-user-authentication-with-github"] = Enabling user authentication with GitHub To authenticate users with GitHub, configure the GitHub authentication provider in {product} and provision the users and groups from GitHub to the {product-short} software catalog. .Prerequisites -* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You {configuring-book-link}[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]. Alternatively, you can ask your GitHub administrator to prepare the required GitHub App. @@ -42,7 +43,7 @@ Select `Only on this account`. * **Client ID** * **Client secret** -. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]. +. To add your GitHub credentials to {product-short}, add the following key/value pairs to {configuring-book-link}#provisioning-your-custom-configuration[your {product-short} secrets]. You can use these secrets in the {product-short} configuration files by using their respective environment variable name. `AUTHENTICATION_GITHUB_CLIENT_ID`:: @@ -209,5 +210,5 @@ WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-sh .Additional resources -* link:{integrating-with-github-book-url}[{integrating-with-github-book-title}]. +* {integrating-with-github-book-link}[{integrating-with-github-book-title}] diff --git a/modules/authentication/proc-enabling-user-authentication-with-microsoft-azure.adoc b/modules/authentication/proc-enabling-user-authentication-with-microsoft-azure.adoc index f20ddf0213..fccf153c16 100644 --- a/modules/authentication/proc-enabling-user-authentication-with-microsoft-azure.adoc +++ b/modules/authentication/proc-enabling-user-authentication-with-microsoft-azure.adoc @@ -1,3 +1,4 @@ +:_mod-docs-content-type: PROCEDURE [id="enabling-user-authentication-with-microsoft-azure"] = Enabling user authentication with {azure-brand-name} @@ -7,7 +8,7 @@ To authenticate users with {azure-brand-name}, configure the {azure-short} authe * You have the permission to register an application in {azure-short}. Alternatively, you can ask your {azure-short} administrator to prepare the required {azure-short} application. -* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. * Your {product-short} backend can access the following hosts: @@ -69,7 +70,7 @@ Optional: Enter optional custom scopes for the Microsoft Graph API that you defi - **Application (client) ID** - **Application (client) Secret ID** -. To add your {azure-short} credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]: +. To add your {azure-short} credentials to {product-short}, add the following key/value pairs to {configuring-book-link}#provisioning-your-custom-configuration[your {product-short} secrets]: `AUTHENTICATION_AZURE_TENANT_ID`:: Enter your saved *Directory (tenant) ID*. @@ -163,7 +164,7 @@ catalog: [id=queryMode] `queryMode: basic | advanced`:: Enter `advanced` when the default `basic` query mode is not sufficient for your queries to the Microsoft Graph API. -See link:https://docs.microsoft.com/en-us/graph/aad-advanced-queries[{azure-brand-name} advanced queries]. +See link:https://learn.microsoft.com/en-us/graph/aad-advanced-queries[{azure-brand-name} advanced queries]. + .`{my-app-config-file}` fragment with optional `queryMode` field [source,yaml] @@ -179,7 +180,7 @@ catalog: `user.expand`:: To include the expanded resource or collection referenced by a single relationship (navigation property) in your results. Only one relationship can be expanded in a single request. -See https://docs.microsoft.com/en-us/graph/query-parameters#expand-parameter[Microsoft Graph query expand parameter]. +See https://learn.microsoft.com/en-us/graph/query-parameters#expand-parameter[Microsoft Graph query expand parameter]. This parameter can be combined with xref:userGroupMemberFilter[`userGroupMember.filter`] or xref:userFilter[`user.filter`]. + .`{my-app-config-file}` fragment with optional `user.expand` field @@ -196,7 +197,7 @@ catalog: [id=userFilter] `user.filter`:: To filter users. -See link:https://docs.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties[Microsoft Graph API] and link:https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter[Microsoft Graph API query filter parameters syntax]. +See link:https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties[Microsoft Graph API] and link:https://learn.microsoft.com/en-us/graph/query-parameters#filter-parameter[Microsoft Graph API query filter parameters syntax]. This parameter and xref:userGroupMemberFilter[`userGroupMember.filter`] are mutually exclusive, only one can be specified. + .`{my-app-config-file}` fragment with optional `user.filter` field @@ -228,7 +229,7 @@ catalog: [id=userSelect] `user.select`:: -Enter the link:https://docs.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource type] list to retrieve. +Enter the link:https://learn.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource type] list to retrieve. + .`{my-app-config-file}` fragment with optional `user.select` field [source,yaml] @@ -279,7 +280,7 @@ catalog: `group.expand`:: Optional parameter to include the expanded resource or collection referenced by a single relationship (navigation property) in your results. Only one relationship can be expanded in a single request. -See https://docs.microsoft.com/en-us/graph/query-parameters#expand-parameter +See link:https://learn.microsoft.com/en-us/graph/query-parameters#expand-parameter[Customize Microsoft Graph responses with query parameters]. This parameter can be combined with xref:userGroupMemberFilter[`userGroupMember.filter`] instead of xref:userFilter[`user.filter`]. + .`{my-app-config-file}` fragment with optional `group.expand` field @@ -296,7 +297,7 @@ catalog: [id=groupFilter] `group.filter`:: To filter groups. -See link:https://docs.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties[Microsoft Graph API query group syntax]. +See link:https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties[Microsoft Graph API query group syntax]. + .`{my-app-config-file}` fragment with optional `group.filter` field [source,yaml] @@ -312,7 +313,7 @@ catalog: [id=groupSearch] `group.search`:: To search for groups. -See link:https://docs.microsoft.com/en-us/graph/search-query-parameter[Microsoft Graph API query search parameter]. +See link:https://learn.microsoft.com/en-us/graph/search-query-parameter[Microsoft Graph API query search parameter]. + .`{my-app-config-file}` fragment with optional `group.search` field [source,yaml] @@ -327,7 +328,7 @@ catalog: [id=groupSelect] `group.select`:: -Enter the link:https://docs.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource type] list to retrieve. +Enter the link:https://learn.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource type] list to retrieve. + .`{my-app-config-file}` fragment with optional `group.select` field [source,yaml] @@ -381,7 +382,7 @@ Optional for single-tenant applications. You can reduce login friction for users with accounts in multiple tenants by automatically filtering out accounts from other tenants. If you want to use this parameter for a single-tenant application, uncomment and enter the tenant ID. If your application registration is multi-tenant, leave this parameter blank. -For more information, see link:https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/home-realm-discovery-policy[Home Realm Discovery]. +For more information, see link:https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/home-realm-discovery-policy[Home Realm Discovery]. + .`{my-app-config-file}` file fragment with optional `domainHint` field [source,yaml,subs="+quotes,+attributes"] diff --git a/modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc b/modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc index a7cc277599..cf4d4ab3e2 100644 --- a/modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc +++ b/modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc @@ -1,21 +1,22 @@ +:_mod-docs-content-type: PROCEDURE [id="enabling-user-authentication-with-rhbk"] = Enabling user authentication with {rhbk-brand-name} ({rhbk}) To authenticate users with {rhbk-brand-name} ({rhbk}), enable and configure the OpenID Connect (OIDC) authentication provider in {product} and provision the users and groups from {rhbk} to the {product-short} software catalog. .Prerequisites -* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. * You have sufficient permissions in {rhsso} to create and manage a realm and a client. Alternatively, your {rhbk} administrator can prepare in {rhbk} the required realm and client for you. .Procedure -. To allow {product-short} to authenticate with {rhbk}, complete the steps in {rhbk}, to link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/getting_started_guide/getting-started-zip-#getting-started-zip-create-a-realm[create a realm and a user] and link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/getting_started_guide/getting-started-zip-#getting-started-zip-secure-the-first-application[secure the first application]: +. To allow {product-short} to authenticate with {rhbk}, complete the steps in {rhbk}, to {rhbk-docs-link}/html/getting_started_guide/getting-started-zip-#getting-started-zip-create-a-realm[create a realm and a user] and {rhbk-docs-link}/html/getting_started_guide/getting-started-zip-#getting-started-zip-secure-the-first-application[secure the first application]: -.. Use an existing realm, or link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/getting_started_guide/getting-started-zip-#getting-started-zip-create-a-realm[create a realm], with a distinctive **Name** such as ____. +.. Use an existing realm, or {rhbk-docs-link}/html/getting_started_guide/getting-started-zip-#getting-started-zip-create-a-realm[create a realm], with a distinctive **Name** such as ____. Save the value for the next step: * **{rhbk} realm base URL**, such as: ____/realms/____. -.. To register your {product-short} in {rhbk}, in the created realm, link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/getting_started_guide/index#getting-started-zip-secure-the-first-application[secure the first application], with: +.. To register your {product-short} in {rhbk}, in the created realm, {rhbk-docs-link}/html-single/getting_started_guide/index#getting-started-zip-secure-the-first-application[secure the first application], with: ... **Client ID**: A distinctive client ID, such as __<{product-very-short}>__. ... **Valid redirect URIs**: Set to the OIDC handler URL: `https://____/api/auth/oidc/handler/frame`. ... Navigate to the **Credentials** tab and copy the **Client secret**. @@ -23,9 +24,9 @@ Save the value for the next step: * **Client ID** * **Client Secret** -.. To prepare for the verification steps, in the same realm, get the credential information for an existing user or link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/getting_started_guide/index#getting-started-zip-create-a-user[create a user]. Save the user credential information for the verification steps. +.. To prepare for the verification steps, in the same realm, get the credential information for an existing user or {rhbk-docs-link}/html-single/getting_started_guide/index#getting-started-zip-create-a-user[create a user]. Save the user credential information for the verification steps. -. To add your {rhsso} credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]. +. To add your {rhsso} credentials to {product-short}, add the following key/value pairs to {configuring-dynamic-plugins-book-link}#provisioning-your-custom-configuration[your {product-short} secrets]. You can use these secrets in the {product-short} configuration files by using their respective environment variable name. + `AUTHENTICATION_OIDC_CLIENT_ID`:: diff --git a/modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc b/modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc index ca4a96a355..971bf55dd5 100644 --- a/modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc +++ b/modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc @@ -4,7 +4,7 @@ You can configure the RBAC backend plugin by updating the `{my-app-config-file}` file to enable the permission framework. .Prerequisites -* You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see link:{plugins-configure-book-url}[{plugins-configure-book-title}]. +* You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}]. .Procedure * Update the `{my-app-config-file}` file to enable the permission framework as shown: diff --git a/modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc b/modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc index dd97e154a5..ab86c2296b 100644 --- a/modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc +++ b/modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc @@ -75,7 +75,7 @@ $ oc create configmap rbac-policies \ --from-file=rbac-conditional-policies.yaml ---- -. Update link:{configuring-book-url}[your `{product-custom-resource-type}` custom resource] to mount in the {product-short} filesystem your files from the `rbac-policies` config map: +. Update {configuring-book-link}[your `{product-custom-resource-type}` custom resource] to mount in the {product-short} filesystem your files from the `rbac-policies` config map: + .`{product-custom-resource-type}` custom resource fragment [source,yaml] diff --git a/modules/authorization/proc-enabling-the-rbac-plugin.adoc b/modules/authorization/proc-enabling-the-rbac-plugin.adoc index 864bf0fa45..fb64604749 100644 --- a/modules/authorization/proc-enabling-the-rbac-plugin.adoc +++ b/modules/authorization/proc-enabling-the-rbac-plugin.adoc @@ -7,8 +7,8 @@ Enable the RBAC plugin and declare policy administrators to start using RBAC fea The permission policies for users and groups in the {product-short} are managed by permission policy administrators. Only permission policy administrators can access the Role-Based Access Control REST API. .Prerequisites -* You have link:{configuring-book-url}[added a custom {product-short} application configuration], and have necessary permissions to modify it. -* You have link:{authentication-book-url}[enabled an authentication provider]. +* You have {configuring-book-link}[added a custom {product-short} application configuration], and have necessary permissions to modify it. +* You have {authentication-book-link}[enabled an authentication provider]. .Procedure . The RBAC plugin is installed but disabled by default. @@ -22,7 +22,7 @@ plugins: disabled: false ---- + -See link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]. +See {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}]. . Declare policy administrators to enable a select number of authenticated users to configure RBAC policies through the REST API or Web UI, instead of modifying the CSV file directly. The permissions can be specified in a separate CSV file referenced in your `{my-app-config-config-map}` config map, or permissions can be created using the REST API or Web UI. @@ -39,7 +39,7 @@ permission: users: - name: user:default/____ ---- -. In order for the {product-short} Web UI to display available permissions provided by installed plugins, add the corresponding plugin IDs to link:{configuring-book-url}[your custom `{my-app-config-file}` {product-short} configuration file]. +. In order for the {product-short} Web UI to display available permissions provided by installed plugins, add the corresponding plugin IDs to {configuring-book-link}[your custom `{my-app-config-file}` {product-short} configuration file]. + To display available permissions in RBAC UI, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following code to the `{my-app-config-file}` content: + diff --git a/modules/authorization/proc-sending-request-to-the-rbac-rest-api-by-using-curl.adoc b/modules/authorization/proc-sending-request-to-the-rbac-rest-api-by-using-curl.adoc index b0b9933c09..65f0e06562 100644 --- a/modules/authorization/proc-sending-request-to-the-rbac-rest-api-by-using-curl.adoc +++ b/modules/authorization/proc-sending-request-to-the-rbac-rest-api-by-using-curl.adoc @@ -101,13 +101,13 @@ curl -v -H "Content-Type: application/json" \ -X PUT "{my-product-url}/api/permission/policies/role/default/test" \ -d '{ "oldPolicy": [ - { + { "permission": "catalog-entity", "policy": "read", "effect": "allow" } ], "newPolicy": [ - { + { "permission": "policy-entity", "policy": "read", "effect": "allow" } ] diff --git a/modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc b/modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc index 12b41ae4ce..cf09825945 100644 --- a/modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc +++ b/modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc @@ -4,7 +4,7 @@ You can enable guest authentication and use it alongside the RBAC frontend plugin. .Prerequisites -* You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see link:{plugins-configure-book-url}[{plugins-configure-book-title}]. +* You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}]. .Procedure diff --git a/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc b/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc index 8724519039..96e756363b 100644 --- a/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc +++ b/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc @@ -78,7 +78,7 @@ done You can stop port forwarding when the copying of the data is complete. For more information about handling large databases and using the compression tools, see the link:https://www.postgresql.org/docs/current/backup-dump.html#BACKUP-DUMP-LARGE[Handling Large Databases] section on the PostgreSQL website. ==== -. Reconfigure your `{product-custom-resource-type}` custom resource (CR). For more information, see link:{configuring-book-url}#proc-configuring-postgresql-instance-using-operator_configuring-external-postgresql-databases[Configuring an external PostgreSQL instance using the Operator]. +. Reconfigure your `{product-custom-resource-type}` custom resource (CR). For more information, see {configuring-book-link}#proc-configuring-postgresql-instance-using-operator_configuring-external-postgresql-databases[Configuring an external PostgreSQL instance using the Operator]. . Check that the following code is present at the end of your `Backstage` CR after reconfiguration: + [source,yaml, subs="+attributes"] diff --git a/modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc b/modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc index ac52bbcfa5..67b5a367eb 100644 --- a/modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc +++ b/modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc @@ -2,7 +2,7 @@ = Customizing your {product} global header 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. -For more information about enabling dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]. +For more information about enabling dynamic plugins, see {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}]. .Default global header configuration @@ -164,4 +164,4 @@ where: ---- - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header disabled: true ----- \ No newline at end of file +---- diff --git a/modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc b/modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc index add80975a4..8afc7cf89e 100644 --- a/modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc +++ b/modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc @@ -8,7 +8,7 @@ Configured plugins in {product-short} receive dedicated cache connections, which .Prerequisites * You have installed {product}. * You have an active Redis server. -For more information on setting up an external Redis server, see the link:https://www.redis.io/docs/latest/[`official Redis documentation`]. +For more information on setting up an external Redis server, see the link:https://redis.io/docs/latest/[`official Redis documentation`]. .Procedure . Enable the {product-short} cache by defining Redis as the cache store type and entering your Redis server connection URL in your `{my-app-config-file}` file. diff --git a/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc b/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc index 8508c9f3a6..5f0969d39e 100644 --- a/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc +++ b/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc @@ -18,7 +18,7 @@ The `mountPath` field specifies the location where a ConfigMap or Secret is moun .Prerequisites * You have developer permissions to access the {ocp-short} cluster containing your {product-short} instance using the {openshift-cli}. -* link:{installing-on-ocp-book-url}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}]. +* {installing-on-ocp-book-link}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}]. .Procedure diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc index f4f41608fe..6e51fb7c32 100644 --- a/modules/configuring/proc-provisioning-your-custom-configuration.adoc +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -10,13 +10,13 @@ Your changes on this configuration might get reverted on {product-short} restart ==== .Prerequisites -* By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. +* By using the {ocp-docs-link}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. .Procedure . Author your custom `__.txt` file to provision your secrets as environment variables values in an {ocp-short} secret, rather than in clear text in your configuration files. It contains one secret per line in `KEY=value` form. + -* link:{authentication-book-url}[Enter your authentication secrets]. +* {authentication-book-link}[Enter your authentication secrets]. . Author your custom `{my-app-config-file}` file. This is the main {product-short} configuration file. @@ -52,9 +52,9 @@ backend: ** Optionally, enter your configuration such as: -*** link:{authentication-book-url}[{authentication-book-title}]. -*** link:{authorization-book-url}[{authorization-book-title}]. -*** link:{customizing-book-url}[Customization]. +*** {authentication-book-link}[{authentication-book-title}]. +*** {authorization-book-link}[{authorization-book-title}]. +*** {customizing-book-link}[Customization]. *** xref:proc-configuring-an-rhdh-instance-with-tls-in-kubernetes_running-behind-a-proxy[Configure your {ocp-short} integration]. . Provision your custom configuration files to your {ocp-short} cluster. @@ -66,7 +66,7 @@ backend: $ oc create namespace {my-product-namespace} ---- + -Alternatively, link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#creating-a-project-using-the-web-console_projects[create the project by using the web console]. +Alternatively, {ocp-docs-link}/html-single/building_applications/index#creating-a-project-using-the-web-console_projects[create the project by using the web console]. .. Provision your `{my-app-config-file}` file to the `{my-app-config-config-map}` config map in the _<{my-product-namespace}>_ project. + @@ -75,7 +75,7 @@ Alternatively, link:https://docs.redhat.com/en/documentation/openshift_container $ oc create configmap {my-app-config-config-map} --from-file={my-app-config-file} --namespace={my-product-namespace} ---- + -Alternatively, link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/nodes/index#nnodes-pods-configmap-create-from-console_configmaps[create the config map by using the web console]. +Alternatively, {ocp-docs-link}/html-single/nodes/index#nnodes-pods-configmap-create-from-console_configmaps[create the config map by using the web console]. .. Provision your `__.txt` file to the `__` secret in the _<{my-product-namespace}>_ project. + @@ -85,7 +85,7 @@ $ oc create secret generic `__` --from-file=`__, aimed at containing your {product-short} instance. +* By using the {ocp-short} web console, you have access with developer permissions, to {ocp-docs-link}/html-single/building_applications/index#working-with-projects[an {ocp-short} project] named _<{my-product-namespace}>_, aimed at containing your {product-short} instance. * xref:provisioning-your-custom-configuration[You have uploaded your custom configuration files and secrets in your `_<{my-product-namespace}>_` project]. .Procedure diff --git a/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc b/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc index 09bf27c879..8b63bb7ebb 100644 --- a/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc +++ b/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc @@ -7,8 +7,8 @@ To use the {product-short} Operator to run {product} with your custom configurat * Injects environment variables provisioned in your custom secrets. .Prerequisites -* By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. -* link:{installing-on-ocp-book-url}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}]. +* By using the {ocp-docs-link}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. +* {installing-on-ocp-book-link}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}]. * xref:provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. .Procedure diff --git a/modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc b/modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc index 34a3f7234d..4c22369ec9 100644 --- a/modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc +++ b/modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc @@ -4,21 +4,21 @@ You can configure {odf-name} to store the files that TechDocs generates instead of relying on other cloud storage solutions. -{odf-name} provides an `ObjectBucketClaim` custom resource (CR) that you can use to request an S3-compatible bucket backend. You must install the {odf-name} Operator to use this feature. +{odf-name} provides an `ObjectBucketClaim` custom resource (CR) that you can use to request an S3-compatible bucket backend. +You must install the {odf-name} Operator to use this feature. + [NOTE] ==== -For air-gapped environments, using {odf-name} is the recommended storage for TechDocs. +For air-gapped environments, using {odf-name} is the recommended storage for TechDocs. ==== .Prerequisites - -* An {ocp-short} administrator has installed the {odf-name} Operator in {ocp-brand-name}. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.15/html/deploying_openshift_data_foundation_using_amazon_web_services/deploy-using-dynamic-storage-devices-aws#installing-openshift-data-foundation-operator-using-the-operator-hub_cloud-storage[{ocp-short} - Installing {company-name} {odf-name} Operator]. -* An {ocp-short} administrator has created an {odf-name} cluster and configured the `StorageSystem` schema. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/latest/html/deploying_openshift_data_foundation_using_amazon_web_services/deploy-using-dynamic-storage-devices-aws#creating-an-openshift-data-foundation-service_cloud-storage[{ocp-short} - Creating an {odf-name} cluster]. +* An {ocp-short} administrator has installed the {odf-name} Operator in {ocp-brand-name}, created an {odf-name} cluster and configured the `StorageSystem` schema. +For more information, see {odf-docs-link}/html-single/deploying_openshift_data_foundation_using_amazon_web_services/index[Deploying {odf-name} using {aws-brand-name}]. .Procedure - -* Create an `ObjectBucketClaim` CR where the generated TechDocs files are stored. For example: +* Create an `ObjectBucketClaim` CR where the generated TechDocs files are stored. +For example: + [source,yaml] ---- @@ -33,12 +33,14 @@ spec: + [NOTE] ==== -Creating the {product-short} `ObjectBucketClaim` CR automatically creates both the {product-short} `ObjectBucketClaim` config map and secret. The config map and secret have the same name as the `ObjectBucketClaim` CR. +Creating the {product-short} `ObjectBucketClaim` CR automatically creates both the {product-short} `ObjectBucketClaim` config map and secret. +The config map and secret have the same name as the `ObjectBucketClaim` CR. ==== -After you create the `ObjectBucketClaim` CR, you can use the information stored in the config map and secret to make the information accessible to the {product-short} container as environment variables. Depending on the method that you used to install {product-short}, you add the access information to either the {product} Helm chart or Operator configuration. +After you create the `ObjectBucketClaim` CR, you can use the information stored in the config map and secret to make the information accessible to the {product-short} container as environment variables. +Depending on the method that you used to install {product-short}, you add the access information to either the {product} Helm chart or Operator configuration. [role="_additional-resources"] .Additional resources - -* For more information about the Object Bucket Claim, see link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.12/html/managing_hybrid_and_multicloud_resources/object-bucket-claim#doc-wrapper[{ocp-short} - Object Bucket Claim]. +* {odf-docs-link}[{odf-name}] +* {odf-docs-link}/html-single/managing_hybrid_and_multicloud_resources/object-bucket-claim#object-bucket-claim[Object Bucket Claim] diff --git a/modules/customizing-templates/proc-adding-templates.adoc b/modules/customizing-templates/proc-adding-templates.adoc index 52b7b34a10..47f668aab5 100644 --- a/modules/customizing-templates/proc-adding-templates.adoc +++ b/modules/customizing-templates/proc-adding-templates.adoc @@ -11,7 +11,7 @@ You can add an existing Software Template to your {product} instance by using th .Prerequisites * You have created a directory or repository that contains at least one template YAML file. -* Optional: To use a template stored in a GitHub repository, you link:{have configured integrating-with-github-book-url}[{product-short} integration with GitHub]. +* Optional: To use a template stored in a GitHub repository, you have configured {integrating-with-github-book-link}[{product-short} integration with GitHub]. .Procedure diff --git a/modules/customizing-templates/proc-versioning-software-templates.adoc b/modules/customizing-templates/proc-versioning-software-templates.adoc index 35b55b0ca1..2b7d81aa8c 100644 --- a/modules/customizing-templates/proc-versioning-software-templates.adoc +++ b/modules/customizing-templates/proc-versioning-software-templates.adoc @@ -35,10 +35,10 @@ To add versioning to a Software Template yaml file, complete the following steps ---- .Verification -. link:{configuring-book-url}#ref-creating-templates_configuring-templates[Create a catalog component using the updated Software Template]. This step creates a new component in {product-custom-resource-type} and optionally, pushes files to an external repository (For example, GitHub, GitLab). +. {configuring-book-link}#ref-creating-templates_configuring-templates[Create a catalog component using the updated Software Template]. This step creates a new component in {product-custom-resource-type} and optionally, pushes files to an external repository (For example, GitHub, GitLab). . Check the component in the Catalog UI. .. On the *Catalog* page, locate the newly created catalog component. .. Verify that the `backstage.io/template-version` annotation is present in the entity. You can use *INSPECT ENTITY* and select *YAML Raw* or *JSON Raw* view to find the annotation in the component definition. . Only if you have published the catalog component: Check the component file in the repository. .. If *VIEW SOURCE* is present in your UI: Click *VIEW SOURCE* to open the stored component file in the repository. -.. Locate the file manually and verify that the `backstage.io/template-version` annotation is present. \ No newline at end of file +.. Locate the file manually and verify that the `backstage.io/template-version` annotation is present. diff --git a/modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc b/modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc index ac95e5b45d..a8d73f91a3 100644 --- a/modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc +++ b/modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc @@ -11,7 +11,7 @@ There are two component variants that you can use to customize various component In addition to assigning a component variant to each parameter in the light or dark theme mode configurations, you can toggle the `rippleEffect` `on` or `off`. -The following code shows the options that you can use in the link:{configuring-book-url}[`{my-app-config-file}` file] to configure the theme components for your {product-short} instance: +The following code shows the options that you can use in the {configuring-book-link}[`{my-app-config-file}` file] to configure the theme components for your {product-short} instance: [source,yaml] ---- diff --git a/modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-a-dedicated-service.adoc b/modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-a-dedicated-service.adoc index 7e07c05fe7..11914e4307 100644 --- a/modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-a-dedicated-service.adoc +++ b/modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-a-dedicated-service.adoc @@ -9,7 +9,7 @@ You can even use a different service for each page. You can find an example at link:https://github.com/redhat-developer/red-hat-developer-hub-customization-provider[`red-hat-developer-hub-customization-provider`], that provides the same data as default {product-short} data. The customization service provides a Learning Paths data URL such as: `pass:c,a,q[http://__/learning-paths]`. -. Configure the {product-short} proxy to use your dedicated service to provide the Learning Path data, add the following to the link:{configuring-book-url}[`{my-app-config-file}` file]: +. Configure the {product-short} proxy to use your dedicated service to provide the Learning Path data, add the following to the {configuring-book-link}[`{my-app-config-file}` file]: + [source,yaml,subs='+quotes'] ---- diff --git a/modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc b/modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc index 8fdc190bdb..bdfebdb3be 100644 --- a/modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc +++ b/modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc @@ -20,7 +20,7 @@ proxy: secure: true ---- -`__`:: Enter the hosted JSON file base URL, such as `https://raw.githubusercontent.com`. +`__`:: Enter the hosted JSON file base URL, such as `pass:[https://raw.githubusercontent.com]`. `__`:: Enter the hosted JSON file path without the base URL, such as `'/redhat-developer/rhdh/main/packages/app/public/learning-paths/data.json'` diff --git a/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc b/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc index 4bc51b2fa5..26edb3ed55 100644 --- a/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc +++ b/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc @@ -15,7 +15,7 @@ When using a dedicated service, you can do the following tasks: .Prerequisites * You have installed the {product} using Helm chart. -For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. +For more information, see xref:{installing-on-ocp-book-link}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. .Procedure @@ -36,7 +36,7 @@ To use the `red-hat-developer-hub-customization-provider` service, add the URL f *Target Port* automatically generates a Kubernetes or {ocp-short} service to communicate with. ==== + -. Add the following code to the link:{configuring-book-url}[`{my-app-config-file}` file]: +. Add the following code to the {configuring-book-link}[`{my-app-config-file}` file]: + [source,yaml] ---- diff --git a/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc b/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc index 214dfc02a1..f3818d7e4b 100644 --- a/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc +++ b/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc @@ -9,7 +9,7 @@ .Prerequisites * You have installed {product} by using either the Operator or Helm chart. -See xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}]. +See xref:{installing-on-ocp-book-link}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}]. .Procedure @@ -32,4 +32,4 @@ proxy: # Change to "false" in case of using self hosted cluster with a self-signed certificate headers: : # optional and can be passed as needed i.e Authorization can be passed for private GitHub repo and PRIVATE-TOKEN can be passed for private GitLab repo ----- \ No newline at end of file +---- diff --git a/modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-customization-service.adoc b/modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-customization-service.adoc index f4b9067cfa..2ddf25a7e8 100644 --- a/modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-customization-service.adoc +++ b/modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-customization-service.adoc @@ -6,7 +6,7 @@ You can even use a different service for each page. .Prerequisites * You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `{my-app-config-file}` file. -For example, you link:{integrating-with-github-book-url}[have enabled {product-short} integration with GitHub]. +For example, you {integrating-with-github-book-link}[have enabled {product-short} integration with GitHub]. * You have enabled the `./dynamic-plugins/dist/backstage-community-plugin-tech-radar` and `/dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic` plugins. diff --git a/modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-json-file.adoc b/modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-json-file.adoc index 2b45f64a86..f33827f911 100644 --- a/modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-json-file.adoc +++ b/modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-json-file.adoc @@ -1,18 +1,18 @@ +:_mod-docs-content-type: PROCEDURE [id='proc-customizing-the-tech-radar-page-by-using-a-json-file_{context}'] = Customizing the Tech Radar page by using a JSON file For ease of use and simplicity, you can configure the Tech Radar page by using a hosted JSON file. .Prerequisites - * You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `{my-app-config-file}` file. -For example, you link:{integrating-with-github-book-url}[have enabled {product-short} integration with GitHub]. +For example, you {integrating-with-github-book-link}[have enabled {product-short} integration with GitHub]. * You have enabled the `./dynamic-plugins/dist/backstage-community-plugin-tech-radar` and `/dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic` plugins. .Procedure - -. Publish the JSON file containing your Tech Radar data to a web server, such as GitHub or Gitlab. You can find an example at link:https://raw.githubusercontent.com/redhat-developer/rhdh/release-{product-version}/packages/app/public/tech-radar/data-default.json[]. +. Publish the JSON file containing your Tech Radar data to a web server, such as GitHub or Gitlab. +You can find an example at link:https://raw.githubusercontent.com/backstage/community-plugins/main/workspaces/tech-radar/plugins/tech-radar-common/src/sampleTechRadarResponse.json[]. . Configure {product-short} to access the Tech Radar data from the hosted JSON files, by adding the following to the `{my-app-config-file}` file: + diff --git a/modules/customizing/proc-customizing-the-backend-secret.adoc b/modules/customizing/proc-customizing-the-backend-secret.adoc index 1e82ace817..908297cf1e 100644 --- a/modules/customizing/proc-customizing-the-backend-secret.adoc +++ b/modules/customizing/proc-customizing-the-backend-secret.adoc @@ -6,7 +6,7 @@ The default {product} configuration defines the {product-short} backend secret f You can define your custom {product-short} backend secret. .Prerequisites -* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. .Procedure diff --git a/modules/customizing/proc-customizing-your-product-base-url.adoc b/modules/customizing/proc-customizing-your-product-base-url.adoc index 7371b369a5..2c85a2923c 100644 --- a/modules/customizing/proc-customizing-your-product-base-url.adoc +++ b/modules/customizing/proc-customizing-your-product-base-url.adoc @@ -1,11 +1,11 @@ -[id="customizing-your-product-se-url"] +[id="customizing-your-product-se-link"] = Customizing your {product} base URL You can change the default {product} base URL. .Prerequisites * You know your desired {product-short} external URL: pass:c,a,q[{my-product-url}], and have configured DNS to point to your {ocp-brand-name} cluster. -* link:{configuring-book-url}[Custom {product-short} configuration]. +* {configuring-book-link}[Custom {product-short} configuration]. .Procedure * In your custom `{my-app-config-file}` file, enter your {product-short} external URL, such as pass:c,a,q[{my-product-url}]. diff --git a/modules/customizing/proc-customizing-your-product-title.adoc b/modules/customizing/proc-customizing-your-product-title.adoc index b560084bde..5179137bca 100644 --- a/modules/customizing/proc-customizing-your-product-title.adoc +++ b/modules/customizing/proc-customizing-your-product-title.adoc @@ -4,7 +4,7 @@ You can change the default {product} display name. .Prerequisites -* link:{configuring-book-url}[Custom {product-short} configuration]. +* {configuring-book-link}[Custom {product-short} configuration]. .Procedure * In your custom `{my-app-config-file}` file, enter your {product-short} instance display name, such as _<{product}>_. diff --git a/modules/developer-lightspeed/con-supported-architecture.adoc b/modules/developer-lightspeed/con-supported-architecture.adoc index 3c214e775d..e6fc87710a 100644 --- a/modules/developer-lightspeed/con-supported-architecture.adoc +++ b/modules/developer-lightspeed/con-supported-architecture.adoc @@ -3,9 +3,9 @@ = Supported architecture for {ls-brand-name} {ls-short} is available as a plugin on all platforms that host {product-very-short}, and it requires the use of {rcs-name} ({rcs-short}) as a sidecar container. -For more information on the different available platforms to install {product-very-short}, see link:{install-category-url}[Install]. +For more information on the different available platforms to install {product-very-short}, see {install-category-link}[Install]. [NOTE] ==== Currently, the provided {rcs-short} image is built for x86 platforms. To use other platforms (for example, arm64), ensure that you enable emulation. -==== \ No newline at end of file +==== diff --git a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc index 77644a2ca3..85125c85f1 100644 --- a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc +++ b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc @@ -9,8 +9,8 @@ You must install and configure both the {ls-short} and the {rcs-short} sidecar c .Prerequisites * You are logged into your {ocp-short} account. * You have an {product-very-short} instance installed either of the following ways: -** link:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-operator[Using the Operator] -** link:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[Using the Helm chart] +** {installing-on-ocp-book-link}#assembly-install-rhdh-ocp-operator[Using the Operator] +** {installing-on-ocp-book-link}#assembly-install-rhdh-ocp-helm[Using the Helm chart] .Procedure @@ -100,27 +100,27 @@ data: script-src: - "'self'" - https://cdn.jsdelivr.net - + lightspeed: # REQUIRED: Configure LLM servers with OpenAI API compatibility servers: - id: ${LIGHTSPEED_SERVER_ID} url: ${LIGHTSPEED_SERVER_URL} token: ${LIGHTSPEED_SERVER_TOKEN} - + # OPTIONAL: Enable/disable question validation (default: true) # When enabled, restricts questions to RHDH-related topics for better security - questionValidation: true - + questionValidation: true + # OPTIONAL: Custom users prompts displayed to users # If not provided, the plugin uses built-in default prompts prompts: - title: 'Getting Started with Red Hat Developer Hub' message: Can you guide me through the first steps to start using Developer Hub as a developer, like exploring the Software Catalog and adding my service? - + # OPTIONAL: Port for lightspeed service (default: 8080) # servicePort: ${LIGHTSPEED_SERVICE_PORT} - + # OPTIONAL: Override default RHDH system prompt # systemPrompt: "You are a helpful assistant focused on Red Hat Developer Hub development." ---- @@ -193,7 +193,7 @@ includes: . Update your deployment configuration based on your installation method: .. For an Operator-installed {product-very-short} instance, update your {product-custom-resource-type} custom resource (CR). ... In the `spec.application.appConfig.configMaps` section, add the {ls-short} custom app configuration as shown in the following example: -+ ++ [source,yaml] ---- appConfig: @@ -202,7 +202,7 @@ includes: mountPath: /opt/app-root/src ---- ... Update the `extraVolumes` specification to include the {rcs-short} ConfigMap as shown in the following example: -+ ++ [source,yaml] ---- volumes: @@ -253,7 +253,7 @@ Your {product-very-short} container is typically already present in your CR. You ---- apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage -metadata: +metadata: name: backstage namespace: __ # your {product-very-short} instance namespace spec: @@ -320,7 +320,7 @@ spec: + [source,yaml] ---- -global: +global: dynamic: includes: - dynamic-plugins.default.yaml @@ -512,11 +512,11 @@ spec: configMaps: - name: rbac-policies ---- -For detailed information, see link:{authorization-book-url}managing-authorizations-by-using-external-files[Managing authorizations by using external files]. +For detailed information, see {authorization-book-link}managing-authorizations-by-using-external-files[Managing authorizations by using external files]. .Verification . Log in to your {product-very-short} instance. . In your {product} navigation menu, you are able to see and access the *Lightspeed* menu item. Clicking this menu takes you to the {ls-short} screen. -image::rhdh-plugins-reference/developer-lightspeed.png[] \ No newline at end of file +image::rhdh-plugins-reference/developer-lightspeed.png[] diff --git a/modules/dynamic-plugins/con-ansible-plugin-admin.adoc b/modules/dynamic-plugins/con-ansible-plugin-admin.adoc index a5ac281ca9..e2ac1461e5 100644 --- a/modules/dynamic-plugins/con-ansible-plugin-admin.adoc +++ b/modules/dynamic-plugins/con-ansible-plugin-admin.adoc @@ -4,5 +4,5 @@ Ansible plug-ins for {product} deliver an Ansible-specific portal experience wit push-button content creation, integrated development tools, and other opinionated resources. To install and configure the Ansible plugins, see -link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for Red Hat Developer Hub_]. +{ansible-automation-platform-docs-link}/html-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for Red Hat Developer Hub_]. diff --git a/modules/dynamic-plugins/con-ansible-plugin-user.adoc b/modules/dynamic-plugins/con-ansible-plugin-user.adoc index d8a4c67a91..99090e5d11 100644 --- a/modules/dynamic-plugins/con-ansible-plugin-user.adoc +++ b/modules/dynamic-plugins/con-ansible-plugin-user.adoc @@ -15,5 +15,5 @@ Additional detail on how Red Hat provides support for bundled community dynamic ==== To use the Ansible plugins, see -link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_]. +{ansible-automation-platform-docs-link}/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_]. diff --git a/modules/dynamic-plugins/con-ansible-plugin.adoc b/modules/dynamic-plugins/con-ansible-plugin.adoc index 6b38258a64..d69d5d817b 100644 --- a/modules/dynamic-plugins/con-ansible-plugin.adoc +++ b/modules/dynamic-plugins/con-ansible-plugin.adoc @@ -17,10 +17,10 @@ Additional detail on how Red Hat provides support for bundled community dynamic == For administrators To install and configure the Ansible plugins, see -link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for Red Hat Developer Hub_]. +{ansible-automation-platform-docs-link}/html-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for Red Hat Developer Hub_]. == For users To use the Ansible plugins, see -link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_]. +{ansible-automation-platform-docs-link}/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_]. diff --git a/modules/dynamic-plugins/proc-customizing-theme.adoc b/modules/dynamic-plugins/proc-customizing-theme.adoc index f132391681..eeb4e14526 100644 --- a/modules/dynamic-plugins/proc-customizing-theme.adoc +++ b/modules/dynamic-plugins/proc-customizing-theme.adoc @@ -16,7 +16,7 @@ export const darkThemeProvider = ({ children }: { children: ReactNode }) => ( ); ---- -For more information about creating a custom theme, see link:{customizing-book-url}#proc-loading-custom-theme-using-dynamic-plugin-_customizing-appearance[creating a custom theme]. +For more information about creating a custom theme, see {customizing-book-link}#proc-loading-custom-theme-using-dynamic-plugin-_customizing-appearance[creating a custom theme]. You can declare the theme using the `themes` configuration as shown in the following example: diff --git a/modules/dynamic-plugins/proc-enable-plugins-rhdh-container-image.adoc b/modules/dynamic-plugins/proc-enable-plugins-rhdh-container-image.adoc index abc8d270bd..3c7dc7c0a5 100644 --- a/modules/dynamic-plugins/proc-enable-plugins-rhdh-container-image.adoc +++ b/modules/dynamic-plugins/proc-enable-plugins-rhdh-container-image.adoc @@ -6,18 +6,18 @@ In the {product-very-short} container image, a set of dynamic plugins is preload You can enable and configure the plugins in the {product-very-short} container image, including how to manage the default configuration, set necessary environment variables, and ensure the proper functionality of the plugins within your application. .Prerequisites -* You have access to the link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file, which lists all preloaded plugins and their default configuration. +* You have access to the link:https://github.com/redhat-developer/rhdh/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file, which lists all preloaded plugins and their default configuration. * You have deployed the {product-very-short} application, and have access to the logs of the `install-dynamic-plugins` init container. * You have the necessary permissions to modify plugin configurations and access the application environment. * You have identified and set the required environment variables referenced by the plugin's default configuration. These environment variables must be defined in the Helm Chart or Operator configuration. .Procedure . Start your {product-very-short} application and access the logs of the `install-dynamic-plugins` init container within the {product-very-short} pod. -. Identify the link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/dynamic_plugins_reference/index#red-hat-supported-plugins[Red Hat supported plugins] that are disabled by default. -. Copy the package configuration from the link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file. +. Identify the {dynamic-plugins-reference-book-link}#red-hat-supported-plugins[Red Hat supported plugins] that are disabled by default. +. Copy the package configuration from the link:https://github.com/redhat-developer/rhdh/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file. . Open the plugin configuration file and locate the plugin entry you want to enable. + -The location of the plugin configuration file varies based on the deployment method. For more details, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-config-dynamic-plugins-rhdh-operator_rhdh-installing-rhdh-plugins[Installing dynamic plugins with the {product} Operator] and link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[Installing dynamic plugins using the Helm chart]. +The location of the plugin configuration file varies based on the deployment method. For more details, see {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}]. . Modify the `disabled` field to `false` and add the package name as follows: + -- @@ -28,7 +28,7 @@ plugins: - disabled: false package: ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic ---- -For more information about how to configure dynamic plugins in {product-short}, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/rhdh-installing-rhdh-plugins_title-plugins-rhdh-about[Installing dynamic plugins in {product}]. +For more information about how to configure dynamic plugins in {product-short}, see {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}]. -- .Verification diff --git a/modules/dynamic-plugins/proc-enable-users-to-use-topology-plugin.adoc b/modules/dynamic-plugins/proc-enable-users-to-use-topology-plugin.adoc index 16f26783f3..f36341f822 100644 --- a/modules/dynamic-plugins/proc-enable-users-to-use-topology-plugin.adoc +++ b/modules/dynamic-plugins/proc-enable-users-to-use-topology-plugin.adoc @@ -1,14 +1,14 @@ [id="enable-users-to-use-the-topology-plugin"] = Enable users to use the Topology plugin -The Topology plugin is defining additional permissions. When link:{authorization-book-url}[{authorization-book-title}] is enabled, to enable users to use the Topology plugin, grant them: +The Topology plugin is defining additional permissions. When {authorization-book-link}[{authorization-book-title}] is enabled, to enable users to use the Topology plugin, grant them: * The `kubernetes.clusters.read` and `kubernetes.resources.read`, `read` permissions to view the Topology panel. * The `kubernetes.proxy` `use` permission to view the pod logs. * The `catalog-entity` `read` permission to view the {product} software catalog items. .Prerequisites -* You are link:{authorization-book-url}#managing-authorizations-by-using-external-files[managing {authorization-book-title} by using external files]. +* You are {authorization-book-link}#managing-authorizations-by-using-external-files[managing {authorization-book-title} by using external files]. .Procedure * Add the following permission policies to your `rbac-policy.csv` file to create a `topology-viewer` role that has access to the Topology plugin features, and add the role to the users requiring this authorization: @@ -21,6 +21,6 @@ p, role:default/topology-viewer, kubernetes.resources.read, read, allow <1> p, role:default/topology-viewer, kubernetes.proxy, use, allow <2> p, role:default/topology-viewer, catalog-entity, read, allow <3> ---- -<1> Grants the user the ability to see the Topology panel. -<2> Grants the user the ability to view the pod logs. -<3> Grants the user the ability to see the catalog item. \ No newline at end of file +<1> Grants the user the ability to see the Topology panel. +<2> Grants the user the ability to view the pod logs. +<3> Grants the user the ability to see the catalog item. diff --git a/modules/dynamic-plugins/proc-extensions-configuring-rbac-role.adoc b/modules/dynamic-plugins/proc-extensions-configuring-rbac-role.adoc index c02d0c2840..74b7378b94 100644 --- a/modules/dynamic-plugins/proc-extensions-configuring-rbac-role.adoc +++ b/modules/dynamic-plugins/proc-extensions-configuring-rbac-role.adoc @@ -1,7 +1,7 @@ [id="proc-extensions-configuring-rbac-role_{context}"] = Configuring RBAC to manage Extensions -You can add Extensions permissions by creating or updating and existing RBAC role. For more information about using RBAC to manage role-based controls, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/authorization_in_red_hat_developer_hub/managing-authorizations-by-using-the-web-ui[Managing role-based access controls (RBAC) using the {product} Web UI]. +You can add Extensions permissions by creating or updating and existing RBAC role. For more information about using RBAC to manage role-based controls, see {authorization-book-link}#managing-authorizations-by-using-the-web-ui[Managing role-based access controls (RBAC) using the {product} Web UI]. == Creating a role in the {product-short} UI to manage Extensions diff --git a/modules/dynamic-plugins/proc-extensions-creating.adoc b/modules/dynamic-plugins/proc-extensions-creating.adoc index 2b34bb80eb..0dc545040a 100644 --- a/modules/dynamic-plugins/proc-extensions-creating.adoc +++ b/modules/dynamic-plugins/proc-extensions-creating.adoc @@ -1,5 +1,6 @@ [id="rhdh-extensions-plugins-creating_{context}"] = Adding your own plugin metadata to Extensions + You can add your own plugin metadata to Extensions. .Prequisites @@ -109,7 +110,7 @@ spec: [%header,cols=3*] |=== |*Attribute* |*Type* |*Description* -// |3scale |`https://npmjs.com/package/@backstage-community/plugin-3scale-backend/v/3.0.3[@backstage-community/plugin-3scale-backend]` |3.0.3 +// |3scale |`https://npmjs.com/package/@backstage-community/plugin-3scale-backend/v/3.0.3[@backstage-community/plugin-3scale-backend]` |3.0.3 // |`./dynamic-plugins/dist/backstage-community-plugin-3scale-backend-dynamic` // `THREESCALE_BASE_URL` @@ -118,11 +119,11 @@ spec: -| `metadata.description` | `string` | Short description that is shown on the cards (text). -| `spec.author` | `string` | A single author name, this attribute is automatically converted to authors if specified. +| `metadata.description` | `string` | Short description that is shown on the cards (text). +| `spec.author` | `string` | A single author name, this attribute is automatically converted to authors if specified. | `spec.authors` | `{ name: string, url?: string }[]` | Authors array if a plugin is developed by multiple authors. -| `spec.categories` | `string[]` | Categories are displayed directly as filter and labels. +| `spec.categories` | `string[]` | Categories are displayed directly as filter and labels. | `spec.highlights` | `string[]` | Highlights for the details page. | `spec.description` | `string` | Full description that is shown on the details page (markdown). | `spec.installation` | `string` | Full installation description that is shown later on the install page (markdown). -| `spec.icon` | `string` | Icon URL \ No newline at end of file +| `spec.icon` | `string` | Icon URL diff --git a/modules/dynamic-plugins/proc-extensions-enabling-plugins-installation.adoc b/modules/dynamic-plugins/proc-extensions-enabling-plugins-installation.adoc index 1c9058ce6b..d0625c6e15 100644 --- a/modules/dynamic-plugins/proc-extensions-enabling-plugins-installation.adoc +++ b/modules/dynamic-plugins/proc-extensions-enabling-plugins-installation.adoc @@ -3,7 +3,7 @@ When you install a plugin using Extensions UI, the configuration that you use is saved to a `dynamic-plugins.extensions.yaml` file within the `dynamic-plugins-root` persistent volume. This ensures the configuration is available when you restart the application, allowing you to edit or re-enable the plugin. -You must create a persistent volume claim (PVC) to ensure that the cache persists when you restart the {product-very-short} application. For more information about using the dynamic plugins cache, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_red_hat_developer_hub/index#using-the-dynamic-plugins-cache_running-behind-a-proxy[Using the dynamic plugins cache]. +You must create a persistent volume claim (PVC) to ensure that the cache persists when you restart the {product-very-short} application. For more information about using the dynamic plugins cache, see {configuring-book-link}#using-the-dynamic-plugins-cache_running-behind-a-proxy[Using the dynamic plugins cache]. .Prerequisites * You have created a persistent volume claim (PVC) for the dynamic plugins cache with the name *dynamic-plugins-root*. @@ -18,7 +18,7 @@ You must create a persistent volume claim (PVC) to ensure that the cache persist includes: - dynamic-plugins.default.yaml -plugins: +plugins: - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace disabled: false pluginConfig: @@ -128,4 +128,4 @@ upstream: ... Click *Upgrade* .Verification -Enable a plugin by using the Extensions UI, restart your {product-very-short} application and refresh the UI to confirm that the plugin is enabled. \ No newline at end of file +Enable a plugin by using the Extensions UI, restart your {product-very-short} application and refresh the UI to confirm that the plugin is enabled. diff --git a/modules/dynamic-plugins/proc-install-plugins-using-custom-npm-registry.adoc b/modules/dynamic-plugins/proc-install-plugins-using-custom-npm-registry.adoc index 06119b4da9..de157631c0 100644 --- a/modules/dynamic-plugins/proc-install-plugins-using-custom-npm-registry.adoc +++ b/modules/dynamic-plugins/proc-install-plugins-using-custom-npm-registry.adoc @@ -18,8 +18,8 @@ metadata: type: Opaque stringData: .npmrc: | - registry= - //:_authToken= + registry= + //:_authToken= ... ---- -<1> Replace `__` with your Helm release name. This name is a unique identifier for each chart installation in the Kubernetes cluster. \ No newline at end of file +<1> Replace `__` with your Helm release name. This name is a unique identifier for each chart installation in the Kubernetes cluster. diff --git a/modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc b/modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc index 417e1af3d8..6696ea1f88 100644 --- a/modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc +++ b/modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc @@ -28,6 +28,6 @@ If Red Hat OpenShift Dev Spaces is installed and configured and Git URL annotati When you deploy your application using the OCP Git import flows, then you do not need to add the labels as import flows do that. Otherwise, you need to add the labels manually to the workload YAML file. ==== -//The labels are not similar to `backstage.io/edit-url` annotations as it points to the catalog entity metadata source file and is applied to RHDH catalog entity metadata YAML file, but not Kubernetes resources. +//The labels are not similar to `backstage.io/edit-link` annotations as it points to the catalog entity metadata source file and is applied to RHDH catalog entity metadata YAML file, but not Kubernetes resources. -You can also add the `app.openshift.io/edit-url` annotation with the edit URL that you want to access using the decorator. \ No newline at end of file +You can also add the `app.openshift.io/edit-link` annotation with the edit URL that you want to access using the decorator. diff --git a/modules/dynamic-plugins/proc-load-plugin-js-package.adoc b/modules/dynamic-plugins/proc-load-plugin-js-package.adoc index 7c04817174..a6dfb00006 100644 --- a/modules/dynamic-plugins/proc-load-plugin-js-package.adoc +++ b/modules/dynamic-plugins/proc-load-plugin-js-package.adoc @@ -2,7 +2,7 @@ = Loading a plugin packaged as a JavaScript package .Prerequisites -* The third-party plugin is packaged as a dynamic plugin in a JavaScript package. +* The third-party plugin is packaged as a dynamic plugin in a JavaScript package. + For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[]. @@ -12,7 +12,7 @@ For more information about packaging a third-party plugin, see xref:assembly-pac -- [source,terminal] ---- -npm view --registry @ dist.integrity +npm view --registry @ dist.integrity ---- -- @@ -35,8 +35,8 @@ plugins: .Example code for `.npmrc` file [source,text] ---- -registry= -//:_authToken= +registry= +//:_authToken= ---- -- @@ -55,8 +55,8 @@ metadata: type: Opaque stringData: .npmrc: | - registry= - //:_authToken= + registry= + //:_authToken= ---- <1> Replace `__` with your Helm release name. This name is a unique identifier for each chart installation in the Kubernetes cluster. @@ -65,4 +65,4 @@ stringData: `__-dynamic-plugins-npmrc` -- -. To apply the changes, restart the {product-very-short} application. \ No newline at end of file +. To apply the changes, restart the {product-very-short} application. diff --git a/modules/dynamic-plugins/ref-rh-compatible-plugins.adoc b/modules/dynamic-plugins/ref-rh-compatible-plugins.adoc index 5cca90f229..5cc280fe2d 100644 --- a/modules/dynamic-plugins/ref-rh-compatible-plugins.adoc +++ b/modules/dynamic-plugins/ref-rh-compatible-plugins.adoc @@ -1,4 +1,4 @@ -= Other installable plugins += Other installable plugins The following Technology Preview plugins are not preinstalled and must be installed from an external source: @@ -7,15 +7,15 @@ The following Technology Preview plugins are not preinstalled and must be instal |*Name* |*Plugin*|*Version* |*Installation Details* |Ansible Automation Platform Frontend|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap]` |1.0.0 -| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more] +| {ansible-automation-platform-docs-link}/html-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[Learn more] |Ansible Automation Platform -| `https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap-backend]` |1.0.0 -| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more] +| `https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap-backend]` |1.0.0 +| {ansible-automation-platform-docs-link}/html-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[Learn more] |Ansible Automation Platform Scaffolder Backend -|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-scaffolder-backend-module-backstage-rhaap]` |1.0.0 -| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more] +|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-scaffolder-backend-module-backstage-rhaap]` |1.0.0 +| {ansible-automation-platform-docs-link}/html-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[Learn more] // temporarily removed until we have a good installation story from the Orchestrator team //|Orchestrator Frontend|`https://www.npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator[@red-hat-developer-hub/backstage-plugin-orchestrator]` | N/A for RHDH 1.4 | https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator/[Learn more] @@ -29,6 +29,6 @@ The following Technology Preview plugins are not preinstalled and must be instal //[NOTE] //==== // -//* The above Red Hat Ansible Automation Platform (RHAAP) plugins, can be used as a replacement for the older plugin listed in the link:{configuring-dynamic-plugins-book-url}#rhdh-tech-preview-plugins[Technology Preview plugins] section of _{configuring-dynamic-plugins-book-title}_. +//* The above Red Hat Ansible Automation Platform (RHAAP) plugins, can be used as a replacement for the older plugin listed in the {configuring-dynamic-plugins-book-link}#rhdh-tech-preview-plugins[Technology Preview plugins] section of _{configuring-dynamic-plugins-book-title}_. //==== diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 363cb5d428..1817b3ad7e 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -3,7 +3,7 @@ You can enable the Bulk Import feature for users and give them the necessary permissions to access it. .Prerequisites -* You have link:{integrating-with-github-book-url}#enabling-github-repository-discovery[enabled GitHub repository discovery]. +* You have xref:enabling-github-repository-discovery[enabled GitHub repository discovery]. .Procedure @@ -21,7 +21,7 @@ plugins: disabled: false ---- + -See link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]. +See {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}]. . Configure the required `bulk.import` RBAC permission for the users who are not administrators as follows: + @@ -32,7 +32,7 @@ p, role:default/bulk-import, bulk.import, use, allow g, user:default/____, role:default/bulk-import ---- + -Note that only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. +Note that only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. See {authorization-book-link}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. .Verification * The sidebar displays a *Bulk Import* option. diff --git a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc index 6cec0e651a..95f5775b23 100644 --- a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -23,7 +23,7 @@ Empty:: {product-short} is unable to determine the import job status because the [NOTE] ==== * After an import pull request is merged, the import status is marked as _Added_ in the list of Added Repositories, but it might take a few seconds for the corresponding entities to appear in the {product-short} Catalog. -* A location added through other sources (like statically in an `{my-app-config-file}` file, dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery], or registered manually using the "Register an existing component" page) might show up in the Bulk Import list of Added Repositories if the following conditions are met: +* A location added through other sources (like statically in an `{my-app-config-file}` file, dynamically when xref:enabling-github-repository-discovery[enabling GitHub discovery], or registered manually using the "Register an existing component" page) might show up in the Bulk Import list of Added Repositories if the following conditions are met: ** The target repository is accessible from the configured GitHub integrations. ** The location URL points to a `catalog-info.yaml` file at the root of the repository default branch. ==== diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc index b88ff09f4d..4b01d079f8 100644 --- a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc +++ b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc @@ -2,7 +2,7 @@ = Understanding the Bulk Import audit Logs The Bulk Import backend plugin adds the following events to the {product-short} audit logs. -See link:{linkgettingstartedguide}#assembly-audit-log[Audit Logs in {product}] for more information on how to configure and view audit logs. +See {audit-log-book-link}[{audit-log-book-title}] for more information on how to configure and view audit logs. *Bulk Import Events*: diff --git a/modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc b/modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc index 65f32d7b58..420dcc626e 100644 --- a/modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc +++ b/modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc @@ -73,7 +73,7 @@ data: The `backstage-plugin-kubernetes` plugin is currently in link:https://access.redhat.com/support/offerings/techpreview[Technology Preview]. As an alternative, you can use the `./dynamic-plugins/dist/backstage-plugin-topology-dynamic` plugin, which is Generally Available (GA). ==== -. Set the Kubernetes cluster details and configure the catalog sync options in the link:{configuring-book-url}[`{my-app-config-file}` configuration file]. +. Set the Kubernetes cluster details and configure the catalog sync options in the {configuring-book-link}[`{my-app-config-file}` configuration file]. + [source,yaml,subs="+attributes"] ---- diff --git a/modules/installation/proc-deploy-rhdh-instance-eks.adoc b/modules/installation/proc-deploy-rhdh-instance-eks.adoc index 25a272fad6..b23728f114 100644 --- a/modules/installation/proc-deploy-rhdh-instance-eks.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-eks.adoc @@ -11,7 +11,7 @@ * You have an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on installed. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on {eks-brand-name}] and https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on]. * You have configured a domain name for your {product-short} instance. The domain name can be a hosted zone entry on Route 53 or managed outside of AWS. For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service] documentation. * You have an entry in the {aws-short} Certificate Manager (ACM) for your preferred domain name. Make sure to keep a record of your Certificate ARN. -* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have subscribed to `registry.redhat.io`. For more information, see link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. * You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster]. * You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl]. diff --git a/modules/installation/proc-deploy-rhdh-instance-gke.adoc b/modules/installation/proc-deploy-rhdh-instance-gke.adoc index c3439bd13c..2a047eb00e 100644 --- a/modules/installation/proc-deploy-rhdh-instance-gke.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-gke.adoc @@ -4,7 +4,7 @@ You can deploy your {product-short} instance in {gke-short} using the Operator. .Prerequisites * A cluster administrator has installed the {product} Operator. -* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have subscribed to `registry.redhat.io`. For more information, see link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. * You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl]. * You have configured a domain name for your {product-short} instance. @@ -21,7 +21,7 @@ You need to create an `A` record with the value equal to the IP address. This pr + -- .`{my-app-config-file}` fragment -[source,yaml,subs="attributes+"] +[source,yaml,subs="+attributes,+quotes"] ---- apiVersion: v1 kind: ConfigMap @@ -31,7 +31,7 @@ data: "{my-app-config-file}": | app: title: Red Hat Developer Hub - baseUrl: https:// + baseUrl: {my-product-url} backend: auth: externalAccess: @@ -39,9 +39,9 @@ data: options: subject: legacy-default-config secret: "${BACKEND_SECRET}" - baseUrl: https:// + baseUrl: {my-product-url} cors: - origin: https:// + origin: {my-product-url} ---- -- @@ -122,7 +122,7 @@ metadata: name: spec: domains: - - + - {my-product-domain} ---- -- For more information about setting up a Google-managed certificate, see https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs?hl=en#setting_up_a_google-managed_certificate[Setting up a Google-managed certificate]. @@ -149,7 +149,7 @@ For more information about setting a policy to redirect to HTTPS, see https://cl + -- .Example of an ingress resource configuration -[source,yaml,subs="attributes+"] +[source,yaml,subs="+attributes,+quotes"] ---- apiVersion: networking.k8s.io/v1 kind: Ingress @@ -166,7 +166,7 @@ spec: ingressClassName: gce rules: # TODO: Set your application domain name. - - host: + - host: {my-product-domain} http: paths: - path: / @@ -187,7 +187,7 @@ spec: * Wait for the `ManagedCertificate` to be provisioned. This process can take a couple of hours. -* Access {product-very-short} with `https://` +* Access {product-very-short} with `pass:a,q[{my-product-url}]`. // Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use. diff --git a/modules/installation/proc-enable-signin.adoc b/modules/installation/proc-enable-signin.adoc index 60a61bca36..55643e67da 100644 --- a/modules/installation/proc-enable-signin.adoc +++ b/modules/installation/proc-enable-signin.adoc @@ -63,7 +63,7 @@ The {product} supports the following authentication providers: .Prerequisites * You have installed the {product-short}. -For more information about installation, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. +For more information about installation, see xref:{installing-on-ocp-book-link}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. .Procedure diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc index 02c0e58f1b..63556c1046 100644 --- a/modules/installation/proc-install-operator.adoc +++ b/modules/installation/proc-install-operator.adoc @@ -14,8 +14,8 @@ Containers are available for the following CPU architectures: .Prerequisites * You are logged in as an administrator on the {ocp-short} web console. -* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]. -* You have installed {ocp-brand-name} 4.17 or later. +* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the {ocp-docs-link}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]. +* You have installed {ocp-brand-name} {ocp-version-min} to {ocp-version}. .Procedure @@ -26,7 +26,7 @@ Containers are available for the following CPU architectures: + Before you create a {product-short} instance, you must create the required config map and Secret resources in your project. These include the `baseUrl` and service-to-service authentication secrets. + -For detailed steps, see xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +For detailed steps, see xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. . From the *Update channel* drop-down menu, select the update channel that you want to use, for example, *fast* or *fast-{product-version}*. + [IMPORTANT] @@ -57,9 +57,9 @@ The *All namespaces on the cluster (default)* option is selected by default. The ==== For enhanced security, better control over the Operator lifecycle, and preventing potential privilege escalation, install the {product} Operator in a dedicated default `rhdh-operator` namespace. You can restrict other users' access to the Operator resources through role bindings or cluster role bindings. -You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-global-namespaces_olm-adding-operators-to-a-cluster[Installing global Operators in custom namespaces]. +You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see {ocp-docs-link}/html-single/operators/index#olm-installing-global-namespaces_olm-adding-operators-to-a-cluster[Installing global Operators in custom namespaces]. -However, if the {product} Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the {product} Operator update policy is also set to manual. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-colocation-namespaces_olm-colocation[Colocation of Operators in a namespace]. +However, if the {product} Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the {product} Operator update policy is also set to manual. For more information, see {ocp-docs-link}/html-single/operators/index#olm-colocation-namespaces_olm-colocation[Colocation of Operators in a namespace]. ==== + . Select the *Update approval* method for the Operator. @@ -87,4 +87,4 @@ If you selected an *Automatic* approval strategy, the upgrade status should reso .Additional resources * xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with the Operator] -* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console] +* {ocp-docs-link}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console] diff --git a/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc b/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc index 5ad3a6b9b5..f4923b44d8 100644 --- a/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc +++ b/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc @@ -9,11 +9,11 @@ If your network has access to the registry through a bastion host, you can use t ** You have access to the registry.redhat.io. ** You have access to the charts.openshift.io Helm chart repository. ** You have installed the {openshift-cli} on your workstation. -** You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin]. +* {ocp-docs-link}/html-single/disconnected_environments/index#about-installing-oc-mirror-v2[You have installed the oc-mirror OpenShift CLI plugin]. ** You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal. -* You have set up your intermediary host. -** Your host has access to the disconnected cluster and to the target mirror registry, for example, the {ocp-brand-name} image registry. For more information about exposing the {ocp-short} image registry, see https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry]. -** You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin]. +** You have set up your intermediary host. +** Your host has access to the disconnected cluster and to the target mirror registry, for example, the {ocp-brand-name} image registry. For more information about exposing the {ocp-short} image registry, see {ocp-docs-link}/html-single/registry/index#securing-exposing-registry[Exposing the registry]. +** {ocp-docs-link}/html-single/disconnected_environments/index#about-installing-oc-mirror-v2[You have installed the oc-mirror OpenShift CLI plugin]. ** You have installed {ocp-brand-name} {ocp-version-min} or later. ** You have installed the {openshift-cli} on your workstation. @@ -52,7 +52,7 @@ where: `` :: Specifies the name of your mirror configuration yaml file, for example, `mirror-config.yaml` -`` :: Specifies the location of your directory where the mirror archive will be created, for example,`file://.user`. +`` :: Specifies the location of your directory where the mirror archive will be created, for example, `pass:[file://.user]`. -- + [NOTE] @@ -146,4 +146,4 @@ where: `` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`. `` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`. --- \ No newline at end of file +-- diff --git a/modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc b/modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc index f6d75e2634..dd144db925 100644 --- a/modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc +++ b/modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc @@ -8,10 +8,10 @@ If your network has access to the `registry.redhat.io` registry and the `charts. * You have installed {ocp-brand-name} {ocp-version-min} or later. * You have access to the `charts.openshift.io` Helm chart repository. * You have access to the `registry.redhat.io`. -* You have access to a mirror registry that can be reached from the disconnected cluster, for example, the {ocp-short} image registry. For more information about exposing the {ocp-short} image registry, see https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry]. -* You are logged in to your target mirror registry and have permissions to push images to it. For more information, see link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-adding-registry-pull-secret_installing-mirroring-disconnected[Configuring credentials that allow images to be mirrored]. +* You have access to a mirror registry that can be reached from the disconnected cluster, for example, the {ocp-short} image registry. For more information about exposing the {ocp-short} image registry, see {ocp-docs-link}/html-single/registry/index#securing-exposing-registry[Exposing the registry]. +* You are logged in to your target mirror registry and have permissions to push images to it. For more information, see {ocp-docs-link}/html-single/disconnected_environments/index#installation-adding-registry-pull-secret_about-installing-oc-mirror-v2[Configuring credentials that allow images to be mirrored]. * You have installed the {openshift-cli} on your workstation. -* You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin]. +* {ocp-docs-link}/html-single/disconnected_environments/index#about-installing-oc-mirror-v2[You have installed the oc-mirror OpenShift CLI plugin]. * You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal. .Procedure @@ -122,4 +122,4 @@ where: `` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`. `` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`. --- \ No newline at end of file +-- diff --git a/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc b/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc index 3588eb2909..86ba1136ca 100644 --- a/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc +++ b/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc @@ -9,8 +9,8 @@ You can use the Helm CLI to install {product} on {ocp-brand-name}. .Prerequisites * You have installed the {openshift-cli} on your workstation. * You are logged in to your {ocp-short} account. -* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]. -* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation]. +* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see {ocp-docs-link}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]. +* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see {ocp-docs-link}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation]. * You have installed the Helm CLI tool. .Procedure @@ -50,4 +50,4 @@ echo "https://redhat-developer-hub-$NAMESPACE.$CLUSTER_ROUTER_BASE" * Open the running {product-short} instance URL in your browser to use {product-short}. .Additional resources -* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm] \ No newline at end of file +* {osd-docs-link}/html-single/building_applications/index#installing-helm[Installing Helm] diff --git a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc index 5bf3c684dc..00ae9ef92d 100644 --- a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc +++ b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc @@ -18,8 +18,8 @@ The {product} Helm chart is available in the Helm catalog on {osd-short} and {oc .Prerequisites * You are logged in to your {ocp-short} account. -* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]. -* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation]. +* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see {ocp-docs-link}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]. +* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see {ocp-docs-link}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation]. .Procedure diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 56e24b8c1a..add05f2f90 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -9,8 +9,8 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the .Prerequisites * You have set the `baseUrl` in your `{my-app-config-file}` to match the external URL of your {product-short} instance. Without it, frontend and backend services cannot communicate, and features might not work as expected. * xref:proc-install-operator_{context}[An {ocp-short} administrator has installed the {product} Operator]. -* xref:{configuring-book-url}#provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. -* xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[You have authored your {product-custom-resource-type} custom resource]. +* xref:{configuring-book-link}#provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. +* xref:{configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configuration[You have authored your {product-custom-resource-type} custom resource]. .Procedure @@ -44,7 +44,7 @@ data: + Use a config map named `app-config-rhdh` to provide your `app-config.yaml` file, and a Secret for service-to-service authentication (such as `BACKEND_SECRET`). + -To create and apply these configuration resources, follow the steps in xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration] for the full procedure. +To create and apply these configuration resources, follow the steps in xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration] for the full procedure. + [NOTE] ==== @@ -68,10 +68,10 @@ stringData: + [NOTE] ==== -Ensure that your secret includes `BACKEND_SECRET`, used for service-to-service authentication. For structure and provisioning steps, see xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +Ensure that your secret includes `BACKEND_SECRET`, used for service-to-service authentication. For structure and provisioning steps, see xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. ==== . Click *Create*. -. xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Add your {product-custom-resource-type} custom resource content]. +. xref:{configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Add your {product-custom-resource-type} custom resource content]. . On the *Create Backstage* page, click *Create*. .Verification @@ -87,4 +87,4 @@ image::rhdh/operator-install-1.png[] [role="_additional-resources"] [id="additional-resources_proc-install-rhdh-ocp-operator"] .Additional resources -* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-short} - Building applications overview] +* {ocp-docs-link}/html-single/building_applications/index#building-applications-overview[{ocp-short} - Building applications overview] diff --git a/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc b/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc index aacb27585d..61b0025836 100644 --- a/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc +++ b/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc @@ -13,8 +13,8 @@ If your network has access to the registry through a bastion host, you can use t * You have installed `yq` 4.44 or later. * You have installed the GNU `sed` command line text editor. * You have installed `umoci` CLI tool. -* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. -* You have installed the `opm` CLI tool. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI]. +* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have installed the `opm` CLI tool. For more information, see {ocp-docs-link}/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI]. .Procedure . Download the mirroring script to disk by running the following command: @@ -77,8 +77,8 @@ kubectl -n rhdh-operator get pods .Next steps * Use the Operator to create a {product} instance on a supported platform. For more information, see the following documentation for the platform that you want to use: -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_container_platform/assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator] -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/proc-rhdh-deploy-eks-operator_title-install-rhdh-eks[Installing {product-short} on {eks-short} with the Operator] -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks[Installing {product-short} on {aks-short} with the Operator] -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[Installing {product-short} on {gcp-short} with the Operator] -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_google_kubernetes_engine/proc-rhdh-deploy-gke-operator.adoc_title-install-rhdh-gke#proc-deploy-rhdh-instance-gke.adoc_title-install-rhdh-gke[Deploying {product-short} on {gke-short} with the Operator] +** {installing-on-ocp-book-link}#assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator] +** {installing-on-eks-book-link}#assembly-install-rhdh-eks-operator[Installing {product-short} on {eks-short} with the Operator] +** {installing-on-aks-book-link}#proc-rhdh-deploy-aks-operator_title-install-rhdh-aks[Installing {product-short} on {aks-short} with the Operator] +** {installing-on-osd-on-gcp-book-link}#proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[Installing {product-short} on {gcp-short} with the Operator] +** {installing-on-gke-book-link}#proc-deploy-rhdh-instance-gke.adoc_title-install-rhdh-gke[Deploying {product-short} on {gke-short} with the Operator] diff --git a/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc b/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc index 725af137f8..4efd474b02 100644 --- a/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc +++ b/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc @@ -19,9 +19,9 @@ When connected to a {ocp-short} cluster, the helper script detects it and automa * You have installed `yq` 4.44 or later. * You have installed the GNU `sed` command line text editor. * You have installed `umoci` CLI tool. -* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. * You have an active `skopeo` session with administrative access to the target mirror registry. For more information, see link:https://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry]. -* You have installed the `opm` CLI tool. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI]. +* You have installed the `opm` CLI tool. For more information, see link:{ocp-docs-link}/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI]. * If you are using an {ocp-short} cluster, you have the following prerequisites: ** (Optional) You have installed the `oc-mirror` {ocp-short} CLI plugin if you want to use it to mirror images. * If you are using a supported Kubernetes cluster, you have the following prerequisites: @@ -65,8 +65,8 @@ kubectl -n rhdh-operator get pods .Next steps * Use the Operator to create a {product} instance on a supported platform. For more information, see the following documentation for the platform that you want to use: -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_container_platform/assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator] -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/proc-rhdh-deploy-eks-operator_title-install-rhdh-eks[Installing {product-short} on {eks-short} with the Operator] -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks[Installing {product-short} on {aks-short} with the Operator] -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[Installing {product-short} on {gcp-short} with the Operator] -** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_google_kubernetes_engine/proc-rhdh-deploy-gke-operator.adoc_title-install-rhdh-gke#proc-deploy-rhdh-instance-gke.adoc_title-install-rhdh-gke[Deploying {product-short} on {gke-short} with the Operator] \ No newline at end of file +** {installing-on-ocp-book-link}#assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator] +** {installing-on-eks-book-link}#assembly-install-rhdh-eks-operator[Installing {product-short} on {eks-short} with the Operator] +** {installing-on-aks-book-link}#proc-rhdh-deploy-aks-operator_title-install-rhdh-aks[Installing {product-short} on {aks-short} with the Operator] +** {installing-on-osd-on-gcp-book-link}#proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[Installing {product-short} on {gcp-short} with the Operator] +** {installing-on-gke-book-link}#proc-deploy-rhdh-instance-gke.adoc_title-install-rhdh-gke[Deploying {product-short} on {gke-short} with the Operator] diff --git a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc index ebddb9701c..a06264cd4b 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc @@ -8,7 +8,7 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product .Prerequisites * You have a valid {gcp-short} account. -* Your {osd-short} cluster is running on {gcp-short}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/installing_accessing_and_deleting_openshift_dedicated_clusters/osd-creating-a-cluster-on-gcp[Creating a cluster on GCP] in {osd-brand-name} documentation. +* Your {osd-short} cluster is running on {gcp-short}. For more information, see{osd-docs-link}/html/installing_accessing_and_deleting_openshift_dedicated_clusters/osd-creating-a-cluster-on-gcp[Creating a cluster on GCP] in {osd-brand-name} documentation. * You have installed Helm 3 or the latest. .Procedure @@ -28,14 +28,14 @@ To configure the `baseUrl`, set the following values in your Helm configuration: ---- global: app: - baseUrl: https:// + baseUrl: https:// backend: - baseUrl: https:// + baseUrl: https:// cors: - origin: https:// + origin: https:// ---- You can also define additional secrets, plugins, and advanced configuration in your `values.yaml` file. For full instructions, see: -xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. ==== + The *Form view* is selected by default. @@ -65,5 +65,5 @@ global: * To access the the {product-short}, click the *Open URL* icon. .Additional resources -* link:{configuring-book-url}[{configuring-book-title}] -* link:{customizing-book-url}[{customizing-book-title}] +* {configuring-book-link}[{configuring-book-title}] +* {customizing-book-link}[{customizing-book-title}] diff --git a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc index 0f3e392f99..4a8b716723 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -8,7 +8,7 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product .Prerequisites * You have a valid {gcp-short} account. -* Your {osd-short} cluster is running on {gcp-short}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html/installing_accessing_and_deleting_openshift_dedicated_clusters/osd-creating-a-cluster-on-gcp[Creating a cluster on GCP] in {osd-brand-name} documentation. +* Your {osd-short} cluster is running on {gcp-short}. For more information, see{osd-docs-link}/html/installing_accessing_and_deleting_openshift_dedicated_clusters/osd-creating-a-cluster-on-gcp[Creating a cluster on GCP] in {osd-brand-name} documentation. * You have administrator access to {osd-short} cluster and {gcp-short} project. .Procedure @@ -46,7 +46,7 @@ data: + You must create a config map named `app-config-rhdh` and a Kubernetes Secret containing the `BACKEND_SECRET`. These resources are used by the {product-short} instance for authentication and application settings. + -For further steps, see xref:{configuring-book-url}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +For further steps, see xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. . Create a config map named `app-config-rhdh` that includes your `{my-app-config-file}` as shown: + -- @@ -97,5 +97,5 @@ stringData: * To access the {product-short}, navigate to the {product-short} URL provided in the {ocp-short} web console. .Additional resources -* link:{configuring-book-url}[{configuring-book-title}] -* link:{customizing-book-url}[{customizing-book-title}] +* {configuring-book-link}[{configuring-book-title}] +* {customizing-book-link}[{customizing-book-title}] diff --git a/modules/installation/proc-rhdh-deploy-aks-helm.adoc b/modules/installation/proc-rhdh-deploy-aks-helm.adoc index 7118e0a636..39694e0eaa 100644 --- a/modules/installation/proc-rhdh-deploy-aks-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-helm.adoc @@ -9,7 +9,7 @@ You can deploy your {product-short} application on {aks-name} ({aks-short}) to a .Prerequisites * You have a {azure-brand-name} account with active subscription. -* You have installed the https://learn.microsoft.com/en-us/cli/azure/install-azure-cli[Azure CLI]. +* You have installed the https://learn.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest[Azure CLI]. * You have installed the link:https://kubernetes.io/docs/reference/kubectl/[`kubectl` CLI]. * You are logged into your cluster using `kubectl`, and have `developer` or `admin` permissions. * You have installed Helm 3 or the latest. diff --git a/modules/installation/proc-rhdh-deploy-aks-operator.adoc b/modules/installation/proc-rhdh-deploy-aks-operator.adoc index 2b987ef171..4d60ecc404 100644 --- a/modules/installation/proc-rhdh-deploy-aks-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-operator.adoc @@ -163,7 +163,7 @@ kubectl -n {my-product-namespace} apply -f rhdh.yaml ---- -- -. Access the deployed {product-short} using the URL: `https://`, where is the Ingress address obtained earlier (for example, `https://108.141.70.228`). +. Access the deployed {product-short} using the URL: `pass:c,a,q[https://]`, where __ is the Ingress address obtained earlier (for example, `pass:[https://108.141.70.228]`). . Optional: To delete the CR, run the following command: + -- diff --git a/modules/installation/proc-rhdh-deploy-eks-helm.adoc b/modules/installation/proc-rhdh-deploy-eks-helm.adoc index c6aff3342e..504d1e41f9 100644 --- a/modules/installation/proc-rhdh-deploy-eks-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-eks-helm.adoc @@ -11,7 +11,7 @@ When you install the {product-short} Helm chart in {eks-name} ({eks-short}), it * You have an {eks-short} cluster with AWS Application Load Balancer (ALB) add-on installed. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on Amazon {product-short}] and https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on]. * You have configured a domain name for your {product-short} instance. The domain name can be a hosted zone entry on Route 53 or managed outside of AWS. For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service] documentation. * You have an entry in the AWS Certificate Manager (ACM) for your preferred domain name. Make sure to keep a record of your Certificate ARN. -* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have subscribed to `registry.redhat.io`. For more information, see link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. * You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster]. * You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl]. * You have installed Helm 3 or the latest. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/helm.html[Using Helm with Amazon {eks-short}]. diff --git a/modules/installation/proc-rhdh-deploy-eks-operator.adoc b/modules/installation/proc-rhdh-deploy-eks-operator.adoc index 55faec2668..23edd25a0e 100644 --- a/modules/installation/proc-rhdh-deploy-eks-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-eks-operator.adoc @@ -11,7 +11,7 @@ You can install the {product-short} Operator on {eks-short} using the https://ol * You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster]. * You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl]. -* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have subscribed to `registry.redhat.io`. For more information, see link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. * You have installed the Operator Lifecycle Manager (OLM). For more information about installation and troubleshooting, see https://olm.operatorframework.io/docs/getting-started/[OLM QuickStart] or https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?] .Procedure @@ -121,4 +121,4 @@ kubectl -n rhdh-operator patch deployment \ --type=merge ---- ==== --- \ No newline at end of file +-- diff --git a/modules/installation/proc-rhdh-deploy-gke-helm.adoc b/modules/installation/proc-rhdh-deploy-gke-helm.adoc index 55f56d4207..d8cdb7bd3f 100644 --- a/modules/installation/proc-rhdh-deploy-gke-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-gke-helm.adoc @@ -4,7 +4,7 @@ When you install the {product-short} Helm chart in {gke-brand-name} ({gke-short}), it orchestrates the deployment of a {product-short} instance, which provides a robust developer platform within the {gke-short} ecosystem. .Prerequisites -* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have subscribed to `registry.redhat.io`. For more information, see link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. * You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl]. * You have installed the Google Cloud CLI. For more information, see https://cloud.google.com/sdk/docs/install[Install the gcloud CLI]. * You have logged in to your Google account and created a https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster[GKE Autopilot] or https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster[GKE Standard] cluster. @@ -12,13 +12,13 @@ When you install the {product-short} Helm chart in {gke-brand-name} ({gke-short} * You have configured a domain name for your {product-short} instance. * You have reserved a static external Premium IPv4 Global IP address that is not attached to any VM. For more information see https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserve a new static external IP address] -* You have configured the DNS records for your domain name to point to the IP address that has been reserved. +* You have configured the DNS records for your domain name to point to the IP address that has been reserved. + [NOTE] ==== You need to create an `A` record with the value equal to the IP address. This process can take up to one hour to propagate. ==== -* You have installed Helm 3 or the latest. For more information, see https://helm.sh/docs/intro/install[Installing Helm]. +* You have installed Helm 3 or the latest. For more information, see https://helm.sh/docs/intro/install/[Installing Helm]. .Procedure . Go to your terminal and run the following command to add the Helm chart repository containing the {product-short} chart to your local Helm registry: @@ -66,7 +66,7 @@ spec: -- For more information about setting up a Google-managed certificate, see https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs?hl=en#setting_up_a_google-managed_certificate[Setting up a Google-managed certificate]. -. Create a `FrontendConfig` object to set a policy for redirecting to HTTPS. You must attach this policy to the ingress. +. Create a `FrontendConfig` object to set a policy for redirecting to HTTPS. You must attach this policy to the ingress. + -- .Example of attaching a `FrontendConfig` object to the ingress @@ -137,7 +137,7 @@ For the latest Helm Chart version, see this https://github.com/openshift-helm-ch + [source,terminal,subs="attributes+"] ---- -kubectl get deploy -developer-hub -n +kubectl get deploy -developer-hub -n ---- * Verify that the service and ingress were created. @@ -151,7 +151,7 @@ kubectl get ingress -n [NOTE] Wait for the `ManagedCertificate` to be provisioned. This process can take a couple of hours. -* Access {product-very-short} with `https://` +* Access {product-very-short} with `pass:c,a,q[{my-product-url}]`. * To upgrade your deployment, use the following command: + @@ -165,4 +165,4 @@ helm -n upgrade -f values.yaml openshift-hel [source,terminal,subs="attributes+"] ---- helm -n delete ----- \ No newline at end of file +---- diff --git a/modules/installation/proc-rhdh-deploy-gke-operator.adoc b/modules/installation/proc-rhdh-deploy-gke-operator.adoc index 3500187076..61d517ba90 100644 --- a/modules/installation/proc-rhdh-deploy-gke-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-gke-operator.adoc @@ -6,7 +6,7 @@ You can install the {product-short} Operator on {gke-short} using the https://ol For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation. .Prerequisites -* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have subscribed to `registry.redhat.io`. For more information, see link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. * You have installed the Operator Lifecycle Manager (OLM). For more information about installation and troubleshooting, see https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?] @@ -136,4 +136,4 @@ kubectl -n rhdh-operator patch deployment \ --type=merge ---- ==== --- \ No newline at end of file +-- diff --git a/modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc b/modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc index de0ff31dcf..b2043bb5e9 100644 --- a/modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc +++ b/modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc @@ -5,7 +5,7 @@ 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 {configuring-book-link}[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]. @@ -25,7 +25,7 @@ Authorization callback URL:: Enter your {product-short} authentication backend URL: `pass:c,a,q[{my-product-url}/api/auth/github/handler/frame]`. Webhook:: -Clear "Active", as this is not needed for authentication and catalog providers. +Clear "Active", as this is not needed for authentication and catalog providers. App permissions:: Select permissions to define the level of access for the app. @@ -94,7 +94,7 @@ Select `Only on this account`. * **Client secret** * **Private key** -. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]. +. To add your GitHub credentials to {product-short}, add the following key/value pairs to {configuring-dynamic-plugins-book-link}#provisioning-your-custom-configuration[your {product-short} secrets]. You can use these secrets in the {product-short} configuration files by using their respective environment variable name. `GITHUB_INTEGRATION_APP_ID`:: @@ -117,7 +117,7 @@ It provides an automated alternative to manually registering components via `cat When a repository contains a `catalog-info.yaml` file, the entity is ingested into the catalog as a component. + .`dynamic-plugins.yaml` file fragment -[code,yaml] +[source,yaml] ---- plugins: - package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github' diff --git a/modules/observe/adoption-insights/proc-customize-adoption-insights.adoc b/modules/observe/adoption-insights/proc-customize-adoption-insights.adoc index 62a9baeb43..f625f0e0e7 100644 --- a/modules/observe/adoption-insights/proc-customize-adoption-insights.adoc +++ b/modules/observe/adoption-insights/proc-customize-adoption-insights.adoc @@ -47,5 +47,6 @@ app: p, role:default/__, adoption-insights.events.read, read, allow g, user:default/__, role:default/__ ---- -See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in {product}]. ++ +See {authorization-book-link}#ref-rbac-permission-policies_title-authorization[Permission policies in {product}]. diff --git a/modules/observe/con-audit-log-config.adoc b/modules/observe/con-audit-log-config.adoc index 2cc11ea2d3..71a9d61e30 100644 --- a/modules/observe/con-audit-log-config.adoc +++ b/modules/observe/con-audit-log-config.adoc @@ -6,10 +6,10 @@ Use the {ocp-short} web console to configure the following {ocp-short} logging components to use audit logging for {product-short}: Logging deployment:: -Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-memory[{ocp-brand-name} - Configuring your Logging deployment]. +Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see link:{ocp-docs-link}/html-single/logging/index#cluster-logging-memory[{ocp-brand-name} - Configuring your Logging deployment]. Logging collector:: -Configure the `spec.collection` stanza in the `ClusterLogging` custom resource (CR) to use a supported modification to the log collector and collect logs from `STDOUT`. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-collector[{ocp-brand-name} - Configuring the logging collector]. +Configure the `spec.collection` stanza in the `ClusterLogging` custom resource (CR) to use a supported modification to the log collector and collect logs from `STDOUT`. For more information, see link:{ocp-docs-link}/html-single/logging/index#cluster-logging-collector[{ocp-brand-name} - Configuring the logging collector]. Log forwarding:: -Send logs to specific endpoints inside and outside your {ocp-short} cluster by specifying a combination of outputs and pipelines in a `ClusterLogForwarder` CR. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-json-log-forwarding_cluster-logging-enabling-json-logging[{ocp-brand-name} - Enabling JSON log forwarding] and link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#configuring-log-forwarding[{ocp-brand-name} - Configuring log forwarding]. +Send logs to specific endpoints inside and outside your {ocp-short} cluster by specifying a combination of outputs and pipelines in a `ClusterLogForwarder` CR. For more information, see {ocp-docs-link}/html-single/logging/index#cluster-logging-json-log-forwarding_cluster-logging-enabling-json-logging[{ocp-brand-name} - Enabling JSON log forwarding] and {ocp-docs-link}/html-single/logging/index#configuring-log-forwarding[{ocp-brand-name} - Configuring log forwarding]. diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc index bd5b2a71d1..b6705c6edc 100644 --- a/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc +++ b/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc @@ -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 {ocp-docs-link}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[monitoring for user-defined projects] enabled. * You have installed {product} on {ocp-short} using the Helm chart. .Procedure @@ -41,4 +41,4 @@ 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. \ No newline at end of file +. Click the *Metrics* tab to view metrics for {product} pods. diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc index 921ed4d11b..a59067fefd 100644 --- a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc +++ b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc @@ -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 {ocp-docs-link}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[monitoring for user-defined projects] enabled. * You have installed {product} on {ocp-short} using the {product} Operator. * You have installed the {openshift-cli}. @@ -52,7 +52,7 @@ spec: [NOTE] ==== `spec.selector.matchLabels` configuration must match the labels of your {product-very-short} installation. -==== +==== . Apply the `ServiceMonitor` CR by running the following command: + diff --git a/modules/observe/proc-enabling-azure-monitor-metrics.adoc b/modules/observe/proc-enabling-azure-monitor-metrics.adoc index 19185396f3..94a21296b9 100644 --- a/modules/observe/proc-enabling-azure-monitor-metrics.adoc +++ b/modules/observe/proc-enabling-azure-monitor-metrics.adoc @@ -8,8 +8,8 @@ To enable managed Prometheus monitoring, use the `-enable-azure-monitor-metrics` az aks create/update --resource-group --name --enable-azure-monitor-metrics ---- -The previous command installs the metrics add-on, which gathers https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/prometheus-metrics-overview[Prometheus metrics]. Using the previous command, you can enable monitoring of Azure resources through both native Azure Monitor metrics. You can also view the results in the portal under *Monitoring -> Insights*. For more information, see https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/monitor-azure-resource[Monitor Azure resources with Azure Monitor]. +The previous command installs the metrics add-on, which gathers https://learn.microsoft.com/en-us/azure/azure-monitor/metrics/prometheus-metrics-overview[Prometheus metrics]. Using the previous command, you can enable monitoring of Azure resources through both native Azure Monitor metrics. You can also view the results in the portal under *Monitoring -> Insights*. For more information, see https://learn.microsoft.com/en-us/azure/azure-monitor/platform/monitor-azure-resource[Monitor Azure resources with Azure Monitor]. -Furthermore, metrics from both the Managed Prometheus service and Azure Monitor can be accessed through Azure Managed Grafana service. For more information, see https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/azure-monitor-workspace-manage?tabs=azure-portal#link-a-grafana-workspace[Link a Grafana workspace] section. +Furthermore, metrics from both the Managed Prometheus service and Azure Monitor can be accessed through Azure Managed Grafana service. For more information, see https://learn.microsoft.com/en-us/azure/azure-monitor/metrics/azure-monitor-workspace-manage?tabs=azure-portal#link-a-grafana-workspace[Link a Grafana workspace] section. -By default, Prometheus uses the minimum ingesting profile, which optimizes ingestion volume and sets default configurations for scrape frequency, targets, and metrics collected. The default settings can be customized through custom configuration. Azure offers various methods, including using different ConfigMaps, to provide scrape configuration and other metric add-on settings. For more information about default configuration, see https://learn.microsoft.com/en-us/azure/azure-monitor/containers/prometheus-metrics-scrape-default[Default Prometheus metrics configuration in Azure Monitor] and https://learn.microsoft.com/en-us/azure/azure-monitor/containers/prometheus-metrics-scrape-configuration?tabs=CRDConfig%2CCRDScrapeConfig[Customize scraping of Prometheus metrics in Azure Monitor managed service for Prometheus] documentation. \ No newline at end of file +By default, Prometheus uses the minimum ingesting profile, which optimizes ingestion volume and sets default configurations for scrape frequency, targets, and metrics collected. The default settings can be customized through custom configuration. Azure offers various methods, including using different ConfigMaps, to provide scrape configuration and other metric add-on settings. For more information about default configuration, see https://learn.microsoft.com/en-us/azure/azure-monitor/containers/prometheus-metrics-scrape-default[Default Prometheus metrics configuration in Azure Monitor] and https://learn.microsoft.com/en-us/azure/azure-monitor/containers/prometheus-metrics-scrape-configuration?tabs=CRDConfig%2CCRDScrapeConfig[Customize scraping of Prometheus metrics in Azure Monitor managed service for Prometheus] documentation. diff --git a/modules/observe/proc-forward-audit-log-splunk.adoc b/modules/observe/proc-forward-audit-log-splunk.adoc index f3ebe394d4..530e2691fd 100644 --- a/modules/observe/proc-forward-audit-log-splunk.adoc +++ b/modules/observe/proc-forward-audit-log-splunk.adoc @@ -11,7 +11,7 @@ You can use the {logging-brand-name} ({logging-short}) Operator and a `ClusterLo .Procedure -. Log in to your {ocp-short} cluster. +. Log in to your {ocp-short} cluster. . Install the {logging-short} Operator in the `openshift-logging` namespace and switch to the namespace: + -- @@ -65,7 +65,7 @@ metadata: namespace: openshift-logging ---- -For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#logging-create-clf_configuring-log-forwarding[Creating a log forwarder]. +For more information, see {ocp-docs-link}/html-single/logging/index#logging-create-clf_configuring-log-forwarding[Creating a log forwarder]. -- . Define the following `ClusterLogForwarder` configuration using OpenShift web console or OpenShift CLI: .. Specify the `log-collector` as `serviceAccount` in the YAML file: @@ -94,7 +94,7 @@ inputs: maxRecordsPerSecond: 100 ---- -For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-collector-log-forward-logs-from-application-pods_configuring-log-forwarding[Forwarding application logs from specific pods]. +For more information, see {ocp-docs-link}/html-single/logging/index#cluster-logging-collector-log-forward-logs-from-application-pods_configuring-log-forwarding[Forwarding application logs from specific pods]. -- .. Configure outputs to specify where the captured logs are sent. In this step, focus on the `splunk` type. You can either use `tls.insecureSkipVerify` option if the Splunk endpoint uses self-signed TLS certificates (not recommended) or provide the certificate chain using a Secret. + @@ -111,12 +111,12 @@ outputs: key: hecToken secretName: splunk-secret index: main - url: 'https://my-splunk-instance-url' + url: 'https://my-splunk-instance-link' rateLimit: maxRecordsPerSecond: 250 ---- -For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#logging-forward-splunk_configuring-log-forwarding[Forwarding logs to Splunk] in {ocp-short} documentation. +For more information, see {ocp-docs-link}/html-single/logging/index#logging-forward-splunk_configuring-log-forwarding[Forwarding logs to Splunk] in {ocp-short} documentation. -- .. Optional: Filter logs to include only audit logs: + @@ -132,7 +132,7 @@ filters: - field: .message notMatches: isAuditEvent ---- -For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#logging-content-filtering[Filtering logs by content] in {ocp-short} documentation. +For more information, see {ocp-docs-link}/html-single/logging/index#logging-content-filtering[Filtering logs by content] in {ocp-short} documentation. -- .. Configure pipelines to route logs from specific inputs to designated outputs. Use the names of the defined inputs and outputs to specify multiple `inputRefs` and `outputRefs` in each pipeline: + @@ -193,7 +193,7 @@ tuning: maxRetryDuration: 10s ---- -<1> `AtLeastOnce` delivery mode means that if the log forwarder crashes or is restarted, any logs that were read before the crash but not sent to their destination are re-sent. It is possible that some logs are duplicated after a crash. +<1> `AtLeastOnce` delivery mode means that if the log forwarder crashes or is restarted, any logs that were read before the crash but not sent to their destination are re-sent. It is possible that some logs are duplicated after a crash. -- .Verification diff --git a/modules/observe/proc-view-logs-aks.adoc b/modules/observe/proc-view-logs-aks.adoc index e3b2c0186f..6d01fcef33 100644 --- a/modules/observe/proc-view-logs-aks.adoc +++ b/modules/observe/proc-view-logs-aks.adoc @@ -7,7 +7,7 @@ You can access live data logs generated by Kubernetes objects and collect log da * You have deployed {product-short} on {aks-short}. -For more information, see xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[{installing-on-aks-book-title}]. +For more information, see xref:{installing-on-aks-book-link}#assembly-install-rhdh-aks[{installing-on-aks-book-title}]. .Procedure diff --git a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc index 459358b591..99c89e0281 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc @@ -76,11 +76,11 @@ orchestrator: + [NOTE] ==== -This step only configures the Orchestrators use of an external database. To configure {product} to use an external PostgreSQL instance, follow the steps in link:{configuring-book-url}#proc-configuring-postgresql-instance-using-helm_configuring-external-postgresql-databases[Configuring a PostgreSQL instance using Helm]. +This step only configures the Orchestrators use of an external database. To configure {product} to use an external PostgreSQL instance, follow the steps in {configuring-book-link}#proc-configuring-postgresql-instance-using-helm_configuring-external-postgresql-databases[Configuring a PostgreSQL instance using Helm]. ==== .Verification . Verify that the Orchestrator plugin is visible in the {product} UI. -. Create and run sample workflows to confirm the orchestration is functioning correctly. \ No newline at end of file +. Create and run sample workflows to confirm the orchestration is functioning correctly. diff --git a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc index dca09f8d0c..27a9314b08 100644 --- a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc @@ -6,8 +6,8 @@ Use manual installation when you want full control of the setup process and comp .Procedure -. Install the OpenShift Serverless components manually by following the instructions in the link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36[Red Hat OpenShift Serverless] documentation. +. Install the OpenShift Serverless components. If you wish to manually install the OpenShift Serverless components, follow the instructions in the {rhoserverless-link}[{rhoserverless-brand-name}] documentation. -. You must also configure workflow persistence to prevent workflow context from being lost when the Pod restarts. You can do this configuration at the namespace level using the `SonataFlowPlatform` or `SonataFlow` custom resources (CR). For detailed instructions on configuring persistence using the `SonataFlowPlatform` or `SonataFlow` custom resources, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36/html-single/serverless_logic/index#serverless-logic-managing-persistence[Managing workflow persistence]. +. You must also configure workflow persistence to prevent workflow context from being lost when the Pod restarts. You can do this configuration at the namespace level using the `SonataFlowPlatform` or `SonataFlow` custom resources (CR). For detailed instructions on configuring persistence using the `SonataFlowPlatform` or `SonataFlow` custom resources, see {rhoserverless-link}/html-single/serverless_logic/index#serverless-logic-managing-persistence[Managing workflow persistence]. -. (Optional) If required, deploy a custom PostgreSQL database. \ No newline at end of file +. (Optional) If required, deploy a custom PostgreSQL database. diff --git a/modules/proc-create-plugin.adoc b/modules/proc-create-plugin.adoc index 13fe06d366..3cd587ae2a 100644 --- a/modules/proc-create-plugin.adoc +++ b/modules/proc-create-plugin.adoc @@ -6,7 +6,7 @@ You can create a plugin for the {product-short} application. .Prerequisites -* {product} application is installed and running. For more information, see link:{configuring-book-url}[{configuring-book-title}]). +* {product} application is installed and running. For more information, see {configuring-book-link}[{configuring-book-title}]). * `yarn` command and associated dependencies are installed. .Procedure diff --git a/modules/release-notes/ref-release-notes-deprecated-functionalities.adoc b/modules/release-notes/ref-release-notes-deprecated-functionalities.adoc index 484ac9529a..28eb1c633c 100644 --- a/modules/release-notes/ref-release-notes-deprecated-functionalities.adoc +++ b/modules/release-notes/ref-release-notes-deprecated-functionalities.adoc @@ -5,8 +5,8 @@ This section lists deprecated functionalities in {product} {product-version}. [id="deprecated-functionality-rhidp-6917"] -== Backstage CR versions `v1alpha1` and `v1alpha2` - +== Backstage CR versions `v1alpha1` and `v1alpha2` + Backstage CR versions `v1alpha1` and `v1alpha2` are deprecated in 1.7 and will be removed in 1.9 @@ -14,18 +14,13 @@ Backstage CR versions `v1alpha1` and `v1alpha2` are deprecated in 1.7 and will b * link:https://issues.redhat.com/browse/RHIDP-6917[RHIDP-6917] [id="deprecated-functionality-rhidp-8525"] -== Deprecation of Bundled Plugin Wrappers - -To enhance performance, decrease image size, and reduce maintenance, the method of including "wrapped" dynamic plugins within the main {product} container image is being deprecated as of release 1.7.0. We are transitioning to a model where all dynamic plugins will be distributed as independent OCI artifacts. - -For the 1.7.0 release, this is a deprecation notice only; there are no breaking changes, and all previously bundled plugins will continue to be bundled. However, we encourage customers to prepare for the removal of wrappers in a future release by beginning to use the new OCI artifacts in 1.8.0. Documentation will be updated to guide this migration. - -For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-load-plugin-oci-image_assembly-install-third-party-plugins-rhdh[Loading a plugin packaged as an OCI image]. +== Deprecation of Bundled Plugin Wrappers + +To enhance performance, decrease image size, and reduce maintenance, the method of including "wrapped" dynamic plugins within the main {product} container image is being deprecated as of release 1.7.0. We are transitioning to a model where all dynamic plugins will be distributed as independent OCI artifacts. +For the 1.7.0 release, this is a deprecation notice only; there are no breaking changes, and all previously bundled plugins will continue to be bundled. However, we encourage customers to prepare for the removal of wrappers in a future release by beginning to use the new OCI artifacts in 1.8.0. Documentation will be updated to guide this migration. +For more information, see {installing-and-viewing-plugins-book-link}#proc-load-plugin-oci-image_assembly-install-third-party-plugins-rhdh[Loading a plugin packaged as an OCI image]. .Additional resources * link:https://issues.redhat.com/browse/RHIDP-8525[RHIDP-8525] - - - diff --git a/modules/release-notes/ref-release-notes-developer-preview.adoc b/modules/release-notes/ref-release-notes-developer-preview.adoc index 775cadde0c..2b09b1e488 100644 --- a/modules/release-notes/ref-release-notes-developer-preview.adoc +++ b/modules/release-notes/ref-release-notes-developer-preview.adoc @@ -16,4 +16,4 @@ For more information about the support scope of Red Hat Developer Preview featur == {ls-brand-name} {ls-brand-name} is available as a Developer Preview feature in {product}, as a virtual assistant powered by generative Artificial Intelligence (AI) designed for {product-very-short}. The assistant offers in-depth insights into {product-very-short}, including its wide range of capabilities. You can interact with this assistant to explore and learn more about {product-very-short} in greater detail. -For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html-single/interacting_with_red_hat_developer_lightspeed_for_red_hat_developer_hub/index[{ls-brand-name}]. \ No newline at end of file +For more information, see {product-docs-link}/html-single/interacting_with_red_hat_developer_lightspeed_for_red_hat_developer_hub/index[{ls-brand-name}]. diff --git a/modules/release-notes/ref-release-notes-new-features-extra.adoc b/modules/release-notes/ref-release-notes-new-features-extra.adoc index 07b5b267fd..fdd6c3a6d5 100644 --- a/modules/release-notes/ref-release-notes-new-features-extra.adoc +++ b/modules/release-notes/ref-release-notes-new-features-extra.adoc @@ -7,4 +7,4 @@ In this release, the following Home page cards are added: * *OnboardingSection* * *TemplateSection* -For more information, see link:{customizing-book-url}#customizing-the-home-page-cards_customizing-the-home-page[Customizing the Home page cards]. \ No newline at end of file +For more information, see {customizing-book-link}#customizing-the-home-page-cards_customizing-the-home-page[Customizing the Home page cards]. diff --git a/modules/release-notes/ref-release-notes-new-features.adoc b/modules/release-notes/ref-release-notes-new-features.adoc index f0e470523a..36850ac418 100644 --- a/modules/release-notes/ref-release-notes-new-features.adoc +++ b/modules/release-notes/ref-release-notes-new-features.adoc @@ -18,8 +18,7 @@ For more information, see link:https://github.com/redhat-developer/rhdh-operator [id="feature-rhidp-6633"] == Added Orchestrator plugins with dependencies to {product-very-short} profile. - -With this update, Orchestrator plugins with dependencies are added to the {product-very-short} profile. The Orchestrator plugin is disabled by default. When you enable the Orchestrator plugin, it will deploy dependencies and work out of the box on {product-very-short}. +With this update, Orchestrator plugins with dependencies are added to the {product-very-short} profile. The Orchestrator plugin is disabled by default. When you enable the Orchestrator plugin, it will deploy dependencies and work out of the box on {product-very-short}. [id="enhancement-rhidp-6657"] == Updated {product-very-short} theme @@ -43,7 +42,7 @@ These changes aim to create a more intuitive and seamless role management workfl In this release, {product-short} administrators can configure dynamic plugins directly within the Extensions UI. Administrators can now enable, disable, install, or edit the configuration of dynamic plugins on the Extensions Details Page. -This is an opt-in feature that must be enabled by configuration, and it is intended for testing and development environments only; it is not recommended for production use. +This is an opt-in feature that must be enabled by configuration, and it is intended for testing and development environments only; it is not recommended for production use. This release requires a single replica deployment and uses a persistent volume claim (PVC) for the dynamic plugin configuration file. The {product-short} backend does not automatically restart when you save configuration changes. You must restart the {product-short} application for any dynamic plugin configuration updates to take effect. @@ -74,23 +73,22 @@ With this update, the look and feel of {product-short} has been updated to bette {product-very-short} has been enhanced to provide crucial traceability, allowing users to easily identify the template version used to create a specific component. This enhancement helps determine if an older entity needs updating or if a bug is linked to a particular template version. -Scaffolder templates can now be versioned using the backstage.io/template-version annotation and the `catalog:template:version` action. When used with the `catalog:template:version` action, the the annotation of the template is applied to the generated catalog entity. +Scaffolder templates can now be versioned using the backstage.io/template-version annotation and the `catalog:template:version` action. When used with the `catalog:template:version` action, the annotation of the template is applied to the generated catalog entity. [id="feature-rhidp-7561"] == Support for high availability in {eks-brand-name} {product} now supports high availability setups in {eks-brand-name} ({eks-short}). This enhancement allows the deployment to scale beyond a single replica, ensuring the application remains operational and accessible even in the event of failures or disruptions. -For more information, see link:{configuring-book-url}#HighAvailability[_Configuring high availability in Red Hat Developer Hub_]. +For more information, see {configuring-book-link}#HighAvailability[_Configuring high availability in Red Hat Developer Hub_]. [id="feature-rhidp-7610"] == Adoption Insights in {product} -In this release, the Adoption Insights plugin is fully supported and enabled by default. The Adoption Insights plugin provides key metrics and trends to help you understand {product-short} usage. +In this release, the Adoption Insights plugin is fully supported and enabled by default. The Adoption Insights plugin provides key metrics and trends to help you understand {product-short} usage. If you have an existing Adoption Insights plugin custom configuration with GitHub Container registry images already set up, you can upgrade to the latest version to omit configurations using GitHub Container registry images. - -For more information, see link:{adoption-insights-url}#proc-configure-adoption-insights_title-adoption-insights[Configuring the {adoption-insights-title}]. +For more information, see {adoption-insights-link}#proc-configure-adoption-insights_title-adoption-insights[Configuring the {adoption-insights-title}]. [id="feature-rhidp-7663"] == {product-short} community plugins updated to Backstage 1.39 diff --git a/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc b/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc index 5cc6428f09..eeecfd0cf9 100644 --- a/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc +++ b/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc @@ -9,7 +9,7 @@ .Prerequisites * You have installed and configured the {product} instance. -* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. +* You have the required permissions. See {authorization-book-link}[{authorization-book-title}]. .Procedure @@ -17,4 +17,4 @@ You can add components to your {product-very-short} instance using the following * Register components manually using the GUI or by using your `{my-app-config-file}` with the required permissions. * Create new components by using Software Templates. -* Use the bulk import plugin with the required permissions. For more information, see link:{configuring-dynamic-plugins-book-url}#bulk-importing-github-repositories[Bulk importing GitHub repositories]. \ No newline at end of file +* Use the bulk import plugin with the required permissions. For more information, see {configuring-dynamic-plugins-book-link}#bulk-importing-github-repositories[Bulk importing GitHub repositories]. diff --git a/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc b/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc index 877659f570..7941ac6428 100644 --- a/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc +++ b/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc @@ -11,9 +11,9 @@ You can create new components in the Software Catalog in your {product-very-shor .Prerequisites * You have installed and configured the {product} instance. -* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. +* You have the required permissions. See {authorization-book-link}[{authorization-book-title}]. .Procedure . In your {product} navigation menu, click *Catalog*. -. On the *Catalog* page, click *Self-service*. \ No newline at end of file +. On the *Catalog* page, click *Self-service*. diff --git a/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc b/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc index ae6f964fdf..6fefaee939 100644 --- a/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc +++ b/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc @@ -11,7 +11,7 @@ To manually register components in your {product-very-short} instance, create a .Prerequisites * You have installed and configured the {product} instance. -* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. +* You have the required permissions. See {authorization-book-link}[{authorization-book-title}]. .Procedure @@ -43,4 +43,4 @@ spec: .Verification -* Your software component is listed in the Software Catalog. You can view its details and ensure all the metadata is accurate. \ No newline at end of file +* Your software component is listed in the Software Catalog. You can view its details and ensure all the metadata is accurate. diff --git a/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc b/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc index 4840c1fd3a..5f6a24f65c 100644 --- a/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc +++ b/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc @@ -11,7 +11,7 @@ You can update components in the Software Catalog in your {product} instance. .Prerequisites * You have installed and configured the {product} instance. -* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. +* You have the required permissions. See {authorization-book-link}[{authorization-book-title}]. .Procedure @@ -32,4 +32,4 @@ This action redirects you to the YAML file on GitHub. [NOTE] ==== After you merge your changes, the updated metadata in the Software Catalog appears after some time. -==== \ No newline at end of file +==== diff --git a/modules/techdocs/proc-techdocs-addon-create.adoc b/modules/techdocs/proc-techdocs-addon-create.adoc index 0c452e9932..8795ccb0d0 100644 --- a/modules/techdocs/proc-techdocs-addon-create.adoc +++ b/modules/techdocs/proc-techdocs-addon-create.adoc @@ -142,7 +142,7 @@ where __ (Optional) :: Specifies the `props` for your new TechDocs add-on, as specified in your `__.tsx` file, if applicable. . In the `plugins.ts` file, import your new TechDocs add-on component. -. Install and configure your new TechDocs add-on by following the steps in link:{techdocs-book-url}#techdocs-addon-installing[Installing and configuring a TechDocs add-on] +. Install and configure your new TechDocs add-on by following the steps in {techdocs-book-link}#techdocs-addon-installing[Installing and configuring a TechDocs add-on] .Verification . Restart the RHDH application and verify that the plugin is successfully activated and configured. diff --git a/modules/techdocs/proc-techdocs-addon-install-helm.adoc b/modules/techdocs/proc-techdocs-addon-install-helm.adoc index 68ccbb27c3..2787f9b31a 100644 --- a/modules/techdocs/proc-techdocs-addon-install-helm.adoc +++ b/modules/techdocs/proc-techdocs-addon-install-helm.adoc @@ -14,7 +14,7 @@ Preinstalled add-ons, such as `ReportIssue`, are included in the default `backst * The TechDocs plugin is installed and enabled. .Procedure -. In your Helm chart, add the `global.dynamic` parameters required to install a dynamic plugin, as shown in link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_and_viewing_plugins_in_red_hat_developer_hub/rhdh-installing-rhdh-plugins_title-plugins-rhdh-about#con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[Installing dynamic plugins using the Helm chart ] +. In your Helm chart, add the `global.dynamic` parameters required to install a dynamic plugin, as shown in {installing-and-viewing-plugins-book-link}#con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[Installing dynamic plugins using the Helm chart ] + [NOTE] ==== @@ -58,4 +58,3 @@ where: __:: Specifies the external TechDocs add-on that you want to install, for example, `TextSize` or `LightBox`. -//.Next steps \ No newline at end of file diff --git a/modules/upgrade/proc-upgrade-rhdh-operator.adoc b/modules/upgrade/proc-upgrade-rhdh-operator.adoc index f2d43a2272..cb7fbabd0c 100644 --- a/modules/upgrade/proc-upgrade-rhdh-operator.adoc +++ b/modules/upgrade/proc-upgrade-rhdh-operator.adoc @@ -14,7 +14,7 @@ If you use the Operator to deploy your {product} instance, then an administrator * You are logged in as an administrator on the {ocp-short} web console. * You have installed the {product} Operator. -* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]. +* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the {ocp-docs-link}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]. .Procedure @@ -37,5 +37,5 @@ If there is no upgrade available, the *Upgrade status* field value is *Up to dat [role="_additional-resources"] .Additional resources -* link:{installing-on-ocp-book-url}#proc-install-operator_assembly-install-rhdh-ocp-operator[{installing-on-ocp-book-title} with the Operator]. -* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console] +* {installing-on-ocp-book-link}#proc-install-operator_assembly-install-rhdh-ocp-operator[{installing-on-ocp-book-title} with the Operator] +* {ocp-docs-link}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console] diff --git a/modules/using-kubernetes-custom-actions/proc-using-kubernetes-custom-actions-plugin.adoc b/modules/using-kubernetes-custom-actions/proc-using-kubernetes-custom-actions-plugin.adoc index 716386d75c..31f4bdf693 100644 --- a/modules/using-kubernetes-custom-actions/proc-using-kubernetes-custom-actions-plugin.adoc +++ b/modules/using-kubernetes-custom-actions/proc-using-kubernetes-custom-actions-plugin.adoc @@ -26,4 +26,4 @@ input: [role="_additional-resources"] .Additional resource -* link:{customizing-book-url#configuring-templates}[Configuring templates]. \ No newline at end of file +* {customizing-book-link}#configuring-templates}[Configuring templates] diff --git a/modules/using-kubernetes-custom-actions/ref-supported-kubernetes-custom-actions.adoc b/modules/using-kubernetes-custom-actions/ref-supported-kubernetes-custom-actions.adoc index 2faba2e798..b37e012abe 100644 --- a/modules/using-kubernetes-custom-actions/ref-supported-kubernetes-custom-actions.adoc +++ b/modules/using-kubernetes-custom-actions/ref-supported-kubernetes-custom-actions.adoc @@ -32,7 +32,7 @@ Creates a namespace for the Kubernetes cluster in the {product-short}. |`string` |Required only if `clusterRef` is not defined. You cannot specify both `url` and `clusterRef`. |API url of the Kubernetes cluster -|`https://api.foo.redhat.com:6443` +|`pass:[https://api.example.com:6443]` |`token` |`String` @@ -57,4 +57,4 @@ Creates a namespace for the Kubernetes cluster in the {product-short}. |Optional |Labels applied to the namespace |app.io/type=ns; app.io/managed-by=org; -|=== \ No newline at end of file +|=== diff --git a/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc b/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc index b1cb404d61..12dbe875f3 100644 --- a/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc +++ b/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc @@ -6,7 +6,6 @@ In {product}, the ServiceNow custom actions are provided as a pre-loaded plugin, .Prerequisites * {product} is installed and running. -For more information about installing the {product-short}, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. * You have created a project in the {product-short}. .Procedure diff --git a/titles/about/master.adoc b/titles/about/master.adoc index c117e03875..1f767b87d2 100644 --- a/titles/about/master.adoc +++ b/titles/about/master.adoc @@ -9,9 +9,9 @@ include::assemblies/assembly-about-rhdh.adoc[] [role="_next-steps"] .Next steps -* link:{installing-on-eks-book-url}[{installing-on-eks-book-title}] -* link:{installing-on-osd-on-gcp-book-url}[{installing-on-osd-on-gcp-book-title}] -* link:{installing-on-gke-book-url}[{installing-on-gke-book-title}] -* link:{installing-on-aks-book-url}[{installing-on-aks-book-title}] -* link:{installing-on-ocp-book-url}[{installing-on-ocp-book-title}] +* {installing-on-eks-book-link}[{installing-on-eks-book-title}] +* {installing-on-osd-on-gcp-book-link}[{installing-on-osd-on-gcp-book-title}] +* {installing-on-gke-book-link}[{installing-on-gke-book-title}] +* {installing-on-aks-book-link}[{installing-on-aks-book-title}] +* {installing-on-ocp-book-link}[{installing-on-ocp-book-title}] diff --git a/titles/install-rhdh-ocp/master.adoc b/titles/install-rhdh-ocp/master.adoc index 3dfbad9ea0..6d5059b726 100644 --- a/titles/install-rhdh-ocp/master.adoc +++ b/titles/install-rhdh-ocp/master.adoc @@ -29,16 +29,16 @@ The {product} Helm chart:: [IMPORTANT] ==== -You must set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `https://rhdh.example.com`). +You must set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance (for example, `pass:[https://rhdh.example.com]`). This value is required for the {product} to function correctly. If it is not set, frontend and backend services cannot communicate properly, and features may not work as expected. ==== Use the installation method that best meets your needs and preferences. .Additional resources -* For more information about choosing an installation method, see link:https://www.redhat.com/en/technologies/cloud-computing/openshift/helm[Helm Charts vs. Operators] -* For more information about the Operator method, see link:https://docs.openshift.com/container-platform/4.15/operators/understanding/olm-what-operators-are.html[Understanding Operators]. -* For more information about the Helm chart method, see link:https://docs.openshift.com/container-platform/4.15/applications/working_with_helm_charts/understanding-helm.html[Understanding Helm]. +* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/helm[Choosing an installation method: Helm Charts vs. Operators] +* {ocp-docs-link}/html-single/operators/index[Working with Operators] +* {ocp-docs-link}/html-single/building_applications/index#working-with-helm-charts[Working with Helm charts] // Operator method include::assemblies/assembly-install-rhdh-ocp-operator.adoc[leveloffset=+1] diff --git a/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc b/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc index 8e52df9593..182d893f2a 100644 --- a/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc +++ b/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc @@ -7,7 +7,7 @@ include::artifacts/attributes.adoc[] :context: release-notes-rhdh :imagesdir: images -{product} ({product-short}) {product-version} is now generally available. {product-short} is a fully supported, enterprise-grade productized version of upstream Backstage v{product-backstage-version}. You can access and download the {product} application from the {company-name} https://access.redhat.com/downloads[Customer Portal] or from the https://catalog.redhat.com/search?gs&q=rhdh&searchType=containers[Ecosystem Catalog]. +{product} ({product-short}) {product-version} is now generally available. {product-short} is a fully supported, enterprise-grade productized version of upstream Backstage v{product-backstage-version}. You can access and download the {product} application from the {company-name} https://access.redhat.com/downloads[Customer Portal] or from the https://catalog.redhat.com/en/search?gs&q=rhdh&searchType=containers[Ecosystem Catalog]. include::modules/release-notes/ref-release-notes-new-features.adoc[leveloffset=+1] // Note: This additional file is necessary as the RN generation script does not recognize the RHDHPAI project.