mirror of https://github.com/dapr/docs.git
2.9 KiB
2.9 KiB
| type | title | linkTitle | description |
|---|---|---|---|
| docs | Kubernetes Events binding spec | Kubernetes Events | Detailed documentation on the Kubernetes Events binding component |
Setup Dapr component
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: bindings.kubernetes
version: v1
metadata:
- name: namespace
value: <NAMESPACE>
- name: resyncPeriodInSec
vale: "<seconds>"
namespace(required) is the Kubernetes namespace to read events from.resyncPeriodInSec(optional, default10) the period of time to refresh event list from Kubernetes API server.
Output received from the binding is of format bindings.ReadResponse with the Data field populated with the following structure:
{
"event": "",
"oldVal": {
"metadata": {
"name": "hello-node.162c2661c524d095",
"namespace": "kube-events",
"selfLink": "/api/v1/namespaces/kube-events/events/hello-node.162c2661c524d095",
...
},
"involvedObject": {
"kind": "Deployment",
"namespace": "kube-events",
...
},
"reason": "ScalingReplicaSet",
"message": "Scaled up replica set hello-node-7bf657c596 to 1",
...
},
"newVal": {
"metadata": { "creationTimestamp": "null" },
"involvedObject": {},
"source": {},
"firstTimestamp": "null",
"lastTimestamp": "null",
"eventTime": "null",
...
}
}
Three different event types are available:
- Add : Only the
newValfield is populated,oldValfield is an emptyv1.Event,eventisadd - Delete : Only the
oldValfield is populated,newValfield is an emptyv1.Event,eventisdelete - Update : Both the
oldValandnewValfields are populated,eventisupdate
Required permisiions
For consuming events from Kubernetes, permissions need to be assigned to a User/Group/ServiceAccount using [RBAC Auth] mechanism of Kubernetes.
Role
One of the rules need to be of the form as below to give permissions to get, watch and list events. API Groups can be as restrictive as needed.
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
namespace: <NAMESPACE>
name: <ROLENAME>
rules:
- apiGroups: [""]
resources: ["events"]
verbs: ["get", "watch", "list"]
RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: <NAME>
namespace: <NAMESPACE> # same as above
subjects:
- kind: ServiceAccount
name: default # or as need be, can be changed
namespace: <NAMESPACE> # same as above
roleRef:
kind: Role
name: <ROLENAME> # same as the one above
apiGroup: ""
Related links
- [Bindings building block]({{< ref bindings >}})
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
- [Bindings API reference]({{< ref bindings_api.md >}})