Skip to content

Commit ef89d0e

Browse files
authored
fix: trying to clarify usage of remotly used env vars (#30)
This mini-PR tries to emphasize the need to escape remote env variables. It addresses #28 . Whether it actually does the trick remains to be seen - when my cluster is accessible again. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Refined explanatory text to improve clarity. - Updated configuration examples to ensure proper escaping of environment variables for accurate guidance. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent afbe945 commit ef89d0e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/further.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ shared-fs-usage:
1818
- source-cache
1919
```
2020
21-
If the shared scratch is e.g. specific for each job (e.g. controlled by a ``$JOBID``), one can define a job-specific local storage prefix like this
21+
If the shared scratch is e.g. specific for each job (e.g. controlled by a ``$JOBID``). Environment variables defined only on remote instances might need to be escaped (with a `\`) to prevent premature evaluation. One can define a job-specific local storage prefix like this
2222

2323
```yaml
2424
default-storage-provider: fs
2525
local-storage-prefix: /local/work/$USER
26-
remote-job-local-storage-prefix: /local/work/$USER/$JOBID
26+
remote-job-local-storage-prefix: /local/work/$USER/\$JOBID
2727
shared-fs-usage:
2828
- persistence
2929
- software-deployment

0 commit comments

Comments
 (0)