Improvements for build nodes documentation

Ouverte
#72 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Domaine
documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

  • 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
Langage dominant
Python
Étoiles
14
Forks
54
Merge moyen
11 h 2 min
PR mergées (30 j)
41

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de EESSI/docs

Toutes les issues de EESSI/docs

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.