Chore: Update dataspace connector examples

* chore: update dsc docker slim deployment * chore: add dsc k8s deployment guide * chore: mount external config folder * docs[readme]: Update notes about IDS identity certificate * build: update docker-compose, use volume for conf and ghcr for dsc image * feat: add config (DSC v4), key- and truststore as external ressources * docs[readme]: Update full deployment about IDS identity certificate and config * docs: update readme * chore: remove full-zip since git clone is explained in readme * docs: update README.md * docs[readme]: Patch full deployment links to DSC v4 Wiki instead to DSC v5 Docu docs[readme]: Align slim deployment readme to full deployment readme * docs[readme]: Update readmes * docs[readme]: Update readmes * docs[readme]: Update readmes * docs[readme]: Update readmes Co-authored-by: Brian-Frederik Jahnke <brian-frederik.jahnke@isst.fraunhofer.de> Co-authored-by: Tim Berthold <75306992+tmberthold@users.noreply.github.com> Co-authored-by: Julia Pampus <72392527+juliapampus@users.noreply.github.com>
brianjahnke · Jun 18, 2021 · 381440b · 381440b
1 parent c1fff81
commit 381440b
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 63 deletions.
diff --git a/dataspace-connector/full/README.md b/dataspace-connector/full/README.md
@@ -6,63 +6,76 @@
   <br>
 </h1>
 
-This is the **Full Setup** of the Dataspace Connector.
-In this setup the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) is started with all its extensions:
-* [Configmanager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager), 
-* [GUI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI), 
-* [Camel](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance),
-* Postgres DB
-
-This allows us to use the full potential of all functionalities on the Dataspace Connector and the services around it. 
-
-
-## Deployment Example
-This Dataspace Connector Deployment example consists of the following components:
-- Postgres 12
-- Dataspace Connector 4.3.1
-- Configuration Manager 7.0.0
-- Configuration Manager GUI 7.0.0
+This is a deployment example for the **Full Setup** of the Dataspace Connector. It allows the exploration of all holistic functionalities of the Dataspace Connector and its services. 
 
 ---
 
 **Note**: 
-This example can not be used with the current IDS Metadata Broker off-the-shelf, because a valid IDS identity certificate is not included. 
+This example can not be used with the current IDS Metadata Broker off-the-shelf as a valid IDS identity certificate is not included. 
+To get and install your own IDS identity certificate, please read the provided [Download DSC v4 Wiki](https://international-data-spaces-association.github.io/DataspaceConnector/assets/files/dsc_v4_wiki.zip).
+Other than described there, in this example, the `config.json` and the `KeyStore` are located at  `/dataspaceconnector/config/`.
 
 ---
 
+In this setup, the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) is started with the listed extensions:
+* [Configuration Manager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager), 
+* [Configuration Manager GUI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI), 
+* Postgres DB
+
+In addition, the following Dataspace Connector extensions will be included in future deployment example setups:
+* [Camel](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance)
+
+
+### Components & Versions
+This deployment example builds on the following compatible versions:
+
+| Component | Version |
+|:----------|:--------|
+| Dataspace Connector | 4.3.1 |
+| Configuration Manager | 7.0.0 |
+| Configuration Manager GUI | 7.0.0 |
+| Postgres | 12 |
+
 ### Prerequisites
-  - git
-  - docker
-  - docker-compose
+  - Git
+  - Docker
+  - Docker Compose
 
-### Install Steps
-  - Clone the Dataspace Connector repo 
+### Installation Steps
+1. Clone the IDS Deployment Examples GitHub repository.
     ```
     git clone https://github.com/International-Data-Spaces-Association/IDS-Deployment-Examples.git
     ```
-  - Open a new terminal inside the cloned repo and navigate to this folder
+2. Open a new terminal inside the created directory and navigate to this folder.
     ```
-    cd IDS-Deployment-Examples/dataspace-connector/slim/docker
+    cd IDS-Deployment-Examples/dataspace-connector/full
     ```
-    **Note:** A GitHub account is required in order to be able to pull the different images.
-  - After all systems have been booted, they can be reached at the following addresses in the standard case:
-    - Configuration Manager GUI 7.0.0: http://localhost:8082/dashboard
-    - Configuration Manager 7.0.0 Swagger-UI: http://localhost:8081/swagger-ui/index.html?url=/v3/api-docs/
-    - Dataspace Connector Swagger-UI: https://localhost:8080/admin/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config
-
-Individual settings can be made via the .env-files of the respective components.
-
-### Uninstall
-  - Run 'docker-compose down' in this folder
+3. Use a Docker Compose command to load the different Docker images of the components. **Note:** A GitHub account and Docker login is required for being able to pull all images of this deployment example.
+    ```
+    docker-compose pull
+    ```
+4. Use a Docker Compose command to start all of the component's Docker containers.
+   ```
+   docker-compose up
+   ```    
+5. After all systems have been booted, they can be reached (by default) at the following URLs:
+   - Dataspace Connector Swagger UI: https://localhost:8080/api/docs
+   - Configuration Manager Swagger UI: http://localhost:8081/swagger-ui/index.html?url=/v3/api-docs/
+   - Configuration Manager GUI: http://localhost:8082/dashboard
+
+Individual settings can be provided via the `.env-files` of the respective components and via the `config.json` in `/dataspaceconnector/config/` ([Download DSC v4 Wiki](https://international-data-spaces-association.github.io/DataspaceConnector/assets/files/dsc_v4_wiki.zip) for detailed information).
+
+### Stop & Uninstall
+  - Run `docker-compose down` inside the same folder you started the Dataspace Connector
   - Remove the repository folder
 
 ## Developers
 
-This is an ongoing project of the developers of the Dataspace Connector Repositories:
-* [DataspaceConnector](https://github.com/International-Data-Spaces-Association/DataspaceConnector)
-* [DSC-Camel-Instance](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance)
-* [IDS-ConfigurationManager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager)
-* [IDS-ConfigurationManager-UI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI)
+This is an ongoing project of the developers of the Dataspace Connector repositories:
+* [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector)
+* [DSC Camel Instance](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance)
+* [IDS Configuration Manager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager)
+* [IDS Configuration Manager GUI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI)
 
 
 

diff --git a/dataspace-connector/full/dsc-full.zip b/dataspace-connector/full/dsc-full.zip
diff --git a/dataspace-connector/slim/docker/README.md b/dataspace-connector/slim/docker/README.md
@@ -6,17 +6,11 @@
   <br>
 </h1>
 
-This is the **Slim Setup** of the Dataspace Connector.
+This is a deployment example for the **Slim Setup** of the Dataspace Connector.
 In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and Postgres as database are started, without Camel, Configmanager and UI.
 
 This allows us to only using the core functionalities of the Dataspace Connector without having an graphical user interface and the logic of the ConfigurationManager to install IDS Apps and configure Camel routes.
 
-## Deployment Example
-This Dataspace Connector Deployment example consists of the following components:
-- Postgres 13
-- Dataspace Connector latest
-
-
 ---
 
 **Note**: 
@@ -26,32 +20,43 @@ Other than described there, the ```config.json``` and the ```KeyStore``` are loc
 
 ---
 
+### Components & Versions
+This Dataspace Connector Deployment example consists of the following components:
+
+| Component | Version |
+|:----------|:--------|
+| Dataspace Connector | latest |
+| Postgres | 13 |
 
 ### Prerequisites
-  - git
-  - docker
-  - docker-compose
+  - Git
+  - Docker
+  - Docker Compose
 
-### Install Steps
-  - Clone the Dataspace Connector repo 
+### Installation Steps
+1. Clone the IDS Deployment Examples GitHub repository.
     ```
     git clone https://github.com/International-Data-Spaces-Association/IDS-Deployment-Examples.git
     ```
-  - Open a new terminal inside the cloned repo and navigate to this folder
+2. Open a new terminal inside the created direcotry and navigate to this folder.
     ```
     cd IDS-Deployment-Examples/dataspace-connector/slim/docker
+    ``` 
+3. Use a Docker Compose command to load the different Docker images of the components.
     ```
-  - Start the Dataspace Connector via docker compose
+    docker-compose pull
+    ```  
+4. Use a Docker Compose command to start all of the component's Docker containers.  
     ```
     docker-compose up
-    ```
-  - Go to `https://localhost:8080/api/docs`
-  - Login with username `admin` and password `password`
-  - The [Communication Guide](https://international-data-spaces-association.github.io/DataspaceConnector/CommunicationGuide) explains how to use the APIs of the connector
+    ``` 
+5. Go to `https://localhost:8080/api/docs`
+6. Login with username `admin` and password `password`
+7. The [Communication Guide](https://international-data-spaces-association.github.io/DataspaceConnector/CommunicationGuide) explains how to use the APIs of the connector
 
-Individual settings can be made via the ```.env-files``` of the respective components and via ```config.json``` in ```/dataspaceconnector/config/``` (see [Configuration](https://international-data-spaces-association.github.io/DataspaceConnector/Deployment/Configuration)).
+Individual settings can be provided via the `.env-files` of the respective components and via the `config.json` in `/dataspaceconnector/config/` (see [here](https://international-data-spaces-association.github.io/DataspaceConnector/Deployment/Configuration)).
 
-### Uninstall
+### Stop & Uninstall
   - Run `docker-compose down` inside the same folder you started the Dataspace Connector
   - Remove the repository folder
   

diff --git a/templates/README.md b/templates/README.md
@@ -4,17 +4,16 @@ Deployment Example Name
 
 General Description
 
-## Deployment Example
+### Components & Versions
 
-Description about the example
 
 ### Prerequisites
 
 
-### Install Steps
+### Installation Steps
 
 
-### Uninstall
+### Stop & Uninstall
 
 
 ## Developers