From a54ed9cfbcfd6729a267323a59d49288dc3ec685 Mon Sep 17 00:00:00 2001 From: Paulo Cabrita Date: Tue, 14 Nov 2023 16:51:00 +0000 Subject: [PATCH] Docs fixes (#48) --- README.md | 2 -- deployment/README.md | 5 +++-- example/README.md | 8 ++++++++ 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 29ac93d1..bad6fde4 100644 --- a/README.md +++ b/README.md @@ -54,8 +54,6 @@ The extension has the following dependencies: | `org.eclipse.edc:data-plane-core` | Main features of the data plane | | `org.eclipse.edc:data-plane-selector-client` | Offers several implementations for the data plane selector | | `org.eclipse.edc:data-plane-selector-core` | Main features of the data plane selector | -| `org.eclipse.edc:ids` | Support IDS | -| `de.fraunhofer.iais.eis.ids.infomodel:java` | IDS Information Model for Java | ### Configurations It is required to configure an `Access key` and a `Secret Access Key` from the IONOS S3 storage service. diff --git a/deployment/README.md b/deployment/README.md index 98118c12..2aaa79cf 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -24,6 +24,7 @@ To deploy the EDC Ionos S3 connector to external kubernetes cluster on IONOS clo These are the services that are deployed: - [Vault](https://www.vaultproject.io/) - [EDC-Ionos-S3](https://github.com/Digital-Ecosystems/edc-ionos-s3) +- [PostgreSQL](https://www.postgresql.org/) *** @@ -36,7 +37,7 @@ Set environment variables - To create the IONOS token please take a look at the following [documentation](/ionos_token.md); - If you are deploying multiple EDC Connectors on the same Kubernetes cluster, make sure **TF_VAR_namespace** and **TF_VAR_vaultname** parameters are unique for each Connector. - The *TF_VAR_ionos_token*, *TF_VAR_s3_access_key* and *TF_VAR_s3_secret_key* parameters must be connected to the same IONOS DCD user and account. -- The IONOS_S3 connector automatically creates S3 access keys for each file transfer. The limit in DCD is usually 5, some make sure there are less than 5 keys in before initiating a file transfer. +- The IONOS_S3 connector automatically creates S3 access keys for each file transfer. The limit in DCD is usually 5, so make sure there are less than 5 keys before initiating a file transfer. - **WARNING**: For **TF_VAR_persistence_type** if you choose **None** the data will be lost if the container pods are restarted. ```sh @@ -53,7 +54,7 @@ export TF_VAR_ionos_token='' # IONOS Cloud token, for further information: https # Required only if persistence_type is PostgreSQLaaS export TF_VAR_datacenter_name="Digital Ecosystems" export TF_VAR_datacenter_location="de/txl" -export TF_VAR_kubernetes_cluster_name="federated-catalog" +export TF_VAR_kubernetes_cluster_name="dataspace" export TF_VAR_kubernetes_node_pool_name="pool2" export TF_VAR_private_lan_name="k8s-lan" export TF_VAR_pg_database="edcionos" diff --git a/example/README.md b/example/README.md index 60f40e5c..be68185b 100644 --- a/example/README.md +++ b/example/README.md @@ -9,6 +9,14 @@ This folder contains several examples of the IONOS S3 Extension usage. Example of a file transfer between 1 connector using Azure Storage and another connector using IONOS S3. +### `file-transfer-multiple-instances` + +Example of a file transfer between 2 deployed connectors, using terraform script and the IONOS Cloud. + +### `file-transfer-persistence` + +Example of a file transfer between 2 connectors with both of them having IONOS S3 extension and PostgreSQL database to persist the EDC's internal data. + ### `file-transfer-pull` Example of a file transfer between 1 standard connector and another one using the IONOS S3 extension.