Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-10535

[2.11] Migrate addon to be managed by addon-manager

XMLWordPrintable

    • [2.11] Migrate addon to be managed by addon-manager
    • False
    • None
    • False
    • Green
    • To Do
    • ACM-8668 - [2.11] Migrate addon to be managed by addon-manager
    • ACM-8668[2.11] Migrate addon to be managed by addon-manager
    • 53
    • 53% 53%

      OCP/Telco Definition of Done
      https://docs.google.com/document/d/1TP2Av7zHXz4_fmeX4q9HB0m9cqSZ4F6Jd4AiVoaF_2s/edit#heading=h.gaa58bzbvwde
      Epic Template descriptions and documentation.
      https://docs.google.com/document/d/14CUCEg6hQ_jpsFzJtWo29GfFVWmun2Uivrxq3_Fkgdg/edit
      ACM-wide Product Requirements (Top-level Epics)
      https://docs.google.com/document/d/1uIp6nS2QZ766UFuZBaC9USs8dW_I5wVdtYF9sUObYKg/edit

      *<--- Cut-n-Paste the entire contents of this description into your new
      Epic --->*

      Epic Goal

      1. SF team follow the migration plan in community to upgrade the addon-framework and addon-manager. 

      https://github.com/open-cluster-management-io/ocm/issues/355 

      OCM v0.14.0 (ACM 2.11)

      • The addon is default managed by self (addon-framework).
      • The minimal request addon-framework version is v0.8.1.
      • Addon-manager will add annotation addon.open-cluster-management.io/lifecycle: addon-manager if self is not set.

      Addon-framework (to be released as 0.10.0)

      • Remove duplicate config controller code in framework.
      • Remove WithInstallStrategy() func in framework.
      • If use addon-framework, remove annotation addon.open-cluster-management.io/lifecycle: self.

      2. Cross quad work, each ACM addon owner MUST upgrade the addon-framework to at least v0.8.1 or v0.9.0. The minimal supported version is v0.8.1. And we suggest you upgrade to v0.9.0 since the v0.8.1 might be unsupported in the next release. 

      • For the addons using WithInstallStrategy() func, need add patch permission on ClusterManagementAddon for your addon manager. With this, the framework will add annotation `addon.open-cluster-management.io/lifecycle: self` to your cma and the general cluster-manager-addon-manager-controller won't take over your addon lifecycle.
      • For the addons not using WithInstallStrategy()  func, just upgrade the framework version. You cma will have an annotation `addon.open-cluster-management.io/lifecycle: addon-manager` in this release. And since your cma.spec.installstrategy type is Manual, the general cluster-manager-addon-manager-controller won't create/update any mca for your addon. 

      There are breaking changes in v0.10.0 you need to pay attention to (v0.10.0 is not released yet): the WithInstallStrategy() func is removed from framework.

      • For the addons not using WithInstallStrategy() func, there's no impact so far. For these addons, you can choose to always keep the framework up to date. 

      Below are the existing addon versions, will log story for each addon to upgrade the version. 

      • Submariner 0.8.0
      • volsync 0.8.0
      • observability 0.8.1
      • search 0.8.0
      • policy 0.8.0
      • application 0.8.0
      • hypershift 0.5.0
      • global-hub 0.8.0
      • cluster-proxy 0.8.0
      • managed-serviceaccount already using addon-template

      Why is this important?

      ...

      Scenarios

      ...

      Acceptance Criteria

      ...

      Dependencies (internal and external)

      1. ...

      Previous Work (Optional):

      1. ...

      Open questions:

      Done Checklist

      • CI - CI is running, tests are automated and merged.
      • Release Enablement <link to Feature Enablement Presentation>
      • DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
        Issue>
      • DEV - Upstream documentation merged: <link to meaningful PR or GitHub
        Issue>
      • DEV - Downstream build attached to advisory: <link to errata>
      • QE - Test plans in Polarion: <link or reference to Polarion>
      • QE - Automated tests merged: <link or reference to automated tests>
      • DOC - Doc issue opened with a completed template. Separate doc issue
        opened for any deprecation, removal, or any current known
        issue/troubleshooting removal from the doc, if applicable.

      Slack Channel

      #acm-10535-migrate-addon

            yuhe@redhat.com Yuanyuan He
            qhao@redhat.com Qing Hao
            Hui Chen Hui Chen
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: