-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Added Python Example for Knative Eventing #2299
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
68ddf1b
8de32ce
ba7ce92
ea3da45
82c085e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| FROM python:alpine3.7 | ||
|
|
||
| COPY . /app | ||
|
|
||
| WORKDIR /app | ||
|
|
||
| RUN pip install -r requirements.txt | ||
|
|
||
| EXPOSE 8080 | ||
|
|
||
| ENTRYPOINT [ "python" ] | ||
|
|
||
| CMD [ "helloworld.py" ] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,338 @@ | ||
| A simple web app written in Python that you can use to test knative eventing. It shows how to consume a [CloudEvent](https://cloudevents.io/) 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](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) along with a [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "This example deploys..." |
||
| However, you can also deploy the app as a [Knative Serving Service](../../../../serving/README.md). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove 'however' |
||
|
|
||
| Follow the steps below 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: | ||
|
|
||
| ```shell | ||
| # Clone the relevant branch version such as "release-0.13" | ||
| git clone -b "{{< branch >}}" https://github.com/knative/docs knative-docs | ||
| cd knative-docs/docs/eventing/samples/helloworld/helloworld-python | ||
| ``` | ||
|
|
||
| ## Before you begin | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add a line to say something like "To follow this example guide, you will need:" Also, change "we'll use it"
|
||
| - A Kubernetes cluster with [Knative Eventing](../../../getting-started.md#installing-knative-eventing) installed. | ||
| - [Docker](https://www.docker.com) 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: | ||
|
|
||
| ```python | ||
| from flask import Flask, request, make_response | ||
| import uuid | ||
|
|
||
| app = Flask(__name__) | ||
|
|
||
| @app.route('/', methods=['POST']) | ||
| def hello_world(): | ||
| app.logger.warning(request.data) | ||
| # Respond with another event (optional) | ||
| response = make_response({ | ||
| "msg": "Hi from helloworld-python app!" | ||
| }) | ||
| response.headers["Ce-Id"] = str(uuid.uuid4()) | ||
| response.headers["Ce-specversion"] = "0.3" | ||
| response.headers["Ce-Source"] = "knative/eventing/samples/hello-world" | ||
| response.headers["Ce-Type"] = "dev.knative.samples.hifromknative" | ||
| return response | ||
|
|
||
| if __name__ == '__main__': | ||
| app.run(debug=True, host='0.0.0.0', port=8080) | ||
|
|
||
|
|
||
| ``` | ||
|
|
||
| 1. Add a requirements.txt file containing the following contents: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Where is this txt file added? Also, use backticks for literals? e.g.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. still need to determine where the requirements.txt file is added |
||
|
|
||
| ```bash | ||
| Flask==1.1.1 | ||
| ``` | ||
| 1. In your project directory, create a file named `Dockerfile` and copy the code | ||
| block below into it. For detailed instructions on dockerizing a Go app, see | ||
| [Deploying Go servers with Docker](https://blog.golang.org/docker). | ||
|
|
||
| ```docker | ||
| FROM python:alpine3.7 | ||
|
|
||
| COPY . /app | ||
|
|
||
| WORKDIR /app | ||
|
|
||
| RUN pip install -r requirements.txt | ||
|
|
||
| EXPOSE 8080 | ||
|
|
||
| ENTRYPOINT [ "python" ] | ||
|
|
||
| CMD [ "helloworld.py" ] | ||
|
|
||
| ``` | ||
|
|
||
| 1. Create a new file, `sample-app.yaml` and copy the following service definition | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| into the file. Make sure to replace `{username}` with your Docker Hub | ||
| username. | ||
|
|
||
| ```yaml | ||
| # Namespace for sample application with eventing enabled | ||
| apiVersion: v1 | ||
| kind: Namespace | ||
| metadata: | ||
| name: knative-samples | ||
| labels: | ||
| knative-eventing-injection: enabled | ||
| --- | ||
| # Helloworld-python app deploment | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| metadata: | ||
| name: helloworld-python | ||
| namespace: knative-samples | ||
| spec: | ||
| replicas: 1 | ||
| selector: | ||
| matchLabels: &labels | ||
| app: helloworld-python | ||
| template: | ||
| metadata: | ||
| labels: *labels | ||
| spec: | ||
| containers: | ||
| - name: helloworld-python | ||
| image: docker.io/{username}/helloworld-python | ||
| imagePullPolicy: IfNotPresent | ||
| --- | ||
| # Service that exposes helloworld-python app. | ||
| # This will be the subscriber for the Trigger | ||
| kind: Service | ||
| apiVersion: v1 | ||
| metadata: | ||
| name: helloworld-python | ||
| namespace: knative-samples | ||
| spec: | ||
| selector: | ||
| app: helloworld-python | ||
| ports: | ||
| - protocol: TCP | ||
| port: 80 | ||
| targetPort: 8080 | ||
| --- | ||
| # Knative Eventing Trigger to trigger the helloworld-python service | ||
| apiVersion: eventing.knative.dev/v1alpha1 | ||
| kind: Trigger | ||
| metadata: | ||
| name: helloworld-python | ||
| namespace: knative-samples | ||
| spec: | ||
| broker: default | ||
| filter: | ||
| attributes: | ||
| type: dev.knative.samples.helloworld | ||
| source: dev.knative.samples/helloworldsource | ||
| subscriber: | ||
| ref: | ||
| apiVersion: v1 | ||
| kind: Service | ||
| name: helloworld-python | ||
| ``` | ||
|
|
||
| ## Building and deploying the sample | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Building and deploying the sample app |
||
|
|
||
| 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: | ||
|
|
||
| ```shell | ||
| # Build the container on your local machine | ||
| docker build -t {username}/helloworld-python . | ||
|
|
||
| # Push the container to docker registry | ||
| docker push {username}/helloworld-python | ||
| ``` | ||
|
|
||
| 1. After the build has completed and the container is pushed to docker hub, you | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. again, use consistent capitalization, e.g. Docker Hub |
||
| 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`: | ||
|
|
||
| ```shell | ||
| kubectl apply --filename sample-app.yaml | ||
| ``` | ||
| 1. Above command created a namespace `knative-samples` and labelled it with `knative-eventing-injection=enabled`, to enable eventing in the namespace. Verify using the following command: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "The previous step creates...and labels it with...that enables..." "Verify that the previous step has been successful by entering the following command:" |
||
| ```shell | ||
| kubectl get ns knative-samples --show-labels | ||
| ``` | ||
| 1. It deployed the helloworld-python app as a K8s Deployment and created a K8s service names helloworld-python. Verify using the following command. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is it? Again use present tense "X deploys...as a...and creates a..." "Verify that the previous step has been successful by entering the following command:" I think the structure here overall for the steps could use some work. It's confusing that each step constantly refers back to a previous step. The verification should be part of the step it's verifying maybe? |
||
| ```shell | ||
| kubectl --namespace knative-samples get deployments helloworld-python | ||
| kubectl --namespace knative-samples get svc helloworld-python | ||
| ``` | ||
| 1. It created a Knative Eventing Trigger to route certain events to the helloworld-python application. Make sure that Ready=true | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Again, what is 'it'? Please modify the structure of these steps as mentioned in previous comment. |
||
| ```shell | ||
| kubectl --namespace knative-samples get trigger helloworld-python | ||
| ``` | ||
| ## Send and verify CloudEvents | ||
| Once you have deployed the application and verified that the namespace, sample application and trigger are ready, let's send a CloudEvent. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Once -> After |
||
|
|
||
| ### Send CloudEvent to the Broker | ||
| We can send an http request directly to the [Broker](../../../broker-trigger.md) with correct CloudEvent headers set. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not we..... |
||
|
|
||
| 1. Deploy a curl pod and SSH into it | ||
| ```shell | ||
| kubectl --namespace knative-samples run curl --image=radial/busyboxplus:curl -it | ||
| ``` | ||
| 1. Run the following in the SSH terminal | ||
| ```shell | ||
| curl -v "default-broker.knative-samples.svc.cluster.local" \ | ||
| -X POST \ | ||
| -H "Ce-Id: 536808d3-88be-4077-9d7a-a3f162705f79" \ | ||
| -H "Ce-specversion: 0.3" \ | ||
| -H "Ce-Type: dev.knative.samples.helloworld" \ | ||
| -H "Ce-Source: dev.knative.samples/helloworldsource" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{"msg":"Hello World from the curl pod."}' | ||
|
|
||
| exit | ||
| ``` | ||
| ### Verify that event is received by helloworld-python app | ||
| Helloworld-python app logs the context and the msg of the above event, and replies back with another event. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. msg -> message, do not abbreviate "The...app" |
||
| 1. Display helloworld-python app logs | ||
| ```shell | ||
| kubectl --namespace knative-samples logs -l app=helloworld-python --tail=50 | ||
| ``` | ||
| You should see something similar to: | ||
| ```shell | ||
| Event received. Context: Context Attributes, | ||
| specversion: 0.3 | ||
| type: dev.knative.samples.helloworld | ||
| source: dev.knative.samples/helloworldsource | ||
| id: 536808d3-88be-4077-9d7a-a3f162705f79 | ||
| time: 2019-10-04T22:35:26.05871736Z | ||
| datacontenttype: application/json | ||
| Extensions, | ||
| knativearrivaltime: 2019-10-04T22:35:26Z | ||
| knativehistory: default-kn2-trigger-kn-channel.knative-samples.svc.cluster.local | ||
| traceparent: 00-971d4644229653483d38c46e92a959c7-92c66312e4bb39be-00 | ||
|
|
||
| Hello World Message "Hello World from the curl pod." | ||
| Responded with event Validation: valid | ||
| Context Attributes, | ||
| specversion: 0.2 | ||
| type: dev.knative.samples.hifromknative | ||
| source: knative/eventing/samples/hello-world | ||
| id: 37458d77-01f5-411e-a243-a459bbf79682 | ||
| Data, | ||
| {"msg":"Hi from Knative!"} | ||
|
|
||
| ``` | ||
| Play around with the CloudEvent attributes in the curl command and the trigger specification to understand how [Triggers work](../../../broker-trigger.md#trigger). | ||
|
|
||
| ## Verify reply from helloworld-python app | ||
| `helloworld-python` app replies back with an event of `type= dev.knative.samples.hifromknative`, and `source=knative/eventing/samples/hello-world`. This event enters the eventing mesh via the Broker and can be delivered to other services using a Trigger | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Again, "The...app"
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use "through", not "via" |
||
|
|
||
| 1. Deploy a pod that receives any CloudEvent and logs the event to its output. | ||
| ```shell | ||
| kubectl --namespace knative-samples apply --filename - << END | ||
| # event-display app deploment | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| metadata: | ||
| name: event-display | ||
| namespace: knative-samples | ||
| spec: | ||
| replicas: 1 | ||
| selector: | ||
| matchLabels: &labels | ||
| app: event-display | ||
| template: | ||
| metadata: | ||
| labels: *labels | ||
| spec: | ||
| containers: | ||
| - name: helloworld-python | ||
| image: gcr.io/knative-releases/github.com/knative/eventing-sources/cmd/event_display | ||
| --- | ||
| # Service that exposes event-display app. | ||
| # This will be the subscriber for the Trigger | ||
| kind: Service | ||
| apiVersion: v1 | ||
| metadata: | ||
| name: event-display | ||
| namespace: knative-samples | ||
| spec: | ||
| selector: | ||
| app: event-display | ||
| ports: | ||
| - protocol: TCP | ||
| port: 80 | ||
| targetPort: 8080 | ||
| END | ||
| ``` | ||
| 1. Create a trigger to deliver the event to the above service | ||
| ```shell | ||
| kubectl --namespace knative-samples apply --filename - << END | ||
| apiVersion: eventing.knative.dev/v1alpha1 | ||
| kind: Trigger | ||
| metadata: | ||
| name: event-display | ||
| namespace: knative-samples | ||
| spec: | ||
| broker: default | ||
| filter: | ||
| attributes: | ||
| type: dev.knative.samples.hifromknative | ||
| source: knative/eventing/samples/hello-world | ||
| subscriber: | ||
| ref: | ||
| apiVersion: v1 | ||
| kind: Service | ||
| name: event-display | ||
| END | ||
| ``` | ||
|
|
||
| 1. [Send a CloudEvent to the Broker](###Send-CloudEvent-to-the-Broker) | ||
|
|
||
| 1. Check the logs of event-display service | ||
| ```shell | ||
| kubectl --namespace knative-samples logs -l app=event-display --tail=50 | ||
| ``` | ||
| You should see something similar to: | ||
| ```shell | ||
| cloudevents.Event | ||
| Validation: valid | ||
| Context Attributes, | ||
| specversion: 0.3 | ||
| type: dev.knative.samples.hifromknative | ||
| source: knative/eventing/samples/hello-world | ||
| id: 8a7384b9-8bbe-4634-bf0f-ead07e450b2a | ||
| time: 2019-10-04T22:53:39.844943931Z | ||
| datacontenttype: application/json | ||
| Extensions, | ||
| knativearrivaltime: 2019-10-04T22:53:39Z | ||
| knativehistory: default-kn2-ingress-kn-channel.knative-samples.svc.cluster.local | ||
| traceparent: 00-4b01db030b9ea04bb150b77c8fa86509-2740816590a7604f-00 | ||
| Data, | ||
| { | ||
| "msg": "Hi from helloworld- app!" | ||
| } | ||
| ``` | ||
|
|
||
| **Note: You could use the above approach to test your applications too.** | ||
|
|
||
|
|
||
| ## Removing the sample app deployment | ||
|
|
||
| To remove the sample app from your cluster, delete the service record: | ||
|
|
||
| ```shell | ||
| kubectl delete --filename sample-app.yaml | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| title: "Hello World - Python" | ||
| linkTitle: "Python" | ||
| weight: 20 | ||
| type: "docs" | ||
| --- | ||
|
|
||
| {{% readfile file="README.md" %}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
|
|
||
| from flask import Flask, request, make_response | ||
| import uuid | ||
|
|
||
| app = Flask(__name__) | ||
|
|
||
| @app.route('/', methods=['POST']) | ||
| def hello_world(): | ||
| app.logger.warning(request.data) | ||
| # Respond with another event (optional) | ||
| response = make_response({ | ||
| "msg": "Hi from helloworld-python app!" | ||
| }) | ||
| response.headers["Ce-Id"] = str(uuid.uuid4()) | ||
| response.headers["Ce-specversion"] = "0.3" | ||
| response.headers["Ce-Source"] = "knative/eventing/samples/hello-world" | ||
| response.headers["Ce-Type"] = "dev.knative.samples.hifromknative" | ||
| return response | ||
|
|
||
| if __name__ == '__main__': | ||
| app.run(debug=True, host='0.0.0.0', port=8080) | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Flask==1.1.1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"This guide provides an example of a simple web application, written in Python, that can be used to test Knative Eventing."
We capitalize 'Eventing' throughout the site, so please capitalize all instances. @carieshmarie do we have any official guidelines for Knative about capitalization?