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

Documentation about usage of the APIcast self_managed option

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Critical Critical
    • None
    • 2.6 GA, 2.7 GA
    • Documentation
    • 3scale 2019-12-23

      Originally opened as a Zync Bug with the following details:

      Steps to reproduce:
      Conflicting routes created when APICAST_PATH_ROUTING=true and "deployment_option":"hosted"	
      
      1. Promote the configuration of the default API Service and check that the routes 
      https://api-3scale-apicast-staging.{THREESCALE_SUPERDOMAIN}
      https://api-3scale-apicast-production.{THREESCALE_SUPERDOMAIN}
      exist.
      
      2. Create one additional service with `"deployment_option":"hosted"`: two new routes will be created for the new service.
      
      3. From the Integration Settings of the new Service, set the Public Base URLs of staging and production environments to be the same as those in the default API service from step 1 (as it normally would happen when APICAST_PATH_ROUTING=true) and promote the changes to Staging and Production.
      
      Description:
      Referring to the Steps to Reproduce:
      * The two routes from step 2 will be renamed to be conflicting with those of step 1.
      * Periodically the production route will be deleted and recreated. The staging route will remain unchanged.
      
      Check attached logs (zync-que-1-dh2lh.log), names of the routes:
      
      apicast-production route:             zync-3scale-api-6c2c7
      one of apicast-production recreated:  zync-3scale-api-kfhwx
      apicast-staging route:                zync-3scale-api-cz4jh
      

      It seems like the Documentation could be improved, to include all the scenarios when the APIcast `self_managed` option would be a good fit.

      Example scenarios of the usage of self_managed:

      • when using an external APIcast
      • when willing to manage routes manually
      • when using a common host across multiple services with APICAST_PATH_ROUTING = true (this is the scenario described in the original JIRA and in this KCS)

      These would be important details to add to the 2.7 documentation as well, probably not just in the `upgrading 2.5 to 2.6` docs.

      At the moment few details about the usage of `self_managed` can be found here.

            Unassigned Unassigned
            rhn-support-sillumin Samuele Illuminati (Inactive)
            Darren Fennessy Darren Fennessy
            Votes:
            0 Vote for this issue
            Watchers:
            8 Start watching this issue

              Created:
              Updated:
              Resolved: