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

This commit is contained in:
Alexis GUYOT 2024-01-19 14:57:50 +01:00
parent 2997bebcd0
commit e3391d4a6f

View File

@ -109,7 +109,7 @@ 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 à partir de la section <a href="#mon-compte">Mon compte visible ici</a>.
Il sagit dune présentation sommaire, chaque page web donyxia, vous trouverez un guide détaillant chaque page web donyxia à partir de la section <a href="#mon-compte" target="_blank">Mon compte visible ici</a>.
@ -118,7 +118,7 @@ Les conditions d'utilisation du Datalab sont consultables à <a href="https://co
:::
# Le catalogue de services
Le <a href="https://onyxia.lab.groupe-genes.fr/" target="_blank">catalogue de services </a> est au centre de l'utilisation du Datalab. Il propose un ensemble de services destinés aux traitements statistiques de données ainsi qu'à la gestion complète des projets de data science.
Le <a href="https://onyxia.lab.groupe-genes.fr/catalog/ide target="_blank">catalogue de services </a> est au centre de l'utilisation du Datalab. Il propose un ensemble de services destinés aux traitements statistiques de données ainsi qu'à la gestion complète des projets de data science.
![Screenshot](img/image4.png)
@ -136,7 +136,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 à la section <a href="#configuration-avancée-du-catalogue-de-services">Configuration avancée du Catalogue de 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 à la section <a href="#configuration-avancée-du-catalogue-de-services" target="_blank">Configuration avancée du Catalogue de services</a>.
# 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.
@ -191,7 +191,7 @@ Dans cet onglet vous pourrez modifier différents paramètres, les plus importan
- Modification des comptes et jetons Gitlab, Github et Kaggle qui seront par lié par défaut a tous les services que vous créérez, disponible dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/third-party-integration" target="_blank">Services externes</a> ;
- La capacité de récupérer des scripts dinitialisation dans le language de programmation de votre choix, qui vous permettrons daccéder au stockage S3 en dehors des services du datalab Onyxia GENES. Disponible dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/storage" target="_blank">Connexion au stockage</a> (attention, les token fournit dans ces scripts dinitialisation expirent rapidement) ;
- Récupérer les identifiants Vault afin de pouvoir lutiliser dans votre terminal, disponible dans le sous onglet <a href="Vault" target="_blank">https://onyxia.lab.groupe-genes.fr/account/vault</a> ;
- Récupérer les identifiants Vault afin de pouvoir lutiliser dans votre terminal, disponible dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/vault" target="_blank">Vault</a> ;
## Information du compte
Dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/infos" target="_blank">Information du compte</a> vous retrouverez les informations générales de votre compte Datalab Onyxia GENES et la capacité de modifier le mot de passe pour accéder aux différents services déployer dans votre espace :
@ -208,7 +208,7 @@ Et deffectuer la modification lors de la configuration du service dans le <a
![Screenshot](img/image11.png)
## Connexion au stockage
Dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/storage" target="_blank">Connexion au stockage</a> vous trouverez toutes les informations de votre [stockage S3](https://minio-console.lab.groupe-genes.fr/browser) fournit par le GENES et qui sera automatiquement lié à tous les services du Datalab Onyxia GENES que vous créerez. Dans cet onglet vous trouverez également toutes les informations pour connecter vos ressources externes à votre stockage Onyxia S3.
Dans le sous onglet <a href="https://onyxia.lab.groupe-genes.fr/account/storage" target="_blank">Connexion au stockage</a> vous trouverez toutes les informations de votre <a href="https://minio-console.lab.groupe-genes.fr/browser" target="_blank">stockage S3</a>fournit par le GENES et qui sera automatiquement lié à tous les services du Datalab Onyxia GENES que vous créerez. Dans cet onglet vous trouverez également toutes les informations pour connecter vos ressources externes à votre stockage Onyxia S3.
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.
@ -233,7 +233,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”.
# 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 la section <a href="#configuration-avancée-du-catalogue-de-services">Configuration avancée du Catalogue de services</a> .
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 <a href="#configuration-avancée-du-catalogue-de-services" target="_blank">Configuration avancée du Catalogue de services</a> .
Pour lancer et paramétrer un service, il suffit de cliquer sur “Lancer”.
@ -268,7 +268,7 @@ La configuration par défaut est celle de votre <a href="https://minio-console.l
Modifier uniquement ces paramètres si vous possédez par exemple un stockage AWS S3 et que vous souhaitez le monter sur un service Onyxia ou que vous avez besoins daccéder à un stockage S3 GENES autres que celui qui vous a été attribué par défaut.
![Screenshot](img/image18.png)
Pour apprendre à utiliser cet onglet, voir là <a href="https://docs.sspcloud.fr/onyxia-guide/stockage-de-donnees" target="_blank">page dédiée</a>.
Pour apprendre à utiliser cet onglet, voir là <a href="https://code.groupe-genes.fr/DSIT/documentation-dsit/src/branch/main/docs/Services/pole-scientifique/Onyxia/docs/stockage.md" target="_blank">page dédiée</a>.
### Kubernetes
Cette option est relativement technique et spécifique, vous ne devriez pas en avoir lintérêt, hors manipulation direct dans lenvironnement Kubernetes. Cependant cette option vous permettra, depuis les différents services que vous avez déployés (pods aux seins de votre namespace Onyxia), de pouvoir effectuer des interactions Kubernetes avec le Master Node et exécuter des commandes kubectl dans un terminal de service (kubectl get pods, kubectl edit deployment etc...). Les interactions seront limitées à ce qui est déployé au sein de votre namespace. Vous avez également la possibilité de modifier le rôle Kubernetes attribué aux services, restreignant les actions possibles : view, edit ou admin.
@ -305,7 +305,7 @@ Ajouter un lien vers un script shell (enchaînement de commandes linux) qui est
Ce lien du script doit être accessible sur internet, par exemple sur <https://code.groupe-genes.fr/> ou autres Git avec un projet public.
[Exemple de script d'initialisation](https://git.drees.fr/drees_code_public/ressources/tutos/-/blob/diffusion/contenu/init.sh){:target="_blank"} qui clone un projet à partir d'une instance Gitlab privée, configure les options globales de RStudio, ouvre automatiquement le projet RStudio cloné, installe et sélectionne la correction orthographique française, personnalise les bribes de codes (snippets).
<a href="https://git.drees.fr/drees_code_public/ressources/tutos/-/blob/diffusion/contenu/init.sh">Exemple de script d'initialisation</a>qui clone un projet à partir d'une instance Gitlab privée, configure les options globales de RStudio, ouvre automatiquement le projet RStudio cloné, installe et sélectionne la correction orthographique française, personnalise les bribes de codes (snippets).
::: {.callout-warning}
Le script est exécuté en tant que superutilisateur (*Root*) et les fichiers qu'il crée sont ainsi la propriété du superutilisateur.
@ -374,9 +374,9 @@ L'adresse email qui apparaîtra dans les commits (pas forcément le mail associ
#### Token
Jeton d'accès défini sur la plateforme utilisée (Gitlab, Github...).
Pour apprendre à utiliser plus en détails cette partie de Git, voir là <a href="https://docs.sspcloud.fr/onyxia-guide/controle-de-version" target="_blank">page dédiée</a>.
Pour apprendre à utiliser plus en détails cette partie de Git, voir là <a href="https://code.groupe-genes.fr/DSIT/documentation-dsit/src/branch/main/docs/Services/pole-scientifique/Onyxia/docs/secrets.md" target="_blank">page dédiée</a>.
Il n'est pas possible de cloner automatiquement un projet privé d'une instance privée (c'est-à-dire autre que gitlab.com et github.com). Pour le faire, il faudra recourir à un script shell comme indiqué <a href="https://docs.sspcloud.fr/onyxia-guide/configuration-des-services#init" target="_blank">ici</a>.
Il n'est pas possible de cloner automatiquement un projet privé d'une instance privée (c'est-à-dire autre que gitlab.com et github.com). Pour le faire, il faudra recourir à un script shell comme indiqué <a href="#init" target="_blank">plus de détails ici</a>.
### Service