Skip to content

Commit d1b75e4

Browse files
committed
fix: publiccode.yml validation errors
Add a GitHub Actions workflow to catch future ones.
1 parent 038993c commit d1b75e4

2 files changed

Lines changed: 67 additions & 59 deletions

File tree

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Validate publiccode.yml
2+
3+
on:
4+
push:
5+
paths:
6+
- "publiccode.yml"
7+
- ".github/workflows/publiccodeyml-check.yml"
8+
pull_request:
9+
paths:
10+
- "publiccode.yml"
11+
- ".github/workflows/publiccodeyml-check.yml"
12+
13+
permissions: {}
14+
15+
jobs:
16+
validate:
17+
runs-on: ubuntu-latest
18+
permissions:
19+
contents: read
20+
name: publiccode.yml validation
21+
steps:
22+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
23+
24+
- uses: italia/publiccode-parser-action@56e1200cba853b1efa73ee871600284d0705ab4d # v1
25+
with:
26+
publiccode: "publiccode.yml"
27+
no-network: true
28+

publiccode.yml

Lines changed: 39 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
publiccodeYmlVersion: "0.2"
2-
1+
publiccodeYmlVersion: "0"
2+
33
name: Onyxia
44
applicationSuite: Onyxia
55
url: "https://github.com/InseeFrLab/onyxia"
66
landingURL: "https://onyxia.sh"
7-
creationDate: "2017-01-01"
87
releaseDate: "2020-03-22"
98
logo: https://inseefrlab.github.io/onyxia/icon.svg
109

@@ -24,9 +23,7 @@ usedBy:
2423

2524
fundedBy:
2625
- name: Insee
27-
url: https://lannuaire.service-public.fr/gouvernement/278bf3d4-9cf3-4a36-a317-ec56fb0abc52
28-
29-
roadmap: "https://docs.onyxia.sh/roadmap"
26+
uri: https://lannuaire.service-public.fr/gouvernement/278bf3d4-9cf3-4a36-a317-ec56fb0abc52
3027

3128
developmentStatus: development
3229

@@ -38,73 +35,65 @@ intendedAudience:
3835

3936
description:
4037
en:
41-
genericName: Onyxia
4238
shortDescription: >
43-
Web app to simplify data science environment setup on Kubernetes
39+
Web app to simplify data science environment setup on Kubernetes
4440
4541
longDescription: >
46-
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.
47-
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.
48-
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.
49-
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.
50-
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.
42+
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.
43+
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.
44+
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.
45+
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.
46+
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.
5147
5248
documentation: "https://docs.onyxia.sh"
5349

5450
features:
55-
- UI for launching docker images (Helm charts)
56-
- Users can define the amount of RAM, CPU and GPU they would like to allocate to their containers
57-
- Define environnement variables to be made available in the containers.
58-
- Save and restore your service service configurations.
59-
- View datasets
51+
- UI for launching docker images (Helm charts)
52+
- Users can define the amount of RAM, CPU and GPU they would like to allocate to their containers
53+
- Define environnement variables to be made available in the containers.
54+
- Save and restore your service service configurations.
55+
- View datasets
6056
screenshots:
61-
- https://github.com/InseeFrLab/onyxia/assets/6702424/f07e91e7-d597-4eca-b9df-2ddf457afb19
62-
- https://github.com/InseeFrLab/onyxia/assets/6702424/77eb58e1-6f5d-43c4-8447-90f5c5aad5d2
63-
- https://github.com/InseeFrLab/onyxia/assets/6702424/ae32ccab-e295-4079-b06e-c4035e67d7a4
64-
- https://github.com/InseeFrLab/onyxia/assets/6702424/e8ec58ad-7dc8-410d-9cd3-5f0996e8f8f8
65-
- https://github.com/InseeFrLab/onyxia/assets/6702424/b5256014-2af3-4e39-9ecb-f3f120aa920a
57+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273940140-f07e91e7-d597-4eca-b9df-2ddf457afb19.png
58+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273939460-77eb58e1-6f5d-43c4-8447-90f5c5aad5d2.png
59+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273939517-ae32ccab-e295-4079-b06e-c4035e67d7a4.png
60+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273939583-e8ec58ad-7dc8-410d-9cd3-5f0996e8f8f8.png
61+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273939654-b5256014-2af3-4e39-9ecb-f3f120aa920a.png
6662
videos:
67-
- https://youtu.be/FvpNfVrxBFM?si=goZHdAkOegWjrXBw
63+
- https://youtu.be/FvpNfVrxBFM?si=goZHdAkOegWjrXBw
6864

6965
fr:
70-
genericName: Onyxia
7166
shortDescription: >
72-
Application web pour simplifier la mise en place d'un environnement de data science sur Kubernetes
67+
Application web pour simplifier la mise en place d'un environnement de data science sur Kubernetes
7368
7469
longDescription: >
75-
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.
76-
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.
77-
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.
78-
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.
79-
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.
70+
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.
71+
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.
72+
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.
73+
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.
74+
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.
8075
8176
documentation: "https://docs.onyxia.sh"
8277

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

9085
screenshots:
91-
- https://github.com/InseeFrLab/onyxia/assets/6702424/f07e91e7-d597-4eca-b9df-2ddf457afb19
92-
- https://github.com/InseeFrLab/onyxia/assets/6702424/77eb58e1-6f5d-43c4-8447-90f5c5aad5d2
93-
- https://github.com/InseeFrLab/onyxia/assets/6702424/ae32ccab-e295-4079-b06e-c4035e67d7a4
94-
- https://github.com/InseeFrLab/onyxia/assets/6702424/e8ec58ad-7dc8-410d-9cd3-5f0996e8f8f8
95-
- https://github.com/InseeFrLab/onyxia/assets/6702424/b5256014-2af3-4e39-9ecb-f3f120aa920a
86+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273940140-f07e91e7-d597-4eca-b9df-2ddf457afb19.png
87+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273939460-77eb58e1-6f5d-43c4-8447-90f5c5aad5d2.png
88+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273939517-ae32ccab-e295-4079-b06e-c4035e67d7a4.png
89+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273939583-e8ec58ad-7dc8-410d-9cd3-5f0996e8f8f8.png
90+
- https://github-production-user-asset-6210df.s3.amazonaws.com/6702424/273939654-b5256014-2af3-4e39-9ecb-f3f120aa920a.png
9691
videos:
97-
- https://youtu.be/FvpNfVrxBFM?si=goZHdAkOegWjrXBw
98-
92+
- https://youtu.be/FvpNfVrxBFM?si=goZHdAkOegWjrXBw
9993

10094
legal:
10195
license: MIT
10296
mainCopyrightOwner: INSEE
103-
repoOwner: INSEE
104-
105-
authors:
106-
distinctAuthorsCount: 0
107-
distinctOrganizationsCount: 0
10897

10998
maintenance:
11099
type: "internal"
@@ -117,15 +106,6 @@ maintenance:
117106
email: "joseph.garrone@protonmail.com"
118107
affiliation: INSEE
119108

120-
metadataFiles:
121-
readme: README.md
122-
license: LICENSE
123-
contributing: CONTRIBUTING.md
124-
changelog: null
125-
codeOfConduct: CODE_OF_CONDUCT.md
126-
governance: GOVERNANCE.md
127-
funding: null
128-
129109
localisation:
130110
localisationReady: true
131111
availableLanguages:
@@ -141,5 +121,5 @@ localisation:
141121

142122
dependsOn:
143123
open:
144-
- name: Kubernetes
145-
- name: Helm
124+
- name: Kubernetes
125+
- name: Helm

0 commit comments

Comments
 (0)