Hello World - Golang

A simple web app written in Go 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, using the Go SDK for CloudEvents

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.

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:

  1. git clone -b "release-0.24" https://github.com/knative/docs knative-docs
  2. cd knative-docs/docs/eventing/samples/helloworld/helloworld-go

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.go and paste the following code. This code creates a basic web server which listens on port 8080:

    1.  import (
    2.      "context"
    3.      "log"
    5.      cloudevents "github.com/cloudevents/sdk-go/v2"
    6.      "github.com/google/uuid"
    7.  )
    9.  func receive(ctx context.Context, event cloudevents.Event) (*cloudevents.Event, cloudevents.Result) {
    10.      // Here is where your code to process the event will go.
    11.      // In this example we will log the event msg
    12.      log.Printf("Event received. \n%s\n", event)
    13.      data := &HelloWorld{}
    14.      if err := event.DataAs(data); err != nil {
    15.          log.Printf("Error while extracting cloudevent Data: %s\n", err.Error())
    16.          return nil, cloudevents.NewHTTPResult(400, "failed to convert data: %s", err)
    17.      }
    18.      log.Printf("Hello World Message from received event %q", data.Msg)
    20.      // Respond with another event (optional)
    21.      // This is optional and is intended to show how to respond back with another event after processing.
    22.      // The response will go back into the knative eventing system just like any other event
    23.      newEvent := cloudevents.NewEvent()
    24.      newEvent.SetID(uuid.New().String())
    25.      newEvent.SetSource("knative/eventing/samples/hello-world")
    26.      newEvent.SetType("dev.knative.samples.hifromknative")
    27.      if err := newEvent.SetData(cloudevents.ApplicationJSON, HiFromKnative{Msg: "Hi from helloworld-go app!"}); err != nil {
    28.          return nil, cloudevents.NewHTTPResult(500, "failed to set response data: %s", err)
    29.      }
    30.      log.Printf("Responding with event\n%s\n", newEvent)
    31.      return &newEvent, nil
    32.  }
    34.  func main() {
    35.      log.Print("Hello world sample started.")
    36.      c, err := cloudevents.NewDefaultClient()
    37.      if err != nil {
    38.          log.Fatalf("failed to create client, %v", err)
    39.      }
    40.      log.Fatal(c.StartReceiver(context.Background(), receive))
    41.  }

  2. Create a new file named eventschemas.go and paste the following code. This defines the data schema of the CloudEvents.

    1.  package main
    3.  // HelloWorld defines the Data of CloudEvent with type=dev.knative.samples.helloworld
    4.  type HelloWorld struct {
    5.    // Msg holds the message from the event
    6.    Msg string `json:"msg,omitempty,string"`
    7.  }
    9.  // HiFromKnative defines the Data of CloudEvent with type=dev.knative.samples.hifromknative
    10.  type HiFromKnative struct {
    11.    // Msg holds the message from the event
    12.    Msg string `json:"msg,omitempty,string"`
    13.  }

  3. 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.

    1.  # Use the official Golang image to create a build artifact.
    2.  # This is based on Debian and sets the GOPATH to /go.
    3.  # https://hub.docker.com/_/golang
    4.  FROM golang:1.14 as builder
    6.  # Copy local code to the container image.
    7.  WORKDIR /app
    9.  # Retrieve application dependencies using go modules.
    10.  # Allows container builds to reuse downloaded dependencies.
    11.  COPY go.* ./
    12.  RUN go mod download
    14.  # Copy local code to the container image.
    15.  COPY . ./
    17.  # Build the binary.
    18.  # -mod=readonly ensures immutable go.mod and go.sum in container builds.
    19.  RUN CGO_ENABLED=0 GOOS=linux go build -mod=readonly  -v -o helloworld
    21.  # Use a Docker multi-stage build to create a lean production image.
    22.  # https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds
    23.  FROM alpine:3
    24.  RUN apk add --no-cache ca-certificates
    26.  # Copy the binary to the production image from the builder stage.
    27.  COPY --from=builder /app/helloworld /helloworld
    29.  # Run the web service on container startup.
    30.  CMD ["/helloworld"]

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

  5. Use the go tool to create a go.mod manifest.

    1. go mod init github.com/knative/docs/docs/serving/samples/hello-world/helloworld-go

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-go .
    4. # Push the container to docker registry
    5. docker push {username}/helloworld-go

  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 --filename sample-app.yaml

  3. Above command created a namespace knative-samples and create a default Broker it. Verify using the following command:

    1. kubectl get broker --namespace knative-samples

    Note: you can also use injection based on labels with the Eventing sugar controller. For how to install the Eventing sugar controller, see Install optional Eventing extensions.

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

    1. kubectl --namespace knative-samples get deployments helloworld-go
    3. kubectl --namespace knative-samples get svc helloworld-go

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

    1. kubectl --namespace knative-samples get trigger helloworld-go

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.

Send CloudEvent to the Broker

We can send an http request directly to the Broker with correct CloudEvent headers set.

  1. Deploy a curl pod and SSH into it

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

  2. Get the Broker URL

    1. kubectl -n knative-samples get broker default

  3. Run the following in the SSH terminal. Please replace the URL with the URL of the default broker.

    1. curl -v "http://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: 1.0" \
    5. -H "Ce-Type: dev.knative.samples.hifromknative" \
    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-go app

Helloworld-go app logs the context and the msg of the above event, and replies back with another event.

  1. Display helloworld-go app logs

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

    You should see something similar to:

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

Play around with the CloudEvent attributes in the curl command and the trigger specification to understand how triggers work.

Verify reply from helloworld-go app

helloworld-go 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

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

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

  2. Create a trigger to deliver the event to the above service

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

  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

    You should see something similar to:

    1.   cloudevents.Event
    2.   Validation: valid
    3.   Context Attributes,
    4.     specversion: 1.0
    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-go 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