Skip to content

Update README.md of helm-apps role#13200

Open
hatef94 wants to merge 1 commit into
kubernetes-sigs:masterfrom
hatef94:doc/update-helm-apps-role
Open

Update README.md of helm-apps role#13200
hatef94 wants to merge 1 commit into
kubernetes-sigs:masterfrom
hatef94:doc/update-helm-apps-role

Conversation

@hatef94
Copy link
Copy Markdown

@hatef94 hatef94 commented Apr 19, 2026

What type of PR is this?

/kind documentation

What this PR does / why we need it:

The current documentation instructs users to add the helm-apps role directly to their play. However, following the documented steps results in the following error during execution:

The task includes an option with an undefined variable. The error was: 'download_run_once' is undefined

This happens because helm-apps depends on the kubernetes-apps/helm role, which in turn expects variables provided by the kubespray_defaults role. When kubespray_defaults is not included in the play, required variables (such as download_run_once) are missing, causing the playbook to fail.

This commit updates the role integration to ensure that kubespray_defaults is loaded before helm-apps, aligning the dependency order with what the upstream roles expect

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

Special notes for your reviewer:

Does this PR introduce a user-facing change?:
Update provided documentation of how to add helm applications to Kubernetes

Adding this role as documented results in the following error:

The task includes an option with an undefined variable. The error was: 'download_run_once' is undefined

This happens because helm-apps depends on the kubernetes-apps/helm role, which in turn expects variables provided by the kubespray_defaults role. When kubespray_defaults is not included in the play, required variables (such as download_run_once) are missing, causing the playbook to fail.

This commit updates the role integration to ensure that kubespray_defaults is loaded before helm-apps, aligning the dependency order with what the upstream roles expect
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Details

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-sigs/prow repository.

@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. labels Apr 19, 2026
@linux-foundation-easycla
Copy link
Copy Markdown

CLA Not Signed

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 19, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @hatef94!

It looks like this is your first PR to kubernetes-sigs/kubespray 🎉. 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/kubespray 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 k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 19, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: hatef94
Once this PR has been reviewed and has the lgtm label, please assign mzaian for approval. For more information see the 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

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @hatef94. 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.

Details

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-sigs/prow repository.

@yankay
Copy link
Copy Markdown
Member

yankay commented Apr 20, 2026

/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 Apr 20, 2026
@guoard
Copy link
Copy Markdown
Contributor

guoard commented May 14, 2026

/retest-failed

@guoard
Copy link
Copy Markdown
Contributor

guoard commented May 14, 2026

@hatef94 Please rebase your branch on master.

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

Labels

cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/documentation Categorizes issue or PR as related to documentation. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Kubespray Helm role fails due to undefined variable download_defaults

4 participants