Uploaded image for project: 'Container / Cluster Management (XCM) Strategy'
  1. Container / Cluster Management (XCM) Strategy
  2. XCMSTRAT-39

ROSA CLI UX Improvements

    XMLWordPrintable

Details

    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected
    • 66
    • 66% 66%
    • Hide

      Jan 3

      • OCM-3961
        • Merged changes will be given to QE to review this week. Changes will be merged to master once ROSA release is out.
      •  OCM-989 / OCM-4451
        • OCM-989 closed in favor of label 'rosa-ux' and quarterly stack-ranked tracker epics
        • OCM-4451 closed as complete
      • OCM-5180 for 2024Q1

      Dec 11

      • OCM-3961
        • Finished implementing changes for updated `go v2`, waiting on reviews. QE testing will be done at the start of Q1.
      •  OCM-989 / OCM-4451
        • OCM-989 to be closed in favor of the jira label 'rosa-ux', priority field to be used to stack rank
        • 2024Q1 epic to be loaded from prioritized issues

      Dec 5

      • OCM-3961
        Debugging init related issues found in code
        Debugging why ListQuotas is retrieving the wrong list of quotas in aws
        QE testing planned once fixed
      •  OCM-989 / OCM-4451
        • meeting scheduled w/ PM to plan 2024Q1 approach

      Nov 28

      • OCM-3961
        Moved common functions to the ocm-common library
        Ran basic sanity checks successfully
        Split generating policy files into two separate functions to ease code complexity

      Nov 21

      • OCM-3961
        In process of running sanity checks locally
        Peer reviews and addressing comments
      •  OCM-989 / OCM-4451
        • worked through issues, 4 remaining
        • set up mtg next week to consider 2024Q1 goals

      Nov 14

      • OCM-3961

      Rosa CLI fully updated with some minor blockers still being figured out
      Testing changes and addressing reviews on pr

      •  OCM-989

      Nov 7

      • OCM-3961
        • Finishing up updating the pkg/aws folder
          Trying to figure out a blocker in regards to getting Partition Id's
          Need to update the common repo so that Tag related functions work with v2
      •  OCM-989
        • Miro board for organizing, no ticket updates

      Oct 31

      • OCM-3961
        Updating client builder test file and other corresponding files to v2
        Created draft pull request for new changes
      •  OCM-989
        • Working w/ Justin to organize and triage issues
        • Established weekly time during regular "office hours" to triage existing and new issues that arrive in the epic; will start next week..

      Oct 24

      • OCM-3961
        • Updated mock test generation to v2
        • Working on updating the client builder to v2
      •  OCM-989
        • Loading of a Q4 epic started OCM-4451
        • ROSA squad will regularly review issues for inclusion in upcoming sprints

      Oct 18

      • OCM-3961
        • Started work on updating the ROSA CLI to use aws-sdk-go-v2 module
      •  OCM-989
        • UX contact assigned, Justin Hale
        • Continue prioritizing issues based upon type (bug) and severity (highest) and date (recently created)
        • OCM-1405 - The editable UI "display name" is inconsistently presented with the CLI. Working w/ UX and stakeholders to determine best solution to reconcile.
        • OCM-1326 - Reproducing AWS error messages for propagation to CLI
      Show
      Jan 3 OCM-3961 Merged changes will be given to QE to review this week. Changes will be merged to master once ROSA release is out.  OCM-989 / OCM-4451 OCM-989 closed in favor of label 'rosa-ux' and quarterly stack-ranked tracker epics OCM-4451 closed as complete OCM-5180 for 2024Q1 Dec 11 OCM-3961 Finished implementing changes for updated `go v2`, waiting on reviews. QE testing will be done at the start of Q1.  OCM-989 / OCM-4451 OCM-989 to be closed in favor of the jira label 'rosa-ux', priority field to be used to stack rank 2024Q1 epic to be loaded from prioritized issues Dec 5 OCM-3961 Debugging init related issues found in code Debugging why ListQuotas is retrieving the wrong list of quotas in aws QE testing planned once fixed  OCM-989 / OCM-4451 meeting scheduled w/ PM to plan 2024Q1 approach Nov 28 OCM-3961 Moved common functions to the ocm-common library Ran basic sanity checks successfully Split generating policy files into two separate functions to ease code complexity Nov 21 OCM-3961 In process of running sanity checks locally Peer reviews and addressing comments  OCM-989 / OCM-4451 worked through issues, 4 remaining set up mtg next week to consider 2024Q1 goals Nov 14 OCM-3961 Rosa CLI fully updated with some minor blockers still being figured out Testing changes and addressing reviews on pr  OCM-989 Nov 7 OCM-3961 Finishing up updating the pkg/aws folder Trying to figure out a blocker in regards to getting Partition Id's Need to update the common repo so that Tag related functions work with v2  OCM-989 Miro board for organizing, no ticket updates Oct 31 OCM-3961 Updating client builder test file and other corresponding files to v2 Created draft pull request for new changes  OCM-989 Working w/ Justin to organize and triage issues Established weekly time during regular "office hours" to triage existing and new issues that arrive in the epic; will start next week.. Oct 24 OCM-3961 Updated mock test generation to v2 Working on updating the client builder to v2  OCM-989 Loading of a Q4 epic started OCM-4451 ROSA squad will regularly review issues for inclusion in upcoming sprints Oct 18 OCM-3961 Started work on updating the ROSA CLI to use aws-sdk-go-v2 module  OCM-989 UX contact assigned, Justin Hale Continue prioritizing issues based upon type (bug) and severity (highest) and date (recently created) OCM-1405 - The editable UI "display name" is inconsistently presented with the CLI. Working w/ UX and stakeholders to determine best solution to reconcile. OCM-1326 - Reproducing AWS error messages for propagation to CLI
    • 0

    Description

      Feature Overview (aka. Goal Summary)  

      The feature available with a new CLI version (TBD) will introduce User Experience (UX) improvements to the ROSA CLI used for creating and managing ROSA clusters and their resources.

      Goals (aka. expected user outcomes)

      • Simplicity as measured by number of times customer have to get help through --help CLI, Documentation or support inquiries

      Requirements (aka. Acceptance Criteria):

      • ROSA CLI fields descriptive of the purpose of the IAM roles
      • ROSA CLI fields for IAM roles have consistent suffix -role or -arn
      • Brevity of CLI command through consolidation of independent fields 
      • ROSA documentation for ROSA CLI calls out what are REQUIRED fields for different use cases (e.g., BYOVPC)
      • ROSA documentation for ROSA CLI calls out the DEFAULTs for each field 
      • ROSA CLI error messages include more direct ways of communicating
      • New fields are added only as alias with backward compatibility to existing fields
      • Old fields are deprecated and then discontinued
      • ROSA CLI fields have consistency with other clients such as OCM UI, Terraform etc.

      Use Cases (Optional):

      Include use case diagrams, main success scenarios, alternative flow scenarios.  Initial completion during Refinement status.

       

      Questions to Answer (Optional):

      Include a list of refinement / architectural questions that may need to be answered before coding can begin.  Initial completion during Refinement status.

       

      Out of Scope

      1. Adding any additional backend capabilities either in OCM or OCP for making changes

      Background

      Provide any additional context is needed to frame the feature.  Initial completion during Refinement status.

       

      Customer Considerations

      Provide any additional customer-specific considerations that must be made when designing and delivering the Feature.  Initial completion during Refinement status.

       

      Documentation Considerations

      Provide information that needs to be considered and planned so that documentation will meet customer needs.  Initial completion during Refinement status.

       

      Interoperability Considerations

      Which other projects and versions in our portfolio does this feature impact?  What interoperability test scenarios should be factored by the layered products?  Initial completion during Refinement status.

      Attachments

        Activity

          People

            Unassigned Unassigned
            rh-ee-bchandra Balachandran Chandrasekaran
            Denis Moskalenko
            Thomas Mckay Thomas Mckay
            Yu Wang Yu Wang
            Justin Hale Justin Hale
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated: