Document Pipeline's use of Pod termination messages #4226
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Prior to this commit we primarily documented use of termination messages through a lens of Task Results, but the mechanism is used more broadly than this. This commit adds notes to our developer docs explaining use of pod termination messages, giving examples of the data included, how the data is distributed to other parts of the Pipelines machinery and describing the lack of guarantees around the message's content.
ghost
added
the
kind/documentation
ghost
requested a review
from 
tekton-robot
added
the
release-note
tekton-robot
added
the
size/S
ghost
mentioned this pull request
5 tasks
vdemeester
approved these changes
Sep 14, 2021
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vdemeester 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 |
tekton-robot
added
the
approved
pritidesai
reviewed
Sep 14, 2021
| step began, contents of task results, contents of pipeline resource | ||
| results. | ||
|
|
||
| The contents and format of the termination message can change. At time |
There was a problem hiding this comment.
thanks a bunch @sbwsg for adding this.
NIT: I would add a little note here saying its not recommended to consume the termination message.
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Prior to this commit we primarily documented use of termination messages
through a lens of Task Results, but the mechanism is used more broadly
than this.
This commit adds notes to our developer docs explaining use of pod termination
messages, giving examples of the data included, how the data is distributed to
other parts of the Pipelines machinery and describing the lack of guarantees
around the message's content.
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
Release Notes