fix: add config partials for dynamic frontend plugins (#965)

Signed-off-by: Tomas Coufal <[email protected]>
janus-idp · Nov 23, 2023 · b01e55e · b01e55e
1 parent 80499eb
commit b01e55e
Show file tree

Hide file tree

Showing 28 changed files with 239 additions and 47 deletions.
diff --git a/plugins/aap-backend/app-config.janus-idp.yaml b/plugins/aap-backend/app-config.janus-idp.yaml
@@ -1,5 +1,3 @@
-enabled:
-  aap: true
 catalog:
   providers:
     aap:

diff --git a/plugins/acr/README.md b/plugins/acr/README.md
@@ -17,14 +17,15 @@ The Azure Container Registry (ACR) plugin displays information about your contai
    ```yaml
    # app-config.yaml
    proxy:
-     '/acr/api':
-       target: 'https://mycontainerregistry.azurecr.io/acr/v1/'
-       changeOrigin: true
-       headers:
-         # If you use Bearer Token for authorization, please replace the 'Basic' with 'Bearer' in the following line.
-         Authorization: 'Basic ${ACR_AUTH_TOKEN}'
-       # Change to "false" in case of using self hosted artifactory instance with a self-signed certificate
-       secure: true
+     endpoints:
+       '/acr/api':
+         target: 'https://mycontainerregistry.azurecr.io/acr/v1/'
+         changeOrigin: true
+         headers:
+           # If you use Bearer Token for authorization, please replace the 'Basic' with 'Bearer' in the following line.
+           Authorization: 'Basic ${ACR_AUTH_TOKEN}'
+         # Change to "false" in case of using self hosted artifactory instance with a self-signed certificate
+         secure: true
    ```
 
 1. Set the authorization using one of the following options:

diff --git a/plugins/acr/app-config.janus-idp.yaml b/plugins/acr/app-config.janus-idp.yaml
@@ -0,0 +1,23 @@
+proxy:
+  endpoints:
+    '/acr/api':
+      target: ${ACR_URL}
+      changeOrigin: true
+      headers:
+        # If you use Bearer Token for authorization, please replace the 'Basic' with 'Bearer' in the following line.
+        Authorization: 'Bearer ${ACR_AUTH_TOKEN}'
+      # Change to "false" in case of using self hosted artifactory instance with a self-signed certificate
+      secure: true
+
+dynamicPlugins:
+  frontend:
+    janus-idp.backstage-plugin-acr:
+      mountPoints:
+        - mountPoint: entity.page.image-registry/cards
+          importName: AcrPage
+          config:
+            layout:
+              gridColumn: 1 / -1
+            if:
+              anyOf:
+                - isAcrAvailable
diff --git a/plugins/acr/package.json b/plugins/acr/package.json
@@ -55,7 +55,8 @@
   },
   "files": [
     "dist",
-    "dist-scalprum"
+    "dist-scalprum",
+    "app-config.janus-idp.yaml"
   ],
   "repository": "github:janus-idp/backstage-plugins",
   "keywords": [

diff --git a/plugins/analytics-provider-segment/app-config.janus-idp.yaml b/plugins/analytics-provider-segment/app-config.janus-idp.yaml
@@ -0,0 +1,6 @@
+app:
+  analytics:
+    segment:
+      writeKey: ${SEGMENT_WRITE_KEY}
+      maskIP: true # prevents IP addresses from being sent if true
+      testMode: false # prevents data from being sent if true
diff --git a/plugins/analytics-provider-segment/package.json b/plugins/analytics-provider-segment/package.json
@@ -58,7 +58,8 @@
   "files": [
     "dist",
     "dist-scalprum",
-    "config.d.ts"
+    "config.d.ts",
+    "app-config.janus-idp.yaml"
   ],
   "configSchema": "config.d.ts"
 }
diff --git a/plugins/jfrog-artifactory/README.md b/plugins/jfrog-artifactory/README.md
@@ -18,12 +18,13 @@ The Jfrog Artifactory plugin displays information about your container images wi
 
    ```yaml title="app-config.yaml"
    proxy:
-     '/jfrog-artifactory/api':
-       target: 'http://<hostname>:8082' # or https://<customer>.jfrog.io
-       headers:
-         # Authorization: 'Bearer <YOUR TOKEN>'
-       # Change to "false" in case of using self hosted artifactory instance with a self-signed certificate
-       secure: true
+     endpoints:
+       '/jfrog-artifactory/api':
+         target: 'http://<hostname>:8082' # or https://<customer>.jfrog.io
+         headers:
+           # Authorization: 'Bearer <YOUR TOKEN>'
+         # Change to "false" in case of using self hosted artifactory instance with a self-signed certificate
+         secure: true
    ```
 
 1. Enable the **JFROG ARTIFACTORY** tab on the entity view page in `packages/app/src/components/catalog/EntityPage.tsx`:

diff --git a/plugins/jfrog-artifactory/app-config.janus-idp.yaml b/plugins/jfrog-artifactory/app-config.janus-idp.yaml
@@ -0,0 +1,21 @@
+proxy:
+  endpoints:
+    '/jfrog-artifactory/api':
+      target: ${ARTIFACTORY_URL}
+      headers:
+        Authorization: Bearer ${ARTIFACTORY_TOKEN}
+      # Change to "false" in case of using self hosted artifactory instance with a self-signed certificate
+      secure: true
+
+dynamicPlugins:
+  frontend:
+    janus-idp.backstage-plugin-jfrog-artifactory:
+      mountPoints:
+        - mountPoint: entity.page.image-registry/cards
+          importName: JfrogArtifactoryPage
+          config:
+            layout:
+              gridColumn: 1 / -1
+            if:
+              anyOf:
+                - isJfrogArtifactoryAvailable
diff --git a/plugins/jfrog-artifactory/package.json b/plugins/jfrog-artifactory/package.json
@@ -57,7 +57,8 @@
   "files": [
     "dist",
     "dist-scalprum",
-    "config.d.ts"
+    "config.d.ts",
+    "app-config.janus-idp.yaml"
   ],
   "configSchema": "config.d.ts",
   "repository": "github:janus-idp/backstage-plugins",

diff --git a/plugins/matomo-backend/README.md b/plugins/matomo-backend/README.md
@@ -49,7 +49,7 @@ async function main() {
 
 4. Now you need to add in app-config.yaml file
 
-```
+```yaml
 matomo:
   apiToken: ${MATOMO_API_TOKEN}
   apiUrl: ${MATOMO_API_URL}

diff --git a/plugins/matomo-backend/app-config.janus-idp.yaml b/plugins/matomo-backend/app-config.janus-idp.yaml
@@ -0,0 +1,3 @@
+matomo:
+  apiToken: ${MATOMO_API_TOKEN}
+  apiUrl: ${MATOMO_API_URL}
diff --git a/plugins/matomo/app-config.janus-idp.yaml b/plugins/matomo/app-config.janus-idp.yaml
@@ -0,0 +1,3 @@
+matomo:
+  frontendBaseUrl: ${MATOMO_INSTANCE_URL}
+  contactUsLink: mailto:${MATOMO_CONTACT_EMAIL}
diff --git a/plugins/matomo/package.json b/plugins/matomo/package.json
@@ -58,7 +58,8 @@
   "files": [
     "dist",
     "dist-scalprum",
-    "config.d.ts"
+    "config.d.ts",
+    "app-config.janus-idp.yaml"
   ],
   "repository": "github:janus-idp/backstage-plugins",
   "keywords": [

diff --git a/plugins/nexus-repository-manager/README.md b/plugins/nexus-repository-manager/README.md
@@ -16,15 +16,16 @@ The Nexus Repository Manager plugin displays the information about your build ar
 
    ```yaml title="app-config.yaml"
    proxy:
-     '/nexus-repository-manager':
-       target: 'https://<NEXUS_REPOSITORY_MANAGER_URL>'
-       headers:
-         X-Requested-With: 'XMLHttpRequest'
-         # Uncomment the following line to access a private Nexus Repository Manager using a token
-         # Authorization: 'Bearer <YOUR TOKEN>'
-       changeOrigin: true
-       # Change to "false" in case of using self hosted Nexus Repository Manager instance with a self-signed certificate
-       secure: true
+     endpoints:
+       '/nexus-repository-manager':
+         target: 'https://<NEXUS_REPOSITORY_MANAGER_URL>'
+         headers:
+           X-Requested-With: 'XMLHttpRequest'
+           # Uncomment the following line to access a private Nexus Repository Manager using a token
+           # Authorization: 'Bearer <YOUR TOKEN>'
+         changeOrigin: true
+         # Change to "false" in case of using self hosted Nexus Repository Manager instance with a self-signed certificate
+         secure: true
    ```
 
 1. Optional: Change the base URL of Nexus Repository Manager proxy as follows:

diff --git a/plugins/nexus-repository-manager/app-config.janus-idp.yaml b/plugins/nexus-repository-manager/app-config.janus-idp.yaml
@@ -0,0 +1,27 @@
+proxy:
+  endpoints:
+    '/nexus-repository-manager':
+      target: ${NEXUS_REPOSITORY_MANAGER_URL}
+      headers:
+        X-Requested-With: 'XMLHttpRequest'
+        # Uncomment the following line to access a private Nexus Repository Manager using a token
+        # Authorization: 'Bearer <NEXUS_REPOSITORY_MANAGER_TOKEN>'
+      changeOrigin: true
+      # Change to "false" in case of using self hosted Nexus Repository Manager instance with a self-signed certificate
+      secure: true
+
+nexusRepositoryManager:
+  experimentalAnnotations: true
+
+dynamicPlugins:
+  frontend:
+    janus-idp.backstage-plugin-nexus-repository-manager:
+      mountPoints:
+        - mountPoint: entity.page.image-registry/cards
+          importName: NexusRepositoryManagerPage
+          config:
+            layout:
+              gridColumn: 1 / -1
+            if:
+              anyOf:
+                - isNexusRepositoryManagerAvailable
diff --git a/plugins/nexus-repository-manager/package.json b/plugins/nexus-repository-manager/package.json
@@ -61,7 +61,8 @@
   "files": [
     "dist",
     "dist-scalprum",
-    "config.d.ts"
+    "config.d.ts",
+    "app-config.janus-idp.yaml"
   ],
   "configSchema": "config.d.ts",
   "repository": "github:janus-idp/backstage-plugins",

diff --git a/plugins/ocm-backend/app-config.janus-idp.yaml b/plugins/ocm-backend/app-config.janus-idp.yaml
@@ -1,5 +1,3 @@
-enabled:
-  ocm: true
 catalog:
   providers:
     ocm:

diff --git a/plugins/ocm/app-config.janus-idp.yaml b/plugins/ocm/app-config.janus-idp.yaml
@@ -0,0 +1,39 @@
+dynamicPlugins:
+  frontend:
+    janus-idp.backstage-plugin-ocm:
+      appIcons:
+        - name: ocmIcon
+          importName: OcmIcon
+      dynamicRoutes:
+        - path: /ocm
+          importName: OcmPage
+          menuItem:
+            icon: ocmIcon
+            text: Clusters
+      mountPoints:
+        - mountPoint: entity.page.overview/context
+          importName: ClusterContextProvider
+        - mountPoint: entity.page.overview/cards
+          importName: ClusterAvailableResourceCard
+          config:
+            layout:
+              gridColumnEnd:
+                lg: 'span 4'
+                md: 'span 6'
+                xs: 'span 12'
+            if:
+              allOf:
+                - isKind: resource
+                - isType: kubernetes-cluster
+        - mountPoint: entity.page.overview/cards
+          importName: ClusterInfoCard
+          config:
+            layout:
+              gridColumnEnd:
+                lg: 'span 4'
+                md: 'span 6'
+                xs: 'span 12'
+            if:
+              allOf:
+                - isKind: resource
+                - isType: kubernetes-cluster
diff --git a/plugins/ocm/package.json b/plugins/ocm/package.json
@@ -62,7 +62,8 @@
   },
   "files": [
     "dist",
-    "dist-scalprum"
+    "dist-scalprum",
+    "app-config.janus-idp.yaml"
   ],
   "repository": "github:janus-idp/backstage-plugins",
   "keywords": [

diff --git a/plugins/openshift-image-registry/README.md b/plugins/openshift-image-registry/README.md
@@ -18,14 +18,15 @@ yarn workspace app add @janus-idp/backstage-plugin-openshift-image-registry
 
    ```yaml title="app-config.yaml"
    proxy:
-     '/openshift-image-registry/api':
-     target: <URL where k8s control plane for OpenShift cluster is running>
-     headers:
-       X-Requested-With: 'XMLHttpRequest'
-       Authorization: Bearer <TOKEN>
-     changeOrigin: true
-     # Change to "false" in case of using self hosted OpenShift cluster with a self-signed certificate
-     secure: true
+     endpoints:
+       '/openshift-image-registry/api':
+       target: <URL where k8s control plane for OpenShift cluster is running>
+       headers:
+         X-Requested-With: 'XMLHttpRequest'
+         Authorization: Bearer <TOKEN>
+       changeOrigin: true
+       # Change to "false" in case of using self hosted OpenShift cluster with a self-signed certificate
+       secure: true
    ```
 
 2. Enable an additional sidebar-item on the app sidebar in the `packages/app/src/components/Root/Root.tsx` file:

diff --git a/plugins/openshift-image-registry/app-config.janus-idp.yaml b/plugins/openshift-image-registry/app-config.janus-idp.yaml
@@ -0,0 +1,20 @@
+proxy:
+  endpoints:
+    '/openshift-image-registry/api':
+    target: ${OCP_API_ENDPOINT}
+    headers:
+      X-Requested-With: 'XMLHttpRequest'
+      Authorization: Bearer ${OCP_API_TOKEN}
+    changeOrigin: true
+    # Change to "false" in case of using self hosted OpenShift cluster with a self-signed certificate
+    secure: true
+
+dynamicPlugins:
+  frontend:
+    janus-idp.backstage-plugin-acr:
+      dynamicRoutes:
+        - path: /openshift-image-registry
+          importName: OpenshiftImageRegistryPage
+          menuItem:
+            icon: dashboard
+            text: Image Registry
diff --git a/plugins/openshift-image-registry/package.json b/plugins/openshift-image-registry/package.json
@@ -55,7 +55,8 @@
   "files": [
     "dist",
     "dist-scalprum",
-    "config.d.ts"
+    "config.d.ts",
+    "app-config.janus-idp.yaml"
   ],
   "configSchema": "config.d.ts"
 }
diff --git a/plugins/quay/app-config.janus-idp.yaml b/plugins/quay/app-config.janus-idp.yaml
@@ -0,0 +1,12 @@
+dynamicPlugins:
+  frontend:
+    janus-idp.backstage-plugin-quay:
+      mountPoints:
+        - mountPoint: entity.page.image-registry/cards
+          importName: QuayPage
+          config:
+            layout:
+              gridColumn: 1 / -1
+            if:
+              anyOf:
+                - isQuayAvailable
diff --git a/plugins/tekton/README.md b/plugins/tekton/README.md
@@ -123,10 +123,13 @@ The Tekton plugin enables you to visualize the `PipelineRun` resources available
 
    ```tsx title="packages/app/src/components/catalog/EntityPage.tsx"
    /* highlight-add-next-line */
-   import { TektonCI, isTektonCIAvailable } from '@janus-idp/backstage-plugin-tekton';
+   import {
+     isTektonCIAvailable,
+     TektonCI,
+   } from '@janus-idp/backstage-plugin-tekton';
 
    const cicdContent = (
-     <EntitySwitch>>
+     <EntitySwitch>
        {/* ... */}
        {/* highlight-add-start */}
        <EntitySwitch.Case if={isTektonCIAvailable}>

diff --git a/plugins/tekton/app-config.janus-idp.yaml b/plugins/tekton/app-config.janus-idp.yaml
@@ -0,0 +1,12 @@
+dynamicPlugins:
+  frontend:
+    janus-idp.backstage-plugin-tekton:
+      mountPoints:
+        - mountPoint: entity.page.ci/cards
+          importName: TektonCI
+          config:
+            layout:
+              gridColumn: '1 / -1'
+            if:
+              allOf:
+                - isTektonCIAvailable
diff --git a/plugins/tekton/package.json b/plugins/tekton/package.json
@@ -71,7 +71,8 @@
   },
   "files": [
     "dist",
-    "dist-scalprum"
+    "dist-scalprum",
+    "app-config.janus-idp.yaml"
   ],
   "repository": "github:janus-idp/backstage-plugins",
   "keywords": [
-Original file line number
+Diff line change
@@ Expand Up / @@ -49,7 +49,7 @@ async function main() { @@
 . Now you need to add in app-config.yaml file
-    ```
+    ```yaml
     matomo:
       apiToken: ${MATOMO_API_TOKEN}
       apiUrl: ${MATOMO_API_URL}
@@ Expand Down @@