Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

InseeFrLab/legacy-onyxia-entrypoint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

⚠️ This is a legacy repo, please head over to https://github.com/InseeFrLab/onyxia-web

πŸ”¬ A data science oriented container launcher πŸ”¬

Our instance of Onyxia @ INSEE - Onyxia Web - Onyxia UI - Onyxia K8s API

πŸ—£ v1 (of onyxia-web) have been released with a breaking change. Please checkout the migration guide

Onyxia is a web app that aims at being the glue between multiple open source backend technologies to provide a state of art working environnement for data scientists.
Onyxia is developed by the French National institute of statistics and economic studies (INSEE).

Core feature set:

Launching a container

Launch.RStudio.mp4

S3 File explorer

Demo.file.upload.mp4

Vault secret manager

For injecting secret environment variables in the containers.

explorer_states.mov

Table of content

Screenshots

scree_myservices image screen_launcher my_secrets

Deploy onyxia on your infrastructure today πŸš€

The simplest way to install Onyxia is to use Helm.

helm repo add inseefrlab https://inseefrlab.github.io/helm-charts
helm install onyxia inseefrlab/onyxia --set ingress.enabled=true --set ingress.hosts[0].host=datalab.yourdomain.com

Browse to http://datalab.yourdomain.com and enjoy :)

Note that this is only a bare installation of Onyxia with some major limitations (no authentication, deployed services won't be accessible ...). Read below for more configuration options.

Installation & configuration

See Installation

Modules

Onyxia is split into several modules :

Module Description Status
Onyxia WEB Web UI (React) βœ…
Onyxia API Kubernetes API (Java / Spring-boot) βœ…
Onyxia-UI Design system and React UI toolkit βœ…
Onyxia CLI Command line application (Go) πŸ”Ά

Services catalogs

Onyxia relies on catalogs to provide users with a selection of services they can install in one click.
You can either create your own repositories or use the default ones :

Repository Purpose Status
Helm charts datascience Datascience catalog using Helm (for Kubernetes) format βœ…

Docker images for services

InseeFRLab maintains various Docker images that extends standard images so that they work nicely inside the datalab.
You can browse them here : Repositories using docker-image tag on InseeFRLab

Cloudshell

Onyxia integrates a cloudshell that is based on a WebSSH docker image.
The docker image used is codenamed Shelly and is available here : Shelly

Miscellaneous

Repository Purpose Status
Helm charts Collection of Helm charts including Onyxia's Helm chart βœ…
Simple default backend A simple loading webpage that gets displayed for services that are not yet ready βœ…

Infrastructure scripts

The cloud-scripts repository is a collection of scripts we used at some point at Insee. They are provided as is with minimal to no documentation and support. They are, currently at least, used as memo and not production grade code.
The repository is available here : cloud-scripts

Media

Energy Data Hack

OpenLAB - Download slides

Article d'acteurs publics

Les Entrepreuneurs d'intΓ©rΓͺt gΓ©nΓ©ral - DΓ©couvrir le programme

Roadmap πŸ›£

The Onyxia project is actively developed. We are constantly working on new functionalities to meet our users needs at Insee. Do not hesitate to get in touch with us to ask questions or share your ideas!

Recently released 🎁

  • New services: Argo CD, Argo Workflow, Pinot
  • Step by step Onyxia deployment guide
  • Customizable UI themes
  • Onyxia installation documentation
  • Project documentation (CONTRIBUTING.md...)

Coming soon β˜„οΈ

  • Projects and collaboration
  • Transform File Explorer into Data Explorer

WIP πŸ—

  • Onyxia installation documentation
  • Project documentation (CONTRIBUTING.md...)
  • New UI for FileExplorer

Ideas πŸ’‘

  • End user documentation

  • Extend the catalog of data science services

  • Data governance (data & metadata management, data cataloging, data lineage, data quality management)

  • What data management features does a user need in Onyxia (objects explorer, PV manager...)?

  • Billing, monitoring & housekeeping of services

  • Onyxia deployment automation

  • Instance administration (users & groups...)