search

knative / docs

User documentation for Knative components.
https://knative.dev/docs/
Other
4.41k stars 1.22k forks source link

Link to Eventing Data Plane Contract/SPEC #4943

Open embano1 opened 2 years ago

embano1 commented 2 years ago

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.

abrennan89 commented 2 years ago

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

pierDipi commented 1 year ago

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

github-actions[bot] commented 1 year ago

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.

pierDipi commented 1 year ago

/reopen

knative-prow[bot] commented 1 year ago

@pierDipi: Reopened this issue.

In response to [this](https://github.com/knative/docs/issues/4943#issuecomment-1422358764): >/reopen Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
github-actions[bot] commented 1 year ago

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.

pierDipi commented 1 year ago

/triage accepted