Improvements for build nodes documentation

Aperta
#72 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Start from the build nodes documentation page in the EESSI docs repo, where the $EESSI_TMPDIR bind-mount instructions, the tarball creation example and the startprefix commands appear. Work through the nine bullets, editing each section the issue names, and resolve the open questions (EasyBuild temp dir versus bind mount, disk space figure) with a maintainer. Done means each bullet is either applied or explicitly declined in the thread.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

  • When using something else than /tmp for $EESSI_TMPDIR, you may have to bind mount that location by passing -B $EESSI_TMPDIR to Singularity. We can probably just always use this flag in the instructions, even when /tmp is being used.
  • Maybe have a TLDR section that allows you to easily copy all commands in one go.
  • Add an extra warning about the working directory from which the tarball gets created; this really has to be a subdir of the repo, as illustrated in the example.
  • Add a section on how this can be run as a (non-interactive) job. (using startprefix <<< buildscript.sh)
  • Build nodes should have internet access
  • How to set the number of cores to be used for compiling
  • Easybuild should use a temporary dir in $EESSI_TMPDIR (which can be set to something else than /tmp), or we should bind mount a subdir of $EESSI_TMPDIR as /tmp in the container
  • Check available disk space (~30GB?)
  • Make the tarball (especially when you install some additional packages, but it can be done in any case) in ${EESSI_TMPDIR}/overlay-upper/${EESSI_PILOT_VERSION}/software/linux
Lingua principale
Python
Stelle
14
Fork
54
Merge medio
11h 2m
PR unite (30g)
41

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di EESSI/docs

Tutte le issue di EESSI/docs

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.