Add JobSink documentation #6005
Conversation
Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com>
knative-prow
bot
added
the
size/L
|
/cc @Cali0707 |
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
/cc @Leo6Leo |
| backoffDelay: "2007-03-01T13:00:00Z/P1Y2M10DT2H30M" | ||
| backoffDelay: "PT1S" |
There was a problem hiding this comment.
Unrelated fix but I couldn't resist as it's so wrong that time
|
@pierDipi do you want to wait for reviews from the users who requested the feature or should we just merge this if it is good? |
|
@Cali0707 we can wait for a few days and then merge if we don't hear any feedback, we can always iterate based on the feedback as we get it |
| `JobSink` supports the full | ||
| Kubernetes [batch/v1 Job resource and features](https://kubernetes.io/docs/concepts/workloads/controllers/job/) | ||
| and Kubernetes Job queuing systems like [Kueue](https://kueue.sigs.k8s.io/). |
There was a problem hiding this comment.
Maybe mention something along the lines of except the .metadata.name field? As far as I know, we set the name ourselves
There was a problem hiding this comment.
I don't think this is a detail we can add here at the introduction (and also is kinda intuitive, if jobs are created dynamically "to create long-running asynchronous jobs and tasks" then a name can't be fixated)
| ### Reading the event file | ||
|
|
||
| You can read the file and deserialize it using any [CloudEvents](https://github.com/cloudevents) | ||
| JSON deserializer. | ||
|
|
||
| For example, the following snippet reads an event using the CloudEvents Go SDK and processes it. |
There was a problem hiding this comment.
I think this section is a little confusing without some more context, because as far as I can tell we don't mention before this that the event is mounted as a file into the job
There was a problem hiding this comment.
It's in the first sentence after # Usage at line 24 ?
There was a problem hiding this comment.
Ah, I guess I missed that - my bad!
|
/unhold |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Cali0707, matzew, pierDipi The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
knative-prow
bot
added
the
approved
Fixes knative/eventing#7732
Proposed Changes