Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/object-storage.rst @ 881:d04096c1afd7
fix
author | Alain Mazy <am@osimis.io> |
---|---|
date | Fri, 21 Oct 2022 15:10:34 +0200 |
parents | ac9b677b73c3 |
children | 6316d139b4a9 |
rev | line source |
---|---|
451 | 1 .. _object-storage: |
2 | |
3 | |
4 Cloud Object Storage plugins | |
5 ============================ | |
6 | |
7 .. contents:: | |
8 | |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
9 Release notes |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
10 ------------- |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
11 |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
12 Release notes are available `here |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
13 <https://hg.orthanc-server.com/orthanc-object-storage/file/default/NEWS>`__ |
451 | 14 |
15 Introduction | |
16 ------------ | |
17 | |
880 | 18 These 3 plugins enable storing the Orthanc files in `Object Storage <https://en.wikipedia.org/wiki/Object_storage>`__ |
19 at the 3 main Cloud providers: `AWS <https://aws.amazon.com/s3/>`__, | |
451 | 20 `Azure <https://azure.microsoft.com/en-us/services/storage/blobs/>`__ & |
21 `Google Cloud <https://cloud.google.com/storage>`__ | |
22 | |
23 Storing Orthanc files in object storage and your index SQL in a | |
24 managed database allows you to have a stateless Orthanc that does | |
25 not store any data in its local file system which is highly recommended | |
26 when deploying an application in the cloud. | |
27 | |
28 | |
459
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
29 Pre-compiled binaries |
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
30 --------------------- |
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
31 |
880 | 32 These plugins are provided as part of the ``osimis/orthanc`` :ref:`Docker images <docker-osimis>`. |
881 | 33 The AWS plugin is available in the default Docker images while the Azure and Google plugins are available |
34 in the ``-full`` images. | |
880 | 35 |
459
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
36 These plugins are used to interface Orthanc with commercial and |
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
37 proprietary cloud services that you accept to pay. As a consequence, |
880 | 38 the Orthanc project usually doesn't freely update them or fix them unless |
39 the requester purchases a support contract e.g. at `Orthanc Team <https://orthanc.team>`__. | |
40 | |
41 Although you are obviously free to compile these plugins by | |
459
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
42 yourself (instructions are given below), purchasing such support |
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
43 contracts makes the Orthanc project sustainable in the long term, to |
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
44 the benefit of the worldwide community of medical imaging. |
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
45 |
a4ed4e883337
highlighting the pre-compiled binaries for google, aws and azure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
453
diff
changeset
|
46 |
451 | 47 Compilation |
48 ----------- | |
49 | |
50 .. highlight:: text | |
51 | |
52 The procedure to compile the plugins is quite similar of that for the | |
53 :ref:`core of Orthanc <compiling>` although they usually require | |
54 some prerequisites. The documented procedure has been tested only | |
55 on a Debian Buster machine. | |
56 | |
57 The compilation of each plugin produces a shared library that contains | |
58 the plugin. | |
59 | |
60 | |
61 AWS S3 plugin | |
62 ^^^^^^^^^^^^^ | |
63 | |
64 Prerequisites: Compile the AWS C++ SDK:: | |
65 | |
66 $ mkdir ~/aws | |
67 $ cd ~/aws | |
68 $ git clone https://github.com/aws/aws-sdk-cpp.git | |
69 $ | |
70 $ mkdir -p ~/aws/builds/aws-sdk-cpp | |
71 $ cd ~/aws/builds/aws-sdk-cpp | |
72 $ cmake -DBUILD_ONLY="s3;transfer" ~/aws/aws-sdk-cpp | |
73 $ make -j 4 | |
74 $ make install | |
75 | |
76 Prerequisites: Install `vcpkg <https://github.com/Microsoft/vcpkg>`__ dependencies:: | |
77 | |
78 $ ./vcpkg install cryptopp | |
79 | |
80 Compile:: | |
81 | |
82 $ mkdir -p build/aws | |
83 $ cd build/aws | |
84 $ cmake -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]\scripts\buildsystems\vcpkg.cmake ../../orthanc-object-storage/Aws | |
85 | |
504 | 86 |
87 **NB:** If you don't want to use vcpkg, you can use the following | |
88 command (this syntax is not compatible with Ninja yet):: | |
89 | |
543
fd340103904c
note to build aws plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
520
diff
changeset
|
90 $ cmake -DCMAKE_BUILD_TYPE=Debug -DUSE_VCPKG_PACKAGES=OFF -DUSE_SYSTEM_GOOGLE_TEST=OFF ../../orthanc-object-storage/Aws |
504 | 91 $ make |
92 | |
543
fd340103904c
note to build aws plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
520
diff
changeset
|
93 Crypto++ must be installed (on Ubuntu, run ``sudo apt install libcrypto++-dev``). |
fd340103904c
note to build aws plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
520
diff
changeset
|
94 |
505
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
95 |
451 | 96 Azure Blob Storage plugin |
97 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
98 | |
99 Prerequisites: Install `vcpkg <https://github.com/Microsoft/vcpkg>`__ dependencies:: | |
100 | |
628 | 101 $ ./vcpkg install cryptopp |
102 $ ./vcpkg install azure-storage-cpp | |
451 | 103 |
104 | |
105 Compile:: | |
106 | |
107 $ mkdir -p build/azure | |
108 $ cd build/azure | |
109 $ cmake -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]\scripts\buildsystems\vcpkg.cmake ../../orthanc-object-storage/Azure | |
110 | |
111 Google Storage plugin | |
112 ^^^^^^^^^^^^^^^^^^^^^ | |
113 | |
114 Prerequisites: Install `vcpkg <https://github.com/Microsoft/vcpkg>`__ dependencies:: | |
115 | |
628 | 116 $ ./vcpkg install cryptopp |
117 $ ./vcpkg install google-cloud-cpp | |
451 | 118 |
119 Compile:: | |
120 | |
121 $ mkdir -p build/google | |
122 $ cd build/google | |
123 $ cmake -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]\scripts\buildsystems\vcpkg.cmake ../../orthanc-object-storage/google | |
124 | |
125 | |
126 Configuration | |
127 ------------- | |
128 | |
129 .. highlight:: json | |
130 | |
131 AWS S3 plugin | |
132 ^^^^^^^^^^^^^ | |
133 | |
134 Sample configuration:: | |
135 | |
136 "AwsS3Storage" : { | |
766
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
137 "BucketName": "test-orthanc-s3-plugin", |
451 | 138 "Region" : "eu-central-1", |
685 | 139 "AccessKey" : "AKXXX", // optional: if not specified, the plugin will use the default credentials manager (available from version 1.3.0) |
140 "SecretKey" : "RhYYYY", // optional: if not specified, the plugin will use the default credentials manager (available from version 1.3.0) | |
141 "Endpoint": "", // optional: custom endpoint | |
142 "ConnectionTimeout": 30, // optional: connection timeout in seconds | |
143 "RequestTimeout": 1200, // optional: request timeout in seconds (max time to upload/download a file) | |
144 "RootPath": "", // optional: see below | |
145 "MigrationFromFileSystemEnabled": false, // optional: see below | |
146 "StorageStructure": "flat", // optional: see below | |
766
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
147 "EnableLegacyUnknownFiles": true, // optional: see below |
685 | 148 "VirtualAddressing": true, // optional: see the section related to MinIO |
880 | 149 "StorageEncryption" : {}, // optional: see the section related to encryption |
150 "HybridMode": "Disabled" // optional: see the section related to Hybrid storage | |
451 | 151 } |
152 | |
464 | 153 The **EndPoint** configuration is used when accessing an S3 compatible cloud provider. I.e. here is a configuration to store data on Scaleway:: |
154 | |
155 "AwsS3Storage" : { | |
156 "BucketName": "test-orthanc", | |
157 "Region": "fr-par", | |
158 "AccessKey": "XXX", | |
159 "SecretKey": "YYY", | |
160 "Endpoint": "s3.fr-par.scw.cloud" | |
505
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
161 } |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
162 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
163 |
746 | 164 .. _minio: |
165 | |
505
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
166 Emulation of AWS S3 using MinIO |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
167 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
168 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
169 .. highlight:: bash |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
170 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
171 The `MinIO project <https://min.io/>`__ can be used to emulate AWS S3 |
507
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
172 for local testing/prototyping. Here is a sample command to start a |
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
173 MinIO server on your local computer using Docker (evidently, make sure |
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
174 to set different credentials):: |
505
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
175 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
176 $ docker run -p 9000:9000 \ |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
177 -e "MINIO_REGION=eu-west-1" \ |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
178 -e "MINIO_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE" \ |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
179 -e "MINIO_SECRET_KEY=wJalrXUtnFEMI/K7MNG/bPxRfiCYEXAMPLEKEY" \ |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
180 minio/minio server /data |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
181 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
182 .. highlight:: json |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
183 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
184 Note that the ``MINIO_REGION`` must be set to an arbitrary region that |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
185 is supported by AWS S3. |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
186 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
187 You can then open the URL `http://localhost:9000/ |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
188 <http://localhost:9000/>`__ with your Web browser to create a bucket, |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
189 say ``my-sample-bucket``. |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
190 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
191 Here is a corresponding full configuration for Orthanc:: |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
192 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
193 { |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
194 "Plugins" : [ <...> ], |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
195 "AwsS3Storage" : { |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
196 "BucketName": "my-sample-bucket", |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
197 "Region" : "eu-west-1", |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
198 "Endpoint": "http://localhost:9000/", |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
199 "AccessKey": "AKIAIOSFODNN7EXAMPLE", |
506 | 200 "SecretKey": "wJalrXUtnFEMI/K7MNG/bPxRfiCYEXAMPLEKEY", |
505
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
201 "VirtualAddressing" : false |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
202 } |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
203 } |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
204 |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
205 Note that the ``VirtualAddressing`` option must be set to ``false`` |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
206 for such a `local setup with MinIO to work |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
207 <https://github.com/aws/aws-sdk-cpp/issues/1425>`__. This option is |
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
208 **not** available in releases <= 1.1.0 of the AWS S3 plugin. |
507
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
209 |
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
210 **Important:** If you get the cryptic error message |
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
211 ``SignatureDoesNotMatch The request signature we calculated does not |
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
212 match the signature you provided. Check your key and signing |
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
213 method.``, this most probably indicates that your access key or your |
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
214 secret key doesn't match the credentials that were used while starting |
a51542cfdfeb
warning about minio credentials
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
506
diff
changeset
|
215 the MinIO server. |
505
e4bea5b97890
Emulation of AWS S3 using MinIO
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
504
diff
changeset
|
216 |
464 | 217 |
451 | 218 Azure Blob Storage plugin |
219 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
220 | |
221 Sample configuration:: | |
222 | |
223 "AzureBlobStorage" : { | |
224 "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=xxxxxxxxx;AccountKey=yyyyyyyy===;EndpointSuffix=core.windows.net", | |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
225 "ContainerName" : "test-orthanc-storage-plugin", |
647 | 226 "CreateContainerIfNotExists": true, // available from version 1.2.0 |
502 | 227 "RootPath": "", // see below |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
228 "MigrationFromFileSystemEnabled": false, // see below |
766
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
229 "StorageStructure": "flat", // see below |
880 | 230 "EnableLegacyUnknownFiles": true, // optional: see below |
231 "StorageEncryption" : {} // optional: see the section related to encryption | |
232 "HybridMode": "Disabled" // optional: see the section related to Hybrid storage | |
451 | 233 } |
234 | |
235 | |
236 Google Storage plugin | |
237 ^^^^^^^^^^^^^^^^^^^^^ | |
238 | |
239 Sample configuration:: | |
240 | |
241 "GoogleCloudStorage" : { | |
242 "ServiceAccountFile": "/path/to/googleServiceAccountFile.json", | |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
243 "BucketName": "test-orthanc-storage-plugin", |
502 | 244 "RootPath": "", // see below |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
245 "MigrationFromFileSystemEnabled": false, // see below |
766
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
246 "StorageStructure": "flat", // see below |
880 | 247 "EnableLegacyUnknownFiles": true, // optional: see below |
248 "StorageEncryption" : {} // optional: see the section related to encryption | |
249 "HybridMode": "Disabled" // optional: see the section related to Hybrid storage | |
451 | 250 } |
251 | |
252 | |
880 | 253 Migration & Hybrid mode Storage structure |
254 ----------------------------------------- | |
255 | |
256 Since version **2.1.0** of the plugins, an HybridMode as been introduced. | |
257 This mode allows reading/writing files from both/to the file system and the object-storage. | |
258 | |
259 By default, the ``HybridMode`` is ``Disabled``. This means that the plugins will access | |
260 only the object-storage. | |
261 | |
262 When the ``HybridMode`` is set to ``WriteToFileSystem``, it means that new files received | |
263 are store on the file system. When accessing a file, it is first read from the file system | |
264 and, if it is not found on the file system, it is read from the object-storage. | |
265 | |
266 The ``WriteToFileSystem`` hybrid mode is usefull for storing recent files on the file system for | |
267 better performance and old files on the object-storage for lower cost and easier backups. | |
268 | |
269 When the ``HybridMode`` is set to ``WriteToObjectStorage``, it means that new files received | |
270 are store on the object storage. When accessing a file, it is first read from the object storage | |
271 and, if it is not found on the object-storage, it is read from the file system. | |
272 | |
273 The ``WriteToObjectStorage`` hybrid mode is usefull mainly during a migration from file system to | |
274 object-storage, e.g, if you have deployed a VM in a cloud with local file system storage and want | |
275 to move your files to object-storage without interrupting your service. | |
276 | |
277 Moving files between file-system and object-storage | |
278 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
279 | |
280 When the ``HybridMode`` is set to ``WriteToFileSystem``, it is sometimes usefull to move old files | |
281 to the object-storage for long term archive or to `pre-fetch`` files from object-storage to file | |
282 system for improved performances e.g when before opening the study in a viewer. | |
283 | |
284 When the ``HybridMode`` is set to ``WriteToObjectStorage``, it is usefull to move file from the | |
285 file system to the object storage to perform a full data migration to object-storage. | |
286 | |
287 To move files from one storage to the other, you should call the plugin Rest API:: | |
288 | |
289 $ curl -X POST http://localhost:8042/move-storage \ | |
290 --data '{ | |
291 "Resources": ["27f7126f-4f66fb14-03f4081b-f9341db2-53925988"], | |
292 "TargetStorage": "file-system", | |
293 "Asynchronous": true, | |
294 "Priority": 0 | |
295 }' | |
296 | |
297 This call creates a ``MoveStorageJob`` that can then be monitor to the ``/jobs`` route. | |
298 | |
299 The allowed values for ``TargetStorage`` are ``file-system`` or ``object-storage``. | |
300 | |
301 | |
302 Other configuration options | |
303 --------------------------- | |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
304 |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
305 The **StorageStructure** configuration allows you to select the way objects are organized |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
306 within the storage (``flat`` or ``legacy``). |
500 | 307 Unlike the traditional file system in which Orthanc uses 2 levels |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
308 of folders, object storages usually have no limit on the number of files per folder and |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
309 therefore all objects are stored at the root level of the object storage. This is the |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
310 default ``flat`` behaviour. Note that, in the ``flat`` mode, an extension `.dcm` or `.json` |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
311 is added to the filename which is not the case in the legacy mode. |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
312 |
500 | 313 The ``legacy`` behaviour mimics the Orthanc File System convention. This is actually helpful |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
314 when migrating your data from a file system to an object storage since you can copy all the file |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
315 hierarchy as is. |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
316 |
502 | 317 The **RootPath** allows you to store the files in another folder as the root level of the |
520 | 318 object storage. Note: it shall not start with a ``/``. |
502 | 319 |
320 Note that you can not change these configurations once you've uploaded the first files in Orthanc. | |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
321 |
880 | 322 The **MigrationFromFileSystemEnabled** configuration has been superseded by the **HybridMode** in v 2.1.0. |
508 | 323 |
766
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
324 The **EnableLegacyUnknownFiles** configuration has been introduced to allow recent version of the plugins (from 1.3.3) |
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
325 continue working with data that was saved with Orthanc version around 1.9.3 and plugins version around 1.2.0 (e.g. osimis/orthanc:21.5.1 docker images). |
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
326 With these specific versions, some ``.unk`` files were generated instead of ``.dcm.head`` files. With this configuration option enabled, |
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
327 when reading files, the plugin will try both file extensions. |
73ee8a489b24
object-storage: EnableLegacyUnknownFiles
Alain Mazy <am@osimis.io>
parents:
746
diff
changeset
|
328 If you have ``.unk`` files in your storage, you must enable this configuration. |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
329 |
452 | 330 Sample setups |
331 ------------- | |
332 | |
811 | 333 You'll find sample deployments and more info in the `Orthanc Setup Samples repository <https://bitbucket.org/osimis/orthanc-setup-samples/src/master/#markdown-header-for-software-integrators>`__ . |
452 | 334 |
511
5b574520a34c
performance tests for object-storage
Alain Mazy <alain@mazy.be>
parents:
509
diff
changeset
|
335 Performances |
5b574520a34c
performance tests for object-storage
Alain Mazy <alain@mazy.be>
parents:
509
diff
changeset
|
336 ------------ |
5b574520a34c
performance tests for object-storage
Alain Mazy <alain@mazy.be>
parents:
509
diff
changeset
|
337 |
5b574520a34c
performance tests for object-storage
Alain Mazy <alain@mazy.be>
parents:
509
diff
changeset
|
338 You'll find some performance comparison between VM SSDs and object-storage `here <https://bitbucket.org/osimis/orthanc-setup-samples/src/master/docker/performance-tests/>`__ . |
5b574520a34c
performance tests for object-storage
Alain Mazy <alain@mazy.be>
parents:
509
diff
changeset
|
339 |
452 | 340 |
586
5f5519f1491a
securing the storage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
543
diff
changeset
|
341 .. _client-side-encryption: |
5f5519f1491a
securing the storage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
543
diff
changeset
|
342 |
451 | 343 Client-side encryption |
344 ---------------------- | |
345 | |
346 Although all cloud providers already provide encryption at rest, the plugins provide | |
347 an optional layer of client-side encryption . It is very important that you understand | |
348 the scope and benefits of this additional layer of encryption. | |
349 | |
350 Rationale | |
351 ^^^^^^^^^ | |
352 | |
353 Encryption at rest provided by cloud providers basically compares with a file-system disk encryption. | |
354 If someone has access to the disk, he won't have access to your data without the encryption key. | |
355 | |
356 With cloud encryption at rest only, if someone has access to the "api-key" of your storage or if one | |
357 of your admin inadvertently make your storage public, `PHI <https://en.wikipedia.org/wiki/Protected_health_information>`__ will leak. | |
358 | |
359 Once you use client-side encryption, you'll basically store packets of meaningless bytes on the cloud infrastructure. | |
360 So, if an "api-key" leaks or if the storage is misconfigured, packets of bytes will leak but not PHI since | |
361 no one will be able to decrypt them. | |
362 | |
363 Another advantage is that these packets of bytes might eventually not be considered as PHI anymore and eventually | |
364 help you meet your local regulations (Please check your local regulations). | |
365 | |
366 However, note that, if you're running entirely in a cloud environment, your decryption keys will still | |
367 be stored on the cloud infrastructure (VM disks - process RAM) and an attacker could still eventually gain access to this keys. | |
368 | |
369 If Orthanc is running in your infrastructure with the Index DB on your infrastructure, and files are store in the cloud, | |
370 the master keys will remain on your infrastructure only and there's no way the data stored in the cloud could be decrypted outside your infrastructure. | |
371 | |
372 Also note that, although the cloud providers also provide client-side encryption, we, as an open-source project, | |
373 wanted to provide our own implementation on which you'll have full control and extension capabilities. | |
374 This also allows us to implement the same logic on all cloud providers. | |
375 | |
376 Our encryption is based on well-known standards (see below). Since it is documented and the source code is open-source, | |
377 feel-free to have your security expert review it before using it in a production environment. | |
378 | |
379 Technical details | |
380 ^^^^^^^^^^^^^^^^^ | |
381 | |
382 Orthanc saves 2 kind of files: DICOM files and JSON summaries of DICOM files. Both files contain PHI. | |
383 | |
452 | 384 When configuring the plugin, you'll have to provide a **Master Key** that we can also call the **Key Encryption Key (KEK)**. |
451 | 385 |
452 | 386 For each file being saved, the plugin will generate a new **Data Encryption Key (DEK)**. This DEK, encrypted with the KEK will be pre-pended to the file. |
451 | 387 |
388 If, at any point, your KEK leaks or you want to rotate your KEKs, you'll be able to use a new one to encrypt new files that are being added | |
389 and still use the old ones to decrypt data. You could then eventually start a side script to remove usages of the leaked/obsolete KEKs. | |
390 | |
391 To summarize: | |
392 | |
452 | 393 - We use `Crypto++ <https://www.cryptopp.com/>`__ to perform all encryptions. |
451 | 394 - All keys (KEK and DEK) are AES-256 keys. |
395 - DEKs and IVs are encrypted by KEK using CTR block cipher using a null IV. | |
396 - data is encrypted by DEK using GCM block cipher that will also perform integrity check on the whole file. | |
397 | |
398 The format of data stored on disk is therefore the following: | |
399 | |
400 - **VERSION HEADER**: 2 bytes: identify the structure of the following data currently `A1` | |
401 - **MASTER KEY ID**: 4 bytes: a numerical ID of the KEK that was used to encrypt the DEK | |
402 - **EIV**: 32 bytes: IV used by DEK for data encryption; encrypted by KEK | |
403 - **EDEK**: 32 bytes: the DEK encrypted by the KEK. | |
404 - **CIPHER TEXT**: variable length: the DICOM/JSON file encrypted by the DEK | |
405 - **TAG**: 16 bytes: integrity check performed on the whole encrypted file (including header, master key id, EIV and EDEK) | |
406 | |
407 Configuration | |
408 ^^^^^^^^^^^^^ | |
409 | |
410 .. highlight:: text | |
411 | |
412 AES Keys shall be 32 bytes long (256 bits) and encoded in base64. Here's a sample OpenSSL command to generate such a key:: | |
413 | |
414 openssl rand -base64 -out /tmp/test.key 32 | |
415 | |
416 Each key must have a unique id that is a uint32 number. | |
417 | |
418 .. highlight:: json | |
419 | |
420 Here's a sample configuration file of the `StorageEncryption` section of the plugins:: | |
421 | |
422 { | |
499
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
423 "GoogleCloudStorage" : { |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
424 "StorageEncryption" : { |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
425 "Enable": true, |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
426 "MasterKey": [3, "/path/to/master.key"], // key id - path to the base64 encoded key |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
427 "PreviousMasterKeys" : [ |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
428 [1, "/path/to/previous1.key"], |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
429 [2, "/path/to/previous2.key"] |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
430 ], |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
431 "MaxConcurrentInputSize" : 1024 // size in MB |
d255e02eb89d
updated object-storage doc for 1.0.0
Alain Mazy <alain@mazy.be>
parents:
464
diff
changeset
|
432 } |
451 | 433 } |
434 } | |
435 | |
436 **MaxConcurrentInputSize**: Since the memory used during encryption/decryption can grow up to a bit more | |
437 than 2 times the input, we want to limit the number of threads doing concurrent processing according | |
438 to the available memory instead of the number of concurrent threads. Therefore, if you're currently | |
439 ingesting small files, you can have a lot of thread working together while, if you're ingesting large | |
440 files, threads might have to wait before receiving a "slot" to access the encryption module. |