# Getting started with Onyxia

{% hint style="success" %}
See also [https://docs.sspcloud.fr](https://docs.sspcloud.fr/)

It's the Onyxia user guide dedicated to our staff.  
{% endhint %}

There are 3 main components accessible on the onyxia web interface :

* catalogs and services launched by the users (Kubernetes access)
* a file browser (S3 access)
* secret browser (Vault access)

## Start a service

Following is a documentation Onyxia when configured with the default service catalogs : 

{% embed url="<https://github.com/inseefrlab/helm-charts-interactive-services>" %}

This collection of charts help users to launch many IDE with various binary stacks (python , R) with or without GPU support. Docker images are built [here](https://github.com/inseefrlab/images-datascience) and help us to give a homogeneous stack.

{% embed url="<https://github.com/inseefrlab/helm-charts-databases>" %}

This collection of charts help users to launch many databases system. Most of them are based on [bitnami/charts](https://guthub.com/bitnami/charts).

{% embed url="<https://github.com/InseeFrLab/helm-charts-automation>" %}

This collection of charts help users to start automation tools for their datascience activity.&#x20;

{% embed url="<https://github.com/InseeFrLab/helm-charts-datavisualization>" %}

This collection of charts helps users to launch tools to visualize and share data insights.

{% hint style="info" %}
The Onyxia user experience may be very different from one catalog of service to another. &#x20;

The catalog defines what options are available though Onyxia. &#x20;
{% endhint %}

Users can edit various parameters. Onyxia do some assertion based on the charts values schema and the configuration on the instance. For example some identity token can be injected by default (because Onyxia connect users to many APIs).

<figure><img src="/files/ceu3JtiCLD1fsIkO9v3j" alt=""><figcaption></figcaption></figure>

After launching a service, notes are shown to the user. He can retrieve those notes on the README button. Charts administrator should explain how to connect to the services (url , account) and what happens on deletion.

<figure><img src="/files/6cJLzozNR5bchVMli0Uy" alt=""><figcaption></figcaption></figure>

Now you want to learn how to setup your devloppement environement for day to day usage: &#x20;

{% content-ref url="/pages/cdkxJw8KXKGlY30oMRVS" %}
[Setting up your dev environment in Onyxia](/user-doc/setting-up-your-dev-environment-in-onyxia.md)
{% endcontent-ref %}

## File browser

Users can manage their files on S3. There is no support for rename in S3 so don't be surprise. Onyxia is educational. Any action on the S3 browser in the UI is written in a console with a cli.

<figure><img src="/files/NUs6qnJmOJeCPNOFGRKH" alt=""><figcaption><p>s3 browser</p></figcaption></figure>

User can do the following S3 actions :&#x20;

* download files
* upload files
* delete files

Of course, in our default catalags there are all the necessary tools to connect to S3.

Our advice is to never download file to your container but directly ingest in memory the data.

{% embed url="<https://youtu.be/Fg4drnvgd20>" %}
Connecting to an external S3
{% endembed %}

## Secret browser

Users can mange their secrets on Vault. There is also a cli console.

<figure><img src="/files/cV7SXm3ywD5xh6lu7Fi9" alt=""><figcaption></figcaption></figure>

Onyxia use only a key value v2 secret engine in Vault. Users can store some secrets there and inject them in their services if configured by the helm chart.

<figure><img src="/files/6thJIozbiRKEWa6MSgbF" alt=""><figcaption></figcaption></figure>

Of course, in our default catalags there are all the necessary tools to connect to Vault.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.onyxia.sh/user-doc/user-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.