21841: Add system properties 'workflowName' and 'container'
authorPeter Amstutz <peter.amstutz@curii.com>
Mon, 3 Jun 2024 15:36:21 +0000 (11:36 -0400)
committerPeter Amstutz <peter.amstutz@curii.com>
Mon, 3 Jun 2024 15:36:21 +0000 (11:36 -0400)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

doc/api/properties.html.textile.liquid
sdk/go/arvados/vocabulary.go

index 175c59b8c4012f680558f9eeacabbd81e9c5ac17..f748e7ddc6427f76efa5d25b31d51d1c7e6be89d 100644 (file)
@@ -40,9 +40,11 @@ table(table table-bordered table-condensed).
 |container_request|collection|string|The UUID of the container request that produced an output or log collection.|
 |docker-image-repo-tag|collection|string|For collections containing a Docker image, the repo/name:tag identifier|
 |container_uuid|collection|string|The UUID of the container that produced a collection (set on collections with type=log)|
+|container|collection|string|(legacy) The UUID of the container that produced a collection.  Set on intermediate collections created by arvados-cwl-runner.  Starting with Arvados 2.6.0 a-c-r uses @container_uuid@ instead, but older versions of a-c-r may still set the @container@ property.|
 |cwl_input|container_request|object|On an intermediate container request, the CWL workflow-level input parameters used to generate the container request|
 |cwl_output|container_request|object|On an intermediate container request, the CWL workflow-level output parameters collected from the container request|
 |template_uuid|container_request|string|For a workflow runner container request, the workflow record that was used to launch it.|
+|workflowName|container_request|string|For a workflow runner container request, the "name" of the workflow record in @template_uuid@ at the time of launch (used for display only).|
 |username|link|string|For a "can_login":permission-model.html#links permission link, the unix username on the VM that the user will have.|
 |groups|link|array of string|For a "can_login":permission-model.html#links permission link, the unix groups on the VM that the user will be added to.|
 |image_timestamp|link|string|When resolving a Docker image name and multiple links are found with @link_class=docker_image_repo+tag@ and same @link_name@, the @image_timestamp@ is used to determine precedence (most recent wins).|
index 1df43b5fb8f1ebc92fa8ffa8f8317badeb2513a1..adde25cd92b1e5244c58170748b9aa1dd0b744d1 100644 (file)
@@ -35,15 +35,33 @@ func (v *Vocabulary) systemTagKeys() map[string]bool {
                // Collection keys - set by arvados-cwl-runner
                "container_request": true,
                "container_uuid":    true,
-               "type":              true,
+
+               // legacy Collection key, set by arvados-cwl-runner,
+               // was changed to container_uuid in Arvados 2.6.0 but
+               // still gets set if an older version of a-c-r is
+               // used.
+               "container": true,
+
+               // Set by several components to indicate the intended
+               // role of a collection
+               "type": true,
+
                // Collection keys - set by arv-keepdocker (on the way out)
                "docker-image-repo-tag": true,
+
                // Container request keys - set by arvados-cwl-runner
-               "cwl_input":     true,
-               "cwl_output":    true,
+               "cwl_input":  true,
+               "cwl_output": true,
+
+               // Container request key set alongside by Workbench 2
+               // to link to the Workflow definition used to launch
+               // the workflow
                "template_uuid": true,
+               "workflowName":  true,
+
                // Group keys
                "filters": true,
+
                // Link keys
                "groups":          true,
                "image_timestamp": true,