Skip to content

Commit 68472e2

Browse files
themr0cGitHub Actions
themr0c
authored and
GitHub Actions
committed
RHIDP-5604 Configuring entity tab titles and entity detail tab layout (#903)
* RHIDP-5604 Configuring Entity Page widgets and tabs layout Signed-off-by: Fabrice Flore-Thébault <[email protected]> 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
1 parent 0ca9df1 commit 68472e2

File tree

8 files changed

+196
-7
lines changed

8 files changed

+196
-7
lines changed

‎assemblies/assembly-configuring-default-secret-pvc-mounts.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="assembly-configuring-default-secret-pvc-mounts_{context}"]
3+
= Configuring default mounts for Secrets and PVCs
4+
5+
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.
6+
7+
include::modules/configuring-external-databases/proc-configuring-mount-paths.adoc[leveloffset=+1]
8+
9+
include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+1]

‎assemblies/assembly-customizing-the-appearance.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.ad
2828
include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1]
2929

3030

31+
include::modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc[leveloffset=+1]
32+
33+
34+
include::modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc[leveloffset=+1]
35+
36+
3137
include::modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc[leveloffset=+1]
3238

3339

‎modules/configuring-external-databases/proc-configuring-mount-paths.adoc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-configure-mount-path-secrets-pvcs_{context}"]
3+
= Configuring mount paths for Secrets and PVCs
4+
5+
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`.
6+
7+
You can add the `rhdh.redhat.com/mount-path` annotation to specify a custom path.
8+
9+
.Procedure
10+
11+
. To specify a PVC mount path, add the `rhdh.redhat.com/mount-path` annotation to your configuration file as shown in the following example:
12+
+
13+
.Example specifying where the PVC mounts
14+
[source,yaml,subs="+attributes,+quotes"]
15+
----
16+
apiVersion: v1
17+
kind: PersistentVolumeClaim
18+
metadata:
19+
name: _<my_claim>_
20+
annotations:
21+
rhdh.redhat.com/mount-path: /mount/path/from/annotation
22+
----
23+
where:
24+
25+
`rhdh.redhat.com/mount-path`:: Specifies which mount path the PVC mounts to (in this case, `/mount/path/from/annotation` directory).
26+
<my_claim>:: Specifies the PVC to mount.
27+
28+
. To specify a Secret mount path, add the `rhdh.redhat.com/mount-path` annotation to your configuration file as shown in the following example:
29+
+
30+
.Example specifying where the Secret mounts
31+
[source,yaml,subs="+attributes,+quotes"]
32+
----
33+
apiVersion: v1
34+
kind: Secret
35+
metadata:
36+
name: _<my_secret>_
37+
annotations:
38+
rhdh.redhat.com/mount-path: /mount/path/from/annotation
39+
----
40+
where:
41+
42+
<my_secret>:: Specifies the Secret name.

‎modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-mount-secrets-pvcs-specific-containers_{context}"]
3+
= Mounting Secrets and PVCs to specific containers
4+
5+
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.
6+
7+
.Procedure
8+
9+
. To mount Secrets to *all* containers, set the `rhdh.redhat.com/containers` annotation to `*`:
10+
+
11+
.Example mounting to all containers
12+
[source,yaml,subs="+attributes,+quotes"]
13+
----
14+
apiVersion: v1
15+
kind: Secret
16+
metadata:
17+
name: _<my_secret>_
18+
annotations:
19+
rhdh.redhat.com/containers: `*`
20+
----
21+
+
22+
[IMPORTANT]
23+
====
24+
Set `rhdh.redhat.com/containers` to `*` to mount it to all containers in the deployment.
25+
====
26+
27+
. To mount to specific containers, separate the names with commas:
28+
+
29+
.Example separating the list of containers
30+
[source,yaml,subs="+attributes,+quotes"]
31+
----
32+
apiVersion: v1
33+
kind: PersistentVolumeClaim
34+
metadata:
35+
name: myclaim
36+
annotations:
37+
rhdh.redhat.com/containers: "init-dynamic-plugins,backstage-backend"
38+
----
39+
+
40+
[NOTE]
41+
====
42+
This configuration mounts the `myclaim` PVC to the `init-dynamic-plugins` and `backstage-backend` containers.
43+
====

‎modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
[id="configuring-entity-detail-tab-layout_{context}"]
2+
= Configuring entity detail tab layout
3+
4+
Each {product} entity detail tab has a default opinionated layout.
5+
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.
6+
7+
.Prerequisites
8+
9+
* 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].
10+
11+
.Procedure
12+
13+
* Copy the plugin default configuration in your `{my-app-config-file}` file, and change the `layout` properties.
14+
+
15+
[source,yaml,subs="+quotes"]
16+
----
17+
global:
18+
dynamic:
19+
plugins:
20+
- package: _<package_location>_
21+
disabled: false
22+
pluginConfig:
23+
dynamicPlugins:
24+
frontend:
25+
_<plugin_name>_:
26+
mountPoints:
27+
- mountPoint: _<mount_point>_
28+
importName: _<import_name>_
29+
config:
30+
layout:
31+
gridColumn:
32+
lg: span 6
33+
xs: span 12
34+
----
35+
`package`::
36+
Enter your package location, such as `./dynamic-plugins/dist/backstage-community-plugin-tekton`.
37+
38+
`_<plugin_name>_`::
39+
Enter your plugin name, such as: `backstage-community.plugin-tekton`.
40+
41+
`mountPoint`::
42+
Copy the mount point defined in the plugin default configuration, such as: `entity.page.ci/cards`.
43+
44+
`importName`::
45+
Copy the import name defined in the plugin default configuration, such as: `TektonCI`.
46+
47+
`layout`:: Enter your layout configuration.
48+
The tab content is displayed in a responsive grid that uses a 12 column-grid and supports different breakpoints (`xs`,
49+
`sm`, `md`, `lg`, `xl`) that can be specified for a CSS property, such as `gridColumn`.
50+
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).

‎modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[id="configuring-entity-tab-titles_{context}"]
2+
= Configuring entity tab titles
3+
4+
{product} provides a default opinionated tab set for catalog entity views.
5+
For consistency with your organization needs, you can rename, reorder, remove, and add tab titles.
6+
7+
.Procedure
8+
* For each tab to modify, enter your desired values in the `entityTabs` section in your `{my-app-config-file}` file:
9+
+
10+
[source,yaml,subs="+quotes"]
11+
----
12+
upstream:
13+
backstage:
14+
appConfig:
15+
dynamicPlugins:
16+
frontend:
17+
_<plugin_name>_:
18+
entityTabs:
19+
- mountPoint: _<mount_point>_
20+
path: _<path>_
21+
title: _<title>_
22+
priority: _<priority>_
23+
----
24+
25+
`_<plugin_name>_`::
26+
Enter the plugin name, such as `backstage-community.plugin-topology`.
27+
28+
`mountPoint`::
29+
Enter the tab mountpoint, such as `entity.page.topology`.
30+
31+
`path`::
32+
Enter the tab path, such as `/topology`.
33+
`title`::
34+
Enter the tab title, such as `Topology`.
35+
36+
`priority`::
37+
Optional.
38+
+
39+
To reorder tabs, enter the tab priority, such as `42`.
40+
Higher priority appears first.
41+
+
42+
To remove a tab, enter a negative value, such as `-1`.

‎modules/installation/proc-install-operator.adoc‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,7 @@
55
[id="proc-install-operator_{context}"]
66
= Installing the {product} Operator
77

8-
As an administrator, you can install the {product} Operator. Authorized users can use the Operator to install {product} on the following platforms:
9-
10-
* {ocp-brand-name} ({ocp-short})
11-
* {eks-brand-name} ({eks-short})
12-
* {aks-brand-name} ({aks-short})
13-
14-
For more information on {ocp-short} supported versions, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle].
8+
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.
159

1610
Containers are available for the following CPU architectures:
1711

‎titles/configuring/master.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,8 @@ include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kube
3333
include::modules/dynamic-plugins/con-dynamic-plugins-cache.adoc[ leveloffset=+1]
3434

3535

36+
include::assemblies/assembly-configuring-default-secret-pvc-mounts.adoc[leveloffset=+1]
37+
38+
3639
include::modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc[leveloffset=+1]
3740

0 commit comments

Comments
 (0)