Skip to content

Commit

Permalink
Refactor readme
Browse files Browse the repository at this point in the history
  • Loading branch information
olevitt committed Dec 5, 2023
1 parent 634b852 commit 62846bb
Showing 1 changed file with 6 additions and 20 deletions.
26 changes: 6 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ This is the server part of the Onyxia datalab, it interacts with your container
Deployable services are listed and configured inside catalogs.
Default catalogs are from InseeFrlab : [Interactive services](https://inseefrlab.github.io/helm-charts-interactive-services), [Databases](https://inseefrlab.github.io/helm-charts-databases), [Automation](https://inseefrlab.github.io/helm-charts-automation) but more catalogs (including your own) can be added.

## Quick start
## Quick start

Onyxia-api is usually run as a component within the Onyxia stack. See [Onyxia helm chart](https://github.com/InseeFrLab/onyxia/tree/main/helm-chart) and [docs.onyxia.sh](https://docs.onyxia.sh/) for installation instruction.

## Running Onyxia-API standalone

### Using docker

Expand All @@ -20,22 +24,9 @@ cd onyxia-api
mvn spring-boot:run
```

### Using Helm

The [Onyxia helm chart](https://github.com/InseeFrLab/helm-charts/tree/master/charts/onyxia) is available at [inseefrlab](https://github.com/InseeFrLab/helm-charts)

```
helm repo add inseefrlab https://inseefrlab.github.io/helm-charts
helm install inseefrlab/onyxia
```

This will install both the [API](https://github.com/InseeFrLab/onyxia-api) and the [Web](https://github.com/inseefrlab/onyxia-web) components.

## Usage

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-Web](https://github.com/inseefrlab/onyxia-web).
If you use it in other ways, we would love to hear from you :)
Once Onyxia is started, browse to http://localhost:8080 to get started with the OpenAPI documentation.

## Contributing

Expand Down Expand Up @@ -109,11 +100,6 @@ Onyxia-API makes system calls to `helm` using the [helm-wrapper](helm-wrapper) J
`helm` is bundled in the `Onyxia API` Docker image, see current version bundled here : [Dockerfile](onyxia-api/Dockerfile).
If running `Onyxia API` locally you need to have `helm` available in the `PATH`.

## Onyxia API compatibility matrix with Kubernetes

In addition of using `helm`, Onyxia API interacts with the Kubernetes cluster thanks to the [fabric8.io Kubernetes client for Java](https://github.com/fabric8io/kubernetes-client).
See [here](https://github.com/fabric8io/kubernetes-client#kubernetes-compatibility-matrix) for the compatibility matrix and [here](helm-wrapper/pom.xml#L19) for the current version used by Onyxia.

## Onyxia Helm format extension

Onyxia's catalogs are based on the Helm chart format and especially the `values.schema.json` (see https://helm.sh/docs/topics/charts/#schema-files) file used to populate the personalization tabs displayed by the UI.
Expand Down

0 comments on commit 62846bb

Please sign in to comment.