diff --git a/docs/Services/pole-scientifique/Onyxia/docs/index.md b/docs/Services/pole-scientifique/Onyxia/docs/index.md index 7f28924..cb2191e 100644 --- a/docs/Services/pole-scientifique/Onyxia/docs/index.md +++ b/docs/Services/pole-scientifique/Onyxia/docs/index.md @@ -127,7 +127,7 @@ Une page centrée sur le service demandé s'ouvre alors, qui offre plusieurs pos - cliquer à nouveau sur le bouton `Lancer` pour lancer le service avec sa configuration par défaut ; -- personnaliser le nom que portera l'instance une fois le service lancé, attention, si vous enregistrer la configuration d’un service et que celui-ci a le même nom d’un service que vous avez déjà enregistré, sa configuration sera écrasée ; +- personnaliser le nom que portera l'instance une fois le service lancé, **Attention**, si vous enregistrer la configuration d’un service et que celui-ci a le même nom d’un service que vous avez déjà enregistré, sa configuration sera écrasée ; - dérouler un menu de configuration afin de personnaliser la configuration du service avant de le lancer ; @@ -190,12 +190,12 @@ Dans cet onglet vous pourrez modifier différents paramètres, les plus importan - La capacité de récupérer des scripts d’initialisation dans le language de programmation de votre choix, qui vous permettrons d’accéder au stockage S3 en dehors des services du datalab Onyxia GENES. Disponible dans le sous onglet Connexion au stockage (attention, les token fournit dans ces scripts d’initialisation expirent rapidement) ; - Récupérer les identifiants Vault afin de pouvoir l’utiliser dans votre terminal, disponible dans le sous onglet https://onyxia.lab.groupe-genes.fr/account/vault ; -# Information du compte +## Information du compte Dans le sous onglet Information du compte 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 : -# Services externes +## Services externes Dans le sous onglet Services externes 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 d’utiliser un Git différent de celui du GENES pour un service en particulier. Et d’effectuer la modification lors de la configuration du service dans le Catalogue de services (explication de la configuration en détail disponible ici LIEN A RAJOUTER) exemple: @@ -204,18 +204,20 @@ Et d’effectuer la modification lors de la configuration du service dans le Connexion au stockage 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. +## Connexion au stockage +Dans le sous onglet Connexion au stockage 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. + +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 l’obtention du Session token S3, il n’est 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 : 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 ![Screenshot](img/image12.png) -Vous pourrez également générer un script d’initialisation dans le langage de programmation de votre choix (R, Python, shell, MC client, s3cmd, etc...) disponible en bas à gauche via un menu déroulant : +Vous pourrez également générer un script d’initialisation dans le langage de programmation de votre choix (R, Python, shell, MC client, s3cmd, etc...) qui connectera automatiquement vos ressources à votre stockage Onyxia S3, disponible en bas à gauche via un menu déroulant : ![Screenshot](img/image13.png) -# Vault +## Vault Dans le sous onglet https://onyxia.lab.groupe-genes.fr/account/vault, vous aurez la possibilité de copier les variables d’environnement afin de configurer votre Vault CLI local : (VOIR PLUS D’INFO SUR LE FONCTIONNEMENT) ![Screenshot](img/image14.png) @@ -224,7 +226,7 @@ Attention, concernant l’obtention du token Vault, comme pour le token S3, il n ![Screenshot](img/image15.png) -# Modes d’interfaces +## Modes d’interfaces Dans le sous onglet Modes d’interfaces vous pourrez modifier le thème d’Onyxia, changer la langue, et activer la fonctionnalités “béta-testeur” qui actuellement vous ajout l’accès à un nouvelle onglet “Coquille SQL OLAP” A VOIR PLUS EN DETAIL LE TERMINAL DUCKDB # Catalogue de services @@ -238,7 +240,7 @@ Par exemple dans le Catalogue de services dans la catégorie Catalogue de services après avoir cliquer sur “lancer” du services que vous souhaitez utiliser, vous pourrez : Attribué un nom personnalisé au service, une fois le service lancé ou enregistré, celui-ci apparaitra dans l’onglet Mes services. @@ -255,10 +257,10 @@ Par ailleurs, l’option de la copie URL de lancement automatique ne s’affiche ![Screenshot](img/image17.png) -# Configuration avancée du Catalogue de services +## Configuration avancée du Catalogue de services A VOIR POUR EXPLIQUER PLUS EN DETAIL LE PARAMETRAGE DES SERVICES HORS CATEGORIE TYPE “INTERACTIVE SERVICES” genre database, mlflow... -## S3 +### S3 La configuration par défaut est celle de votre stockage S3 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. 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 d’accéder à un stockage S3 GENES autres que celui qui vous a été attribué par défaut. @@ -266,10 +268,10 @@ Modifier uniquement ces paramètres si vous possédez par exemple un stockage AW Pour apprendre à utiliser cet onglet, voir là page dédiée. -## Kubernetes +### Kubernetes Cette option est relativement technique et spécifique, vous ne devriez pas en avoir l’intérêt, hors manipulation direct dans l’environnement 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. -## Init +### Init Grâce à Init vous allez pouvoir personnaliser les environnements de vos services via des scripts, qui seront exécuté au lancement de votre services, pour automatiser l’installation d’un plugin sur un de vos services IDE ou autres. Exemple simple, je souhaite ajouter automatiquement sur mon service onyxia Jupyter un fichier .txt avec comme contenu “Hello World” dans le dossier work/hello-onyxia.txt. @@ -294,7 +296,7 @@ chown -R ${USERNAME}:${GROUPNAME} ${HOME} Ce script peut être hébergé n’importe où, du moment qu’il possède une URL publique (example: ) que j’ajoute ensuite dans le Init parameters “PersonalInit” de l’onglet Init: ![Screenshot](img/image19.png) -## PersonalInit +### PersonalInit Ajouter un lien vers un script shell (enchaînement de commandes linux) qui est exécuté juste après le lancement du service. Pratique pour automatiser la mise en place de certaines configurations. @@ -312,7 +314,7 @@ chown -R ${USERNAME}:${GROUPNAME} ${HOME} ``` ::: -## PersonalInitArgs +### PersonalInitArgs Des options à passer au script d'initialisation, séparées par des espaces et que l'on peut ensuite appeler avec `$1`, `$2`... Par exemple si on inscrit dans le champ *PersonalInitArgs* `fichier1.txt fichier2.txt`, et qu'on utilise ce script d'initialisation : @@ -325,33 +327,33 @@ touch $2 Le script créera via la commande `touch` deux fichiers `fichier1.txt` et `fichier2.txt`. -## Resources +### Resources C’est l’endroit où vous allez pouvoir configurer le minimum à maximum de ressource à vos services, pour rappel, vous êtes limités par compte à 5 services, 20 CPU, 50Go RAM et 1 GPU. ![Screenshot](img/image20.png) -## Networking +### Networking Cette option permet d’ouvrir un port en particulier sur votre service. (A VOIR, possibilité d’ouvrir 2 ports en séparant par une virgule ? Ou alors permet de faire du ingress/egress ??) ![Screenshot](img/image21.png) -## Security +### Security Permet de restreindre l’accès au différent service, filtrer selon IP (A VOIR possibilité d’en 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 l’exterieur de l’infra kubernetes), n’autoriser l’accès à ce service uniquement aux autres pod du mêmes namespace de l’utilisateur -### Password +#### 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. -### Enable IP protection +#### Enable IP protection Si coché, le service n'est accessible que par une seule IP, à décocher si l'on souhaite travailler de deux endroits différents. -### Enable network policy +#### Enable network policy -## Git +### Git Par défaut cette option est activée sur chaque service, ce qui configure Git et tente un clone d’un dépôt au démarrage du service. Attention, vous devez renseigner l’URL du dépôt Git dans l’option “Repository”. ![Screenshot](img/image22.png) -### Repository +#### Repository Attention, l’option “Repository” est L'URL à renseigner obligatoirement et qui obtenue sur la plateforme utilisée (Gitlab, Github...) en cliquant sur "Cloner" > HTTPS: Par example, pour le Github du GENES qui est paramétré par défaut, celle-ci sera obtenu sur le lien puis en cliquant sur l’icône “Copier l’URL”. Vous obtiendrez l’URL à renseigner dans l’option “Repository”, ce qui clonera ce dépôt automatiquement sur votre service : @@ -361,13 +363,13 @@ Par example, pour le Github du GENES qui est paramétré par défaut, celle-ci s Exemple sur un service Jupyter où l’URL du dépôt a été renseigné et donc cloné au démarrage : ![Screenshot](img/image24.png) -### Name +#### Name Le nom qui apparaîtra dans les commits (pas le nom d'utilisateur du compte Gitlab ou Github). -### Email +#### Email L'adresse email qui apparaîtra dans les commits (pas forcément le mail associé au compte Gitlab ou Github). -### Token +#### 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à page dédiée. @@ -375,18 +377,18 @@ Pour apprendre à utiliser plus en détails cette partie de Git, voir là ici. -## Service +### Service -## Discovery +### 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 d’automatiquement les rattacher à votre service. A VOIR comment l’interconnexion s’effectue ![Screenshot](img/image25.png) -## Persistence +### Persistence Vous permet de modifier la taille du disque alloué à votre service. 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. -## Vault +### Vault Pour apprendre à utiliser cet onglet, voir la page dédiée. -## +### []() ![Screenshot](img/.png) \ No newline at end of file