Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs on termination message size to correctly reflect k8s info #3680

Merged
merged 1 commit into from Jan 12, 2021
Merged

Update docs on termination message size to correctly reflect k8s info #3680

merged 1 commit into from Jan 12, 2021

Conversation

ghost
Copy link

@ghost ghost commented Jan 12, 2021

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

  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

Release Notes

Fixed error in developer doc on the maximum size of the termination message.

@ghost ghost added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 12, 2021
@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 12, 2021
@tekton-robot
Copy link
Collaborator

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label 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 tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 12, 2021
@chmouel
Copy link
Member

chmouel commented Jan 12, 2021

/lgtm

Looking Good! 🤙🏽

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 12, 2021
@tekton-robot tekton-robot merged commit 3acf1e7 into tektoncd:master Jan 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants