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

Documentation for all controllers of etcd-druid #722

Merged
merged 5 commits into from
Dec 21, 2023

Conversation

renormalize
Copy link
Member

@renormalize renormalize commented Nov 13, 2023

How to categorize this PR?

/area documentation
/kind enhancement

What this PR does / why we need it:
Documentation for the 5 controllers of etcd-druid

  • Explains the usage of Kubebuilder
  • Explains the package structure
  • Introduces the controller manager
  • Briefly documents all 5 controllers of etcd-druid in docs/concepts/controllers.md

Which issue(s) this PR fixes:
Fixes #695

Special notes for your reviewer:
Due to the planned changes to the etcd and custodian controllers, the documentation for those two is not complete at the moment.

Release note:

Documentation for the controllers of etcd-druid

Copy link

gardener-prow bot commented Nov 13, 2023

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@gardener-robot gardener-robot added area/documentation Documentation related kind/enhancement Enhancement, improvement, extension needs/review Needs review size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) labels Nov 13, 2023
@gardener-robot-ci-3
Copy link
Contributor

Thank you @renormalize for your contribution. Before I can start building your PR, a member of the organization must set the required label(s) {'reviewed/ok-to-test'}. Once started, you can check the build status in the PR checks section below.

Copy link
Contributor

@shreyas-s-rao shreyas-s-rao left a comment

Choose a reason for hiding this comment

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

@renormalize thanks for the well-written PR, and for documenting the design and functionality of the controllers in a concise way. I have left some suggestions for improvements. PTAL.

@gardener-robot gardener-robot added the needs/changes Needs (more) changes label Dec 1, 2023
@gardener-robot gardener-robot added size/xl Size of pull request is huge (see gardener-robot robot/bots/size.py) needs/second-opinion Needs second review by someone else and removed size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) labels Dec 12, 2023
@gardener-robot-ci-1 gardener-robot-ci-1 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Dec 12, 2023
@renormalize renormalize changed the base branch from master to enhancements.etcd-druid-v070 December 12, 2023 15:09
@renormalize renormalize changed the base branch from enhancements.etcd-druid-v070 to master December 12, 2023 15:09
* Documents all controllers of etcd-druid in docs/concepts/00-controllers.md
* Explains the usage of Kubebuilder
* Explains the package structure
* Introduces the *controller manager*
* Briefly explains the 5 controllers
* Changed the file name to docs/concepts/controllers.md
* Added all suggestions to the content for each controller
@gardener-robot gardener-robot added size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) and removed size/xl Size of pull request is huge (see gardener-robot robot/bots/size.py) labels Dec 12, 2023
@gardener-robot-ci-2 gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Dec 12, 2023
@renormalize renormalize marked this pull request as ready for review December 12, 2023 15:22
@renormalize renormalize requested a review from a team as a code owner December 12, 2023 15:22
Copy link
Contributor

@shreyas-s-rao shreyas-s-rao left a comment

Choose a reason for hiding this comment

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

@renormalize thanks a lot for making all the requested changes! Just couple more nits, but overall LGTM 👍

* Removed unecessary comment.
* Grammar fix in line 53.
@gardener-robot-ci-1 gardener-robot-ci-1 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Dec 18, 2023
Copy link
Contributor

@shreyas-s-rao shreyas-s-rao left a comment

Choose a reason for hiding this comment

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

@renormalize thanks for addressing all my comments. LGTM!
/lgtm

@gardener-robot gardener-robot added reviewed/lgtm Has approval for merging and removed needs/changes Needs (more) changes needs/review Needs review needs/second-opinion Needs second review by someone else labels Dec 18, 2023
@shreyas-s-rao
Copy link
Contributor

/retest

@gardener-robot-ci-3 gardener-robot-ci-3 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Dec 18, 2023
Copy link
Contributor

@seshachalam-yv seshachalam-yv left a comment

Choose a reason for hiding this comment

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

/lgtm

@renormalize renormalize added the merge/squash Should be merged via 'Squash and merge' label Dec 18, 2023
Copy link
Member

@ishan16696 ishan16696 left a comment

Choose a reason for hiding this comment

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

Overall looks good.
just few nits.

@gardener-robot-ci-2 gardener-robot-ci-2 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Dec 19, 2023
@gardener-robot-ci-3 gardener-robot-ci-3 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Dec 21, 2023
@renormalize
Copy link
Member Author

/retest

@shreyas-s-rao shreyas-s-rao merged commit e060f52 into gardener:master Dec 21, 2023
1 check passed
@gardener-robot gardener-robot added the status/closed Issue is closed (either delivered or triaged) label Dec 21, 2023
@renormalize renormalize deleted the document-controllers branch November 15, 2024 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related kind/enhancement Enhancement, improvement, extension merge/squash Should be merged via 'Squash and merge' needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) reviewed/lgtm Has approval for merging size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) status/closed Issue is closed (either delivered or triaged)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Etcd-druid documentation for all controller present in etcd-druid
8 participants