bloomberg / bloomberg/pytest-pystack

Document how to use in github actions

Abierto
#2 2 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation
Lenguaje dominante
Python
Estrellas
21
Forks
5
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Users might get the following error in CI:
```
💀 Engine error: No such process 💀

The specified process cannot be traced. This could be because the tracer
has insufficient privileges (the required capability is CAP_SYS_PTRACE).
Unprivileged processes cannot trace processes that they cannot send signals
to or those running set-user-ID/set-group-ID programs, for security reasons.
Alternatively, the process may already be being traced.

If your uid matches the uid of the target process you want to analyze, you
can do one of the following to get 'ptrace' scope permissions:

* If you are running inside a Docker container, you need to make sure you
start the container using the '--cap-add=SYS_PTRACE' or '--privileged'
command line arguments. Notice that this may not be enough if you are not
running as 'root' inside the Docker container as you may need to disable
hardening (see next points).

* Try running again with elevated permissions by running 'sudo -E !!'.

* You can disable kernel hardening for the current session temporarily (until
a reboot happens) by running 'echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope'.
```

Rather than waiting for them to get the error to notice it, document that when running in github actions they should have a step that runs `echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope`.

We can add this in a section of the README file.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Empieza por el README y sus secciones de uso existentes; después, revisa cómo se ejecuta el proyecto en GitHub Actions. La tarea estará terminada cuando el README documente el paso de permisos de ptrace solicitado para los usuarios de GitHub Actions, incluido el comando mostrado en el issue.

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

Evaluación

Stack tecnológico
github-actions
Área
ci-cd, documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.