Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@
:developer-lightspeed-book-link: {product-docs-link}/html-single/interacting_with_red_hat_developer_lightspeed_for_red_hat_developer_hub/index
:developer-lightspeed-book-title: Interacting with {ls-brand-name}
:discover-category-link: {product-docs-link}/#Discover
:dynamic-plugins-default-yaml-link: link:https://github.com/redhat-developer/rhdh/blob/release-{product-version}/dynamic-plugins.default.yaml
:dynamic-plugins-reference-book-link: {product-docs-link}/html-single/dynamic_plugins_reference/index
:dynamic-plugins-reference-book-title: Dynamic plugins reference
:extend-category-link: {product-docs-link}/#Extend
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
:_mod-docs-content-type: CONCEPT

// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.

[id="preinstalled-dynamic-plugins_{context}"]
= Preinstalled dynamic plugins

Expand Down Expand Up @@ -35,7 +37,7 @@ Upon application startup, for each plugin that is disabled by default, the `inst

To enable this plugin, add a package with the same name to the Helm chart and change the value in the `disabled` field to `false`. For example:

[source,java]
[source,yaml]
----
global:
dynamic:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ include::{docdir}/artifacts/snip-tag-for-sha256-tip.adoc[]
|1.0.2|`./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd-backend`
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd-backend:<tag>`

|*{azure-short} DevOps Backend*
|*Azure DevOps Backend*
|0.23.0|`./dynamic-plugins/dist/backstage-community-plugin-azure-devops-backend`
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-azure-devops-backend:<tag>`

|*Catalog Backend Module {azure-short} DevOps Annotator Processor*
|*Catalog Backend Module Azure DevOps Annotator Processor*
|0.14.0|`./dynamic-plugins/dist/bcp-ctlg-backend-mod-azure-devops-annotator-processor`
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-catalog-backend-module-azure-devops-annotator-processor:<tag>`

Expand Down Expand Up @@ -176,7 +176,7 @@ include::{docdir}/artifacts/snip-tag-for-sha256-tip.adoc[]
|1.8.1|`./dynamic-plugins/dist/roadiehq-scaffolder-backend-argocd`
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-argocd:<tag>`

|*Scaffolder Backend Module {azure-short} DevOps*
|*Scaffolder Backend Module Azure DevOps*
|0.18.0|`./dynamic-plugins/dist/bcp-scaffolder-backend-mod-azure-devops`
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-azure-devops:<tag>`

Expand Down Expand Up @@ -212,7 +212,7 @@ include::{docdir}/artifacts/snip-tag-for-sha256-tip.adoc[]
|4.1.1|`./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-utils`
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-module-utils:<tag>`

|*Search Backend Module {azure-short} DevOps*
|*Search Backend Module Azure DevOps*
|0.1.2|`./dynamic-plugins/dist/bcp-search-backend-mod-azure-devops`
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-search-backend-module-azure-devops:<tag>`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,32 +1 @@
:_mod-docs-content-type: REFERENCE

// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
// cd /path/to/rhdh-documentation; ./modules/dynamic-plugins-reference/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html

[id="deprecated-plugins_{context}"]
= Deprecated plugins

[role="_abstract"]
{product} ({product-very-short}) includes several deprecated plugins, which are no longer being actively developed. Migrate to an alternative solution as soon as possible, because these plugins will be removed in a future release.

{product-very-short} includes the following 2 deprecated plugins:

[%header,cols=4*]
|===
|*Name* |*Plugin* |*Version* |*Path and required variables*
|OCM |`https://npmjs.com/package/@backstage-community/plugin-ocm/v/5.11.1[@backstage-community/plugin-ocm]` |5.11.1
|`./dynamic-plugins/dist/backstage-community-plugin-ocm`


|OCM |`https://npmjs.com/package/@backstage-community/plugin-ocm-backend/v/5.12.2[@backstage-community/plugin-ocm-backend]` |5.12.2
|`./dynamic-plugins/dist/backstage-community-plugin-ocm-backend-dynamic`

`OCM_HUB_NAME`

`OCM_HUB_URL`

`OCM_SA_TOKEN`


|===

Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
:_mod-docs-content-type: REFERENCE

// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
// cd /path/to/rhdh-documentation; ./modules/dynamic-plugins-reference/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html

[id="supported-plugins_{context}"]
= {company-name} supported plugins

[role="_abstract"]
{company-name} provides full support for the following 32 dynamic plugins:
{company-name} provides full support for the following 32 dynamic plugins.

[%header,cols=4*]
|===
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
:_mod-docs-content-type: REFERENCE

// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
// cd /path/to/rhdh-documentation; ./modules/dynamic-plugins-reference/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html

[id="technology-preview-plugins_{context}"]
= {company-name} {technology-preview} plugins

[role="_abstract"]
{company-name} provides {technology-preview} support for the following 16 plugins:
{company-name} provides {technology-preview} support for the following 16 plugins.

include::../../artifacts/snip-technology-preview.adoc[]

Expand All @@ -31,15 +31,15 @@ include::../../artifacts/snip-technology-preview.adoc[]
`GITHUB_WEBHOOK_SECRET`


|Extensions |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-extensions/v/0.14.3[@red-hat-developer-hub/backstage-plugin-extensions]` |0.14.3
|Extensions |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-extensions/v/0.15.0[@red-hat-developer-hub/backstage-plugin-extensions]` |0.15.0
|`./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions`


|Extensions |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-catalog-backend-module-extensions/v/0.14.3[@red-hat-developer-hub/backstage-plugin-catalog-backend-module-extensions]` |0.14.3
|Extensions |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-catalog-backend-module-extensions/v/0.15.0[@red-hat-developer-hub/backstage-plugin-catalog-backend-module-extensions]` |0.15.0
|`./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-catalog-backend-module-extensions-dynamic`


|Extensions |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-extensions-backend/v/0.14.3[@red-hat-developer-hub/backstage-plugin-extensions-backend]` |0.14.3
|Extensions |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-extensions-backend/v/0.15.0[@red-hat-developer-hub/backstage-plugin-extensions-backend]` |0.15.0
|`./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions-backend-dynamic`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
"Bulk Import","@red-hat-developer-hub/backstage-plugin-bulk-import","Frontend","7.0.1","Red Hat Tech Preview","active","./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import",";","Disabled"
"Bulk Import","@red-hat-developer-hub/backstage-plugin-bulk-import-backend","Backend","7.0.1","Red Hat Tech Preview","active","./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic",";","Disabled"
"Events Backend Module GitHub","@backstage/plugin-events-backend-module-github","Backend","0.4.6","Red Hat Tech Preview","active","oci://quay.io/rhdh/backstage-plugin-events-backend-module-github@sha256:c1d17d47aaac41eaeb3ad15c64d904cbad7d93f351cdd69d7aee13b2097329ed","`GITHUB_WEBHOOK_SECRET`;","Disabled"
"Extensions","@red-hat-developer-hub/backstage-plugin-extensions","Frontend","0.14.3","Red Hat Tech Preview","active","./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions",";","Enabled"
"Extensions","@red-hat-developer-hub/backstage-plugin-catalog-backend-module-extensions","Backend","0.14.3","Red Hat Tech Preview","active","./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-catalog-backend-module-extensions-dynamic",";","Enabled"
"Extensions","@red-hat-developer-hub/backstage-plugin-extensions-backend","Backend","0.14.3","Red Hat Tech Preview","active","./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions-backend-dynamic",";","Enabled"
"Extensions","@red-hat-developer-hub/backstage-plugin-extensions","Frontend","0.15.0","Red Hat Tech Preview","active","./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions",";","Enabled"
"Extensions","@red-hat-developer-hub/backstage-plugin-catalog-backend-module-extensions","Backend","0.15.0","Red Hat Tech Preview","active","./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-catalog-backend-module-extensions-dynamic",";","Enabled"
"Extensions","@red-hat-developer-hub/backstage-plugin-extensions-backend","Backend","0.15.0","Red Hat Tech Preview","active","./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions-backend-dynamic",";","Enabled"
"GitLab","@backstage/plugin-scaffolder-backend-module-gitlab","Backend","0.10.0","Red Hat Tech Preview","active","./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gitlab-dynamic",";","Disabled"
"Kubernetes","@backstage/plugin-kubernetes","Frontend","0.12.13","Red Hat Tech Preview","active","./dynamic-plugins/dist/backstage-plugin-kubernetes",";","Disabled"
"Notifications","@backstage/plugin-notifications","Frontend","0.5.11","Red Hat Tech Preview","active","./dynamic-plugins/dist/backstage-plugin-notifications",";","Disabled"
Expand All @@ -44,5 +44,3 @@
"Pingidentity","@backstage-community/plugin-catalog-backend-module-pingidentity","Backend","0.9.0","Red Hat Tech Preview","active","./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-pingidentity-dynamic",";","Disabled"
"Scaffolder Relation Processor","@backstage-community/plugin-catalog-backend-module-scaffolder-relation-processor","Backend","2.11.0","Red Hat Tech Preview","active","./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-scaffolder-relation-processor-dynamic",";","Disabled"
"Signals","@backstage/plugin-signals","Frontend","0.0.25","Red Hat Tech Preview","active","./dynamic-plugins/dist/backstage-plugin-signals",";","Disabled"
"OCM","@backstage-community/plugin-ocm","Frontend","5.11.1","Production","deprecated","./dynamic-plugins/dist/backstage-community-plugin-ocm",";","Disabled"
"OCM","@backstage-community/plugin-ocm-backend","Backend","5.12.2","Production","deprecated","./dynamic-plugins/dist/backstage-community-plugin-ocm-backend-dynamic","`OCM_HUB_NAME`;`OCM_HUB_URL`;`OCM_SA_TOKEN`;","Disabled"
32 changes: 14 additions & 18 deletions modules/extend_dynamic-plugins-reference/rhdh-supported-plugins.sh
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ generate_dynamic_plugins_table() {
fi
jq -r '.dependencies' "${rhdhtmpdir}"/packages/{app,backend}/package.json | grep -E -v "\"\*\"|\{|\}" | grep "@" | tr -d "," >> "$pluginVersFile"
# Use LC_ALL=C for consistent sorting across different locales
cat "$pluginVersFile" | sort -u > "$pluginVersFile".out; mv -f "$pluginVersFile".out "$pluginVersFile"
sort -u "$pluginVersFile" > "$pluginVersFile".out; mv -f "$pluginVersFile".out "$pluginVersFile"

rm -fr /tmp/warnings_"${BRANCH}".txt

Expand Down Expand Up @@ -243,20 +243,6 @@ generate_dynamic_plugins_table() {
[[ $Plugin == "@redhat"* ]] && [[ $(yq -r '.spec.dynamicArtifact // ""' "$y") == "@redhat"* ]] && \
{ debug "Skip[3] Plugin = $Plugin\n"; continue; }

# DEPRECATED :: once wrappers are removed, we don't need this anymore
if [[ $Path ]] && [[ $Path == "./dynamic-plugins/dist/"* ]]; then
# shellcheck disable=SC2016
found_in_default_config1=$(yq -r --arg Path "${Path%-dynamic}" '.plugins[] | select(.package == $Path)' "${rhdhtmpdir}"/dynamic-plugins.default.yaml)
# shellcheck disable=SC2016
found_in_default_config2=$(yq -r --arg Path "${Path}" '.plugins[] | select(.package == $Path)' "${rhdhtmpdir}"/dynamic-plugins.default.yaml)
Path2=$(echo "$found_in_default_config2" | jq -r '.package') # with -dynamic suffix
if [[ $Path2 ]]; then
Path=$Path2
else
Path=$(echo "$found_in_default_config1" | jq -r '.package') # without -dynamic suffix
fi
fi

# For extensions YAML files, skip the default config check for inclusion
if [[ "$y" == *"/metadata/"* ]]; then
# Process extensions packages regardless of default config
Expand Down Expand Up @@ -439,9 +425,6 @@ generate_dynamic_plugins_table() {
fi
csv_key="$SupportSort-$PrettyName-$RoleSort-$Role-$Plugin"
echo "$csv_key|$csv_content" >> "$TEMP_DIR/csv.tmp"
else
(( tot-- )) || true
echo -e "${blue} Skip: not in rhdh/dynamic-plugins.default.yaml !${norm}"
fi
echo
done
Expand Down Expand Up @@ -725,6 +708,19 @@ popd >/dev/null || exit
# see https://issues.redhat.com/browse/RHIDP-3187 - only GA plugins should be enabled by default
if [[ -f "${ENABLED_PLUGINS}.errors" ]]; then echo;sort -u "${ENABLED_PLUGINS}.errors"; fi

# clean up CQA warnings
pushd "${SCRIPT_DIR}"/../.. >/dev/null || exit
for d in \
ref-community-plugins-migration-to-the-github-container-registry.adoc \
ref-deprecated-plugins.adoc \
ref-other-installable-plugins.adoc \
ref-supported-plugins.adoc \
ref-technology-preview-plugins.adoc \
; do
./build/scripts/cqa-16-official-product-names.sh --fix modules/extend_dynamic-plugins-reference/$d >/dev/null 2>&1
done
popd >/dev/null || exit

# cleanup
rm -f "$ENABLED_PLUGINS" "${ENABLED_PLUGINS}.errors"
rm -rf "$TEMP_DIR"
Expand Down
3 changes: 2 additions & 1 deletion modules/shared/proc-configure-entity-detail-tab-layout.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Each {product} entity detail tab has a default opinionated layout. For consisten

.Prerequisites

* The plugin that contributes the tab content allows a configuration, such as {dynamic-plugins-default-yaml-link}[{product-short} plugins defining a default configuration in a `config` section].
// see more info in modules/shared/proc-enable-plugins-added-in-the-rhdh-container-image.adoc about how to get the default config from the index image
* The plugin that contributes the tab content can be configured to extend the default inherited configuration.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,72 @@ The {product-very-short} container image preinstalls a set of dynamic plugins to

You can enable and configure the plugins in the {product-very-short} container image. This includes how to manage the default configuration, set necessary environment variables, and ensure the proper functionality of the plugins within your application.

[IMPORTANT]
Since {product-very-short} 1.10, the latest version of the `dynamic-plugins.default.yaml` file exists in the plugin catalog index container image.

To retrieve the latest version of the `dynamic-plugins.default.yaml` file, run the following commands in your terminal:

[source,shell]
----
$ unpack () {
if [[ ! $1 ]]; then
echo "Usage: unpack reg/org/container:tagorsha [file(s)-to-unpack-pattern]"
echo "Example: unpack quay.io/rhdh/plugin-catalog-index:1.10 dynamic-plugins.default.yaml"
else
local FILES=""
if [[ $2 ]]; then FILES="$2"; fi
local IMAGE="$1"
local DIR="${IMAGE//:/_}"
DIR="/tmp/${DIR//\//-}"
rm -fr "$DIR"; mkdir -p "$DIR"; container_id=$(podman create "${IMAGE}")
podman export $container_id -o /tmp/image.tar && tar xf /tmp/image.tar -C "${DIR}/" $FILES; podman rm $container_id; rm -f /tmp/image.tar
echo "Unpacked $IMAGE into $DIR"
cd $DIR;
if [[ $FILES ]]; then ls -la $FILES; else tree -d -L 3 -I "usr|root|buildinfo"; fi
fi
}

$ unpack registry.access.redhat.com/rhdh/plugin-catalog-index:1.10 dynamic-plugins.default.yaml

# For a pre-GA CI container:
$ unpack quay.io/rhdh/plugin-catalog-index:1.10 dynamic-plugins.default.yaml

----

Alternatively, you can use an `oci://` plugin reference, and the special `{{inherit}}` tag will fetch the latest compatible plugin, including its default configuration, for your current {product-very-short} version.

.Prerequisites
* You have access to the link:https://github.com/redhat-developer/rhdh/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file, which lists all preinstalled plugins and their default configuration.
Comment thread
nickboldt marked this conversation as resolved.
* You have deployed the {product-very-short} application, and have access to the logs of the `install-dynamic-plugins` init container.
* You have the necessary permissions to change plugin configurations and access the application environment.
* You have identified and set the required environment variables referenced by the plugin's default configuration. You must define these environment variables in the Helm Chart or Operator configuration.

.Procedure
. Start your {product-very-short} application and access the logs of the `install-dynamic-plugins` init container within the {product-very-short} pod.
. Identify the {dynamic-plugins-reference-book-link}#red-hat-supported-plugins[Red Hat supported plugins] that the system disables by default.
. Copy the package configuration from the link:https://github.com/redhat-developer/rhdh/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file.
. Open the plugin configuration file and locate the plugin entry you want to enable.
. If you need to provide additional configuration for the plugin, other than enabling it, copy the package configuration from the `dynamic-plugins.default.yaml` file you extracted above. For plugins which require no configuration, you can simply reference the plugin and set it to `disabled:false` as in the example below.
. To use the latest compatible plugin version, use the special tag `{{inherit}}`; this will also load the default configuration, which you can then override.
. Open the plugin configuration file (Custom Resource or ConfigMap) and locate the plugin entry you want to enable.
+
The location of the plugin configuration file varies based on the deployment method. For more details, see {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}].
. Change the `disabled` field to `false` and add the package name as follows:
+

--
[source,yaml]
----
plugins:
- disabled: false
package: ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
- package: oci://registry.access.redhat.com/rhdh/backstage-community-plugin-analytics-provider-segment:{{inherit}}
disabled: false
----

or using the deprecated wrapper syntax:

[source,yaml]
----
plugins:
- package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
disabled: false
----

For more information about how to configure dynamic plugins in {product-short}, see {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}].
--

Expand Down
Loading