Skip to content

Commit db6f681

Browse files
authored
RHIDP-3440-reference 1.3 Add tables (#564)
1 parent 83e11e0 commit db6f681

File tree

5 files changed

+36
-37
lines changed

5 files changed

+36
-37
lines changed
Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,21 @@
11
[id="rhdh-installing-dynamic-plugins"]
22
= Dynamic plugin installation
3+
34
The dynamic plugin support is based on the backend plugin manager package, which is a service that scans a configured root directory (`dynamicPlugins.rootDirectory` in the app config) for dynamic plugin packages and loads them dynamically.
45

56
You can use the dynamic plugins that come preinstalled with {product} or install external dynamic plugins from a public NPM registry.
67

7-
//viewing installed plugins
8-
// Viewing installed plugins
9-
include::../modules/dynamic-plugins/proc-viewing-installed-plugins.adoc[leveloffset=+1]
10-
//preinstalled plugins
11-
128
// Preinstalled plugins
139
include::../modules/dynamic-plugins/con-preinstalled-dynamic-plugins.adoc[leveloffset=+1]
14-
// include::../modules/dynamic-plugins/rhdh-supported-plugins.adoc[leveloffset=+2]
15-
16-
//configure dynamic plugins - moved from admin guide
17-
//include::../modules/dynamic-plugins/rhdh-supported-plugins.adoc[leveloffset=+2]
1810

1911
// Dynamic plugins tables
20-
[id="rhdh-supported-plugins"]
21-
== Preinstalled dynamic plugin descriptions and details
2212

2313
// Red Hat Generally Available supported plugins
2414
include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+3]
2515

2616
[NOTE]
2717
====
28-
* For more information about configuring Keycloak, see xref:rhdh-keycloak_{context}[Installation and configuration of Keycloak].
18+
* For more information about configuring KeyCloak, see link:{plugins-configure-book-url}[{plugins-configure-book-title}].
2919
3020
* For more information about configuring TechDocs, see link:{LinkAdminGuide}#assembly-techdocs-plugin_{context}[Configuring the TechDocs plugin in {product}].
3121
====
@@ -39,7 +29,7 @@ include::../modules/dynamic-plugins/ref-rh-tech-preview-plugins.adoc[leveloffset
3929

4030
[NOTE]
4131
====
42-
* 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 compatible plugins] in the _{NameOfPluginsGuide} guide_ for further details.
32+
* 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].
4333
====
4434

4535
// Community plugins
@@ -48,19 +38,4 @@ include::../modules/dynamic-plugins/ref-community-plugins.adoc[leveloffset=+4]
4838

4939
// Red Hat compatible plugins
5040
[id="rhdh-compatible-plugins"]
51-
include::../modules/dynamic-plugins/ref-rh-compatible-plugins.adoc[leveloffset=+1]
52-
53-
54-
// Configure dynamic plugins - moved from admin guide
55-
include::../modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc[leveloffset=+1]
56-
57-
//helm installed plugins
58-
// Helm installed plugins
59-
include::../modules/dynamic-plugins/con-install-dynamic-plugin-helm.adoc[leveloffset=+1]
60-
include::../modules/dynamic-plugins/proc-obtaining-integrity-checksum.adoc[leveloffset=+2]
61-
include::../modules/dynamic-plugins/ref-example-dynamic-plugin-helm-installations.adoc[leveloffset=+2]
62-
include::../modules/dynamic-plugins/proc-rhdh-example-external-dynamic-plugins.adoc[leveloffset=+2]
63-
//include::../modules/dynamic-plugins/proc-rhdh-installing-external-dynamic-plugins-airgapped.adoc[leveloffset=+1]
64-
include::../modules/dynamic-plugins/proc-using-custom-npm-registry.adoc[leveloffset=+1]
65-
//basic plugin configuration
66-
include::../modules/dynamic-plugins/con-basic-config-dynamic-plugins.adoc[leveloffset=+1]
41+
include::../modules/dynamic-plugins/ref-rh-compatible-plugins.adoc[leveloffset=+1]

modules/dynamic-plugins/con-preinstalled-dynamic-plugins.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
= Preinstalled dynamic plugins
44

5-
{product} is preinstalled with a selection of dynamic plugins. For a complete list of dynamic plugins that are included in this release of {product-short}, see the xref:rhdh-supported-plugins[Dynamic plugins support matrix].
5+
{product} is preinstalled with a selection of dynamic plugins.
6+
//For a complete list of dynamic plugins that are included in this release of {product-short}, see the xref:rhdh-supported-plugins[Dynamic plugins support matrix].
67

78
The following preinstalled dynamic plugins are enabled by default:
89

@@ -12,8 +13,6 @@ The following preinstalled dynamic plugins are enabled by default:
1213
* `@backstage/plugin-techdocs-backend`
1314
* `@backstage/plugin-techdocs`
1415

15-
The dynamic plugins that require custom configuration are disabled by default.
16-
1716
Upon application startup, for each plugin that is disabled by default, the `install-dynamic-plugins init container` within the {product-short} pod log displays a message similar to the following:
1817

1918
[source,yaml]

modules/dynamic-plugins/ref-rh-compatible-plugins.adoc

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,34 @@
11
// 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.
22
// cd /path/to/rhdh-documentation; ./modules/dynamic-plugins/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html
33

4-
= Other compatible installable plugins
4+
= Other installable plugins
55

6-
{product-very-short} provides Technology Preview support for the following compatible plugins, which are not preinstalled and must be enabled from an external source:
6+
The following Technology Preview plugins are not preinstalled and must be installed from an external source:
77

8+
[%header,cols=4*]
9+
|===
10+
|*Name* |*Plugin*|*Version* |*Installation Details*
11+
12+
|Ansible Automation Platform Frontend|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap]` |1.0.0
13+
| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
14+
15+
|Ansible Automation Platform
16+
| `https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap-backend]` |1.0.0 |
17+
18+
|Ansible Automation Platform Scaffolder Backend
19+
|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-scaffolder-backend-module-backstage-rhaap]` |1.0.0 |
20+
21+
22+
|Orchestrator Frontend|`https://www.npmjs.com/package/@janus-idp/backstage-plugin-orchestrator[@janus-idp/backstage-plugin-orchestrator]` |1.22.6| https://www.parodos.dev/1.2-rc/docs/[Learn more]
23+
24+
|Orchestrator Backend
25+
|`https://www.npmjs.com/package/@janus-idp/backstage-plugin-orchestrator-backend-dynamic[@janus-idp/backstage-plugin-orchestrator-backend-dynamic]` |1.22.9 |
26+
27+
28+
|===
29+
30+
// Without description - for consistency i.e. no descriptions in other table and we provide a 'Learn more' link to plugin documentation for users' convenience.
31+
////
832
[%header,cols=5*]
933
|===
1034
|*Name* |*Description*|*Plugin*|*Version* |*Installation Details*
@@ -31,6 +55,7 @@
3155
3256
3357
|===
58+
////
3459

3560
[NOTE]
3661
====

titles/plugins-rhdh-reference/docinfo.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>{subtitle}
4+
<subtitle>
55
</subtitle>
66
<abstract>
77
<para>{abstract}</para>

titles/plugins-rhdh-reference/master.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ include::artifacts/attributes.adoc[]
33
:doctype: book
44
:imagesdir: images
55

6-
:title: Dynamic plugins in {product}
6+
:title: Dynamic plugins reference
77
:subtitle: Working with plugins in {product-very-short}
88
:abstract: {product} is preinstalled with a selection of dynamic plugins that users can enable and configure to extend {product-very-short} functionality.
99

10-
include::assemblies/dynamic-plugins/assembly-reference-rhdh-plugins.adoc[]
10+
include::assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc[]

0 commit comments

Comments
 (0)