From ff56577d4ab46550c8bd50d5d72ebd4f532672d6 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Thu, 3 Jun 2021 09:35:57 +0200 Subject: [PATCH 1/5] Documentation for KReference.Group feature Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 9d42911d51..225d144860 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -51,4 +51,28 @@ data: ## Features list - +### `KReference.Group` field + +**Flag name**: `kreference-group` + +**State**: Alpha, disabled by default + +When using the `KReference` type to refer to another Knative resource, you can just specify the API `Group` of the resource, instead of the full `APIVersion`. + +For example, in order to refer to an `InMemoryChannel`, more than using: + +```yaml +apiVersion: messaging.knative.dev/v1 +kind: InMemoryChannel +name: my-channel +``` + +You can use instead: + +```yaml +group: messaging.knative.dev +kind: InMemoryChannel +name: my-channel +``` + +Note: At the moment this feature is implemented only for `Subscription.Spec.Subscriber.Ref`, in future other usages of `KReference` will support it. From 30a5f93488eef51f759d63706240a238c7e1c843 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Fri, 4 Jun 2021 09:07:43 +0200 Subject: [PATCH 2/5] Explain why Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 225d144860..27e70ecc94 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -75,4 +75,6 @@ kind: InMemoryChannel name: my-channel ``` +Thanks to this feature you can let Knative resolve the full `APIVersion` and further upgrades/deprecations/removals of the referred CRD won't affect your resources. + Note: At the moment this feature is implemented only for `Subscription.Spec.Subscriber.Ref`, in future other usages of `KReference` will support it. From 377710f06d9a26eeeeaaf164dd2be657486dee12 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Mon, 7 Jun 2021 08:47:14 +0200 Subject: [PATCH 3/5] Suggestions Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 27e70ecc94..9db95d233d 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -57,9 +57,9 @@ data: **State**: Alpha, disabled by default -When using the `KReference` type to refer to another Knative resource, you can just specify the API `Group` of the resource, instead of the full `APIVersion`. +When using the `KReference` type to refer to another Knative resource, you can just specify the API `group` of the resource, instead of the full `APIVersion`. -For example, in order to refer to an `InMemoryChannel`, more than using: +For example, in order to refer to an `InMemoryChannel`, instead of the following spec: ```yaml apiVersion: messaging.knative.dev/v1 @@ -67,7 +67,7 @@ kind: InMemoryChannel name: my-channel ``` -You can use instead: +You can use the following: ```yaml group: messaging.knative.dev @@ -75,6 +75,7 @@ kind: InMemoryChannel name: my-channel ``` -Thanks to this feature you can let Knative resolve the full `APIVersion` and further upgrades/deprecations/removals of the referred CRD won't affect your resources. +With this feature you can allow Knative to resolve the full `APIVersion` and further upgrades, deprecations and removals of the referred CRD without affecting existing resources. -Note: At the moment this feature is implemented only for `Subscription.Spec.Subscriber.Ref`, in future other usages of `KReference` will support it. +!!! note + At the moment this feature is implemented only for `Subscription.Spec.Subscriber.Ref`. From 4ef9537c76d7d40018d4415ca8bfde3927698f7b Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Mon, 7 Jun 2021 16:57:33 +0200 Subject: [PATCH 4/5] Added link issue Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 9db95d233d..9a0a07c0b6 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -57,6 +57,8 @@ data: **State**: Alpha, disabled by default +**Tracking issue**: https://github.com/knative/eventing/issues/5086 + When using the `KReference` type to refer to another Knative resource, you can just specify the API `group` of the resource, instead of the full `APIVersion`. For example, in order to refer to an `InMemoryChannel`, instead of the following spec: From 882d6ae96ba457961e77ad4004f1b87d798f2c4f Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Tue, 15 Jun 2021 10:12:33 +0200 Subject: [PATCH 5/5] State -> Stage Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 9a0a07c0b6..150a72e84e 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -55,7 +55,7 @@ data: **Flag name**: `kreference-group` -**State**: Alpha, disabled by default +**Stage**: Alpha, disabled by default **Tracking issue**: https://github.com/knative/eventing/issues/5086