Uploaded image for project: 'Managed Service - API'
  1. Managed Service - API
  2. MGDAPI-5461

Update "Adding and accessing Red Hat OpenShift API Management" for ROSA

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • None
    • 3
    • False
    • None
    • False
    • No
    • RHOAM Docs Sprint 39, RHOAM Doc Sprint 40

      I have several suggestions for the "Adding and accessing Red Hat OpenShift API Management" doc, which I think might help to improve it for ROSA:

      The "Adding OpenShift API Management to your cluster" procedure is for both OSD and ROSA, but then the next procedure is "Adding OpenShift API Management to your Red Hat OpenShift Service on AWS cluster". So if I want to install RHOAM for ROSA, which procedure should I use? Maybe consider the following structure:

      • Adding OpenShift API Management to your cluster
        • Adding OpenShift API Management using OpenShift Cluster Manager
        • Adding OpenShift API Management to ROSA using the CLI

      Throughout the doc, consider using "ROSA" as the short product name instead of the full "Red Hat OpenShift Service on AWS" name. In the ROSA docs, the common way to handle this is, for the first mention, the full product name is used ("Red Hat OpenShift Service on AWS (ROSA)"), and then each subsequent mention is just the abbreviation "ROSA". See the intro paragraph here, for example: https://docs.openshift.com/rosa/welcome/index.html.


      "Adding OpenShift API Management to your STS enabled Red Hat OpenShift Service on AWS cluster" - STS is now the heavily preferred method for deploying ROSA (Red Hat strongly encourages customers to use this method, and the non-STS method is likely to be phased out). So I think we can safely assume that virtually all ROSA customers that add RHOAM will be using STS. In addition, I think the steps in this procedure can be moved to the previous procedure ("Adding OpenShift API Management to your Red Hat OpenShift Service on AWS cluster"). In other words, I would consider removing this procedure all together, and moving the steps to the end of the previous one (since the steps are part of the process you have to go through to add RHOAM to a ROSA cluster). 

            joaedwar@redhat.com Joan Edwards
            behardesty Ben Hardesty
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: