Skip to content

Commit 7bb7816

Browse files
kim-tsaokim-tsao
committed
RHIDP-13538: add ENV VARS to community plugins table
Signed-off-by: Kim Tsao <ktsao@redhat.com>
1 parent 55910fc commit 7bb7816

2 files changed

Lines changed: 145 additions & 57 deletions

File tree

‎modules/extend_dynamic-plugins-reference/ref-community-supported-plugins.adoc‎

Lines changed: 124 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -22,136 +22,216 @@ Replace `<tag>` with the version tag corresponding to your {product-short} versi
2222
|*Path*
2323

2424
|*3Scale*
25-
|3.13.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-3scale-backend:<tag>`
25+
|3.13.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-3scale-backend:<tag>`|``THREESCALE_ACCESS_TOKEN`
26+
27+
`THREESCALE_BASE_URL`
28+
29+
`
2630

2731
|*ArgoCD Backend*
28-
|1.4.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd-backend:<tag>`
32+
|1.4.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd-backend:<tag>`|``ARGOCD_AUTH_TOKEN`
33+
34+
`ARGOCD_INSTANCE1_URL`
35+
36+
`ARGOCD_PASSWORD`
37+
38+
`ARGOCD_USERNAME`
39+
40+
`
2941

3042
|*Azure DevOps Backend*
31-
|0.27.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-azure-devops-backend:<tag>`
43+
|0.27.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-azure-devops-backend:<tag>`|``AZURE_ORG`
44+
45+
`AZURE_TOKEN`
46+
47+
`
3248

3349
|*Catalog Backend Module Azure DevOps Annotator Processor*
34-
|0.18.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-catalog-backend-module-azure-devops-annotator-processor:<tag>`
50+
|0.18.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-catalog-backend-module-azure-devops-annotator-processor:<tag>`|``
3551

3652
|*Catalog Backend Module Bitbucket Cloud*
37-
|0.5.9|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-catalog-backend-module-bitbucket-cloud:<tag>`
53+
|0.5.9|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-catalog-backend-module-bitbucket-cloud:<tag>`|``BITBUCKET_WORKSPACE`
54+
55+
`
3856

3957
|*Catalog Backend Module Bitbucket Server*
40-
|0.5.9|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-catalog-backend-module-bitbucket-server:<tag>`
58+
|0.5.9|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-catalog-backend-module-bitbucket-server:<tag>`|``BITBUCKET_HOST`
59+
60+
`
4161

4262
|*Datadog*
43-
|2.7.2|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-datadog:<tag>`
63+
|2.7.2|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-datadog:<tag>`|``
4464

4565
|*Dynatrace*
46-
|10.17.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-dynatrace:<tag>`
66+
|10.17.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-dynatrace:<tag>`|``
4767

4868
|*GitHub Actions*
49-
|0.22.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-actions:<tag>`
69+
|0.22.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-actions:<tag>`|``
5070

5171
|*GitHub Deployments*
52-
|0.18.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-deployments:<tag>`
72+
|0.18.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-deployments:<tag>`|``
5373

5474
|*GitHub Discussions*
55-
|0.10.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-discussions:<tag>`
75+
|0.10.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-discussions:<tag>`|``
5676

5777
|*GitHub Discussions Search Backend Module*
58-
|0.11.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-search-backend-module-github-discussions:<tag>`
78+
|0.11.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-search-backend-module-github-discussions:<tag>`|``GITHUB_DISCUSSIONS_REPO_URL`
79+
80+
`
5981

6082
|*GitHub Insights*
61-
|3.5.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-github-insights:<tag>`
83+
|3.5.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-github-insights:<tag>`|``
6284

6385
|*GitHub Issues*
64-
|0.21.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-issues:<tag>`
86+
|0.21.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-issues:<tag>`|``
6587

6688
|*GitHub Pull Requests*
67-
|3.7.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-github-pull-requests:<tag>`
89+
|3.7.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-github-pull-requests:<tag>`|``
6890

6991
|*GitHub Pull Requests Board*
70-
|0.16.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-pull-requests-board:<tag>`
92+
|0.16.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-pull-requests-board:<tag>`|``
7193

7294
|*GitLab Backend*
73-
|7.0.1|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/immobiliarelabs-backstage-plugin-gitlab-backend:<tag>`
95+
|7.0.1|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/immobiliarelabs-backstage-plugin-gitlab-backend:<tag>`|``GITLAB_HOST`
96+
97+
`GITLAB_TOKEN`
98+
99+
`
74100

75101
|*JFrog Artifactory*
76-
|1.28.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jfrog-artifactory:<tag>`
102+
|1.28.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jfrog-artifactory:<tag>`|``
77103

78104
|*Jenkins Backend*
79-
|0.27.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jenkins-backend:<tag>`
105+
|0.27.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jenkins-backend:<tag>`|``JENKINS_TOKEN`
106+
107+
`JENKINS_URL`
108+
109+
`JENKINS_USERNAME`
110+
111+
`
80112

81113
|*Jenkins Scaffolder Backend Module*
82-
|0.20.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-jenkins:<tag>`
114+
|0.20.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-jenkins:<tag>`|``
83115

84116
|*Jira*
85-
|2.14.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-jira:<tag>`
117+
|2.14.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-jira:<tag>`|``
86118

87119
|*Lighthouse Backend*
88-
|0.21.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-lighthouse-backend:<tag>`
120+
|0.21.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-lighthouse-backend:<tag>`|``
89121

90122
|*Nexus Repository Manager*
91-
|1.23.2|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-nexus-repository-manager:<tag>`
123+
|1.23.2|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-nexus-repository-manager:<tag>`|``
92124

93125
|*PagerDuty Backend*
94-
|0.12.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/pagerduty-backstage-plugin-backend:<tag>`
126+
|0.12.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/pagerduty-backstage-plugin-backend:<tag>`|``PAGERDUTY_API_BASE`
127+
128+
`PAGERDUTY_CLIENT_ID`
129+
130+
`PAGERDUTY_CLIENT_SECRET`
131+
132+
`PAGERDUTY_SUBDOMAIN`
133+
134+
`
95135

96136
|*PagerDuty Entity Processor*
97-
|0.3.10|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/pagerduty-backstage-plugin-entity-processor:<tag>`
137+
|0.3.10|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/pagerduty-backstage-plugin-entity-processor:<tag>`|``
98138

99139
|*PagerDuty Scaffolder Actions*
100-
|0.2.9|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/pagerduty-backstage-plugin-scaffolder-actions:<tag>`
140+
|0.2.9|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/pagerduty-backstage-plugin-scaffolder-actions:<tag>`|``
101141

102142
|*Quay Backend*
103-
|1.14.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay-backend:<tag>`
143+
|1.14.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay-backend:<tag>`|``
104144

105145
|*Roadie ArgoCD Backend*
106-
|4.8.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-argo-cd-backend:<tag>`
146+
|4.8.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-argo-cd-backend:<tag>`|``ARGOCD_AUTH_TOKEN`
147+
148+
`ARGOCD_INSTANCE1_URL`
149+
150+
`ARGOCD_PASSWORD`
151+
152+
`ARGOCD_USERNAME`
153+
154+
`
107155

108156
|*Scaffolder Backend ArgoCD*
109-
|1.8.1|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-argocd:<tag>`
157+
|1.8.1|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-argocd:<tag>`|``ARGOCD_AUTH_TOKEN`
158+
159+
`ARGOCD_INSTANCE1_URL`
160+
161+
`ARGOCD_PASSWORD`
162+
163+
`ARGOCD_USERNAME`
164+
165+
`
110166

111167
|*Scaffolder Backend Module AWS*
112-
|2.8.2|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-module-aws:<tag>`
168+
|2.8.2|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-module-aws:<tag>`|``AWS_ACCESS_KEY_ID`
169+
170+
`AWS_SECRET_ACCESS_KEY`
171+
172+
`
113173

114174
|*Scaffolder Backend Module Azure*
115-
|0.2.19|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-azure:<tag>`
175+
|0.2.19|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-azure:<tag>`|``
116176

117177
|*Scaffolder Backend Module Azure DevOps*
118-
|0.23.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-azure-devops:<tag>`
178+
|0.23.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-azure-devops:<tag>`|``
119179

120180
|*Scaffolder Backend Module Bitbucket Cloud*
121-
|0.3.4|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-bitbucket-cloud:<tag>`
181+
|0.3.4|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-bitbucket-cloud:<tag>`|``
122182

123183
|*Scaffolder Backend Module Bitbucket Server*
124-
|0.2.19|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-bitbucket-server:<tag>`
184+
|0.2.19|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-bitbucket-server:<tag>`|``
125185

126186
|*Scaffolder Backend Module DotNet*
127-
|0.13.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-dotnet:<tag>`
187+
|0.13.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-dotnet:<tag>`|``
128188

129189
|*Scaffolder Backend Module Gerrit*
130-
|0.2.19|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-gerrit:<tag>`
190+
|0.2.19|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-gerrit:<tag>`|``
131191

132192
|*Scaffolder Backend Module Quay*
133-
|2.18.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-quay:<tag>`
193+
|2.18.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-quay:<tag>`|``
134194

135195
|*Scaffolder Backend Module ServiceNow*
136-
|2.15.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-servicenow:<tag>`
196+
|2.15.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-servicenow:<tag>`|``SERVICENOW_BASE_URL`
197+
198+
`SERVICENOW_PASSWORD`
199+
200+
`SERVICENOW_USERNAME`
201+
202+
`
137203

138204
|*Scaffolder Backend Module SonarQube*
139-
|2.15.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-sonarqube:<tag>`
205+
|2.15.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-sonarqube:<tag>`|``
140206

141207
|*Scaffolder Backend Module Utils*
142-
|4.1.2|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-module-utils:<tag>`
208+
|4.1.2|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-module-utils:<tag>`|``
143209

144210
|*Search Backend Module Azure DevOps*
145-
|0.5.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-search-backend-module-azure-devops:<tag>`
211+
|0.5.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-search-backend-module-azure-devops:<tag>`|``AZURE_DEVOPS_BASE_URL`
212+
213+
`AZURE_DEVOPS_ORGANIZATION`
214+
215+
`AZURE_DEVOPS_PROJECT`
216+
217+
`AZURE_DEVOPS_TOKEN`
218+
219+
`AZURE_DEVOPS_WIKI_IDENTIFIER`
220+
221+
`
146222

147223
|*Security Insights*
148-
|3.3.1|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-security-insights:<tag>`
224+
|3.3.1|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-security-insights:<tag>`|``
149225

150226
|*SonarQube Backend*
151-
|1.1.1|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-sonarqube-backend:<tag>`
227+
|1.1.1|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-sonarqube-backend:<tag>`|``SONARQUBE_TOKEN`
228+
229+
`SONARQUBE_URL`
230+
231+
`
152232

153233
|*Tekton*
154-
|3.37.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-tekton:<tag>`
234+
|3.37.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-tekton:<tag>`|``
155235

156236
|===
157237

‎modules/extend_dynamic-plugins-reference/rhdh-supported-plugins.sh‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,23 @@ titlecase() {
146146
done; echo;
147147
}
148148

149+
# Extract ${VAR_NAME} placeholders from spec.appConfigExamples[0].content for docs tables.
150+
get_required_variables() {
151+
local metadata_file="$1"
152+
local Required_Variables=""
153+
local appConfig
154+
appConfig=$(yq -r '.spec.appConfigExamples[0].content // empty' "$metadata_file" 2>/dev/null)
155+
if [[ -n "$appConfig" && "$appConfig" != "null" ]]; then
156+
# Extract ${VARIABLE_NAME} patterns
157+
# shellcheck disable=SC2016
158+
while IFS= read -r var; do
159+
[[ -n "$var" ]] && Required_Variables="${Required_Variables}\`${var}\`\\n\\n"
160+
done < <(echo "$appConfig" | grep -o '\${[^}]*}' | sed 's/\${//g' | sed 's/}//g' | LC_ALL=C sort -u)
161+
fi
162+
printf '%s' "$Required_Variables"
163+
}
164+
165+
149166
generate_dynamic_plugins_table() {
150167
# generate a list of plugin:version mapping from the following files
151168
# * dynamic-plugins/imports/package.json#.peerDependencies or .dependencies
@@ -330,18 +347,7 @@ generate_dynamic_plugins_table() {
330347
fi
331348

332349
# compute Required_Variables from appConfigExamples in YAML
333-
Required_Variables=""
334-
appConfig=$(yq -r '.spec.appConfigExamples[0].content // empty' "$y" 2>/dev/null)
335-
if [[ -n "$appConfig" && "$appConfig" != "null" ]]; then
336-
# Extract ${VARIABLE_NAME} patterns
337-
# shellcheck disable=SC2016
338-
vars=$(echo "$appConfig" | grep -o '\${[^}]*}' | sed 's/\${//g' | sed 's/}//g' | LC_ALL=C sort -u)
339-
for var in $vars; do
340-
if [[ $var ]]; then
341-
Required_Variables="${Required_Variables}\`$var\`\n\n"
342-
fi
343-
done
344-
fi
350+
Required_Variables=$(get_required_variables "$y")
345351
Required_Variables_CSV=$(echo -e "$Required_Variables" | tr -s "\n" ";")
346352
# not currently used due to policy and support concern with upstream content linked from downstream doc
347353
# URL="https://www.npmjs.com/package/$Plugin"
@@ -612,6 +618,7 @@ generate_community_table() {
612618
plugin_version=$(yq -r '.spec.version // ""' "$metadata_file")
613619
dynamic_artifact=$(yq -r '.spec.dynamicArtifact // ""' "$metadata_file")
614620
support=$(yq -r '.spec.support // "unknown"' "$metadata_file")
621+
Required_Variables=$(get_required_variables "$metadata_file")
615622

616623
# Skip if not a community plugin or no dynamic artifact
617624
[[ "$support" != "community" ]] && continue
@@ -642,11 +649,12 @@ generate_community_table() {
642649
echo " * Plugin: $display_title"
643650
echo " Version: $plugin_version"
644651
echo " Path: $new_path"
652+
echo " Required variables: ${Required_Variables}"
645653
fi
646654

647655
# Add to community table (sorted by title)
648656
# shellcheck disable=SC2028
649-
echo "${display_title}||*${display_title}*\n|${plugin_version}|\`${new_path}\`" >> "$COMMUNITY_TABLE_FILE"
657+
echo "${display_title}||*${display_title}*\n|${plugin_version}|\`${new_path}\`|\`${Required_Variables}\`" >> "$COMMUNITY_TABLE_FILE"
650658

651659
community_count=$((community_count + 1))
652660
done

0 commit comments

Comments
 (0)