Feature Overview

Ability to automate SiteConfig CR to ClusterInstance CR. Partners have expressed concerns for migrating high scale deployments from SiteConfig v1 to SiteConfig v2 manually as detailed here.  It is not uncommon to have a fleet of 100-200 MNO/SNO clusters deployed with one cluster with SiteConfig v1. Expectation from the partner is to:

• have a supported tool that avoids human error when manually migrating from SiteConfig CR to Cluster Instance when handling a large number of existing managed clusters that are running active workloads. Partner cannot risk a service outage due to human mistakes because they are migrating from SiteConfig v1 to ClusterInstance. Manual migration might work fine for a single cluster, but the partner is thinking at medium/high scale numbers in terms of managed clusters deployed at customer premises. Some initial ideas to automate from SiteConfig to ClusterInstance CR have been explored on the PoC here:

• • https://gitlab.consulting.redhat.com/skoksal/siteconfig_to_clusterinstance_translator/-/tree/main?ref_type=headsGoals

• have a tested, validated and documented procedure that allows incremental one-by-one managed MNO/SNO cluster migrations (canary migration). Partner request canary migrations (one by one) in order to do sanity checks after migrating. Again partners cannot risk service outages customer request sanity checks after each single managed cluster is migrated.  
  • as today the documented procedure today strongly recommends to upgrade all managed clusters at once:
    • https://access.redhat.com/articles/7105238

This Section: Provide high-level goal statement, providing user context
and expected user outcome(s) for this feature

• Provide tool with the ability to migrate automatically SiteConfig CR to ClusterInstance CR at scale

Requirements

This Section: A list of specific needs or objectives that a Feature must
deliver to satisfy the Feature.. Some requirements will be flagged as MVP.
If an MVP gets shifted, the feature shifts. If a non MVP requirement slips,
it does not shift the feature.

• The tool takes as input a set of SiteConfig CRs (SiteConfig v1) and the method used to install that SiteConfig: Assisted Based Installer (ABI) or Image Based Installer (IBI)
  • The set of input SiteConfig CRs represent the definition of a cluster installed using ABI or IBI method
  • The tool is valid for Spoke clusters deployed using ABI or IBI
• Support mapping of critical parameter used in SiteConfig
• The tool takes as output a set of ClusterInstance CRs (SiteConfig v2)

(Optional) Use Cases

This Section:

• Main success scenarios - high-level user stories
• Alternate flow/scenarios - high-level user stories
• ...

Questions to answer

• ...

Out of Scope

• …

Background, and strategic fit

This Section: What does the person writing code, testing, documenting
need to know? What context can be provided to frame this feature?

Assumptions

• ...

Customer Considerations

• ...

Documentation Considerations

Questions to be addressed:

• What educational or reference material (docs) is required to support this
  product feature? For users/admins? Other functions (security officers, etc)?
• Does this feature have a doc impact?
• New Content, Updates to existing content, Release Note, or No Doc Impact
• If unsure and no Technical Writer is available, please contact Content
  Strategy.
• What concepts do customers need to understand to be successful in
  [action]?
• How do we expect customers will use the feature? For what purpose(s)?
• What reference material might a customer want/need to complete [action]?
• Is there source material that can be used as reference for the Technical
  Writer in writing the content? If yes, please link if available.
• What is the doc impact (New Content, Updates to existing content, or
  Release Note)?