Libelektra: supprimer les barrières à l'entrée

Créé le 1 nov. 2020  ·  3Commentaires  ·  Source: ElektraInitiative/libelektra

  • [ ] retravailler le fichier README.md principal
  • [ ] couvre pourquoi l'écriture sur le système nécessite root
  • [ ] tutoriel de première étape (get/set) avec TOML
  • [ ] réécrivez doc/COMPILE.md en un didacticiel axé sur les problèmes (comme l'installation sans racine)
  • [ ] doc/TESTING.md : décrit comment exécuter kdb run_all sans racine
  • [ ] publicité/tutoriel de présentation #2742
  • [ ] + vidéo de ce tutoriel
  • [ ] Tutoriel METADATA.ini
  • [ ] Tutoriel Java pour débutants avec maven
  • [ ] exécuter des tests sans racine
  • [ ] Page principale de la documentation de l'API

@robaerd @dev2718 pouvez-vous donner plus d'informations sur les barrières à l'entrée que vous avez franchies ?

Tous les 3 commentaires

Pour moi c'était l'installation d'elektra sans root.
L'installation sans racine nécessite la définition de quelques drapeaux cmake (KDB_DB_SYSTEM, CMAKE_INSTALL_PREFIX, ...) et de variables d'environnement (LD_LIBRARY_PATH, ..). Bien que CMAKE_INSTALL_PREFIX soit décrit dans doc/COMPILE , il n'était pas évident pour moi quels drapeaux cmake et envs devaient être définis pour cela.
Dans doc/Testing.md dans la section "Vous avez des options pour éviter de les exécuter en tant que root :" , l'exemple suivant d'invocation cmake est référencé : scripts/configure-home (devrait être en fait scripts/dev/configure-home ). Cet exemple ne couvre que la compilation et non l'installation (l'indicateur CMAKE_INSTALL_PREFIX est manquant). Étant donné que kdb run_all est également décrit dans doc/TESTING.md , il devrait, du moins à mon avis, être également mentionné comment faire fonctionner cela sans root.

Les étapes de doc/tutorials/run_all_tests_with_docker.md - qui sont en fait référencées dans doc/TESTING.md - décrivent comment l'installer en tant qu'utilisateur non root, mais il n'est pas mentionné que les images docker sont exécutées en tant que non root. Donc, au début, il m'était un peu difficile de comprendre pourquoi ces choses devaient être définies uniquement ici.

Je proposerais de :

  • ajoutez une description indiquant que les images docker sont exécutées en tant que non root (et peut-être aussi la raison de cela).
  • ajoutez un point à doc/INSTALL.md et/ou doc/TESTING.md sur la façon d'installer elektra sans privilèges root.

Merci beaucoup pour cet apport très utile !

Bien que CMAKE_INSTALL_PREFIX soit décrit dans doc/COMPILE

Oui, je suis entièrement d'accord, ce docu doit être réécrit dans un style où les problèmes concrets sont résolus (comme l'installation sans root). La seule description de ce que font les drapeaux est mieux faite dans le CMake-cache-variable-docu.

mais il n'est pas mentionné que les images docker sont exécutées en tant que non root

J'espère que vous pourrez améliorer les tutoriels sur les images Docker :sparkling_heart:, vous devez quand même les adapter avec les modifications que vous apportez (comme supprimer le besoin de l'utilisateur Jenkins).

les images docker sont exécutées en tant que non root (et peut-être aussi la raison de cela).

Voulez-vous dire la raison pour laquelle ils s'exécutent en tant que non root? Il est recommandé d'exécuter quelque chose avec le moins de privilèges possible.

En général : c'est bien si nous ne supposons pas trop de connaissances sur Docker ou Jenkins dans notre docu, car beaucoup de gens ne l'ont pas. Je suis donc d'accord qu'une telle justification devrait être donnée.

J'espère que vous pourrez améliorer les tutoriels sur les images Docker 💖, vous devez quand même les adapter avec les modifications que vous apportez (comme supprimer le besoin de l'utilisateur Jenkins).

Oui bien sûr je vais améliorer les tutos sur les images Docker.

Cette page vous a été utile?
0 / 5 - 0 notes

Questions connexes

sanssecours picture sanssecours  ·  3Commentaires

markus2330 picture markus2330  ·  4Commentaires

mpranj picture mpranj  ·  3Commentaires

markus2330 picture markus2330  ·  4Commentaires

dominicjaeger picture dominicjaeger  ·  3Commentaires