Gateway Channels

A gateway channels defines path segment(s) mappings to systems for distributing requests across different runners.

Gateway Channel UI

All channels share the following settings:

• Target: Path segment(s) representing this channel (e.g. /api/crud).

• System: Id of the gateway system that communicates for this channel.

• Method: Method for communicating through the gateway system (e.g. POST).

• Gateways: List of gateway ids which are allowed to communicate with this system.

Authentication requirements for a channel are defined with the following settings:

• Auth Token: Id of the gateway token to use for user authentication

• Anonymous Token: Id of the gateway token to use for guest identification

• Paths: Customized authentication settings for different paths on the channel:

  • Path: Path segment for customization (e.g. product). * is used as a wildcard meaning all paths. [path]/* is used to allow all subpaths of a given path.

  • Is Public: Whether path can be accessed without authentication

  • Access Token Verification Required: Whether gateway can rely on its own tokens for authentication, or it should ask authentication server for each request

  • Methods: Customized authentication settings for different call methods on the channel:

    • Method: Name of the method (e.g. GET). * is used as a wildcard meaning all methods.

    • Accessing Roles: List of user roles which are allowed access for this method (e.g. admin). Leaving this list empty or including * as a role allows access for all users regardless of their roles.

Resilience requirements for a channel are defined with the following settings:

• Rate Limit: Rate limit settings based on resilience4j parameters.

• Paths: Customized resilience settings for different path segments.

  • Path: Path segment for customization (e.g. product). * is used as a wildcard meaning all paths.

  • Circuit Break: Circuit breaker settings based on resilience4j parameters.

CircuitBreakerresilience4j

Resilience4j Circuit Breaker