Bug #21841
closedcheck on 'workflowName' and 'container' property keys in vocabulary
Added by Peter Amstutz 6 months ago. Updated 3 months ago.
Updated by Peter Amstutz 6 months ago
workflowName
is set by Workbench 2 when when launching a workflow (run-process-panel-actions.ts). It is the name
field of the workflow
object that gets recorded as template_uuid
and used to provide a human-friendly name instead of displaying the UUID (it could look up the record to get the current name, but doesn't.)
container
was set on intermediate collections created by older versions of arvados-cwl-runner prior to Arvados 2.6.0. This was a typo, the field should have been called "container_uuid". It was fixed in #19960.
Updated by Peter Amstutz 6 months ago
to do -> find where the built-in vocabulary validation happens and see if these are included.
Updated by Brett Smith 6 months ago
Peter Amstutz wrote in #note-3:
to do -> find where the built-in vocabulary validation happens and see if these are included.
source:sdk/go/arvados/vocabulary.go and no, they are not.
They need to be documented in source:doc/api/properties.html.textile.liquid too.
Updated by Peter Amstutz 6 months ago
21841-missing-vocab @ 931dedc97473200b7dfc7ab344eab2e249aeb169
re-run:
Updated by Peter Amstutz 6 months ago
- Target version changed from Development 2024-06-05 sprint to Development 2024-06-19 sprint
Updated by Peter Amstutz 6 months ago
21841-missing-vocab @ 7786e414318b20123a5435ea0f6403ffe95bccf7
merged main on account of a failing test.
Updated by Peter Amstutz 6 months ago
21841-missing-vocab @ 7786e414318b20123a5435ea0f6403ffe95bccf7
- All agreed upon points are implemented / addressed.
- 'workflowName' and 'container' are now documented and accounted for in the system vocabulary in
sdk/go/arvados/vocabulary.go
- 'workflowName' and 'container' are now documented and accounted for in the system vocabulary in
- Anything not implemented (discovered or discussed during work) has a follow-up story.
- n/a
- Code is tested and passing, both automated and manual, what manual testing was done is described
- passes existing tests
- Documentation has been updated.
- keys are now listed in
doc/api/properties.html.textile.liquid
- keys are now listed in
- Behaves appropriately at the intended scale (describe intended scale).
- should have no impact on scaling
- Considered backwards and forwards compatibility issues between client and server.
- this should improve compatibility for clusters that use 'strict vocabulary' as they don't need to include these Arvados system keys in their vocabulary
- Follows our coding standards and GUI style guidelines.
- yes
Updated by Brett Smith 6 months ago
Peter Amstutz wrote in #note-9:
21841-missing-vocab @ 7786e414318b20123a5435ea0f6403ffe95bccf7
My only request is that we please s/a-c-r/arvados-cwl-runner/g
in doc/api/properties.html.textile.liquid
. I'm totally fine with the abbreviation in comments and developer documentation, but I don't think it's front of mind for users, and I don't think the abbreviation really contributes to readability, so seems better to just not.
Other than that, lgtm, thanks.
Updated by Peter Amstutz 6 months ago
Brett Smith wrote in #note-10:
Peter Amstutz wrote in #note-9:
21841-missing-vocab @ 7786e414318b20123a5435ea0f6403ffe95bccf7
My only request is that we please
s/a-c-r/arvados-cwl-runner/g
indoc/api/properties.html.textile.liquid
. I'm totally fine with the abbreviation in comments and developer documentation, but I don't think it's front of mind for users, and I don't think the abbreviation really contributes to readability, so seems better to just not.
I agree 100% and would have made the same comment myself, thank you for calling that out.
Updated by Peter Amstutz 6 months ago
- Status changed from In Progress to Resolved