Skip to content

Commit 17af12f

Browse files
AndrewThienAndrewThien
authored
Update docs aligning 3.1.0 (#23)
* update like c4 * update content for 3.1 * remove the link * clean up
1 parent 7247e57 commit 17af12f

5 files changed

Lines changed: 108 additions & 158 deletions

File tree

‎app/connect/connect-submission/page.mdx‎

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ This guide describes how to connect a TRE Agent to the Submission Layer using th
1818
- Deploy at least one TRE Agent.
1919
- Connect the TRE Agent to TES backend.
2020
- Get TRE administrator login credentials from the Submission Layer administrator to sign in to the Submission Layer.
21-
- Get the [Submission S3 admin credentials and server URLs](/co-ordinate/setup-sub-layer/configuration#s3-configuration) from the Federation Operator.
21+
- Get the Submission S3 API URL from the Federation Operator.
2222

2323
### Connect TRE Agent to Submission S3 storage:
2424

2525
<Steps>
2626

27-
#### Set the following configuration values in the TRE .env file :
27+
#### Configure TRE Agent to use Submission S3 storage:
28+
29+
Set the following configuration in the TRE .env file:
2830

2931
<Table>
3032
<thead>
@@ -34,36 +36,21 @@ This guide describes how to connect a TRE Agent to the Submission Layer using th
3436
</Table.Tr>
3537
</thead>
3638
<tbody>
37-
<Table.Tr>
38-
<Table.Td>`SubmissionS3RootUser`</Table.Td>
39-
<Table.Td>The root user for the Submission Layer S3 server.</Table.Td>
40-
</Table.Tr>
41-
<Table.Tr>
42-
<Table.Td>`SubmissionS3RootPass`</Table.Td>
43-
<Table.Td>The root password for the Submission Layer S3 server.</Table.Td>
44-
</Table.Tr>
4539
<Table.Tr>
4640
<Table.Td>`SubmissionS3ApiUrl`</Table.Td>
4741
<Table.Td>
4842
Point to Submission Layer S3 server, used by TRE Agent. For example,
4943
`http://host-of-submission-layer:9000`.
5044
</Table.Td>
5145
</Table.Tr>
52-
<Table.Tr>
53-
<Table.Td>`SubmissionS3ConsoleUrl`</Table.Td>
54-
<Table.Td>
55-
The URL for the Submission Layer's S3 admin console. For example,
56-
`http://host-of-submission-layer:9001`.
57-
</Table.Td>
58-
</Table.Tr>
5946
</tbody>
6047
</Table>
6148

6249
<Callout type="info">
6350
Once a TES submission has finished executing and the outputs have been
64-
approved by an Output checker the TRE Agent uses these configuration details
65-
to connect to the Submission S3 and copy over the outputs for the Researcher
66-
to access.
51+
approved by an Output checker, the TRE Agent uses access keys with scoped
52+
privileges (only read/write access to the target bucket) to connect to the
53+
Submission S3 and copy over the outputs for the Researcher to access.
6754
</Callout>
6855

6956
</Steps>

‎app/connect/setup-tre/configuration/page.mdx‎

Lines changed: 17 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -240,28 +240,13 @@ This section contains the environment variables that are used to configure the c
240240
(in minutes).
241241
</Table.Td>
242242
</Table.Tr>
243-
<Table.Tr>
244-
<Table.Td>`SubmissionS3RootUser`</Table.Td>
245-
<Table.Td>The root user for the Submission Layer S3 server.</Table.Td>
246-
</Table.Tr>
247-
<Table.Tr>
248-
<Table.Td>`SubmissionS3RootPass`</Table.Td>
249-
<Table.Td>The root password for the Submission Layer S3 server.</Table.Td>
250-
</Table.Tr>
251243
<Table.Tr>
252244
<Table.Td>`SubmissionS3ApiUrl`</Table.Td>
253245
<Table.Td>
254246
Point to Submission Layer S3 server, used by TRE Agent. For example,
255247
`http://host-of-submission-layer:9000`.
256248
</Table.Td>
257249
</Table.Tr>
258-
<Table.Tr>
259-
<Table.Td>`SubmissionS3ConsoleUrl`</Table.Td>
260-
<Table.Td>
261-
The URL for the Submission Layer's S3 admin console. For example,
262-
`http://host-of-submission-layer:9001`.
263-
</Table.Td>
264-
</Table.Tr>
265250
<Table.Tr>
266251
<Table.Td>`SUBMISSION_KEYCLOAK_URL`</Table.Td>
267252
<Table.Td>
@@ -278,6 +263,16 @@ This section contains the environment variables that are used to configure the c
278263
`http://host-of-submission-layer:5034`.
279264
</Table.Td>
280265
</Table.Tr>
266+
<Table.Tr>
267+
<Table.Td>`SubmissionAPIKeyCloakSecret`</Table.Td>
268+
<Table.Td>
269+
The OpenID secret for the Submission API Keycloak client
270+
`Dare-Control-API`. Find and regenerate this secret by navigating to
271+
`Dare-Control` realm -> `Clients` -> `Dare-Control-API` ->
272+
`Credentials`. Then click `Regenerate` and copy the new value into this
273+
environment variable.
274+
</Table.Td>
275+
</Table.Tr>
281276
</tbody>
282277
</Table>
283278

@@ -293,6 +288,13 @@ This section contains the environment variables that are used to configure the O
293288
</Table.Tr>
294289
</thead>
295290
<tbody>
291+
<Table.Tr>
292+
<Table.Td>`EgressKeyCloakClientUIRedirectURL`</Table.Td>
293+
<Table.Td>
294+
The URL for the Egress Layer's Keycloak redirect URL. For example,
295+
`http://localhost:8100/` or `https://egress-keycloak.example.com/`.
296+
</Table.Td>
297+
</Table.Tr>
296298
<Table.Tr>
297299
<Table.Td>`TRES3OpenidSecret`</Table.Td>
298300
<Table.Td>
@@ -302,13 +304,6 @@ This section contains the environment variables that are used to configure the O
302304
`Clients` -> `Dare-TRE-S3` -> `Credentials`. Then click `Regenerate`
303305
and copy the new value into this environment variable.
304306
</Table.Td>
305-
</Table.Tr>
306-
<Table.Tr>
307-
<Table.Td>`EgressKeyCloakClientUIRedirectURL`</Table.Td>
308-
<Table.Td>
309-
The URL for the Egress Layer's Keycloak redirect URL. For example,
310-
`http://localhost:8100/` or `https://egress-keycloak.example.com/`.
311-
</Table.Td>
312307
</Table.Tr>
313308
<Table.Tr>
314309
<Table.Td>`EgressKeyCloakSecret`</Table.Td>
@@ -319,30 +314,6 @@ This section contains the environment variables that are used to configure the O
319314
and copy the new value into this environment variable.
320315
</Table.Td>
321316
</Table.Tr>
322-
<Table.Tr>
323-
<Table.Td>`SubmissionAPIKeyCloakClientUIRedirectURL`</Table.Td>
324-
<Table.Td>
325-
The URL for the Submission API's Keycloak redirect URL. For example,
326-
`http://host-of-submission-layer:8989/`.
327-
</Table.Td>
328-
</Table.Tr>
329-
<Table.Tr>
330-
<Table.Td>`SubmissionAPIKeyCloakSecret`</Table.Td>
331-
<Table.Td>
332-
The OpenID secret for the Submission API Keycloak client
333-
`Dare-Control-API`. Find and regenerate this secret by navigating to
334-
`Dare-Control` realm -> `Clients` -> `Dare-Control-API` ->
335-
`Credentials`. Then click `Regenerate` and copy the new value into this
336-
environment variable.
337-
</Table.Td>
338-
</Table.Tr>
339-
<Table.Tr>
340-
<Table.Td>`TreKeyCloakClientUIRedirectURL`</Table.Td>
341-
<Table.Td>
342-
The URL for the TRE UI's Keycloak redirect URL. For example,
343-
`http://host-of-tre:8989/`.
344-
</Table.Td>
345-
</Table.Tr>
346317
<Table.Tr>
347318
<Table.Td>`TreKeyCloakSecret`</Table.Td>
348319
<Table.Td>
@@ -352,13 +323,6 @@ This section contains the environment variables that are used to configure the O
352323
value into this environment variable.
353324
</Table.Td>
354325
</Table.Tr>
355-
<Table.Tr>
356-
<Table.Td>`TreAPIKeyCloakClientUIRedirectURL`</Table.Td>
357-
<Table.Td>
358-
The URL for the TRE API's Keycloak redirect URL. For example,
359-
`http://localhost:8989/`.
360-
</Table.Td>
361-
</Table.Tr>
362326
<Table.Tr>
363327
<Table.Td>`TreAPIKeyCloakSecret`</Table.Td>
364328
<Table.Td>

‎app/connect/setup-tre/deployment-steps/page.mdx‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -231,9 +231,9 @@ You are highly recommended to change the passwords for the services by the envir
231231
</Table.Td>
232232
</Table.Tr>
233233
<Table.Tr>
234-
<Table.Td>`EnableExternalHangfire`, `HangfireUser`, `HangfirePassword` </Table.Td>
234+
<Table.Td>`HangfireUser`, `HangfirePassword` </Table.Td>
235235
<Table.Td>
236-
Configure Hangfire with `EnableExternalHangfire` (default is true) & set the login credentials.
236+
The login credentials for Hangfire.
237237
</Table.Td>
238238
</Table.Tr>
239239
<Table.Tr>
@@ -244,12 +244,8 @@ You are highly recommended to change the passwords for the services by the envir
244244
</Table.Td>
245245
</Table.Tr>
246246
<Table.Tr>
247-
<Table.Td>`TRES3RootUser`</Table.Td>
248-
<Table.Td>The admin user for the TRE S3 server.</Table.Td>
249-
</Table.Tr>
250-
<Table.Tr>
251-
<Table.Td>`TRES3RootPass`</Table.Td>
252-
<Table.Td>The admin password for the TRE S3 server.</Table.Td>
247+
<Table.Td>`TRES3RootUser, TRES3RootPass`</Table.Td>
248+
<Table.Td>The root user and password for the TRE S3 server.</Table.Td>
253249
</Table.Tr>
254250
</tbody>
255251
</Table>

0 commit comments

Comments
 (0)