This is the server part of the Onyxia datalab.
It interacts with your container orchestrator to deploy users services.
Onyxia supports Kubernetes using Helm.
Deployable services are listed and configured inside catalogs.
Default catalogs are from InseeFrlab : Universe datascience and Inseefrlab helm charts but more catalogs can be added.
The opensourcing (and documentation) is still a work in progress, please be patient :)
docker run -p 8080:8080 inseefrlab/onyxia-api
git clone https://github.com/InseeFrLab/onyxia-api.git
cd onyxia-api
mvn spring-boot:run
A helm package is available at inseefrlab
helm repo add inseefrlab https://inseefrlab.github.io/helm-charts
helm install inseefrlab/onyxia
Note that this installs both the API and the UI
Once onyxia is started, browse to http://localhost:8080 to get the OpenAPI documentation.
Onyxia-API is primarly made to work with the webapp Onyxia-UI.
If you use it in other ways, we would love to hear from you :)
Main configuration file is onyxia-api/src/main/resources/application.properties.
Each variable can be overriden using environment variables.
Authentication configuration
| Key | Default | Description |
|---|---|---|
authentication.mode |
none |
Supported modes are : none, openidconnect (must be configured) |
Open id configuration
| Key | Default | Description |
|---|---|---|
keycloak.realm |
See Keycloak configuration | |
keycloak.resource |
See Keycloak configuration | |
keycloak.auth-server-url |
See Keycloak configuration | |
keycloak.ssl-required |
external |
See Keycloak configuration |
keycloak.public-client |
true |
See Keycloak configuration |
keycloak.enable-basic-auth |
true |
See Keycloak configuration |
keycloak.bearer-only |
true |
See Keycloak configuration |
keycloak.disable-trust-manager |
false |
See Keycloak configuration |
Security configuration :
| Key | Default | Description |
|---|---|---|
security.cors.allowed_origins |
To indicate which origins are allowed by CORS |
Regions configuration :
| Key | Default | Description |
|---|---|---|
regions |
see onyxia-api/src/main/resources/regions.json | List of regions. |
Catalogs configuration :
| Key | Default | Description |
|---|---|---|
catalogs |
see onyxia-api/src/main/resources/catalogs.json | List of catalogs. Each catalog can be of type universe or helm. Mixing is supported. If there is no region of corresponding type then the catalog will be ignored |
catalogs.refresh.ms |
300000 (5 minutes) |
The rate at which the catalogs should be refreshed. <= 0 means no refreshs after initial loading |
HTTP configuration
| Key | Default | Description |
|---|---|---|
http.proxyHost |
Proxy hostname (e.g : proxy.example.com) | |
http.proxyPort |
80 for HTTP, 443 for HTTPS |
Proxy port |
http.noProxy |
Hosts that should not use the proxy (e.g : `localhost | |
http.proxyUsername |
Username if the proxy requires authentication | |
http.proxyPassword |
Password if the proxy requires authentication |
Other configurations
| Key | Default | Description |
|---|---|---|
springdoc.swagger-ui.path |
/ |
Open API (swagger) UI path |
springdoc.swagger-ui.oauth.clientId |
`` | clientid use by swagger to authenticate the user, in general the same which is use by onyxia-ui is ok. |
Onyxia extends the official Universe format (see https://github.com/mesosphere/universe) to enhance it.
This format extension is fully interoperable with the official Universe format meaning Onyxia works with any Universe and Universes using Onyxia's extension should be usable in other apps.
The specification is defined here.
An example of a Universe using this extension is available here.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent