PingGateway

Starting with Studio

PingGateway Studio is a user interface to help you build and deploy your PingGateway configuration. There are two ways to create routes in Studio:

  • With the structured editor (deprecated) to build simple routes by using predefined menus and templates. The structured editor presents valid options and default values as you add filters, decorators, and other objects to your configuration.

  • With the FreeForm Designer to design complex, multi-branched routes. Drag handlers and filters from a sidebar onto the canvas to begin designing the route. The FreeForm Designer helps you to visualize the chain and track the path of requests, responses, and contexts.

By default, PingGateway is in production mode. The /routes endpoint isn’t exposed or accessible, effectively disabling Studio.

Access to Studio

Configure access to Studio by following these steps:

  1. Install PingGateway as described in Getting started with PingGateway.

  2. Switch PingGateway to development mode.

    For example, add the following configuration to admin.json and restart PingGateway:

    {
  "mode": "DEVELOPMENT",
  "adminConnector": {
    "host": "localhost",
    "port": 8085
  },
  "connectors": [
    {
      "port": 8080
    }
  ]
}

    Source: admin-dev.json

  3. Configure PingGateway to connect to the sample application over HTTPS with a route to access static resources:

    Learn more in Using the sample application, making sure to restart PingGateway to load your changes.

    When you configure PingGateway with a config.json file, include a main router named _router as in the example.

  4. With PingGateway installed and running in development mode, go to http://ig.example.com:8085/studio to access Studio.

    The browser displays the Routes screen:

    The [.label]#Routes# screen is displayed in Studio.

Upgrades and secrets

During PingGateway upgrade, PingGateway transfers routes you created previously in Studio automatically. Where possible, PingGateway replaces deprecated settings with the newer evolved settings. If PingGateway needs additional information to upgrade a route, the route status becomes Compatibility update required. Select the route and provide the requested information.

You can’t configure secrets providers in Studio.

Documentation examples generated with Studio refer to secrets providers you must configure separately in config.json.