onyxia/publiccode.yml at main · Making-Sense-Info/onyxia · GitHub

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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
publiccodeYmlVersion: "0.2"

name: Onyxia
applicationSuite: Onyxia
url: "https://github.com/InseeFrLab/onyxia"
landingURL: "https://onyxia.sh"
creationDate: "2017-01-01"
releaseDate: "2020-03-22"
logo: https://inseefrlab.github.io/onyxia/icon.svg

platforms:
  - web

categories:
  - it-development
  - workflow-management

usedBy:
  - Insee
  - Statistics Norway
  - Mercator Ocean
  - Expertise France
  - Genes

fundedBy:
  - name: Insee
    url: https://lannuaire.service-public.fr/gouvernement/278bf3d4-9cf3-4a36-a317-ec56fb0abc52

roadmap: "https://docs.onyxia.sh/roadmap"

developmentStatus: development

softwareType: "standalone/web"

intendedAudience:
  scope:
    - science-and-technology

description:
  en:
    genericName: Onyxia
    shortDescription: >
          Web app to simplify data science environment setup on Kubernetes

    longDescription: >
          Onyxia is a powerful open-source web application designed to streamline the creation of state-of-the-art data science environments. Its core mission is to make advanced cloud-based resources accessible—even to users without prior expertise in cloud technologies.
          What distinguishes Onyxia is its intuitive, user-friendly interface that abstracts away the complexity of cloud infrastructure. Data scientists can effortlessly configure their preferred tools—such as Jupyter, RStudio, and VSCode—while selecting computational resources (GPU, CPU, RAM), defining environment variables, and setting up persistent storage. With just a few clicks, Onyxia automates the entire deployment process: it launches containerized environments, connects to S3-compatible storage systems, and manages secure credentials through integrations with Vault and OIDC providers.
          Importantly, Onyxia is not the environment where data analysis itself takes place. Instead, it acts as the gateway—a preparatory layer—where data professionals define and launch their technical stack before entering their actual workspace (e.g., Jupyter or RStudio). This separation of concerns keeps the experience streamlined and focused.
          A built-in file explorer facilitates the handling of large datasets, while Onyxia’s transparent architecture fosters learning and trust. Every action performed through the interface is logged in a terminal-style viewer, showing users the exact commands being executed (e.g., Helm, Kubernetes, Docker). This visibility not only promotes reproducibility and confidence but also serves as an educational bridge for those curious about the infrastructure powering their work.
          For deployment, Onyxia is installed by system administrators on a Kubernetes cluster—either on-premises or through a cloud provider—and exposed via a web UI for the data science team. Once in place, it dramatically reduces onboarding friction, encourages best practices, and empowers teams to focus entirely on data-driven innovation.

    documentation: "https://docs.onyxia.sh"

    features:
       - UI for launching docker images (Helm charts)
       - Users can define the amount of RAM, CPU and GPU they would like to allocate to their containers
       - Define environnement variables to be made available in the containers.
       - Save and restore your service service configurations.
       - View datasets
    screenshots:
       - https://github.com/InseeFrLab/onyxia/assets/6702424/f07e91e7-d597-4eca-b9df-2ddf457afb19
       - https://github.com/InseeFrLab/onyxia/assets/6702424/77eb58e1-6f5d-43c4-8447-90f5c5aad5d2
       - https://github.com/InseeFrLab/onyxia/assets/6702424/ae32ccab-e295-4079-b06e-c4035e67d7a4
       - https://github.com/InseeFrLab/onyxia/assets/6702424/e8ec58ad-7dc8-410d-9cd3-5f0996e8f8f8
       - https://github.com/InseeFrLab/onyxia/assets/6702424/b5256014-2af3-4e39-9ecb-f3f120aa920a
    videos:
       - https://youtu.be/FvpNfVrxBFM?si=goZHdAkOegWjrXBw

  fr:
    genericName: Onyxia
    shortDescription: >
          Application web pour simplifier la mise en place d'un environnement de data science sur Kubernetes

    longDescription: >
          Onyxia est une application web open-source conçue pour simplifier la mise en place d’environnements de travail avancés dédiés à la science des données. Sa vocation première est de rendre les ressources cloud accessibles, même aux utilisateurs n’ayant pas de compétences techniques poussées en infrastructure.
          Ce qui distingue Onyxia, c’est son interface intuitive et ergonomique, qui masque toute la complexité des technologies cloud. En quelques clics, les utilisateurs peuvent sélectionner leurs outils de prédilection (Jupyter, RStudio, VSCode, etc.), allouer les ressources nécessaires (GPU, CPU, mémoire vive), configurer des variables d’environnement, et activer un stockage persistant. Onyxia prend ensuite en charge l’ensemble du processus : lancement des conteneurs, connexion à un stockage compatible S3, gestion sécurisée des identifiants via Vault et OIDC.
          Onyxia n’est pas l’endroit où les data scientists effectuent leur analyse, mais plutôt la porte d’entrée de leur environnement technique. Il s’agit d’une étape intermédiaire dans leur workflow, leur permettant de configurer efficacement leur stack de travail avant d’accéder à leurs outils habituels.
          L’explorateur de fichiers intégré facilite la manipulation de grands volumes de données, tandis que l’architecture transparente d’Onyxia en fait également un outil pédagogique. Chaque action réalisée via l’interface est affichée sous forme de commandes dans un terminal simulé. Cette transparence permet aux utilisateurs de comprendre les mécanismes sous-jacents (Kubernetes, Helm, Docker, etc.) et, s’ils le souhaitent, de répliquer les opérations eux-mêmes.
          L’installation d’Onyxia est assurée par les administrateurs système sur un cluster Kubernetes — en local ou chez un fournisseur cloud — avant d’être mise à disposition de l’équipe data via une interface web. Une fois déployé, Onyxia réduit considérablement le temps d’onboarding, encourage les bonnes pratiques et permet aux équipes de se concentrer pleinement sur leurs projets de données.

    documentation: "https://docs.onyxia.sh"

    features:
       - UI de lancement d'images docker (Helm charts)
       - Les utilisateurs peuvent définir la quantité de RAM, de CPU et de GPU qu’ils souhaitent allouer à leurs conteneurs.
       - Définir des variables d’environnement à rendre disponibles dans les conteneurs.
       - Sauvegardez et restaurez vos configurations de services.
       - Visualiser les jeux de données

    screenshots:
       - https://github.com/InseeFrLab/onyxia/assets/6702424/f07e91e7-d597-4eca-b9df-2ddf457afb19
       - https://github.com/InseeFrLab/onyxia/assets/6702424/77eb58e1-6f5d-43c4-8447-90f5c5aad5d2
       - https://github.com/InseeFrLab/onyxia/assets/6702424/ae32ccab-e295-4079-b06e-c4035e67d7a4
       - https://github.com/InseeFrLab/onyxia/assets/6702424/e8ec58ad-7dc8-410d-9cd3-5f0996e8f8f8
       - https://github.com/InseeFrLab/onyxia/assets/6702424/b5256014-2af3-4e39-9ecb-f3f120aa920a
    videos:
       - https://youtu.be/FvpNfVrxBFM?si=goZHdAkOegWjrXBw


legal:
  license: MIT
  mainCopyrightOwner: INSEE
  repoOwner: INSEE

authors:
  distinctAuthorsCount: 0
  distinctOrganizationsCount: 0

maintenance:
  type: "internal"

  contacts:
    - name: Frederic Comte
      email: "frederic.comte@insee.fr"
      affiliation: INSEE
    - name: Joseph Garrone
      email: "joseph.garrone@protonmail.com"
      affiliation: INSEE

metadataFiles:
  readme: README.md
  license: LICENSE
  contributing: CONTRIBUTING.md
  changelog: null
  codeOfConduct: CODE_OF_CONDUCT.md
  governance: GOVERNANCE.md
  funding: null

localisation:
  localisationReady: true
  availableLanguages:
    - de
    - en
    - fi
    - fr
    - it
    - es
    - nl
    - no
    - zh-CN

dependsOn:
  open:
   - name: Kubernetes
   - name: Helm