Skip to content

docs: clarify flag availability across controller binaries#9390

Open
lusqua wants to merge 1 commit intotektoncd:mainfrom
lusqua:fix/clarify-controller-flags
Open

docs: clarify flag availability across controller binaries#9390
lusqua wants to merge 1 commit intotektoncd:mainfrom
lusqua:fix/clarify-controller-flags

Conversation

@lusqua
Copy link

@lusqua lusqua commented Feb 13, 2026

Changes

Restructure the docs/tekton-controller-flags.md documentation to clearly communicate which flags and environment variables are available on each controller binary (controller, webhook, events, resolvers).

What changed

  • Separated flags by source: flags from knative/pkg (common to all controllers) are now clearly distinguished from Tekton-specific flags
  • Added per-controller availability table: a table shows exactly which flags and env vars each controller supports
  • Added per-controller sections: each controller now has its own section documenting its specific flags and environment variables
  • Corrected inaccuracies: source code verification revealed that:
    • resolvers does not support --disable-ha (it uses MainWithConfig, not MainWithContext)
    • controller and resolvers use THREADS_PER_CONTROLLER env var (no K_ prefix), while webhook and events use K_THREADS_PER_CONTROLLER (with K_ prefix) via sharedmain

Fixes #9292

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • pre-commit Passed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Restructured docs/tekton-controller-flags.md to clarify flag and environment variable availability per controller binary, and corrected inaccuracies in --disable-ha and THREADS_PER_CONTROLLER documentation.

@tekton-robot tekton-robot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Feb 13, 2026
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 13, 2026

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: lusqua / name: Lucas Aguiar (b3820c5)

@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 13, 2026
@waveywaves
Copy link
Member

@lusqua please sign the CLA

@waveywaves
Copy link
Member

@lusqua also, please follow the PR template

Restructure the controller flags documentation to clearly show which
flags and environment variables are available on each controller binary.

Separate flags from knative/pkg (common to all controllers) from
Tekton-specific flags, and add a per-controller availability table with
corrections found during source code verification.
@lusqua lusqua force-pushed the fix/clarify-controller-flags branch from 8e40c78 to b3820c5 Compare February 13, 2026 18:55
@lusqua
Copy link
Author

lusqua commented Feb 13, 2026

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 13, 2026
@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 16, 2026
Copy link
Member

@waveywaves waveywaves left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 17, 2026
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester, waveywaves

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [vdemeester,waveywaves]

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 release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Feb 17, 2026
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/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

docs: clarify which flags are available for use across controllers

4 participants