Aller au contenu principal

A02 - Control Plane API

GroupeTechnologieStatutServicePhase de la feuille de routeContrats
A - Gouvernance, identité et sécuritéFastAPIà développercontrol-plane1common

Retour à l'index - English

Rôle et responsabilités​

API source de vérité unique de tous les registres, politiques, quotas et pistes d'audit.

Position dans l'architecture et interactions​

Chaque écran du portail, commande CLI et appel SDK passe par elle. Elle détient registres, politiques, quotas et audit ; runtimes et gateways y lisent leur configuration et y renvoient usage et audit.

Modèle de données​

Tables (schéma eai, chaque table tenant porte tenant_id uuid NOT NULL avec une politique RLS sur current_setting('app.tenant_id', true)::uuid) : eai.schema_migrations, eai.audit_events.

Endpoints API​

  • GET /healthz
  • GET /readyz
  • GET /v1/meta
  • GET /v1/catalog/bricks
  • GET /v1/catalog/bricks/{id}
  • GET /v1/roadmap
  • GET /v1/contracts
  • POST /v1/contracts/{name}/validate
  • POST /v1/manifests/apply
  • GET /v1/manifests/{kind}/{name}
POST /v1/contracts/{name}/validate HTTP/1.1
Host: <control-plane-host>
X-API-Key: eai_xxx_secret
Accept-Language: fr
Content-Type: application/json

{"apiVersion": "enterprise-ai.io/v1", "kind": "Agent", "metadata": {"name": "invoice-assistant", "tenant": "acme", "version": "1.2.0", "owner": "team-finance@acme.example"}, "spec": {"description": "Checks supplier invoices against purchase orders.", "risk_level": "high", "runtime": {"engine": "langgraph"}, "models": [{"model_id": "claude-sonnet-eu", "role": "primary"}], "permissions": {"data_classification_max": "confidential"}, "autonomy": {"level": "supervised"}}}
{"contract": "agent-manifest", "valid": true, "errors": []}

Les erreurs utilisent l'enveloppe commune {"error": {"code", "message", "message_i18n", "details", "request_id"}} ; les listes sont paginées avec limit et cursor.

Utilisation des SDK​

Python (enterprise_ai):

from enterprise_ai import EnterpriseAI

client = EnterpriseAI(base_url="<control-plane-url>", api_key="eai_xxx_secret")
items = client.system.meta()

TypeScript (@enterprise-ai/sdk):

import { EnterpriseAI } from "@enterprise-ai/sdk";

const eai = new EnterpriseAI({ baseUrl: "<control-plane-url>", apiKey: process.env.EAI_API_KEY });
const items = await eai.meta.get();

Java (enterprise-ai-java):

EnterpriseAIClient client = EnterpriseAIClient.builder()
    .baseUrl("<control-plane-url>")
    .apiKey(System.getenv("EAI_API_KEY"))
    .build();
var items = client.meta().get();

Go (enterprise-ai-go):

client, _ := eai.NewClient(eai.WithBaseURL("<control-plane-url>"), eai.WithAPIKey(os.Getenv("EAI_API_KEY")))
items, err := client.Meta.Get(ctx)

Configuration​

  • Environnement : EAI_DATABASE_URL, EAI_OTEL_EXPORTER_OTLP_ENDPOINT.
  • Valeurs Helm : control-plane.enabled, control-plane.replicas, control-plane.resources.

Contrôles de sécurité​

  • Authentification par JWT OIDC, clé API tenant avec scopes, ou mTLS SPIFFE ; le tenant est résolu depuis l'identifiant, jamais depuis le corps.
  • Autorisation par décisions OpenFGA et OPA ; chaque mutation et décision écrit une ligne eai.audit_events chaînée par hash.
  • Les secrets ne sont jamais renvoyés par l'API ; TLS partout ; les politiques réseau Cilium restreignent qui peut joindre le service.

Observabilité​

  • Métriques : eai_control_plane_api_requests_total, eai_control_plane_api_errors_total, eai_control_plane_api_latency_seconds (Prometheus).
  • Traces : spans OpenTelemetry eai.meta.* avec propagation W3C traceparent, spans IA envoyés à Opik.
  • Actions d'audit : manifest.apply, audit.export, policy.evaluate.

Aspects FinOps​

Le coût d'exploitation est imputé par tenant et projet via les labels des Usage Events et les requêtes de ressources Kubernetes ; pas de coût direct par appel.

Modes de défaillance et résilience​

  • Réplicas sans état derrière l'API Gateway, PostgreSQL HA pour l'état ; la sonde GET /readyz retire les pods défaillants.
  • Système externe indisponible : échec fermé pour les décisions de sécurité, code d'erreur explicite, aucun contournement silencieux.

Adoption autonome (client d'un client)​

Un client d'un client peut adopter cette brique seule avec le sous-client SDK Python client.system (TS eai.meta, Java client.system.meta(), Go client.Meta). Déploiement minimal : Control Plane API + PostgreSQL + Keycloak (ou clés API), le Control Plane charge tous les domaines de services/control-plane/src/eai/domains ; les composants optionnels du chart se coupent dans deploy/helm/enterprise-ai/values.yaml (vllm.enabled, qdrant.enabled, nats.enabled, workers.enabled).

Tests d'acceptation​

  1. Un tenant ne peut ni lire ni modifier les ressources d'un autre tenant (test RLS).
  2. Chaque mutation produit un événement d'audit vérifiable par GET /v1/audit/verify.
  3. Les erreurs sont renvoyées en anglais et en français selon Accept-Language.