Add a minimal-dependencies working example listening to k8s events by evankanderson · Pull Request #240 · knative/docs

evankanderson · 2018-07-24T00:08:35Z

Fixes #203

Proposed Changes

Adds a sample which uses Feed and Service to listen to k8s events.
Documents using some of the released eventing components (still TODO on how to document the release, probably in eventing/README.md).
Uses dep to vendor the dependencies of function.go for the moment. I'll send a PR to remove the glog usage from https://github.com/knative/eventing/tree/master/pkg/event later today, which may remove the need to use dep to avoid double declaration of the log_dir flag.
Ran through the sample twice, but may have missed bugs or assumptions.

googlebot · 2018-07-24T00:08:38Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

evankanderson · 2018-07-24T00:10:21Z

For your reading pleasure (images work):

https://github.com/evankanderson/docs/tree/1-10th-event/eventing/samples/k8s-events

evankanderson · 2018-07-24T00:11:18Z

Let me see if I can excise the other commits that somehow leaked into my repo.

grantr

/lgtm
/hold

This is really good. @evankanderson I made some optional suggestions; feel free to cancel the hold to get this in now.

FYI I didn't actually go through the steps, just read the instructions and yaml files.

grantr · 2018-07-24T01:24:07Z

+  and a Docker Hub account configured (you'll use it for a container registry).
+- The core Knative eventing tools installed. You can install them with:
+  ```shell
+  kubectl apply -f https://storage.googleapis.com/knative-releases/latest/release-eventing.yaml


This url is now https://storage.googleapis.com/knative-releases/eventing/latest/release.yaml

grantr · 2018-07-24T01:25:18Z

+`k8sevents` EventSource.
+
+```shell
+kubectl apply -f https://storage.googleapis.com/knative-releases/latest/release-eventing-clusterbus-stub.yaml


This url is now https://storage.googleapis.com/knative-releases/eventing/latest/release-clusterbus-stub.yaml

grantr · 2018-07-24T01:25:59Z

+
+```shell
+kubectl apply -f https://storage.googleapis.com/knative-releases/latest/release-eventing-clusterbus-stub.yaml
+kubectl apply -f https://storage.googleapis.com/knative-releases/latest/release-eventing-source-k8sevents.yaml


This url is now https://storage.googleapis.com/knative-releases/eventing/latest/release-source-k8sevents.yaml

grantr · 2018-07-24T01:26:41Z

+## Build and deploy the sample
+
+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


Add backticks around {username}

grantr · 2018-07-24T01:28:06Z

+
+1.  After the build has completed and the container is pushed to Docker Hub, you
+    can deploy the function into your cluster. **Ensure that the container image
+    value in function.yaml matches the container you built in the previous step.**


Add backticks around function.yaml. Maybe add an example of the image value?

grantr · 2018-07-24T01:29:57Z

+    kubectl apply -f eventing/samples/k8s-events/flow.yaml
+    ```
+
+1.  You can read the function logs using Kibana. To access Kibana, you need to


Might be worth a footnote mentioning that Kibana isn't installed in the lite or no-mon installs and thatkubectl logs is an alternative.

grantr · 2018-07-24T01:34:38Z

+      revisionTemplate:
+        spec:
+          container:
+            # Replace this image with your {username}/k8s-events container


Maybe add a TODO or some other callout to be clear that this requires action from the user.

grantr · 2018-07-24T01:36:10Z

+    # Future revisions may opt to have a meaningful resource string
+    # that allows users to scope which objects they choose based on
+    # a templatized self-link. E.g. Configurations across all namespaces:
+    # /apis/serving.knative.dev/v1alpha1/namespaces/{namespace}/configurations/{config}


I'd probably remove all of these comment lines. They're distracting and won't have meaning to the new user.

… to docs.

googlebot · 2018-07-24T15:23:02Z

CLAs look good, thanks!

google-prow-robot · 2018-07-24T15:23:08Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: evankanderson, grantr

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [evankanderson]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

evankanderson · 2018-07-24T15:28:48Z

updated, thanks

grantr · 2018-07-24T15:52:23Z

/lgtm
/hold cancel

vaikas · 2018-07-24T15:54:49Z

/lgtm
/approve

google-prow-robot assigned grantr, labadav, mogar1980 and n3wscott Jul 24, 2018

google-prow-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. approved labels Jul 24, 2018

google-prow-robot requested review from mdemirhan and samodell July 24, 2018 00:08

google-prow-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged. labels Jul 24, 2018

grantr approved these changes Jul 24, 2018

View reviewed changes

evankanderson mentioned this pull request Jul 24, 2018

Simplify demos knative/eventing#270

Closed

evankanderson and others added 12 commits July 24, 2018 07:00

Copy and clean up knative/eventing/samples/{flow,k8s_events_function}…

2c4151c

… to docs.

Clean up go build and make it work.

4340c0f

Add a comment for where to update image.

3b72103

Clean up prereqs & steps 1-2 based on test runthrough.

842a576

'Merge'

92a2ab4

Name function 'read-k8s-events' like in the example.

3f1da92

Fix the image path to work with ko.

5ba6d43

More name fixes for ko

779175f

Use dep to load eventing and k8s.io to avoid glog flag collision. :-/

f00e99d

Update paths for dep + docker build.

d1b685a

Add initial startup line to indicate container is running.

2a312b8

Update Kibana logging details

2cb2a01

evankanderson force-pushed the 1-10th-event branch from f396ff5 to 2cb2a01 Compare July 24, 2018 15:22

google-prow-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 24, 2018

Apply PR feedback.

5a13beb

google-prow-robot added lgtm Indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jul 24, 2018

google-prow-robot merged commit 32f3f94 into knative:master Jul 24, 2018

evankanderson mentioned this pull request Aug 22, 2018

Adding GitHub Sample for move from eventing. #339

Merged

evankanderson deleted the 1-10th-event branch April 17, 2021 14:53

Conversation

evankanderson commented Jul 24, 2018

Proposed Changes

Uh oh!

googlebot commented Jul 24, 2018

Uh oh!

evankanderson commented Jul 24, 2018

Uh oh!

evankanderson commented Jul 24, 2018

Uh oh!

grantr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

googlebot commented Jul 24, 2018

Uh oh!

google-prow-robot commented Jul 24, 2018

Uh oh!

evankanderson commented Jul 24, 2018

Uh oh!

grantr commented Jul 24, 2018

Uh oh!

vaikas commented Jul 24, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants