Add a new Channel CRD to the eventing group by grantr · Pull Request #430 · knative/eventing

grantr · 2018-09-14T18:20:54Z

This is intended to replace the existing Channel in the channels group.
~~It doesn't include the array of subscription details yet.~~

This is intended to replace the existing Channel in the channels group. It doesn't include the array of subscription details yet.

grantr · 2018-09-14T18:24:01Z

+
+//TODO replace this with openapi defaults when
+// https://github.com/kubernetes/features/issues/575 lands (scheduled for 1.13)
+func (c *Channel) SetDefaults() {


Is there any reason to keep this empty defaults file and others like it? It pulls down our coverage numbers unless we write no-op tests.

+1 to removing.

you need to keep func (c *Channel) SetDefaults() { but you can delete func (fs *ChannelSpec) SetDefaults() {

The webhook validation code requires you implement Defaultable.

If you would like to change this, you will have to update GenericCRD interface and https://github.com/knative/pkg/blob/a3bc2db77a14d9ca6195172e81b4bf33e6190f85/webhook/webhook.go#L227

scothis · 2018-09-14T18:34:11Z

+
+	// A reference to the k8s Service backing this channel.
+	// +optional
+	Service *corev1.LocalObjectReference `json:"service,omitempty"`


There was a notion of capturing all provisioned resources in a generic way. Perhaps Provisioned []corev1.ObjectReference. Likely, this is overkill if those resources have OwnerReferences back to this Channel.

Service and VirtualService are too implementation specific and should be removed

Removed these fields. We can add Provisioned later if owner references prove insufficient.

scothis · 2018-09-14T18:37:46Z

+	// ChannelConditionServiceable has status True when the service addressing the
+	// Channel exists.
+	// TODO should this be Sinkable?
+	ChannelConditionServiceable ChannelConditionType = "Serviceable"


Since a channel may not be fronted by a Service, "Serviceable" is no longer a good name. "Sinkable" (or whatever we end up calling that interface) is good. I'd also consider "Targetable" since that aligns with the .status.domainInternal value being set.

I removed this condition since I can't think of a reason for it to be different from Ready.

These fields are too specific to the implementation of the Channel.

The Serviceable/Sinkable condition is effectively the same as Ready.

Allows ignoring timestamps when comparing Statuses for equality.

Shared by Channel and Source so it shouldn't be buried in the types for either one.

Includes the Call and Result fields from Subscription.Spec so the Subscription controller can copy those values directly.

Each Subscriber must have at least one of Call or Result. Currently the validation returns immediately upon encountering an empty Subscriber object due to a limitation in the knative/pkg validation helpers. This is probably fine for now since this field is not expected to be mutated by users.

grantr · 2018-09-17T20:16:10Z

Channel now has a Subscribers array, each of which contains a Call and Result field of the same type as that in SubscriptionSpec. Elements of the array are validated to contain at least one of the Call or Result fields.

ProvisionerReference was considered a top-level type at one point, apparently.

The SetDefaults method is required to exist by the webhook implementation, but we don't want it to negatively impact coverage stats.

n3wscott · 2018-09-17T21:54:16Z

+	// +optional
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	Conditions []ChannelCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`


you will want to update to the style of #434

Let's get #434 in first, reviewing now :)

It is in now!

Updated to use duck Conditions.

Encapsulates the happy/dependent condition behavior.

adamharwayne · 2018-09-18T19:17:27Z

+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// Channel represents a named endpoint on which a Bus accepts event delivery and
+// corresponds to the channels.channels.knative.dev CRD. The Bus handles


channels.channels.knative.dev -> channels.eventing.knative.dev?

adamharwayne · 2018-09-18T19:18:51Z

+// Check that ConfigurationStatus may have its conditions managed.
+var _ duckv1alpha1.ConditionsAccessor = (*ChannelStatus)(nil)
+
+// Check that Subscription implements the Conditions duck type.


Subscription -> Channel

n3wscott · 2018-09-18T14:53:40Z

 			// For group eventing.knative.dev,
+			eventingv1alpha1.SchemeGroupVersion.WithKind("Channel"):            &eventingv1alpha1.Channel{},
 			eventingv1alpha1.SchemeGroupVersion.WithKind("ClusterProvisioner"): &eventingv1alpha1.ClusterProvisioner{},
+			eventingv1alpha1.SchemeGroupVersion.WithKind("Subscription"):       &eventingv1alpha1.Subscription{},


n3wscott · 2018-09-18T14:55:21Z

+
+//TODO replace this with openapi defaults when
+// https://github.com/kubernetes/features/issues/575 lands (scheduled for 1.13)
+func (c *Channel) SetDefaults() {


If you would like to change this, you will have to update GenericCRD interface and https://github.com/knative/pkg/blob/a3bc2db77a14d9ca6195172e81b4bf33e6190f85/webhook/webhook.go#L227

n3wscott · 2018-09-18T14:55:57Z

+
+import "testing"
+
+// No-op test because method does nothing.


does nothing yet :D

n3wscott · 2018-09-18T14:58:49Z

+	// ObservedGeneration is the most recent generation observed for this Channel.
+	// It corresponds to the Channel's generation, which is updated on mutation by
+	// the API Server.
+	//TODO The above comment is only true once


malformed TODO. Should be:

// TODO: The above comment is only true once

n3wscott · 2018-09-18T14:59:00Z

+	// DomainInternal holds the top-level domain that will distribute traffic
+	// over the provided targets from inside the cluster. It generally has the
+	// form {channel}.{namespace}.svc.cluster.local
+	//TODO move this to a struct that can be embedded similar to ObjectMeta and


malformed TODO. See above

n3wscott · 2018-09-18T14:59:30Z

+	// +optional
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	Conditions []ChannelCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`


It is in now!

n3wscott · 2018-09-18T15:00:08Z

+const (
+	// ChannelConditionReady has status True when the Channel is ready to accept
+	// traffic.
+	ChannelConditionReady ChannelConditionType = "Ready"


This will turn into ChannelConditionReady = duck.ConditionReady

n3wscott · 2018-09-18T15:00:30Z

+
+	// ChannelConditionProvisioned has status True when the Channel's backing
+	// resources have been provisioned.
+	ChannelConditionProvisioned ChannelConditionType = "Provisioned"


duck.ConditionType

knative-metrics-robot · 2018-09-18T20:24:15Z

The following is the coverage report on pkg/.
Say /test pull-knative-eventing-go-coverage to run the coverage report again

File	Old Coverage	New Coverage
pkg/apis/eventing/v1alpha1/channel_defaults.go	Do not exist	100.0%
pkg/apis/eventing/v1alpha1/channel_types.go	Do not exist	100.0%
pkg/apis/eventing/v1alpha1/channel_validation.go	Do not exist	100.0%

vaikas · 2018-09-18T22:58:00Z

/lgtm
/approve

knative-prow-robot · 2018-09-18T22:58:05Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: grantr, vaikas-google

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~~ [grantr,vaikas-google]

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

Add a new Channel CRD to the eventing group

6cdd708

This is intended to replace the existing Channel in the channels group. It doesn't include the array of subscription details yet.

knative-prow-robot requested review from inlined and vaikas September 14, 2018 18:20

knative-prow-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Sep 14, 2018

grantr commented Sep 14, 2018

View reviewed changes

Add CRD yaml for Channel in eventing group

5bd9843

scothis reviewed Sep 14, 2018

View reviewed changes

grantr added 9 commits September 14, 2018 13:25

Add Channels and Subscriptions to webhook

9259abb

Remove Service and VirtualService

7a0586a

These fields are too specific to the implementation of the Channel.

Remove Serviceable condition

c56ca48

The Serviceable/Sinkable condition is effectively the same as Ready.

use apis.VolatileTime for LastTransitionTime

7b29db3

Allows ignoring timestamps when comparing Statuses for equality.

Merge branch 'master' into new-channel-crds

f767f48

Remove reference to Serviceable condition in test

34e6854

Move ProvisionerReference to its own file

65f5b7e

Shared by Channel and Source so it shouldn't be buried in the types for either one.

Add Subscribers array to Channel

e6f892d

Includes the Call and Result fields from Subscription.Spec so the Subscription controller can copy those values directly.

grantr added 2 commits September 17, 2018 14:35

Remove outdated codegen files

66cf283

ProvisionerReference was considered a top-level type at one point, apparently.

Add no-op test of SetDefaults method

7bb4c70

The SetDefaults method is required to exist by the webhook implementation, but we don't want it to negatively impact coverage stats.

n3wscott reviewed Sep 17, 2018

View reviewed changes

grantr added 2 commits September 18, 2018 10:14

Merge branch 'master' into new-channel-crds

c6a8591

Switch to duck Conditions

aebcad8

Encapsulates the happy/dependent condition behavior.

adamharwayne reviewed Sep 18, 2018

View reviewed changes

n3wscott reviewed Sep 18, 2018

View reviewed changes

grantr added 2 commits September 18, 2018 13:14

Correct some comments

355ec67

Bring back ChannelConditionReady for docs

940815b

knative-prow-robot assigned vaikas Sep 18, 2018

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 18, 2018

knative-prow-robot merged commit 777657e into knative:master Sep 18, 2018

grantr deleted the new-channel-crds branch September 20, 2018 16:34

n3wscott mentioned this pull request Sep 25, 2018

adding n3wscott to approvers. #465

Merged

Conversation

grantr commented Sep 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

grantr commented Sep 17, 2018

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!

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!

knative-metrics-robot commented Sep 18, 2018

Uh oh!

vaikas commented Sep 18, 2018

Uh oh!

knative-prow-robot commented Sep 18, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

grantr commented Sep 14, 2018 •

edited

Loading