Gaia-X Lab Registry
Gaia-X Trust Framework
For Gaia-X to ensure a higher and unprecedented level of trust in digital platforms, we need to make trust an easy-to-understand and adopted principle. For this reason, Gaia-X developed a Trust Framework – formerly known as Gaia-X Compliance and Labelling Framework that safeguards data protection, transparency, security, portability, and flexibility for the ecosystem as well as sovereignty and European Control.
The Trust Framework is the set of rules that define the minimum baseline to be part of the Gaia-X Ecosystem. Those rules ensure a common governance and the basic levels of interoperability across individual ecosystems while letting the users in full control of their choices.
In other words, the Gaia-X Ecosystem is the virtual set of participants and service offerings following the requirements from the Gaia-X Trust Framework.
Gaia-X Lab Registry Service
The Gaia-X Lab Registry Service is designed to be used by the Gaia-X Lab Compliance Service. However, an API is exposed for the registry as well, to get the content of the registry as well as verify the validity of signed claims (e.g., Self Descriptions) by checking the provided certificates against Gaia-X endorsed Trust Anchor certificates.
Existing deployments
In addition to the GXDCH instances, the Gaia-X Lab maintains several instances:
| Deployment URL | Usage | Content |
|---|---|---|
v1, v1.x.x |
Production-ready trusted anchors and cert validation. | Latest stable release. Version deployed on the Clearing Houses |
2206-unreleased |
Trusted anchors for 2206-unreleased compliance. | Outdated 2206-unreleased version. Some rules are not applied to certificate (expiration etc.) |
main |
Used for playground activities. | Latest stable (main branch) |
development |
Used for playground activities. | Latest unstable (development branch) |
Images tags
This repo provides several images tags.
| tag | content | example |
|---|---|---|
vX |
latest major version | v1 |
vX.Y |
latest minor version | v1.1 |
vX.Y.Z |
specific version | v1.1.1 |
main |
latest stable | |
development |
latest unstable |
Feature branches are also build and push to the container registry.
https://registry.lab.gaia-x.eu/v2204/docs/ is no longer instantiated. It is the implementation of the outdated Trust Framework 22.04 document.
The Gaia-X Lab Registry is responsible for storing Trust Anchor certificates at any time.
All key pairs used to sign claims must have at least one of the Trust Anchors in their certificate chain to comply with the Gaia-X Trust Framework.
Find a list of endorsed trust anchors here: https://gaia-x.gitlab.io/policy-rules-committee/trust-framework/trust_anchors/
Gaia-X Lab Compliance Service
The Compliance Service will validate the shape and content of Self Descriptions. Required fields and consistency rules are defined in the Trust Framework.
The Compliance Service can validate shapes of self-descriptions and sign valid self-descriptions.
GitLab repository: https://gitlab.com/gaia-x/lab/compliance/gx-compliance
Get Started with Using The API
Get Started With Development
Deployment
A helm chart is provided inside /k8s/gx-registry folder. It deploys the registry application and a mongoDB server used
by the registry
It provides several environment variables for the application:
| Env Variable | Name in values file | Default value | Note |
|---|---|---|---|
| evsslonly | evsslonly | true | Whether the app is deployed on a production environment. Will enable EV SSL-only validation |
| APP_PATH | ingress.hosts[0].paths[0].path | /main | Deployment path of the application |
| BASE_URL | https://<ingress.hosts[0].host>/<ingress.hosts[0].paths[0].path> | URL of the deployed application | |
| BASE_URI | https://<ingress.hosts[0].host>/<ingress.hosts[0].paths[0].path> | URL of the deployed application. Iso to BASE_URL | |
| DB_USERNAME | N/A | mongodb username | |
| DB_PASSWORD | N/A | mongodb password | |
| MONGO_DATABASE | N/A | trust-anchor-registry | |
| MONGO_HOST | mongodb hostname from current deployment | ||
| MONGO_PORT | 27017 |
Usage example:
helm upgrade --install -n "<branch-name>" --create-namespace gx-registry ./k8s/gx-registry --set "nameOverride=<branch-name>,ingress.hosts[0].host=registry.lab.gaia-x.eu,ingress.hosts[0].paths[0].path=/<branch-name>,image.tag=<branch-name>,ingress.hosts[0].paths[0].pathType=Prefix"Deploy v1:
helm upgrade --install -n "v1" --create-namespace gx-registry ./k8s/gx-registry --set "nameOverride=v1,ingress.hosts[0].host=registry.lab.gaia-x.eu,ingress.hosts[0].paths[0].path=/v1,image.tag=v1,ingress.hosts[0].paths[0].pathType=Prefix"The deployment is triggered automatically on development and main branches. Please refer
to Gaia-X Lab Registry Service for available instances.