Hello World - Python

A simple web app written in Python that you can use to test knative eventing. It shows how to consume a CloudEvent in Knative eventing, and optionally how to respond back with another CloudEvent in the http response, by adding the Cloud Eventing headers outlined in the Cloud Events standard definition.

We will deploy the app as a Kubernetes Deployment along with a Kubernetes Service. However, you can also deploy the app as a Knative Serving Service.

Do the following steps to create the sample code and then deploy the app to your cluster. You can also download a working copy of the sample, by running the following commands:

  1. # Clone the relevant branch version such as "release-0.13"
  2. git clone -b "release-1.0" https://github.com/knative/docs knative-docs
  3. cd knative-docs/docs/eventing/samples/helloworld/helloworld-python

Before you begin

  • A Kubernetes cluster with Knative Eventing installed.
  • Docker installed and running on your local machine, and a Docker Hub account configured (we’ll use it for a container registry).

Recreating the sample code

  1. Create a new file named helloworld.py and paste the following code. This code creates a basic web server which listens on port 8080:

    1. from flask import Flask, request, make_response
    2. import uuid
    4. app = Flask(__name__)
    6. @app.route('/', methods=['POST'])
    7. def hello_world():
    8.     app.logger.warning(request.data)
    9.     # Respond with another event (optional)
    10.     response = make_response({
    11.         "msg": "Hi from helloworld-python app!"
    12.     })
    13.     response.headers["Ce-Id"] = str(uuid.uuid4())
    14.     response.headers["Ce-specversion"] = "0.3"
    15.     response.headers["Ce-Source"] = "knative/eventing/samples/hello-world"
    16.     response.headers["Ce-Type"] = "dev.knative.samples.hifromknative"
    17.     return response
    19. if __name__ == '__main__':
    20.     app.run(debug=True, host='0.0.0.0', port=8080)

  2. Add a requirements.txt file containing the following contents:

    1. Flask==1.1.1

  3. In your project directory, create a file named Dockerfile and copy the following code block into it. For detailed instructions on dockerizing a Go app, see Deploying Go servers with Docker.

    1. FROM python:alpine3.7
    3. COPY . /app
    5. WORKDIR /app
    7. RUN pip install -r requirements.txt
    9. EXPOSE 8080
    11. ENTRYPOINT [ "python" ]
    13. CMD [ "helloworld.py" ]

  4. Create a new file, sample-app.yaml and copy the following service definition into the file. Make sure to replace {username} with your Docker Hub username.

    1. # Namespace for sample application with eventing enabled
    2. apiVersion: v1
    3. kind: Namespace
    4. metadata:
    5.   name: knative-samples
    6.   labels:
    7.        eventing.knative.dev/injection: enabled
    8. ---
    9. # A default broker
    10. apiVersion: eventing.knative.dev/v1
    11. kind: Broker
    12. metadata:
    13.   name: default
    14.   namespace: knative-samples
    15.   annotations:
    16.     # Note: you can set the eventing.knative.dev/broker.class annotation to change the class of the broker.
    17.     # The default broker class is MTChannelBasedBroker, but Knative also supports use of the other class.
    18.     eventing.knative.dev/broker.class: MTChannelBasedBroker
    19. spec: {}
    20. ---
    21. # Helloworld-python app deployment
    22. apiVersion: apps/v1
    23. kind: Deployment
    24. metadata:
    25.   name: helloworld-python
    26.   namespace: knative-samples
    27. spec:
    28.   replicas: 1
    29.   selector:
    30.     matchLabels: &labels
    31.       app: helloworld-python
    32.   template:
    33.     metadata:
    34.       labels: *labels
    35.     spec:
    36.       containers:
    37.         - name: helloworld-python
    38.           image: docker.io/{username}/helloworld-python
    39.           imagePullPolicy: IfNotPresent
    40. ---
    41. # Service that exposes helloworld-python app.
    42. # This will be the subscriber for the Trigger
    43. apiVersion: v1
    44. kind: Service
    45. metadata:
    46.   name: helloworld-python
    47.   namespace: knative-samples
    48. spec:
    49.   selector:
    50.     app: helloworld-python
    51.   ports:
    52.   - protocol: TCP
    53.     port: 80
    54.     targetPort: 8080
    55. ---
    56. # Knative Eventing Trigger to trigger the helloworld-python service
    57. apiVersion: eventing.knative.dev/v1
    58. kind: Trigger
    59. metadata:
    60.   name: helloworld-python
    61.   namespace: knative-samples
    62. spec:
    63.   broker: default
    64.   filter:
    65.     attributes:
    66.       type: dev.knative.samples.helloworld
    67.       source: dev.knative.samples/helloworldsource
    68.   subscriber:
    69.     ref:
    70.       apiVersion: v1
    71.       kind: Service
    72.       name: helloworld-python

Building and deploying the sample

Once you have recreated the sample code files (or used the files in the sample folder) you’re ready to build and deploy the sample app.

  1. Use Docker to build the sample code into a container. To build and push with Docker Hub, run these commands replacing {username} with your Docker Hub username:

    1. # Build the container on your local machine
    2. docker build -t {username}/helloworld-python .
    3. # Push the container to docker registry
    4. docker push {username}/helloworld-python

  2. After the build has completed and the container is pushed to Docker Hub, you can deploy the sample application into your cluster. Ensure that the container image value in sample-app.yaml matches the container you built in the previous step. Apply the configuration using kubectl:

    1. kubectl apply -f sample-app.yaml

  3. The previous command creates a namespace knative-samples and labels it with knative-eventing-injection=enabled, to enable eventing in the namespace. Verify using the following command:

    1. kubectl get ns knative-samples --show-labels

  4. It deployed the helloworld-python app as a K8s Deployment and created a K8s service names helloworld-python. Verify using the following command:

    1. kubectl --namespace knative-samples get deployments helloworld-python
    2. kubectl --namespace knative-samples get svc helloworld-python

  5. It created a Knative Eventing Trigger to route certain events to the helloworld-python application. Make sure that Ready=true:

    1. kubectl -n knative-samples get trigger helloworld-python

Send and verify CloudEvents

After you have deployed the application, and have verified that the namespace, sample application and trigger are ready, you can send a CloudEvent.

Send CloudEvent to the Broker

You can send an HTTP request directly to the Knative Broker if the correct CloudEvent headers are set.

  1. Deploy a curl pod and SSH into it:

    1. kubectl --namespace knative-samples run curl --image=radial/busyboxplus:curl -it

  2. Run the following command in the SSH terminal:

    1. curl -v "broker-ingress.knative-eventing.svc.cluster.local/knative-samples/default" \
    2. -X POST \
    3. -H "Ce-Id: 536808d3-88be-4077-9d7a-a3f162705f79" \
    4. -H "Ce-specversion: 0.3" \
    5. -H "Ce-Type: dev.knative.samples.helloworld" \
    6. -H "Ce-Source: dev.knative.samples/helloworldsource" \
    7. -H "Content-Type: application/json" \
    8. -d '{"msg":"Hello World from the curl pod."}'
    9. exit

Verify that event is received by helloworld-python app

The Helloworld-python app logs the context and the msg of the event you created earlier, and replies with another event.

  1. Display helloworld-python app logs

    1. kubectl --namespace knative-samples logs -l app=helloworld-python --tail=50

    You should see something similar to:

    1. Event received. Context: Context Attributes,
    2.   specversion: 0.3
    3.   type: dev.knative.samples.helloworld
    4.   source: dev.knative.samples/helloworldsource
    5.   id: 536808d3-88be-4077-9d7a-a3f162705f79
    6.   time: 2019-10-04T22:35:26.05871736Z
    7.   datacontenttype: application/json
    8. Extensions,
    9.   knativearrivaltime: 2019-10-04T22:35:26Z
    10.   knativehistory: default-kn2-trigger-kn-channel.knative-samples.svc.cluster.local
    11.   traceparent: 00-971d4644229653483d38c46e92a959c7-92c66312e4bb39be-00
    13. Hello World Message "Hello World from the curl pod."
    14. Responded with event Validation: valid
    15. Context Attributes,
    16.   specversion: 0.2
    17.   type: dev.knative.samples.hifromknative
    18.   source: knative/eventing/samples/hello-world
    19.   id: 37458d77-01f5-411e-a243-a459bbf79682
    20. Data,
    21.   {"msg":"Hi from Knative!"}

    Try the CloudEvent attributes in the curl command and the trigger specification to understand how Triggers work.

Verify reply from helloworld-python app

The helloworld-python app replies with an event type type= dev.knative.samples.hifromknative, and source source=knative/eventing/samples/hello-world. The event enters the eventing mesh through the broker, and can be delivered to event sinks using a trigger

  1. Deploy a Pod that receives any CloudEvent and logs the event to its output.

    1. Copy the following YAML into a file:

      1. # event-display app deploment
      2. apiVersion: apps/v1
      3. kind: Deployment
      4. metadata:
      5.   name: event-display
      6.   namespace: knative-samples
      7. spec:
      8.   replicas: 1
      9.   selector:
      10.     matchLabels: &labels
      11.       app: event-display
      12.   template:
      13.     metadata:
      14.       labels: *labels
      15.     spec:
      16.       containers:
      17.         - name: helloworld-python
      18.           image: gcr.io/knative-releases/knative.dev/eventing/cmd/event_display
      19. ---
      20. # Service that exposes event-display app.
      21. # This will be the subscriber for the Trigger
      22. kind: Service
      23. apiVersion: v1
      24. metadata:
      25.   name: event-display
      26.   namespace: knative-samples
      27. spec:
      28.   selector:
      29.     app: event-display
      30.   ports:
      31.     - protocol: TCP
      32.       port: 80
      33.       targetPort: 8080

    2. Apply the YAML file by running the command:

      1. kubectl apply -f <filename>.yaml

      Where <filename> is the name of the file you created in the previous step.

  2. Create a trigger to deliver the event to the previously created service.

    1. Copy the following YAML into a file:

      1. apiVersion: eventing.knative.dev/v1
      2. kind: Trigger
      3. metadata:
      4.   name: event-display
      5.   namespace: knative-samples
      6. spec:
      7.   broker: default
      8.   filter:
      9.     attributes:
      10.       type: dev.knative.samples.hifromknative
      11.       source: knative/eventing/samples/hello-world
      12.   subscriber:
      13.     ref:
      14.       apiVersion: v1
      15.       kind: Service
      16.       name: event-display

    2. Apply the YAML file by running the command:

      1. kubectl apply -f <filename>.yaml

      Where <filename> is the name of the file you created in the previous step.

  3. Send a CloudEvent to the Broker

  4. Check the logs of event-display Service:

    1. kubectl -n knative-samples logs -l app=event-display --tail=50

    Example output:

    1.     cloudevents.Event
    2.     Validation: valid
    3.     Context Attributes,
    4.       specversion: 0.3
    5.       type: dev.knative.samples.hifromknative
    6.       source: knative/eventing/samples/hello-world
    7.       id: 8a7384b9-8bbe-4634-bf0f-ead07e450b2a
    8.       time: 2019-10-04T22:53:39.844943931Z
    9.       datacontenttype: application/json
    10.     Extensions,
    11.       knativearrivaltime: 2019-10-04T22:53:39Z
    12.       knativehistory: default-kn2-ingress-kn-channel.knative-samples.svc.cluster.local
    13.       traceparent: 00-4b01db030b9ea04bb150b77c8fa86509-2740816590a7604f-00
    14.     Data,
    15.       {
    16.         "msg": "Hi from helloworld- app!"
    17.       }

Removing the sample app deployment

To remove the sample app from your cluster, delete the service record:

  1. kubectl delete -f sample-app.yaml