Skip to content

fix(examples): add missing prerequisites and KWOK stage-fast in setup.sh#6

Closed
mesutoezdil wants to merge 1 commit intoNVIDIA:mainfrom
mesutoezdil:mesutoezdil/fix/setup-sh-improvements
Closed

fix(examples): add missing prerequisites and KWOK stage-fast in setup.sh#6
mesutoezdil wants to merge 1 commit intoNVIDIA:mainfrom
mesutoezdil:mesutoezdil/fix/setup-sh-improvements

Conversation

@mesutoezdil
Copy link
Copy Markdown
Contributor

@mesutoezdil mesutoezdil commented May 6, 2026

Customer Summary

Users who run setup.sh and then follow the next-step instructions will hit errors if helmfile or helm-diff is not installed. The script also did not apply the KWOK stage-fast manifest, which causes pods to stay stuck after helmfile sync.

Summary

Two fixes to setup.sh, both found while reviewing the script after #4.

First, helmfile and helm-diff were added to the pre-flight checks. The summary section tells users to run HELMFILE_ENV=local helmfile sync, but the script never checked that those tools were present.

Second, stage-fast.yaml was added to the KWOK install step. Without it, KWOK nodes do not simulate fast pod-lifecycle transitions and pods appear stuck in Pending after helmfile sync.

For the Reviewer

Both changes are additive and follow the existing patterns in the file. The KWOK manifest URL uses the same pinned version (v0.7.0) already in the file.

For QA

Run setup.sh without helmfile installed and confirm it exits early with a clear error message.

Run setup.sh on a clean machine and confirm pods reach Running after helmfile sync.

Issues

Related to #4

Checklist

  • I am familiar with the Contributing Guidelines.
  • I have signed off my commits for Developer Certificate of Origin (DCO) compliance.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

JIRA: NO-REF
NVBug: none

The pre-flight checks did not include helmfile or the helm-diff plugin,
both of which are required by the next-step command shown in the summary
(HELMFILE_ENV=local helmfile sync). A user who runs setup.sh without
them will hit an error only after the cluster and components are already
installed.

The KWOK stage-fast.yaml manifest was not applied alongside kwok.yaml.
Without it KWOK nodes do not simulate the fast pod-lifecycle transitions
that the NVCF stack expects, so pods can appear stuck in Pending after
helmfile sync.

JIRA: NO-REF
NVBug: none
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil mesutoezdil requested a review from a team as a code owner May 6, 2026 17:03
@mesutoezdil
Copy link
Copy Markdown
Contributor Author

@kristinapathak @sbaum1994 following up on your comments in #4, here are two fixes found while reviewing setup.sh.

@kristinapathak
Copy link
Copy Markdown
Contributor

hi @mesutoezdil, thanks for the contribution! We're currently pushing changes to this repo from gitlab. We can't directly merge this PR, but soon you'll see a commit to main with these changes and your co-authorship. This will change in the near future to allow for direct merges in github.

@mesutoezdil
Copy link
Copy Markdown
Contributor Author

mesutoezdil commented May 6, 2026

@kristinapathak thanks for the quick turnaround on #6. One question before I spend more time on contributions: since changes flow through GitLab and cannot be merged directly on GitHub, what is the recommended workflow for external contributors? Is opening GitHub PRs the right path, or is there a better way to submit patches so they land reliably with attribution?
I'm asking because I'm wondering whether I should invest my time or devote my energy to other projects.

@kristinapathak
Copy link
Copy Markdown
Contributor

@mesutoezdil, this is the correct workflow for now. Our plan is to get this fixed so we can merge directly from github in the next few weeks, but I don't have an exact target date at this time.

@mesutoezdil
Copy link
Copy Markdown
Contributor Author

@kristinapathak thanks! one small suggestion: a short note in CONTRIBUTING.md explaining that GitHub PRs flow through GitLab and attribution is preserved via co-author would save future contributors the confusion that came up in #4 and #6.
I will hold off on new PRs until the pipeline on github is fixed.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants