Add docs around HA support for the pipeline controller #3418
Conversation
tekton-robot
added
the
release-note
tekton-robot
added
size/M
|
Hi @qu1queee. 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 Once the patch is verified, the new status will be reflected by the 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. |
tekton-robot
added
kind/documentation
|
/test pull-tekton-pipeline-unit-tests |
|
/test pull-tekton-pipeline-integration-tests |
There was a problem hiding this comment.
Thank you for this!
I think it would be nice to have this documentation discoverable from other docs, the install guide sounds like a good candidate - https://github.com/tektoncd/pipeline/blob/master/docs/install.md.
The active/passive vs active/active may need to be correct.
Once this is ready and merged, it would be great if you could add the new file to the sync config for the website, e.g. tektoncd/website#179
| | Parameter | Default | | ||
| | -------------------- | -------- | | ||
| | `data.resourceLock` | "leases" | | ||
| | `data.leaseDuration` | 15s | | ||
| | `data.renewDeadline` | 10s | | ||
| | `data.retryPeriod` | 2s | |
There was a problem hiding this comment.
@mattmoor since this is inherited from knative/pkg, is there some documentation from that package that we can point to in here?
There was a problem hiding this comment.
Looks like that the key bucket is supported as well as I mentioned here: #3404, although they seem to be two different models of leadership election. As per my experiments, when the statefulset based leader election is enabled all instances become active. Perhaps @mattmoor can elaborate a litle about that.
|
/test pull-tekton-pipeline-unit-tests |
|
/retest |
| ### Customizing High Availability for the Pipelines Controller | ||
|
|
||
| To customize the behavior of HA for the Tekton Pipelines controller, please refer to the related [documentation](/developers/enabling-ha.md). | ||
|
|
There was a problem hiding this comment.
the link is broken here, has extra /, link must point to developers/enabling-ha.md
|
hey @afrittoli any more changes needed here? its planned for next release, possible in a day 😜 🙏 |
|
I will review this today |
This adds documentation around HA support for the tekton pipeline controller. HA is enabled by default, therefore adding more information on the behaviour and how could devs/maintainers use it.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: afrittoli 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
|
@mattmoor @imjasonh @bobcatfish @pritidesai this is needed for the release, if you have a chance to review |
|
thanks a bunch @qu1queee 🙏 |
Changes
Follow up from issue #2735
This adds documentation around HA support for the tekton pipeline controller.
HA is enabled by default, this PR introduces a doc with information on the behaviour
and how could devs/maintainers enable/disable it.
fyi @afrittoli
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmddir, please updatethe release Task to build and release this image.
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