On this page
LuaPolicy
LuaPolicy API reference.
Proto: lua_policy.proto
Package: extensions.policy.gloo.solo.io
Types:
- LuaPolicyReport
- LuaPolicyReport.WorkspacesEntry
- LuaPolicySpec
- LuaPolicySpec.Config
- LuaPolicySpec.Config.SourceCode
- LuaPolicyStatus
LuaPolicyReport
The report shows the resources that the policy selects after the policy is successfully applied.
| Field | Description |
|---|---|
workspaces | (repeated LuaPolicyReport.WorkspacesEntry)The status of the resource in each workspace that it exists in. |
selectedRoutes | (repeated common.gloo.solo.io.RouteReference)A list of references to all routes selected by the policy. |
selectedDestinationPorts | (repeated common.gloo.solo.io.DestinationReference)A list of destination ports selected by the policy. |
LuaPolicyReport.WorkspacesEntry
| Field | Description |
|---|---|
key | (string) |
value | (common.gloo.solo.io.Report) |
LuaPolicySpec
Specifications for the policy.
| Field | Description |
|---|---|
applyToRoutes | (repeated common.gloo.solo.io.RouteSelector)Select the routes where the policy will be applied. If empty ( {}), the policy applies to all routes in the workspace. If omitted and the policy also does not select any destinations, the policy applies to all routes in the workspace. If omitted and the policy selects a destination, the policy does not apply to any routes. |
applyToDestinations | (repeated common.gloo.solo.io.DestinationSelector)Select the destinations where the policy will be applied. Only Kubernetes services are supported. By default if omitted, the policy does not apply to any destinations. If empty ( {}), the policy applies to all destinations in the workspace. |
config | (LuaPolicySpec.Config)The details of the Lua policy to apply to the selected routes and destinations. |
LuaPolicySpec.Config
The details of the Lua policy to apply to the selected routes and destinations.
| Field | Description |
|---|---|
sourceCode | (LuaPolicySpec.Config.SourceCode)Lua code to be executed by the policy. Both envoy_on_request and envoy_on_response functions are supported. |
phase | (common.gloo.solo.io.PrioritizedPhase)Optional: Set when to apply the Lua filter in the request chain, either before ( preAuthz) or after (postAuthz) authorization. If no phase is specified, defaults to preAuthz. |
LuaPolicySpec.Config.SourceCode
| Field | Description |
|---|---|
inlineString | (string)Lua code in string format. |
LuaPolicyStatus
The status of the policy after it is applied to your Gloo environment.Status
| Field | Description |
|---|---|
common | (common.gloo.solo.io.Status)The state and workspace conditions of the applied resource. |
numSelectedRoutes | (uint32)The number of routes selected by the policy. |
numSelectedDestinationPorts | (uint32)The number of destination ports selected by the policy. |