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

Add a document to tell users how to configure Thread, QPS and Burst #3508

Merged
merged 1 commit into from
Nov 17, 2020
Merged

Add a document to tell users how to configure Thread, QPS and Burst #3508

merged 1 commit into from
Nov 17, 2020

Conversation

xiujuan95
Copy link
Contributor

Changes

Follow up this PR. Especially for this comment.

This PR add a new document about how to configuring the ThreadPerController, QPS and Burst. The default ThreadPerController, QPS and Burst are 2, 5.0 and 10 accordingly. Sometimes, users want to modify these default values. So a guidance is necessary.

Beside, for QPS and Burst, the actual values of them are multiplied by 2, so the doc is more necessary. Because if a user isn't aware of this, then there will cause some misunderstand.

Fyi, @afrittoli

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • 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)

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

Reviewer Notes

If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.

Release Notes

@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Nov 9, 2020
@linux-foundation-easycla
Copy link

CLA Not Signed

@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 9, 2020
@tekton-robot
Copy link
Collaborator

Hi @xiujuan95. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 11, 2020
Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 11, 2020
docs/install.md Outdated
@@ -363,6 +363,10 @@ data:

To customize the behavior of HA for the Tekton Pipelines controller, please refer to the related [documentation](developers/enabling-ha.md).

## Overwriting the ThreadsPerController, QPS and Burst
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest a slightly broader title of Configuring Tekton Controller Performance.

ThreadsPerController, QPS, and Burst are specific settings but we might one day add more ways to configure performance so placing them under a broader title makes sense I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@@ -0,0 +1,42 @@
# Configure ThreadsPerController, QPS and Burst
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the developers subdirectory is the right place for this doc. developers is for documentation that people coding Tekton Pipelines might need.

Suggest putting this file at docs/performance-configuration.md or something similar. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sbwsg Thanks for your suggestions!

Actually, I agree with you. But I saw this doc enabling-ha.md also under developers folder. I think these two files have the same target. So I also put it in developers subdirectory. Anyway, I can change it to docs/performance-configuration.md. Thanks again!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! Pls take a look again, thanks!

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, you're right. I think enabling-ha.md should probably also be in the docs section. I will make a PR, thank you!

docs/install.md Outdated
@@ -363,6 +363,10 @@ data:

To customize the behavior of HA for the Tekton Pipelines controller, please refer to the related [documentation](developers/enabling-ha.md).

## Overwriting the ThreadsPerController, QPS and Burst

If you want to modify the default ThreadsPerController, QPS and Burst to meet your performance requirements, then please refer to this [guidance](developers/configuring-qps-burst-thread.md).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be worth adding a little bit of context here. Something like this:

Out-of-the-box, Tekton Pipelines is configured for relatively small-scale deployments but several options for configuring Pipelines' performance are available. See the Performance Configuration document which describes how to change the ThreadsPerController, QPS and Burst settings to meet your requirements.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@ghost
Copy link

ghost commented Nov 13, 2020

/test check-pr-has-kind-label

@ghost
Copy link

ghost commented Nov 13, 2020

/approve

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 13, 2020
@ghost
Copy link

ghost commented Nov 13, 2020

@xiujuan95 Could you squash your commits into 1? Once that is done I think the PR is in good shape to merge.

/approve cancel

@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Nov 13, 2020
Document about how to configure controller's performance

Add a document to show how to configure Thread, QPS and Burst

A doc about configuring tekton controller's performance

Refactor the way timeouts are handled

`{Task,Pipeline}Run` now handle timeouts via `EnqueueAfter` on the workqueue.

`pkg/timeout` is now removed.

We now have consistent `GetTimeout(ctx)` methods on types.

updating readme with 0.18

Adding doc/examples link for 0.18

correct the disabled link

Use dogfooding buildx image for multi-arch builds

Signed-off-by: Yulia Gaponenko <yulia.gaponenko1@de.ibm.com>

Use dogfooding skopeo image for e2e and examples tests

Signed-off-by: Yulia Gaponenko <yulia.gaponenko1@de.ibm.com>

Fix markdown styling

The header of the markdown styling does not render properly on tekton.dev. Changing the formatting so the site can render properly.
@xiujuan95
Copy link
Contributor Author

@sbwsg I have merged all commits into one, pls take a look again! Thanks a lot!

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbwsg

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 Nov 16, 2020
@dlorenc
Copy link
Contributor

dlorenc commented Nov 17, 2020

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 17, 2020
@tekton-robot tekton-robot merged commit 5ed55aa into tektoncd:master Nov 17, 2020
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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants