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

Document leader-election configuration #5104

Merged
merged 1 commit into from
Jul 12, 2022
Merged

Document leader-election configuration #5104

merged 1 commit into from
Jul 12, 2022

Conversation

dibyom
Copy link
Member

@dibyom dibyom commented Jul 7, 2022

Changes

The leader-election config did not describe what the options did and were set to the default values. See https://github.com/knative/pkg/blob/e60d250dc6378c387c8c9d149774ee21e9a827ab/leaderelection/config.go#L121-L127
This commit adds block of commented out example config (like we do in config-defaults). The actual content was taken from https://github.com/knative/serving/blob/f9951ecf37709bb160fd513591e84b6e6f50f6f8/config/core/configmaps/leader-election.yaml

Submitter Checklist

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

  • Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • 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)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

The leader-election config did not describe what the options did and were set to the default values. See https://github.com/knative/pkg/blob/e60d250dc6378c387c8c9d149774ee21e9a827ab/leaderelection/config.go#L121-L127
This commit adds block of commented out example config (like we do in config-defaults). The actual content was taken from https://github.com/knative/serving/blob/f9951ecf37709bb160fd513591e84b6e6f50f6f8/config/core/configmaps/leader-election.yaml
@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 Jul 7, 2022
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 7, 2022
@dibyom
Copy link
Member Author

dibyom commented Jul 7, 2022

/kind misc

@dibyom dibyom closed this Jul 7, 2022
@tekton-robot tekton-robot added the kind/misc Categorizes issue or PR as a miscellaneuous one. label Jul 7, 2022
@dibyom dibyom reopened this Jul 7, 2022
@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. 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 Jul 7, 2022
@lbernick
Copy link
Member

lbernick commented Jul 8, 2022

Are we currently actively using these configuration options, and this PR is replacing them with invalid configuration? Is this documentation code block intended for tekton developers or cluster operators using tekton?

@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 Jul 12, 2022
@dibyom
Copy link
Member Author

dibyom commented Jul 12, 2022

Are we currently actively using these configuration options,

Yes, we support a HA mode. The config file was essentially a no-op since it was supplying default values - those values are also present in the code.

and this PR is replacing them with invalid configuration? Is this documentation code block intended for tekton developers or cluster operators using tekton?

This is a configuration with no values specified which means the HA code will use the default config from the code. The docs are mostly intended towards cluster operators.

@abayer
Copy link
Contributor

abayer commented Jul 12, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 12, 2022
@tekton-robot tekton-robot merged commit 0bf2111 into main Jul 12, 2022
@dibyom dibyom deleted the dibyom-patch-1 branch July 12, 2022 15:11
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/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. 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.

5 participants