Skip to content

Commit

Permalink
Updated document
Browse files Browse the repository at this point in the history
  • Loading branch information
adkumar1 committed Jul 11, 2023
1 parent 5f3f17d commit a5045f5
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 36 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
## [Unreleased]
- NA

## [1.3.4] - 2023-07-11

### Changed
- Updated the ARC42 document

## [1.3.3] - 2023-07-06

### Changed
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ This service will help service provider to set up DFT/SDE with EDC and EDC as se
### Software Version

```shell
Application version: 1.3.3
Helm release version: 1.3.3
Application version: 1.3.4
Helm release version: 1.3.4
```

### Container images
Expand Down
4 changes: 2 additions & 2 deletions charts/orchestrator/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ sources:
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 1.3.3
version: 1.3.4

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "1.3.3"
appVersion: "1.3.4"

dependencies:
- condition: postgresql.enabled
Expand Down
2 changes: 1 addition & 1 deletion charts/orchestrator/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# autosetup

![Version: 1.3.3](https://img.shields.io/badge/Version-1.3.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.3.3](https://img.shields.io/badge/AppVersion-1.3.3-informational?style=flat-square)
![Version: 1.3.4](https://img.shields.io/badge/Version-1.3.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.3.4](https://img.shields.io/badge/AppVersion-1.3.4-informational?style=flat-square)

This service will help service provider to set up DFT/SDE with EDC and EDC as service in service provider environment.

Expand Down
37 changes: 7 additions & 30 deletions docs/ARC42.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Onboarding:

Onboard SME/Company in third-party. (what data are necessary to be able to do this without interaction of SME/Company)
Customers will only have access to SDEFrontend, but not any access to managed data space itself

Auto-Setup:

1. deploy EDC
Expand Down Expand Up @@ -91,12 +92,12 @@ Alternatively (or additionally) you can use a table. The title of the table is t
This interface will be provided by the third service provider (T-systems for blueprint), and will be called from a portal once the customer pushes the "get managed SDEservice" button. This a push-interface, where the portal can push the needed information to the third-party service provider
2. **SDEregistration interface:**
The portal will provide this interface to register the SDEwith an SME-individual user credentials
3. **SD-HUB Registration Service:**
This interface has to be provided by the portal. The owner of connectors has to use this interface to create the SD-Document for the connector.
4. **Digital Registry Registration Service:**
This service has to be provided by the digital twin team and will be used by SDE to register the metadata of the provided data
5. **DAPS Registration Service:**
This interface will be implemented by T-Systems. This interface has to provide for the registration of connectors to the DAPS
3. **Manage Tenant Namespace:**
This interface includes Manage SDE, Digital twin Registray and Managed EDC connector.
4. **Connector Registration process:**
Portal provides anAPI to Autosetup process for connector registration
5. **Auto Setup Creation:**
Auto setup create data.core,digitalTwinRegistry type Asset for managed twin registry information

## ![](images/pic5.png)

Expand Down Expand Up @@ -141,22 +142,6 @@ The third-party service provider has to provide the service bill to the customer
### SD-Factory API:
SD-Factory has only one endpoint - POST /selfdescription with the generic request body, which should contain mandatory fields holder and issuer. The response body is dependent on a request.

### DAPS Registration API:
To register a Certificate to the DAPS an authenticated client (known client with an appropriate role, a concrete role can be configured in configuration file) sends POST multipart request to the DAPS registration service endpoint

Media Type: multipart/form-data

POST /api/v1/daps

here are interface definition in java:

public void createClient(
@RequestParam String clientName,
@RequestParam(required = false) String securityProfile,
@RequestParam(required = false) String referringConnector,
@RequestPart("file") MultipartFile file)
parameters securityProfile and referringConnector are optional, for securityProfile the default value is used, if referringConnector is missed than it is not included in DAT

### Auto Setup API:
**The description of API here** Auto Setup API information

Expand Down Expand Up @@ -184,14 +169,6 @@ Swagger API info as below:
- **SD-HUB Registration Service:**
- SD-Hub have only one endpoint - POST /selfdescription with the generic request body, that should contain mandatory fields holder and issuer .

- **DAPS Registration Service:**
- DAPS registration service provides CRUD operations for maintaining a client in DAPS service for an authenticated user (keycloak) with appropriate roles. The operations are:

- creating a client and registering its certificate
- updating client and changing its attributes in DAT
- retrieving client information
- deleting a client

- **Digital Twin Registry Registration Service:**
- See API Documentation of Digital Twin documentation

Expand Down
Binary file modified docs/images/pic0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/pic4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
</parent>
<groupId>org.eclipse.tractusx</groupId>
<artifactId>auto-setup</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
<name>auto-setup</name>
<description>auto-setup</description>
<properties>
Expand Down

0 comments on commit a5045f5

Please sign in to comment.