Exposing EventListeners Externally

By default, ClusterIP services such as the EventListener sink are accessible within the cluster. There are a few ways of exposing it so that external services can talk to it:

Using an Ingress

You can use an Ingress resource to expose the EventListener. The create-ingress Tekton task can help setup an ingress resource using self-signed certs.

Note: If you are using a cloud hosted Kubernetes solution such as GKE, the built-in ingress will not work with ClusterIP services. Instead, you can use the Nginx Ingress based approach below.

Using Nginx Ingress

The following instructions have been tested on GKE cluster running version 1.13.7-gke.24. Instructions for installing nginx Ingress on other Kubernetes services can be found here.

  1. First, install Nginx ingress controller. One liner below, check the website for more information: 
       # Check https://kubernetes.github.io/ingress-nginx/deploy for other installation options
   kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.34.1/deploy/static/provider/cloud/deploy.yaml
  2. Find the service name expose by the Eventlistener service: 
     kubectl get el <EVENTLISTENR_NAME> -o=jsonpath='{.status.configuration.generatedName}{"\n"}'
  3. Create the Ingress resource. A sample Ingress is below. Check the docs here for a full range of configuration options.
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: ingress-resource
  annotations:
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/ssl-redirect: "false"
spec:
  rules:
    - http:
        paths:
          - path: /
            backend:
              serviceName: EVENT_LISTENER_SERVICE_NAME # REPLACE WITH YOUR SERVICE NAME FROM STEP 2
              servicePort: 8080
  1. Try it out! Get the address of the Ingress by running kubectl get ingress ingress-resource and noting the address field. You can curl this IP or setup a GitHub webhook to send events to it.

Using Openshift Route

The following instructions have been tested on Openshift 4.2 cluster running version v1.14.6+32dc4a0. Further information can be found here

  1. Find the service name expose by the Eventlistener service: 
     oc get el <EVENTLISTENR_NAME> -o=jsonpath='{.status.configuration.generatedName}'
  2. Expose the service using openshift route: 
     oc expose svc/[el-listener] # REPLACE el-listener WITH YOUR SERVICE NAME FROM STEP 1
  3. Get the address of the Openshift Route: 
     oc get route el-listener  -o=jsonpath='{.spec.host}' # REPLACE el-listener WITH YOUR SERVICE NAME FROM STEP 1
  4. Try it out! You can use the url received above to setup a GitHub webhook for receiving events or you can curl this url.