Uploaded image for project: 'Red Hat 3scale API Management'
  1. Red Hat 3scale API Management
  2. THREESCALE-7322

Include NGINX phase information in policy description and high level picture

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Done
    • Icon: Major Major
    • 2.11.0 GA
    • 2.10 GA, 2.11.0 CR1
    • Documentation
    • None
    • 3scale-doc-2021-09-27, 3scale-doc-2021-11-01, 3scale-doc-2021-11-22, API Sprint 19

      Now we have 32 standard policies list in our product documentation. These policies are executed in different Nginx phases. Unfortunately we don't have much information on which policy execute at which Nginx phases. This will result in some queries and confusions when some policies are added in different orders, as well as some questions like, "why some policies will have to be placed before (or after) the builtin 3scale APICast policy to function?"

      This request is to show the customer a more clearer perspective on which phase each policy is running on, and provide a full diagram picture about the different phases involved. Like below screenshot order of lua nginx module directive.

      The goal is to answer the below questions:
      1. When my policy is executed in the request/response flow?
      2. When I have multiple policies that forms a policy chain, how the order of the policy affect the request/response header and content.
      3. If I have some custom policy and place it in the policy chain, how it will work together with the standard policies ?

      So, could we:
      1. have a similar diagram that shows all the related phases, in a more end user friendly way?
      2. Update our product documentation to specify the phase(s) associated for each standard policy we provided. I understand maybe some policy (e.g 3scale APICast) will be involved in more than one phase. But still it is beneficial for customers to understand more about the policy chain and use our product more maturely.

            Unassigned Unassigned
            rhn-support-bihu Bin Hu
            Tova Cohen Tova Cohen (Inactive)
            Tova Cohen Tova Cohen (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: