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.

Sign up for GitHub

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

Jump to bottom

Add addonmanager.kubernetes.io label documentation #41236

Merged
merged 1 commit into from
May 22, 2023
Merged

Add addonmanager.kubernetes.io label documentation #41236

merged 1 commit into from
May 22, 2023

Conversation

mrgiles
Copy link
Contributor

@mrgiles mrgiles commented May 20, 2023

Document addonmanager.kubernetes.io/mode label. Fixes #29189

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 20, 2023
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 20, 2023
@netlify
Copy link

netlify bot commented May 20, 2023

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 3bcd9ef
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6468276e10c73b000886aeb3
😎 Deploy Preview https://deploy-preview-41236--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@mrgiles
Copy link
Contributor Author

mrgiles commented May 20, 2023

@sftim, I've added the label documentation per #29189 but I wasn't sure where in the document to place it. I picked a random spot, so please let me know if I need to change it. Thanks!

@mrgiles
Copy link
Contributor Author

mrgiles commented May 22, 2023

FYI @tengqm

tengqm
tengqm reviewed May 22, 2023
View reviewed changes
content/en/docs/reference/labels-annotations-taints/_index.md
Comment on lines +280 to +285
- `Reconcile`: Addon resources will be periodically reconciled with the expected state. If there are any differences,
the add-on manager will recreate, reconfigure or delete the resources as needed. This is the default mode if no label is specified.
- `EnsureExists`: Addon resources will be checked for existence only but will not be modified after creation.
The add-on manager will create or re-create the resources when there is no instance of the resource with that name.
- `Ignore`: Addon resources will be ignored. This mode is useful for add-ons that are not compatible with
the add-on manager or that are managed by another controller.
Copy link
Contributor

Choose a reason for hiding this comment

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

/lgtm

I'd suggest we wrap and indent the list items in a different way.

Suggested change
- `Reconcile`: Addon resources will be periodically reconciled with the expected state. If there are any differences,
the add-on manager will recreate, reconfigure or delete the resources as needed. This is the default mode if no label is specified.
- `EnsureExists`: Addon resources will be checked for existence only but will not be modified after creation.
The add-on manager will create or re-create the resources when there is no instance of the resource with that name.
- `Ignore`: Addon resources will be ignored. This mode is useful for add-ons that are not compatible with
the add-on manager or that are managed by another controller.
- `Reconcile`: Addon resources will be periodically reconciled with the expected state.
If there are any differences, the add-on manager will recreate, reconfigure or delete
the resources as needed. This is the default mode if no label is specified.
- `EnsureExists`: Addon resources will be checked for existence only but will not be
modified after creation. The add-on manager will create or re-create the resources
when there is no instance of the resource with that name.
- `Ignore`: Addon resources will be ignored. This mode is useful for add-ons that are
not compatible with the add-on manager or that are managed by another controller.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @tengqm, I agree with you on the line wrapping. This document, in particular is 1153 lines long, I see literally hundreds of lines that are too long. I don't mind wrapping them as well. Do you want me to just do that?

Copy link
Contributor

Choose a reason for hiding this comment

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

The LGTM I left means that I'm okay with this PR merged as is.
The line wrapping is a nit to be fixed in case you have another push.
As for other lines in the same file, maybe a dedicated tidy up PR is needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it. Thanks

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 22, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: a62f36f2d5e754c53f98cca8dd96adf6307a81c0

sftim
sftim reviewed May 22, 2023
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 22, 2023
@k8s-ci-robot k8s-ci-robot merged commit 4947c88 into kubernetes:main May 22, 2023
@mrgiles mrgiles mentioned this pull request Jun 28, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@tengqm tengqm tengqm left review comments

@natalisucks natalisucks Awaiting requested review from natalisucks

@reylejano reylejano Awaiting requested review from reylejano

Assignees

@tengqm tengqm

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document addonmanager.kubernetes.io/mode label
4 participants
@mrgiles @k8s-ci-robot @tengqm @sftim