mirror of https://github.com/dapr/docs.git
Added additional information and examples to Azure Event Grid binding's documentation (#618)
* Added additional information and examples how to use the binding locally and in k8s. * Added section about troubleshooting Nginx controller issues. Co-authored-by: Masi Malmi <masi.malmi@polarsquad.com>
This commit is contained in:
Masi
GitHub
parent
82638199bb
commit
7b3c3d7cad
|
|
@ -69,3 +69,171 @@ spec:
|
|||
- `topicEndpoint` is the topic endpoint in which this output binding should publish events
|
||||
|
||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
||||
|
||||
## Additional information
|
||||
|
||||
Event Grid Binding creates an [event subscription](https://docs.microsoft.com/en-us/azure/event-grid/concepts#event-subscriptions) when Dapr initializes. Your Service Principal needs to have the RBAC permissions to enable this.
|
||||
|
||||
```bash
|
||||
# First ensure that Azure Resource Manager provider is registered for Event Grid
|
||||
az provider register --namespace Microsoft.EventGrid
|
||||
az provider show --namespace Microsoft.EventGrid --query "registrationState"
|
||||
# Give the SP needed permissions so that it can create event subscriptions to Event Grid
|
||||
az role assignment create --assignee <clientId> --role "EventGrid EventSubscription Contributor" --scopes <scope>
|
||||
```
|
||||
|
||||
_Make sure to also to add quotes around the `[HandshakePort]` in your Event Grid binding component because Kubernetes expects string values from the config._
|
||||
|
||||
### Testing locally using ngrok and Dapr standalone mode
|
||||
|
||||
- Install [ngrok](https://ngrok.com/download)
|
||||
- Run locally using custom port `9000` for handshakes
|
||||
|
||||
```bash
|
||||
# Using random port 9000 as an example
|
||||
ngrok http -host-header=localhost 9000
|
||||
```
|
||||
|
||||
- Configure the ngrok's HTTPS endpoint and custom port to input binding metadata
|
||||
- Run Dapr
|
||||
|
||||
```bash
|
||||
# Using default ports for .NET core web api and Dapr as an example
|
||||
dapr run --app-id dotnetwebapi --app-port 5000 --port 3500 dotnet run
|
||||
```
|
||||
|
||||
### Testing from Kubernetes cluster
|
||||
|
||||
Azure Event Grid requires a valid HTTPS endpoint for custom webhooks. Self signed certificates won't do. In order to enable traffic from public internet to your app's Dapr sidecar you need an ingress controller enabled with Dapr. There's a good article on this topic: [Kubernetes NGINX ingress controller with Dapr](https://carlos.mendible.com/2020/04/05/kubernetes-nginx-ingress-controller-with-dapr/).
|
||||
|
||||
To get started, first create `dapr-annotations.yaml` for Dapr annotations
|
||||
|
||||
```yaml
|
||||
controller:
|
||||
podAnnotations:
|
||||
dapr.io/enabled: "true"
|
||||
dapr.io/id: "nginx-ingress"
|
||||
dapr.io/port: "80"
|
||||
```
|
||||
|
||||
Then install NGINX ingress controller to your Kubernetes cluster with Helm 3 using the annotations
|
||||
|
||||
```bash
|
||||
helm repo add stable https://kubernetes-charts.storage.googleapis.com/
|
||||
helm install nginx stable/nginx-ingress -f ./dapr-annotations.yaml -n default
|
||||
# Get the public IP for the ingress controller
|
||||
kubectl get svc -l component=controller -o jsonpath='Public IP is: {.items[0].status.loadBalancer.ingress[0].ip}{"\n"}'
|
||||
```
|
||||
|
||||
If deploying to Azure Kubernetes Service, you can follow [the official MS documentation for rest of the steps](https://docs.microsoft.com/en-us/azure/aks/ingress-tls)
|
||||
- Add an A record to your DNS zone
|
||||
- Install cert-manager
|
||||
- Create a CA cluster issuer
|
||||
|
||||
Final step for enabling communication between Event Grid and Dapr is to define `http` and custom port to your app's service and an `ingress` in Kubernetes. This example uses .NET Core web api and Dapr default ports and custom port 9000 for handshakes.
|
||||
|
||||
```yaml
|
||||
# dotnetwebapi.yaml
|
||||
kind: Service
|
||||
apiVersion: v1
|
||||
metadata:
|
||||
name: dotnetwebapi
|
||||
labels:
|
||||
app: dotnetwebapi
|
||||
spec:
|
||||
selector:
|
||||
app: dotnetwebapi
|
||||
ports:
|
||||
- name: webapi
|
||||
protocol: TCP
|
||||
port: 80
|
||||
targetPort: 80
|
||||
- name: dapr-eventgrid
|
||||
protocol: TCP
|
||||
port: 9000
|
||||
targetPort: 9000
|
||||
type: ClusterIP
|
||||
|
||||
---
|
||||
apiVersion: extensions/v1beta1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: eventgrid-input-rule
|
||||
annotations:
|
||||
kubernetes.io/ingress.class: nginx
|
||||
cert-manager.io/cluster-issuer: letsencrypt
|
||||
spec:
|
||||
tls:
|
||||
- hosts:
|
||||
- dapr.<your custom domain>
|
||||
secretName: dapr-tls
|
||||
rules:
|
||||
- host: dapr.<your custom domain>
|
||||
http:
|
||||
paths:
|
||||
- path: /api/events
|
||||
backend:
|
||||
serviceName: dotnetwebapi
|
||||
servicePort: 9000
|
||||
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: dotnetwebapi
|
||||
labels:
|
||||
app: dotnetwebapi
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: dotnetwebapi
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: dotnetwebapi
|
||||
annotations:
|
||||
dapr.io/enabled: "true"
|
||||
dapr.io/id: "dotnetwebapi"
|
||||
dapr.io/port: "5000"
|
||||
spec:
|
||||
containers:
|
||||
- name: webapi
|
||||
image: <your container image>
|
||||
ports:
|
||||
- containerPort: 5000
|
||||
imagePullPolicy: Always
|
||||
```
|
||||
|
||||
Deploy binding and app (including ingress) to Kubernetes
|
||||
|
||||
```bash
|
||||
# Deploy Dapr components
|
||||
kubectl apply -f eventgrid.yaml
|
||||
# Deploy your app and Nginx ingress
|
||||
kubectl apply -f dotnetwebapi.yaml
|
||||
```
|
||||
|
||||
> **Note:** This manifest deploys everything to Kubernetes default namespace.
|
||||
|
||||
**Troubleshooting possible issues with Nginx controller**
|
||||
|
||||
After initial deployment the "Daprized" Nginx controller can malfunction. To check logs and fix issue (if it exists) follow these steps.
|
||||
|
||||
```bash
|
||||
$ kubectl get pods -l app=nginx-ingress
|
||||
|
||||
NAME READY STATUS RESTARTS AGE
|
||||
nginx-nginx-ingress-controller-649df94867-fp6mg 2/2 Running 0 51m
|
||||
nginx-nginx-ingress-default-backend-6d96c457f6-4nbj5 1/1 Running 0 55m
|
||||
|
||||
$ kubectl logs nginx-nginx-ingress-controller-649df94867-fp6mg nginx-ingress-controller
|
||||
|
||||
# If you see 503s logged from calls to webhook endpoint '/api/events' restart the pod
|
||||
# .."OPTIONS /api/events HTTP/1.1" 503..
|
||||
|
||||
$ kubectl delete pod nginx-nginx-ingress-controller-649df94867-fp6mg
|
||||
|
||||
# Check the logs again - it should start returning 200
|
||||
# .."OPTIONS /api/events HTTP/1.1" 200..
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue