Skip to main content

OCCTET deliverable D4.1

Reference Installation

OCCTET deliverable D4.1 runs the open source toolkit as a containerised cloud service, validated on the Eclipse Foundation portfolio, on SME products and on popular open source projects. Use the hosted instance or reproduce the installation from its public deployment material.

On this page

The OCCTET toolkit, ready to use

Deliverable D4.1 turns the tools of the OCCTET toolkit into a reference installation: a containerised cloud service, hosted in the EU by the Eclipse Foundation, that SMEs and open source projects use without installing anything.

Every component is open source and all the deployment material is public, so any organisation can also reproduce the installation on its own infrastructure and keep its source code in-house.

Validated on real workloads

The installation was tested at the scale of an open source foundation, on SME products and on widely used open source projects.

See the results

Inside the reference installation

Four services run on a managed Kubernetes cluster in the EU. ORT Server and the Curator check vulnerabilities against two open data sources: OSV and VulnerableCode, part of the federated software metadata platform of the project.

ORT Server

Analyses repositories with a pipeline of jobs, offers a web UI, a REST API and a CLI, and generates SPDX and CycloneDX SBOMs.

OCCTET Curator

Imports, curates and assesses SBOMs. Its AI-assisted services use a local language model, so no data leaves the installation.

VulnerableCode

An open vulnerability database that aggregates advisories from many sources and serves them by Package URL.

Keycloak

Single sign-on shared by ORT Server and the Curator, with the OCCTET theme.

Design principles

  • One entry point: a single load balancer serves every host name over HTTPS.
  • One namespace per service: each service has its own database and lifecycle.
  • Helm everywhere: every component is installed and upgraded as its own Helm release.
  • Shared identity: one account opens ORT Server and the Curator.

Use the hosted instance

Organisations that do not want to run the installation can use the OCCTET instance. After an access request, users sign in once with an e-mail address or a GitHub account, and the same account opens ORT Server and the OCCTET Curator.

Every account can read the results of the public open source organisations of ORT Server: Eclipse projects, Eclipse Research Labs, Renowned FOSS projects and FOSS Validation. Each SME works in its own organisation, which only its members can see. The ORT Server API, CLI and tokens for CI pipelines cover automated use.

Ready to try?

The getting started guide explains what to prepare and how to request access.

Get started

Install it yourself

All the deployment material is public, in the Eclipse Foundation GitLab group occtet-eu/reference-installation, under open source licences. One repository, occtet-helm-chart, installs the whole platform, one Helm release per component.

  1. Prepare a Kubernetes cluster

    A managed Kubernetes cluster with block storage, a load balancer and four DNS host names. The documentation gives the sizing of the reference instance.

  2. Install the ingress controller and the certificates

    The entry point terminates TLS for every service, with certificates from Let’s Encrypt.

  3. Install single sign-on

    Keycloak, with the OCCTET theme and the realm shared by the tools.

  4. Install the tools

    ORT Server, the OCCTET Curator and VulnerableCode, each in its own namespace.

  5. Publish and verify

    Publish the services through the entry point, sign in and run a first analysis.

Repositories by component The OCCTET deployment material, on the Eclipse Foundation GitLab, and the upstream projects it builds on.

Local development

The whole platform also runs on a workstation, on a local minikube cluster. Use it to try the installation before reproducing it on a cluster, or to test a change of a chart, of its values or of a secret script before it is merged and deployed by the CI. It uses the same charts, values and secret scripts as production; only a few development overrides differ.

  1. Clone the repositories side by side

    occtet-helm-chart, occtet-keycloak, occtet-ort-server-helm-chart, occtet-curator-helm-chart and occtet-vulnerablecode-helm-chart.

  2. Install the platform

    make dev-up, in occtet-helm-chart, creates the cluster and installs the secrets and every release, then prints the line to add to /etc/hosts.

    On Linux, raise the inotify limits of the workstation first (fs.inotify.max_user_instances=1024): the minikube node shares them.

  3. Trust the local certificate authority

    make dev-ca-install imports it into Chrome, Chromium and Firefox. It can only sign names under occtet.local.

  4. Sign in

    make dev-accounts prints the passwords of the development accounts. Then open https://ort-server.occtet.local and https://curator.occtet.local.

What differs from the reference instance
Reference instanceLocal installation
ClusterManaged Kubernetesminikube with the Docker driver: 8 CPUs, 12 GB of memory, 60 GB of disk
Host names*.occtet.eu, public DNS records*.occtet.local, in /etc/hosts
CertificatesLet’s EncryptA self-signed certificate authority, limited to occtet.local
ResourcesProduction sizingSmaller requests; no local AI model for the Curator; fewer VulnerableCode workers
Single sign-onRealm configured by an administratorDevelopment realm imported at start-up, with an administrator account
Chart repositoriesPinned as Git submodulesLocal clones: a change is tested before it is committed

Beyond the project

The project ends on 31 October 2026. The Eclipse Foundation continues to host the platform until early 2027.

The software does not depend on this instance. ORT Server is developed in Eclipse Apoapsis, an Eclipse Foundation project, and the OCCTET Curator and VulnerableCode are open source projects on GitHub. Anyone can use them, contribute to them, fork them and reproduce the installation. The deliverable also gives a one-year infrastructure cost estimate and an operational readiness plan for a fully operational service.

Read the full deliverable

D4.1 is a public demonstrator of Work Package 4, led by Double Open. Its documentation is written in Markdown and maintained with the deployment material, under the CC BY 4.0 licence.

Back to the top