Skip to content

Commit 76df699

Browse files
authored
Update docs for Eventing TLS Beta (#5967)
* Update docs for Eventing TLS Beta Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com> * Reword strict note Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com> * Add trust-manager usage note for distributing CA bundles Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com> * Add Kafka Broker for KEDA integration Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com> * Fix nav Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com> * Fix warning formatting Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com> --------- Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com>
1 parent 7a7e30c commit 76df699

15 files changed

+231
-48
lines changed

config/nav.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -277,17 +277,17 @@ nav:
277277
- Configuring logging: eventing/observability/logging/config-logging.md
278278
- Collecting metrics: eventing/observability/metrics/collecting-metrics.md
279279
- Knative Eventing metrics: eventing/observability/metrics/eventing-metrics.md
280-
- Experimental Features:
281-
- About Eventing experimental features: eventing/experimental-features/README.md
282-
- DeliverySpec.Timeout field: eventing/experimental-features/delivery-timeout.md
283-
- DeliverySpec.RetryAfterMax field: eventing/experimental-features/delivery-retryafter.md
284-
- New Trigger Filters: eventing/experimental-features/new-trigger-filters.md
285-
- New APIServerSource Filters: eventing/experimental-features/new-apiserversource-filters.md
286-
- KReference.Group field: eventing/experimental-features/kreference-group.md
287-
- Knative reference mapping: eventing/experimental-features/kreference-mapping.md
288-
- EventType auto creation: eventing/experimental-features/eventtype-auto-creation.md
289-
- Transport Encryption: eventing/experimental-features/transport-encryption.md
290-
- Sender Identity: eventing/experimental-features/sender-identity.md
280+
- Features:
281+
- About Eventing features: eventing/features/README.md
282+
- DeliverySpec.Timeout field: eventing/features/delivery-timeout.md
283+
- DeliverySpec.RetryAfterMax field: eventing/features/delivery-retryafter.md
284+
- New Trigger Filters: eventing/features/new-trigger-filters.md
285+
- New APIServerSource Filters: eventing/features/new-apiserversource-filters.md
286+
- KReference.Group field: eventing/features/kreference-group.md
287+
- Knative reference mapping: eventing/features/kreference-mapping.md
288+
- EventType auto creation: eventing/features/eventtype-auto-creation.md
289+
- Transport Encryption: eventing/features/transport-encryption.md
290+
- Sender Identity: eventing/features/sender-identity.md
291291
- FAQ: eventing/faq/README.md
292292
# Eventing reference docs
293293
- Reference:

config/redirects.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@ plugins:
22
redirects:
33
redirect_maps:
44
contributing/about.md: community/README.md
5+
eventing/experimental-features/README.md: eventing/features/README.md
6+
eventing/experimental-features/delivery-timeout.md: eventing/features/delivery-timeout.md
7+
eventing/experimental-features/delivery-retryafter.md: eventing/features/delivery-retryafter.md
8+
eventing/experimental-features/new-trigger-filters.md: eventing/features/new-trigger-filters.md
9+
eventing/experimental-features/kreference-group.md: eventing/features/kreference-group.md
10+
eventing/experimental-features/kreference-mapping.md: eventing/features/kreference-mapping.md
11+
eventing/experimental-features/eventtype-auto-creation.md: eventing/features/eventtype-auto-creation.md
12+
eventing/experimental-features/transport-encryption.md: eventing/features/transport-encryption.md
13+
eventing/experimental-features/sender-identity.md: eventing/features/sender-identity.md
514
eventing/broker/kafka-broker/kafka-configmap.md: eventing/configuration/kafka-channel-configuration.md
615
eventing/broker/create-mtbroker.md: eventing/brokers/create-broker.md
716
eventing/broker/example-mtbroker.md: eventing/brokers/broker-developer-config-options.md

docs/eventing/event-registry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ two topics.
152152
Using the registry, you can discover the different types of events that [Broker event meshes](../event-mesh) can consume.
153153

154154
!!! note
155-
With the experimental feature for EventType auto creation you can see more event types in the registry. Learn [here](../experimental-features/eventtype-auto-creation) how to enable this feature.
155+
With the feature for EventType auto creation you can see more event types in the registry. Learn [here](../features/eventtype-auto-creation) how to enable this feature.
156156

157157
### View all event types you can subscribe to
158158

docs/eventing/experimental-features/README.md renamed to docs/eventing/features/README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Eventing experimental features
1+
# Eventing Features
22

33
To keep Knative innovative, the maintainers of this project have developed an
44
[experimental features process](https://github.com/knative/eventing/blob/main/docs/experimental-features.md)
@@ -8,21 +8,22 @@ without affecting the stability of the core project.
88
<!--TODO: Add note about HOW / where users can provide feedback, otherwise there's not much point mentioning that-->
99

1010
!!! warning
11-
Experimental features are unstable and may cause issues in your Knative setup or even your cluster setup.
12-
These features should be used with caution, and should never be tested on a production environment. For more
11+
Features are stable and unstable features and may cause issues in your Knative setup or even your cluster
12+
setup.
13+
These features should be used with caution, and should never be tested on a production environment.
14+
For more
1315
information about quality guarantees for features at different stages of
1416
development, see the
1517
[Feature stage definition](https://github.com/knative/eventing/blob/main/docs/experimental-features.md#stage-definition)
1618
documentation.
1719

18-
This document explains how to enable experimental features and which ones are
19-
available today.
20+
This document explains how to enable features and which ones are available today.
2021

2122
## Before you begin
2223

2324
You must have a Knative cluster running with Knative Eventing installed.
2425

25-
## Experimental features configuration
26+
## Features configuration
2627

2728
When you install Knative Eventing, the `config-features` ConfigMap is added to
2829
your cluster in the `knative-eventing` namespace.
@@ -40,7 +41,6 @@ metadata:
4041
namespace: knative-eventing
4142
labels:
4243
eventing.knative.dev/release: devel
43-
knative.dev/config-propagation: original
4444
knative.dev/config-category: eventing
4545
data:
4646
new-cool-feature: enabled
@@ -56,23 +56,22 @@ metadata:
5656
namespace: knative-eventing
5757
labels:
5858
eventing.knative.dev/release: devel
59-
knative.dev/config-propagation: original
6059
knative.dev/config-category: eventing
6160
data:
6261
new-cool-feature: disabled
6362
```
6463

65-
## Available experimental features
64+
## Available Features
6665

67-
The following table gives an overview of the available experimental features in
66+
The following table gives an overview of the available features in
6867
Knative Eventing:
6968

70-
| Feature | Flag | Description | Maturity |
71-
|------------------------------------------------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------- |
69+
| Feature | Flag | Description | Maturity |
70+
|------------------------------------------------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
7271
| [DeliverySpec.RetryAfterMax field](delivery-retryafter.md) | `delivery-retryafter` | Specify a maximum retry duration that overrides HTTP [Retry-After](https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.3) headers when calculating backoff times for retrying **429** and **503** responses. | Alpha, disabled by default |
73-
| [DeliverySpec.Timeout field](delivery-timeout.md) | `delivery-timeout` | When using the `delivery` spec to configure event delivery parameters, you can use the`timeout` field to specify the timeout for each sent HTTP request. | Beta, enabled by default |
72+
| [DeliverySpec.Timeout field](delivery-timeout.md) | `delivery-timeout` | When using the `delivery` spec to configure event delivery parameters, you can use the`timeout` field to specify the timeout for each sent HTTP request. | Beta, enabled by default |
7473
| [KReference.Group field](kreference-group.md) | `kreference-group` | Specify the API `group` of `KReference` resources without the API version. | Alpha, disabled by default |
7574
| [Knative reference mapping](kreference-mapping.md) | `kreference-mapping` | Provide mappings from a [Knative reference](https://github.com/knative/specs/blob/main/specs/eventing/overview.md#destination) to a templated URI. | Alpha, disabled by default |
76-
| [New trigger filters](new-trigger-filters.md) | `new-trigger-filters` | Enables a new Trigger `filters` field that supports a set of powerful filter expressions. | Beta, enabled by default |
77-
| [Transport encryption](transport-encryption.md) | `transport-encryption` | Enables components to encrypt traffic using TLS by exposing HTTPS URL. | Alpha, disabled by default |
78-
| [Sender Identity](sender-identity.md) | `authentication-oidc` | Enables Eventing sources to send authenticated requests and addressables to require authenticated requests. | Alpha, disabled by default |
75+
| [New trigger filters](new-trigger-filters.md) | `new-trigger-filters` | Enables a new Trigger `filters` field that supports a set of powerful filter expressions. | Beta, enabled by default |
76+
| [Transport encryption](transport-encryption.md) | `transport-encryption` | Enables components to encrypt traffic using TLS by exposing HTTPS URL. | Beta, disabled by default |
77+
| [Sender Identity](sender-identity.md) | `authentication-oidc` | Enables Eventing sources to send authenticated requests and addressables to require authenticated requests. | Alpha, disabled by default |

docs/eventing/experimental-features/delivery-retryafter.md renamed to docs/eventing/features/delivery-retryafter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ of the normal backoff duration and the Retry-After header value will be used for
2525
the subsequent retry attempt. Specifying a "zero" value of `PT0S` effectively
2626
disables **Retry-After** support.
2727

28-
Prior to this experimental feature, Knative Eventing implementations have not
28+
Prior to this feature, Knative Eventing implementations have not
2929
supported **Retry-After** headers, and this is an attempt to provide a path
3030
for standardizing that support. To begin, the feature is **opt-in**, but the
3131
final state will be **opt-out** as follows:
@@ -60,7 +60,7 @@ spec:
6060
```
6161
6262
!!! note
63-
While the experimental feature flag enforces all DeliverySpec usage of the
63+
While the feature flag enforces all DeliverySpec usage of the
6464
`retryAfterMax` field through Webhook validation, it does not guarantee all
6565
implementations, such as Channels or Sources, actually implement support
6666
for the field. The shared `HTTPMessageSender.SendWithRetries()` logic has

docs/eventing/experimental-features/eventtype-auto-creation.md renamed to docs/eventing/features/eventtype-auto-creation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ data:
2626
...
2727
```
2828

29-
With this experiemental feature enabled, we get `EventType`s on the broker/channel ingress for free, instead of manually creating them as yaml manifests along the application code that talks to the `Broker` or `Channel` API.
29+
With this feature enabled, we get `EventType`s on the broker/channel ingress for free, instead of manually creating them as yaml manifests along the application code that talks to the `Broker` or `Channel` API.
3030

3131
## Example
3232

docs/eventing/experimental-features/kreference-mapping.md renamed to docs/eventing/features/kreference-mapping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ a [Knative reference](https://github.com/knative/specs/blob/main/specs/eventing/
1313
to a templated URI.
1414

1515
!!! note
16-
Currently only PingSource supports this experimental feature.
16+
Currently only PingSource supports this feature.
1717

1818
For example, you can directly reference non-addressable resources anywhere that
1919
Knative Eventing accepts a reference, such as for a PingSource sink, or a

docs/eventing/experimental-features/new-apiserversource-filters.md renamed to docs/eventing/features/new-apiserversource-filters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**Tracking issue**: [#7791](https://github.com/knative/eventing/issues/7791)
88
## Overview
9-
This experimental feature enables a new `filters` field in APIServerSource that conforms to the filters API field defined in the [`CloudEvents Subscriptions API`](https://github.com/cloudevents/spec/blob/main/subscriptions/spec.md#324-filters). It allows users to specify a set of powerful filter expressions, where each expression evaluates to either true or false for each event.
9+
This feature enables a new `filters` field in APIServerSource that conforms to the filters API field defined in the [`CloudEvents Subscriptions API`](https://github.com/cloudevents/spec/blob/main/subscriptions/spec.md#324-filters). It allows users to specify a set of powerful filter expressions, where each expression evaluates to either true or false for each event.
1010

1111
The following example shows a APIServerSource using the new `filters` field:
1212

docs/eventing/experimental-features/new-trigger-filters.md renamed to docs/eventing/features/new-trigger-filters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**Tracking issue**: [#5204](https://github.com/knative/eventing/issues/5204)
88
## Overview
9-
This experimental feature enables a new `filters` field in Triggers that conforms to the filters API field defined in the [`CloudEvents Subscriptions API`](https://github.com/cloudevents/spec/blob/main/subscriptions/spec.md#324-filters). It allows users to specify a set of powerful filter expressions, where each expression evaluates to either true or false for each event.
9+
This feature enables a new `filters` field in Triggers that conforms to the filters API field defined in the [`CloudEvents Subscriptions API`](https://github.com/cloudevents/spec/blob/main/subscriptions/spec.md#324-filters). It allows users to specify a set of powerful filter expressions, where each expression evaluates to either true or false for each event.
1010

1111
The following example shows a Trigger using the new `filters` field:
1212

@@ -185,4 +185,4 @@ The reason is twofold. First, at the time of developing `Trigger` APIs, there wa
185185

186186
### Why `filters` and not another name that wouldn't conflict with the `filter` field?
187187

188-
We considered other names, such as `cefilters`, `subscriptionsAPIFilters`, or `enhancedFilters`, but we decided that this would be a step further from aligning with the Subscriptions API. Instead, we decided it is a good opportunity to conform with the Subscriptions API, at least at the field name level, and to leverage the safety of this being an experimental feature.
188+
We considered other names, such as `cefilters`, `subscriptionsAPIFilters`, or `enhancedFilters`, but we decided that this would be a step further from aligning with the Subscriptions API. Instead, we decided it is a good opportunity to conform with the Subscriptions API, at least at the field name level, and to leverage the safety of this being a feature.

0 commit comments

Comments
 (0)