Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-7560

[Docs] Install and configure plugins from Extensions page (next phase)

    • RHDH Documentation 3276, RHDH Documentation 3277, RHDH Documentation 3278

      Feature Overview (aka. Goal Summary)

      As the marketplace plugin is available, we want to continue to add new features to make it even easier for customers to add/test plugins and other integrations to RHDH. This will allow customers to get to production faster and quicker POCs

      Continues work started in RHIDP-6020

      Goals (aka. expected user outcomes)

      Customers should be able to install a plugin and configure it from the marketplace. Typically, this will be done in a non prod environment. We also need an export feature, so the customer can get the working configuration for a specific plugin and apply this change in their GitOps pipeline.

      Requirements (aka. Acceptance Criteria):

      • As a RHDH administrator, I want to be able to install a plugin from the marketplace
      • As a RHDH administrator, I want to be able to configure a plugin from the marketplace
      • As a RHDH administrator, after doing an update on a plugin (install, configuration, uninstall), I want to see a reminder that I need to restart my pod for the changes to take effect.
      • As a RHDH administrator, I want to be able to export the configuration for a specific plugin

      Customer Considerations (Optional)

      It should work in Air gapped environments

      Added requirements by rh-ee-mhild

      Requirements (aka. Acceptance Criteria):

      • Write plugin configurations to a dynamic plugins cache file (marketplace-dynamic-plugins.yaml).
      • Ensure functionality only works with cache enabled, eliminating the need to interface with Kubernetes.
      • Implement a reboot mechanism triggered via a button to apply changes.
      • Provide a phased implementation approach:
        • Phase 0 was worked for 1.6 in RHIDP-6020
        • Phase 1: Install and uninstall plugins with default configurations using environment variables. These are written to another file in the cache PVC.
        • Phase 2: Allow configuration modifications with a warning about the lack of rollback.
      • Develop a marketplace backend to handle CRUD operations on plugin configurations and trigger restarts.
      • Develop a marketplace frontend with:
        • Install button
        • Configuration text field
        • Export configuration button
        • Reboot button
      • Consider a stretch goal for rollback functionality to previous configurations.
      • Should work with RHDH-local as well

      Out of Scope (Optional)

      • Integration with Kubernetes for plugin management.
      • reboot is out of scope
      • installation feature is disabled in production

      Documentation Considerations

      • Provide detailed documentation on the installation, configuration, and management of plugins within the marketplace.
      • Include instructions for exporting configurations and integrating with GitOps pipelines.
      • Note requirements for persistent storage
      • documentation should mention clearly that this is intended for dev/stage cases

              gforde@redhat.com Gerry Forde
              hmanwani@redhat.com Heena Manwani
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: