Configuration

fromarray[object]

From list makes a match between clients and corresponding configurations

Hide Child Parameters
defaultobject

Default is a configuration specific to the group of clients referenced in
‘targetRef’

Hide Child Parameters
localobject

LocalConf defines local http or/and tcp rate limit configuration

Hide Child Parameters
httpobject
Show Child Parameters
Show Child Parameters
targetRefobjectrequired

TargetRef is a reference to the resource that represents a group of
clients.

Hide Child Parameters
kindstringrequired

Kind of the referenced resource

Allowed values:MeshMeshSubsetMeshGatewayMeshServiceMeshExternalServiceMeshMultiZoneServiceMeshServiceSubsetMeshHTTPRouteDataplane

labelsobject

Labels are used to select group of MeshServices that match labels. Either Labels or
Name and Namespace can be used.

meshstring

Mesh is reserved for future use to identify cross mesh resources.

namestring

Name of the referenced resource. Can only be used with kinds: MeshService,
MeshServiceSubset and MeshGatewayRoute

namespacestring

Namespace specifies the namespace of target resource. If empty only resources in policy namespace
will be targeted.

proxyTypesarray[string]

ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
all data plane types are targeted by the policy.

Allowed values:SidecarGateway

sectionNamestring

SectionName is used to target specific section of resource.
For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected.

tagsobject

Tags used to select a subset of proxies by tags. Can only be used with kinds
MeshSubset and MeshServiceSubset

rulesarray[object]

Rules defines inbound rate limiting configurations. Currently limited to
selecting all inbound traffic, as L7 matching is not yet implemented.

Hide Child Parameters
defaultobject

Default contains configuration of the inbound rate limits

Hide Child Parameters
localobject

LocalConf defines local http or/and tcp rate limit configuration

Hide Child Parameters
httpobject
Show Child Parameters
Show Child Parameters
targetRefobject

TargetRef is a reference to the resource the policy takes an effect on.
The resource could be either a real store object or virtual resource
defined inplace.

Hide Child Parameters
kindstringrequired

Kind of the referenced resource

Allowed values:MeshMeshSubsetMeshGatewayMeshServiceMeshExternalServiceMeshMultiZoneServiceMeshServiceSubsetMeshHTTPRouteDataplane

labelsobject

Labels are used to select group of MeshServices that match labels. Either Labels or
Name and Namespace can be used.

meshstring

Mesh is reserved for future use to identify cross mesh resources.

namestring

Name of the referenced resource. Can only be used with kinds: MeshService,
MeshServiceSubset and MeshGatewayRoute

namespacestring

Namespace specifies the namespace of target resource. If empty only resources in policy namespace
will be targeted.

proxyTypesarray[string]

ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
all data plane types are targeted by the policy.

Allowed values:SidecarGateway

sectionNamestring

SectionName is used to target specific section of resource.
For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected.

tagsobject

Tags used to select a subset of proxies by tags. Can only be used with kinds
MeshSubset and MeshServiceSubset

toarray[object]

To list makes a match between clients and corresponding configurations

Hide Child Parameters
defaultobject

Default is a configuration specific to the group of clients referenced in
‘targetRef’

Hide Child Parameters
localobject

LocalConf defines local http or/and tcp rate limit configuration

Hide Child Parameters
httpobject
Show Child Parameters
Show Child Parameters
targetRefobjectrequired

TargetRef is a reference to the resource that represents a group of
clients.

Hide Child Parameters
kindstringrequired

Kind of the referenced resource

Allowed values:MeshMeshSubsetMeshGatewayMeshServiceMeshExternalServiceMeshMultiZoneServiceMeshServiceSubsetMeshHTTPRouteDataplane

labelsobject

Labels are used to select group of MeshServices that match labels. Either Labels or
Name and Namespace can be used.

meshstring

Mesh is reserved for future use to identify cross mesh resources.

namestring

Name of the referenced resource. Can only be used with kinds: MeshService,
MeshServiceSubset and MeshGatewayRoute

namespacestring

Namespace specifies the namespace of target resource. If empty only resources in policy namespace
will be targeted.

proxyTypesarray[string]

ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
all data plane types are targeted by the policy.

Allowed values:SidecarGateway

sectionNamestring

SectionName is used to target specific section of resource.
For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected.

tagsobject

Tags used to select a subset of proxies by tags. Can only be used with kinds
MeshSubset and MeshServiceSubset

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!