A virtual research environment for running and managing life science analyses, brought to you by ELIXIR On-Cloud. Users log in through a configurable OpenID Connect provider (LS Login for the ELIXIR On-Cloud deployment), find compute services in a Cloud Registry, run tasks on GA4GH Task Execution Service (TES) and workflows on GA4GH Workflow Execution Service (WES) instances, and follow their runs. Deploy Krini with its container image for your own registry, login provider and services; see the operator guide for the deployment, the settings and the login.
Read the documentation: the user guide, the operator guide for the deployment, configuration and upgrades, and development for the local setup, checks, tests and releases.
| Deployment | Operated by | Notes |
|---|---|---|
| https://krini.rahtiapp.fi/ | ELIXIR On-Cloud | Hosted on CSC Rahti |
Running Krini yourself? Open a pull request that adds your deployment to the
table in README.md.
Write the settings to a file outside the repository, e.g.
~/krini/settings.env (see Configuration; plain
KEY=value lines without quotes, as Docker doesn't strip them), and start
the image of a release; it reads all settings when the
container starts:
docker run --rm -p 3000:3000 --read-only --tmpfs /tmp \
--env-file ~/krini/settings.env docker.io/elixircloud/krini:<version>On Kubernetes or OpenShift, write the login providers to
login-providers.json, a JSON array with Krini's OpenID Connect client
at each provider (more fields in the Helm chart docs):
[{"id": "example", "issuer": "https://login.example.org/oidc",
"clientId": "my-client-id", "clientSecret": "my-client-secret"}]Then install the Helm chart (from deployment/, packaged
and attached to each release as krini-<version>.tgz, which
deploys that release's image), with the login providers in a Secret of
your own and the settings in a values file (see Helm
chart for all steps and values, and how to verify the
chart):
kubectl create secret generic krini-login-providers -n <namespace> \
--from-file=login-providers=login-providers.json
gh release download v<version> --repo elixir-cloud-aai/krini \
--pattern 'krini-<version>.tgz*'
helm install krini krini-<version>.tgz -n <namespace> \
--set hostName=krini.example.org \
--set config.cloudRegistryUrl=https://registry.example.org \
--set loginProviders.existingSecret=krini-login-providersOn OpenShift, add --set krini.ingress.enabled=false, so that the chart
creates a Route with TLS instead of an Ingress.
The operator guide describes the image tags, how to verify an image and check a deployment, and what the login provider, the Cloud Registry and the TES and WES services need (client registration, CORS).
If you use Krini, please cite it with the metadata in
CITATION.cff: on GitHub, "Cite this repository" in the
sidebar of the repository formats it as APA or BibTeX.
Contributions are welcome! See the organisation's contributing
guide, mind our code of conduct, and see
Development in the documentation for the setup, checks,
tests and releases of this repository; the sources of the documentation are
in docs/.
Use the issue tracker to request features or report bugs. For anything else, write to cloud-service@elixir-europe.org.
Krini is released under the Apache License 2.0; third-party
material that it contains or builds on is listed in NOTICE.