Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-1709

Dynamic plugins are not loaded if the filename in the configMap ends with .yml

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Normal Normal
    • 1.2.2
    • 1.2
    • Documentation, Operator
    • None
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • Hide
      Starting version 1.2.1 (!)

      Fixed a bug that allowed Backstage CR to be created even if the dynamic plugin filename was invalid. Now the build fails with a corresponding log message.
      Show
      Starting version 1.2.1 (!) Fixed a bug that allowed Backstage CR to be created even if the dynamic plugin filename was invalid. Now the build fails with a corresponding log message.
    • Bug Fix
    • Proposed
    • 3

      In the Operator installed RHDH, the configMap for dynamic plugins needs to have the yaml filename ending with .yaml extension. If the filename in the configMap ends with .yml none of the dynamic plugins are loaded, and there is no error/warning about this in the console.

       

      Here's a working version of dynamic plugins cm (extension is .yaml):

      data:
        dynamic-plugins.yaml: |
          includes:
            - dynamic-plugins.default.yaml
          plugins:
            - package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic'
              disabled: false
              pluginConfig: {}

       

      The same config that does not work (extension is .yml):

      data:
        dynamic-plugins.yml: |
          includes:
            - dynamic-plugins.default.yaml
          plugins:
            - package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic'
              disabled: false
              pluginConfig: {}

       

      The configMap is referenced using the following config:

      dynamicPluginsConfigMapName: <NAME_OF_DYAMIC_PLUGIN_CM>

      Other configMaps that are referenced in the Backstage config (in application.appConfig.configMaps field) are read in (and applied) properly even if their name ends with .yml.

       

      I'm not sure whether this is a defect or just needs doc update to mention this shortcoming/requirement. Please adjust the issue type and component accordingly.

              gazarenk-1 Gennady Azarenkov
              sgahlot@redhat.com Sandip Gahlot
              RHIDP - Install
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: