5.1.5 Ingress Gateway Parameters
Listed below are the customizable Ingress Gateway parameters:
Table 5-10 Routes Config Customizable Parameters
| Parameter | Description | Details |
|---|---|---|
globalRemoveRequestHeader[0].name |
This field is used for blacklisting (removing) a request header at global level. Hence, it will be applied to all routes configured. Additional header can be configured by adding a new element in the next line and so on. | Default Value: Value to be updated accordingly |
globalRemoveResponseHeader[0].name |
This field is used for blacklisting(removing) a response header at global level. Hence, it will be applied to all routes configured. Additional header can be configured by adding a new element in the next line and so on. | Default Value: Value to be updated accordingly |
routesConfig[0].id |
This is a mandatory parameter. Id of the route. |
Default Value: Value to be updated accordingly |
routesConfig[0].uri |
This is a mandatory parameter. Service name of the internal microservice of this NF. |
Default Value: Value to be updated accordingly |
routesConfig[0].path |
This is a mandatory parameter. Provide the path to be matched. |
Default Value: Value to be updated accordingly |
routesConfig[0].order |
This is a mandatory parameter. Provide the order of the execution of this route. |
Default Value: Value to be updated accordingly |
routesConfig[0].metadata.requestTimeout |
requestTimeout is used to set timeout at route level. Value should be in milliseconds. If present then it will override global request timeout | Default Value:0 |
routesConfig[0].metadata.xfccHeaderValidation.validationEnabled |
This is used to provide an option to enable or disable route level xfccHeaderValidation, it will override global configuration for xfccHeaderValidation.enabled | Default Value:False |
routesConfig[0].metadata.oauthValidator.enabled |
Default Value: Value to be updated accordingly | |
routesConfig[0].metadata.ccaHeaderValidation.enabled |
This is used to provide an option to enable or disable route level ccaHeaderValidation, it will override global configuration for ccaHeaderValidation.enabled |
Default Value:False |
routesConfig[0].filters.invalidRouteFilter.errorCodeOnInvalidRoute |
This is a mandatory parameter. If invalidRouteFilter filter is configured, then keep the 'order' value highest compared to other routesComment the parameters related to invalidRouteFilter if configurable error code is not required for invalid route. Configurable error code for invalid route. |
Default Value: Value to be updated accordingly |
routesConfig[0].filters.invalidRouteFilter.errorCauseOnInvalidRoute |
This is a mandatory parameter. Error cause for invalid route. |
Default Value: Value to be updated accordingly |
routesConfig[0].filters.invalidRouteFilter.errorTitleOnInvalidRoute |
This is a mandatory parameter. Error title for invalid route. |
Default Value: Value to be updated accordingly |
routesConfig[0].filters.invalidRouteFilter.errorDescriptionOnInvalidRoute |
This is a mandatory parameter. Error description for invalid route. |
Default Value: Value to be updated accordingly |
routesConfig[0].filters.removeRequestHeader[0].name |
This field is used for blacklisting(removing) a request header at route level. Additional header can be configured by adding a new element in the next line and so on. | The value of "name" attribute denotes the name of the request header which is to be blacklisted/removed at route level. Add a new entry in next line for every header to be removed. |
routesConfig[0].filters.removeResponseHeader[0].name |
Below field is used for blacklisting(removing) a response header at route level. Additional header can be configured by adding a new element in the next line and so on. | The value of "name" attribute denotes the name of the response header which is to be blacklisted/removed at route level. Add a new entry in next line for every header to be removed. |
routesConfig[0].metadata.svcName |
The following parameter configurable per route in route-metadata is used to track Overload Control data. If this parameter is not configured in route metadata then svc name from routesConfig[0].uri field is used as the required key to track Overload Control data. | The value of "svcName" attribute denotes the back-end service tag to be used as the required key (configurable per route) to track Overload Control data instead of using back-end service name from routesConfig[0].uri as the required key |
routesConfig[0].metadata.serverHeaderDetails.enabled |
Server header configuration if defined at Route level (irrespective of being enabled/disabled) will take precedence over the Global conf. | Default Value: Value to be updated accordingly |
routesConfig[0].metadata.serverHeaderDetails.errorCodeSeriesId |
If not defined here, value at Global level will be used as fallback. Value need to be one among "errorCodeSeriesList" resource defined. | Default Value: Value to be updated accordingly |
routesConfig[0].metadata.requiredTime |
If isSbiTimerEnabled is true then this is the minimum time required to process an incoming request. If the timeout falls below this then request will be rejected. | Default Value: Value to be updated accordingly |