Skip to content

Commit

Permalink
Merge pull request #34 from FIWARE/components
Browse files Browse the repository at this point in the history
Proposal for linking components and their diagram part
  • Loading branch information
pulledtim authored Dec 10, 2024
2 parents 37cebf2 + 59d8396 commit dc95e56
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,20 +85,21 @@ Connector.

Precisely, the connector bundles the following components:

| Component | Role | Link |
|-----------------|-----------------|------|
| VCVerifier | Verifier | https://github.com/FIWARE/VCVerifier |
| credentials-config-service | Credentials Config provider for the verifier | https://github.com/FIWARE/credentials-config-service |
| Keycloak | Issuer of VCs | https://www.keycloak.org |
| Scorpio | Context Broker | https://github.com/ScorpioBroker/ScorpioBroker |
| trusted-issuers-list | Acts as Trusted Issuers List by providing an [EBSI Trusted Issuers Registry](https://api-pilot.ebsi.eu/docs/apis/trusted-issuers-registry) API | https://github.com/FIWARE/trusted-issuers-list |
| APISIX | APISIX as API-Gateway with a sidecar OPA as PEP | https://apisix.apache.org/ / https://www.openpolicyagent.org/ |
| odrl-pap | PAP allowing to configure ODRL policies to be used by the OPA | https://github.com/wistefan/odrl-pap |
| tmforum-api | [TMForum APIs](https://www.tmforum.org/oda/open-apis/) for contract management | https://github.com/FIWARE/tmforum-api |
| contract-management | Notification listener for contract management events out of TMForum | https://github.com/FIWARE/contract-management |
| MySQL | Database | https://www.mysql.com |
| PostgreSQL | Database | https://www.postgresql.org |
| PostGIS | PostgreSQL Database with PostGIS extensions | https://postgis.net/ |
| Component | Role | Diagram field | Link |
|-----------------|-----------------|---|------|
| VCVerifier | Validates VCs and exchanges them for tokens |Verifier | https://github.com/FIWARE/VCVerifier |
| credentials-config-service | Holds the information which VCs are required for accessing a service |PRP/PAP (authentication)| https://github.com/FIWARE/credentials-config-service |
| Keycloak | Issuer of VCs on the Consumer side | | https://www.keycloak.org |
| Scorpio | Context Broker | | https://github.com/ScorpioBroker/ScorpioBroker |
| trusted-issuers-list | Acts as Trusted Issuers List by providing an [EBSI Trusted Issuers Registry](https://api-pilot.ebsi.eu/docs/apis/trusted-issuers-registry) API |Local Trusted Issuers List| https://github.com/FIWARE/trusted-issuers-list |
| APISIX | APISIX as API-Gateway with a OPA plugin |PEP| https://apisix.apache.org/ / https://apisix.apache.org/docs/apisix/plugins/opa/ |
| OPA | OpenPolicyAgent as the API Gateway's Sidecar |PDP | https://www.openpolicyagent.org/ |
| odrl-pap | Allowing to configure ODRL policies to be used by the OPA | PRP/PAP (authorization) | https://github.com/wistefan/odrl-pap |
| tmforum-api | Implementation of the [TMForum APIs](https://www.tmforum.org/oda/open-apis/) for handling contracts|Contract Management| https://github.com/FIWARE/tmforum-api |
| contract-management | Notification listener for contract management events out of TMForum |Contract Management | https://github.com/FIWARE/contract-management |
| MySQL | Database | | https://www.mysql.com |
| PostgreSQL | Database | | https://www.postgresql.org |
| PostGIS | PostgreSQL Database with PostGIS extensions | | https://postgis.net/ |

**Note,** that some of the components shown in the diagram above are not implemented yet.

Expand Down

0 comments on commit dc95e56

Please sign in to comment.