diff --git a/.htmltest.yml b/.htmltest.yml index 8a73af5ee4..2d6030e2da 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -3,17 +3,21 @@ # Defines htmltest configuration # See: https://github.com/wjdp/htmltest # -DirectoryPath: titles-generated/main +DirectoryPath: titles-generated CheckDoctype: false -ExternalTimeout: 30 +ExternalTimeout: 60 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 + - "^./pr-.*/index.html$" + - "^index.html$" - https://developers.redhat.com - https://docs.github.com/ + - https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.9 - https://entra.microsoft.com + - https://npm.registry.redhat.com + - https://npmjs.com/package/ - https://openai.com/api/ - https://platform.openai.com/docs/overview diff --git a/.linkcheckerrc b/.linkcheckerrc index 2e915ad13c..09f76b7acb 100644 --- a/.linkcheckerrc +++ b/.linkcheckerrc @@ -5,9 +5,12 @@ checkextern=True ignore= brand.css - lang.css http://creativecommons.org/licenses/by-sa/3.0/ - https://access.redhat.com/downloads/content/480/ + https://access.redhat.com/downloads/ + https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.9 + https://npmjs.com/package/ + https://www.youtube.com/@redhat + lang.css [output] fileoutput=html,csv diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index 8647b308d7..7eb0d06030 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -41,6 +41,8 @@ :my-product-namespace: my-rhdh-project :my-product-secrets: my-rhdh-secrets :my-product-url: https://____ +:plugin-type-name-uppercase: Custom +:plugin-type-name: custom // Red Hat Platforms (in alphabetical order) :logging-brand-name: Red Hat OpenShift Logging @@ -60,6 +62,9 @@ :rhacs-very-short: ACS :rhads-brand-name: Red Hat Advanced Developer Suite - secure supply chain :rhads-very-short: RHADS - ssc +:rhcr: Red Hat Container Registry +:rhcr-long: {rhcr} (registry.redhat.io) +:rhec: Red Hat Ecosystem Catalog :rhbk-brand-name: Red Hat Build of Keycloak :rhbk: RHBK :rhdeveloper-name: Red Hat Developer @@ -91,6 +96,8 @@ :gcp-short: Google Cloud :gke-brand-name: Google Kubernetes Engine :gke-short: GKE +:openshift-ai-connector-name-short: OpenShift AI Connector for {product-very-short} +:openshift-ai-connector-name: OpenShift AI Connector for {product} // First mention of OpenShift CLI or `oc` in a module :openshift-cli: pass:quotes[OpenShift CLI (`oc`)] @@ -138,7 +145,7 @@ :installing-on-gke-book-title: Installing {product} on {gke-brand-name} :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-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud/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 @@ -147,11 +154,14 @@ :introduction-to-plugins-book-link: {product-docs-link}/html-single/introduction_to_plugins/index :introduction-to-plugins-book-title: Introduction to plugins :learning-path-data-json-link: link:https://raw.githubusercontent.com/redhat-developer/rhdh/release-{product-version}/packages/app/public/learning-paths/data.json +:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index +:model-context-protocol-title: Interacting with Model Context Protocol tools for {product} :monitoring-and-logging-book-link: {product-docs-link}/html-single/monitoring_and_logging/index :monitoring-and-logging-book-title: Monitoring and logging :observability-category-link: {product-docs-link}/#Observability :ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version} :odf-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/{ocp-version} +:openshift-ai-connector-for-rhdh-link: {product-docs-link}/html-single/accelerate_ai_development_with_openshift_ai_connector_for_red_hat_developer_hub/index :orchestrator-book-link: {product-docs-link}/html-single/orchestrator_in_red_hat_developer_hub/index :orchestrator-book-title: Orchestrator in {product} :osd-docs-link: link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-version} @@ -159,7 +169,10 @@ :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} +:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single :rhoserverless-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/{rhoserverless-version} +:scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index +:scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards :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 @@ -169,19 +182,3 @@ :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 -:plugin-type-name: custom -:plugin-type-name-uppercase: Custom - - -:scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index -:scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards - -:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index -:model-context-protocol-title: Interacting with Model Context Protocol tools for {product} - -:openshift-ai-connector-for-rhdh-link: {product-docs-link}/html-single/accelerate_ai_development_with_openshift_ai_connector_for_red_hat_developer_hub/index - -:openshift-ai-connector-name: OpenShift AI Connector for {product} -:openshift-ai-connector-name-short: OpenShift AI Connector for {product-very-short} - -:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single \ No newline at end of file diff --git a/artifacts/snip-rhdh-install-operator-next-steps.adoc b/artifacts/snip-rhdh-install-operator-next-steps.adoc index 95d34e048b..1a00742e65 100644 --- a/artifacts/snip-rhdh-install-operator-next-steps.adoc +++ b/artifacts/snip-rhdh-install-operator-next-steps.adoc @@ -2,8 +2,8 @@ .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}#proc-install-rhdh-ocp-operator_assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator] +** {installing-on-eks-book-link}#assembly-installing-rhdh-on-eks-by-using-the-operator[{installing-on-eks-book-title} with the Operator] +** {installing-on-aks-book-link}#assembly-installing-rhdh-on-aks-by-using-the-operator[{installing-on-aks-book-title} with the Operator] +** {installing-on-osd-on-gcp-book-link}#proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[{installing-on-osd-on-gcp-book-title} with the Operator] +** {installing-on-gke-book-link}#assembly-installing-rhdh-on-gke-by-using-the-operator[{installing-on-gke-book-title} with the Operator] diff --git a/assemblies/assembly-installing-rhdh-on-platform-by-using-the-operator.adoc b/assemblies/assembly-installing-rhdh-on-platform-by-using-the-operator.adoc index 140a69d7ac..778bfc24da 100644 --- a/assemblies/assembly-installing-rhdh-on-platform-by-using-the-operator.adoc +++ b/assemblies/assembly-installing-rhdh-on-platform-by-using-the-operator.adoc @@ -3,12 +3,12 @@ [id="assembly-installing-rhdh-on-{platform-id}-by-using-the-operator"] = Installing {product-short} on {platform-long} by using the Operator -To benefit from over-the-air updates and catalogs provided by Operator-based applications distributed with the Operator Lifecycle Manager (OLM) framework, consider installing {product} by using the {product} Operator distributed in the {company-name} Ecosystem. +To benefit from over-the-air updates and catalogs provided by Operator-based applications distributed with the Operator Lifecycle Manager (OLM) framework, consider installing {product} by using the {product} Operator distributed in the {rhcr}. On {platform}, the most notable differences over an OpenShift-based installation are: -* The OLM framework and the {company-name} Ecosystem are not built-in. -* The {company-name} Ecosystem pull-secret is not managed globally. +* The OLM framework and the {rhcr} are not built-in. +* The {rhcr} pull-secret is not managed globally. * To expose the application, Ingresses replace OpenShift Routes. For clarity, the content is broken down in sections highlighting these platform-specific additional steps. diff --git a/build/scripts/build-ccutil.sh b/build/scripts/build-ccutil.sh index ca7d941658..5a4b309f9b 100755 --- a/build/scripts/build-ccutil.sh +++ b/build/scripts/build-ccutil.sh @@ -70,3 +70,6 @@ else echo "
  • ${BRANCH}
  • " >> titles-generated/index.html fi fi + +# Test the links with htmltest +podman run --rm --tty --volume "$(pwd)":/test:Z docker.io/wjdp/htmltest:latest -c .htmltest.yml diff --git a/modules/authentication/snip-enabling-user-authentication-with-microsoft-azure-common-first-steps.adoc b/modules/authentication/snip-enabling-user-authentication-with-microsoft-azure-common-first-steps.adoc index bdbd41d9e2..abdad0572d 100644 --- a/modules/authentication/snip-enabling-user-authentication-with-microsoft-azure-common-first-steps.adoc +++ b/modules/authentication/snip-enabling-user-authentication-with-microsoft-azure-common-first-steps.adoc @@ -22,7 +22,7 @@ The server for retrieving organization data, including user and group data, to i .Procedure :my-product-app-name-in-azure: -. Register your {product-short} app in {azure-short}, link:https://learn.microsoft.com/en-us/entra/identity-platform/scenario-web-app-sign-user-app-registration?tabs=aspnetcore#register-an-app-by-using-the-azure-portal[by using the {azure-short} portal]. +. Register your {product-short} app in {azure-short}, link:https://learn.microsoft.com/en-us/entra/identity-platform/scenario-web-app-sign-user-app-configuration?tabs=aspnetcore#register-an-app-by-using-the-azure-portal[by using the {azure-short} portal]. .. Sign in to the link:https://entra.microsoft.com/[Microsoft Entra admin center]. diff --git a/modules/configuring-external-databases/con-default-base-urls.adoc b/modules/configuring-external-databases/con-default-base-urls.adoc index 36cdab7baf..209c80bad4 100644 --- a/modules/configuring-external-databases/con-default-base-urls.adoc +++ b/modules/configuring-external-databases/con-default-base-urls.adoc @@ -9,9 +9,9 @@ The Operator follows these rules to set the base URLs for your application: * If the cluster is not OpenShift, the Operator makes no changes. * If you explicitly set the `spec.application.route.enabled` field in your Custom Resource (CR) to `false`, no changes are made. -* If you define `spec.application.route.host` in the {product-custom-resource-type} CR, the base URLs are set to `https://`. -* If you specify the `spec.application.route.subdomain` in the {product-custom-resource-type} CR, the base URLs are set to `https://.`. -* If no custom host or subdomain is provided, the Operator sets the base URLs to `https://backstage-{cr_name}-.`, which is the default domain for the created _Route_ resource. +* If you define `spec.application.route.host` in the {product-custom-resource-type} CR, the base URLs are set to `pass:c,a,q[https://]`. +* If you specify the `spec.application.route.subdomain` in the {product-custom-resource-type} CR, the base URLs are set to `pass:c,a,q[https://.]`. +* If no custom host or subdomain is provided, the Operator sets the base URLs to `pass:c,a,q[https://backstage--.]`, which is the default domain for the created _Route_ resource. The Operator updates the following base URLs in the default `app-config` ConfigMap: diff --git a/modules/configuring/snip-provisioning-your-custom-configuration-appconfig-step-with-optional-steps-disabled.adoc b/modules/configuring/snip-provisioning-your-custom-configuration-appconfig-step-with-optional-steps-disabled.adoc index f37c087ba1..e6469e4a74 100644 --- a/modules/configuring/snip-provisioning-your-custom-configuration-appconfig-step-with-optional-steps-disabled.adoc +++ b/modules/configuring/snip-provisioning-your-custom-configuration-appconfig-step-with-optional-steps-disabled.adoc @@ -51,4 +51,4 @@ Enter your repository discovery configuration. `permissions`:: Enable Role-based access control. Enter your policy administrator name. -.. Additionally, link:{authentication-book-url}[provision users and enable authentication with your external identity provider]. +.. Additionally, {authentication-book-link}[provision users and enable authentication with your external identity provider]. diff --git a/modules/dynamic-plugins/proc-configuring-events-module-for-github.adoc b/modules/dynamic-plugins/proc-configuring-events-module-for-github.adoc index e31d8b9777..385455afbe 100644 --- a/modules/dynamic-plugins/proc-configuring-events-module-for-github.adoc +++ b/modules/dynamic-plugins/proc-configuring-events-module-for-github.adoc @@ -54,7 +54,7 @@ Secure your workflow by adding a webhook secret token to link:https://docs.githu ** *For Github Discovery Events*: push, repository ** *For Github Organizational Data Events*: organization, team and membership ** *Content Type*: application/json -** *Payload URL*: https:///api/events/http/github +** *Payload URL*: pass:c,a,q[`{my-product-url}/api/events/http/github`] + [NOTE] ==== diff --git a/modules/dynamic-plugins/ref-keycloak-plugin-metrics.adoc b/modules/dynamic-plugins/ref-keycloak-plugin-metrics.adoc index 51ba7463b3..5815a7c114 100644 --- a/modules/dynamic-plugins/ref-keycloak-plugin-metrics.adoc +++ b/modules/dynamic-plugins/ref-keycloak-plugin-metrics.adoc @@ -50,4 +50,4 @@ You can export metrics using any OpenTelemetry-compatible backend, such as *Prom .Additional resources * link:https://opentelemetry.io/[OpenTelemetry] -* link:https://backstage.io/docs/tutorials/setup-opentelemetry[Backstage OpenTelemetry setup guide] +* link:https://backstage.io/docs/tutorials/setup-opentelemetry/[Backstage OpenTelemetry setup guide] diff --git a/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc b/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc index b7fdf1c048..bbec45aa19 100644 --- a/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc +++ b/modules/installation/proc-install-rhdh-helm-airgapped-full.adoc @@ -13,7 +13,7 @@ If your network has access to the registry through a bastion host, you can use t ** You have installed the {openshift-cli} on your workstation. ** You have installed the {ocp-docs-link}/html-single/disconnected_environments/index#installation-oc-mirror-installing-plugin_about-installing-oc-mirror-v2[`oc-mirror`] tool, with a version corresponding to the version of your {ocp-short} cluster. * You have set up your intermediary host. -** Your host has access to the link:https://registry.redhat.io[{company-name} Ecosystem Catalog]. +** Your host has access to the {rhcr-long}. ** Your host has access to image registry on the destination host. See {ocp-docs-link}/html-single/registry/index#securing-exposing-registry[Exposing the registry]. * You have set up your destination host. diff --git a/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc b/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc index ba8c2fb17e..2299e293a5 100644 --- a/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc +++ b/modules/installation/proc-install-rhdh-operator-airgapped-full.adoc @@ -14,7 +14,7 @@ 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:link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have an active `oc registry`, `podman`, or `skopeo` session to the {rhcr-long}. For more information, see link:https://access.redhat.com/articles/RegistryAuthentication[{rhcr} 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]. * Recommended on {ocp-short}: You have installed the {ocp-docs-link}/html-single/disconnected_environments/index#installation-oc-mirror-installing-plugin_about-installing-oc-mirror-v2[`oc-mirror`] tool, with a version corresponding to the version of your {ocp-short} cluster. * Make sure that your system meets the minimum sizing requirements. See {about-book-link}#rhdh-sizing_about-rhdh[Sizing requirements for {product}]. diff --git a/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc b/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc index 49474a7b9f..fced755e51 100644 --- a/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc +++ b/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc @@ -26,7 +26,7 @@ For more information, see link:https://podman.io/docs/installation[Podman Instal * 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. +* You have an active `oc registry`, `podman`, or `Skopeo` session to the {rhcr-long}. 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]. diff --git a/modules/installation/proc-provisioning-your-pull-secret-to-your-rhdh-instance-namespace.adoc b/modules/installation/proc-provisioning-your-pull-secret-to-your-rhdh-instance-namespace.adoc index 3f27dafb2d..1029fe3f47 100644 --- a/modules/installation/proc-provisioning-your-pull-secret-to-your-rhdh-instance-namespace.adoc +++ b/modules/installation/proc-provisioning-your-pull-secret-to-your-rhdh-instance-namespace.adoc @@ -1,19 +1,19 @@ :_mod-docs-content-type: PROCEDURE -[id="provision-your-red-hat-ecosystem-pull-secret-to-your-rhrh-instance-namespace"] -= Provision your {company-name} Ecosystem pull secret to your {product} instance namespace +[id="provision-your-red-hat-container-registry-pull-secret-to-your-rhrh-instance-namespace"] += Provision your {rhcr} pull secret to your {product} instance namespace -On {platform-long}, the {company-name} Ecosystem pull-secret is not managed globally. +On {platform-long}, the {rhcr} pull-secret is not managed globally. Therefore add your pull-secret in your {product} instance namespace. .Prerequisites -* Your credentials to the link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry]: +* Your credentials to the link:https://access.redhat.com/articles/RegistryAuthentication[{rhcr}]: ** __ ** __ ** __ * You created the `{my-rhdh-project}` namespace on {platform} to host your {product-short} instance. .Procedure -. Create a pull secret using your {company-name} credentials to pull the container images from the protected {company-name} Ecosystem: +. Create a pull secret using your {company-name} credentials to pull the container images from the protected {rhcr-long}: + [source,terminal,subs="+attributes"] ---- @@ -24,7 +24,7 @@ $ kubectl -n {my-rhdh-namespace} create secret docker-registry my-rhdh-pull-secr --docker-email= ---- -. To enable pulling {product-short} images from the {company-name} Ecosystem Catalog, add the image pull secret in the default service account within the namespace where the {product-short} instance is being deployed: +. To enable pulling {product-short} images from the {rhcr}, add the image pull secret in the default service account within the namespace where the {product-short} instance is being deployed: + [source,terminal,subs="+attributes"] ---- diff --git a/modules/installation/proc-rhdh-deploy-aks-helm.adoc b/modules/installation/proc-rhdh-deploy-aks-helm.adoc index 137ed300d4..1011620ae0 100644 --- a/modules/installation/proc-rhdh-deploy-aks-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-helm.adoc @@ -118,7 +118,7 @@ kubectl create namespace ${NAMESPACE} kubectl config set-context --current --namespace=${NAMESPACE} ---- -. Create a pull secret, which is used to pull the {product-short} images from the {company-name} Ecosystem, by running the following command: +. Create a pull secret, which is used to pull the {product-short} images from the {rhcr}, by running the following command: + [source,terminal] ---- diff --git a/modules/installation/proc-rhdh-deploy-eks-helm.adoc b/modules/installation/proc-rhdh-deploy-eks-helm.adoc index 89afc6fffd..396ae80c57 100644 --- a/modules/installation/proc-rhdh-deploy-eks-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-eks-helm.adoc @@ -10,7 +10,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 link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have subscribed to {rhcr-long}. 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}]. @@ -42,7 +42,7 @@ kubectl create secret docker-registry rhdh-pull-secret \ <2> Enter your password in the command. <3> Enter your email address in the command. -The created pull secret is used to pull the {product-short} images from the {company-name} Ecosystem. +The created pull secret is used to pull the {product-short} images from the {rhcr}. -- . Create a file named `values.yaml` using the following template: diff --git a/modules/installation/proc-rhdh-deploy-gke-helm.adoc b/modules/installation/proc-rhdh-deploy-gke-helm.adoc index a428d38785..ab3919f95a 100644 --- a/modules/installation/proc-rhdh-deploy-gke-helm.adoc +++ b/modules/installation/proc-rhdh-deploy-gke-helm.adoc @@ -6,7 +6,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 link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. +* You have subscribed to the {rhcr-long}. 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. @@ -47,7 +47,7 @@ kubectl -n create secret docker-registry rhdh-pull-secret \ <1> <3> Enter your password in the command. <4> Enter your email address in the command. -The created pull secret is used to pull the {product-short} images from the {company-name} Ecosystem. +The created pull secret is used to pull the {product-short} images from the {rhcr}. -- . Set up a Google-managed certificate by creating a `ManagedCertificate` object that you must attach to the ingress. diff --git a/modules/installation/snip-installing-the-operator-common-prerequisites.adoc b/modules/installation/snip-installing-the-operator-common-prerequisites.adoc index 82c381a517..d6409dbf2c 100644 --- a/modules/installation/snip-installing-the-operator-common-prerequisites.adoc +++ b/modules/installation/snip-installing-the-operator-common-prerequisites.adoc @@ -1,16 +1,16 @@ [id="proc-installing-the-operator-on-{platform-id}-by-using-olm_{context}"] = Installing the {product-short} Operator on {platform-long} by using the OLM framework -The {company-name} Ecosystem, based on the Operator Lifecycle Manager (OLM) framework, +The {rhcr-long}, based on the Operator Lifecycle Manager (OLM) framework, contains a distribution of the {product} Operator, aimed at managing your {product} instance lifecycle. However, on {platform-long}: -* The Operator Lifecycle Manager (OLM) framework and the {company-name} Ecosystem are not built-in. -* The {company-name} Ecosystem pull-secret is not managed globally. +* The Operator Lifecycle Manager (OLM) framework and the {rhcr} are not built-in. +* The {rhcr} pull-secret is not managed globally. -Therefore, install the OLM framework, the {company-name} Ecosystem, -and provision your {company-name} Ecosystem pull secret to install {product-short} Operator. +Therefore, install the OLM framework, the {rhcr}, +and provision your {rhcr} pull secret to install {product-short} Operator. .Prerequisites * You have link:https://kubernetes.io/docs/tasks/tools/#kubectl[installed the `kubectl` CLI on your local environment]. diff --git a/modules/installation/snip-installing-the-operator-common-steps.adoc b/modules/installation/snip-installing-the-operator-common-steps.adoc index f6b279232e..b7372d34c0 100644 --- a/modules/installation/snip-installing-the-operator-common-steps.adoc +++ b/modules/installation/snip-installing-the-operator-common-steps.adoc @@ -5,7 +5,7 @@ $ kubectl create namespace rhdh-operator ---- -. Create a pull secret using your {company-name} credentials to pull the container images from the protected {company-name} Ecosystem: +. Create a pull secret using your {company-name} credentials to pull the container images from the protected {rhcr-long}: + [source,terminal] ---- @@ -16,7 +16,7 @@ $ kubectl -n rhdh-operator create secret docker-registry rhdh-pull-secret \ --docker-email= ---- -. Create a catalog source that contains the {company-name} Ecosystem Operators: +. Create a catalog source that contains the {company-name} operators: + [source,terminal,subs="attributes+"] ---- diff --git a/modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc b/modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc index c90f71d291..a92be08697 100644 --- a/modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc +++ b/modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc @@ -7,17 +7,17 @@ You must configure an MCP client before it can interact with the MCP server. For .Prerequisites -* You have configured one of the following endpoints as the server URL, where `<{product-very-short}_HOST>` is the hostname of your {product-very-short} instance. +* You have configured one of the following endpoints as the server URL, where `pass:c,a,q[{my-product-domain}]` is the hostname of your {product-very-short} instance. -** Streamable: https://<{product-very-short}_HOST>/api/mcp-actions/v1 -** SSE (Legacy): https://<{product-very-short}_HOST>/api/mcp-actions/v1/sse +** Streamable: pass:c,a,q[`{my-product-url}/api/mcp-actions/v1`] +** SSE (Legacy): pass:c,a,q[`{my-product-url}/api/mcp-actions/v1/sse`] + [NOTE] ==== -Some clients do not yet support the Streamable endpoint, and you might need to use the SSE endpoint instead. +Some clients do not yet support the Streamable endpoint, and you might need to use the SSE endpoint instead. ==== -* You have set the ${MCP_TOKEN} in your MCP server configuration as the bearer token when authenticating with the MCP server. +* You have set the `${MCP_TOKEN}` environment variable in your MCP server configuration as the bearer token when authenticating with the MCP server. .Procedure @@ -25,12 +25,12 @@ Some clients do not yet support the Streamable endpoint, and you might need to u .. From your Desktop app, navigate to *Cursor Settings* and select *MCP Tools > New MCP Server*. .. Add the following configuration: + -[source,yaml] +[source,yaml,subs="+attributes,+quotes"] ---- { "mcpServers": { "backstage-actions": { - "url": "https:///api/mcp-actions/v1", + "url": "{my-product-url}/api/mcp-actions/v1", "headers": { "Authorization": "Bearer " } @@ -41,7 +41,7 @@ Some clients do not yet support the Streamable endpoint, and you might need to u where: ``:: Enter the previously configured static token -``:: Enter the hostname of your {product-very-short} instance +`pass:c,a,q[{my-product-domain}]`:: Enter the hostname of your {product-very-short} instance . Configure *Continue* as a client. @@ -52,7 +52,7 @@ where: mcpServers: - name: backstage-actions type: sse - url: https:///api/mcp-actions/v1/sse + url: {my-product-url}/api/mcp-actions/v1/sse requestOptions: headers: Authorization: "Bearer " @@ -61,7 +61,7 @@ mcpServers: where: ``:: Enter the previously configured static token -``:: Enter the hostname of your {product-very-short} instance +`pass:c,a,q[{my-product-domain}]`:: Enter the hostname of your {product-very-short} instance . Configure *{ls-short}* as a client. For more details, see {developer-lightspeed-link}[{ls-brand-name}]. .. In the `lightspeed-stack.yaml` configuration, add the following configuration for `mcp_servers`: @@ -71,7 +71,7 @@ where: mcp_servers: - name: mcp::backstage provider_id: model-context-protocol - url: https://<{product-very-short}_HOST>/api/mcp-actions/v1 + url: {my-product-url}/api/mcp-actions/v1 ---- where: @@ -109,4 +109,4 @@ curl -X POST \ where: -``:: Enter the LCS endpoint. You can use localhost(<{product-very-short}_servicename>.<{product-very-short}-namespace>.svc.cluster.local:8080) or the service name for this field if you are inside the {backstage} container. \ No newline at end of file +``:: Enter the LCS endpoint. You can use localhost(pass:c,a,q:[`<{product-very-short}_servicename>.{my-product-namespace}.svc.cluster.local:8080`]) or the service name for this field if you are inside the {backstage} container. diff --git a/modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc b/modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc index ceef4db04b..77e035d238 100644 --- a/modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc +++ b/modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc @@ -3,7 +3,7 @@ [id="proc-configuring-github-scorecards-in-rhdh-instance_{context}"] = Configuring GitHub Scorecards to view GitHub metrics in your {product} instance -To achieve enhanced visibility and control over your software components, you must configure the GitHub Scorecards plugin to integrate GitHub metrics directly into your {product-very-short} catalog. This allows engineering teams to centralize development data, quickly identify risks, and accelerate decision-making related to component health and security. +To achieve enhanced visibility and control over your software components, you must configure the GitHub Scorecards plugin to integrate GitHub metrics directly into your {product-very-short} catalog. This allows engineering teams to centralize development data, quickly identify risks, and accelerate decision-making related to component health and security. To enable the GitHub metrics integration, you must create and configure a GitHub App to grant {product-very-short} access to the GitHub API. @@ -27,7 +27,7 @@ To install and configure GitHub Scorecards in your {product-very-short} instance *** *Client ID* *** *Client Secret* *** *Private key* -.. To add your GitHub credentials to {product-very-short}, add the following key/value pairs to your {configuring-book-link}#provisioning-your-custom-configuration[your {product-very-short} secrets]. You can use these secrets in the {product-very-short} configuration files by using their respective environment variable names. +.. To add your GitHub credentials to {product-very-short}, add the following key/value pairs to {configuring-book-link}#provisioning-your-custom-configuration[your {product-very-short} secrets]. You can use these secrets in the {product-very-short} configuration files by using their respective environment variable names. + `GITHUB_INTEGRATION_APP_ID`:: Enter the saved *App ID*. `GITHUB_INTEGRATION_CLIENT_ID`:: Enter the saved *Client ID*. @@ -122,7 +122,5 @@ where: `scorecard:plugins:github:open_prs:thresholds`:: Lists the default threshold values for the GitHub open PRs metric. -[NOTE] -==== -To read more information about how to customize the threshold values, see link:https://documentation.example.com/scorecard-plugins-thresholds/[Thresholds in Scorecard plugins]. -==== \ No newline at end of file +.Additional resources +* {scorecard-plugin-book-link}#con-manage-metric-thresholds-in-scorecard-plugin_assembly-configuring-scorecards-in-rhdh[Managing metric thresholds in your Scorecard plugin]