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

Extension Catalog Plugin Metadata Collection and OCI Artifact Integration

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

    • False
    • Hide

      None

      Show
      None
    • False

      Feature Overview (aka. Goal Summary)

      Implement a metadata collection system for the RHDH Marketplace that aggregates plugin metadata embedded within OCI artifact images. This approach integrates the plugin YAML files—sourced either directly from the plugin repositories or manually added into the overlay repository—into the OCI image, ensuring that all metadata is centrally maintained within the overlay repository.

      Goals (aka. expected user outcomes)

      • Maintain a consolidated and reliable catalog of plugins for the RHDH Marketplace.
      • include plugin metadata within OCI artifacts as part of the overlay repository.
      • Allow RHDH Administrators to seamlessly integrate and update plugin metadata directly from OCI container images.

      Requirements (aka. Acceptance Criteria):

      • Create a script that:
        • Retrieves OCI artifacts containing plugin metadata.
        • Extracts the embedded plugin YAML file from the OCI container image.
        • Consolidates and writes the extracted metadata into the RHDH repository as a catalog file.
        • Accepts a list of container registry URLs as input for metadata extraction.
        • Use methods similar to the init container process that installs dynamic plugins in RHDH.
        • Create a package.yaml that contains the version information of the plugin.
        • Embed the plugin YAML file into the OCI container image during the build process.

      The script can be the basis for a future catalog provider in RHDH.

      Out of Scope (Optional)

      • Implementation of certification status checks (future enhancement).

      Customer Considerations (Optional)

      Documentation Considerations

      • Provide guidelines for plugin developers on integrating metadata into their container builds.
      • Include examples of valid metadata files and sample OCI configurations.

              nickboldt Nick Boldt
              rh-ee-mhild Marcel Hild
              RHDH Dynamic Plugins
              Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

                Created:
                Updated:
                Resolved: