annotate Sphinx/source/plugins/google-cloud-platform.rst @ 259:c2c436ce92d6

cont
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 27 Jun 2019 07:57:23 +0200
parents a073419272c7
children f9e7036d81d0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
254
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _google:
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 Google Cloud Platform plugin
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 ============================
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 .. contents::
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
9
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
10 Introduction
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
11 ------------
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
12
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
13 Osimis freely provides the `source code
257
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 256
diff changeset
14 <https://bitbucket.org/osimis/orthanc-gcp/src>`__ of a plugin to
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 256
diff changeset
15 interface Orthanc with the Healthcare API of `Google Cloud Platform
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
16 (GCP) <https://en.wikipedia.org/wiki/Google_Cloud_Platform>`__ through
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
17 `DICOMweb <https://www.dicomstandard.org/dicomweb/>`__.
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
18
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
19 This GCP plugin notably enables the upload of DICOM images using
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
20 STOW-RS, the querying of the cloud content using QIDO-RS, and the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
21 retrieval of remote content using WADO-RS. These operations can be
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
22 possibly scripted thanks to the REST API of Orthanc.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
23
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
24 Concretely, the GCP plugin manages the credentials to Google Cloud
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
25 Platform. It requires the official :ref:`DICOMweb plugin <dicomweb>`
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
26 to be installed. As soon as Orthanc is started, the GCP plugin
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
27 automatically acquires and refreshes the `access tokens
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
28 <https://cloud.google.com/docs/authentication/>`__, transparently
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
29 updating the remote :ref:`DICOMweb servers <dicomweb-client-config>`
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
30 that are known to the DICOMweb plugin. The access tokens can
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
31 be derived either from service accounts, or from user accounts.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
32
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
33 This page makes the assumption that you have created a Google Cloud
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
34 Platform project, in which you have enabled the `Healthcare API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
35 <https://cloud.google.com/healthcare/>`__, and in which you have
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
36 created a `DICOM store
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
37 <https://cloud.google.com/healthcare/docs/how-tos/dicom>`__.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
38
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
39 Under the hood, the GCP plugin is built on the top of the official
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
40 `Google Cloud Platform C++ Client Libraries
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
41 <https://github.com/googleapis/google-cloud-cpp>`__.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
42
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
43
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
44
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
45 Compilation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
46 -----------
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
47
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
48 .. highlight:: text
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
49
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
50 The procedure to compile the GCP plugin is similar of that for the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
51 :ref:`core of Orthanc <compiling>`. The following commands should work
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
52 on any recent UNIX-like distribution (including GNU/Linux)::
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
53
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
54 $ mkdir Build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
55 $ cd Build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
56 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
57 $ make
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
58
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
59 The compilation produces a shared library
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
60 ``OrthancGoogleCloudPlatform`` that contains the GCP
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
61 plugin. Pre-compiled binaries for Microsoft Windows `are available
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
62 <http://www.orthanc-server.com/browse.php?path=/plugin-google-cloud>`__,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
63 and are included in the `Windows installers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
64 <https://www.orthanc-server.com/download-windows.php>`__.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
65
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
66
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
67
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
68 Configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
69 -------------
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
70
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
71
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
72 Common parameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
73 ^^^^^^^^^^^^^^^^^
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
74
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
75 As explained above, the GCP plugin requires the :ref:`official
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
76 DICOMweb plugin <dicomweb>` to be installed (with version above
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
77 1.0). All the communications with Google Cloud Platform are done using
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
78 the DICOMweb plugin, and the responsibility of the GCP plugin is to
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
79 aquire and periodically refresh the access tokens whose lifetime is
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
80 limited.
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
81
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
82 Obtaining the access tokens for Google Cloud Platform necessitates a
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
83 sequence of HTTPS requests. As a consequence, the Orthanc
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
84 :ref:`configuration options <configuration>` must specify how the
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
85 authenticity of the Google servers is verified. You have two
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
86 possibilities to that end:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
87
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
88 1. Disabling the verification of the remote servers (**not recommended
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
89 in production**). This is done by setting option ``HttpsVerifyPeers``
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
90 to ``false``.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
91
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
92 2. Providing a list of `trusted Certificate Authorities (CA)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
93 <https://curl.haxx.se/docs/sslcerts.html>`__ to the HTTPS client
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
94 that is internally used by Orthanc (namely, `cURL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
95 <https://en.wikipedia.org/wiki/CURL>`__). This is done by properly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
96 setting ``HttpsVerifyPeers`` option, so that it points to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
97 containing a store of CA certificates. Depending on your operating
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
98 system, this file can be found as follows:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
99
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
100 * On Debian-based system, the standard file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
101 ``/etc/ssl/certs/ca-certificates.crt`` can be used.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
102 * On other systems, the cURL project provides `CA certificates
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
103 <https://curl.haxx.se/docs/caextract.html>`__ that are extracted
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
104 from Mozilla.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
105
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
106 Note that to debug HTTPS communications, you have the possibility of
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
107 setting the ``HttpVerbose`` configuration option of Orthanc to
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
108 ``true``. It is also useful to run Orthanc in ``--verbose`` mode
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
109 (check out :ref:`this page <log>`).
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
110
254
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111
63cc25161330 skeleton of gcp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
113 Service account
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
114 ^^^^^^^^^^^^^^^
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
115
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
116 As explained on the `Google documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
117 <https://cloud.google.com/docs/authentication/#service_accounts>`__,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
118 *"a service account is a Google account that represents an
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
119 application, as opposed to representing an end user"*. This is
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
120 presumably the most common situation in the case of Orthanc.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
121
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
122 You first have to `create a service account
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
123 <https://cloud.google.com/docs/authentication/getting-started#creating_a_service_account>`__
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
124 for your application. This will produce a JSON file (say,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
125 ``dicom-osimis.json``) that you have to store securely on the server
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
126 that will run Orthanc.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
127
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
128 .. highlight:: json
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
129
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
130 Secondly, you have to modify the :ref:`Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
131 <configuration>` in order to provide the GCP plugin with your service
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
132 account file and with the parameters of your `DICOM store
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
133 <https://cloud.google.com/healthcare/docs/how-tos/dicom>`__. Here is a
256
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 255
diff changeset
134 sample, minimalist configuration of Orthanc::
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
135
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
136 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
137 "HttpsCACertificates": "/etc/ssl/certs/ca-certificates.crt",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
138 "Plugins" : [ "." ],
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
139 "GoogleCloudPlatform" : {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
140 "Accounts": {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
141 "my-google" : {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
142 "Project" : "osimis-test",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
143 "Location" : "europe-west2",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
144 "Dataset" : "test",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
145 "DicomStore" : "dicom",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
146 "ServiceAccountFile" : "dicom-osimis.json"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
147 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
148 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
149 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
150 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
151
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
152
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
153 In this example, once the GCP plugin has succeeded to authenticate
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
154 using the service account, the DICOMweb plugin will provide access to
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
155 the cloud DICOM store at URI ``/dicom-web/servers/my-google/`` of the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
156 REST API of Orthanc.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
157
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
158
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
159 User account
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
160 ^^^^^^^^^^^^
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
161
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
162 User account is an alternative to service account, and can be used
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
163 *"when the application needs to access resources on behalf of an end
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
164 user"* (check out the `Google documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
165 <https://cloud.google.com/docs/authentication/#user_accounts>`__).
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
166
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
167 .. highlight:: json
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
168
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
169 The easiest way of setting up a user account is through the `gcloud
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
170 command-line tool <https://cloud.google.com/sdk/gcloud/>`__.
256
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 255
diff changeset
171 `Google's quick-starts
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
172 <https://cloud.google.com/sdk/docs/quickstarts>`__ explain how to
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
173 initialize the environment depending on your operating system (check
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
174 out the "Initialize the SDK" sections, which essentially boil down to
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
175 calling ``gcloud init``).
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
176
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
177
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
178 .. highlight:: bash
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
179
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
180 Once the ``gcloud init`` command-line has been invoked, you can
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
181 extract credentials to be used by Orthanc by typing the following
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
182 command::
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
183
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
184 $ gcloud auth print-access-token --format json
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
185
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
186
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
187 .. highlight:: json
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
188
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
189 This command produces JSON file containing all the required
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
190 information, that can be written to a file (say,
256
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 255
diff changeset
191 ``dicom-user.json``). Given this file, here is a sample, minimalist
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
192 configuration of Orthanc::
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
193
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
194 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
195 "HttpsCACertificates": "/etc/ssl/certs/ca-certificates.crt",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
196 "Plugins" : [ "." ],
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
197 "GoogleCloudPlatform" : {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
198 "Accounts": {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
199 "my-google" : {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
200 "Project" : "osimis-test",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
201 "Location" : "europe-west2",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
202 "Dataset" : "test",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
203 "DicomStore" : "dicom",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
204 "AuthorizedUserFile" : "dicom-osimis.json"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
205 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
206 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
207 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
208 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
209
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
210 In this example, once the GCP plugin has succeeded to authenticate
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
211 using the user account, the DICOMweb plugin will provide access to the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
212 cloud DICOM store at URI ``/dicom-web/servers/my-google/`` of the REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
213 API of Orthanc.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
214
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
215
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
216 .. highlight:: bash
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
217
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
218 Note that only 3 fields in the JSON file produced by the ``gcloud auth
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
219 print-access-token`` command are required: ``client_id``,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
220 ``client_secret``, and ``refresh_token``. Instead of using the full
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
221 JSON file, you can extract only these fields, e.g. using the `jq
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
222 <https://stedolan.github.io/jq/>`__ command-line tool::
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
223
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
224 $ gcloud auth print-access-token --format json | jq '{ AuthorizedUserClientId: .client_id, AuthorizedUserClientSecret:.client_secret, AuthorizedUserRefreshToken:.refresh_token }'
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
225 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
226 "AuthorizedUserClientId": "XXXXXXXXXX.apps.googleusercontent.com",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
227 "AuthorizedUserClientSecret": "ZmssLNXXXXXX",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
228 "AuthorizedUserRefreshToken": "1/e2ngXXXXXX"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
229 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
230
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
231
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
232 .. highlight:: json
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
233
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
234 These fields can then be copied/pasted as follows in order to create a
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
235 configuration for Orthanc that is equivalent to the one using the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
236 separate JSON file::
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
237
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
238 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
239 "HttpsCACertificates": "/etc/ssl/certs/ca-certificates.crt",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
240 "Plugins" : [ "." ],
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
241 "GoogleCloudPlatform" : {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
242 "Accounts": {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
243 "my-google" : {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
244 "Project" : "osimis-test",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
245 "Location" : "europe-west2",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
246 "Dataset" : "test",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
247 "DicomStore" : "dicom",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
248 "AuthorizedUserClientId": "XXXXXXXXXX.apps.googleusercontent.com",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
249 "AuthorizedUserClientSecret": "ZmssLNXXXXXX",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
250 "AuthorizedUserRefreshToken": "1/e2ngXXXXXX"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
251 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
252 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
253 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 254
diff changeset
254 }
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
255
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
256
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
257 Advanced options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
258 ^^^^^^^^^^^^^^^^
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
259
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
260 .. highlight:: json
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
261
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
262 Some advanced configuration options are available as well, as
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
263 summarized in this excerpt::
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
264
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
265 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
266 ...
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
267 // In seconds, must be large enough to send/receive your largest studies
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
268 // using WADO or STOW, depending on the speed of your Internet connection
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
269 "HttpTimeout" : 600,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
270
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
271 "GoogleCloudPlatform" : {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
272 ...
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
273 // Path to the URL of the GCP services
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
274 "BaseUrl" : "https://healthcare.googleapis.com/v1beta1/"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
275 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 258
diff changeset
276 }