Add initial documentation

.github/workflows/build.yaml

@@ -39,7 +39,7 @@ jobs:
         [ ! -d "edc" ] && git submodule add https://github.com/eclipse-dataspaceconnector/DataSpaceConnector.git edc
         git submodule update --init
         git -C edc fetch --all
-        git -C edc checkout milestone-3
+        git -C edc checkout 045c9a6c1f8dcde78dfcb0480cf49643cdb65401
     -
       name: Set up JDK 11
       uses: actions/[email protected]

.github/workflows/draft-new-release.yaml

@@ -43,7 +43,7 @@ jobs:
           GITHUB_PACKAGE_PASSWORD: ${{ secrets.CXNG_GHCR_PAT }}
       -
         name: Bump version in deployment/helm
-        uses: mikefarah/[email protected].4
+        uses: mikefarah/[email protected].2
         with:
           cmd: |-
             find deployment/helm -name Chart.yaml | xargs -n1 yq -i '.appVersion = "${{ github.event.inputs.version }}" | .version = "${{ github.event.inputs.version }}"'

README.md

@@ -1 +1,44 @@
-Catena-X specific edc apps
+# Catena-X specific edc apps
+
+This project provides pre-built Control-Plane and Data-Plane [docker](https://www.docker.com/) images and [helm](https://helm.sh/) charts of the [Eclipse DataSpaceConnector Project](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector).
+
+## Inventory
+
+The eclipse data space connector is split up into Control-Plane and Data-Plane, whereas the Control-Plane functions as administration layer
+and has responsibility of resource management, contract negotiation and administer data transfer. 
+The Data-Plane does the heavy lifting of transferring and receiving data streams.
+
+Depending on your environment there are different derivatives of the control-plane prepared:
+
+* [edc-controlplane-cosmosdb](edc-controlplane/edc-controlplane-cosmosdb)
+* [edc-controlplane-memory](edc-controlplane/edc-controlplane-memory)
+* [edc-controlplane-postgresql](edc-controlplane/edc-controlplane-postgresql)
+
+Derivatives of the Data-Plane can be found here
+
+* [edc-dataplane](edc-dataplane)
+
+## Prerequisites
+
+#### EDC artifacts
+
+Since the [EDC](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector) does 
+not yet publish artifacts to a maven repository, which this project relies on, it needs 
+to be built upfront to be used:
+
+```shell
+# Init / update git-submodule
+[ ! -d "edc" ] && git submodule add https://github.com/eclipse-dataspaceconnector/DataSpaceConnector.git edc
+git submodule update --init
+git -C edc fetch --all
+git -C edc checkout milestone-3
+
+# build edc 0.0.1-SNAPSHOT artifacts
+cd edc && ./gradlew publishToMavenLocal
+```
+
+## Build
+
+```shell
+./mvnw package -Pwith-docker-image
+```

deployment/helm/edc-controlplane/README.md

@@ -0,0 +1 @@
+# edc-controlplane Helm Chart

deployment/helm/edc-controlplane/templates/configmap.yaml

@@ -11,6 +11,8 @@ data:
     web.http.default.path={{ .Values.edc.endpoints.default.path }}
     web.http.data.port={{ .Values.edc.endpoints.data.port }}
     web.http.data.path={{ .Values.edc.endpoints.data.path }}
+    web.http.validation.port={{ .Values.edc.endpoints.validation.port }}
+    web.http.validation.path={{ .Values.edc.endpoints.validation.path }}
     web.http.control.port={{ .Values.edc.endpoints.control.port }}
     web.http.control.path={{ .Values.edc.endpoints.control.path }}
     web.http.ids.port={{ .Values.edc.endpoints.ids.port }}

deployment/helm/edc-controlplane/templates/deployment.yaml

@@ -49,6 +49,9 @@ spec:
             - name: data
               containerPort: {{ .Values.edc.endpoints.data.port }}
               protocol: TCP
+            - name: validation
+              containerPort: {{ .Values.edc.endpoints.validation.port }}
+              protocol: TCP
             - name: ids
               containerPort: {{ .Values.edc.endpoints.ids.port }}
               protocol: TCP

deployment/helm/edc-controlplane/values.yaml

@@ -95,10 +95,15 @@ edc:
       port: "8181"
       path: /data
       ingress: true
+    # Validation API
+    validation:
+      port: "8182"
+      path: /validation
+      ingress: false
     # Control API
     control:
       port: "9999"
-      path: /api/control
+      path: /api/controlplane/control
       ingress: true
     # IDS endpoints
     ids:

deployment/helm/edc-dataplane/README.md

@@ -0,0 +1 @@
+# edc-dataplane Helm Chart

deployment/helm/edc-dataplane/values.yaml

@@ -89,7 +89,7 @@ edc:
     # Control API
     control:
       port: "9999"
-      path: /api/control
+      path: /api/dataplane/control
       ingress: true
     # Public endpoint for data transfer
     public: