Configure Docker PoC for sideband

You can optionally configure the Docker PoC environment for a sideband deployment with an API Gateway. The Docker PoC package ships with sample API swagger definition files which can be adapted to support your API Gateway environment. PingIntelligence sideband policies and documentation can be downloaded from the Ping download site.

Configure Docker package for sideband

Navigate to config directory and edit the poc.config file to set mode as sideband. Following is a sample poc.config file.

# API Security Enforcer mode.
# allowed values: inline, sideband
ase_mode=inline

# initial training period in hours
training_period=1

# poc mode for training
poc_mode=true


Below Configuration is applicable only when ase_mode is set to sideband

# API gateway ip address or dns name
gateway_ip=
# API gateway port
gateway_port=443
# set gateway protocol if API gateway is configured with ssl
# else set it to tcp
# allowed values: tcp, ssl
gateway_protocol=ssl

The following table describes the variables.

Variable Description

Variable	Description
`ase_mode`	Defines the deployment mode of ASE. Possible values are `inline` and `sideband`. Default value is `inline`.
`training_period`	Training period of AI engine in hours. Minimum value is 1-hour.
`poc_mode`	Defines the mode in which ABS AI engine trains its models. Default value is `true`. It is recommended to keep the value as `true`. If you change it to `false`, it may take longer time to set all the attack thresholds.
`gateway_ip`	Configure the URL for API gateway.
`gateway_port`	Port number of API gateway URL
`gateway_protocol`	API gateway protocol. Possible values are `ssl` or `tcp`.

ase_mode

Defines the deployment mode of ASE. Possible values are inline and sideband. Default value is inline.

training_period

Training period of AI engine in hours. Minimum value is 1-hour.

poc_mode

Defines the mode in which ABS AI engine trains its models. Default value is true. It is recommended to keep the value as true. If you change it to false, it may take longer time to set all the attack thresholds.

gateway_ip

Configure the URL for API gateway.

gateway_port

Port number of API gateway URL

gateway_protocol

API gateway protocol. Possible values are ssl or tcp.