docs icon indicating copy to clipboard operation
docs copied to clipboard

Link to Eventing Data Plane Contract/SPEC

Open embano1 opened this issue 3 years ago • 7 comments

Describe the change you'd like to see Speaking to many function authors (i.e. Knative Service with Eventing), especially newcomers, most of them are not aware of the underlying data plane contract, e.g. used by brokers. This can lead to issues where retry and error behavior by a function (Kservice) is incorrectly assumed/handled.

Examples SPEC says to retry on 404 which is typically not what users expect (404s are usually not retriable and the SPEC bends the rules here IMHO a bit for a particular use case).

Proposal: add a section to the docs describing the impact of the data plane contract to Knative function authors so at least they are aware of the behavior. The only issue is that not all implementations might strictly follow the SPEC, so this should be considered best effort/best practice for now until we are sure that all implementations strictly follow the SPEC.

Additional context Add any other context or screenshots about the feature request here.

embano1 avatar Apr 27 '22 09:04 embano1

@knative-sandbox/func-wg-leads @knative/eventing-wg-leads can ya'll provide some information here about what needs to be documented?

abrennan89 avatar Jul 05 '22 17:07 abrennan89

This is the spec version of the content to document https://github.com/knative/specs/blob/main/specs/eventing/data-plane.md#event-acknowledgement-and-delivery-retry

pierDipi avatar Aug 10 '22 15:08 pierDipi

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

github-actions[bot] avatar Jan 09 '23 01:01 github-actions[bot]

/reopen

pierDipi avatar Feb 08 '23 10:02 pierDipi

@pierDipi: Reopened this issue.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

knative-prow[bot] avatar Feb 08 '23 10:02 knative-prow[bot]

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

github-actions[bot] avatar May 11 '23 01:05 github-actions[bot]

/triage accepted

pierDipi avatar Jun 12 '23 08:06 pierDipi