From 3bfecd1ef77e9b73d8937d12c81799a487e5ea16 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Mon, 14 Jun 2021 14:30:12 +0200 Subject: [PATCH 1/4] Delivery.Timeout Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 33 ++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 801e7c94d9e..90a7c11e4f3 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -85,3 +85,36 @@ With this feature you can allow Knative to resolve the full `APIVersion` and fur !!! note At the moment this feature is implemented only for `Subscription.Spec.Subscriber.Ref`. + +### `DeliverySpec.Timeout` field + +**Flag name**: `delivery-timeout` + +**State**: Alpha, disabled by default + +**Tracking issue**: https://github.com/knative/eventing/issues/5148 + +When using the `DeliverySpec` to configure event delivery parameters, you can use `timeout` field to specify the timeout for each sent HTTP request. The duration of the `timeout` parameter is specified using the ISO 8601 format + +For example, you can define a `Subscription' that retries 3 times, and on each retry the request timeout is going to be 5 seconds: + +```yaml +apiVersion: messaging.knative.dev/v1 +kind: Subscription +metadata: + name: example-subscription + namespace: example-namespace +spec: + subscriber: + ref: + apiVersion: serving.knative.dev/v1 + kind: Service + name: example-sink + delivery: + backoffDelay: PT2S + backoffPolicy: linear + retry: 3 + timeout: PT5S +``` + +You can use this feature in `Channel`, `Subscription`, `Broker`, `Trigger` and every other Resource spec that uses that accepts the `delivery` object field. From cd01d9b39d265c7f87d3eab838ee612a880e575f Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Tue, 15 Jun 2021 10:12:55 +0200 Subject: [PATCH 2/4] 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 90a7c11e4f3..c2765434cda 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -90,7 +90,7 @@ With this feature you can allow Knative to resolve the full `APIVersion` and fur **Flag name**: `delivery-timeout` -**State**: Alpha, disabled by default +**Stage**: Alpha, disabled by default **Tracking issue**: https://github.com/knative/eventing/issues/5148 From 8b022005ec82f3794da2261700f1d2283f1f5e6f Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Mon, 21 Jun 2021 08:44:13 +0200 Subject: [PATCH 3/4] Trailing WS 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 c2765434cda..79842198af9 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -96,7 +96,7 @@ With this feature you can allow Knative to resolve the full `APIVersion` and fur When using the `DeliverySpec` to configure event delivery parameters, you can use `timeout` field to specify the timeout for each sent HTTP request. The duration of the `timeout` parameter is specified using the ISO 8601 format -For example, you can define a `Subscription' that retries 3 times, and on each retry the request timeout is going to be 5 seconds: +For example, you can define a `Subscription' that retries 3 times, and on each retry the request timeout is going to be 5 seconds: ```yaml apiVersion: messaging.knative.dev/v1 From 6510a846b831d5d992c73ba03aed81d8471eb218 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Wed, 23 Jun 2021 09:16:10 +0200 Subject: [PATCH 4/4] Suggestions Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 79842198af9..551545f225b 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -55,7 +55,7 @@ data: ## Features list -### `KReference.Group` field +### KReference.Group field **Flag name**: `kreference-group` @@ -86,7 +86,7 @@ With this feature you can allow Knative to resolve the full `APIVersion` and fur !!! note At the moment this feature is implemented only for `Subscription.Spec.Subscriber.Ref`. -### `DeliverySpec.Timeout` field +### DeliverySpec.Timeout field **Flag name**: `delivery-timeout` @@ -94,9 +94,9 @@ With this feature you can allow Knative to resolve the full `APIVersion` and fur **Tracking issue**: https://github.com/knative/eventing/issues/5148 -When using the `DeliverySpec` to configure event delivery parameters, you can use `timeout` field to specify the timeout for each sent HTTP request. The duration of the `timeout` parameter is specified using the ISO 8601 format +When using the `delivery` spec to configure event delivery parameters, you can use `timeout` field to specify the timeout for each sent HTTP request. The duration of the `timeout` parameter is specified using the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Times) format. -For example, you can define a `Subscription' that retries 3 times, and on each retry the request timeout is going to be 5 seconds: +The following example shows a Subscription that retries sending an event 3 times, and on each retry the request timeout is going to be 5 seconds: ```yaml apiVersion: messaging.knative.dev/v1 @@ -117,4 +117,4 @@ spec: timeout: PT5S ``` -You can use this feature in `Channel`, `Subscription`, `Broker`, `Trigger` and every other Resource spec that uses that accepts the `delivery` object field. +You can specify a `delivery` spec for Channels, Subscriptions, Brokers, Triggers, and any other resource spec that accepts the `delivery` field.