红帽全球峰会7.5. 创建无服务器工作流时的最佳实践
按照基于 Serverless 工作流特定语言(DSL)原则的这些最佳实践，创建有效的无服务器工作流来设计、处理数据和管理错误。这些原则可帮助您构建强大的工作流。
- 工作流设计原则
Serverless 工作流 DSL 优先选择在编写工作流时清晰和易用性。
- 行为的优先级
- 在开发工作流或 API 时，请确保需要作者（工作流写入器）。该行为按照以下顺序进行优先级排序： Authors > Operators > implementedors > Specifications writers。
- Linguistic fluency 和 clarity
-
使用 call、
Emit、for、fork、Raise、运行、设置、切换和Wait等操作。这些简单、通用理解的术语使您的工作流易于阅读和理解。
-
使用 call、
- 结构和可扩展性
- 使用隐式默认行为来减少冗余。
- 如果组件不可重复使用，则声明组件内联，以保持自包含的定义。
- 使用外部引用导入和重复使用共享组件，可促进模块化设计。
- 优先选择更严格的枚举的灵活性，以确保在不同运行时环境之间具有可扩展性和适应性。
- 数据流和运行时管理
-
控制数据流对于高效的工作流至关重要。任务是工作流的基本计算单元。域特定语言(DSL)定义运行时必须执行的几个默认任务类型。其中包括
Do,Listen,Raise,Run,Try, 和Wait。 - 安全性和错误处理
- Secrets
- 请谨慎使用 Secret。避免在调用输入中直接传递它们，因为这可能会公开敏感信息。
- 容错和错误处理
- Serverless 工作流设计时具有恢复故障的弹性。
- Orchestrator UI 集成最佳实践
要使工作流结果有效地显示在 Orchestrator UI 中，并便于工作流链，您必须根据
WorkflowResult模式构建输出数据。另外，包括任何错误信息作为工作流输出的一部分，以便 UI 和后续工作流可以相应地处理它们。- 工作流输出模式
- 结果放置
-
用于后续处理的主要输出必须放在
data.result属性下。 - 模式参考
-
您的输出架构文件(
schemas/workflow-output-schema.json)必须引用 workflowResult模式。 - 输出定义
在工作流定义中包含
outputs部分。本节包含 UI 将显示的人类可读键/值对。工作流结构：
id: my-workflow version: "0.8" specVersion: "0.8" name: My Workflow start: ImmediatelyEnd dataInputSchema: schemas/basic__main-schema.json extensions: - extensionid: workflow-output-schema outputSchema: schemas/workflow-output-schema.json functions: - name: print type: custom operation: sysout - name: successResult type: expression operation: '{ "result": { "message": "Project " + .projectName + " active", "outputs":[] } }' start: "successResult" states: - name: successResult type: operation actions: - name: setOutput functionRef: refName: successResult end: true
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}