From 3a0152dcfc43be551745fcddd2de579c67076ff4 Mon Sep 17 00:00:00 2001 From: Simon Date: Tue, 13 Aug 2024 11:42:25 +0200 Subject: [PATCH] Remove mentions to remote storages in docs (#5097) Co-authored-by: Simon Dumas --- .../docs/delta/api/assets/files/create-put.sh | 2 +- .../delta/api/assets/files/created-put.json | 4 +- .../delta/api/assets/files/link-post.json | 13 ---- .../docs/delta/api/assets/files/link-post.sh | 16 ---- .../docs/delta/api/assets/files/link-put.json | 11 --- .../docs/delta/api/assets/files/link-put.sh | 14 ---- .../delta/api/assets/files/linked-post.json | 39 ---------- .../delta/api/assets/files/linked-put.json | 38 ---------- .../docs/delta/api/assets/files/listed.json | 8 +- .../docs/delta/api/assets/files/sse.json | 4 +- .../delta/api/assets/storages/create-put.json | 4 +- .../delta/api/assets/storages/create-put.sh | 6 +- .../api/assets/storages/created-put.json | 11 ++- .../delta/api/assets/storages/deprecate.sh | 2 +- .../delta/api/assets/storages/deprecated.json | 11 ++- .../delta/api/assets/storages/fetch-source.sh | 2 +- .../api/assets/storages/fetch-statistics.sh | 2 +- .../docs/delta/api/assets/storages/fetch.sh | 2 +- .../api/assets/storages/fetched-source.json | 4 +- .../delta/api/assets/storages/fetched.json | 14 ++-- .../delta/api/assets/storages/listed.json | 11 ++- .../docs/delta/api/assets/storages/sse.json | 8 +- .../delta/api/assets/storages/undeprecate.sh | 2 +- .../api/assets/storages/undeprecated.json | 10 +-- .../delta/api/assets/storages/update.json | 4 +- .../docs/delta/api/assets/storages/update.sh | 6 +- .../delta/api/assets/storages/updated.json | 11 ++- .../docs/delta/api/assets/version.json | 3 +- .../main/paradox/docs/delta/api/files-api.md | 70 ----------------- .../paradox/docs/delta/api/storages-api.md | 40 ---------- .../running-nexus/configuration/index.md | 59 +++++++-------- docs/src/main/paradox/docs/releases/index.md | 2 +- .../docs/releases/v1.10-release-notes.md | 5 -- .../docs/releases/v1.6-release-notes.md | 2 +- .../docs/releases/v1.8-to-v1.9-migration.md | 2 +- .../docs/releases/v1.9-release-notes.md | 2 - docs/src/main/paradox/schemas/storage.json | 75 ------------------- 37 files changed, 92 insertions(+), 427 deletions(-) delete mode 100644 docs/src/main/paradox/docs/delta/api/assets/files/link-post.json delete mode 100644 docs/src/main/paradox/docs/delta/api/assets/files/link-post.sh delete mode 100644 docs/src/main/paradox/docs/delta/api/assets/files/link-put.json delete mode 100644 docs/src/main/paradox/docs/delta/api/assets/files/link-put.sh delete mode 100644 docs/src/main/paradox/docs/delta/api/assets/files/linked-post.json delete mode 100644 docs/src/main/paradox/docs/delta/api/assets/files/linked-put.json diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/create-put.sh b/docs/src/main/paradox/docs/delta/api/assets/files/create-put.sh index a276c6d3ba..50a7c8ab15 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/files/create-put.sh +++ b/docs/src/main/paradox/docs/delta/api/assets/files/create-put.sh @@ -1,4 +1,4 @@ curl -X PUT \ -F "file=@/path/to/myfile.pdf;type=application/pdf" \ -H 'x-nxs-file-metadata: {"name": "My File"}' \ - "http://localhost:8080/v1/files/myorg/myproject/myfile?storage=remote&tag=mytag" \ No newline at end of file + "http://localhost:8080/v1/files/myorg/myproject/myfile?storage=s3&tag=mytag" \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/created-put.json b/docs/src/main/paradox/docs/delta/api/assets/files/created-put.json index 888127df3b..78c262bc45 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/files/created-put.json +++ b/docs/src/main/paradox/docs/delta/api/assets/files/created-put.json @@ -25,8 +25,8 @@ "_rev": 1, "_self": "http://localhost:8080/v1/files/myorg/myproject/myfile", "_storage": { - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", - "@type": "RemoteDiskStorage", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", + "@type": "S3Storage", "_rev": 1 }, "_updatedAt": "2021-05-12T07:30:54.576Z", diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/link-post.json b/docs/src/main/paradox/docs/delta/api/assets/files/link-post.json deleted file mode 100644 index 194a0dbbdc..0000000000 --- a/docs/src/main/paradox/docs/delta/api/assets/files/link-post.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "path": "relative/path/to/myfile.png", - "filename": "myfile.png", - "mediaType": "image/png", - "metadata": { - "name": "My File", - "description": "a description of the file", - "keywords": { - "key1": "value1", - "key2": "value2" - } - } -} \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/link-post.sh b/docs/src/main/paradox/docs/delta/api/assets/files/link-post.sh deleted file mode 100644 index 4d3d7dc4f3..0000000000 --- a/docs/src/main/paradox/docs/delta/api/assets/files/link-post.sh +++ /dev/null @@ -1,16 +0,0 @@ -curl -X POST \ - -H "Content-Type: application/json" \ - "http://localhost:8080/v1/files/myorg/myproject?storage=remote" -d \ - '{ - "path": "relative/path/to/myfile.png", - "filename": "myfile.png", - "mediaType": "image/png", - "metadata": { - "name": "My File", - "description": "a description of the file", - "keywords": { - "key1": "value1", - "key2": "value2" - } - } - }' \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/link-put.json b/docs/src/main/paradox/docs/delta/api/assets/files/link-put.json deleted file mode 100644 index 73e0e5235f..0000000000 --- a/docs/src/main/paradox/docs/delta/api/assets/files/link-put.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "path": "relative/path/to/myfile2.png", - "metadata": { - "name": "My File", - "description": "a description of the file", - "keywords": { - "key1": "value1", - "key2": "value2" - } - } -} \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/link-put.sh b/docs/src/main/paradox/docs/delta/api/assets/files/link-put.sh deleted file mode 100644 index 4ba756ce25..0000000000 --- a/docs/src/main/paradox/docs/delta/api/assets/files/link-put.sh +++ /dev/null @@ -1,14 +0,0 @@ -curl -X PUT \ - -H "Content-Type: application/json" \ - "http://localhost:8080/v1/files/myorg/myproject/mylink?storage=remote&tag=mytag" -d \ - '{ - "path": "relative/path/to/myfile2.png", - "metadata": { - "name": "My File", - "description": "a description of the file", - "keywords": { - "key1": "value1", - "key2": "value2" - } - } - }' \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/linked-post.json b/docs/src/main/paradox/docs/delta/api/assets/files/linked-post.json deleted file mode 100644 index 2f74efcad9..0000000000 --- a/docs/src/main/paradox/docs/delta/api/assets/files/linked-post.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "@context": [ - "https://bluebrain.github.io/nexus/contexts/files.json", - "https://bluebrain.github.io/nexus/contexts/metadata.json" - ], - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5", - "@type": "File", - "name": "My File", - "description": "a description of the file", - "_bytes": 1658857, - "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/files.json", - "_createdAt": "2021-05-12T07:56:42.991Z", - "_createdBy": "http://localhost:8080/v1/anonymous", - "_deprecated": false, - "_digest": { - "_value": "" - }, - "_filename": "myfile.png", - "_incoming": "http://localhost:8080/v1/files/myorg/myproject/9ca0d270-35f0-4369-9c17-296fe36fd9a5/incoming", - "_keywords": { - "key1": "value1", - "key2": "value2" - }, - "_location": "file:///tmp/test/nexus/myorg/myproject/3/4/c/4/9/1/a/1/myfile.png", - "_mediaType": "image/png", - "_origin": "Storage", - "_outgoing": "http://localhost:8080/v1/files/myorg/myproject/9ca0d270-35f0-4369-9c17-296fe36fd9a5/outgoing", - "_project": "http://localhost:8080/v1/projects/myorg/myproject", - "_rev": 1, - "_self": "http://localhost:8080/v1/files/myorg/myproject/9ca0d270-35f0-4369-9c17-296fe36fd9a5", - "_storage": { - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", - "@type": "RemoteDiskStorage", - "_rev": 1 - }, - "_updatedAt": "2021-05-12T07:56:42.991Z", - "_updatedBy": "http://localhost:8080/v1/anonymous", - "_uuid": "34c491a1-17ba-4726-bdf2-3b4e1e150750" -} \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/linked-put.json b/docs/src/main/paradox/docs/delta/api/assets/files/linked-put.json deleted file mode 100644 index 6c4364e3b7..0000000000 --- a/docs/src/main/paradox/docs/delta/api/assets/files/linked-put.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "@context": [ - "https://bluebrain.github.io/nexus/contexts/files.json", - "https://bluebrain.github.io/nexus/contexts/metadata.json" - ], - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/mylink", - "@type": "File", - "name": "My File", - "description": "description of the file", - "_bytes": 1658857, - "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/files.json", - "_createdAt": "2021-05-12T08:00:34.563Z", - "_createdBy": "http://localhost:8080/v1/anonymous", - "_deprecated": false, - "_digest": { - "_value": "" - }, - "_filename": "myfile2.png", - "_incoming": "http://localhost:8080/v1/files/myorg/myproject/mylink/incoming", - "_keywords": { - "key1": "value1", - "key2": "value2" - }, - "_location": "file:///tmp/test/nexus/myorg/myproject/6/6/0/4/9/9/d/9/myfile2.png", - "_origin": "Storage", - "_outgoing": "http://localhost:8080/v1/files/myorg/myproject/mylink/outgoing", - "_project": "http://localhost:8080/v1/projects/myorg/myproject", - "_rev": 1, - "_self": "http://localhost:8080/v1/files/myorg/myproject/mylink", - "_storage": { - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", - "@type": "RemoteDiskStorage", - "_rev": 1 - }, - "_updatedAt": "2021-05-12T08:00:34.563Z", - "_updatedBy": "http://localhost:8080/v1/anonymous", - "_uuid": "660499d9-c522-4f90-beda-2d79e538ffce" -} \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/listed.json b/docs/src/main/paradox/docs/delta/api/assets/files/listed.json index 8e6672ce4c..140ae17fa5 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/files/listed.json +++ b/docs/src/main/paradox/docs/delta/api/assets/files/listed.json @@ -55,8 +55,8 @@ "_rev": 2, "_self": "http://localhost:8080/v1/files/myorg/myproject/9ca0d270-35f0-4369-9c17-296fe36fd9a5", "_storage": { - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", - "@type": "RemoteDiskStorage", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", + "@type": "S3Storage", "_rev": 1 }, "_updatedAt": "2021-05-12T07:56:48.380Z", @@ -84,8 +84,8 @@ "_rev": 2, "_self": "http://localhost:8080/v1/files/myorg/myproject/mylink", "_storage": { - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", - "@type": "RemoteDiskStorage", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", + "@type": "S3Storage", "_rev": 1 }, "_updatedAt": "2021-05-12T08:00:40.790Z", diff --git a/docs/src/main/paradox/docs/delta/api/assets/files/sse.json b/docs/src/main/paradox/docs/delta/api/assets/files/sse.json index 1f356beff4..688f3fa365 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/files/sse.json +++ b/docs/src/main/paradox/docs/delta/api/assets/files/sse.json @@ -1,4 +1,4 @@ -data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileCreated","_attributes":{"_bytes":1658857,"_digest":{"_value":""},"_filename":"myfile.png","_location":"file:///tmp/test/nexus/myorg/myproject/3/4/c/4/9/1/a/1/myfile.png","_mediaType":"image/png","_origin":"Storage","_uuid":"34c491a1-17ba-4726-bdf2-3b4e1e150750"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_instant":"2021-05-12T07:56:42.991Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_rev":1,"_storage":{"@id":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","@type":"RemoteDiskStorage","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_rev":1},"_subject":"http://localhost:8080/v1/anonymous"} +data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileCreated","_attributes":{"_bytes":1658857,"_digest":{"_value":""},"_filename":"myfile.png","_location":"file:///tmp/test/nexus/myorg/myproject/3/4/c/4/9/1/a/1/myfile.png","_mediaType":"image/png","_origin":"Storage","_uuid":"34c491a1-17ba-4726-bdf2-3b4e1e150750"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_instant":"2021-05-12T07:56:42.991Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_rev":1,"_storage":{"@id":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","@type":"S3Storage","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_rev":1},"_subject":"http://localhost:8080/v1/anonymous"} event:FileCreated id:9750c010-b2f7-11eb-96af-ed7fe24c2ccf @@ -6,7 +6,7 @@ data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","ht event:FileAttributesUpdated id:9a8229e0-b2f7-11eb-96af-ed7fe24c2ccf -data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileCreated","_attributes":{"_bytes":1658857,"_digest":{"_value":""},"_filename":"myfile2.png","_location":"file:///tmp/test/nexus/myorg/myproject/6/6/0/4/9/9/d/9/myfile2.png","_origin":"Storage","_uuid":"660499d9-c522-4f90-beda-2d79e538ffce"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/mylink","_instant":"2021-05-12T08:00:34.563Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/mylink","_rev":1,"_storage":{"@id":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","@type":"RemoteDiskStorage","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_rev":1},"_subject":"http://localhost:8080/v1/anonymous"} +data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileCreated","_attributes":{"_bytes":1658857,"_digest":{"_value":""},"_filename":"myfile2.png","_location":"file:///tmp/test/nexus/myorg/myproject/6/6/0/4/9/9/d/9/myfile2.png","_origin":"Storage","_uuid":"660499d9-c522-4f90-beda-2d79e538ffce"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/mylink","_instant":"2021-05-12T08:00:34.563Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/mylink","_rev":1,"_storage":{"@id":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","@type":"S3Storage","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_rev":1},"_subject":"http://localhost:8080/v1/anonymous"} event:FileCreated id:21564eb0-b2f8-11eb-96af-ed7fe24c2ccf diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/create-put.json b/docs/src/main/paradox/docs/delta/api/assets/storages/create-put.json index 9f2ccf34de..aa39de4129 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/create-put.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/create-put.json @@ -1,5 +1,5 @@ { - "@type": "RemoteDiskStorage", + "@type": "S3Storage", "default": false, - "folder": "test" + "bucket": "test" } \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/create-put.sh b/docs/src/main/paradox/docs/delta/api/assets/storages/create-put.sh index b94c000237..fc0b485203 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/create-put.sh +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/create-put.sh @@ -1,8 +1,8 @@ curl -X PUT \ -H "Content-Type: application/json" \ - "http://localhost:8080/v1/storages/myorg/myproject/remote" -d \ + "http://localhost:8080/v1/storages/myorg/myproject/s3" -d \ '{ - "@type": "RemoteDiskStorage", + "@type": "S3Storage", "default": false, - "folder": "test" + "bucket": "test" }' \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/created-put.json b/docs/src/main/paradox/docs/delta/api/assets/storages/created-put.json index ce1bd71793..4a7591ad37 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/created-put.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/created-put.json @@ -3,21 +3,20 @@ "https://bluebrain.github.io/nexus/contexts/storages-metadata.json", "https://bluebrain.github.io/nexus/contexts/metadata.json" ], - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", "@type": [ "Storage", - "RemoteDiskStorage" + "S3Storage" ], - "_algorithm": "SHA-256", "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json", "_createdAt": "2021-05-11T12:22:19.195Z", "_createdBy": "http://localhost:8080/v1/anonymous", "_deprecated": false, - "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming", - "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing", + "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming", + "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing", "_project": "http://localhost:8080/v1/projects/myorg/myproject", "_rev": 1, - "_self": "http://localhost:8080/v1/storages/myorg/myproject/remote", + "_self": "http://localhost:8080/v1/storages/myorg/myproject/s3", "_updatedAt": "2021-05-11T12:22:19.195Z", "_updatedBy": "http://localhost:8080/v1/anonymous" } diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/deprecate.sh b/docs/src/main/paradox/docs/delta/api/assets/storages/deprecate.sh index a3951a5ad7..531ef4b2a1 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/deprecate.sh +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/deprecate.sh @@ -1,2 +1,2 @@ curl -X DELETE \ - "http://localhost:8080/v1/storages/myorg/myproject/remote?rev=3" \ No newline at end of file + "http://localhost:8080/v1/storages/myorg/myproject/s3?rev=3" \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/deprecated.json b/docs/src/main/paradox/docs/delta/api/assets/storages/deprecated.json index a33e0c0218..ecccd1afcc 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/deprecated.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/deprecated.json @@ -3,21 +3,20 @@ "https://bluebrain.github.io/nexus/contexts/storages-metadata.json", "https://bluebrain.github.io/nexus/contexts/metadata.json" ], - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", "@type": [ "Storage", - "RemoteDiskStorage" + "S3Storage" ], - "_algorithm": "SHA-256", "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json", "_createdAt": "2021-05-11T12:22:19.195Z", "_createdBy": "http://localhost:8080/v1/anonymous", "_deprecated": true, - "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming", - "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing", + "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming", + "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing", "_project": "http://localhost:8080/v1/projects/myorg/myproject", "_rev": 4, - "_self": "http://localhost:8080/v1/storages/myorg/myproject/remote", + "_self": "http://localhost:8080/v1/storages/myorg/myproject/s3", "_updatedAt": "2021-05-11T12:29:27.821Z", "_updatedBy": "http://localhost:8080/v1/anonymous" } diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/fetch-source.sh b/docs/src/main/paradox/docs/delta/api/assets/storages/fetch-source.sh index fd9eba63c6..6416feb4d8 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/fetch-source.sh +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/fetch-source.sh @@ -1 +1 @@ -curl "http://localhost:8080/v1/storages/myorg/myproject/remote/source" \ No newline at end of file +curl "http://localhost:8080/v1/storages/myorg/myproject/s3/source" \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/fetch-statistics.sh b/docs/src/main/paradox/docs/delta/api/assets/storages/fetch-statistics.sh index 16cd27d38c..afdd92c894 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/fetch-statistics.sh +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/fetch-statistics.sh @@ -1 +1 @@ -curl "http://localhost:8080/v1/storages/myorg/myproject/remote/statistics" \ No newline at end of file +curl "http://localhost:8080/v1/storages/myorg/myproject/s3/statistics" \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/fetch.sh b/docs/src/main/paradox/docs/delta/api/assets/storages/fetch.sh index 5281ae94f2..cb8f2aeccd 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/fetch.sh +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/fetch.sh @@ -1 +1 @@ -curl "http://localhost:8080/v1/storages/myorg/myproject/remote" \ No newline at end of file +curl "http://localhost:8080/v1/storages/myorg/myproject/s3" \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/fetched-source.json b/docs/src/main/paradox/docs/delta/api/assets/storages/fetched-source.json index a3d5553b7e..d3cc6d7f3c 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/fetched-source.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/fetched-source.json @@ -1,5 +1,5 @@ { - "@type": "RemoteDiskStorage", + "@type": "S3Storage", "default": false, - "folder": "test-updated" + "bucket": "test-updated" } diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/fetched.json b/docs/src/main/paradox/docs/delta/api/assets/storages/fetched.json index 2c73874552..f111cd8f9c 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/fetched.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/fetched.json @@ -3,26 +3,24 @@ "https://bluebrain.github.io/nexus/contexts/storages.json", "https://bluebrain.github.io/nexus/contexts/metadata.json" ], - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", "@type": [ "Storage", - "RemoteDiskStorage" + "S3Storage" ], "default": false, - "folder": "test-updated", - "maxFileSize": 10737418240, + "bucket": "test-updated", "readPermission": "resources/read", "writePermission": "files/write", - "_algorithm": "SHA-256", "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json", "_createdAt": "2021-05-11T12:22:19.195Z", "_createdBy": "http://localhost:8080/v1/anonymous", "_deprecated": true, - "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming", - "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing", + "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming", + "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing", "_project": "http://localhost:8080/v1/projects/myorg/myproject", "_rev": 4, - "_self": "http://localhost:8080/v1/storages/myorg/myproject/remote", + "_self": "http://localhost:8080/v1/storages/myorg/myproject/s3", "_updatedAt": "2021-05-11T12:29:27.821Z", "_updatedBy": "http://localhost:8080/v1/anonymous" } diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/listed.json b/docs/src/main/paradox/docs/delta/api/assets/storages/listed.json index 3f93b58743..05a5e47016 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/listed.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/listed.json @@ -45,21 +45,20 @@ "_updatedBy": "http://localhost:8080/v1/anonymous" }, { - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", "@type": [ "Storage", - "RemoteDiskStorage" + "S3Storage" ], - "_algorithm": "SHA-256", "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json", "_createdAt": "2021-05-11T12:22:19.195Z", "_createdBy": "http://localhost:8080/v1/anonymous", "_deprecated": true, - "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming", - "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing", + "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming", + "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing", "_project": "http://localhost:8080/v1/projects/myorg/myproject", "_rev": 4, - "_self": "http://localhost:8080/v1/storages/myorg/myproject/remote", + "_self": "http://localhost:8080/v1/storages/myorg/myproject/s3", "_updatedAt": "2021-05-11T12:29:27.821Z", "_updatedBy": "http://localhost:8080/v1/anonymous" } diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/sse.json b/docs/src/main/paradox/docs/delta/api/assets/storages/sse.json index f3cab51772..30d1251131 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/sse.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/sse.json @@ -7,18 +7,18 @@ data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","ht event:StorageCreated id:642ccf20-b253-11eb-b48a-9d94c78eda08 -data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/storages.json"],"@type":"StorageCreated","_constrainedBy":"https://bluebrain.github.io/nexus/schemas/storages.json","_instant":"2021-05-11T12:22:19.195Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_rev":1,"_source":{"@type":"RemoteDiskStorage","default":false,"folder":"test"},"_storageId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/Storage","https://bluebrain.github.io/nexus/vocabulary/RemoteDiskStorage"]} +data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/storages.json"],"@type":"StorageCreated","_constrainedBy":"https://bluebrain.github.io/nexus/schemas/storages.json","_instant":"2021-05-11T12:22:19.195Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_rev":1,"_source":{"@type":"S3Storage","default":false,"folder":"test"},"_storageId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/Storage","https://bluebrain.github.io/nexus/vocabulary/S3Storage"]} event:StorageCreated id:879fab30-b253-11eb-b48a-9d94c78eda08 -data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/storages.json"],"@type":"StorageUpdated","_constrainedBy":"https://bluebrain.github.io/nexus/schemas/storages.json","_instant":"2021-05-11T12:24:24.242Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_rev":2,"_source":{"@type":"RemoteDiskStorage","default":false,"folder":"test-updated"},"_storageId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/Storage","https://bluebrain.github.io/nexus/vocabulary/RemoteDiskStorage"]} +data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/storages.json"],"@type":"StorageUpdated","_constrainedBy":"https://bluebrain.github.io/nexus/schemas/storages.json","_instant":"2021-05-11T12:24:24.242Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_rev":2,"_source":{"@type":"S3Storage","default":false,"folder":"test-updated"},"_storageId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/Storage","https://bluebrain.github.io/nexus/vocabulary/S3Storage"]} event:StorageUpdated id:d2226030-b253-11eb-b48a-9d94c78eda08 -data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/storages.json"],"@type":"StorageTagAdded","tag":"mytag","targetRev":1,"_constrainedBy":"https://bluebrain.github.io/nexus/schemas/storages.json","_instant":"2021-05-11T12:28:08.479Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_rev":3,"_storageId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/Storage","https://bluebrain.github.io/nexus/vocabulary/RemoteDiskStorage"]} +data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/storages.json"],"@type":"StorageTagAdded","tag":"mytag","targetRev":1,"_constrainedBy":"https://bluebrain.github.io/nexus/schemas/storages.json","_instant":"2021-05-11T12:28:08.479Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_rev":3,"_storageId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/Storage","https://bluebrain.github.io/nexus/vocabulary/S3Storage"]} event:StorageTagAdded id:57ca3a00-b254-11eb-b48a-9d94c78eda08 -data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/storages.json"],"@type":"StorageDeprecated","_constrainedBy":"https://bluebrain.github.io/nexus/schemas/storages.json","_instant":"2021-05-11T12:29:27.821Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_rev":4,"_storageId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/Storage","https://bluebrain.github.io/nexus/vocabulary/RemoteDiskStorage"]} +data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/storages.json"],"@type":"StorageDeprecated","_constrainedBy":"https://bluebrain.github.io/nexus/schemas/storages.json","_instant":"2021-05-11T12:29:27.821Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_rev":4,"_storageId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/Storage","https://bluebrain.github.io/nexus/vocabulary/S3Storage"]} event:StorageDeprecated id:8714dae0-b254-11eb-b48a-9d94c78eda08 \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/undeprecate.sh b/docs/src/main/paradox/docs/delta/api/assets/storages/undeprecate.sh index d1b63a3728..6aba5ab9bb 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/undeprecate.sh +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/undeprecate.sh @@ -1,2 +1,2 @@ curl -X PUT \ - "http://localhost:8080/v1/storages/myorg/myproject/remote?rev=4" \ No newline at end of file + "http://localhost:8080/v1/storages/myorg/myproject/s3?rev=4" \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/undeprecated.json b/docs/src/main/paradox/docs/delta/api/assets/storages/undeprecated.json index 8eec2fc1e3..c4260fabf9 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/undeprecated.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/undeprecated.json @@ -3,21 +3,21 @@ "https://bluebrain.github.io/nexus/contexts/storages-metadata.json", "https://bluebrain.github.io/nexus/contexts/metadata.json" ], - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", "@type": [ "Storage", - "RemoteDiskStorage" + "S3Storage" ], "_algorithm": "SHA-256", "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json", "_createdAt": "2021-05-11T12:22:19.195Z", "_createdBy": "http://localhost:8080/v1/anonymous", "_deprecated": false, - "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming", - "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing", + "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming", + "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing", "_project": "http://localhost:8080/v1/projects/myorg/myproject", "_rev": 5, - "_self": "http://localhost:8080/v1/storages/myorg/myproject/remote", + "_self": "http://localhost:8080/v1/storages/myorg/myproject/s3", "_updatedAt": "2021-05-11T12:29:27.821Z", "_updatedBy": "http://localhost:8080/v1/anonymous" } diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/update.json b/docs/src/main/paradox/docs/delta/api/assets/storages/update.json index 22881dc4e4..ba4c1cf008 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/update.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/update.json @@ -1,5 +1,5 @@ { - "@type": "RemoteDiskStorage", + "@type": "S3Storage", "default": false, - "folder": "test-updated" + "bucket": "test-updated" } \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/update.sh b/docs/src/main/paradox/docs/delta/api/assets/storages/update.sh index aad3fdfb11..a1c5ced061 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/update.sh +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/update.sh @@ -1,8 +1,8 @@ curl -X PUT \ -H "Content-Type: application/json" \ - "http://localhost:8080/v1/storages/myorg/myproject/remote?rev=1" -d \ + "http://localhost:8080/v1/storages/myorg/myproject/s3?rev=1" -d \ '{ - "@type": "RemoteDiskStorage", + "@type": "S3Storage", "default": false, - "folder": "test-updated" + "bucket": "test-updated" }' \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/assets/storages/updated.json b/docs/src/main/paradox/docs/delta/api/assets/storages/updated.json index 1458a2acf4..df79e7d534 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/storages/updated.json +++ b/docs/src/main/paradox/docs/delta/api/assets/storages/updated.json @@ -3,21 +3,20 @@ "https://bluebrain.github.io/nexus/contexts/storages-metadata.json", "https://bluebrain.github.io/nexus/contexts/metadata.json" ], - "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote", + "@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3", "@type": [ "Storage", - "RemoteDiskStorage" + "S3Storage" ], - "_algorithm": "SHA-256", "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json", "_createdAt": "2021-05-11T12:22:19.195Z", "_createdBy": "http://localhost:8080/v1/anonymous", "_deprecated": false, - "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming", - "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing", + "_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming", + "_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing", "_project": "http://localhost:8080/v1/projects/myorg/myproject", "_rev": 2, - "_self": "http://localhost:8080/v1/storages/myorg/myproject/remote", + "_self": "http://localhost:8080/v1/storages/myorg/myproject/s3", "_updatedAt": "2021-05-11T12:24:24.242Z", "_updatedBy": "http://localhost:8080/v1/anonymous" } diff --git a/docs/src/main/paradox/docs/delta/api/assets/version.json b/docs/src/main/paradox/docs/delta/api/assets/version.json index bd68c8a079..debbf6d4a7 100644 --- a/docs/src/main/paradox/docs/delta/api/assets/version.json +++ b/docs/src/main/paradox/docs/delta/api/assets/version.json @@ -4,8 +4,7 @@ "dependencies": { "blazegraph": "2.1.6-RC", "postgresql": "16.4", - "elasticsearch": "8.14.1", - "remoteStorage": "1.10.0" + "elasticsearch": "8.14.1" }, "plugins": { "archive": "1.10.0", diff --git a/docs/src/main/paradox/docs/delta/api/files-api.md b/docs/src/main/paradox/docs/delta/api/files-api.md index 44bdd99479..ab2084cf4c 100644 --- a/docs/src/main/paradox/docs/delta/api/files-api.md +++ b/docs/src/main/paradox/docs/delta/api/files-api.md @@ -113,76 +113,6 @@ Request Response : @@snip [created-put.json](assets/files/created-put.json) -## Link using POST - -Brings a file existing in a storage to Nexus Delta as a file resource. This operation is supported for files using `RemoteDiskStorage`. - -``` -POST /v1/files/{org_label}/{project_label}?storage={storageId}&tag={tagName} - { - "path": "{path}", - "filename": "{filename}", - "mediaType": "{mediaType}", - "metadata": "{metadata}" - } -``` - -- `{storageId}`: String - Selects a specific storage backend that supports linking existing files. This field is optional. - When not specified, the default storage of the project is used. -- `{path}`: String - the relative location (from the point of view of storage folder) on the remote storage where the file exists. -- `{filename}`: String - the name that will be given to the file during linking. This field is optional. When not specified, the original filename is retained. -- `{mediaType}`: String - the MediaType fo the file. This field is optional. When not specified, Nexus Delta will attempt to detect it. -- `{tagName}` an optional label given to the linked file resource on its first revision. -- `{metadata}`: JSON Object - Optional, see @ref:[custom file metadata](#custom-file-metadata). - -**Example** - -Request -: @@snip [link-post.sh](assets/files/link-post.sh) - -Payload -: @@snip [link-post.json](assets/files/link-post.json) - -Response -: @@snip [linked-post.json](assets/files/linked-post.json) - -## Link using PUT - -Brings a file existing in a storage to Nexus Delta as a file resource. This operation is supported for files using `RemoteDiskStorage`. - -This alternative endpoint allows to specify the resource `@id`. - -``` -PUT /v1/files/{org_label}/{project_label}/{file_id}?storage={storageId}&tag={tagName} - { - "path": "{path}", - "filename": "{filename}", - "mediaType": "{mediaType}", - "metadata": "{metadata}" - } -``` - -... where - -- `{storageId}`: String - Selects a specific storage backend that supports linking existing files. This field is optional. -When not specified, the default storage of the project is used. -- `{path}`: String - the relative location (from the point of view of the storage folder) on the remote storage where the file exists. -- `{filename}`: String - the name that will be given to the file during linking. This field is optional. When not specified, the original filename is retained. -- `{mediaType}`: String - the MediaType fo the file. This field is optional. When not specified, Nexus Delta will attempt to detect it. -- `{tagName}` an optional label given to the linked file resource on its first revision. -- `{metadata}`: JSON Object - Optional, see @ref:[custom file metadata](#custom-file-metadata). - -**Example** - -Request -: @@snip [link-put.sh](assets/files/link-put.sh) - -Payload -: @@snip [link-put.json](assets/files/link-put.json) - -Response -: @@snip [linked-put.json](assets/files/linked-put.json) - ## Update This operation overrides the file content. diff --git a/docs/src/main/paradox/docs/delta/api/storages-api.md b/docs/src/main/paradox/docs/delta/api/storages-api.md index b16375a304..d760280508 100644 --- a/docs/src/main/paradox/docs/delta/api/storages-api.md +++ b/docs/src/main/paradox/docs/delta/api/storages-api.md @@ -52,46 +52,6 @@ local file-system structure and that Nexus has read and write access to the targ - `{write_permission}`: String - the permission a client must have in order to create files using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.disk.default-write-permission` (`files/write`). - `{max_file_size}`: Long - the maximum allowed size in bytes for files uploaded using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.disk.default-max-file-size` (10G). -### Remote disk storage - -@@@ warning -The Remote disk storage and it remote service implementation are now deprecated and will be removed in an upcoming release. -@@@ - -This storage type relies on a remote HTTP service that exposes basic file operations on an underlying POSIX file-system. -This is particularly handy if your organization is running some kind of distributed network storage (such as Ceph, -Gluster, GPFS, Lustre, ...) that you don't want to mount directly on the system where Nexus Delta runs. - -While there's no formal specification for this service, you can check out or deploy our own implementation: -@link:[Nexus remote storage service](https://github.com/BlueBrain/nexus/tree/$git.branch$/storage){ open=new }. - -In order to be able to use this storage, the configuration flag `plugins.storage.storages.remote-disk.enabled` should be set to `true`. -@ref:[More information about configuration](../../getting-started/running-nexus/configuration/index.md#remote-storage-configuration) - - -```json -{ - "@type": "RemoteDiskStorage", - "name": "{name}", - "description": "{description}", - "default": "{default}", - "folder": "{folder}", - "readPermission": "{read_permission}", - "writePermission": "{write_permission}", - "maxFileSize": {max_file_size} -} -``` - -...where - -- `{name}`: String - A name for this storage. This field is optional. -- `{description}`: String - A description for this storage. This field is optional. -- `{default}`: Boolean - the flag to decide whether this storage is going to become the default storage for the target project or not. -- `{folder}`: String - the storage service bucket where files using this storage are going to be saved. -- `{read_permission}`: String - the permission a client must have in order to fetch files using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.remote-disk.default-read-permission` (`resources/read`). -- `{write_permission}`: String - the permission a client must have in order to create files using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.remote-disk.default-write-permission` (`files/write`). -- `{max_file_size}`: Long - the maximum allowed size in bytes for files uploaded using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.remote-disk.default-max-file-size` (10G). - ### Amazon S3 compatible storage This storage type allows the use of an internal or external blob-store that is compatible with the Amazon S3 API. diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md b/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md index 62cc53ac4e..0a0c7db5dc 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md +++ b/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md @@ -115,17 +115,41 @@ The composite views plugin configuration can be found @link:[here](https://githu There are several configuration flags related to tweaking the range of values allowed for sources, projections and rebuild interval. -Authentication for remote sources can be specified in three different ways. The value of `plugins.composite-views.remote-source-credentials` should be speficied in the same way as remote storages, as shown @ref:[here](#remote-storage-configuration) +Authentication for remote sources can be specified in three different ways. The value of `plugins.composite-views.remote-source-credentials` can be set as: + +##### Recommended: client credentials (OpenId authentication) +```hocon +{ + type: "client-credentials" + user: "username" + password: "password" + realm: "internal" +} +``` +This configuration tells Delta to log into the `internal` realm (which should have already been defined) with the `user` and `password` credentials, which will give Delta an access token to use when making requests to the remote instance + +##### Anonymous +```hocon +{ + type: "anonymous" +} +``` +##### Long-living auth token (legacy) +```hocon +{ + type: "jwt-token" + token: "long-living-auth-token" +} +``` ### Storage plugin configuration The storage plugin configuration can be found @link:[here](https://github.com/BlueBrain/nexus/blob/$git.branch$/delta/plugins/storage/src/main/resources/storage.conf){ open=new }. -Nexus Delta supports 3 types of storages: 'disk', 'amazon' (s3 compatible) and 'remote'. +Nexus Delta supports 2 types of storages: 'disk', 'amazon' (s3 compatible). - For disk storages the most relevant configuration flag is `plugins.storage.storages.disk.default-volume`, which defines the default location in the Nexus Delta filesystem where the files using that storage are going to be saved. - For S3 compatible storages the most relevant configuration flags are the ones related to the S3 settings: `plugins.storage.storages.amazon.default-endpoint`, `plugins.storage.storages.amazon.default-access-key` and `plugins.storage.storages.amazon.default-secret-key`. -- For remote disk storages the most relevant configuration flags are `plugins.storage.storages.remote-disk.default-endpoint` (the endpoint where the remote storage service is running) and `plugins.storage.storages.remote-disk.credentials` (the method to authenticate to the remote storage service). #### File configuration @@ -153,35 +177,6 @@ The media type resolution process follow this order stopping at the first succes * Fallback on akka automatic detection * Fallback to the default value `application/octet-stream` -#### Remote storage configuration - -Authentication for remote storage can be specified in three different ways. The value of `plugins.storage.storages.remote-disk.credentials` can be: - -##### Recommended: client credentials (OpenId authentication) -```hocon -{ - type: "client-credentials" - user: "username" - password: "password" - realm: "internal" -} -``` -This configuration tells Delta to log into the `internal` realm (which should have already been defined) with the `user` and `password` credentials, which will give Delta an access token to use when making requests to remote storage - -##### Anonymous -```hocon -{ - type: "anonymous" -} -``` -##### Long-living auth token (legacy) -```hocon -{ - type: "jwt-token" - token: "long-living-auth-token" -} -``` - #### S3 storage configuration Delta's S3 storage integration supports users uploading files to S3 independently and then registering them within Delta. diff --git a/docs/src/main/paradox/docs/releases/index.md b/docs/src/main/paradox/docs/releases/index.md index fdb5f7ddfb..34bfc91362 100644 --- a/docs/src/main/paradox/docs/releases/index.md +++ b/docs/src/main/paradox/docs/releases/index.md @@ -308,7 +308,7 @@ This release contains bugfixes and minor improvements: - Nexus client - Indexing data in other systems -- @ref:[RemoteDiskStorage](../delta/api/storages-api.md#remote-disk-storage) +- Remote storages ### New features / enhancements diff --git a/docs/src/main/paradox/docs/releases/v1.10-release-notes.md b/docs/src/main/paradox/docs/releases/v1.10-release-notes.md index c2b28d0972..d5659cb97e 100644 --- a/docs/src/main/paradox/docs/releases/v1.10-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.10-release-notes.md @@ -92,11 +92,6 @@ Previously deprecated storages can now be undeprecated. @ref:[More information](../delta/api/storages-api.md#undeprecate) -#### The endpoint for remote storages can not be overridden anymore - -The endpoint for remote storages is now only defined by configuration and can not be overridden in the create and -update operations. - #### Deprecations * Storages can no longer be tagged, looked up by tag or have their tags fetched. diff --git a/docs/src/main/paradox/docs/releases/v1.6-release-notes.md b/docs/src/main/paradox/docs/releases/v1.6-release-notes.md index 9c68e0ec94..c3242ef80f 100644 --- a/docs/src/main/paradox/docs/releases/v1.6-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.6-release-notes.md @@ -35,7 +35,7 @@ These two features are now marked as deprecated and will be removed in an upcomi - Nexus client - Indexing data in other systems -- @ref:[RemoteDiskStorage](../delta/api/storages-api.md#remote-disk-storage) +- Remote storages ### Global search diff --git a/docs/src/main/paradox/docs/releases/v1.8-to-v1.9-migration.md b/docs/src/main/paradox/docs/releases/v1.8-to-v1.9-migration.md index 45545c6a22..8ab2185f7d 100644 --- a/docs/src/main/paradox/docs/releases/v1.8-to-v1.9-migration.md +++ b/docs/src/main/paradox/docs/releases/v1.8-to-v1.9-migration.md @@ -59,7 +59,7 @@ The following logs should appear in Delta for each of your project: Currently, both remote storages and composite views with remote sources can hold auth tokens for communications with these remote endpoints. In v1.9, we now expect authentication to be dealt with in the Delta configuration -A remote storage might currently have a token stored in the storage definition. In 1.9, this should be moved to `plugins.storage.storages.remote-disk.credentials`, as shown @ref:[here](../getting-started/running-nexus/configuration/index.md#remote-storage-configuration) +A remote storage might currently have a token stored in the storage definition. In 1.9, this should be moved to `plugins.storage.storages.remote-disk.credentials`. A composite view might currently have a token stored in the view definition. In 1.9, this should be moved to `plugins.composite-views.remote-source-credentials`, as shown @ref:[here](../getting-started/running-nexus/configuration/index.md#composite-views-plugin-configuration) diff --git a/docs/src/main/paradox/docs/releases/v1.9-release-notes.md b/docs/src/main/paradox/docs/releases/v1.9-release-notes.md index bcb2ad4e26..71f749df22 100644 --- a/docs/src/main/paradox/docs/releases/v1.9-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.9-release-notes.md @@ -212,8 +212,6 @@ Storages can no longer be created with credentials that would get stored: These should instead be defined in the Delta configuration. -@ref:[More information](../getting-started/running-nexus/configuration/index.md#remote-storage-configuration) - ### Files #### Undeprecate files diff --git a/docs/src/main/paradox/schemas/storage.json b/docs/src/main/paradox/schemas/storage.json index 6ebeb83425..e50616b640 100644 --- a/docs/src/main/paradox/schemas/storage.json +++ b/docs/src/main/paradox/schemas/storage.json @@ -19,9 +19,6 @@ }, { "node": "this:S3Storage" - }, - { - "node": "this:RemoteDiskStorage" } ] }, @@ -81,78 +78,6 @@ } ] }, - { - "@id": "this:RemoteDiskStorage", - "nodeKind": "sh:BlankNodeOrIRI", - "sh:closed": true, - "property": [ - { - "path": "rdf:type", - "name": "RDF type RemoteDiskStorage", - "description": "The RemoteDiskStorage RDF type.", - "nodeKind": "sh:IRI", - "sh:hasValue": { - "@id": "nxv:RemoteDiskStorage" - } - }, - { - "path": "nxv:maxFileSize", - "name": "maxFileSize", - "description": "the maximum file size for uploaded entities", - "datatype": "xsd:long", - "minCount": 0, - "maxCount": 1 - }, - { - "path": "nxv:default", - "name": "default", - "description": "Flag to determine whether or not the storage is a default storage", - "datatype": "xsd:boolean", - "minCount": 1, - "maxCount": 1 - }, - { - "path": "nxv:folder", - "name": "folder", - "description": "The remote storage folder (similar concept to bucket in the S3)", - "datatype": "xsd:string", - "minCount": 1, - "maxCount": 1 - }, - { - "path": "nxv:endpoint", - "name": "endpoint", - "description": "The endpoint to communicate with the remote storage", - "datatype": "xsd:string", - "minCount": 0, - "maxCount": 1 - }, - { - "path": "nxv:credentials", - "name": "credentials", - "description": "The remote storage optional Bearer Token", - "datatype": "xsd:string", - "minCount": 0, - "maxCount": 1 - }, - { - "path": "nxv:readPermission", - "name": "readPermission", - "description": "The permission required in order to download a file from this storage", - "datatype": "xsd:string", - "minCount": 0, - "maxCount": 1 - }, - { - "path": "nxv:writePermission", - "name": "writePermission", - "description": "The permission required in order to upload a file to this storage", - "datatype": "xsd:string", - "minCount": 0, - "maxCount": 1 - } - ] - }, { "@id": "this:S3Storage", "nodeKind": "sh:BlankNodeOrIRI",