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

Added Readme for helm #383

Merged
merged 3 commits into from
Jun 30, 2022
Merged

Added Readme for helm #383

merged 3 commits into from
Jun 30, 2022

Conversation

chetak123
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it: Readme for Helm chart along with it's parameters

Which issue(s) this PR fixes:

Fixes #353

Special notes for your reviewer:

I have completed task 1 as specified in issue but not able to fully understand task 2 - Update the doc specifying the steps to use helm chart -if any other place other than the above-
It would be really helpful if you can please specify what needs to be done,
Thanks.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 3, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @chetak123!

It looks like this is your first PR to kubernetes-sigs/scheduler-plugins 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/scheduler-plugins has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @chetak123. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 3, 2022
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 3, 2022
@helayoty
Copy link
Contributor

helayoty commented Jun 3, 2022

/assign @helayoty

helayoty
helayoty reviewed Jun 7, 2022
View reviewed changes
manifests/install/charts/as-a-second-scheduler/README.md Outdated
| `controller.replicaCount` | Controller replicaCount | `1` |
| `plugins.enabled` | Plugins enabled | `["Coscheduling","CapacityScheduling","NodeResourceTopologyMatch", "NodeResourcesAllocatable"]` |
| `global.queueSort` | global queueSort, needs to be globally enabled once | `["Coscheduling"]` |
| `global.extensions.preFilter` | global extensions preFilter | `["Coscheduling", "CapacityScheduling"]` |
Copy link
Contributor

Choose a reason for hiding this comment

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

The description should be something like:

`preFilter` extension config. This is be used if the `preFilter` plugin is enabled.

Please apply the same for the rest of all extensions. parameters

helayoty
helayoty suggested changes Jun 7, 2022
View reviewed changes
Copy link
Contributor

@helayoty helayoty left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution. Added some comments.

manifests/install/charts/as-a-second-scheduler/README.md Outdated
@@ -1 +1,45 @@
# Chart to run scheduler plugin as a second scheduler in cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

Update the title to have the chart name only scheduler-plugins as a second scheduler in cluster

manifests/install/charts/as-a-second-scheduler/README.md Outdated
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| `scheduler.name` | Scheduler name | `scheduler-plugins-scheduler` |
| `scheduler.image` | Scheduler image | `k8s.gcr.io/scheduler-plugins/kube-scheduler:v0.22.6` |
| `scheduler.namespace` | Scheduler namespace | `scheduler-plugins` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `scheduler.namespace` | Scheduler namespace | `scheduler-plugins` |
| `scheduler.namespace` | Default scheduler-plugins namespace | `scheduler-plugins` |

manifests/install/charts/as-a-second-scheduler/README.md Outdated
| `scheduler.name` | Scheduler name | `scheduler-plugins-scheduler` |
| `scheduler.image` | Scheduler image | `k8s.gcr.io/scheduler-plugins/kube-scheduler:v0.22.6` |
| `scheduler.namespace` | Scheduler namespace | `scheduler-plugins` |
| `scheduler.replicaCount` | Scheduler replicaCount | `1` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `scheduler.replicaCount` | Scheduler replicaCount | `1` |
| `scheduler.replicaCount` | scheduler-plugins replicas | `1` |

manifests/install/charts/as-a-second-scheduler/README.md Outdated
| `controller.image` | Controller image | `k8s.gcr.io/scheduler-plugins/controller:v0.22.6` |
| `controller.namespace` | Controller namespace | `scheduler-plugins` |
| `controller.replicaCount` | Controller replicaCount | `1` |
| `plugins.enabled` | Plugins enabled | `["Coscheduling","CapacityScheduling","NodeResourceTopologyMatch", "NodeResourcesAllocatable"]` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `plugins.enabled` | Plugins enabled | `["Coscheduling","CapacityScheduling","NodeResourceTopologyMatch", "NodeResourcesAllocatable"]` |
| `plugins.enabled` | All Plugins are enabled by default. Plugins enabled | `["Coscheduling","CapacityScheduling","NodeResourceTopologyMatch", "NodeResourcesAllocatable"]` |

manifests/install/charts/as-a-second-scheduler/README.md Outdated
| `controller.namespace` | Controller namespace | `scheduler-plugins` |
| `controller.replicaCount` | Controller replicaCount | `1` |
| `plugins.enabled` | Plugins enabled | `["Coscheduling","CapacityScheduling","NodeResourceTopologyMatch", "NodeResourcesAllocatable"]` |
| `global.queueSort` | global queueSort, needs to be globally enabled once | `["Coscheduling"]` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove global from all parameters' descriptions.

Suggested change
| `global.queueSort` | global queueSort, needs to be globally enabled once | `["Coscheduling"]` |
| `global.queueSort` | THe default `queueSort` Plugin, needs to be enabled once | `["Coscheduling"]` |

@denkensk
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 15, 2022
@chetak123
Copy link
Member Author

Hey @helayoty I have made the required changes.

(and I'm very sorry for the delay - due to exams)

@chetak123 chetak123 mentioned this pull request Jun 24, 2022
Closed
9 tasks
@seanmalloy
Copy link
Member

@chetak123 I added one more suggestion to the README.

I believe we just need to change one thing. Currently the helm install commands are duplicated in the README you updated and in this document: https://github.com/kubernetes-sigs/scheduler-plugins/blob/master/doc/install.md#as-a-second-scheduler.

Can you remove the helm install commands from doc/install.md and replace them with a link to the updated README?

@seanmalloy
Copy link
Member

@chetak123 this looks good to me now.

/lgtm

@helayoty do you want to review one more time?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 29, 2022
helayoty
helayoty approved these changes Jun 29, 2022
View reviewed changes
Copy link
Contributor

@helayoty helayoty left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM 🚢 @Huang-Wei

@helayoty
Copy link
Contributor

/assign @Huang-Wei

@seanmalloy
Copy link
Member

/release-note-none

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't 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 Jun 29, 2022
@Huang-Wei
Copy link
Contributor

/lgtm
/approve
/label tide/merge-method-squash

Thanks @chetak123 !

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jun 30, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chetak123, helayoty, Huang-Wei

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 Jun 30, 2022
@k8s-ci-robot k8s-ci-robot merged commit e0f0645 into kubernetes-sigs:master Jun 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@helayoty helayoty helayoty approved these changes

@cwdsuzhou cwdsuzhou Awaiting requested review from cwdsuzhou

@yuanchen8911 yuanchen8911 Awaiting requested review from yuanchen8911

@seanmalloy seanmalloy Awaiting requested review from seanmalloy

Assignees

@seanmalloy seanmalloy

@Huang-Wei Huang-Wei

@helayoty helayoty

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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

add Readme to the current helm chart
6 participants
@chetak123 @k8s-ci-robot @helayoty @denkensk @seanmalloy @Huang-Wei