-
Notifications
You must be signed in to change notification settings - Fork 13
/
index.qmd
125 lines (72 loc) · 8.17 KB
/
index.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
::: {.content-visible when-profile="fr"}
# Bienvenue sur le SSP Cloud !
Instance ouverte du projet [Onyxia](https://www.onyxia.sh/), le [SSP Cloud](https://datalab.sspcloud.fr/) est une plateforme mutualisée de traitement de données, ou "Datalab". Elle est dédiée à l'expérimentation autour des méthodes de datascience à partir de données ouvertes. A travers ce tutoriel, nous vous proposons une visite guidée du Datalab pour être rapidement opérationnel dans l'utilisation de ses services.
::: {.callout-warning}
Les conditions d'utilisation du SSP Cloud sont consultables à [cette adresse](https://datalab.sspcloud.fr/terms). Nous rappelons que le SSP Cloud 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 projet Onyxia, sous réserve de se conformer aux règles de sécurité spécifiques au projet.
:::
## Le catalogue de services
Le [catalogue de services](https://datalab.sspcloud.fr/catalog/ide) est au centre de l'utilisation du SSP Cloud. 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_.
### Lancer un service
Pour lancer un service, il suffit de cliquer sur le bouton `Lancer` du service désiré
Une page centrée sur le service demandé s'ouvre alors, qui offre plusieurs possibilités :
* 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é ;
* dérouler un menu de configuration afin de personnaliser la configuration du service avant de le lancer ;
* sauvegarder une configuration personnalisée en cliquant sur le signet en haut à droite du service.
::: {.callout-info}
La configuration précise des services du SSP Cloud constitue un usage avancé et n'est donc pas traité dans ce tutoriel, mais dans d'autres pages de ce site documentaire.
:::
### Utiliser un service
L'action de lancer un service amène automatiquement sur la page [Mes Services](https://datalab.sspcloud.fr/my-services), où sont listées toutes les instances en activité sur le compte de l'utilisateur.
Une fois le service lancé, un bouton `Ouvrir` apparaît qui permet l'accès au service. Un mot de passe — et, selon les services, un nom d'utilisateur — est généralement requis pour pouvoir utiliser le service. Ces informations sont disponibles dans le `README` associé au service, auquel on accède en cliquant sur le bouton du même nom.
### Supprimer une instance
Supprimer une instance d'un service s'effectue simplement en cliquant sur l'icône en forme de poubelle en dessous de l'instance.
::: {.callout-caution}
Pour certains services, la suppression d'une instance entraîne la suppression de toutes les données associées, et cette action est irrémédiable. Il est donc nécessaire de toujours bien lire le `README` associé à l'instance, qui précise les conséquences d'une suppression de l'instance. De manière générale, il est très important de s'assurer que les données ainsi que le code utilisés sont sauvegardés avant de supprimer l'instance. L'idéal est de versionner son code avec Git et de procéder à des sauvegardes régulières des données à l'aide du système de stockage S3.
:::
::: {.callout-caution}
Les ressources mises à disposition pour l'execution des services sont partagées entre les différents utilisateurs du SSP Cloud. Veuillez à ne pas laisser en cours des services dont vous ne faites plus l'usage. Nous procédons parfois à une suppression systématique des instances inactives depuis un certain temps, afin de libérer des ressources.
:::
## Support
Le support et l'aide à l'utilisation du SSP Cloud sont effectuées sur deux outils de communication :
* Sur [le Slack Onyxia](https://join.slack.com/t/3innovation/shared_invite/zt-1bo6y53oy-Y~zKzR2SRg37pq5oYgiPuA) dans le canal dédié #sspcloud. Toute question sur l'utilisation du SSP Cloud ou suggestion d'amélioration y sont les bienvenues.
* Sur un [salon dédié](https://matrix.to/#/#SSPCloudXDpAw6v:agent.finances.tchap.gouv.fr) du service de messagerie instantanée interministériel de l'état Francais [Tchap](https://www.tchap.gouv.fr) pour les agents publiques français.
:::
::: {.content-visible when-profile="en"}
# Welcome to the SSP Cloud!
An open instance of the [Onyxia](https://www.onyxia.sh/) project, the [SSP Cloud](https://datalab.sspcloud.fr/) is a shared data processing platform. This “Datalab” is dedicated to experimenting with datascience methods based on open data. In this tutorial, we'll take you on a guided tour of the Datalab, to help you get up and running quickly.
::: {.callout-warning}
The terms of use for the SSP Cloud can be found at [this address](https://datalab.sspcloud.fr/terms). We remind you that the SSP Cloud is intended exclusively for the processing of **public and non-sensitive data**. Projects involving non-open data for experimentation can be carried out in consultation with the Onyxia team, subject to compliance with project-specific security rules.
:::
## Service Catalog
The [service catalog](https://datalab.sspcloud.fr/catalog/inseefrlab-helm-charts-datascience) is at the core of the SSP Cloud's usage. It offers a set of services for statistical data processing and complete management of data science projects.
### Launching a Service
To launch a service, simply click on the `Launch` button of the desired service.
A page centered on the requested service will then open, offering several options:
* Click again on the `Launch` button to start the service with its default configuration.
* Customize the name that the instance will have once the service is launched.
* Unfold a configuration menu to customize the service's configuration before launching it.
* Save a customized configuration by clicking on the bookmark at the top right of the service.
::: {.callout-info}
The detailed configuration of services is an advanced usage and is not covered in this tutorial but in other pages of this documentation site.
:::
### Using a Service
Launching a service automatically takes you to the [My Services](https://datalab.sspcloud.fr/my-services) page, where all active instances on the user's account are listed.
Once the service is launched, an `Open` button appears, allowing access to the service. A password — and, depending on the services, a username — is generally required to use the service. This information is available in the service's `README`, which can be accessed by clicking on the button of the same name.
### Deleting an Instance
Deleting an instance of a service is done simply by clicking on the trash can icon below the instance.
::: {.callout-caution}
For some services, deleting an instance will also delete all associated data, and this action is irreversible. Therefore, it is essential to always read the `README` associated with the instance, which specifies the consequences of deleting the instance. In general, it is crucial to ensure that the data and code used are backed up before deleting the instance. Ideally, version your code with Git and regularly back up the data using MinIO (S3 storage system).
:::
::: {.callout-caution}
The resources made available for executing services are shared among different SSP Cloud users. Please make sure not to leave active services that you no longer use. We sometimes systematically remove inactive instances after a certain period to free up resources.
:::
## Support
Support and assistance for using the SSP Cloud are provided through two communication channels:
* On [the Onyxia Slack](https://join.slack.com/t/3innovation/shared_invite/zt-1bo6y53oy-Y~zKzR2SRg37pq5oYgiPuA) in the #sspcloud channel. Any questions about using the SSP Cloud or suggestions for improvement are welcome there.
* In a [dedicated room](https://matrix.to/#/#SSPCloudXDpAw6v:agent.finances.tchap.gouv.fr) of the French state inter-ministerial instant messaging service [Tchap](https://www.tchap.gouv.fr) for French public agents.
:::