Container secret mounts » History » Version 11
Peter Amstutz, 01/28/2022 03:01 PM
| 1 | 1 | Tom Clegg | h1. Container secret mounts |
|---|---|---|---|
| 2 | |||
| 3 | 2 | Tom Clegg | This is a proposed modification to [[Containers API]]. |
| 4 | |||
| 5 | Add a "secret_mounts" serialized field to containers and container requests. |
||
| 6 | |||
| 7 | "secret_mounts" has the same form and behavior as "mounts", except: |
||
| 8 | * Only literal content is allowed (kind=text or kind=json) |
||
| 9 | * Current value is never returned in a container request or container API response |
||
| 10 | * Current value can be retrieved from a new API (@/arvados/v1/containers/$uuid/secret_mounts@) which must be authenticated by the container's own runtime token |
||
| 11 | 1 | Tom Clegg | * Never appears in container logs |
| 12 | * Never appears in the Arvados logs table |
||
| 13 | * Never appears in websocket updates |
||
| 14 | * Never appears in API server request logs |
||
| 15 | |||
| 16 | 6 | Tom Clegg | If a secret_mount target is below output_path in the filesystem, it is omitted from the output collection (but this is not an error). |
| 17 | 4 | Peter Amstutz | |
| 18 | 10 | Tom Clegg | It is an error to use the same mount target in a container request's @mounts@ and @secret_mounts@. |
| 19 | |||
| 20 | 3 | Peter Amstutz | For clarity, some ways in which secret_mounts behaves like mounts are: |
| 21 | 2 | Tom Clegg | * Non-identical secret_mounts disqualifies a container for reuse. The mere existence of secret_mounts does not disqualify. |
| 22 | * secret_mounts can be set via container_requests#create and container_requests#update APIs |
||
| 23 | * secret_mounts cannot be null, but can be an empty hash |
||
| 24 | * keys of secret_mounts are paths in the container's filesystem, and always begin with "/" |
||
| 25 | 5 | Peter Amstutz | |
| 26 | 7 | Tom Clegg | "secret_mounts" api response: |
| 27 | |||
| 28 | <pre><code class="json"> |
||
| 29 | { |
||
| 30 | "secret_mounts": { |
||
| 31 | 9 | Tom Clegg | "/secrets/foo": { |
| 32 | "kind": "text", |
||
| 33 | "content": "foobar\n" |
||
| 34 | } |
||
| 35 | 7 | Tom Clegg | }, |
| 36 | "_response_time_or_other_api_metadata": "..." |
||
| 37 | 1 | Tom Clegg | } |
| 38 | </code></pre> |
||
| 39 | 8 | Tom Clegg | |
| 40 | 11 | Peter Amstutz | h3. Secret environment |
| 41 | |||
| 42 | Add a "secret_environment" serialized field to containers and container requests. |
||
| 43 | |||
| 44 | "secret_environment" has the same form and behavior as "environment", except: |
||
| 45 | |||
| 46 | * Current value is never returned in a container request or container API response |
||
| 47 | * Current value can be retrieved from a new API (@/arvados/v1/containers/$uuid/secret_environment@) which must be authenticated by the container's own runtime token |
||
| 48 | <pre><code class="json"> |
||
| 49 | { |
||
| 50 | "secret_environment": { |
||
| 51 | "ACCESS_KEY": "1234" |
||
| 52 | }, |
||
| 53 | "_response_time_or_other_api_metadata": "..." |
||
| 54 | }</code></pre> |
||
| 55 | * Never appears in container logs |
||
| 56 | * Never appears in the Arvados logs table |
||
| 57 | * Never appears in websocket updates |
||
| 58 | * Never appears in API server request logs |
||
| 59 | |||
| 60 | It is an error to use the same environment variable in a container request's @environment@ and @secret_environment@. |
||
| 61 | |||
| 62 | For clarity, some ways in which secret_environment behaves like environment are: |
||
| 63 | * Non-identical secret_environment disqualifies a container for reuse. The mere existence of secret_environment does not disqualify. |
||
| 64 | * secret_environment can be set via container_requests#create and container_requests#update APIs |
||
| 65 | * secret_environment cannot be null, but can be an empty hash |
||
| 66 | * keys of secret_environment are names of environment variables |
||
| 67 | |||
| 68 | There is no support for secret command line arguments. |
||
| 69 | 8 | Tom Clegg | |
| 70 | Documentation note: Anyone who can modify a container request can access its secrets by changing the command, docker image, etc., and committing it. So be careful. |