From 8f60da49bf72a5755cdbf522fe431889231ee3f0 Mon Sep 17 00:00:00 2001 From: Gerry-Forde Date: Fri, 29 Nov 2024 15:45:51 +0000 Subject: [PATCH] RHIDP-4768 - Plugins should be able to know on which Backstage they are running on. --- .../assembly-installing-rhdh-plugins.adoc | 3 +++ ...-identifying-backstage-flavor-for-plugins.adoc | 15 +++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 modules/dynamic-plugins/proc-identifying-backstage-flavor-for-plugins.adoc diff --git a/assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc b/assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc index 70b58f271b..f32f768081 100644 --- a/assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc +++ b/assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc @@ -21,5 +21,8 @@ include::../modules/dynamic-plugins/proc-using-custom-npm-registry.adoc[leveloff // Viewing installed plugins include::../modules/dynamic-plugins/proc-viewing-installed-plugins.adoc[leveloffset=+1] +// Identifying Backstage flavor for plugins +include::../modules/dynamic-plugins/proc-identifying-backstage-flavor-for-plugins.adoc[leveloffset=+1] + //basic plugin configuration //include::../modules/dynamic-plugins/con-basic-config-dynamic-plugins.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/dynamic-plugins/proc-identifying-backstage-flavor-for-plugins.adoc b/modules/dynamic-plugins/proc-identifying-backstage-flavor-for-plugins.adoc new file mode 100644 index 0000000000..a41a5a5052 --- /dev/null +++ b/modules/dynamic-plugins/proc-identifying-backstage-flavor-for-plugins.adoc @@ -0,0 +1,15 @@ +[id="proc-identifying-backstage-flavor-for-plugins_{context}"] += Identifying Backstage flavor for plugins + +You can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, RHTAP, or vanilla Backstage, as shown in the following example: + +.`app-config.yaml` fragment with the `developerhub.flavor` field + +[source,yaml] +---- +developerHub: + flavor: +---- + +`flavor`:: +Identify the flavor of Backstage that is running. Default value: `rhdh` \ No newline at end of file