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

Add Quay and Argocd backend plugins to RHDH

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

    • False
    • Hide

      None

      Show
      None
    • False
    • 0% To Do, 0% In Progress, 100% Done
    • Hide
      = Added ArgoCD and Quay backend plugin configurations

      This {product} update includes pre-configured ArgoCD and Quay backend plugins for simplified setup. This plugins ensure respective permissions are properly displayed in the UI. Plugins are disabled by default, to enable them, update your `dynamic-plugins.yaml` file:
      +
      [source,yaml]
      ----
      global:
        dynamic:
          plugins:
            - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd-backend:bs_1.45.3__1.0.0!backstage-community-plugin-argocd-backend
              disabled: false
            - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay-backend:bs_1.45.3__1.10.1!backstage-community-plugin-quay-backend
              disabled: false
      ----

      NOTE:
      ArgoCD backend plugin is incompatible with Roadie Scaffolder ArgoCD Actions. If you want to use these actions, you can enable ArgoCD frontend plugin together with Roadie ArgoCD backend plugin. Permissions will not be displayed in the RBAC UI, as a workaround, you can apply these permissions by using a CSV file or directly calling the REST API of the RBAC backend plugin. Update your `dynamic-plugins.yaml` file:
      +
      [source,yaml]
      ----
      global:
        dynamic:
          plugins:
            - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd:bs_1.45.3__2.4.0!backstage-community-plugin-argocd
              disabled: false
            - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-argo-cd-backend:bs_1.45.3__4.4.2!roadiehq-backstage-plugin-argo-cd-backend
              disabled: false
            - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-argocd:bs_1.45.3__1.8.1!roadiehq-scaffolder-backend-argocd
              disabled: false
      ----

      Ensure all required secrets for configurations are defined.
      Show
      = Added ArgoCD and Quay backend plugin configurations This {product} update includes pre-configured ArgoCD and Quay backend plugins for simplified setup. This plugins ensure respective permissions are properly displayed in the UI. Plugins are disabled by default, to enable them, update your `dynamic-plugins.yaml` file: + [source,yaml] ---- global:   dynamic:     plugins:       - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd-backend:bs_1.45.3__1.0.0!backstage-community-plugin-argocd-backend         disabled: false       - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay-backend:bs_1.45.3__1.10.1!backstage-community-plugin-quay-backend         disabled: false ---- NOTE: ArgoCD backend plugin is incompatible with Roadie Scaffolder ArgoCD Actions. If you want to use these actions, you can enable ArgoCD frontend plugin together with Roadie ArgoCD backend plugin. Permissions will not be displayed in the RBAC UI, as a workaround, you can apply these permissions by using a CSV file or directly calling the REST API of the RBAC backend plugin. Update your `dynamic-plugins.yaml` file: + [source,yaml] ---- global:   dynamic:     plugins:       - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd:bs_1.45.3__2.4.0!backstage-community-plugin-argocd         disabled: false       - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-argo-cd-backend:bs_1.45.3__4.4.2!roadiehq-backstage-plugin-argo-cd-backend         disabled: false       - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-argocd:bs_1.45.3__1.8.1!roadiehq-scaffolder-backend-argocd         disabled: false ---- Ensure all required secrets for configurations are defined.
    • Developer Preview
    • S

      Feature Overview (aka. Goal Summary)

      Add Quay and Argocd backend plugins to RHDH.

      Goals (aka. expected user outcomes)

      Add Argocd and Quay backend plugins to RHDH. They are required for RBAC permissions to work correctly.

      Right now, users can install Quay and Argocd backend plugins manually by updating dynamic-plugins.yaml:

       

      1.8 Argocd:

        - package: ./dynamic-plugins/dist/roadiehq-scaffolder-backend-argocd-dynamic
          disabled: true
        - package: ./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd
          disabled: false
        - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-redhat-argocd-backend:bs_1.42.5__1.7.1!backstage-community-plugin-redhat-argocd-backend
          disabled: false
          pluginConfig:
            argocd:
              username: "${ARGOCD_USERNAME}"
              password: "${ARGOCD_PASSWORD}"
              appLocatorMethods:
                - type: 'config'
                  instances:
                    - name: argoInstance1
                      url: "${ARGOCD_INSTANCE1_URL}"
                      token: "${ARGOCD_AUTH_TOKEN}"
                    - name: argoInstance2
                      url: "${ARGOCD_INSTANCE2_URL}"
                      token: "${ARGOCD_AUTH_TOKEN2}"

      For 1.7 Argocd, use this backend package:

      - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-redhat-argocd-backend:bs_1.39.1__0.8.1!backstage-community-plugin-redhat-argocd-backend disabled: false

      For 1.6 Argocd, use this backend package:

      - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-redhat-argocd-backend:bs_1.36.1__0.5.0!backstage-community-plugin-redhat-argocd-backend disabled: false

       

      1.8 Quay

        - package: ./dynamic-plugins/dist/backstage-community-plugin-quay
          disabled: false  
        - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay-backend:bs_1.42.5__1.6.0!backstage-community-plugin-quay-backend
          disabled: false
          pluginConfig:
            quay:
              apiUrl: ${QUAY_API_URL}
              apiKey: ${QUAY_API_KEY}

      For 1.7 Quay, use this backend package:

        - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay-backend:bs_1.39.1__1.4.0!backstage-community-plugin-quay-backend

      For 1.6 Quay, use this backend package

       - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay-backend:bs_1.36.1__1.1.3!backstage-community-plugin-quay-backend

       

      Requirements (aka. Acceptance Criteria):

      • Quay backend plugin is added to RHDH
      • Argocd backend plugin is added to RHDH
      • Marketplace entities of Quay and Argocd plugins are updated

      Documentation Considerations

      • As a platform engineer, I want to be able to find the information about how to install Quay and Argocd plugins.
      • As an admin, I want to be able to find information on how to configure RBAC permissions for Quay and Argocd plugins.

          There are no Sub-Tasks for this issue.

              rh-ee-dzemanov Dominika Zemanovicova
              rh-ee-dzemanov Dominika Zemanovicova
              RHDH Plugins
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: