Update docs on termination message size to correctly reflect k8s info #3680
Conversation
This file contains 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
ghost
added
the
kind/documentation
tekton-robot
added
release-note
|
[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
vdemeester
approved these changes
Jan 12, 2021
Prior to this commit we documented the maximum termination message size in our developer docs as 2048 bytes. This is incorrect - the maximum is 4096 according to the link included in that doc. This commit updates the number to 4096 and adds a bit more context for anyone browsing that info. It also updates the docs/tasks.md file to more clearly explain that a large termination message will trigger a failure of the TaskRun and to call out the guidance on keeping results small.
tekton-robot
added
size/S
|
/lgtm Looking Good! 🤙🏽 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Update docs on termination message size to correctly reflect k8s info
Prior to this commit we documented the maximum termination message size in our developer
docs as 2048 bytes. This is incorrect - the maximum is 4096 according to the link included
in that doc.
This commit updates the number to 4096 and adds a bit more context for anyone browsing
that info. It also updates the docs/tasks.md file to more clearly explain that a large
termination message will trigger a failure of the TaskRun and to call out the guidance
on keeping results small.
Submitter Checklist
Release Notes