diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index d9a09e02b6..3dab7bf6c0 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -1,5 +1,5 @@ :red-hat-developers-documentation: -:imagesdir: +:imagesdir: images :idseparator: - // Company names @@ -10,14 +10,22 @@ :product: Red Hat Developer Hub :product-short: Developer Hub :product-very-short: RHDH -:product-version: 1.5 -:product-bundle-version: 1.5.0 -:product-chart-version: 1.5.0 -:product-backstage-version: 1.31.3 +:product-version: 1.4 +:product-bundle-version: 1.4.0 +:product-chart-version: 1.4.0 +:product-backstage-version: 1.29.2 +:product-custom-resource-type: Backstage :rhdeveloper-name: Red Hat Developer :rhel: Red Hat Enterprise Linux :odf-name: OpenShift Data Foundation +:my-app-config-config-map: my-rhdh-app-config +:my-app-config-file: app-config.yaml +: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://____ // Red Hat Platforms @@ -72,10 +80,7 @@ :ug-product-title: Red Hat Developer Hub User Guide // Links -:LinkAdminGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index -:NameOfAdminGuide: Administration guide for {product} -:LinkGettingStartedGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/getting_started_with_red_hat_developer_hub/index :LinkPluginsGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_plugins_in_red_hat_developer_hub/index :NameOfPluginsGuide: Configuring plugins in {product} @@ -92,6 +97,12 @@ :authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index :authorization-book-title: Authorization +:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring/index +:configuring-book-title: Configuring + +:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing/index +:customizing-book-title: Customizing + :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-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name} @@ -113,5 +124,15 @@ :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} +:telemetry-data-collection-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/telemetry_data_collection/index +:telemetry-data-collection-book-title: Telemetry data collection + +:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_log/index +:audit-log-book-title: Audit log + +:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index +:monitoring-and-logging-book-title: Monitoring and logging + :plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index :plugins-configure-book-title: Configuring dynamic plugins + diff --git a/artifacts/docinfo.xml b/artifacts/docinfo.xml new file mode 100644 index 0000000000..35491c93fe --- /dev/null +++ b/artifacts/docinfo.xml @@ -0,0 +1,11 @@ +{title} +{product} +{product-version} +{subtitle} + +{abstract} + + +{company-name} Customer Content Services + + diff --git a/assemblies/assembly-add-custom-app-file-openshift.adoc b/assemblies/assembly-add-custom-app-file-openshift.adoc deleted file mode 100644 index 21978f413c..0000000000 --- a/assemblies/assembly-add-custom-app-file-openshift.adoc +++ /dev/null @@ -1,25 +0,0 @@ -[id='assembly-add-custom-app-file-openshift_{context}'] -= Adding a custom application configuration file to {ocp-brand-name} - -To access the {product}, you must add a custom application configuration file to {ocp-brand-name}. In {ocp-short}, you can use the following content as a base template to create a ConfigMap named `app-config-rhdh`: - -[source,yaml,subs="attributes+"] ----- -kind: ConfigMap -apiVersion: v1 -metadata: - name: app-config-rhdh -data: - app-config-rhdh.yaml: | - app: - title: {product} ----- - -You can add the custom application configuration file to {ocp-short} in one of the following ways: - -* The {product} Operator -* The {product} Helm chart - -include::modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc[leveloffset=+1] - -include::modules/installation/proc-add-custom-app-config-file-ocp-operator.adoc[leveloffset=+1] diff --git a/assemblies/assembly-running-rhdh-behind-a-proxy.adoc b/assemblies/assembly-configuring-a-proxy.adoc similarity index 53% rename from assemblies/assembly-running-rhdh-behind-a-proxy.adoc rename to assemblies/assembly-configuring-a-proxy.adoc index 7f7edd9d2e..88239f68ed 100644 --- a/assemblies/assembly-running-rhdh-behind-a-proxy.adoc +++ b/assemblies/assembly-configuring-a-proxy.adoc @@ -1,5 +1,9 @@ -[id="assembly-running-rhdh-behind-a-proxy"] -= Running the {product-very-short} application behind a corporate proxy +:_mod-docs-content-type: ASSEMBLY +:context: running-behind-a-proxy +[id="{context}"] += Running {product} behind a corporate proxy + +In a network restricted environment, configure {product} to use your proxy to access remote network resources. You can run the {product-very-short} application behind a corporate proxy by setting any of the following environment variables before starting the application: @@ -8,7 +12,8 @@ You can run the {product-very-short} application behind a corporate proxy by set Additionally, set the `NO_PROXY` environment variable to bypass the proxy for certain domains. The variable value is a comma-separated list of hostnames or IP addresses that can be accessed without the proxy, even if one is specified. -include::modules/admin/procedure-understanding-no-proxy.adoc[leveloffset=+1] +include::modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1] + + +include::modules/configuring-a-proxy/proc-configuring-proxy-in-helm-deployment.adoc[leveloffset=+1] -include::modules/admin/proc-configuring-proxy-in-helm-deployment.adoc[leveloffset=+1] -include::modules/admin/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1] diff --git a/assemblies/assembly-configuring-external-postgresql-databases.adoc b/assemblies/assembly-configuring-external-postgresql-databases.adoc index 031c46efc9..360e714886 100644 --- a/assemblies/assembly-configuring-external-postgresql-databases.adoc +++ b/assemblies/assembly-configuring-external-postgresql-databases.adoc @@ -1,4 +1,6 @@ -[id="assembly-configuring-external-postgresql-databases"] +:_mod-docs-content-type: ASSEMBLY +:context: configuring-external-postgresql-databases +[id="{context}"] = Configuring external PostgreSQL databases As an administrator, you can configure and use external PostgreSQL databases in {product}. You can use a PostgreSQL certificate file to configure an external PostgreSQL instance using the Operator or Helm Chart. @@ -11,9 +13,11 @@ By default, the {product} operator or Helm Chart creates a local PostgreSQL data ==== -include::modules/admin/proc-configuring-postgresql-instance-using-operator.adoc[leveloffset=+1] +include::modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc[leveloffset=+1] -include::modules/admin/proc-configuring-postgresql-instance-using-helm.adoc[leveloffset=+1] -include::modules/admin/proc-migrating-databases-to-an-external-server.adoc[leveloffset=+1] +include::modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc[leveloffset=+1] + + +include::modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc[leveloffset=+1] diff --git a/assemblies/assembly-techdocs-plugin.adoc b/assemblies/assembly-configuring-techdocs.adoc similarity index 62% rename from assemblies/assembly-techdocs-plugin.adoc rename to assemblies/assembly-configuring-techdocs.adoc index bf2122abdd..2242fb5151 100644 --- a/assemblies/assembly-techdocs-plugin.adoc +++ b/assemblies/assembly-configuring-techdocs.adoc @@ -1,8 +1,9 @@ :_mod-docs-content-type: ASSEMBLY -[id="assembly-techdocs-plugin_{context}"] -= Configuring the TechDocs plugin in {product} +:context: configuring-techdocs +[id="{context}"] += Configuring TechDocs -The {product} TechDocs plugin helps your organization create, find, and use documentation in a central location and in a standardized way. For example: +Configure the {product} TechDocs plugin to create, find, and use documentation in a central location and in a standardized way. For example: Docs-like-code approach:: Write your technical documentation in Markdown files that are stored inside your project repository along with your code. @@ -35,24 +36,32 @@ After you configure {odf-name} to store the files that TechDocs generates, you c * For more information, see link:{LinkPluginsGuide}[Configuring plugins in {product}]. -//Configuring storage -include::modules/getting-started/con-techdocs-configure-storage.adoc[leveloffset=+1] +include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1] -include::modules/getting-started/proc-techdocs-using-odf-storage.adoc[leveloffset=+2] -include::modules/getting-started/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2] +include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2] -include::modules/getting-started/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3] -include::modules/getting-started/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2] +include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2] -include::modules/getting-started/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3] -//Configuring CI/CD -include::modules/getting-started/con-techdocs-config-cicd.adoc[leveloffset=+1] +include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3] -include::modules/getting-started/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2] -include::modules/getting-started/proc-techdocs-generate-site.adoc[leveloffset=+2] +include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2] + + +include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3] + + +include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1] + + +include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2] + + +include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2] + + +include::modules/customizing-techdocs/proc-techdocs-publish-site.adoc[leveloffset=+2] -include::modules/getting-started/proc-techdocs-publish-site.adoc[leveloffset=+2] diff --git a/assemblies/assembly-admin-templates.adoc b/assemblies/assembly-configuring-templates.adoc similarity index 62% rename from assemblies/assembly-admin-templates.adoc rename to assemblies/assembly-configuring-templates.adoc index e200a047a5..29d502b62e 100644 --- a/assemblies/assembly-admin-templates.adoc +++ b/assemblies/assembly-configuring-templates.adoc @@ -1,16 +1,14 @@ :_mod-docs-content-type: ASSEMBLY -[id="assembly-admin-templates"] -= Managing templates -:context: assembly-admin-templates +:context: configuring-templates +[id="{context}"] += Configuring templates -toc::[] +Configure templates to create software components, and publish these components to different locations, such as the {product} software catalog, or Git repositories. A template is a form composed of different UI fields that is defined in a YAML file. Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally. -You can use templates to easily create {product} components, and then publish these components to different locations, such as the {product} software catalog, or repositories in GitHub or GitLab. - -include::modules/templates/proc-creating-templates.adoc[leveloffset=+1] -include::modules/templates/ref-creating-templates.adoc[leveloffset=+1] +include::modules/customizing-templates/proc-creating-templates.adoc[leveloffset=+1] +include::modules/customizing-templates/ref-creating-templates.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources @@ -18,7 +16,7 @@ include::modules/templates/ref-creating-templates.adoc[leveloffset=+1] * 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] -include::modules/templates/proc-adding-templates.adoc[leveloffset=+1] +include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources diff --git a/assemblies/assembly-customize-rhdh-theme.adoc b/assemblies/assembly-customize-rhdh-theme.adoc deleted file mode 100644 index 37c87a0669..0000000000 --- a/assemblies/assembly-customize-rhdh-theme.adoc +++ /dev/null @@ -1,42 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="assembly-customize-rhdh-theme"] -= Customizing the appearance of your {product} instance -:context: assembly-customize-rhdh-theme - -The following default theme configurations are available for {product}: - -The {product} theme:: Default theme configurations to make your developer portal look like a standard {product} instance. For more information, see xref:ref-customize-rhdh-default-rhdh_{context}[] - -The Backstage theme:: Default theme configurations to make your developer portal look like a standard Backstage instance. For more information, see xref:ref-customize-rhdh-default-backstage_{context}[] - -You can change or disable particular parameters in a default theme or create a fully customized theme by modifying the `app-config-rhdh.yaml` file. From the the `app-config-rhdh.yaml` file, you can customize common theme components, including the following: - -* Company name and logo -* Font color, size, and style of text in paragraphs, headings, headers, and buttons -* Header color, gradient, and shape -* Button color -* Navigation indicator color - -You can also customize some components from the {product-short} GUI, such as the theme mode (*Light Theme*, *Dark Theme*, or *Auto*). - -include::modules/customization/proc-customize-rhdh-theme-mode.adoc[leveloffset=+1] - -include::modules/customization/proc-customize-rhdh-branding-logo.adoc[leveloffset=+1] - -//include::modules/customization/proc-customize-rhdh-sidebar-logo.adoc[leveloffset=+1]//commented since the section has been merged with proc-customize-rhdh-branding-logo.adoc in PR #514 - -include::modules/customization/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1] - -include::modules/customization/proc-customize-rhdh-tab-tooltip.adoc[leveloffset=+1] - -include::modules/customization/proc-customize-rhdh-palette.adoc[leveloffset=+1] - -include::modules/customization/proc-customize-rhdh-page-theme.adoc[leveloffset=+1] - -include::modules/customization/proc-customize-rhdh-font.adoc[leveloffset=+1] - -include::modules/customization/ref-customize-rhdh-default-rhdh.adoc[leveloffset=+1] - -include::modules/customization/ref-customize-rhdh-default-backstage.adoc[leveloffset=+1] - -include::modules/customization/ref-customize-rhdh-custom-components.adoc[leveloffset=+1] diff --git a/assemblies/assembly-customizing-the-appearance.adoc b/assemblies/assembly-customizing-the-appearance.adoc new file mode 100644 index 0000000000..715082c8b6 --- /dev/null +++ b/assemblies/assembly-customizing-the-appearance.adoc @@ -0,0 +1,47 @@ +:_mod-docs-content-type: ASSEMBLY +:context: customizing-appearance +[id="{context}"] += Customizing {product} appearance + +The following default theme configurations are available for {product}: + +The {product} theme:: Default theme configurations to make your developer portal look like a standard {product} instance. For more information, see xref:ref-customize-rhdh-default-rhdh_{context}[] + +The Backstage theme:: Default theme configurations to make your developer portal look like a standard Backstage instance. For more information, see xref:ref-customize-rhdh-default-backstage_{context}[] + +You can change or disable particular parameters in a default theme or create a fully customized theme by modifying the `app-config-rhdh.yaml` file. From the `app-config-rhdh.yaml` file, you can customize common theme components, including the following: + +* Company name and logo +* Font color, size, and style of text in paragraphs, headings, headers, and buttons +* Header color, gradient, and shape +* Button color +* Navigation indicator color + +You can also customize some components from the {product-short} GUI, such as the theme mode (*Light Theme*, *Dark Theme*, or *Auto*). + +include::modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/proc-customize-rhdh-font.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc[leveloffset=+1] + diff --git a/assemblies/assembly-customizing-the-rhdh-homepage.adoc b/assemblies/assembly-customizing-the-homepage.adoc similarity index 54% rename from assemblies/assembly-customizing-the-rhdh-homepage.adoc rename to assemblies/assembly-customizing-the-homepage.adoc index 9c760feec2..643254a727 100644 --- a/assemblies/assembly-customizing-the-rhdh-homepage.adoc +++ b/assemblies/assembly-customizing-the-homepage.adoc @@ -1,5 +1,7 @@ -[id='proc-customize-rhdh-homepage_{context}'] -= Customizing the Home page in {product} +:_mod-docs-content-type: ASSEMBLY +:context: customizing-the-home-page +[id="{context}"] += Customizing the Home page When using the `app-config`, you can do the following: @@ -15,5 +17,8 @@ When using the `app-config`, you can do the following: ** Catalog starred entities ** Featured docs -include::modules/getting-started/proc-customizing-the-home-page-cards.adoc[leveloffset=+1] -include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1] \ No newline at end of file +include::modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc[leveloffset=+1] + + +include::modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1] + diff --git a/assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc b/assemblies/assembly-customizing-the-quick-access-card.adoc similarity index 52% rename from assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc rename to assemblies/assembly-customizing-the-quick-access-card.adoc index b94046361b..2e77d2fe2a 100644 --- a/assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc +++ b/assemblies/assembly-customizing-the-quick-access-card.adoc @@ -1,15 +1,15 @@ :_mod-docs-content-type: ASSEMBLY - -[id="customizing-the-quick-access-card-in-rhdh"] -= Customizing the Quick access card in {product} +:context: customizing-the-quick-access-card +[id="{context}"] += Customizing the Quick access card To access the Home page in {product}, the base URL must include the `/developer-hub` proxy. You can configure the Home page by passing the data into the `app-config.yaml` file as a proxy. You can provide data to the Home page from the following sources: * JSON files hosted on GitHub or GitLab. * A dedicated service that provides the Home page data in JSON format using an API. -include::modules/getting-started/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1] -include::modules/getting-started/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1] +include::modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1] +include::modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1] diff --git a/assemblies/assembly-provisioning-a-custom-configuration.adoc b/assemblies/assembly-provisioning-a-custom-configuration.adoc new file mode 100644 index 0000000000..f208828a45 --- /dev/null +++ b/assemblies/assembly-provisioning-a-custom-configuration.adoc @@ -0,0 +1,27 @@ +:_mod-docs-content-type: ASSEMBLY +:context: provisioning-and-using-your-custom-configuration +[id="{context}"] += Provisioning and using your custom {product} configuration + +To configure {product}, use these methods, which are widely used to configure a {ocp-brand-name} application: + +* Use config maps to mount files and directories. +* Use secrets to inject environment variables. + +Learn to apply these methods to {product-short}: + +. xref:provisioning-your-custom-configuration[Provision your custom config maps and secrets to {ocp-short}]. +. Use your selected deployment method to mount the config maps and inject the secrets: + +** xref:using-the-operator-to-run-rhdh-with-your-custom-configuration[Use the {product} operator to deploy {product-short}]. +** xref:using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[Use the {product} Helm chart to deploy {product-short}]. + + +include::modules/configuring/proc-provisioning-your-custom-configuration.adoc[leveloffset=+1] + + +include::modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc[leveloffset=+1] + + +include::modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc[leveloffset=+1] + diff --git a/assemblies/assembly-rhdh-integration-aks.adoc b/assemblies/assembly-rhdh-integration-aks.adoc index 8962a9d2b6..e69de29bb2 100644 --- a/assemblies/assembly-rhdh-integration-aks.adoc +++ b/assemblies/assembly-rhdh-integration-aks.adoc @@ -1,16 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="assembly-rhdh-integration-aks"] -= {product} integration with {aks-brand-name} ({aks-short}) -:context: assembly-rhdh-integration-aks - -toc::[] - - -You can integrate {product-short} with {aks-brand-name} ({aks-short}), which provides a significant advancement in development, offering a streamlined environment for building, deploying, and managing your applications. - -This integration requires the deployment of {product-short} on {aks-short} using one of the following methods: - -* The Helm chart -* The {product} Operator - -//include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 \ No newline at end of file diff --git a/assemblies/assembly-rhdh-integration-aws.adoc b/assemblies/assembly-rhdh-integration-aws.adoc deleted file mode 100644 index 4177ff7010..0000000000 --- a/assemblies/assembly-rhdh-integration-aws.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="assembly-rhdh-integration-aws"] -= {product} integration with {aws-brand-name} ({aws-short}) -:context: assembly-rhdh-integration-aws - -toc::[] - -You can integrate your {product} application with {aws-brand-name} ({aws-short}), which can help you streamline your workflows within the {aws-short} ecosystem. Integrating the {product-short} resources with {aws-short} provides access to a comprehensive suite of tools, services, and solutions. - -The integration with {aws-short} requires the deployment of {product-short} in {eks-name} (EKS) using one of the following methods: - -* The Helm chart -* The {product} Operator - -//include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1]// moving observe category related content to new titles: RHIDP-4814 - diff --git a/assemblies/assembly-rhdh-telemetry.adoc b/assemblies/assembly-rhdh-telemetry.adoc index f6093846fe..00ee46fdda 100644 --- a/assemblies/assembly-rhdh-telemetry.adoc +++ b/assemblies/assembly-rhdh-telemetry.adoc @@ -5,7 +5,7 @@ The telemetry data collection feature helps in collecting and analyzing the tele [IMPORTANT] ==== -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:{LinkAdminGuide}#disabling-telemetry-data-collection_admin-rhdh[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. 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. ==== {company-name} collects and analyzes the following data: @@ -38,4 +38,4 @@ include::modules/observe/ref-customizing-telemetry-segment.adoc[leveloffset=+1] include::modules/observe/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2] -include::modules/observe/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] \ No newline at end of file +include::modules/observe/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] diff --git a/modules/getting-started/con-servicenow-custom-actions.adoc b/assemblies/assembly-using-servicenow.adoc similarity index 73% rename from modules/getting-started/con-servicenow-custom-actions.adoc rename to assemblies/assembly-using-servicenow.adoc index 01a47b3693..be1c809ff5 100644 --- a/modules/getting-started/con-servicenow-custom-actions.adoc +++ b/assemblies/assembly-using-servicenow.adoc @@ -10,3 +10,8 @@ The custom actions in {product-short} enable you to facilitate and automate the * Create, update, or delete a record * Retrieve information about a single record or multiple records +include::modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc[leveloffset=+1] + + +include::modules/using-service-now/ref-supported-servicenow-custom-actions.adoc[leveloffset=+1] + diff --git a/assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc b/assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc index c151708b37..872f30d8d0 100644 --- a/assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc +++ b/assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc @@ -21,8 +21,10 @@ include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc[ include::../modules/dynamic-plugins/proc-topology-install.adoc[leveloffset=+2] include::../modules/dynamic-plugins/proc-topology-configure.adoc[leveloffset=+2] -// Dynamic plugins cache -include::../modules/dynamic-plugins/con-dynamic-plugins-cache.adoc[ leveloffset=+1] -// Redis cache -include::../modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc[leveloffset=+1] \ No newline at end of file +include::../assembly-bulk-importing-from-github.adoc[leveloffset=+1] + + +include::../assembly-using-servicenow.adoc[leveloffset=+1] + + diff --git a/assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc b/assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc index 47b7c26d9c..f9ccbbe69e 100644 --- a/assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc +++ b/assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc @@ -17,7 +17,7 @@ include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+3 ==== * For more information about configuring KeyCloak, see link:{plugins-configure-book-url}[{plugins-configure-book-title}]. -* For more information about configuring TechDocs, see link:{LinkAdminGuide}#assembly-techdocs-plugin_{context}[Configuring the TechDocs plugin in {product}]. +* For more information about configuring TechDocs, see link:{customizing-book-url}#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:{LinkPluginsGuide}#rhdh-compatible-plugins[Other installable plugins] in the _{NameOfPluginsGuide} guide_ 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 link:{LinkPluginsGuide}#rhdh-compatible-plugins[Other installable plugins] in the _{NameOfPluginsGuide} guide_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix]. ==== // Community plugins @@ -38,4 +38,4 @@ include::../modules/dynamic-plugins/ref-community-plugins.adoc[leveloffset=+4] // Red Hat compatible plugins [id="rhdh-compatible-plugins"] -include::../modules/dynamic-plugins/ref-rh-compatible-plugins.adoc[leveloffset=+1] \ No newline at end of file +include::../modules/dynamic-plugins/ref-rh-compatible-plugins.adoc[leveloffset=+1] 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 aa116e6546..180ed590f1 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,10 +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:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}#Install%20and%20Upgrade[Installed {product-short} by using the Helm Chart]. +* 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}]. .Procedure -* To enable the guest user in your {product-short} custom configuration, link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index#proc-add-custom-app-file-openshift-helm_admin-rhdh[configure your {product} Helm Chart] with following content: +* 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: + .{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 958e73542c..420c517afa 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 @@ -6,12 +6,12 @@ After an Operator-based installation, you can configure {product-short} to log i .Prerequisites * You link:[installed {product-short} by using the Operator]. -* You link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index#proc-add-custom-app-config-file-ocp-operator_admin-rhdh[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. .Procedure -* To enable the guest user in your {product-short} custom configuration, link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index#proc-add-custom-app-config-file-ocp-operator_admin-rhdh[edit your {product-short} application configuration] with following content: +* 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: + -.`app-config-rhdh.yaml` fragment +.`{my-app-config-file}` fragment [source,yaml] ---- auth: diff --git a/modules/authentication/proc-enabling-authentication-with-github.adoc b/modules/authentication/proc-enabling-authentication-with-github.adoc index df2911af57..540c579e2c 100644 --- a/modules/authentication/proc-enabling-authentication-with-github.adoc +++ b/modules/authentication/proc-enabling-authentication-with-github.adoc @@ -4,7 +4,7 @@ To authenticate users with GitHub, enable the GitHub authentication provider in {product}. .Prerequisites -* You have link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/administration_guide_for_red_hat_developer_hub/assembly-add-custom-app-file-openshift_admin-rhdh[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You link:{configuring-book-url}[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]. .Procedure @@ -51,7 +51,7 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri * **Private key** * **Webhook secret** -. To add your GitHub credentials to your {product-short} secrets, edit your {product-short} secrets, such as `secrets-rhdh`, and add the following key/value pairs: +. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{plugins-configure-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]: + `AUTH_GITHUB_APP_ID`:: Enter the saved **App ID**. `AUTH_GITHUB_CLIENT_ID`:: Enter the saved **Client ID**. diff --git a/modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc b/modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc index 517c38c40c..ab43795f59 100644 --- a/modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc +++ b/modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc @@ -5,7 +5,7 @@ .Prerequisites . You have the permission to register an application in Microsoft Azure. -. You link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index#assembly-add-custom-app-file-openshift_admin-rhdh[added a custom {product-short} application configuration]. +* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. .Procedure . To allow {product-short} to authenticate with Microsoft Azure, 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[create an OAuth application in Microsoft Azure]. @@ -44,7 +44,7 @@ To grant administrator consent, a directory administrator must go to the link:ht - **Application (client) ID** - **Application (client) secret** -. To add your Microsoft Azure credentials to {product-short}, add the following key/value pairs to your {product-short} secrets, such as `secrets-rhdh`: +. To add your Microsoft Azure credentials to {product-short}, add the following key/value pairs to link:{plugins-configure-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]: + `AUTH_AZURE_TENANT_ID`:: Enter your saved *Directory (tenant) ID*. `AUTH_AZURE_CLIENT_ID`:: Enter your saved *Application (client) ID*. diff --git a/modules/authentication/proc-enabling-authentication-with-rhbk.adoc b/modules/authentication/proc-enabling-authentication-with-rhbk.adoc index 6c104fe1ae..f73fe3453d 100644 --- a/modules/authentication/proc-enabling-authentication-with-rhbk.adoc +++ b/modules/authentication/proc-enabling-authentication-with-rhbk.adoc @@ -5,8 +5,8 @@ To authenticate users with {rhbk-brand-name} ({rhbk}), enable the OpenID Connect .Prerequisites -* You link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/administration_guide_for_red_hat_developer_hub/assembly-add-custom-app-file-openshift_admin-rhdh[added a custom {product-short} application configuration], and have sufficient permissions to modify it. -* You have sufficient permissions in {rhbk} to create and manage a realm. +* You link:{configuring-book-url}[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. .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/24.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/24.0/html/getting_started_guide/getting-started-zip-#getting-started-zip-secure-the-first-application[secure the first application]: @@ -30,16 +30,16 @@ Save the value for the next step: .. 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/24.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 add your {rhbk} credentials to your {product-short} secrets, edit your {product-short} secrets, such as `secrets-rhdh`, and add the following key/value pairs: +. To add your {rhsso} credentials to your {product-short}, add the following key/value pairs to link:{plugins-configure-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]: + `AUTH_OIDC_CLIENT_ID`:: Enter the saved **Client ID**. `AUTH_OIDC_CLIENT_SECRET`:: Enter the saved **Client Secret**. `AUTH_OIDC_METADATA_URL`:: Enter the saved **{rhbk} realm base URL**. -. To set up the {rhbk} authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content: +. To set up the {rhbk} authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `{my-app-config-file}` content: + -- -.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with {rhbk} +.`{my-app-config-file}` fragment with mandatory fields to enable authentication with {rhbk} [source,yaml] ---- auth: @@ -72,7 +72,7 @@ To enable authentication without requiring to provision users in the {product-sh + WARNING: Use this option to explore {product-short} features, but do not use it in production. + -.`app-config-rhdh.yaml` fragment with optional field to allow authenticating users absent from the software catalog +.`{my-app-config-file}` fragment with optional field to allow authenticating users absent from the software catalog [source,yaml] ---- auth: @@ -92,7 +92,7 @@ dangerouslyAllowSignInWithoutUserInCatalog: true -- {rhbk} callback URL. -.`app-config-rhdh.yaml` fragment with optional `callbackURL` field +.`{my-app-config-file}` fragment with optional `callbackURL` field [source,yaml] ---- auth: @@ -107,7 +107,7 @@ auth: -- Token endpoint authentication method. -.`app-config-rhdh.yaml` fragment with optional `tokenEndpointAuthMethod` field +.`{my-app-config-file}` fragment with optional `tokenEndpointAuthMethod` field [source,yaml] ---- auth: @@ -122,7 +122,7 @@ auth: -- Token signed response algorithm. -.`app-config-rhdh.yaml` fragment with optional `tokenSignedResponseAlg` field +.`{my-app-config-file}` fragment with optional `tokenSignedResponseAlg` field [source,yaml] ---- auth: @@ -137,7 +137,7 @@ auth: -- {rhbk} scope. -.`app-config-rhdh.yaml` fragment with optional `scope` field +.`{my-app-config-file}` fragment with optional `scope` field [source,yaml] ---- auth: @@ -153,7 +153,7 @@ auth: Declarative resolvers to override the default resolver: `emailLocalPartMatchingUserEntityName`. The authentication provider tries each sign-in resolver until it succeeds, and fails if none succeed. -.`app-config-rhdh.yaml` fragment with optional `callbackURL` field +.`{my-app-config-file}` fragment with optional `callbackURL` field [source,yaml] ---- auth: @@ -172,7 +172,7 @@ auth: -- To modify the {product-short} token expiration from its default value of one hour, note that this refers to the validity of short-term cryptographic tokens, not the session duration. The expiration value must be set between 10 minutes and 24 hours. -.`app-config-rhdh.yaml` fragment with optional `auth.backstageTokenExpiration` field +.`{my-app-config-file}` fragment with optional `auth.backstageTokenExpiration` field [source,yaml,subs="+quotes"] ---- auth: diff --git a/modules/authentication/proc-provisioning-users-from-github-to-the-software-catalog.adoc b/modules/authentication/proc-provisioning-users-from-github-to-the-software-catalog.adoc index b1d001b67e..3b2c456d49 100644 --- a/modules/authentication/proc-provisioning-users-from-github-to-the-software-catalog.adoc +++ b/modules/authentication/proc-provisioning-users-from-github-to-the-software-catalog.adoc @@ -11,11 +11,11 @@ Consider configuring {product-short} to provision users from GitHub to the softw .Procedure -* To enable GitHub member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content: +* To enable GitHub member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `{my-app-config-file}` content: + -- [id=githubProviderId] -.`app-config.yaml` fragment with mandatory `github` fields +.`{my-app-config-file}` fragment with mandatory `github` fields [source,yaml] ---- dangerouslyAllowSignInWithoutUserInCatalog: false diff --git a/modules/authentication/proc-provisioning-users-from-microsoft-azure-to-the-software-catalog.adoc b/modules/authentication/proc-provisioning-users-from-microsoft-azure-to-the-software-catalog.adoc index 501d6416a4..8c6bc31d87 100644 --- a/modules/authentication/proc-provisioning-users-from-microsoft-azure-to-the-software-catalog.adoc +++ b/modules/authentication/proc-provisioning-users-from-microsoft-azure-to-the-software-catalog.adoc @@ -7,11 +7,11 @@ To authenticate users with Microsoft Azure, after xref:enabling-authentication-w * You have xref:enabling-authentication-with-microsoft-azure[enabled authentication with Microsoft Azure]. .Procedure -* To enable Microsoft Azure member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following lines to the `app-config-rhdh.yaml` content: +* To enable Microsoft Azure member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following lines to the `{my-app-config-file}` content: + -- [id=microsoftGraphOrgProviderId] -.`app-config.yaml` fragment with mandatory `microsoftGraphOrg` fields +.`{my-app-config-file}` fragment with mandatory `microsoftGraphOrg` fields [source,yaml] ---- dangerouslyAllowSignInWithoutUserInCatalog: false @@ -43,7 +43,7 @@ Defines the authority used. Change the value to use a different link:https://learn.microsoft.com/en-us/graph/deployments#app-registration-and-token-service-root-endpoints[authority], such as Azure US government. Default value: `https://login.microsoftonline.com`. + -.`app-config.yaml` fragment with optional `queryMode` field +.`{my-app-config-file}` fragment with optional `queryMode` field [source,yaml] ---- catalog: @@ -57,7 +57,7 @@ catalog: Certain features require `advanced` querying capabilities. See link:https://docs.microsoft.com/en-us/graph/aad-advanced-queries[Microsoft Azure Advanced queries]. + -.`app-config.yaml` fragment with optional `queryMode` field +.`{my-app-config-file}` fragment with optional `queryMode` field [source,yaml] ---- catalog: @@ -74,7 +74,7 @@ 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]. This parameter can be combined with xref:userGroupMemberFilter[] or xref:userFilter[]. + -.`app-config.yaml` fragment with optional `user.expand` field +.`{my-app-config-file}` fragment with optional `user.expand` field [source,yaml] ---- catalog: @@ -91,7 +91,7 @@ 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]. This parameter and xref:userGroupMemberFilter[] are mutually exclusive, only one can be specified. + -.`app-config.yaml` fragment with optional `user.filter` field +.`{my-app-config-file}` fragment with optional `user.filter` field [source,yaml] ---- catalog: @@ -107,7 +107,7 @@ catalog: Load photos by default. Set to `false` to not load user photos. + -.`app-config.yaml` fragment with optional `user.loadPhotos` field +.`{my-app-config-file}` fragment with optional `user.loadPhotos` field [source,yaml] ---- catalog: @@ -122,7 +122,7 @@ catalog: `user.select`:: Define the link:https://docs.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource types] to retrieve. + -.`app-config.yaml` fragment with optional `user.select` field +.`{my-app-config-file}` fragment with optional `user.select` field [source,yaml] ---- catalog: @@ -139,7 +139,7 @@ To use group membership to get users. To filter groups and fetch their members. This parameter and xref:userFilter[] are mutually exclusive, only one can be specified. + -.`app-config.yaml` fragment with optional `userGroupMember.filter` field +.`{my-app-config-file}` fragment with optional `userGroupMember.filter` field [source,yaml] ---- catalog: @@ -156,7 +156,7 @@ To use group membership to get users. To search for groups and fetch their members. This parameter and xref:userFilter[] are mutually exclusive, only one can be specified. + -.`app-config.yaml` fragment with optional `userGroupMember.search` field +.`{my-app-config-file}` fragment with optional `userGroupMember.search` field [source,yaml] ---- catalog: @@ -174,7 +174,7 @@ Only one relationship can be expanded in a single request. See https://docs.microsoft.com/en-us/graph/query-parameters#expand-parameter This parameter can be combined with xref:userGroupMemberFilter[] instead of xref:userFilter[]. + -.`app-config.yaml` fragment with optional `group.expand` field +.`{my-app-config-file}` fragment with optional `group.expand` field [source,yaml] ---- catalog: @@ -190,7 +190,7 @@ catalog: 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]. + -.`app-config.yaml` fragment with optional `group.filter` field +.`{my-app-config-file}` fragment with optional `group.filter` field [source,yaml] ---- catalog: @@ -206,7 +206,7 @@ catalog: To search for groups. See link:https://docs.microsoft.com/en-us/graph/search-query-parameter[Microsoft Graph API query search parameter]. + -.`app-config.yaml` fragment with optional `group.search` field +.`{my-app-config-file}` fragment with optional `group.search` field [source,yaml] ---- catalog: @@ -221,7 +221,7 @@ catalog: `group.select`:: To define the link:https://docs.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource types] to retrieve. + -.`app-config.yaml` fragment with optional `group.select` field +.`{my-app-config-file}` fragment with optional `group.select` field [source,yaml] ---- catalog: @@ -236,7 +236,7 @@ catalog: To specify custom schedule frequency. Supports cron, ISO duration, and "human duration" as used in code. + -.`app-config.yaml` fragment with optional `schedule.frequency` field +.`{my-app-config-file}` fragment with optional `schedule.frequency` field [source,yaml] ---- catalog: @@ -251,7 +251,7 @@ catalog: To specify custom timeout. Supports ISO duration and "human duration" as used in code. + -.`app-config.yaml` fragment with optional `schedule.timeout` field +.`{my-app-config-file}` fragment with optional `schedule.timeout` field [source,yaml] ---- catalog: @@ -266,7 +266,7 @@ catalog: To specify custom initial delay. Supports ISO duration and "human duration" as used in code. + -.`app-config.yaml` fragment with optional `schedule.initialDelay` field +.`{my-app-config-file}` fragment with optional `schedule.initialDelay` field [source,yaml] ---- catalog: diff --git a/modules/authentication/proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc b/modules/authentication/proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc index 0dd9cab6c3..d5edff880b 100644 --- a/modules/authentication/proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc +++ b/modules/authentication/proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc @@ -6,11 +6,11 @@ .Procedure -* To enable {rhbk} member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content: +* To enable {rhbk} member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `{my-app-config-file}` content: + -- [id=keycloakOrgProviderId] -.`app-config.yaml` fragment with mandatory `keycloakOrg` fields +.`{my-app-config-file}` fragment with mandatory `keycloakOrg` fields [source,yaml] ---- dangerouslyAllowSignInWithoutUserInCatalog: false @@ -41,7 +41,7 @@ Optional: Consider adding the following optional fields: Realm to synchronize. Default value: `master`. + -.`app-config.yaml` fragment with optional `realm` field +.`{my-app-config-file}` fragment with optional `realm` field [source,yaml] ---- catalog: @@ -55,7 +55,7 @@ catalog: Realm used to authenticate. Default value: `master`. + -.`app-config.yaml` fragment with optional `loginRealm` field +.`{my-app-config-file}` fragment with optional `loginRealm` field [source,yaml] ---- catalog: @@ -69,7 +69,7 @@ catalog: User number to query simultaneously. Default value: `100`. + -.`app-config.yaml` fragment with optional `userQuerySize` field +.`{my-app-config-file}` fragment with optional `userQuerySize` field [source,yaml] ---- catalog: @@ -83,7 +83,7 @@ catalog: Group number to query simultaneously. Default value: `100`. + -.`app-config.yaml` fragment with optional `groupQuerySize` field +.`{my-app-config-file}` fragment with optional `groupQuerySize` field [source,yaml] ---- catalog: @@ -97,7 +97,7 @@ catalog: To specify custom schedule frequency. Supports cron, ISO duration, and "human duration" as used in code. + -.`app-config.yaml` fragment with optional `schedule.frequency` field +.`{my-app-config-file}` fragment with optional `schedule.frequency` field [source,yaml] ---- catalog: @@ -112,7 +112,7 @@ catalog: To specify custom timeout. Supports ISO duration and "human duration" as used in code. + -.`app-config.yaml` fragment with optional `schedule.timeout` field +.`{my-app-config-file}` fragment with optional `schedule.timeout` field [source,yaml] ---- catalog: @@ -127,7 +127,7 @@ catalog: To specify custom initial delay. Supports ISO duration and "human duration" as used in code. + -.`app-config.yaml` fragment with optional `schedule.initialDelay` field +.`{my-app-config-file}` fragment with optional `schedule.initialDelay` field [source,yaml] ---- catalog: diff --git a/modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc b/modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc index 0f5f9e96f1..00d34ed97c 100644 --- a/modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc +++ b/modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc @@ -91,7 +91,7 @@ configMap:: defaultMode::: `420` name::: `rbac-policies` -. Update your {product-short} `app-config.yaml` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files: +. Update your {product-short} `{my-app-config-file}` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files: + .`app-config.yml` fragment [source,yaml] 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 d4ad3db5d5..570beecbb3 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 @@ -80,7 +80,7 @@ $ oc create configmap rbac-policies \ .`Backstage` Custom resource fragment [source,yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha1 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage spec: application: diff --git a/modules/authorization/proc-determining-permission-policy-and-role-configuration-source.adoc b/modules/authorization/proc-determining-permission-policy-and-role-configuration-source.adoc index ec1e41b73e..c1bc10bf38 100644 --- a/modules/authorization/proc-determining-permission-policy-and-role-configuration-source.adoc +++ b/modules/authorization/proc-determining-permission-policy-and-role-configuration-source.adoc @@ -8,7 +8,7 @@ You can only use this source to change the resource. The available sources are: Configuration file:: -Configure roles and policies in the {product-short} `app-config.yaml` configuration file, for instance to xref:enabling-and-giving-access-to-rbac[declare your policy administrators]. +Configure roles and policies in the {product-short} `{my-app-config-file}` configuration file, for instance to xref:enabling-and-giving-access-to-rbac[declare your policy administrators]. + The Configuration file pertains to the default `role:default/rbac_admin` role provided by the RBAC plugin. The default role has limited permissions to create, read, update, delete permission policies or roles, and to read catalog entities. diff --git a/modules/authorization/proc-enabling-the-rbac-plugin.adoc b/modules/authorization/proc-enabling-the-rbac-plugin.adoc index fce9db1e76..3161090088 100644 --- a/modules/authorization/proc-enabling-the-rbac-plugin.adoc +++ b/modules/authorization/proc-enabling-the-rbac-plugin.adoc @@ -27,9 +27,9 @@ See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dy . 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 the `app-config-rhdh` ConfigMap, or permissions can be created using the REST API or Web UI. + -To declare users such as __ as policy administrators, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following code to the `app-config-rhdh.yaml` content: +To declare users such as __ as policy administrators, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following code to the `{my-app-config-file}` content: + -.`app-config.yaml` fragment +.`{my-app-config-file}` fragment [source,yaml,subs=+quotes] ---- permission: diff --git a/modules/admin/proc-configuring-proxy-in-helm-deployment.adoc b/modules/configuring-a-proxy/proc-configuring-proxy-in-helm-deployment.adoc similarity index 100% rename from modules/admin/proc-configuring-proxy-in-helm-deployment.adoc rename to modules/configuring-a-proxy/proc-configuring-proxy-in-helm-deployment.adoc diff --git a/modules/admin/proc-configuring-proxy-in-operator-deployment.adoc b/modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc similarity index 100% rename from modules/admin/proc-configuring-proxy-in-operator-deployment.adoc rename to modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc diff --git a/modules/admin/proc-rhdh-deployment-config.adoc b/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc similarity index 96% rename from modules/admin/proc-rhdh-deployment-config.adoc rename to modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc index 29a866bea7..0e637c2241 100644 --- a/modules/admin/proc-rhdh-deployment-config.adoc +++ b/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc @@ -1,8 +1,5 @@ -// Module included in: -// title-admin.adoc - -[id="proc-rhdh-deployment-config_{context}"] -= Configuring {product} deployment +[id="configuring-the-deployment"] += Configuring {product} deployment when using the operator The {product} operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its Custom Resource Definition (CRD). This CRD exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object. @@ -150,4 +147,4 @@ spec: [role="_additional-resources"] .Additional resources -* To learn more about merging, see link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#basic-patch-format[Strategic Merge Patch]. \ No newline at end of file +* To learn more about merging, see link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#basic-patch-format[Strategic Merge Patch]. diff --git a/modules/admin/proc-configuring-postgresql-instance-using-helm.adoc b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc similarity index 91% rename from modules/admin/proc-configuring-postgresql-instance-using-helm.adoc rename to modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc index f45bfec0ee..2f4c86d730 100644 --- a/modules/admin/proc-configuring-postgresql-instance-using-helm.adoc +++ b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc @@ -7,7 +7,7 @@ You can configure an external PostgreSQL instance by using the Helm Chart. By de * You are using a supported version of PostgreSQL. For more information, see the link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page]. * You have the following details: -** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address +** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address ** `db-port`: Denotes your PostgreSQL instance port number, such as `5432` ** `username`: Denotes the user name to connect to your PostgreSQL instance ** `password`: Denotes the password to connect to your PostgreSQL instance @@ -16,13 +16,13 @@ You can configure an external PostgreSQL instance by using the Helm Chart. By de [NOTE] ==== -By default, {product-short} uses a database for each plugin and automatically creates it if none is found. You might need the `Create Database` privilege in addition to `PSQL Database` privileges for configuring an external PostgreSQL instance. +By default, {product-short} uses a database for each plugin and automatically creates it if none is found. You might need the `Create Database` privilege in addition to `PSQL Database` privileges for configuring an external PostgreSQL instance. ==== - + .Procedure -. Optional: Create a certificate secret to configure your PostgreSQL instance with a TLS connection: +. Optional: Create a certificate secret to configure your PostgreSQL instance with a TLS connection: + [source,terminal] ---- @@ -30,7 +30,7 @@ cat < create -f - apiVersion: v1 kind: Secret metadata: - name: <1> + name: {my-product-database-certificates-secrets} <1> type: Opaque stringData: postgres-ca.pem: |- @@ -39,11 +39,11 @@ stringData: postgres-key.key: |- -----BEGIN CERTIFICATE----- <3> - postgres-crt.pem: |- + postgres-crt.pem: |- -----BEGIN CERTIFICATE----- <4> # ... -EOF +EOF ---- <1> Provide the name of the certificate secret. <2> Provide the CA certificate key. @@ -58,7 +58,7 @@ cat < create -f - apiVersion: v1 kind: Secret metadata: - name: <1> + name: {my-product-database-secrets} <1> type: Opaque stringData: <2> POSTGRES_PASSWORD: @@ -83,7 +83,7 @@ upstream: postgresql: enabled: false # disable PostgreSQL instance creation <1> auth: - existingSecret: # inject credentials secret to Backstage <2> + existingSecret: {my-product-database-secrets} # inject credentials secret to Backstage <2> backstage: appConfig: backend: @@ -102,7 +102,7 @@ upstream: cert: $file: /opt/app-root/src/postgres-crt.pem extraEnvVarsSecrets: - - # inject credentials secret to Backstage <3> + - {my-product-database-secrets} # inject credentials secret to Backstage <3> extraEnvVars: - name: BACKEND_SECRET valueFrom: @@ -120,7 +120,7 @@ upstream: subPath: postgres-ca.pem - mountPath: /opt/app-root/src/postgres-key.key name: postgres-key # inject TLS private key to Backstage cont. <6> - subPath: postgres-key.key + subPath: postgres-key.key extraVolumes: - ephemeral: volumeClaimTemplate: @@ -143,10 +143,10 @@ upstream: secretName: dynamic-plugins-npmrc - name: postgres-crt secret: - secretName: <7> + secretName: {my-product-database-certificates-secrets} <7> # ... ---- -<1> Set the value of the `upstream.postgresql.enabled` parameter to `false` to disable creating local PostgreSQL instances. +<1> Set the value of the `upstream.postgresql.enabled` parameter to `false` to disable creating local PostgreSQL instances. <2> Provide the name of the credential secret. <3> Provide the name of the credential secret. <4> Optional: Provide the name of the TLS certificate only for a TLS connection. diff --git a/modules/admin/proc-configuring-postgresql-instance-using-operator.adoc b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc similarity index 79% rename from modules/admin/proc-configuring-postgresql-instance-using-operator.adoc rename to modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc index 3389eb0b49..2d7d3f72c9 100644 --- a/modules/admin/proc-configuring-postgresql-instance-using-operator.adoc +++ b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc @@ -7,7 +7,7 @@ You can configure an external PostgreSQL instance using the {product} Operator. * You are using a supported version of PostgreSQL. For more information, see the link:https://access.redhat.com/support/policy/updates/developerhub[Product life cycle page]. * You have the following details: -** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address +** `db-host`: Denotes your PostgreSQL instance Domain Name System (DNS) or IP address ** `db-port`: Denotes your PostgreSQL instance port number, such as `5432` ** `username`: Denotes the user name to connect to your PostgreSQL instance ** `password`: Denotes the password to connect to your PostgreSQL instance @@ -16,21 +16,21 @@ You can configure an external PostgreSQL instance using the {product} Operator. [NOTE] ==== -By default, {product-short} uses a database for each plugin and automatically creates it if none is found. You might need the `Create Database` privilege in addition to `PSQL Database` privileges for configuring an external PostgreSQL instance. +By default, {product-short} uses a database for each plugin and automatically creates it if none is found. You might need the `Create Database` privilege in addition to `PSQL Database` privileges for configuring an external PostgreSQL instance. ==== - + .Procedure . Optional: Create a certificate secret to configure your PostgreSQL instance with a TLS connection: + -[source,yaml] +[source,yaml,subs="+attributes,+quotes"] ---- -cat < create -f - +cat < <1> + name: {my-product-database-certificates-secrets} <1> type: Opaque stringData: postgres-ca.pem: |- @@ -39,7 +39,7 @@ stringData: postgres-key.key: |- -----BEGIN CERTIFICATE----- <3> - postgres-crt.pem: |- + postgres-crt.pem: |- -----BEGIN CERTIFICATE----- <4> # ... @@ -52,13 +52,13 @@ EOF . Create a credential secret to connect with the PostgreSQL instance: + -[source,yaml] +[source,yaml,subs="+attributes,+quotes"] ---- -cat < create -f - +cat < <1> + name: {my-product-database-secrets} <1> type: Opaque stringData: <2> POSTGRES_PASSWORD: @@ -74,31 +74,31 @@ EOF <3> Optional: Provide the value based on the required link:https://www.postgresql.org/docs/15/libpq-connect.html#LIBPQ-CONNECT-SSLMODE[Secure Sockets Layer (SSL) mode]. <4> Optional: Provide the value only if you need a TLS connection for your PostgreSQL instance. -. Create a `Backstage` custom resource (CR): +. Create a `{product-custom-resource-type}` custom resource (CR): + -[source,terminal] +[source,terminal,subs="+attributes,+quotes"] ---- -cat < create -f - -apiVersion: rhdh.redhat.com/v1alpha1 +cat < spec: database: enableLocalDb: false <1> - application: + application: extraFiles: mountPath: # e g /opt/app-root/src secrets: - - name: <2> - key: postgres-crt.pem, postgres-ca.pem, postgres-key.key # key name as in Secret + - name: {my-product-database-certificates-secrets} <2> + key: postgres-crt.pem, postgres-ca.pem, postgres-key.key # key name as in {my-product-database-certificates-secrets} Secret extraEnvs: secrets: - - name: <3> - # ... + - name: {my-product-database-secrets} <3> + # ... ---- <1> Set the value of the `enableLocalDb` parameter to `false` to disable creating local PostgreSQL instances. -<2> Provide the name of the certificate secret if you have configured a TLS connection. +<2> Provide the name of the certificate secret if you have configured a TLS connection. <3> Provide the name of the credential secret that you created. + [NOTE] @@ -106,4 +106,4 @@ spec: The environment variables listed in the `Backstage` CR work with the Operator default configuration. If you have changed the Operator default configuration, you must reconfigure the `Backstage` CR accordingly. ==== -. Apply the `Backstage` CR to the namespace where you have deployed the {product-very-short} instance. +. Apply the `{product-custom-resource-type}` CR to the namespace where you have deployed the {product-short} instance. diff --git a/modules/admin/proc-migrating-databases-to-an-external-server.adoc b/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc similarity index 92% rename from modules/admin/proc-migrating-databases-to-an-external-server.adoc rename to modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc index 520ec78a07..75bf7d1644 100644 --- a/modules/admin/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 `Backstage` custom resource (CR). For more information, see link:{LinkAdminGuide}#proc-configuring-postgresql-instance-using-operator_admin-rhdh[Configuring an external PostgreSQL instance using the Operator]. +. Reconfigure your `Backstage` 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]. . Check that the following code is present at the end of your `Backstage` CR after reconfiguration: + [source,yaml] @@ -91,11 +91,11 @@ spec: # ... extraFiles: secrets: - - name: - key: postgres-crt.pem # key name as in Secret + - name: {my-product-database-certificates-secrets} + key: postgres-crt.pem # key name as in {my-product-database-certificates-secrets} Secret extraEnvs: secrets: - - name: + - name: {my-product-database-secrets} # ... ---- + diff --git a/modules/admin/proc-mount-directories-pvcs.adoc b/modules/configuring-external-databases/proc-mount-directories-pvcs.adoc similarity index 98% rename from modules/admin/proc-mount-directories-pvcs.adoc rename to modules/configuring-external-databases/proc-mount-directories-pvcs.adoc index 61cc8a6e59..59724bbd50 100644 --- a/modules/admin/proc-mount-directories-pvcs.adoc +++ b/modules/configuring-external-databases/proc-mount-directories-pvcs.adoc @@ -61,4 +61,4 @@ spec: Based on the configuration, the following directories are mounted in the container: * `/my/path/myclaim1` -* `/vol/my/claim` \ No newline at end of file +* `/vol/my/claim` diff --git a/modules/admin/procedure-understanding-no-proxy.adoc b/modules/configuring-external-databases/procedure-understanding-no-proxy.adoc similarity index 100% rename from modules/admin/procedure-understanding-no-proxy.adoc rename to modules/configuring-external-databases/procedure-understanding-no-proxy.adoc diff --git a/modules/configuring/proc-provisioning-your-custom-configuration.adoc b/modules/configuring/proc-provisioning-your-custom-configuration.adoc new file mode 100644 index 0000000000..702b2a39c8 --- /dev/null +++ b/modules/configuring/proc-provisioning-your-custom-configuration.adoc @@ -0,0 +1,71 @@ +[id="provisioning-your-custom-configuration"] += Provisioning your custom {product} configuration + +To configure {product}, provision your custom {product} config maps and secrets to {ocp-brand-name} before running {product}. + +[TIP] +==== +You can skip this step to run {product-short} with the default config map and secret. +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. + +.Procedure +. Author your custom `{my-product-secrets}.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]. + +. Author your custom `{my-app-config-file}` file. +This is the main {product-short} configuration file. ++ +You can start with an empty file to use the default configuration. ++ +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]. +* 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. + +.. Create the _<{my-product-namespace}>_ project aimed at containing your {product-short} instance. ++ +[source,terminal,subs="+attributes,+quotes"] +---- +$ 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]. + +.. Provision your `{my-app-config-file}` file to the `{my-app-config-config-map}` config map in the _<{my-product-namespace}>_ project. ++ +[source,terminal,subs="+attributes,+quotes"] +---- +$ 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]. + +.. Provision your `{my-product-secrets}.txt` file to the `{my-product-secrets}` secret in the _<{my-product-namespace}>_ project. ++ +[source,terminal,subs="+attributes,+quotes"] +---- +$ oc create secret generic {my-product-secrets} --from-file={my-product-secrets}.txt --namespace={my-product-namespace} +---- ++ +Alternatively, +link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/nodes/index#nodes-pods-secrets-creating-web-console-secrets_nodes-pods-secrets[create the secret by using the web console]. + +.Next steps +Consider provisioning additional config maps and secrets: + +* To use an external PostgreSQL database, xref:configuring-external-postgresql-databases[provision your PostgreSQL database secrets]. + + +* To enable dynamic plugins, link:{installing-and-viewing-dynamic-plugins-url}[provision your dynamic plugins config map]. + +* To configure authorization by using external files, link:{authorization-book-url}#managing-authorizations-by-using-external-files[provision your RBAC policies config map]. diff --git a/modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc b/modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc new file mode 100644 index 0000000000..f99c95e2ce --- /dev/null +++ b/modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc @@ -0,0 +1,31 @@ +[id='using-the-helm-chart-to-run-rhdh-with-your-custom-configuration'] += Using the {product} Helm chart to run {product-short} with your custom configuration + +You can use the {product} Helm chart to add a custom application configuration file to your {ocp-short} instance. + +.Prerequisites + +* By using the {ocp-short} web console, you have access with developer permissions, to link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/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 + +. Configure Helm to use your custom configuration files in {product-short}. +.. Go to the *Helm* tab to see the list of Helm releases. +.. Click the overflow menu on the Helm release that you want to use and select *Upgrade*. +.. Use the *YAML view* to edit the Helm configuration. +.. Set the value of the `upstream.backstage.extraAppConfig.configMapRef` and `upstream.backstage.extraAppConfig.filename` parameters as follows: ++ +.Helm configuration excerpt +[source,yaml,subs="+attributes,+quotes"] +---- +upstream: + backstage: + extraAppConfig: + - configMapRef: {my-app-config-config-map} + filename: {my-app-config-file} +---- +.. Click *Upgrade*. + +.Next steps +* Install {product-short} by using Helm. 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 new file mode 100644 index 0000000000..44ed4b9096 --- /dev/null +++ b/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc @@ -0,0 +1,206 @@ +[id="using-the-operator-to-run-rhdh-with-your-custom-configuration"] += Using the {product} operator to run {product-short} with your custom configuration + +To use the {product-short} operator to run {product} with your custom configuration, create a {product-custom-resource-type} custom resource that: + +* Mounts files provisioned in your custom config maps. +* 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}]. +* xref:provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. + +.Procedure + +. Author your {product-custom-resource-type} custom resource in a `{my-product-cr-name}.yaml` file to use your custom config maps and secrets. ++ +.Minimal `{my-product-cr-name}.yaml` custom resource example +==== +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: rhdh.redhat.com/v1alpha3 +kind: Backstage +metadata: + name: {my-product-cr-name} +spec: + application: + appConfig: + mountPath: /opt/app-root/src + configMaps: + - name: {my-app-config-config-map} + extraEnvs: + secrets: + - name: {my-product-secrets} + extraFiles: + mountPath: /opt/app-root/src + replicas: 1 + route: + enabled: true + database: + enableLocalDb: true +---- +==== ++ +.`{my-product-cr-name}.yaml` custom resource example with dynamic plugins and RBAC policies config maps, and external PostgreSQL database secrets. +==== +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: rhdh.redhat.com/v1alpha3 +kind: Backstage +metadata: + name: _<{my-product-cr-name}>_ +spec: + application: + appConfig: + mountPath: /opt/app-root/src + configMaps: + - name: {my-app-config-config-map} + - name: rbac-policies + dynamicPluginsConfigMapName: dynamic-plugins-rhdh + extraEnvs: + secrets: + - name: {my-product-secrets} + - name: {my-product-database-secrets} + extraFiles: + mountPath: /opt/app-root/src + secrets: + - name: {my-product-database-certificates-secrets} + key: postgres-crt.pem, postgres-ca.pem, postgres-key.key + replicas: 1 + route: + enabled: true + database: + enableLocalDb: false +---- +==== + +Mandatory fields:: + +No fields are mandatory. +You can create an empty {product-custom-resource-type} custom resource +and run {product-short} with the default configuration. + +Optional fields:: + +`spec.application.appConfig.configMaps`::: +Enter your config map name list. ++ +.Mount files in the `{my-app-config-config-map}` config map. +==== +[source,yaml,subs="+attributes,+quotes"] +---- +spec: + application: + appConfig: + mountPath: /opt/app-root/src + configMaps: + - name: {my-app-config-config-map} +---- +==== ++ +.Mount files in the `{my-app-config-config-map}` and `rbac-policies` config maps. +==== +[source,yaml,subs="+attributes,+quotes"] +---- +spec: + application: + appConfig: + mountPath: /opt/app-root/src + configMaps: + - name: {my-app-config-config-map} + - name: rbac-policies +---- +==== + +`spec.application.extraEnvs.envs`::: +Optionally, enter your additional environment variables that are not secrets, such as xref:proc-configuring-proxy-in-operator-deployment_running-behind-a-proxy[your proxy environment variables]. ++ +.Inject your `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables. +==== +[source,yaml,subs="+attributes,+quotes"] +---- +spec: + application: + extraEnvs: + envs: + - name: HTTP_PROXY + value: 'http://10.10.10.105:3128' + - name: HTTPS_PROXY + value: 'http://10.10.10.106:3128' + - name: NO_PROXY + value: 'localhost,example.org' +---- +==== + +`spec.application.extraEnvs.secrets`::: +Enter your environment variables secret name list. ++ +.Inject the environment variables in your `{my-product-secrets}` secret +==== +[source,yaml,subs="+attributes,+quotes"] +---- +spec: + application: + extraEnvs: + secrets: + - name: {my-product-secrets} +---- +==== ++ +.Inject the envvironment variables in the `{my-product-secrets}` and `{my-product-database-secrets}` secrets +==== +[source,yaml,subs="+attributes,+quotes"] +---- +spec: + application: + extraEnvs: + secrets: + - name: {my-product-secrets} + - name: {my-product-database-secrets} +---- +==== + +`spec.application.extraFiles.secrets`::: +Enter your certificates files secret name and files list. ++ +.Mount the `postgres-crt.pem`, `postgres-ca.pem`, and `postgres-key.key` files contained in the `{my-product-database-certificates-secrets}` secret +[source,yaml,subs="+attributes,+quotes"] +---- +spec: + application: + extraFiles: + mountPath: /opt/app-root/src + secrets: + - name: {my-product-database-certificates-secrets} + key: postgres-crt.pem, postgres-ca.pem, postgres-key.key +---- + +`spec.database.enableLocalDb`::: +Enable or disable the local PostgreSQL database. ++ +.Disable the local PostgreSQL database generation to use an external postgreSQL database +[source,yaml,subs="+attributes,+quotes"] +---- +spec: + database: + enableLocalDb: false +---- ++ +.On a development environment, use the local PostgreSQL database +[source,yaml,subs="+attributes,+quotes"] +---- +spec: + database: + enableLocalDb: true +---- + +`spec.deployment`::: +Optionally, xref:configuring-the-deployment[enter your deployment configuration]. + +. Apply your {product-custom-resource-type} custom resource to start or update your {product-short} instance. ++ +[source,terminal,subs="+attributes,+quotes"] +---- +$ oc apply --filename={my-product-cr-name}.yaml --namespace={my-product-namespace} +---- diff --git a/modules/customization/proc-customize-rhdh-sidebar-logo.adoc b/modules/customization/proc-customize-rhdh-sidebar-logo.adoc deleted file mode 100644 index 55fc38a9f0..0000000000 --- a/modules/customization/proc-customize-rhdh-sidebar-logo.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// Module included in the following assemblies: -// None -//Archived since the section has been merged with proc-customize-rhdh-branding-logo.adoc in PR #514 - -[id="proc-customize-rhdh-sidebar-logo_{context}"] -= Customizing the sidebar logo width for your {product-short} instance -You can customize the width of the sidebar logo by setting a value for the `fullLogoWidth` field in the `branding` section of the `app-config-rhdh.yaml` file, as shown in the following example: - -[source,yaml] ----- -app: - branding: - fullLogoWidth: 110px -# ... ----- - -The default value for the logo width is 110px. The following units are supported: integer, `px`, `em`, `rem`, percentage. diff --git a/modules/customization/proc-customize-rhdh-tab-tooltip.adoc b/modules/customization/proc-customize-rhdh-tab-tooltip.adoc deleted file mode 100644 index 66de517a91..0000000000 --- a/modules/customization/proc-customize-rhdh-tab-tooltip.adoc +++ /dev/null @@ -1,14 +0,0 @@ -// Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc - -[id="proc-customizing-rhdh-tab-tooltip_{context}"] -= Customizing the application title for your {product-short} instance - -You can customize the app title text by setting a value for the `title` field, as shown in the following example: - -[source,yaml] ----- -app: - title: My custom developer hub -# ... ----- diff --git a/modules/getting-started/con-techdocs-config-cicd.adoc b/modules/customizing-techdocs/con-techdocs-config-cicd.adoc similarity index 100% rename from modules/getting-started/con-techdocs-config-cicd.adoc rename to modules/customizing-techdocs/con-techdocs-config-cicd.adoc diff --git a/modules/getting-started/con-techdocs-configure-storage.adoc b/modules/customizing-techdocs/con-techdocs-configure-storage.adoc similarity index 100% rename from modules/getting-started/con-techdocs-configure-storage.adoc rename to modules/customizing-techdocs/con-techdocs-configure-storage.adoc diff --git a/modules/getting-started/proc-techdocs-config-cicd-prep-repo.adoc b/modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc similarity index 100% rename from modules/getting-started/proc-techdocs-config-cicd-prep-repo.adoc rename to modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc diff --git a/modules/getting-started/proc-techdocs-configure-odf-helm.adoc b/modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc similarity index 100% rename from modules/getting-started/proc-techdocs-configure-odf-helm.adoc rename to modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc diff --git a/modules/getting-started/proc-techdocs-configure-odf-operator.adoc b/modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc similarity index 100% rename from modules/getting-started/proc-techdocs-configure-odf-operator.adoc rename to modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc diff --git a/modules/getting-started/proc-techdocs-generate-site.adoc b/modules/customizing-techdocs/proc-techdocs-generate-site.adoc similarity index 100% rename from modules/getting-started/proc-techdocs-generate-site.adoc rename to modules/customizing-techdocs/proc-techdocs-generate-site.adoc diff --git a/modules/getting-started/proc-techdocs-publish-site.adoc b/modules/customizing-techdocs/proc-techdocs-publish-site.adoc similarity index 100% rename from modules/getting-started/proc-techdocs-publish-site.adoc rename to modules/customizing-techdocs/proc-techdocs-publish-site.adoc diff --git a/modules/getting-started/proc-techdocs-using-odf-storage.adoc b/modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc similarity index 100% rename from modules/getting-started/proc-techdocs-using-odf-storage.adoc rename to modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc diff --git a/modules/getting-started/ref-techdocs-example-config-plugin-helm.adoc b/modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc similarity index 100% rename from modules/getting-started/ref-techdocs-example-config-plugin-helm.adoc rename to modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc diff --git a/modules/getting-started/ref-techdocs-example-config-plugin-operator.adoc b/modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc similarity index 100% rename from modules/getting-started/ref-techdocs-example-config-plugin-operator.adoc rename to modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc diff --git a/modules/templates/proc-adding-templates.adoc b/modules/customizing-templates/proc-adding-templates.adoc similarity index 96% rename from modules/templates/proc-adding-templates.adoc rename to modules/customizing-templates/proc-adding-templates.adoc index 5f421cc8de..91ff78ec9b 100644 --- a/modules/templates/proc-adding-templates.adoc +++ b/modules/customizing-templates/proc-adding-templates.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * assemblies/assembly-admin-templates.adoc +// * assemblies/assembly-configuring-templates.adoc :_mod-docs-content-type: PROCEDURE [id="proc-adding-templates_{context}"] diff --git a/modules/templates/proc-creating-templates.adoc b/modules/customizing-templates/proc-creating-templates.adoc similarity index 97% rename from modules/templates/proc-creating-templates.adoc rename to modules/customizing-templates/proc-creating-templates.adoc index 56f0f6dccb..8113d724ea 100644 --- a/modules/templates/proc-creating-templates.adoc +++ b/modules/customizing-templates/proc-creating-templates.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * assemblies/assembly-admin-templates.adoc +// * assemblies/assembly-configuring-templates.adoc :_mod-docs-content-type: PROCEDURE [id="proc-creating-templates_{context}"] diff --git a/modules/templates/ref-creating-templates.adoc b/modules/customizing-templates/ref-creating-templates.adoc similarity index 98% rename from modules/templates/ref-creating-templates.adoc rename to modules/customizing-templates/ref-creating-templates.adoc index 943a880e95..d894a74ace 100644 --- a/modules/templates/ref-creating-templates.adoc +++ b/modules/customizing-templates/ref-creating-templates.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * assemblies/assembly-admin-templates.adoc +// * assemblies/assembly-configuring-templates.adoc :_mod-docs-content-type: REFERENCE [id="ref-creating-templates_{context}"] diff --git a/modules/customization/proc-customize-rhdh-branding-logo.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc similarity index 96% rename from modules/customization/proc-customize-rhdh-branding-logo.adoc rename to modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc index 3f7fff0073..0304c411a3 100644 --- a/modules/customization/proc-customize-rhdh-branding-logo.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc +// assembly-customizing-the-appearance.adoc //restored module as per slack thread: https://redhat-internal.slack.com/archives/C04CUSD4JSG/p1726856912238529 [id="proc-customize-rhdh-branding-logo_{context}"] diff --git a/modules/customization/proc-customize-rhdh-font.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-font.adoc similarity index 97% rename from modules/customization/proc-customize-rhdh-font.adoc rename to modules/customizing-the-appearance/proc-customize-rhdh-font.adoc index 9ba0c69e82..8a6caee0da 100644 --- a/modules/customization/proc-customize-rhdh-font.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-font.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc +// assembly-customizing-the-appearance.adoc [id="proc-customize-rhdh-font_{context}"] = Customizing the font for your {product-short} instance diff --git a/modules/customization/proc-customize-rhdh-page-theme.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc similarity index 97% rename from modules/customization/proc-customize-rhdh-page-theme.adoc rename to modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc index 45e17866d5..27c212a035 100644 --- a/modules/customization/proc-customize-rhdh-page-theme.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc +// assembly-customizing-the-appearance.adoc [id="proc-customize-rhdh-page-theme_{context}"] = Customizing the page theme header for your {product-short} instance diff --git a/modules/customization/proc-customize-rhdh-palette.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc similarity index 97% rename from modules/customization/proc-customize-rhdh-palette.adoc rename to modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc index 20f3b418d7..a848198913 100644 --- a/modules/customization/proc-customize-rhdh-palette.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc +// assembly-customizing-the-appearance.adoc [id="proc-customize-rhdh-branding_{context}"] = Customizing the theme mode color palettes for your {product-short} instance diff --git a/modules/customization/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc similarity index 100% rename from modules/customization/proc-customize-rhdh-sidebar-menuitems.adoc rename to modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc diff --git a/modules/customization/proc-customize-rhdh-theme-mode.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc similarity index 96% rename from modules/customization/proc-customize-rhdh-theme-mode.adoc rename to modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc index 72c638017c..bc7f60432e 100644 --- a/modules/customization/proc-customize-rhdh-theme-mode.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc +// assembly-customizing-the-appearance.adoc [id="proc-customizing-rhdh-theme-mode_{context}"] = Customizing the theme mode for your {product-short} instance diff --git a/modules/customization/ref-customize-rhdh-custom-components.adoc b/modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc similarity index 97% rename from modules/customization/ref-customize-rhdh-custom-components.adoc rename to modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc index d7305ff86f..139b597764 100644 --- a/modules/customization/ref-customize-rhdh-custom-components.adoc +++ b/modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc +// assembly-customizing-the-appearance.adoc [id="ref-customize-rhdh-custom-components_{context}"] = Custom component options for your {product-short} instance diff --git a/modules/customization/ref-customize-rhdh-default-backstage.adoc b/modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc similarity index 99% rename from modules/customization/ref-customize-rhdh-default-backstage.adoc rename to modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc index ecd6a48205..5fdd98e980 100644 --- a/modules/customization/ref-customize-rhdh-default-backstage.adoc +++ b/modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc +// assembly-customizing-the-appearance.adoc [id="ref-customize-rhdh-default-backstage_{context}"] = Default Backstage theme diff --git a/modules/customization/ref-customize-rhdh-default-rhdh.adoc b/modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc similarity index 99% rename from modules/customization/ref-customize-rhdh-default-rhdh.adoc rename to modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc index df5d7029d3..d2aa3acdf3 100644 --- a/modules/customization/ref-customize-rhdh-default-rhdh.adoc +++ b/modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// assembly-customize-rhdh-theme.adoc +// assembly-customizing-the-appearance.adoc [id="ref-customize-rhdh-default-rhdh_{context}"] = Default {product} theme diff --git a/modules/getting-started/proc-customizing-the-home-page-cards.adoc b/modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc similarity index 98% rename from modules/getting-started/proc-customizing-the-home-page-cards.adoc rename to modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc index e28c976028..445168f035 100644 --- a/modules/getting-started/proc-customizing-the-home-page-cards.adoc +++ b/modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc @@ -51,7 +51,7 @@ dynamicPlugins: ---- .Prerequisites -* You have administrative access and can modify the `app-config.yaml` file for dynamic plugin configurations. +* You have administrative access and can modify the `{my-app-config-file}` file for dynamic plugin configurations. .Procedure * Configure different cards for your Home page in {product} as follows: diff --git a/modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc similarity index 100% rename from modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc rename to modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc diff --git a/modules/getting-started/proc-customize-rhdh-learning-paths.adoc b/modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths.adoc similarity index 92% rename from modules/getting-started/proc-customize-rhdh-learning-paths.adoc rename to modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths.adoc index 2f99273054..0f077a283c 100644 --- a/modules/getting-started/proc-customize-rhdh-learning-paths.adoc +++ b/modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths.adoc @@ -1,13 +1,13 @@ [id='proc-customize-rhdh-learning-paths_{context}'] = Customizing the Learning Paths in {product} -In {product}, you can configure Learning Paths by passing the data into the `app-config.yaml` file as a proxy. The base URL must include the `/developer-hub/learning-paths` proxy. +In {product}, you can configure Learning Paths by passing the data into the `{my-app-config-file}` file as a proxy. The base URL must include the `/developer-hub/learning-paths` proxy. [NOTE] ==== Due to the use of overlapping `pathRewrites` for both the `learning-path` and `homepage` quick access proxies, you must create the `learning-paths` configuration (`^api/proxy/developer-hub/learning-paths`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`). -For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage_rhdh-getting-started[Customizing the Home page in {product}]. +For more information about customizing the Home page in {product}, see xref:customizing-the-home-page[Customizing the Home page in {product}]. ==== You can provide data to the Learning Path from the following sources: @@ -26,7 +26,7 @@ For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhd To access the data from the JSON files, complete the following step: -* Add the following code to the `app-config.yaml` file: +* Add the following code to the `{my-app-config-file}` file: + [source,yaml] ---- diff --git a/modules/getting-started/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 similarity index 100% rename from modules/getting-started/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc rename to modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc diff --git a/modules/getting-started/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 similarity index 100% rename from modules/getting-started/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc rename to modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc diff --git a/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc b/modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc similarity index 78% rename from modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc rename to modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc index 669de89483..7fccb0536d 100644 --- a/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc +++ b/modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc @@ -1,8 +1,16 @@ [id='proc-customize-rhdh-tech-radar-page_{context}'] = Customizing the Tech Radar page in {product} -In {product}, the Tech Radar page is provided by the `tech-radar` and `tech-radar-backend` dynamic plugins, which are disabled by default. -For information about enabling dynamic plugins in {product} see link:{LinkPluginsGuide}[Configuring plugins 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:{LinkPluginsGuide}[Configuring plugins in {product}]. + +In {product}, you can configure Learning Paths by passing the data into the `app-config.yaml` file as a proxy. The base Tech Radar URL must include the `/developer-hub/tech-radar` proxy. + +[NOTE] +==== +Due to the use of overlapping `pathRewrites` for both the `tech-radar` and `homepage` quick access proxies, you must create the `tech-radar` configuration (`^api/proxy/developer-hub/tech-radar`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`). + +For more information about customizing the Home page in {product}, see xref:customizing-the-home-page[Customizing the Home page in {product}]. +==== You can provide data to the Tech Radar page from the following sources: diff --git a/modules/customizing/proc-customizing-the-backend-secret.adoc b/modules/customizing/proc-customizing-the-backend-secret.adoc new file mode 100644 index 0000000000..06ce1d3a62 --- /dev/null +++ b/modules/customizing/proc-customizing-the-backend-secret.adoc @@ -0,0 +1,40 @@ +[id='customizing-the-backend-secret'] += Customizing {product} backend secret + +The default {product} configuration defines the {product-short} backend secret for service to service authentication. + +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. + +.Procedure + +. To define the {product-short} backend secret, +add to your custom `{my-product-secrets}.txt` file the `BACKEND_SECRET` environment variable with a base64 encoded string. +Use a unique value for each {product-short} instance. ++ +[source,terminal,subs="+attributes"] +---- +$ echo > {my-product-secrets}.txt "BACKEND_SECRET=$(node -p 'require("crypto").randomBytes(24).toString("base64")')" +---- ++ +.`{my-product-secrets}.txt` example +---- +BACKEND_SECRET=3E2/rIPuZNFCtYHoxVP8wjriffnN1q/z +---- + +. Add your backend secret to your custom `{my-app-config-file}` file. ++ +.`{my-app-config-file}` excerpt defining the backend secret +[source,yaml,subs="+attributes,+quotes"] +---- +backend: + auth: + externalAccess: + - type: legacy + options: + subject: legacy-default-config + secret: "${BACKEND_SECRET}" +---- + diff --git a/modules/customizing/proc-customizing-your-product-base-url.adoc b/modules/customizing/proc-customizing-your-product-base-url.adoc new file mode 100644 index 0000000000..7371b369a5 --- /dev/null +++ b/modules/customizing/proc-customizing-your-product-base-url.adoc @@ -0,0 +1,22 @@ +[id="customizing-your-product-se-url"] += 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]. + +.Procedure +* In your custom `{my-app-config-file}` file, enter your {product-short} external URL, such as pass:c,a,q[{my-product-url}]. ++ +.`{my-app-config-file}` excerpt +[source,yaml,subs="+attributes,+quotes"] +---- +app: + baseUrl: {my-product-url} +backend: + baseUrl: {my-product-url} + cors: + origin: {my-product-url} +---- diff --git a/modules/customizing/proc-customizing-your-product-title.adoc b/modules/customizing/proc-customizing-your-product-title.adoc new file mode 100644 index 0000000000..b560084bde --- /dev/null +++ b/modules/customizing/proc-customizing-your-product-title.adoc @@ -0,0 +1,17 @@ +[id="customizing-your-product-title"] += Customizing your {product} title + +You can change the default {product} display name. + +.Prerequisites +* link:{configuring-book-url}[Custom {product-short} configuration]. + +.Procedure +* In your custom `{my-app-config-file}` file, enter your {product-short} instance display name, such as _<{product}>_. ++ +.`{my-app-config-file}` excerpt +[source,yaml,subs="+attributes,+quotes"] +---- +app: + title: My custom {product} title +---- diff --git a/modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc b/modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc index 08cbbf40c6..b10d15dace 100644 --- a/modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc +++ b/modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc @@ -10,7 +10,7 @@ You can store the configuration for dynamic plugins in a `ConfigMap` object that [NOTE] ==== -If the `pluginConfig` field references environment variables, you must define the variables in your `secrets-rhdh` secret. +If the `pluginConfig` field references environment variables, you must define the variables in your `my-rhdh-secrets` secret. ==== .Procedure @@ -54,7 +54,7 @@ image::rhdh/operator-install-2.png[] + [source,yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha1 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: my-rhdh diff --git a/modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc b/modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc index f0434f2487..3fd1126de9 100644 --- a/modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc +++ b/modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc @@ -9,7 +9,7 @@ You can use the Redis cache store to improve {product-very-short} performance an * 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/[`Redis official documentation`]. .Procedure -Add the following code to your `app-config.yaml` file: +Add the following code to your `{my-app-config-file}` file: [source, yaml] ---- backend: @@ -34,4 +34,4 @@ When `useRedisSets` is enabled (`true`): [NOTE] In high-performance scenarios, enabling `useRedisSets` can result in memory leaks. If you are running a high-performance application or service, you must set `useRedisSets` to `false`. -When you set `useRedisSets` to `false`, the keys are handled individually and Redis sets are not utilized. This configuration might lead to performance issues in production when using the `clear` function, as it requires iterating over all keys for deletion. \ No newline at end of file +When you set `useRedisSets` to `false`, the keys are handled individually and Redis sets are not utilized. This configuration might lead to performance issues in production when using the `clear` function, as it requires iterating over all keys for deletion. diff --git a/modules/dynamic-plugins/proc-topology-configure.adoc b/modules/dynamic-plugins/proc-topology-configure.adoc index eee7de31a5..897f966e61 100644 --- a/modules/dynamic-plugins/proc-topology-configure.adoc +++ b/modules/dynamic-plugins/proc-topology-configure.adoc @@ -20,7 +20,7 @@ To view OpenShift routes, you must grant read access to the routes resource in t - list ---- -You must also add the following in `kubernetes.customResources` property in your `app-config.yaml` file: +You must also add the following in `kubernetes.customResources` property in your `{my-app-config-file}` file: [source,yaml] ---- @@ -33,7 +33,7 @@ kubernetes: ---- == Viewing pod logs -To view pod logs, you must grant the following permission to the `ClusterRole`: +To view pod logs, you must grant the following permission to the `ClusterRole`: [source,yaml] ---- @@ -77,7 +77,7 @@ To view the Tekton PipelineRuns you must grant read access to the `pipelines`, ` - list ---- -To view the Tekton PipelineRuns list in the side panel and the latest PipelineRuns status in the Topology node decorator, you must add the following code to the `kubernetes.customResources` property in your `app-config.yaml` file: +To view the Tekton PipelineRuns list in the side panel and the latest PipelineRuns status in the Topology node decorator, you must add the following code to the `kubernetes.customResources` property in your `{my-app-config-file}` file: [source,yaml] ---- @@ -118,7 +118,7 @@ You must also grant read access to the `VirtualMachines` resource in the `Cluste - list ---- -To view the virtual machine nodes on the topology plugin, you must add the following code to the `kubernetes.customResources` property in the `app-config.yaml` file: +To view the virtual machine nodes on the topology plugin, you must add the following code to the `kubernetes.customResources` property in the `{my-app-config-file}` file: [source,yaml] ---- @@ -154,7 +154,7 @@ To enable the source code editor, you must grant read access to the CheClusters - list ---- -To use the source code editor, you must add the following configuration to the `kubernetes.customResources` property in your `app-config.yaml` file: +To use the source code editor, you must add the following configuration to the `kubernetes.customResources` property in your `{my-app-config-file}` file: [source,yaml] ---- @@ -330,4 +330,4 @@ annotations: app.openshift.io/connects-to: '[{"apiVersion": ,"kind": ,"name": }]' ---- -For more information about the labels and annotations, see _Guidelines for labels and annotations for OpenShift applications_. \ No newline at end of file +For more information about the labels and annotations, see _Guidelines for labels and annotations for OpenShift applications_. diff --git a/modules/dynamic-plugins/proc-topology-install.adoc b/modules/dynamic-plugins/proc-topology-install.adoc index dbb099975d..5693fac0e0 100644 --- a/modules/dynamic-plugins/proc-topology-install.adoc +++ b/modules/dynamic-plugins/proc-topology-install.adoc @@ -4,14 +4,14 @@ The Topology plugin enables you to visualize the workloads such as Deployment, J .Prerequisites * You have installed and configured the @backstage/plugin-kubernetes-backend dynamic plugins. * You have configured the Kubernetes plugin to connect to the cluster using a ServiceAccount. -* The `ClusterRole` must be granted to ServiceAccount accessing the cluster. -[NOTE] +* The `ClusterRole` must be granted to ServiceAccount accessing the cluster. +[NOTE] If you have the {product-short} Kubernetes plugin configured, then the `ClusterRole` is already granted. .Procedure * The Topology plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the disabled property to false as follows: + -.`app-config.yaml` fragment +.`{my-app-config-file}` fragment [source,yaml] ---- auth: @@ -22,4 +22,4 @@ global: plugins: - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-topology disabled: false ----- \ No newline at end of file +---- diff --git a/modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc b/modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc deleted file mode 100644 index 6fbed3a951..0000000000 --- a/modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc +++ /dev/null @@ -1,46 +0,0 @@ -[id='proc-add-custom-app-file-openshift-helm_{context}'] -= Adding a custom application configuration file to {ocp-short} using the Helm chart - -You can use the {product} Helm chart to add a custom application configuration file to your {ocp-short} instance. - -.Prerequisites - -* You have created an {ocp-brand-name} account. - -.Procedure - -. From the {ocp-short} web console, select the *ConfigMaps* tab. -. Click *Create ConfigMap*. -. From *Create ConfigMap* page, select the *YAML view* option in *Configure via* and make changes to the file, if needed. -. Click *Create*. -. Go to the *Helm* tab to see the list of Helm releases. -. Click the overflow menu on the Helm release that you want to use and select *Upgrade*. -. Use either the *Form view* or *YAML view* to edit the Helm configuration. - -** Using *Form view* -+ -.. Expand *Root Schema → Backstage chart schema → Backstage parameters → Extra app configuration files to inline into command arguments*. -.. Click the *Add Extra app configuration files to inline into command arguments* link. -.. Enter the value in the following fields: -+ --- -* *configMapRef*: `app-config-rhdh` -* *filename*: `app-config-rhdh.yaml` --- -.. Click *Upgrade*. - -** Using *YAML view* - -.. Set the value of the `upstream.backstage.extraAppConfig.configMapRef` and `upstream.backstage.extraAppConfig.filename` parameters as follows: -+ -[source, yaml] ----- -# ... other Red Hat Developer Hub Helm Chart configurations -upstream: - backstage: - extraAppConfig: - - configMapRef: app-config-rhdh - filename: app-config-rhdh.yaml -# ... other Red Hat Developer Hub Helm Chart configurations ----- -.. Click *Upgrade*. diff --git a/modules/getting-started/ref-rhdh-supported-configs.adoc b/modules/getting-started/ref-rhdh-supported-configs.adoc deleted file mode 100644 index 4b15c0bc16..0000000000 --- a/modules/getting-started/ref-rhdh-supported-configs.adoc +++ /dev/null @@ -1,7 +0,0 @@ -[id='ref-rhdh-supported-configs_{context}'] -= Supported configurations for {product} - -This section describes the configurations that are required to access the {product}, including: - -* Custom applications configuration -* Source control configuration for {product-short} Catalog \ No newline at end of file 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 5eb2d5e4b4..6cec0e651a 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 `app-config.yaml` 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 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: ** 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/installation/proc-add-custom-app-config-file-ocp-operator.adoc b/modules/installation/proc-add-custom-app-config-file-ocp-operator.adoc deleted file mode 100644 index a4b4c92bf0..0000000000 --- a/modules/installation/proc-add-custom-app-config-file-ocp-operator.adoc +++ /dev/null @@ -1,99 +0,0 @@ -[id="proc-add-custom-app-config-file-ocp-operator_{context}"] -= Adding a custom application configuration file to {ocp-short} using the Operator - -A custom application configuration file is a `ConfigMap` object that you can use to change the configuration of your {product} instance. If you are deploying your {product-short} instance on {ocp-brand-name}, you can use the {product} Operator to add a custom application configuration file to your {ocp-short} instance by creating the `ConfigMap` object and referencing it in the {product-short} custom resource (CR). - -The custom application configuration file contains a sensitive environment variable, named `BACKEND_SECRET`. This variable contains a mandatory backend authentication key that {product-short} uses to reference an environment variable defined in an {ocp-short} secret. You must create a secret, named 'secrets-rhdh', and reference it in the {product-short} CR. - -[NOTE] -==== -You are responsible for protecting your {product} installation from external and unauthorized access. Manage the backend authentication key like any other secret. Meet strong password requirements, do not expose it in any configuration files, and only inject it into configuration files as an environment variable. -==== - -.Prerequisites -* You have an active {ocp-brand-name} account. -* Your administrator has installed the {product} Operator in {ocp-short}. For more information, see link:{LinkAdminGuide}[Installing the {product} Operator]. -* You have created the {product} CR in {ocp-short}. - -.Procedure -. From the *Developer* perspective in the {ocp-short} web console, select the *Topology* view, and click the *Open URL* icon on the {product-short} pod to identify your {product-short} external URL: __<{product-very-short}_URL>__. -. From the *Developer* perspective in the {ocp-short} web console, select the *ConfigMaps* view. -. Click *Create ConfigMap*. -. Select the *YAML view* option in *Configure via* and use the following example as a base template to create a `ConfigMap` object, such as `app-config-rhdh.yaml`: -+ -[source,yaml,subs="attributes+"] ----- -kind: ConfigMap -apiVersion: v1 -metadata: - name: app-config-rhdh -data: - "app-config-rhdh.yaml": | - app: - title: {product} - baseUrl: <{product-very-short}_URL> # <1> - backend: - auth: - externalAccess: - - type: legacy - options: - subject: legacy-default-config - secret: "${BACKEND_SECRET}" # <2> - baseUrl: <{product-very-short}_URL> # <3> - cors: - origin: <{product-very-short}_URL> # <4> ----- -+ -<1> Set the external URL of your {product} instance. -<2> Use an environment variable exposing an {ocp-short} secret to define the mandatory {product-short} backend authentication key. -<3> Set the external URL of your {product} instance. -<4> Set the external URL of your {product} instance. - -. Click *Create*. -. Select the *Secrets* view. -. Click *Create Key/value Secret*. -. Create a secret named `secrets-rhdh`. -. Add a key named `BACKEND_SECRET` and a base64 encoded string as a value. Use a unique value for each {product} instance. For example, you can use the following command to generate a key from your terminal: -+ -[source,yaml] ----- -node -p 'require("crypto").randomBytes(24).toString("base64")' ----- - -. Click *Create*. -. Select the *Topology* view. -. Click the overflow menu for the {product} instance that you want to use and select *Edit Backstage* to load the YAML view of the {product} instance. -+ -image::rhdh/operator-install-2.png[] - -. In the CR, enter the name of the custom application configuration config map as the value for the `spec.application.appConfig.configMaps` field, and enter the name of your secret as the value for the `spec.application.extraEnvs.secrets` field. For example: -+ -[source, yaml] ----- -apiVersion: rhdh.redhat.com/v1alpha1 -kind: Backstage -metadata: - name: developer-hub -spec: - application: - appConfig: - mountPath: /opt/app-root/src - configMaps: - - name: app-config-rhdh - extraEnvs: - secrets: - - name: secrets-rhdh - extraFiles: - mountPath: /opt/app-root/src - replicas: 1 - route: - enabled: true - database: - enableLocalDb: true ----- -. Click *Save*. -. Navigate back to the *Topology* view and wait for the {product} pod to start. -. Click the *Open URL* icon to use the {product} platform with the configuration changes. - -.Additional resources -* For more information about roles and responsibilities in {product-short}, see link:{LinkAdminGuide}[Role-Based Access Control (RBAC) in {product}]. 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 1b6c85af69..9172d9e4c6 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 @@ -119,8 +119,8 @@ data: <1> The base URL to the Kubernetes control plane. You can run the `kubectl cluster-info` command to get the base URL. <2> Set the value of this parameter to `false` to enable the verification of the TLS certificate. <3> Optional: The link to the Kubernetes dashboard managing the ARO cluster. -<4> Optional: Pass the service account token using a `K8S_SERVICE_ACCOUNT_TOKEN` environment variable that you can define in your `secrets-rhdh` secret. -<5> Pass the CA data using a `K8S_CONFIG_CA_DATA` environment variable that you can define in your `secrets-rhdh` secret. +<4> Optional: Pass the service account token using a `K8S_SERVICE_ACCOUNT_TOKEN` environment variable that you can define in your `my-rhdh-secrets` secret. +<5> Pass the CA data using a `K8S_CONFIG_CA_DATA` environment variable that you can define in your `my-rhdh-secrets` secret. . Save the configuration changes. diff --git a/modules/installation/proc-deploy-rhdh-instance-eks.adoc b/modules/installation/proc-deploy-rhdh-instance-eks.adoc index 14deafb8aa..548aafe4e3 100644 --- a/modules/installation/proc-deploy-rhdh-instance-eks.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-eks.adoc @@ -44,15 +44,15 @@ data: ---- -- -. Create a Secret named `secrets-rhdh` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: +. Create a Secret named `{my-product-secrets}` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: + -- -[source,yaml] +[source,yaml,subs="+attributes,+quotes"] ---- apiVersion: v1 kind: Secret metadata: - name: secrets-rhdh + name: {my-product-secrets} stringData: # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup BACKEND_SECRET: "xxx" @@ -85,9 +85,9 @@ kubectl patch serviceaccount default \ . Create a Custom Resource file using the following template: + -- -[source,yaml,subs="attributes+"] +[source,yaml,subs="+attributes,+quotes"] ---- -apiVersion: rhdh.redhat.com/v1alpha1 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: # TODO: this the name of your {product-short} instance @@ -103,7 +103,7 @@ spec: - name: "app-config-rhdh" extraEnvs: secrets: - - name: "secrets-rhdh" + - name: {my-product-secrets} ---- -- diff --git a/modules/installation/proc-deploy-rhdh-instance-gke.adoc b/modules/installation/proc-deploy-rhdh-instance-gke.adoc index a303a6703e..c67d580682 100644 --- a/modules/installation/proc-deploy-rhdh-instance-gke.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-gke.adoc @@ -1,6 +1,6 @@ [id="proc-deploy-rhdh-instance-gke.adoc_{context}"] = Deploying the {product-short} instance on {gke-short} with the Operator -You can deploy your {product-short} instance in {gke-short} using the Operator. +You can deploy your {product-short} instance in {gke-short} using the Operator. .Prerequisites * A cluster administrator has installed the {product} Operator. @@ -9,7 +9,7 @@ You can deploy your {product-short} instance in {gke-short} using the Operator. * 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 virtual machine (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] ==== @@ -45,16 +45,16 @@ data: ---- -- -. Create a Secret named `secrets-rhdh` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: +. Create a Secret named `my-rhdh-secrets` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string as value: + -- -.`secrets-rhdh` fragment +.`my-rhdh-secrets` fragment [source,yaml] ---- apiVersion: v1 kind: Secret metadata: - name: secrets-rhdh + name: my-rhdh-secrets stringData: # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup BACKEND_SECRET: "xxx" @@ -90,7 +90,7 @@ kubectl patch serviceaccount default \ .Custom Resource fragment [source,yaml,subs="attributes+"] ---- -apiVersion: rhdh.redhat.com/v1alpha1 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: # This is the name of your {product-short} instance @@ -106,7 +106,7 @@ spec: - name: "app-config-rhdh" extraEnvs: secrets: - - name: "secrets-rhdh" + - name: "my-rhdh-secrets" ---- -- @@ -125,9 +125,9 @@ 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]. +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 a `FrontendConfig` object @@ -192,4 +192,4 @@ spec: // Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use. .Additional information -For more information on setting up {gke-short} using Ingress with TLS, see https://github.com/GoogleCloudPlatform/gke-networking-recipes/tree/main/ingress/single-cluster/ingress-https[Secure GKE Ingress]. \ No newline at end of file +For more information on setting up {gke-short} using Ingress with TLS, see https://github.com/GoogleCloudPlatform/gke-networking-recipes/tree/main/ingress/single-cluster/ingress-https[Secure GKE Ingress]. diff --git a/modules/installation/proc-enable-signin.adoc b/modules/installation/proc-enable-signin.adoc index 706fa9e393..60a61bca36 100644 --- a/modules/installation/proc-enable-signin.adoc +++ b/modules/installation/proc-enable-signin.adoc @@ -67,7 +67,7 @@ For more information about installation, see xref:{installing-on-ocp-book-url}#a .Procedure -. Add the configuration for the desired authentication provider under the `auth` section of the `app-config.yaml` file, such as: +. Add the configuration for the desired authentication provider under the `auth` section of the `{my-app-config-file}` file, such as: + -- [source,yaml] @@ -82,8 +82,8 @@ auth: ---- -- -. Set the authentication provider key as the value to `signInPage` parameter in your `app-config.yaml` file, such as: +. Set the authentication provider key as the value to `signInPage` parameter in your `{my-app-config-file}` file, such as: + `signInPage: oidc` -. Start your {product-short} application and sign in. \ No newline at end of file +. Start your {product-short} application and sign in. diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 585521c076..293a7d1b07 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -8,22 +8,19 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the .Prerequisites -* A cluster administrator has installed the {product} Operator. For more information, see xref:proc-install-operator_{context}[]. -* You have added a custom configuration file to {ocp-short}. For more information, see link:{LinkAdminGuide}[Adding a custom configuration file to {ocp-short}]. +* 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]. .Procedure -. Create a project in {ocp-short} for your {product} instance, or select an existing project. -+ -[TIP] -==== -For more information about creating a project in {ocp-short}, see link:https://docs.openshift.com/container-platform/4.15/applications/projects/working-with-projects.html#creating-a-project-using-the-web-console_projects[Creating a project by using the web console] in the {ocp-brand-name} documentation. -==== +. In the {ocp-short} web console, select your `_<{my-product-namespace}>_` project. + . From the *Developer* perspective on the {ocp-short} web console, click *+Add*. . From the *Developer Catalog* panel, click *Operator Backed*. . In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card. . Click *Create*. -. Add custom configurations for the {product} instance. +. xref:{configuring-book-url}#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 diff --git a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc index b53318b52f..df951f9169 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc @@ -44,4 +44,5 @@ global: * To access the the {product-short}, click the *Open URL* icon. .Additional resources -* link:{LinkAdminGuide}[{NameOfAdminGuide}] +* link:{configuring-book-url}[{configuring-book-title}] +* link:{customizing-book-url}[{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 14062de60c..995d878094 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -26,4 +26,5 @@ You can install {product-short} on {osd-short} on {gcp-short} using the {product * To access the {product-short}, navigate to the {product-short} URL provided in the {ocp-short} web console. .Additional resources -* link:{LinkAdminGuide}[{NameOfAdminGuide}] \ No newline at end of file +* link:{configuring-book-url}[{configuring-book-title}] +* link:{customizing-book-url}[{customizing-book-title}] diff --git a/modules/installation/proc-rhdh-deploy-aks-operator.adoc b/modules/installation/proc-rhdh-deploy-aks-operator.adoc index b5e1636bbd..5da1f37886 100644 --- a/modules/installation/proc-rhdh-deploy-aks-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-operator.adoc @@ -114,7 +114,7 @@ data: ---- -- -. Create a Secret named `secrets-rhdh` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string value as shown in the following example: +. Create a Secret named `my-rhdh-secrets` and add a key named `BACKEND_SECRET` with a `Base64-encoded` string value as shown in the following example: + -- [source,yaml] @@ -122,7 +122,7 @@ data: apiVersion: v1 kind: Secret metadata: - name: secrets-rhdh + name: my-rhdh-secrets stringData: BACKEND_SECRET: "xxx" ---- @@ -133,7 +133,7 @@ stringData: -- [source,yaml] ---- -apiVersion: rhdh.redhat.com/v1alpha1 +apiVersion: rhdh.redhat.com/v1alpha3 kind: Backstage metadata: name: @@ -146,7 +146,7 @@ spec: - name: "app-config-rhdh" extraEnvs: secrets: - - name: "secrets-rhdh" + - name: "my-rhdh-secrets" ---- -- diff --git a/modules/observe/ref-customizing-telemetry-segment.adoc b/modules/observe/ref-customizing-telemetry-segment.adoc index d5c386f31a..9ee7698713 100644 --- a/modules/observe/ref-customizing-telemetry-segment.adoc +++ b/modules/observe/ref-customizing-telemetry-segment.adoc @@ -6,7 +6,7 @@ The `analytics-provider-segment` plugin sends the collected telemetry data to {c [NOTE] ==== -By configuring a new Segment source, you can collect and analyze the same set of data that is mentioned in the link:{LinkAdminGuide}#assembly-rhdh-telemetry[Telemetry data collection] section. You might also require to create your own telemetry data collection notice for your application users. +By configuring a new Segment source, you can collect and analyze the same set of data that is mentioned in link:{telemetry-data-collection-book-url}[{telemetry-data-collection-book-title}]. You might also require to create your own telemetry data collection notice for your application users. ==== diff --git a/modules/proc-create-plugin.adoc b/modules/proc-create-plugin.adoc index b234338130..661bcc02fd 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:{LinkAdminGuide}({NameOfAdminGuide}). +* {product} application is installed and running. For more information, see link:{configuring-book-url}[{configuring-book-title}]). * `yarn` command and associated dependencies are installed. .Procedure diff --git a/modules/getting-started/proc-enable-servicenow-custom-actions-plugin.adoc b/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc similarity index 100% rename from modules/getting-started/proc-enable-servicenow-custom-actions-plugin.adoc rename to modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc diff --git a/modules/getting-started/ref-supported-servicenow-custom-actions.adoc b/modules/using-service-now/ref-supported-servicenow-custom-actions.adoc similarity index 100% rename from modules/getting-started/ref-supported-servicenow-custom-actions.adoc rename to modules/using-service-now/ref-supported-servicenow-custom-actions.adoc diff --git a/titles/about/master.adoc b/titles/about/master.adoc index dc61642f29..501f4e120a 100644 --- a/titles/about/master.adoc +++ b/titles/about/master.adoc @@ -5,10 +5,4 @@ include::artifacts/attributes.adoc[] :subtitle: Introduction to {product} :abstract: {product} is a developer platform designed to build developer portals. Use {product} to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently. -//[id="{context}"] -//= {title} - -//{abstract} - - include::assemblies/assembly-about-rhdh.adoc[] diff --git a/titles/admin-rhdh/docinfo.xml b/titles/admin-rhdh/docinfo.xml deleted file mode 100644 index f86bb2f376..0000000000 --- a/titles/admin-rhdh/docinfo.xml +++ /dev/null @@ -1,12 +0,0 @@ -Administration guide for {product} -{product} -{product-version} - - - - {product} is an enterprise-grade platform for building developer portals. As an administrative user, you can manage roles and permissions of other users and configure {product-short} to meet the specific needs of your organization. - - - {company-name} Customer Content Services - - diff --git a/titles/admin-rhdh/master.adoc b/titles/admin-rhdh/master.adoc deleted file mode 100644 index e9369eb549..0000000000 --- a/titles/admin-rhdh/master.adoc +++ /dev/null @@ -1 +0,0 @@ -include::title-admin.adoc[] \ No newline at end of file diff --git a/titles/admin-rhdh/title-admin.adoc b/titles/admin-rhdh/title-admin.adoc index f35bdaa36c..e69de29bb2 100644 --- a/titles/admin-rhdh/title-admin.adoc +++ b/titles/admin-rhdh/title-admin.adoc @@ -1,44 +0,0 @@ -[id="title-admin"] -include::artifacts/attributes.adoc[] -= Administration guide for {product} -:context: admin-rhdh -:imagesdir: images - -{product} is an enterprise-grade, open developer platform that you can use to build developer portals. This platform contains a supported and opinionated framework that helps reduce the friction and frustration of developers while boosting their productivity. - -//add a custom application config file to OCP -include::assemblies/assembly-add-custom-app-file-openshift.adoc[leveloffset=+1] - -// configure PostgreSQL database -include::assemblies/assembly-configuring-external-postgresql-databases.adoc[leveloffset=+1] - -// configure RHDH with TLS in kubernetes -include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc[leveloffset=+1] - -//configure dynamic plugins - moved to configuring plugins guide -// include::modules/installation/proc-config-dynamic-plugins-rhdh-operator.adoc[leveloffset=+1] - -//Telemetry data collection -//include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 - -// Observability -//include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 - -// Running RHDH behind a proxy -include::assemblies/assembly-running-rhdh-behind-a-proxy.adoc[leveloffset=+1] - -//aws integration -include::assemblies/assembly-rhdh-integration-aws.adoc[leveloffset=+1] - -//aks integration -//include::assemblies/assembly-rhdh-integration-aks.adoc[leveloffset=+1] // Removing assembly since the all of the content does not exist in admin guide - -// Managing templates -include::assemblies/assembly-admin-templates.adoc[leveloffset=+1] - -// techdocs plugin -include::assemblies/assembly-techdocs-plugin.adoc[leveloffset=+1] - -// RHDH Operator deployment -include::modules/admin/proc-rhdh-deployment-config.adoc[leveloffset=+1] -include::modules/admin/proc-mount-directories-pvcs.adoc[leveloffset=+2] diff --git a/titles/configuring/artifacts b/titles/configuring/artifacts new file mode 120000 index 0000000000..04f3a24af5 --- /dev/null +++ b/titles/configuring/artifacts @@ -0,0 +1 @@ +../../artifacts/ \ No newline at end of file diff --git a/titles/configuring/assemblies b/titles/configuring/assemblies new file mode 120000 index 0000000000..51bb510220 --- /dev/null +++ b/titles/configuring/assemblies @@ -0,0 +1 @@ +../../assemblies/ \ No newline at end of file diff --git a/titles/configuring/docinfo.xml b/titles/configuring/docinfo.xml new file mode 120000 index 0000000000..fecb543b13 --- /dev/null +++ b/titles/configuring/docinfo.xml @@ -0,0 +1 @@ +../../artifacts/docinfo.xml \ No newline at end of file diff --git a/titles/admin-rhdh/images b/titles/configuring/images similarity index 100% rename from titles/admin-rhdh/images rename to titles/configuring/images diff --git a/titles/configuring/master.adoc b/titles/configuring/master.adoc new file mode 100644 index 0000000000..82b772f476 --- /dev/null +++ b/titles/configuring/master.adoc @@ -0,0 +1,31 @@ +include::artifacts/attributes.adoc[] +:title: Configuring +:subtitle: Configuring {product} +:abstract: Learn how to configure {product} for production to work in your IT ecosystem by adding custom config maps and secrets. +:context: configuring-and-operating +[id="{context}"] += {title} + +{abstract} + + +include::assemblies/assembly-provisioning-a-custom-configuration.adoc[leveloffset=+1] + + +include::assemblies/assembly-configuring-external-postgresql-databases.adoc[leveloffset=+1] + + +include::modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc[leveloffset=+1] + + +include::assemblies/assembly-configuring-a-proxy.adoc[leveloffset=+1] + + +include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc[leveloffset=+1] + + +include::modules/dynamic-plugins/con-dynamic-plugins-cache.adoc[ leveloffset=+1] + + +include::modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc[leveloffset=+1] + diff --git a/titles/admin-rhdh/modules b/titles/configuring/modules similarity index 100% rename from titles/admin-rhdh/modules rename to titles/configuring/modules diff --git a/titles/customizing/artifacts b/titles/customizing/artifacts new file mode 120000 index 0000000000..04f3a24af5 --- /dev/null +++ b/titles/customizing/artifacts @@ -0,0 +1 @@ +../../artifacts/ \ No newline at end of file diff --git a/titles/customizing/assemblies b/titles/customizing/assemblies new file mode 120000 index 0000000000..51bb510220 --- /dev/null +++ b/titles/customizing/assemblies @@ -0,0 +1 @@ +../../assemblies/ \ No newline at end of file diff --git a/titles/customizing/docinfo.xml b/titles/customizing/docinfo.xml new file mode 120000 index 0000000000..fecb543b13 --- /dev/null +++ b/titles/customizing/docinfo.xml @@ -0,0 +1 @@ +../../artifacts/docinfo.xml \ No newline at end of file diff --git a/titles/getting-started-rhdh/images b/titles/customizing/images similarity index 100% rename from titles/getting-started-rhdh/images rename to titles/customizing/images diff --git a/titles/customizing/master.adoc b/titles/customizing/master.adoc new file mode 100644 index 0000000000..869c0b6da2 --- /dev/null +++ b/titles/customizing/master.adoc @@ -0,0 +1,39 @@ +include::artifacts/attributes.adoc[] +:title: Customizing +:subtitle: Customizing {product} +:abstract: Learn to customize {product}, such as templates, learning paths, tech docs, tech radar, home page, quick access cards, and appearance. +:context: customizing-display +[id="{context}"] += {title} + +{abstract} + +include::modules/customizing/proc-customizing-your-product-title.adoc[leveloffset=+1] + + +include::modules/customizing/proc-customizing-your-product-base-url.adoc[leveloffset=+1] + + +include::modules/customizing/proc-customizing-the-backend-secret.adoc[leveloffset=+1] + + +include::assemblies/assembly-configuring-templates.adoc[leveloffset=+1] + + +include::modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths.adoc[leveloffset=+1] + + +include::assemblies/assembly-configuring-techdocs.adoc[leveloffset=+1] + + +include::modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc[leveloffset=+1] + + +include::assemblies/assembly-customizing-the-appearance.adoc[leveloffset=+1] + + +include::assemblies/assembly-customizing-the-homepage.adoc[leveloffset=+1] + + +include::assemblies/assembly-customizing-the-quick-access-card.adoc[leveloffset=+1] + diff --git a/titles/customizing/modules b/titles/customizing/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/titles/customizing/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/titles/getting-started-rhdh/artifacts b/titles/getting-started-rhdh/artifacts deleted file mode 120000 index f30b6dea60..0000000000 --- a/titles/getting-started-rhdh/artifacts +++ /dev/null @@ -1 +0,0 @@ -../../artifacts \ No newline at end of file diff --git a/titles/getting-started-rhdh/assemblies b/titles/getting-started-rhdh/assemblies deleted file mode 120000 index 91646274db..0000000000 --- a/titles/getting-started-rhdh/assemblies +++ /dev/null @@ -1 +0,0 @@ -../../assemblies \ No newline at end of file diff --git a/titles/getting-started-rhdh/docinfo.xml b/titles/getting-started-rhdh/docinfo.xml deleted file mode 100644 index f3d648c9e0..0000000000 --- a/titles/getting-started-rhdh/docinfo.xml +++ /dev/null @@ -1,12 +0,0 @@ -Getting started with {product} -{product} -{product-version} - - - - {product} is an enterprise-grade platform for building developer portals. You can configure and customize your {product-short} instance to meet your needs and preferences. - - - {company-name} Customer Content Services - - \ No newline at end of file diff --git a/titles/getting-started-rhdh/master.adoc b/titles/getting-started-rhdh/master.adoc deleted file mode 100644 index c8e00e16da..0000000000 --- a/titles/getting-started-rhdh/master.adoc +++ /dev/null @@ -1 +0,0 @@ -include::title-getting-started.adoc[] \ No newline at end of file diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc deleted file mode 100644 index 0f6db31721..0000000000 --- a/titles/getting-started-rhdh/title-getting-started.adoc +++ /dev/null @@ -1,27 +0,0 @@ -[id='title-getting-started'] -include::artifacts/attributes.adoc[] -= Getting started with {product} -:context: rhdh-getting-started -:imagesdir: images - -As a developer, you can use {product} to experience a streamlined development environment. {product} is driven by a centralized software catalog, providing efficiency to your microservices and infrastructure. It enables your product team to deliver quality code without any compromises. - -// supported configs and customization -include::modules/getting-started/ref-rhdh-supported-configs.adoc[leveloffset=+1] -include::assemblies/assembly-add-custom-app-file-openshift.adoc[leveloffset=+2] - -include::assemblies/assembly-bulk-importing-from-github.adoc[leveloffset=+1] - -include::assemblies/assembly-customizing-the-rhdh-homepage.adoc[leveloffset=+1] -include::assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc[leveloffset=+1] -include::modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc[leveloffset=+1] -include::modules/getting-started/proc-customize-rhdh-learning-paths.adoc[leveloffset=+1] - -include::assemblies/assembly-customize-rhdh-theme.adoc[leveloffset=+1] - -include::modules/getting-started/con-servicenow-custom-actions.adoc[leveloffset=+1] -include::modules/getting-started/proc-enable-servicenow-custom-actions-plugin.adoc[leveloffset=+2] -include::modules/getting-started/ref-supported-servicenow-custom-actions.adoc[leveloffset=+2] - -// Audit logging -//include::assemblies/assembly-audit-log.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 diff --git a/titles/install-rhdh-aks/master.adoc b/titles/install-rhdh-aks/master.adoc index 83bdd05565..f04de833c2 100644 --- a/titles/install-rhdh-aks/master.adoc +++ b/titles/install-rhdh-aks/master.adoc @@ -17,3 +17,4 @@ include::modules/installation/proc-rhdh-deploy-aks-operator.adoc[leveloffset=+1] // Helm chart method include::modules/installation/proc-rhdh-deploy-aks-helm.adoc[leveloffset=+1] + diff --git a/titles/admin-rhdh/artifacts b/titles/installation-rhdh/artifacts similarity index 100% rename from titles/admin-rhdh/artifacts rename to titles/installation-rhdh/artifacts diff --git a/titles/admin-rhdh/assemblies b/titles/installation-rhdh/assemblies similarity index 100% rename from titles/admin-rhdh/assemblies rename to titles/installation-rhdh/assemblies diff --git a/titles/installation-rhdh/images b/titles/installation-rhdh/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/installation-rhdh/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/getting-started-rhdh/modules b/titles/installation-rhdh/modules similarity index 100% rename from titles/getting-started-rhdh/modules rename to titles/installation-rhdh/modules