Mercurial > hg > orthanc-book
changeset 499:d255e02eb89d
updated object-storage doc for 1.0.0
author | Alain Mazy <alain@mazy.be> |
---|---|
date | Tue, 01 Sep 2020 18:08:45 +0200 |
parents | 2ac9eacb4ade |
children | 4481882d9c83 |
files | Sphinx/source/plugins/object-storage.rst |
diffstat | 1 files changed, 53 insertions(+), 13 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/plugins/object-storage.rst Tue Sep 01 10:15:57 2020 +0200 +++ b/Sphinx/source/plugins/object-storage.rst Tue Sep 01 18:08:45 2020 +0200 @@ -6,6 +6,11 @@ .. contents:: +Release notes +------------- + +Release notes are available `here +<https://hg.orthanc-server.com/orthanc-object-storage/file/default/NEWS>`__ Introduction ------------ @@ -122,9 +127,11 @@ "Region" : "eu-central-1", "AccessKey" : "AKXXX", "SecretKey" : "RhYYYY", - "Endpoint": "", // optional - currently in mainline version only: custom endpoint - "ConnectionTimeout": 30, // optional - currently in mainline version only: connection timeout in seconds - "RequestTimeout": 1200 // optional - currently in mainline version only: request timeout in seconds (max time to upload/download a file) + "Endpoint": "", // custom endpoint + "ConnectionTimeout": 30, // connection timeout in seconds + "RequestTimeout": 1200, // request timeout in seconds (max time to upload/download a file) + "MigrationFromFileSystemEnabled": false, // see below + "StorageStructure": "flat" // see below } The **EndPoint** configuration is used when accessing an S3 compatible cloud provider. I.e. here is a configuration to store data on Scaleway:: @@ -144,7 +151,9 @@ "AzureBlobStorage" : { "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=xxxxxxxxx;AccountKey=yyyyyyyy===;EndpointSuffix=core.windows.net", - "ContainerName" : "test-orthanc-storage-plugin" + "ContainerName" : "test-orthanc-storage-plugin", + "MigrationFromFileSystemEnabled": false, // see below + "StorageStructure": "flat" // see below } @@ -155,10 +164,39 @@ "GoogleCloudStorage" : { "ServiceAccountFile": "/path/to/googleServiceAccountFile.json", - "BucketName": "test-orthanc-storage-plugin" + "BucketName": "test-orthanc-storage-plugin", + "MigrationFromFileSystemEnabled": false, // see below + "StorageStructure": "flat" // see below } +Migration & Storage structure +----------------------------- + +The **StorageStructure** configuration allows you to select the way objects are organized +within the storage (``flat`` or ``legacy``). +Unlike traditional file system in which Orthanc uses 2 levels +of folders, object storages usually have no limit on the number of files per folder and +therefore all objects are stored at the root level of the object storage. This is the +default ``flat`` behaviour. Note that, in the ``flat`` mode, an extension `.dcm` or `.json` +is added to the filename which is not the case in the legacy mode. + +The ``legacy`` behaviour mimicks the Orthanc File System convention. This is actually helpful +when migrating your data from a file system to an object storage since you can copy all the file +hierarchy as is. + +Note that you can not change this configuration once you've uploaded the first files in Orthanc. + +The **MigrationFromFileSystemEnabled** configuration has been for Orthanc to continue working +while you're migrating your data from the file system to the object storage. While this option is enabled, +Orthanc will store all new files into the object storage but will try to read/delete files +from both the file system and the object storage. + +This option can be disabled as soon as all files have been copied from the file system to the +object storage. Note that Orthanc is not copying the files from one storage to the other; you'll +have to use a standard ``sync`` command from the object-storage provider. + + Sample setups ------------- @@ -245,14 +283,16 @@ Here's a sample configuration file of the `StorageEncryption` section of the plugins:: { - "StorageEncryption" : { - "Enable": true, - "MasterKey": [3, "/path/to/master.key"], // key id - path to the base64 encoded key - "PreviousMasterKeys" : [ - [1, "/path/to/previous1.key"], - [2, "/path/to/previous2.key"] - ], - "MaxConcurrentInputSize" : 1024 // size in MB + "GoogleCloudStorage" : { + "StorageEncryption" : { + "Enable": true, + "MasterKey": [3, "/path/to/master.key"], // key id - path to the base64 encoded key + "PreviousMasterKeys" : [ + [1, "/path/to/previous1.key"], + [2, "/path/to/previous2.key"] + ], + "MaxConcurrentInputSize" : 1024 // size in MB + } } }