Skip to content

Commit

Permalink
Docs fixes (Digital-Ecosystems#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
paulocabrita-ionos authored Nov 14, 2023
1 parent c6e3274 commit a54ed9c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 3 additions & 2 deletions deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

***

Expand All @@ -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
Expand All @@ -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"
Expand Down
8 changes: 8 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit a54ed9c

Please sign in to comment.