Skip to content

Commit

Permalink
Merge pull request #130 from FraunhoferIOSB/feature/dockerhub
Browse files Browse the repository at this point in the history
[Feature] add docker hub deployment
  • Loading branch information
fvolz authored Aug 9, 2024
2 parents f0a5070 + 3de5731 commit a651e35
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 8 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/gradle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,22 @@ jobs:
uses: gradle/gradle-build-action@ac2d340dc04d9e1113182899e983b5400c17cda1
with:
arguments: clean build

- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Login to DockerHub
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_TOKEN }}

- name: Build and push docker image - extension
uses: docker/build-push-action@v6
with:
platforms: linux/amd64,linux/arm64
context: "./example"
push: true
tags: |
fraunhoferiosb/edc-extension4aas:latest
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,8 @@ In this section, dependencies from EDC and third-party are listed. (Implementati
Features in development:

- Graphical interface to simplify providing and requesting AAS (
see: https://github.com/FraunhoferIOSB/EDC-Extension-for-AAS-Dashboard) ✓
see: https://github.com/FraunhoferIOSB/EDC-Extension-for-AAS-Dashboard) (✓ update required)
- AAS data-plane for EDC ✓
- Docker Hub container deployment
- Docker Hub container deployment ✓
- Support for AAS Registries: Share all AAS from AAS Registry
- Client DPP Viewer: Directly view the requested DPP (AAS format)
21 changes: 21 additions & 0 deletions data-plane-aas/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Data-plane for AAS

Out-of-the-box, the EDC data-plane supports HTTPS calls for the AAS API, but some use-cases (processing AAS data / calling operations) require setting up endpoint services or configuration of the transfer-requests. For consumers, this is not an easy task and hinders the cross-company usage of AAS.
Additionally, many AAS services use self-signed company certificates, which are not supported by the EDC data-plane.

This custom data-plane adds a configuration option to accept self-signed company certificates, enabling data sharing for those AAS services.

Default values:

`edc.dataplane.aas.acceptAllSelfSignedCertificates=False`

`edc.dataplane.aas.acceptOwnSelfSignedCertificates=True`
## Roadmap

Features in development:

- Support AAS operations
- Use external AAS properties as input variables in AAS operation
- Store external AAS submodel-properties in own AAS submodel-properties
- AAS Events

15 changes: 9 additions & 6 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,24 @@ java "-Dedc.fs.config=./example/configurations/provider.properties" -jar ./examp

### Alternative: docker & docker-compose

After building the extension as seen above, a docker image can be built with
You can directly start a provider and consumer EDC with the AAS extension built-in with docker-compose:

1. Go to example folder: `cd example`
2. `docker compose up` (Alternatively: `docker-compose up`)


If you prefer to built a docker image, it can be built after building the extension as seen above:

1. Go to example folder: `cd example`
2. Create docker image: `docker build -t edc-extension4aas:latest .`
3. Run
with `docker run -i -v $PWD/configurations:/configurations/ -v $PWD/resources:/resources/ -e EDC_FS_CONFIG=/configurations/docker-provider.properties edc-extension4aas:latest`

This docker image can be run individually or **inside a docker-compose file**:

```sh
docker compose up (Alternatively: docker-compose up)
```
This docker image can be run individually or **from the docker-compose file**.

When using Docker, the pre-defined variables in the Postman Collection for the provider should be changed from "localhost" to "provider", i.e. http://provider:8282/dsp instead of http://localhost:8282/dsp

Additionally, new AASX or JSON model files should be placed in the resources folder beforehand, since the docker container does not have access to your local files.
## Configuration

The EDC and its extensions can be configured with a `.properties` file. In `example/resources/configurations` there are
Expand Down

0 comments on commit a651e35

Please sign in to comment.