Careful!

You are browsing documentation for a version of Kuma that is not the latest release.

Looking for even older versions? Learn more.

MeshTrafficPermission (beta)

This policy uses new policy matching algorithm and is in beta state, it should not be mixed with TrafficPermission.

TargetRef support matrix

TargetRef type	top level	to	from
Mesh	✅	❌	✅
MeshSubset	✅	❌	✅
MeshService	✅	❌	✅
MeshServiceSubset	✅	❌	✅

If you don’t understand this table you should read matching docs.

Configuration

Action

Kuma allows configuring one of 3 actions for a group of service’s clients:

ALLOW - allows incoming requests matching the from targetRef.
DENY - denies incoming requests matching the from targetRef
ALLOW_WITH_SHADOW_DENY - same as ALLOW but will log as if request is denied, this is useful for rolling new restrictive policies without breaking things.

Examples

Service ‘payments’ allows requests from ‘orders’

Kubernetes
Universal

apiVersion: kuma.io/v1alpha1
kind: MeshTrafficPermission
metadata:
  namespace: kuma-system
  name: allow-orders
spec:
  targetRef: # 1
    kind: MeshService
    name: payments
  from:
    - targetRef: # 2
        kind: MeshService
        name: orders
      default: # 3
        action: ALLOW

type: MeshTrafficPermission
name: allow-orders
mesh: default
spec:
  targetRef: # 1
    kind: MeshService
    name: payments
  from:
    - targetRef: # 2
        kind: MeshService
        name: orders
      default: # 3
        action: ALLOW

Explanation

Top level targetRef selects data plane proxies that implement payments service. MeshTrafficPermission allow-orders will be configured on these proxies.
```
 targetRef: # 1
   kind: MeshService
   name: payments
```
TargetRef inside the from array selects proxies that implement order service. These proxies will be subjected to the action from default.action.
```
 - targetRef: # 2
     kind: MeshService
     name: orders
```
The action is ALLOW. All requests from service orders will be allowed on service payments.
```
 default: # 3
   action: ALLOW
```

apiVersion: kuma.io/v1alpha1
kind: MeshTrafficPermission
metadata:
  namespace: kuma-system
  name: deny-all
spec:
  targetRef: # 1
    kind: Mesh
  from:
    - targetRef: # 2
        kind: Mesh
      default: # 3
        action: DENY

type: MeshTrafficPermission
name: deny-all
mesh: default
spec:
  targetRef: # 1
    kind: Mesh
  from:
    - targetRef: # 2
        kind: Mesh
      default: # 3
        action: DENY

Explanation

Top level targetRef selects all proxies in the mesh.
```
 targetRef: # 1
   kind: Mesh
```
TargetRef inside the from array selects all clients.
```
 - targetRef: # 2
     kind: Mesh
```
The action is DENY. All requests from all services will be denied on all proxies in the default mesh.
```
 default: # 3
   action: DENY
```

Allow requests from zone ‘us-east’, deny requests from ‘dev’ environment

Kubernetes
Universal

apiVersion: kuma.io/v1alpha1
kind: MeshTrafficPermission
metadata:
  namespace: kuma-system
  name: example-with-tags
spec:
  targetRef: # 1
    kind: Mesh
  from:
    - targetRef: # 2
        kind: MeshSubset
        tags:
          kuma.io/zone: us-east
      default: # 3
        action: ALLOW
    - targetRef: # 4
        kind: MeshSubset
        tags:
          env: dev
      default: # 5
        action: DENY

Apply the configuration with kubectl apply -f [..].

type: MeshTrafficPermission
name: example-with-tags
mesh: default
spec:
  targetRef: # 1
    kind: Mesh
  from:
    - targetRef: # 2
        kind: MeshSubset
        tags:
          kuma.io/zone: us-east
      default: # 3
        action: ALLOW
    - targetRef: # 4
        kind: MeshSubset
        tags:
          env: dev
      default: # 5
        action: DENY

Apply the configuration with kumactl apply -f [..] or with the HTTP API.

Explanation

Top level targetRef selects all proxies in the mesh.
```
 targetRef: # 1
   kind: Mesh
```
TargetRef inside the from array selects proxies that have label kuma.io/zone: us-east. These proxies will be subjected to the action from default.action.
```
 - targetRef: # 2
     kind: MeshSubset
     tags:
       kuma.io/zone: us-east
```
The action is ALLOW. All requests from the zone us-east will be allowed on all proxies.
```
 default: # 3
   action: ALLOW
```
TargetRef inside the from array selects proxies that have tags kuma.io/zone: us-east. These proxies will be subjected to the action from default.action.
```
 - targetRef: # 4
     kind: MeshSubset
     tags:
       env: dev
```
The action is DENY. All requests from the env dev will be denied on all proxies.
```
 default: # 5
   action: DENY
```

Order of rules inside the from array matters. Request from the proxy that has both kuma.io/zone: east and env: dev will be denied. This is because the rule with DENY is later in the from array than any ALLOW rules.

← MeshAccessLog (Beta) HTTP API →