Uploaded image for project: 'RH Developer Hub Planning'
  1. RH Developer Hub Planning
  2. RHDHPLAN-999

Migrate per-plugin `Configuring dynamic plugins` guide to use new oci references that replace wrappers [1.9]

Create Doc EPIC from R...Prepare for Y ReleasePrepare for Z ReleasePrepare Test Plan (Y R...XMLWordPrintable

    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • RHDHPLAN-1001Remove plugin wrappers in favor of OCI artifacts
    • 100% To Do, 0% In Progress, 0% Done
    • Feature

      In 1.9 we replaced a number of wrappers with oci artifact references.

      https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/pull/1762/changes

      As a result of this migration a lot of doc in the `Configuring dynamic plugins` guide is now incorrect.

      For example https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.8/html-single/configuring_dynamic_plugins/index#proc-enabling-the-jfrog-plugin refers to code:

      global:
        dynamic:
          includes:
            - dynamic-plugins.default.yaml
          plugins:
            - package: ./dynamic-plugins/dist/backstage-community-plugin-jfrog-artifactory
              disabled: false

      which should now be something like:

      global:
        dynamic:
          includes:
            - dynamic-plugins.default.yaml
          plugins:
            - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jfrog-artifactory:bs_1.45.3__1.24.0!backstage-community-plugin-jfrog-artifactory
              disabled: false
      

      Though instead of hardcoding these versions we might instead want to use inherit:

            - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jfrog-artifactory:{{inherit}}
      

      so that whatever plugin artifact version is latest/compatible with the currently installed RHDH version will be installed and enabled.

              rhn-support-lhite Lindsay Hite
              nickboldt Nick Boldt
              RHDH Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: