rossoctl / rossoctl/workload-harness
README §Installation: update-secrets.sh behaviour around HF_TOKEN misdocumented
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 5
- Forks
- 6
- Avg merge
- 11h 37m
- Merged PRs (30d)
- 1
Description
Summary
Two README ↔ code drifts found during cold-turkey testing:
1. update-secrets.sh and hf-secret
README §"Installation" (line 191) says update-secrets.sh "Creates/updates hf-secret (skips token if not set)". The actual script skips entirely if HF_TOKEN is unset, leaving hf-secret absent. On kind this causes:
CreateContainerConfigError: secret "hf-secret" not found
Either the README is wrong (it should say the secret is only created when HF_TOKEN is set) or the script should create a placeholder secret so the MCP pod can start.
2. OPENAI_API_BASE documented as optional but practically mandatory
OPENAI_API_BASE is documented on line 79 as the variable to point at your endpoint, but listed on line 201 as "optional". When using an OpenAI-compatible proxy (which the default openai/Azure/gpt-4.1 model requires), leaving it unset causes every LLM call to return Incorrect API key even after update-secrets.sh has patched the key correctly.
The README should clarify: "OPENAI_API_BASE is required when using an OpenAI-compatible proxy."
Found in
PR #33 review by @kellyaa.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the Installation sections around lines 79, 191, and 201 in README, then inspect update-secrets.sh to confirm its HF_TOKEN behavior. Check PR #33's review context and document the chosen behavior for hf-secret, along with when OPENAI_API_BASE is required; done means the README matches the script and proxy setup no longer appears contradictory.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100