Actualiser docs/Services/pole-scientifique/Onyxia/docs/index.md

This commit is contained in:
Alexis GUYOT 2024-01-18 14:42:41 +01:00
parent 7d0e02f790
commit 50a71b9d40

View File

@ -23,17 +23,17 @@ L'avantage d'Onyxia réside dans la possibilité de partager chaque service avec
- Les utilisateurs peuvent définir le nombre de <a href="https://code.groupe-genes.fr/aguyot-ensae/image-public/raw/branch/main/images-onyxia/onyxia-resources.png/" target="_blank">RAM, CPU et GPU</a> quils souhaitent allouer à leurs services avec une limitation par utilisateur de : 5 services, 20 CPU, 50Go RAM, et 1 GPU.
- Possibilité de faire des demandes auprès du DSIT du GENES pour ajouter de nouveaux services au catalogue selon vos besoins <span style="color:red"> (à rajouter la méthode de formulation) </span>
- Possibilité de faire des demandes auprès du DSIT du GENES pour ajouter de nouveaux services au catalogue selon vos besoins
- Capacité de partager l'accès à vos services et ressources d'Onyxia avec un groupe de personnes.
- Possibilité de spécifier un script init personnalisable exécuté au lancement des services. <span style="color:red"> (à rajouter lien vers guide) </span>
- Possibilité de spécifier un script init personnalisable exécuté au lancement des services.
- Enregistrer, restaurer et partager la configuration de vos services avec vos collaborateur <span style="color:red"> (à rajouter lien vers guide) </span>
- Enregistrer, restaurer et partager la configuration de vos services avec vos collaborateur
- <a href="https://onyxia.lab.groupe-genes.fr/my-secrets/" target="_blank">Intégration de secrets</a> sous forme de variables d'environnement dans les services du <a href="https://onyxia.lab.groupe-genes.fr/" target="_blank">Datalab</a>, permettant de stocker les informations sensibles de type clés d'API dans Vault et de les rendre accessibles dans les services sous forme de variable. (à rajouter lien vers guide)
- <span style="color:red"> (à rajouter lien vers guide) (A ETE VU, CE SERA BIEN MIS EN PLACE) Possibilités daccéder et de créé des formations techniques sur différents outils mis à disposition pour vos collaborateurs ou élèves (comme sur : <https://www.sspcloud.fr/formation>), en terme de présentation cela pourrait être pas mal démontrant avec un exemple détaillés du genre: Un professeur créé un tutoriel, ajoute une URL de configuration, sur lequel les élèves cliques pour déployer un service dans leurs propre namespace, démontrant ainsi la facilité de déployer un environnement de travail stable. </span>
- Possibilités daccéder et de créé des formations techniques sur différents outils mis à disposition pour vos collaborateurs ou élèves
## Présentation rapide dOnyxia en vidéo :
@ -107,11 +107,11 @@ Visite guidée du Datalab
Bienvenue sur le Datalab Onyxia, plateforme de libre service mutualisée de traitement de données, destinée aux statisticiens et _data scientists_ de l'Etat. Ce tutoriel propose une visite guidée du Datalab pour être rapidement opérationnel dans l'utilisation de ses services.
Il sagit dune présentation sommaire, chaque page web donyxia, vous trouverez un guide détaillant chaque page web donyxia <span style="color:red">ici (LIEN VERS GUIDE DETAIL). </span>
Il sagit dune présentation sommaire, chaque page web donyxia, vous trouverez un guide détaillant chaque page web donyxia à partir de la section "Mon compte".
::: {.callout-warning}
Les conditions d'utilisation du Datalab sont consultables à <span style="color:red">adresse (A DEFINIR)</span>. Nous rappelons que le Datalab est destiné exclusivement au traitement de **données publiques et non-sensibles**. Des projets d'expérimentation mobilisant des données non ouvertes peuvent être menés en concertation avec l'équipe du Datalab, sous réserve de se conformer aux règles de sécurité spécifiques au projet.
Les conditions d'utilisation du Datalab sont consultables à (ici)[https://code.groupe-genes.fr/DSIT/documentation-dsit/src/branch/main/docs/Services/pole-scientifique/Onyxia/docs/terms.md]. Nous rappelons que le Datalab est destiné exclusivement au traitement de **données publiques et non-sensibles**. Des projets d'expérimentation mobilisant des données non ouvertes peuvent être menés en concertation avec l'équipe du Datalab, sous réserve de se conformer aux règles de sécurité spécifiques au projet.
:::
# Le catalogue de services
@ -133,7 +133,7 @@ Une page centrée sur le service demandé s'ouvre alors, qui offre plusieurs pos
- sauvegarder une configuration personnalisée en cliquant sur le signet en haut à droite du service, ce qui vous permettra denregistrer l'entièreté de la configuration du service et de le relancer depuis longlet <a href="https://onyxia.lab.groupe-genes.fr/my-services" target="_blank">Mes services</a>.
La configuration précise de S3, Kubernetes, Init etc... sur les services constitue un usage avancé, chaque onglet du site web seront expliqués en détails plus loin <span style="color:red">(LIENS VERS DOCUMENTATION)</span>.
La configuration précise de S3, Kubernetes, Init etc... sur les services constitue un usage avancé, chaque onglet du site web seront expliqués en détails plus loin à la section "Configuration avancée du Catalogue de services".
# Utiliser un service
L'action de lancer un service amène automatiquement sur la page <a href="https://onyxia.lab.groupe-genes.fr/my-services" target="_blank">Mes services</a>, où sont listées toutes les instances en activité sur le compte de l'utilisateur.
@ -156,7 +156,7 @@ Les ressources mises à disposition pour l'execution des services sont partagée
# Partager un service
<span style="color:red">A VOIR, option activée par défaut ou sur demande ? Il faudra créé manuellement les groupes etc avec des bucket policy manuellement, il y a pas un style de IAM AWS qui est liable avec minios et qui pourrait facilité/automatiser ce proccess ? </span> Il est possible de partager un service à un groupe de personnes en cochant la case "Partager le service" à l'ouverture du service. Les autres membres du groupe verront le service et pourront l'utiliser. La création de groupes se fait en écrivant aux administrateurs sur Tchap (en privé) ou par mail à l'adresse <span style="color:red">A DEFINIR</span> en communiquant le nom de groupe, les noms d'utilisateurs des membres, le besoin ou non d'un espace de stockage associé sur MinIO.
Il est possible de partager un service à un groupe de personnes en cochant la case "Partager le service" à l'ouverture du service. Les autres membres du groupe verront le service et pourront l'utiliser. La création de groupes se fait en écrivant aux administrateurs sur (Tchap (en privé))[https://teams.microsoft.com/l/team/19%3Ak2a7PAYG-0EO6vmypa7sBdB5hXUR5c3YBDcszO0wCe41%40thread.tacv2/conversations?groupId=050057b4-2f34-4149-9084-5cd8f14b48e5&tenantId=99578065-47e8-4c36-bbf8-4e1228cfb056] ou par mail à l'adresse support.informatique@ensae.fr.
Pour un besoin ponctuel, il est aussi possible de partager un service que l'on a créé à une autre personne, **Attention** via cette méthode, une seule personne à la fois peut se connecter à un service.
@ -198,7 +198,7 @@ Dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/infos" t
## Services externes
Dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/third-party-integration" target="_blank">Services externes</a> vous pourrez récupérer et modifier les informations des comptes et jetons Gitlab, Github et Kaggle qui seront par défaut, lié à tous les services que vous créerez. Nous vous conseillons donc de laisser ces paramètres par défaut et que si vous avez besoin dutiliser un Git différent de celui du GENES pour un service en particulier.
Et deffectuer la modification lors de la configuration du service dans le <a href="https://onyxia.lab.groupe-genes.fr/catalog/ide" target="_blank">Catalogue de services</a> <span style="color:red">(explication de la configuration en détail disponible ici LIEN A RAJOUTER)</span> exemple:
Et deffectuer la modification lors de la configuration du service dans le <a href="https://onyxia.lab.groupe-genes.fr/catalog/ide" target="_blank">Catalogue de services</a> exemple:
@ -209,7 +209,7 @@ Dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/storage"
Cependant **Attention**, tous les tokens de cet onglet expire et se renouvelle automatiquement toutes les 24 heures. Si vous utiliser un token pour connecter des ressources externes a votre stockage S3 Onyxia, bien se rappeler que la durée de vie des tokens est courte et qu'il faudra mettre à jour le token d'accès pour vos ressources externes.
**Attention**, concernant lobtention du Session token S3, il nest pas affiché dans son entièreté, éviter donc de le copier directement en le sélectionnant puis “copier”. Utiliser bien l'icône “Copier dans le presse-papier" à droite de celui-ci </a> <span style="color:red">: Possibilité de modifier cette partie et d'afficher entièrement le token ? dans le mail de nesrine qui avait eu un problème d'accès S3, elle n'avait pas mis le token en entier et faire un copier/coller manuel</span>
**Attention**, concernant lobtention du Session token S3, il nest pas affiché dans son entièreté, éviter donc de le copier directement en le sélectionnant puis “copier”. Utiliser bien l'icône “Copier dans le presse-papier" à droite de celui-ci :
![Screenshot](img/image12.png)
@ -218,7 +218,7 @@ Vous pourrez également générer un script dinitialisation dans le langage d
![Screenshot](img/image13.png)
## Vault
Dans le sous onglet <a href="Vault" target="_blank">https://onyxia.lab.groupe-genes.fr/account/vault</a>, vous aurez la possibilité de copier les variables denvironnement afin de configurer votre Vault CLI local : <span style="color:red">(VOIR PLUS DINFO SUR LE FONCTIONNEMENT)</span>
Dans le sous onglet <a href="Vault" target="_blank">https://onyxia.lab.groupe-genes.fr/account/vault</a>, vous aurez la possibilité de copier les variables denvironnement afin de configurer votre Vault CLI local :
![Screenshot](img/image14.png)
@ -230,7 +230,7 @@ Attention, concernant lobtention du token Vault, comme pour le token S3, il n
Dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/user-interface" target="_blank">Modes dinterfaces</a> vous pourrez modifier le thème dOnyxia, changer la langue, et activer la fonctionnalités “béta-testeur” qui actuellement vous ajout laccès à un nouvelle onglet “Coquille SQL OLAP” <span style="color:red">A VOIR PLUS EN DETAIL LE TERMINAL DUCKDB</span>
# Catalogue de services
Longlet <a href="https://onyxia.lab.groupe-genes.fr/catalog/ide" target="_blank">Catalogue de services</a> va vous permettre de lancer, paramétrer et sauvegarder la configuration de vos différents services, qui posséderons plus au moins de sous onglets paramétrables S3, Init, Git etc... qui seront plus détaillé dans <span style="color:red">“LIEN VERS Configuration avancée du Catalogue de services“</span> .
Longlet <a href="https://onyxia.lab.groupe-genes.fr/catalog/ide" target="_blank">Catalogue de services</a> va vous permettre de lancer, paramétrer et sauvegarder la configuration de vos différents services, qui posséderons plus au moins de sous onglets paramétrables S3, Init, Git etc... qui seront plus détaillé dans la section "Configuration avancée du Catalogue de services".
Pour lancer et paramétrer un service, il suffit de cliquer sur “Lancer”.
@ -258,7 +258,6 @@ Par ailleurs, loption de la copie URL de lancement automatique ne saffiche
![Screenshot](img/image17.png)
## Configuration avancée du Catalogue de services
<span style="color:red">A VOIR POUR EXPLIQUER PLUS EN DETAIL LE PARAMETRAGE DES SERVICES HORS CATEGORIE TYPE “INTERACTIVE SERVICES” genre database, mlflow... </span>
### S3
La configuration par défaut est celle de votre <a href="https://minio-console.lab.groupe-genes.fr/browser" target="_blank">stockage S3</a> fournit par le groupe GENES, il vous sera donc possible d'accéder aux fichiers stockés directement dans les services de data science (R, Python, Jupyter...) proposés sur le Datalab, sans avoir besoin de copier les fichiers localement au préalable, ce qui améliore fortement la reproductibilité des analyses.
@ -333,12 +332,12 @@ Cest lendroit où vous allez pouvoir configurer le minimum à maximum de r
![Screenshot](img/image20.png)
### Networking
Cette option permet douvrir un port en particulier sur votre service. <span style="color:red">(A VOIR, possibilité douvrir 2 ports en séparant par une virgule ? Ou alors permet de faire du ingress/egress ??) </span>
Cette option permet douvrir un port en particulier sur votre service.
![Screenshot](img/image21.png)
### Security
Permet de restreindre laccès au différent service, filtrer selon IP <span style="color:red">(A VOIR possibilité den ajouter plusieurs avec une virgule entre + possibilité de faire un range (127.0.0.1-127.0.0.5) + normalement oui mais confirmer si accessible depuis lexterieur de linfra kubernetes), nautoriser laccès à ce service uniquement aux autres pod du mêmes namespace de lutilisateur </span>
Permet de restreindre laccès au différent service, filtrer selon IP.
#### Password
C'est le mot de passe à saisir lorsqu'on ouvre un service, celui donné par "Copier le mot de passage" sur la page des services. Il est fourni par le paramètre général "Mot de passe pour vos services" que l'on trouve dans "Mon Compte" > "Informations du compte", sauf si on en a défini un particulier au niveau du service.
@ -380,11 +379,11 @@ Il n'est pas possible de cloner automatiquement un projet privé d'une instance
### Service
### Discovery
Les différentes options du discovery sont activées, elles permettent de détecter si vous avez un service Hive metastore, mlflow ou metaflow de lancer et dautomatiquement les rattacher à votre service. <span style="color:red">A VOIR comment linterconnexion seffectue </span>
Les différentes options du discovery sont activées, elles permettent de détecter si vous avez un service Hive metastore, mlflow ou metaflow de lancer et dautomatiquement les rattacher à votre service.
![Screenshot](img/image25.png)
### Persistence
Vous permet de modifier la taille du disque alloué à votre service. <span style="color:red">A VOIR car non persistent normalement, bien préciser que les données utilisateurs doivent impérativement être stocker sur git/s3 et non pas sur le service directement. </span>
Vous permet de modifier la taille du disque alloué à votre service.
### Vault
Pour apprendre à utiliser cet onglet, voir la <a href="https://docs.sspcloud.fr/onyxia-guide/gestion-des-secrets" target="_blank">page dédiée</a>.