Update documentation (#73)

* fix: documentation of asset creation * fix: documentation of asset definition * fix: documentation of asset definition
Digital-Ecosystems · Mar 12, 2024 · b60a3db · b60a3db
1 parent 912664a
commit b60a3db
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Please refer to the official [site](https://github.com/ionos-cloud/edc-ionos-s3)
 
 ## Based on the following
 
-- [https://github.com/eclipse-dataspaceconnector/DataSpaceConnector](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector) - v0.1.2;
+- [https://github.com/eclipse-dataspaceconnector/DataSpaceConnector](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector) - v0.4.1;
 - [International Data Spaces](https://www.internationaldataspaces.org);
 - [GAIA-X](https://gaia-x.eu) project;
 
@@ -91,8 +91,8 @@ java -Dedc.fs.config=resources/config.properties -jar build/libs/dataspace-conne
 ```
 
 ## Examples
-In order to see working examples go to [edc-ionos-samples](https://github.com/ionos-cloud/edc-ionos-samples).
+In order to see working examples go to [edc-ionos-samples](https://github.com/Digital-Ecosystems/edc-ionos-samples).
 
 ## Deploying to IONOS Kubernetes
-Check the [deployment readme](./deployment/README.md) to see how to deploy the Connector locally or to an external Kubernetes cluster.
+Check the [deployment readme](https://github.com/ionos-cloud/edc-ionos-s3/tree/main/deployment/README.md) to see how to deploy the Connector locally or to an external Kubernetes cluster.
 
diff --git a/assets.md b/assets.md
@@ -0,0 +1,61 @@
+
+# IONOS's Asset Definitions
+
+This document describes how to define the asset at the creation and transfer process stages.
+
+## Asset's Registrations 
+The asset registration aims to specify which file/folder we want to share. We can also use pattern filters, these filters will be used to choose which files/folders to share/exclude.
+
+### Requirements
+
+
+| Parameter        | Description                                                                                                                                                                                                                                                                                                                                                                         | Mandatory |
+|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `storage`        | IONOS S3 endpoint address. Refer to  [docs](https://docs.ionos.com/cloud/managed-services/s3-object-storage/s3-endpoints)  for further information.                                                                                                                                                                                                                                 | yes       |
+| `bucketName`     | IONOS S3 bucket name.   Refer to  [docs](https://docs.ionos.com/cloud/managed-services/s3-object-storage/concepts/buckets) for further information.                                                                                                                                                                                                                                 | yes       |
+| `blobName`       | File name or path to folder                                                                                                                                                                                                                                                                                                                                                         | yes       |
+| `filterIncludes` | `filterIncludes` use regular expression that will be used to select the file name pattern from the asset's blobName that will be copied during the transfer <br/> * do not consider the blobName in the expression, but the path from it. example: blobName = folder1, filterIncludes=file1.csv, the file foloder1/file1.csv will be copied                                         | no        |
+| `filterExcludes` | `filterExcludes` use regular expression that will be used to select the file name pattern from the asset's blobName that will NOT be copied during the transfer <br/> | no        |
+
+Note:  if `filterIncludes` and  `filterExcludes` parameters are satisfied, the files to be copied will be selected using the `filterIncludes` and after that selected list, the files that have the pattern defined in the `filterExcludes` will be ignored.
+
+
+## Example
+
+```json
+"dataAddress":{
+  "type": "IonosS3", //from EDC
+  "storage": "s3-eu-central-1.ionoscloud.com",
+  "bucketName": "mybucket",
+  "blobName": "folder1/",
+  "filterIncludes": "file1.csv",
+  "filterExcludes": "file2.csv",
+  "keyName": "mykey" //from EDC
+}
+```
+
+## Assets transfer
+The transfer of assets aims to transfer the files/folders from one connector to another connector.
+
+### Requirements
+
+
+| Parameter    | Description                                                                                                                                         | Mandatory |
+|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `storage`    | IONOS S3 endpoint address. Refer to  [docs](https://docs.ionos.com/cloud/managed-services/s3-object-storage/s3-endpoints)  for further information. | yes       |
+| `bucketName` | IONOS S3 bucket name.   Refer to  [docs](https://docs.ionos.com/cloud/managed-services/s3-object-storage/concepts/buckets) for further information. | yes       |
+| `path`       | Path of destination where the file/folder will be placed. </br>  *if the path not filled, the file will be placed in the root of the bucket.        | no        |
+
+se o caminho não estiver preenchido, o arquivo será colocado na raiz do bucket.
+if the path not filled, the file will be placed in the root of the bucket.
+## Example
+
+```json
+"dataDestination":{
+  "type": "IonosS3", //from EDC
+  "storage": "s3-eu-central-1.ionoscloud.com",
+  "bucketName": "mybucket",
+  "path": "folder2/",
+  "keyName": "mykey" //from EDC
+}
+```