Argo Workflows中如何从YAML文件获取并添加参数描述？

问题详情 #

我尝试用Helm模板从YAML文件读取描述，填充到Argo Workflow的参数description字段，但这个方式不生效；但同样的写法在容器中引入外部脚本却能正常工作。另外，如果有一个包含多个工作流描述的YAML文件（结构如下），怎么从中获取特定的描述内容？这个需求在Argo里是否可行？

参数描述示例（不生效的代码）

arguments:
  parameters:
  - name: param-name
    description: 
    {{ .Files.Get "files/some-description.yaml" | indent 10 }}
    value: 0

容器脚本示例（正常生效的代码）

command:
  - bash
source: |
{{ .Files.Get "files/some-script.sh" | indent 10 }}

多描述YAML示例

description1:
  "some description 1"
description2:
  "some description 2"

解决方案 #

1. 参数描述不生效的原因及修复

Argo的description字段要求是格式化的字符串，直接用.Files.Get读取YAML文件时，会保留原文件的缩进、换行甚至YAML语法符号，导致Argo解析时无法识别为合法的描述字符串。而容器的source字段用|标记支持多行原始字符串，所以同样的写法能生效。

修复方法：

• 如果some-description.yaml里是纯描述字符串（比如文件内容就是"This is a parameter description"），用trim去掉多余空格和换行后直接赋值：

arguments:
  parameters:
  - name: param-name
    description: {{ .Files.Get "files/some-description.yaml" | trim }}
    value: 0

• 如果some-description.yaml是带键的YAML结构（比如desc: "Parameter description"），先用fromYaml解析文件内容，再提取对应的值：

arguments:
  parameters:
  - name: param-name
    description: {{ (index (.Files.Get "files/some-description.yaml" | fromYaml) "desc") | trim }}
    value: 0

2. 从多描述YAML文件中获取特定内容

利用Helm的fromYaml函数将整个多描述YAML文件解析为字典，然后通过键名直接提取对应描述，完全符合Argo的要求。

示例代码：

# 先把多描述文件解析为变量，方便重复引用
{{- $descriptions := .Files.Get "files/descriptions.yaml" | fromYaml -}}
arguments:
  parameters:
  - name: param1
    description: {{ $descriptions.description1 | trim }}
    value: 0
  - name: param2
    description: {{ $descriptions.description2 | trim }}
    value: default

可行性说明

这个需求在Argo中完全可行，核心是借助Helm的模板函数（fromYaml、trim、index等）处理YAML内容，将其转化为Argo参数description字段能识别的字符串格式。只要确保最终生成的YAML中description字段是合法的字符串，Argo就能正常解析显示。

内容的提问来源于stack exchange，提问作者Krzysztof Pagacz