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

Added Readme for helm #383

Merged
merged 3 commits into from
Jun 30, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions manifests/install/charts/as-a-second-scheduler/README.md
Original file line number Diff line number Diff line change
@@ -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


## Installation

Quick start instructions for the setup and configuration of as-a-second-scheduler using Helm.

### Prerequisites

- [Helm](https://helm.sh/docs/intro/quickstart/#install-helm)

### Installing the chart


#### Install chart using Helm v3.0+

```bash
$ git clone git@github.com:kubernetes-sigs/scheduler-plugins.git
$ cd scheduler-plugins/manifests/install/charts
$ helm install scheduler-plugins as-a-second-scheduler/
```

chetak123 marked this conversation as resolved.
Show resolved Hide resolved
### Configuration

The following table lists the configurable parameters of the as-a-second-scheduler chart and their default values.

| Parameter | Description | Default |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| `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` |

| `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` |

| `controller.name` | Controller name | `scheduler-plugins-controller` |
| `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"]` |

| `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"]` |

| `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

| `global.extensions.filter` | global extensions filter | `["NodeResourceTopologyMatch"]` |
| `global.extensions.postFilter` | global extensions postFilter | `["Coscheduling", "CapacityScheduling"]` |
| `global.extensions.score` | global extensions score | `["NodeResourceTopologyMatch", "NodeResourcesAllocatable"]` |
| `global.extensions.permit` | global extensions permit | `["Coscheduling"]` |
| `global.extensions.reserve` | global extensions reserve | `["Coscheduling", "CapacityScheduling"]` |
| `global.extensions.postBind` | global extensions postBind | `["Coscheduling"]` |