Skip to content

installer: update helm parameters to match template usage#5277

Open
kajal-jotwani wants to merge 1 commit intovolcano-sh:masterfrom
kajal-jotwani:docs/sync-helm-params
Open

installer: update helm parameters to match template usage#5277
kajal-jotwani wants to merge 1 commit intovolcano-sh:masterfrom
kajal-jotwani:docs/sync-helm-params

Conversation

@kajal-jotwani
Copy link
Copy Markdown

What type of PR is this?

/kind documentation

What this PR does / why we need it:

The helm parameters table in installer/README.md was out of sync with what the chart templates actually use. This PR updates the table to match real template usage and documents each parameter with YAML path, description, type, accepted values, and example.

It also removes stale entries that were listed in README but not consumed by templates, and adds missing agent_scheduler_* defaults in values.yaml so defaults stay aligned with documented/template-supported settings.

Which issue(s) this PR fixes:

Fixes #5261

Special notes for your reviewer:

  • The parameter list was generated by auditing .Values.* references from installer/helm/chart/volcano/templates/*.yaml.
  • README now reflects template behavior as source of truth.
  • Added missing defaults in values.yaml for:
    custom.agent_scheduler_affinity
    custom.agent_scheduler_tolerations
    custom.agent_scheduler_sc
    custom.agent_scheduler_ns
    custom.agent_scheduler_main_csc

Does this PR introduce a user-facing change?

Updated the Helm parameters table in installer/README.md to document all parameters actually used in the chart templates

Copilot AI review requested due to automatic review settings May 6, 2026 17:58
@volcano-sh-bot volcano-sh-bot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. labels May 6, 2026
@volcano-sh-bot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign thor-wl for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details 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

@volcano-sh-bot volcano-sh-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 6, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request provides a comprehensive update to the Volcano Helm chart documentation in installer/README.md, introducing a more detailed parameter table and adding configuration options for the agent scheduler and security contexts. It also updates values.yaml with new agent scheduler fields. Feedback from the review highlights an incomplete description for custom.scheduler_replicas, a bug where custom.agent_scheduler_replicas is documented but not utilized in the templates, and inconsistencies in the documentation table regarding duplicated log level parameters.

I am having trouble creating individual review comments. Click here to see my feedback.

installer/README.md (116)

high

The description for this parameter appears to be incomplete. The agent-scheduler.yaml template also uses this value for its replica count. To avoid confusion, the description should be updated to clarify that this controls replicas for both the main scheduler and the agent scheduler. For example: 'Number of scheduler and agent scheduler replicas'.

installer/README.md (117)

high

This parameter custom.agent_scheduler_replicas is documented here and exists in values.yaml, but it is not actually used in the agent-scheduler.yaml template. The template incorrectly uses custom.scheduler_replicas instead. This makes custom.agent_scheduler_replicas have no effect. This seems to be a bug in the Helm chart. Either the documentation should be corrected to reflect that this parameter is unused, or preferably, the template should be fixed to use this parameter.

installer/README.md (215-217)

medium

There are some duplicated and inconsistently placed log level parameters in the table.

  • custom.controller_log_level is defined under 'Controller Tuning' (line 143) and again under 'Log Levels' (line 216).
  • custom.scheduler_log_level is defined under 'Scheduler Tuning' (line 134) and again under 'Log Levels' (line 217).
  • custom.admission_log_level is only defined under 'Admission Controller Settings' (line 120) and is missing from the 'Log Levels' section.

To improve consistency and remove redundancy, I suggest consolidating all log level parameters into the Log Levels (custom) section and removing them from their individual component sections.

The Log Levels (custom) section could be updated to include all three, like this:

| **Log Levels (custom)** | | | | | |
| `custom.admission_log_level` | `custom.admission_log_level` | Admission controller verbosity level (`-v`) | int | `0`-`10` | `4` |
| `custom.controller_log_level` | `custom.controller_log_level` | Controller verbosity level (`-v`) | int | `0`-`10` | `4` |
| `custom.scheduler_log_level` | `custom.scheduler_log_level` | Scheduler and agent scheduler verbosity level (`-v`) | int | `0`-`10` | `3` |

And then the corresponding rows from lines 120, 134, and 143 should be removed.

@kajal-jotwani kajal-jotwani force-pushed the docs/sync-helm-params branch from 3c1ce5c to 5c28f1b Compare May 6, 2026 18:04
The README table was missing a bunch of params the templates actually
use. Audited all .Values references in the chart templates, added the
missing entries, and declared the five agent_scheduler_* keys in
values.yaml that agent_scheduler.yaml was already reading.

Also fixed a stale link to values.yaml while I was in there.

Signed-off-by: kajal-jotwani <kajaljotwani06@gmail.com>
@kajal-jotwani kajal-jotwani force-pushed the docs/sync-helm-params branch from 5c28f1b to 8c42d38 Compare May 6, 2026 18:05
@volcano-sh-bot volcano-sh-bot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label May 6, 2026
@JesseStutler
Copy link
Copy Markdown
Member

If I remember correctly, many new parameters have been added, there should be more than these.

@kajal-jotwani
Copy link
Copy Markdown
Author

If I remember correctly, many new parameters have been added, there should be more than these.

Hi @JesseStutler, I went through the templates and cross-checked .Values.* reference against the README table - both came out to 119 and the diff was empty so I think everything is covered. I've attached the output below.

kajal@kajal-HP-Pavilion-Laptop-15-eh2xxx:~/volcano$ grep -roh '\.Values\.[a-zA-Z0-9_.]*' installer/helm/chart/volcano/templates/ \
  | sed 's/\.Values\.//' | sort -u > /tmp/template_params.txt
kajal@kajal-HP-Pavilion-Laptop-15-eh2xxx:~/volcano$ grep "^| \`" installer/README.md \
  | awk -F'|' '{print $2}' | tr -d '` ' \
  | sort -u > /tmp/readme_params.txt
kajal@kajal-HP-Pavilion-Laptop-15-eh2xxx:~/volcano$ comm -23 \
  <(sort /tmp/template_params.txt) \
  <(sort /tmp/readme_params.txt)
kajal@kajal-HP-Pavilion-Laptop-15-eh2xxx:~/volcano$ wc -l /tmp/template_params.txt /tmp/readme_params.txt
 119 /tmp/template_params.txt
 119 /tmp/readme_params.txt
 238 total
kajal@kajal-HP-Pavilion-Laptop-15-eh2xxx:~/volcano$ 

could you point to what you think is missing? or is there another place I should check for references? I’ll update the PR accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Helm parameters table in installer/README.md to match all parameters used in templates

3 participants