Aller au contenu principal

Livrable OCCTET D4.1

Installation de référence

Le livrable OCCTET D4.1 fait fonctionner la boîte à outils open source comme un service cloud conteneurisé, validé sur le portefeuille de la Fondation Eclipse, sur des produits de PME et sur des projets open source populaires. Utilisez l'instance hébergée ou reproduisez l'installation à partir de son matériel de déploiement public.

Sur cette page

La boîte à outils OCCTET, prête à l'emploi

Le livrable D4.1 fait des outils de la boîte à outils OCCTET une installation de référence : un service cloud conteneurisé, hébergé dans l’UE par la Fondation Eclipse, que les PME et les projets open source utilisent sans rien installer.

Tous les composants sont open source et l’ensemble du matériel de déploiement est public : toute organisation peut donc aussi reproduire l’installation sur sa propre infrastructure et garder son code source en interne.

Validée sur des charges réelles

L’installation a été testée à l’échelle d’une fondation open source, sur des produits de PME et sur des projets open source largement utilisés.

Voir les résultats

Au cœur de l'installation de référence

Quatre services s’exécutent sur un cluster Kubernetes managé dans l’UE. ORT Server et le Curator vérifient les vulnérabilités auprès de deux sources de données ouvertes : OSV et VulnerableCode, qui fait partie de la plateforme fédérée de métadonnées logicielles du projet.

ORT Server

Analyse les dépôts avec un pipeline de tâches, propose une interface web, une API REST et une CLI, et génère des SBOM SPDX et CycloneDX.

OCCTET Curator

Importe, cure et évalue les SBOM. Ses services assistés par l’IA utilisent un modèle de langage local, si bien qu’aucune donnée ne quitte l’installation.

VulnerableCode

Une base de données ouverte de vulnérabilités qui agrège les avis de sécurité de nombreuses sources et les fournit par Package URL.

Keycloak

L’authentification unique partagée par ORT Server et le Curator, avec le thème OCCTET.

Principes de conception

  • Un point d’entrée unique : un seul répartiteur de charge sert tous les noms d’hôte en HTTPS.
  • Un namespace par service : chaque service a sa propre base de données et son propre cycle de vie.
  • Helm partout : chaque composant est installé et mis à jour comme sa propre release Helm.
  • Identité partagée : un seul compte ouvre ORT Server et le Curator.

Utilisez l'instance hébergée

Les organisations qui ne souhaitent pas gérer l’installation peuvent utiliser l’instance OCCTET. Après une demande d’accès, les utilisateurs se connectent une fois avec une adresse e-mail ou un compte GitHub, et le même compte ouvre ORT Server et l’OCCTET Curator.

Chaque compte peut consulter les résultats des organisations open source publiques d’ORT Server : Eclipse projects, Eclipse Research Labs, Renowned FOSS projects et FOSS Validation. Chaque PME travaille dans sa propre organisation, visible de ses seuls membres. L’API d’ORT Server, sa CLI et des jetons pour les pipelines CI couvrent l’usage automatisé.

Prêt à essayer ?

Le guide de démarrage explique ce qu’il faut préparer et comment demander un accès.

Bien démarrer

Installez-la vous-même

Tout le matériel de déploiement est public, dans le groupe GitLab de la Fondation Eclipse occtet-eu/reference-installation, sous licences open source. Un seul dépôt, occtet-helm-chart, installe toute la plateforme, avec une release Helm par composant.

  1. Préparer un cluster Kubernetes

    Un cluster Kubernetes managé avec du stockage en mode bloc, un répartiteur de charge et quatre noms d’hôte DNS. La documentation donne le dimensionnement de l’instance de référence.

  2. Installer le contrôleur d'ingress et les certificats

    Le point d’entrée termine le TLS pour chaque service, avec des certificats Let’s Encrypt.

  3. Installer l'authentification unique

    Keycloak, avec le thème OCCTET et le realm partagé par les outils.

  4. Installer les outils

    ORT Server, l’OCCTET Curator et VulnerableCode, chacun dans son propre namespace.

  5. Publier et vérifier

    Publiez les services via le point d’entrée, connectez-vous et lancez une première analyse.

Dépôts par composant Le matériel de déploiement d’OCCTET, sur le GitLab de la Fondation Eclipse, et les projets amont sur lesquels il s’appuie.
ComposantDéploiement OCCTETProjet amont
ORT Serverocctet-ort-server-helm-chartDocumentation · Charts Helm
Configuration d’ORT Serverocctet-ort-server-configExemple de configuration
OCCTET Curatorocctet-curator-helm-chartGuide d’utilisation · Chart Helm
VulnerableCodeocctet-vulnerablecode-helm-chartDocumentation
Authentification uniqueocctet-keycloak · occtet-keycloak-themeDocumentation de Keycloak · Charts Helm
Campagnes sur un portefeuilleocctet-eclipse-projectsAPI d’ORT Server
Statistiques et tableaux de bordocctet-stats–

Développement en local

Toute la plateforme fonctionne aussi sur un poste de travail, sur un cluster minikube local. Utilisez-la pour essayer l’installation avant de la reproduire sur un cluster, ou pour tester une modification d’un chart, de ses valeurs ou d’un script de secrets avant qu’elle soit fusionnée et déployée par la CI. Elle utilise les mêmes charts, valeurs et scripts de secrets que la production ; seules quelques surcharges de développement diffèrent.

  1. Cloner les dépôts côte à côte

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

  2. Installer la plateforme

    make dev-up, dans occtet-helm-chart, crée le cluster et installe les secrets et toutes les releases, puis affiche la ligne à ajouter à /etc/hosts.

    Sous Linux, augmentez d’abord les limites inotify du poste de travail (fs.inotify.max_user_instances=1024) : le nœud minikube les partage.

  3. Faire confiance à l'autorité de certification locale

    make dev-ca-install l’importe dans Chrome, Chromium et Firefox. Elle ne peut signer que des noms sous occtet.local.

  4. Se connecter

    make dev-accounts affiche les mots de passe des comptes de développement. Ouvrez ensuite https://ort-server.occtet.local et https://curator.occtet.local.

Ce qui diffère de l'instance de référence
Instance de référenceInstallation locale
ClusterKubernetes managéminikube avec le pilote Docker : 8 CPU, 12 Go de mémoire, 60 Go de disque
Noms d’hôte*.occtet.eu, enregistrements DNS publics*.occtet.local, dans /etc/hosts
CertificatsLet’s EncryptUne autorité de certification auto-signée, limitée à occtet.local
RessourcesDimensionnement de productionDemandes de ressources réduites ; pas de modèle d’IA local pour le Curator ; moins de workers VulnerableCode
Authentification uniqueRealm configuré par un administrateurRealm de développement importé au démarrage, avec un compte administrateur
Dépôts des chartsÉpinglés comme sous-modules GitClones locaux : une modification est testée avant d’être commitée

Au-delà du projet

Le projet se termine le 31 octobre 2026. La Fondation Eclipse continue d’héberger la plateforme jusqu’au début de 2027.

Le logiciel ne dépend pas de cette instance. ORT Server est développé au sein d’Eclipse Apoapsis, un projet de la Fondation Eclipse, et l’OCCTET Curator et VulnerableCode sont des projets open source sur GitHub. Chacun peut les utiliser, y contribuer, les forker et reproduire l’installation. Le livrable fournit aussi une estimation des coûts d’infrastructure sur un an et un plan de préparation opérationnelle pour un service pleinement opérationnel.

Lire le livrable complet

Le D4.1 est un démonstrateur public du lot de travail 4, piloté par Double Open. Sa documentation est rédigée en Markdown et maintenue avec le matériel de déploiement, sous licence CC BY 4.0.

Retour en haut