Improvements for build nodes documentation

Offen
  • Stimmt etwas nicht?
#72 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

  • 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
Vorherrschende Sprache
Python
Sterne
14
Forks
54
Ø Merge
11 Std. 2 Min.
Gemergte PRs (30 T.)
41

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus EESSI/docs

Alle Issues in EESSI/docs

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.