docs: note experimental Fystash Harbor environment.type - #1946
Conversation
Document fystash as an experimental Harbor sandbox option for SkyRL trials (FYSTASH_API_KEY; requires Harbor --env fystash). Signed-off-by: clayton-dcruze <clayhenrydecruze@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Code Review
This pull request adds documentation and configuration support for the experimental Fystash sandbox provider in Harbor. The changes update the environment variables, provider lists, and prerequisites in the documentation and default YAML configuration. The review feedback highlights a critical syntax error where a commented line inside a backslash-escaped bash command would cause the rest of the command to be ignored, and suggests adding the FYSTASH_TEMPLATE_ID environment variable to the quick start credentials section for completeness.
| harbor_trial_config.environment.type=daytona \ | ||
| # harbor_trial_config.environment.type=fystash \ # experimental; Harbor Fystash + FYSTASH_API_KEY |
There was a problem hiding this comment.
Placing a comment starting with # inside a multi-line backslash-escaped (\) bash command is a syntax error / unexpected behavior in bash. Because the previous line ends with \, the newline is escaped, and the comment character # comments out the rest of the line. Furthermore, because the comment line itself ends with \, it escapes the next newline, causing the entire rest of the command (such as trainer.algorithm.max_seq_len=32768 \ and subsequent lines) to be treated as part of the comment and ignored. This will break the command when users copy and paste it.
harbor_trial_config.environment.type=daytona \
| # export FYSTASH_API_KEY=your_fystash_api_key # experimental; needs Harbor --env fystash | ||
| # export FYSTASH_API=https://api.fystash.ai |
There was a problem hiding this comment.
Since the configuration section below mentions that Fystash uses FYSTASH_TEMPLATE_ID from the environment, it would be helpful to also include it as a commented-out export in the Quick Start credentials section to make the setup instructions complete and consistent.
# export FYSTASH_API_KEY=your_fystash_api_key # experimental; needs Harbor --env fystash
# export FYSTASH_TEMPLATE_ID=your_fystash_template_id
# export FYSTASH_API=https://api.fystash.ai
Gemini review: a # comment inside a \\-continued command comments out the rest of the training invocation. Move the fystash swap to its own snippet and document FYSTASH_TEMPLATE_ID in Quick Start credentials. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Thanks for the review feedback (gemini-code-assist) — addressed in the latest push:
Happy to tweak further if maintainers prefer a different docs shape. Depends on Harbor harbor#2491 for the actual |
Summary
harbor_trial_config.environment.type=fystashon the Harbor integration page (credentials + config table + launch comment).--env fystash(harbor#2491); SkyRL’s pinned Harbor rev may also need a bump after that merge.Docs-only — no SkyRL generator or Harbor pin change in this PR.
Test plan
environment.typetable listsfystashas experimentalFYSTASH_API_KEYMade with Cursor