Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for KReference.Group feature #3713

Merged
merged 5 commits into from
Jun 16, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion docs/eventing/experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,33 @@ data:

## Features list

<!-- TODO there are no experimental features at the moment -->
### `KReference.Group` field

**Flag name**: `kreference-group`

**Stage**: Alpha, disabled by default

**Tracking issue**: https://github.com/knative/eventing/issues/5086
abrennan89 marked this conversation as resolved.
Show resolved Hide resolved

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:

```yaml
apiVersion: messaging.knative.dev/v1
kind: InMemoryChannel
name: my-channel
```

You can use the following:

```yaml
group: messaging.knative.dev
kind: InMemoryChannel
name: my-channel
```

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