From 68472e2109dda15c40705d24ddafb6c7418497ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 3 Apr 2025 16:43:19 +0200 Subject: [PATCH 1/2] RHIDP-5604 Configuring entity tab titles and entity detail tab layout (#903) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * RHIDP-5604 Configuring Entity Page widgets and tabs layout Signed-off-by: Fabrice Flore-Thébault RHIDP-6149: Supported platform list in installation docs (#1054) * RHIDP-6149: Supported platform list in installation docs * Review comment incorporated Configuring default configuration Configuring default configuration Configurable PVC mounting Configurable PVC mounting Incorporate technical suggestions Incorporate technical suggestions Configuring default configuration Configuring default configuration Configuring default configuration Configuring default configuration --- ...configuring-default-secret-pvc-mounts.adoc | 9 ++++ .../assembly-customizing-the-appearance.adoc | 6 +++ .../proc-configuring-mount-paths.adoc | 42 ++++++++++++++++ .../proc-mounting-to-specific-containers.adoc | 43 ++++++++++++++++ ...-customizing-entity-detail-tab-layout.adoc | 50 +++++++++++++++++++ .../proc-customizing-entity-tab-titles.adoc | 42 ++++++++++++++++ .../installation/proc-install-operator.adoc | 8 +-- titles/configuring/master.adoc | 3 ++ 8 files changed, 196 insertions(+), 7 deletions(-) create mode 100644 assemblies/assembly-configuring-default-secret-pvc-mounts.adoc create mode 100644 modules/configuring-external-databases/proc-configuring-mount-paths.adoc create mode 100644 modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc create mode 100644 modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc create mode 100644 modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc diff --git a/assemblies/assembly-configuring-default-secret-pvc-mounts.adoc b/assemblies/assembly-configuring-default-secret-pvc-mounts.adoc new file mode 100644 index 0000000000..42439c19eb --- /dev/null +++ b/assemblies/assembly-configuring-default-secret-pvc-mounts.adoc @@ -0,0 +1,9 @@ +:_mod-docs-content-type: ASSEMBLY +[id="assembly-configuring-default-secret-pvc-mounts_{context}"] += Configuring default mounts for Secrets and PVCs + +You can configure where Persistent Volume Claims (PVCs) and Secrets mount in your {product} deployment. Use annotations to define the custom mount paths and specify the containers to mount them to. + +include::modules/configuring-external-databases/proc-configuring-mount-paths.adoc[leveloffset=+1] + +include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-customizing-the-appearance.adoc b/assemblies/assembly-customizing-the-appearance.adoc index dc1be2a9fd..a452248f78 100644 --- a/assemblies/assembly-customizing-the-appearance.adoc +++ b/assemblies/assembly-customizing-the-appearance.adoc @@ -28,6 +28,12 @@ include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.ad include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1] +include::modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc[leveloffset=+1] + + +include::modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc[leveloffset=+1] + + include::modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc[leveloffset=+1] diff --git a/modules/configuring-external-databases/proc-configuring-mount-paths.adoc b/modules/configuring-external-databases/proc-configuring-mount-paths.adoc new file mode 100644 index 0000000000..a8ec412ef7 --- /dev/null +++ b/modules/configuring-external-databases/proc-configuring-mount-paths.adoc @@ -0,0 +1,42 @@ +:_mod-docs-content-type: PROCEDURE +[id="proc-configure-mount-path-secrets-pvcs_{context}"] += Configuring mount paths for Secrets and PVCs + +By default, the mount path is the {product-short} container's working directory. If you do not define the mount path, it defaults to `/opt/app-root/src`. + +You can add the `rhdh.redhat.com/mount-path` annotation to specify a custom path. + +.Procedure + +. To specify a PVC mount path, add the `rhdh.redhat.com/mount-path` annotation to your configuration file as shown in the following example: ++ +.Example specifying where the PVC mounts +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: __ + annotations: + rhdh.redhat.com/mount-path: /mount/path/from/annotation +---- +where: + +`rhdh.redhat.com/mount-path`:: Specifies which mount path the PVC mounts to (in this case, `/mount/path/from/annotation` directory). +:: Specifies the PVC to mount. + +. To specify a Secret mount path, add the `rhdh.redhat.com/mount-path` annotation to your configuration file as shown in the following example: ++ +.Example specifying where the Secret mounts +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: v1 +kind: Secret +metadata: + name: __ + annotations: + rhdh.redhat.com/mount-path: /mount/path/from/annotation +---- +where: + +:: Specifies the Secret name. \ No newline at end of file diff --git a/modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc b/modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc new file mode 100644 index 0000000000..f8e957f9e8 --- /dev/null +++ b/modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc @@ -0,0 +1,43 @@ +:_mod-docs-content-type: PROCEDURE +[id="proc-mount-secrets-pvcs-specific-containers_{context}"] += Mounting Secrets and PVCs to specific containers + +By default, Secrets and PVCs mount only to the {product} `backstage-backend` container. You can add the `rhdh.redhat.com/containers` annotation to your configuration file to specify the containers to mount to. + +.Procedure + +. To mount Secrets to *all* containers, set the `rhdh.redhat.com/containers` annotation to `*`: ++ +.Example mounting to all containers +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: v1 +kind: Secret +metadata: + name: __ + annotations: + rhdh.redhat.com/containers: `*` +---- ++ +[IMPORTANT] +==== +Set `rhdh.redhat.com/containers` to `*` to mount it to all containers in the deployment. +==== + +. To mount to specific containers, separate the names with commas: ++ +.Example separating the list of containers +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: myclaim + annotations: + rhdh.redhat.com/containers: "init-dynamic-plugins,backstage-backend" +---- ++ +[NOTE] +==== +This configuration mounts the `myclaim` PVC to the `init-dynamic-plugins` and `backstage-backend` containers. +==== \ No newline at end of file diff --git a/modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc b/modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc new file mode 100644 index 0000000000..16ada838b6 --- /dev/null +++ b/modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc @@ -0,0 +1,50 @@ +[id="configuring-entity-detail-tab-layout_{context}"] += Configuring entity detail tab layout + +Each {product} entity detail tab has a default opinionated layout. +For consistency with your organization needs, you can change the entity detail tab content when the plugin that contributes the tab content allows a configuration. + +.Prerequisites + +* The plugin that contributes the tab content allows a configuration, such as https://github.com/redhat-developer/rhdh/blob/release-{product-version}/dynamic-plugins.default.yaml[{product-short} plugins defining a default configuration in a `config` section]. + +.Procedure + +* Copy the plugin default configuration in your `{my-app-config-file}` file, and change the `layout` properties. ++ +[source,yaml,subs="+quotes"] +---- +global: + dynamic: + plugins: + - package: __ + disabled: false + pluginConfig: + dynamicPlugins: + frontend: + __: + mountPoints: + - mountPoint: __ + importName: __ + config: + layout: + gridColumn: + lg: span 6 + xs: span 12 +---- +`package`:: +Enter your package location, such as `./dynamic-plugins/dist/backstage-community-plugin-tekton`. + +`__`:: +Enter your plugin name, such as: `backstage-community.plugin-tekton`. + +`mountPoint`:: +Copy the mount point defined in the plugin default configuration, such as: `entity.page.ci/cards`. + +`importName`:: +Copy the import name defined in the plugin default configuration, such as: `TektonCI`. + +`layout`:: Enter your layout configuration. +The tab content is displayed in a responsive grid that uses a 12 column-grid and supports different breakpoints (`xs`, +`sm`, `md`, `lg`, `xl`) that can be specified for a CSS property, such as `gridColumn`. +The example uses 6 of the 12 columns to show two Tekton CI cards side-by-side on large (`lg`) screens (`span 6` columns) and show them among themselves (`xs` and above `span 12` columns). diff --git a/modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc b/modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc new file mode 100644 index 0000000000..85952723a7 --- /dev/null +++ b/modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc @@ -0,0 +1,42 @@ +[id="configuring-entity-tab-titles_{context}"] += Configuring entity tab titles + +{product} provides a default opinionated tab set for catalog entity views. +For consistency with your organization needs, you can rename, reorder, remove, and add tab titles. + +.Procedure +* For each tab to modify, enter your desired values in the `entityTabs` section in your `{my-app-config-file}` file: ++ +[source,yaml,subs="+quotes"] +---- +upstream: + backstage: + appConfig: + dynamicPlugins: + frontend: + __: + entityTabs: + - mountPoint: __ + path: __ + title: __ + priority: _<priority>_ +---- + +`_<plugin_name>_`:: +Enter the plugin name, such as `backstage-community.plugin-topology`. + +`mountPoint`:: +Enter the tab mountpoint, such as `entity.page.topology`. + +`path`:: +Enter the tab path, such as `/topology`. +`title`:: +Enter the tab title, such as `Topology`. + +`priority`:: +Optional. ++ +To reorder tabs, enter the tab priority, such as `42`. +Higher priority appears first. ++ +To remove a tab, enter a negative value, such as `-1`. diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc index 884b2000fa..bae5470a1e 100644 --- a/modules/installation/proc-install-operator.adoc +++ b/modules/installation/proc-install-operator.adoc @@ -5,13 +5,7 @@ [id="proc-install-operator_{context}"] = Installing the {product} Operator -As an administrator, you can install the {product} Operator. Authorized users can use the Operator to install {product} on the following platforms: - -* {ocp-brand-name} ({ocp-short}) -* {eks-brand-name} ({eks-short}) -* {aks-brand-name} ({aks-short}) - -For more information on {ocp-short} supported versions, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle]. +As an administrator, you can install the {product} Operator. Authorized users can use the Operator to install {product} on {ocp-brand-name} ({ocp-short}) and supported Kubernetes platforms. For more information on supported platforms and versions, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle] page. Containers are available for the following CPU architectures: diff --git a/titles/configuring/master.adoc b/titles/configuring/master.adoc index 73ab3513eb..e2d611561f 100644 --- a/titles/configuring/master.adoc +++ b/titles/configuring/master.adoc @@ -33,5 +33,8 @@ include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kube include::modules/dynamic-plugins/con-dynamic-plugins-cache.adoc[ leveloffset=+1] +include::assemblies/assembly-configuring-default-secret-pvc-mounts.adoc[leveloffset=+1] + + include::modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc[leveloffset=+1] From b9ae8682a17b321b4a8a4d8f5d2d607a8417b69a Mon Sep 17 00:00:00 2001 From: GitHub Actions <github-actions@github.com> Date: Wed, 9 Apr 2025 16:27:41 +0200 Subject: [PATCH 2/2] Configuring default configuration --- .../assembly-customizing-the-appearance.adoc | 6 --- ...-customizing-entity-detail-tab-layout.adoc | 50 ------------------- .../proc-customizing-entity-tab-titles.adoc | 42 ---------------- .../installation/proc-install-operator.adoc | 8 ++- 4 files changed, 7 insertions(+), 99 deletions(-) delete mode 100644 modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc delete mode 100644 modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc diff --git a/assemblies/assembly-customizing-the-appearance.adoc b/assemblies/assembly-customizing-the-appearance.adoc index a452248f78..dc1be2a9fd 100644 --- a/assemblies/assembly-customizing-the-appearance.adoc +++ b/assemblies/assembly-customizing-the-appearance.adoc @@ -28,12 +28,6 @@ include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.ad include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1] -include::modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc[leveloffset=+1] - - -include::modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc[leveloffset=+1] - - include::modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc[leveloffset=+1] diff --git a/modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc b/modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc deleted file mode 100644 index 16ada838b6..0000000000 --- a/modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc +++ /dev/null @@ -1,50 +0,0 @@ -[id="configuring-entity-detail-tab-layout_{context}"] -= Configuring entity detail tab layout - -Each {product} entity detail tab has a default opinionated layout. -For consistency with your organization needs, you can change the entity detail tab content when the plugin that contributes the tab content allows a configuration. - -.Prerequisites - -* The plugin that contributes the tab content allows a configuration, such as https://github.com/redhat-developer/rhdh/blob/release-{product-version}/dynamic-plugins.default.yaml[{product-short} plugins defining a default configuration in a `config` section]. - -.Procedure - -* Copy the plugin default configuration in your `{my-app-config-file}` file, and change the `layout` properties. -+ -[source,yaml,subs="+quotes"] ----- -global: - dynamic: - plugins: - - package: _<package_location>_ - disabled: false - pluginConfig: - dynamicPlugins: - frontend: - _<plugin_name>_: - mountPoints: - - mountPoint: _<mount_point>_ - importName: _<import_name>_ - config: - layout: - gridColumn: - lg: span 6 - xs: span 12 ----- -`package`:: -Enter your package location, such as `./dynamic-plugins/dist/backstage-community-plugin-tekton`. - -`_<plugin_name>_`:: -Enter your plugin name, such as: `backstage-community.plugin-tekton`. - -`mountPoint`:: -Copy the mount point defined in the plugin default configuration, such as: `entity.page.ci/cards`. - -`importName`:: -Copy the import name defined in the plugin default configuration, such as: `TektonCI`. - -`layout`:: Enter your layout configuration. -The tab content is displayed in a responsive grid that uses a 12 column-grid and supports different breakpoints (`xs`, -`sm`, `md`, `lg`, `xl`) that can be specified for a CSS property, such as `gridColumn`. -The example uses 6 of the 12 columns to show two Tekton CI cards side-by-side on large (`lg`) screens (`span 6` columns) and show them among themselves (`xs` and above `span 12` columns). diff --git a/modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc b/modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc deleted file mode 100644 index 85952723a7..0000000000 --- a/modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc +++ /dev/null @@ -1,42 +0,0 @@ -[id="configuring-entity-tab-titles_{context}"] -= Configuring entity tab titles - -{product} provides a default opinionated tab set for catalog entity views. -For consistency with your organization needs, you can rename, reorder, remove, and add tab titles. - -.Procedure -* For each tab to modify, enter your desired values in the `entityTabs` section in your `{my-app-config-file}` file: -+ -[source,yaml,subs="+quotes"] ----- -upstream: - backstage: - appConfig: - dynamicPlugins: - frontend: - _<plugin_name>_: - entityTabs: - - mountPoint: _<mount_point>_ - path: _<path>_ - title: _<title>_ - priority: _<priority>_ ----- - -`_<plugin_name>_`:: -Enter the plugin name, such as `backstage-community.plugin-topology`. - -`mountPoint`:: -Enter the tab mountpoint, such as `entity.page.topology`. - -`path`:: -Enter the tab path, such as `/topology`. -`title`:: -Enter the tab title, such as `Topology`. - -`priority`:: -Optional. -+ -To reorder tabs, enter the tab priority, such as `42`. -Higher priority appears first. -+ -To remove a tab, enter a negative value, such as `-1`. diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc index bae5470a1e..884b2000fa 100644 --- a/modules/installation/proc-install-operator.adoc +++ b/modules/installation/proc-install-operator.adoc @@ -5,7 +5,13 @@ [id="proc-install-operator_{context}"] = Installing the {product} Operator -As an administrator, you can install the {product} Operator. Authorized users can use the Operator to install {product} on {ocp-brand-name} ({ocp-short}) and supported Kubernetes platforms. For more information on supported platforms and versions, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle] page. +As an administrator, you can install the {product} Operator. Authorized users can use the Operator to install {product} on the following platforms: + +* {ocp-brand-name} ({ocp-short}) +* {eks-brand-name} ({eks-short}) +* {aks-brand-name} ({aks-short}) + +For more information on {ocp-short} supported versions, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle]. Containers are available for the following CPU architectures: