Skip to content

Commit

Permalink
Merge pull request #932 from Think-iT-Labs/931-cleanup-daps
Browse files Browse the repository at this point in the history
refactor: cleanup DAPS references
  • Loading branch information
ndr-brt authored Dec 14, 2023
2 parents 79dfafd + 124160c commit 2498215
Show file tree
Hide file tree
Showing 49 changed files with 53 additions and 1,314 deletions.
4 changes: 2 additions & 2 deletions DEPENDENCIES
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ maven/mavencentral/com.azure/azure-core/1.43.0, MIT AND Apache-2.0, approved, #1
maven/mavencentral/com.azure/azure-core/1.44.1, MIT, approved, clearlydefined
maven/mavencentral/com.azure/azure-core/1.45.1, MIT AND Apache-2.0, approved, #11845
maven/mavencentral/com.azure/azure-identity/1.10.1, MIT AND Apache-2.0, approved, #10086
maven/mavencentral/com.azure/azure-identity/1.11.1, , restricted, clearlydefined
maven/mavencentral/com.azure/azure-identity/1.11.1, MIT, approved, clearlydefined
maven/mavencentral/com.azure/azure-json/1.1.0, MIT AND Apache-2.0, approved, #10547
maven/mavencentral/com.azure/azure-security-keyvault-secrets/4.7.0, MIT, approved, #10868
maven/mavencentral/com.azure/azure-security-keyvault-secrets/4.7.3, MIT, approved, #10868
Expand Down Expand Up @@ -244,7 +244,7 @@ maven/mavencentral/org.bouncycastle/bcutil-jdk18on/1.77, MIT, approved, #11596
maven/mavencentral/org.ccil.cowan.tagsoup/tagsoup/1.2.1, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.checkerframework/checker-qual/3.12.0, MIT, approved, clearlydefined
maven/mavencentral/org.checkerframework/checker-qual/3.31.0, MIT, approved, clearlydefined
maven/mavencentral/org.checkerframework/checker-qual/3.41.0, , restricted, clearlydefined
maven/mavencentral/org.checkerframework/checker-qual/3.41.0, MIT, approved, #12032
maven/mavencentral/org.codehaus.woodstox/stax2-api/4.2.1, BSD-2-Clause, approved, #2670
maven/mavencentral/org.eclipse.edc/api-core/0.4.1, Apache-2.0, approved, technology.edc
maven/mavencentral/org.eclipse.edc/api-observability/0.4.1, Apache-2.0, approved, technology.edc
Expand Down
62 changes: 26 additions & 36 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Tractus-X EDC

The Tractus-X EDC repository creates runnable applications out of EDC extensions from
the [Eclipse DataSpace Connector](https://github.com/eclipse-edc/Connector) repository.
The Tractus-X EDC repository creates runnable applications out of EDC extensions from the
[EDC Connector](https://github.com/eclipse-edc/Connector) platform.

When running a EDC connector from the Tractus-X EDC repository there are three setups to choose from. They only vary by
using different extensions for
When running an EDC connector from the Tractus-X EDC repository there are three different setups to choose from. They
only vary by using different extensions for

- Resolving of Connector-Identities
- Persistence of the Control-Plane-State
Expand All @@ -15,43 +15,33 @@ using different extensions for
The three supported setups are.

- Setup 1: Pure in Memory **Not intended for production use!**
- [Control Plane](../edc-controlplane/edc-runtime-memory/README.md)
- [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps)
- In Memory Persistence done by using no extension
- In Memory Keyvault with seedable secrets.
- [Data Plane](../edc-dataplane/edc-dataplane-azure-vault/README.md)
- [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault)
- Setup 2: PostgreSQL & Azure Vault
- [Control Plane](../edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md)
- [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps)
- [PostgreSQL Persistence Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/store/sql)
- [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault)
- [Data Plane](../edc-dataplane/edc-dataplane-azure-vault/README.md)
- [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault)
- Setup 3: PostgreSQL & HashiCorp Vault
- [Control Plane](../edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md)
- [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps)
- [PostgreSQL Persistence Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/store/sql)
- [HashiCorp Vault Extension](../edc-extensions/hashicorp-vault/README.md)
- [Data Plane](../edc-dataplane/edc-dataplane-hashicorp-vault/README.md)
- [HashiCorp Vault Extension](../edc-extensions/hashicorp-vault/README.md)
- In Memory persistence
- In Memory KeyVault with seedable secrets.
- Planes:
- [Control Plane](../edc-controlplane/edc-runtime-memory/README.md)
- [Data Plane](../edc-dataplane/edc-dataplane-base/README.md)
- Setup 2: PostgreSQL & HashiCorp Vault
- PostgreSQL persistence
- HashiCorp Vault
- Planes:
- [Control Plane](../edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md)
- [Data Plane](../edc-dataplane/edc-dataplane-hashicorp-vault/README.md)
- Setup 3: PostgreSQL & Azure Vault
- PostgreSQL persistence
- Azure Key Vault
- Planes:
- [Control Plane](../edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md)
- [Data Plane](../edc-dataplane/edc-dataplane-azure-vault/README.md)

## Recommended Documentation

### This Repository

- [Update EDC Version from 0.0.x - 0.1.x](migration/Version_0.0.x_0.1.x.md)
- [MXD: Minimum viable tractusX Dataspace](https://github.com/eclipse-tractusx/tutorial-resources/tree/main/mxd)
- [Migration guides](migration)
- [Development](development/README.md)
- [Application: Control Plane](../edc-controlplane)
- [Application: Data Plane](../edc-dataplane)
- [Extension: Business Partner Numbers](../edc-extensions/business-partner-validation/README.md)
- [Example: Local TXDC Setup](samples/Local%20TXDC%20Setup.md)
- [Example: Data Transfer](samples/Transfer%20Data.md)

### Eclipse Dataspace Connector

- [EDC Domain Model](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/architecture/domain-model.md)
- [EDC Open API Spec](https://github.com/eclipse-edc/Connector/blob/main/resources/openapi/openapi.yaml)
- [HTTP Receiver Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/http-receiver)
- [Extension: Business Partner Numbers validation](../edc-extensions/bpn-validation/README.md)
- [Eclipse Dataspace Components](https://eclipse-edc.github.io/docs/#/)

## NOTICE

Expand Down
10 changes: 10 additions & 0 deletions docs/development/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Development Documentation

- [Coding principles](coding-principles.md)
- [Decision Records](decision-records)
- [Release](Release.md)

## Deep Dives
- [Data Plane Http OAuth2](data-plane-http-oauth2.md)
- [EDR Api Overview](edr-api-overview.md)

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ associated to it in the configured datasource for future querying.
Since `tractusx-edc` [v0.5.1](https://github.com/eclipse-tractusx/tractusx-edc/releases/tag/0.5.1) the cached EDRs also come with a state machine that will manage the lifecycle of an EDR
on the consumer side. That means that it will auto-renew it is nearing its expiration date by
firing another transfer process request with the same parameters as the original one. Once renewed, the old EDR
will transition to the `EXPIRED` state, and it will be removed from the database and the vault according to the [configuration](../../../core/edr-core/README.md).
will transition to the `EXPIRED` state, and it will be removed from the database and the vault according to the [configuration](../../core/edr-core/README.md).

### EDR Management | Fetch cached EDRs

Expand Down Expand Up @@ -219,7 +219,7 @@ curl --request GET \
#### Consumer data-plane (proxy)

The Consumer data-plane proxy is an extension available in `tractusx-edc` that will use the EDR store to simplify
the data request on consumer side. The documentation is available [here](../../../edc-extensions/dataplane-proxy/edc-dataplane-proxy-consumer-api/README.md).
the data request on consumer side. The documentation is available [here](../../edc-extensions/dataplane-proxy/edc-dataplane-proxy-consumer-api/README.md).

The only API is:

Expand All @@ -228,7 +228,7 @@ The only API is:
| `<PROXY_URL>/aas/request` | POST | [OpenApi](https://app.swaggerhub.com/apis/eclipse-tractusx-bot/tractusx-edc/0.5.1#/Data%20Plane%20Proxy%20API/requestAsset) |

which fetches the data according to the input body. The body should contain the `assetId` plus `providerId` or the `transferProcessId`,
which identifies the EDR to use for fetching data and an `endpointUrl` which is the [provider gateway](../../../edc-extensions/dataplane-proxy/edc-dataplane-proxy-provider-api/README.md)
which identifies the EDR to use for fetching data and an `endpointUrl` which is the [provider gateway](../../edc-extensions/dataplane-proxy/edc-dataplane-proxy-provider-api/README.md)
on which the data is available.

Example:
Expand Down
Binary file removed docs/development/run-config.png
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/kit/Adoption View/00_adoption-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The main difference between the EDC and the previous connectors of the [IDSA][id

The architecture of the EDC combines various services that are necessary for the above principles:

- An interface to the Identity Provider service, currently [IDSA][idsa-url]'s [Dynamic Attribute Provisioning System][daps-url]. This central service provides the identity and the corresponding authentication of the participants in the data exchange. (There is no authorization at this point). Decentralized solutions will also be supported in the future.
- An interface to the Identity Provider service, currently [IDSA][idsa-url]'s [Identity And Trust Protocol][iatp-url]. This central service provides the identity and the corresponding authentication of the participants in the data exchange. (There is no authorization at this point). Decentralized solutions will also be supported in the future.
- The provision of possible offers (contract offering) which, on the one hand, stipulates the data offered and the associated terms of use (policies) in corresponding contracts.
- An interface for manual selection of data and associated contract offers.
- The actual data transfer via the data plane extension
Expand All @@ -40,7 +40,7 @@ The architecture of the EDC combines various services that are necessary for the
[edc-url]: https://github.com/eclipse-edc/Connector
[gaiax-url]: https://www.data-infrastructure.eu/GAIAX/Navigation/EN/Home/home.html
[idsa-url]: https://internationaldataspaces.org/
[daps-url]: https://www.dataspaces.fraunhofer.de/en/software/identity_provider.html
[iatp-url]: https://github.com/eclipse-tractusx/ssi-docu

## NOTICE

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,6 @@ edc.hostname=localhost
edc.api.auth.key=password
# OAuth / DAPS related configuration
edc.oauth.token.url=https://daps.example.net
edc.oauth.certificate.alias=key-to-daps-certificate-in-keyvault
edc.oauth.private.key.alias=key-to-private-key-in-keyvault
edc.oauth.client.id=daps-oauth-client-id
# HashiCorp vault related configuration
edc.vault.hashicorp.url=http://vault
edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999
Expand Down
15 changes: 0 additions & 15 deletions docs/samples/README.md

This file was deleted.

Loading

0 comments on commit 2498215

Please sign in to comment.