Improvements for build nodes documentation

Abierto
#72 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

  • 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
Lenguaje dominante
Python
Estrellas
14
Forks
54
Merge medio
11 h 2 min
PR fusionados (30 d)
41

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de EESSI/docs

Todos los issues de EESSI/docs

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.