Uploaded image for project: 'Ansible Automation Platform RFEs'
  1. Ansible Automation Platform RFEs
  2. AAPRFE-2002

Make underlying component Org/Team API information more intuitive

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      What is the nature and description of the request?

      With the addition of the Gateway node, Teams are stored both in the Gateway node and the individual components (EDA, Hub, controller). With AAP 2.4, it was easy to determine the Org/Team ID from the UI by looking at the URL.

      For example, navigating to an organization in AAP 2.4, uses the following URL

       

      https://$CONTROLLER_URL/#/organizations/#ORG_ID/details

       

      With this organization ID, you could create an Inventory for that organization through the API using a curl command like

       

      curl https://$CONTROLLER_URL/api/v2/inventories/ -H "Content-Type: application/json" -k -d '{"name": "My Inventory", "organization": $ORGANZATION_ID}' -u user:password

       

       

      In AAP 2.5, navigating to an organization in the UI, shows the following URL

       

      https://$GATEWAY_URL/access/organizations/$GATEWAY_ORGANIZATION_ID/details

       

      If we try to use the $GATEWAY_ORGANIZATION_ID in the same type of curl command on AAP 2.5, we would do the following:

       

      curl https://$GATEWAY_URL/api/controller/v2/inventories/ -H "Content-Type: application/json" -k -d '{"name": "My Inventory", "organization": $GATEWAY_ORGANIZATION_ID}' -u user:password

       

      Using the $GATEWAY_ORGANIZATION_ID on the controller API (which users are used to doing!) can create multiple potential issues.

      1. the inventory can be created under the incorrect organization
      2. the user may not be able to create the inventory because they don't have permissions to the incorrect organization

       

      Why does the customer need this? (List the business requirements here)

      This confuses the user because they are used to doing things a certain way, and nothing tells them otherwise. 

       

      How would you like to achieve this? (List the functional requirements here)

      The best solution would be to use the supported collections

      However, this change in behavior should be noted in our documentation at a minimum.

      Alternatively, a more intuitive method to display or obtain the correct ORG ID would be useful. 

       

      Additional Info

      I've created the following KCS which can be used as a template for the official documentation update

      https://access.redhat.com/solutions/7113658

              lmaynard@redhat.com Lynne Maynard
              jbird@redhat.com Jeffrey Bird
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: