$SINGULARITY_ENVIRONMENT, --nv, and random cleanup #100
Conversation
| export VADER=badguy | ||
| export LUKE=goodguy | ||
| export SOLO=someguy | ||
| ``` |
There was a problem hiding this comment.
I would just change this to be like:
VADER=badguy
LUKE=goodguy
SOLO=someguy
export VADER LUKE SOLO
lol
There was a problem hiding this comment.
@gmkurtzer can you explain to me again why it's bad to export on the same line as definition? I remember you called it a "bashism" and I don't remember why it's bad - I just tried it in a local /bin/sh and it seemed reasonable. But if it could lead to some weird bug I'd rather not tell users to do it, hehe.
| ``` | ||
| %post | ||
| echo 'export JAWA_SEZ=wutini' >>$SINGULARITY_ENVIRONMENT | ||
| ``` |
There was a problem hiding this comment.
woot! I'm so glad we can do this :)
|
|
||
| #### %setup | ||
| ### %setup | ||
| This section blob is a Bourne shell scriptlet which will be executed on the host outside the container during bootstrap. The path to the container is accessible from within the running scriptlet environment via the variable `$SINGULARITY_ROOTFS`. For example, consider the following scriptlet: |
There was a problem hiding this comment.
we will need to add %help to the development version (2.4) docs! Can you PR these general changes there too? It will make the merge (when we get there) easier.
|
These look great! Two main points:
|
|
Whoops! I'm sorry. I missed that there was a 2.4 branch. I should remove the As far as the cli help goes, I agree it will be burdensome to maintain it. But it already exists on many of the commands pages. I guess we should remove it from all of them for consistency. But then some of the commands pages will be blank! meh. |
|
+1 on moving to docs/2.4, and also see this issue #93 so you can check stuffs off after merge there. For the command line - I think we should remove. In my mind, it would be better for a user to open an issue that an example is missing (and then we write a meaningful entry) than to have some (likely outdated) instruction. The second is sort of akin to a script silently failing - I'd rather know and be notified! |
|
And after we merge your contribution here I'll add the SCI-F docs proper too! |
|
OK. See how this looks. I'll submit another PR to the 2.4 branch with the other stuff. |
|
Whoa, just noticed that this is PR 💯 . |
| permalink: contributing-docs | ||
| folder: releases | ||
| toc: false | ||
| --- |
|
|
||
| ### A GPU example | ||
| If you're host system has an NVIDIA GPU card and a driver installed you can | ||
| leverage the card with the `--nv` option. (This example requires a fairly |
There was a problem hiding this comment.
I do feel like a host system some days... :L)
| ### Defining the Runscript | ||
| When using the "run" command, the order of operations for runscripts works as follows: | ||
| When you first create a contianer, the runscript is defined using the followinge order of operations: | ||
|
|
There was a problem hiding this comment.
this sentence is all kinds of funny :)
|
💯 💯 💯 💯 💯 💯 💯 💯 💯 💯 💯 💯 💯 💯 |
* adding troubleshooting for debian issue apptainer/singularity#845 * adding note about security implications * Typo: dummpy.img -> dummy.img (#94) Not sure if this was a typo or a snarky insider joke by a Perl/Ruby programmer.... * Typo: One -> On & wordsmithing (#95) * Type: One -> On * Wordsmithing * Fix inaccurate docker command description (#96) There is no `docker -ps` command. The docker `ps` subcommand lists containers. The docker `history` subcommand will list the layers, like so: ``` hartzelg@blah:~$ docker history hartzelg/cime IMAGE CREATED CREATED BY SIZE COMMENT 7185c64fa2a5 5 months ago /bin/sh -c #(nop) VOLUME [/cime_config.yaml] 0 B fd53e85b356b 5 months ago /bin/sh -c #(nop) VOLUME [/var/jenkins_home] 0 B b50f22ae6ec1 5 months ago /bin/sh -c #(nop) COPY file:fb917d778dfa959bb 10.11 kB [...] ``` * Typo: maybe -> may be (#97) * Oops: "pids" -> "numeric userid" (#98) "pids" is process ids, I think? What you mean is the users numeric id, e.g. on machine A `hartzell` is `3245` so files are owned by `3245`. But, when I get to machine B where `hartzell` is `22453`, those same files appear to be someone else. Right? * nothing to see here... * fixing environment variable example * Fix typo (#99) * $SINGULARITY_ENVIRONMENT, --nv, and random cleanup * removed Usage sections from commands * removed $SINGULARITY_ENVIRONMENT jazz from current docs * reverted docs-usage to old version * cleaning up the merge a bit more * finalizing and approving PR to close #100!
2 participants
Hiya @vsoch! I also plan to document the new ability to bootstrap from an existing local image, but that will be in a separate PR.