Add support for Eventing/v1beta2 EventTypes #1831

dsimansk · 2023-07-21T14:50:07Z

Description

Changes

Add support for Eventing/v1beta2 EventTypes

Reference

Fixes #

Release Note

Add support for Eventing/v1beta2 EventTypes with `--reference` option flag

/cc @rhuss @matzew

knative-prow

@dsimansk: 0 warnings.

In response to this:

Description

Changes

Add support for Eventing/v1beta2 EventTypes

Reference

Fixes #

Release Note
Add support for Eventing/v1beta2 EventTypes with `--reference` option flag

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

codecov · 2023-07-23T15:24:48Z

Codecov Report

Patch coverage: 82.25% and project coverage change: -0.07% ⚠️

Comparison is base (3ecb24f) 79.73% compared to head (a0a2495) 79.66%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1831      +/-   ##
==========================================
- Coverage   79.73%   79.66%   -0.07%     
==========================================
  Files         179      179              
  Lines       13898    13946      +48     
==========================================
+ Hits        11081    11110      +29     
- Misses       2054     2069      +15     
- Partials      763      767       +4

Files Changed	Coverage Δ
pkg/kn/commands/eventtype/eventtype.go	`100.00% <ø> (ø)`
pkg/kn/commands/eventtype/create.go	`75.34% <62.50%> (-12.16%)`	⬇️
pkg/kn/commands/flags/sink.go	`80.90% <68.96%> (-5.23%)`	⬇️
pkg/eventing/v1beta2/client_mock.go	`94.28% <93.75%> (ø)`
pkg/eventing/v1beta2/client.go	`85.00% <100.00%> (ø)`
pkg/kn/commands/broker/delivery_option_flags.go	`100.00% <100.00%> (ø)`
pkg/kn/commands/completion_helper.go	`85.54% <100.00%> (ø)`
pkg/kn/commands/eventtype/delete.go	`80.64% <100.00%> (ø)`
pkg/kn/commands/eventtype/describe.go	`81.25% <100.00%> (+2.30%)`	⬆️
pkg/kn/commands/eventtype/list.go	`80.26% <100.00%> (ø)`
... and 2 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

rhuss · 2023-07-24T05:43:49Z

test/e2e/eventtype_test.go

@@ -37,6 +38,10 @@ const (
 )

 func TestEventtype(t *testing.T) {
+	//FIXME: enable after Eventing v1.11 is out


How can we ensure that we don't forget this ?

Yep, it's a bit tedious. But the release is this week, I'll try not to foget to remove it immediately.

rhuss · 2023-07-24T05:58:57Z

pkg/kn/commands/flags/sink.go

@@ -49,26 +57,32 @@ func (i *SinkFlags) AddWithFlagName(cmd *cobra.Command, fname, short string) {
 		"'" + flag + " ksvc:mysvc:mynamespace' for a Knative service 'mysvc' in another namespace 'mynamespace', " +
 		"'" + flag + " https://event.receiver.uri' for an URI with an 'http://' or 'https://' schema, " +
 		"'" + flag + " ksvc:receiver' or simply '" + flag + " receiver' for a Knative service 'receiver' in the current namespace. " +
+		"'" + flag + " special.eventing.dev/v1alpha1/channels:pipe' for GroupVersionResource of v1alpha1 'pipe'. " +
+		"GroupVersionResource requires resource name in a lower case plural form. The inputs are sanitized on best effort basis, " +


"requires resource name in a lower case plural form" --> Can't we do at least the lower casing on our own so that that case doesn't mind ? Also the plural form is not intuitive if you don't know about resources. I would accept also both, naively assuming that plural form mean adding a s (or is there an easier way to find out ?)

The overall help message now became quite a bit lengthy and since it is used for every sink type and some commands have multiple sink options (eg --sink, --sink-reply, --sink-dead-letter), the help page becomes too long.

We might:

Shorten it and reference to website for the full documentation.

Try to keep it but only keep the absolutely necessary information.

Eg. instead of

-s, --sink string Addressable sink for events. You can specify a broker, channel, Knative service or URI. Examples: '--sink broker:nest' for a broker 'nest', '--sink channel:pipe' for a channel 'pipe', '--sink ksvc:mysvc:mynamespace' for a Knative service 'mysvc' in another namespace 'mynamespace', '--sink https://event.receiver.uri' for an URI with an 'http://' or 'https://' schema, '--sink ksvc:receiver' or simply '--sink receiver' for a Knative service 'receiver' in the current namespace. '--sink special.eventing.dev/v1alpha1/channels:pipe' for GroupVersionResource of v1alpha1 'pipe'. GroupVersionResource requires resource name in a lower case plural form. The inputs are sanitized on best effort basis, but in case of 'resource not found' error it may help to double check and correct the input. If a prefix is not provided, it is considered as a Knative service in the current namespace. If referring to a Knative service in another namespace, 'ksvc:name:namespace' combination must be provided explicitly.

we might use something like

-s, --sink string Addressable sink for events. Use one of these formats: broker:<name>, channel:<name>, ksvc:<service>:<namespace>, <URI>, or simply <service>. Examples: '--sink broker:nest', '--sink ksvc:mysvc:mynamespace', '--sink https://event.receiver.uri', '--sink receiver'. If the prefix is omitted, it's assumed to be a Knative service in the current namespace. Also supports GroupVersionResource format like 'special.eventing.dev/v1alpha1/channels:pipe'. On errors like 'resource not found', verify your input format.

I agree, it was a bit long even without this change. Sure, the code tries to do both lower case of course and add naive +s. However, we never explained anything from that. I kind of like the idea of a little how to use sinks page with a couple of examples.

Or I can move the plural form recommendation into error message maybe?

Maybe we might leave of the error explanation, too ?

OK, let me remove the additional lines and keep just GVR example to check how that looks.

rhuss · 2023-07-24T07:06:10Z

docs/cmd/kn_eventtype_create.md

  -h, --help               help for create
  -n, --namespace string   Specify the namespace to operate in.
+  -r, --reference string   Addressable Reference producing events. You can specify a broker, channel, or fully qualified GroupVersionResource (GVR). Examples: 'reference broker:nest' for a broker 'nest', 'reference channel:pipe' for a channel 'pipe', 'reference special.eventing.dev/v1alpha1/channels:pipe' for GroupVersionResource of v1alpha1 'pipe'.


Here the intial -- is missing for reference. Also maybe the short version would be nice (-r channel:pipe)

rhuss · 2023-07-24T07:06:43Z

docs/cmd/kn_eventtype_create.md

@@ -21,9 +21,10 @@ kn eventtype create
 ### Options

 ```
-  -b, --broker string      Cloud Event broker
+  -b, --broker string      Cloud Event Broker. This flag is added for the convenience, since Eventing v1beta2 brokers as represented as KReference type.


Still, I would remove the "is added for convenience" since this is an implementation detail that is confusing for a help page.

I removed the whole sentence. Indeed it's an implementation detail.

rhuss · 2023-07-24T07:07:26Z

docs/cmd/kn_source_apiserver_create.md

@@ -26,7 +26,7 @@ kn source apiserver create NAME --resource RESOURCE --sink SINK
      --resource stringArray      Specification for which events to listen, in the format Kind:APIVersion:LabelSelector, e.g. "Event:sourcesv1:key=value".
                                  "LabelSelector" is a list of comma separated key value pairs. "LabelSelector" can be omitted, e.g. "Event:sourcesv1".
      --service-account string    Name of the service account to use to run this source
-  -s, --sink string               Addressable sink for events. You can specify a broker, channel, Knative service or URI. Examples: '--sink broker:nest' for a broker 'nest', '--sink channel:pipe' for a channel 'pipe', '--sink ksvc:mysvc:mynamespace' for a Knative service 'mysvc' in another namespace 'mynamespace', '--sink https://event.receiver.uri' for an URI with an 'http://' or 'https://' schema, '--sink ksvc:receiver' or simply '--sink receiver' for a Knative service 'receiver' in the current namespace. If a prefix is not provided, it is considered as a Knative service in the current namespace. If referring to a Knative service in another namespace, 'ksvc:name:namespace' combination must be provided explicitly.
+  -s, --sink string               Addressable sink for events. You can specify a broker, channel, Knative service or URI. Examples: '--sink broker:nest' for a broker 'nest', '--sink channel:pipe' for a channel 'pipe', '--sink ksvc:mysvc:mynamespace' for a Knative service 'mysvc' in another namespace 'mynamespace', '--sink https://event.receiver.uri' for an URI with an 'http://' or 'https://' schema, '--sink ksvc:receiver' or simply '--sink receiver' for a Knative service 'receiver' in the current namespace. '--sink special.eventing.dev/v1alpha1/channels:pipe' for GroupVersionResource of v1alpha1 'pipe'. If a prefix is not provided, it is considered as a Knative service in the current namespace. If referring to a Knative service in another namespace, 'ksvc:name:namespace' combination must be provided explicitly.


I would remove If referring to a Knative service in another namespace, 'ksvc:name:namespace' combination must be provided explicitly.

with an 'http://' or 'https://' schema might be overkill. Maybe only "for an HTTP URI" ?

@rhuss can we merge it? asking because we're in a release day already.

dsimansk · 2023-07-25T09:59:25Z

@knative/knative-release-leads FYI this should be merged for v1.11 release.

rhuss · 2023-07-26T06:56:24Z

Looks good to me, I added a final comment to the wording. Feel free to merge nevertheless.

/approve
/lgtm
/hold

rhuss · 2023-07-26T09:07:20Z

/approve
/lgtm

knative-prow · 2023-07-26T09:07:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dsimansk, rhuss

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [dsimansk,rhuss]

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

dsimansk · 2023-07-26T10:42:06Z

/unhold

Add support for Eventing/v1beta2 EventTypes

d6d5617

knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 21, 2023

knative-prow bot reviewed Jul 21, 2023

View reviewed changes

knative-prow bot requested review from dprotaso, itsmurugappan and navidshaikh July 21, 2023 14:50

knative-prow bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 21, 2023

dsimansk force-pushed the pr/eventtypes-v1beta2 branch 4 times, most recently from 0dd8833 to deee125 Compare July 23, 2023 21:27

Skip e2e tests on missing API

08112b8

dsimansk force-pushed the pr/eventtypes-v1beta2 branch from deee125 to 08112b8 Compare July 23, 2023 21:53

rhuss reviewed Jul 24, 2023

View reviewed changes

Shortne the sink help message

d618168

rhuss reviewed Jul 24, 2023

View reviewed changes

Reword the help by the review recommendation

1a0fc48

knative-prow bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 26, 2023

knative-prow bot assigned rhuss Jul 26, 2023

knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jul 26, 2023

Reflect review feedback

a0a2495

knative-prow bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 26, 2023

knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jul 26, 2023

knative-prow bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 26, 2023

knative-prow bot merged commit 3a7d8c1 into knative:main Jul 26, 2023
23 checks passed

dsimansk linked an issue Jul 26, 2023 that may be closed by this pull request

CLI: Add support for EventType v1beta2 #1818

Closed

dsimansk added the kind/feature New feature or request label Jul 26, 2023

dsimansk mentioned this pull request Aug 10, 2023

CLI: Add support for EventType v1beta2 #1818

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Eventing/v1beta2 EventTypes #1831

Add support for Eventing/v1beta2 EventTypes #1831

dsimansk commented Jul 21, 2023 •

edited

Loading

knative-prow bot left a comment

codecov bot commented Jul 23, 2023 •

edited

Loading

rhuss Jul 24, 2023

dsimansk Jul 24, 2023

rhuss Jul 24, 2023

dsimansk Jul 24, 2023 •

edited

Loading

rhuss Jul 24, 2023

dsimansk Jul 24, 2023

rhuss Jul 24, 2023

rhuss Jul 24, 2023

dsimansk Jul 26, 2023

rhuss Jul 24, 2023

rhuss Jul 24, 2023

dsimansk Jul 24, 2023

dsimansk Jul 25, 2023

dsimansk commented Jul 25, 2023

rhuss commented Jul 26, 2023

rhuss commented Jul 26, 2023

knative-prow bot commented Jul 26, 2023

dsimansk commented Jul 26, 2023

Add support for Eventing/v1beta2 EventTypes #1831

Add support for Eventing/v1beta2 EventTypes #1831

Conversation

dsimansk commented Jul 21, 2023 • edited Loading

Description

Changes

Reference

knative-prow bot left a comment

Choose a reason for hiding this comment

Description

Changes

Reference

codecov bot commented Jul 23, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dsimansk Jul 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dsimansk commented Jul 25, 2023

rhuss commented Jul 26, 2023

rhuss commented Jul 26, 2023

knative-prow bot commented Jul 26, 2023

dsimansk commented Jul 26, 2023

dsimansk commented Jul 21, 2023 •

edited

Loading

codecov bot commented Jul 23, 2023 •

edited

Loading

dsimansk Jul 24, 2023 •

edited

Loading