View a markdown version of this page

创建工作流程版本 - AWS HealthOmics

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

创建工作流程版本

创建工作流程的新版本时,需要为新版本指定配置值。它不继承工作流程中的任何配置值。

创建版本时,请提供此工作流程唯一的版本名称。之后你无法更改名字 HealthOmics 创建版本。

版本名称必须以字母或数字开头,并且可以包括大写和小写字母、数字、连字符、句点和下划线。最大长度为 64 个字符。例如,您可以使用简单的命名方案,例如版本 1、版本 2、版本 3。您还可以将工作流程版本与自己的内部版本控制约定进行匹配,例如 2.7.0、2.7.1、2.7.2。

(可选)使用版本描述字段添加有关此版本的注释。例如:Fix for syntax error in workflow definition。

注意

不要在版本名称中包含任何个人身份信息 (PII)。版本名称显示在工作流程版本 ARN 中。

HealthOmics 为工作流程版本分配唯一的 ARN。根据工作流程 ID 和版本名称的组合,ARN 是唯一的。

警告

删除工作流程版本后, HealthOmics 允许您为其他工作流程版本重复使用版本名称。最佳做法是不要重复使用版本名称。如果您确实重复使用名称,则工作流程和每个版本都有一个唯一的 UUID,可用作来源。

使用控制台创建工作流程版本

创建工作流程版本的步骤
  1. 打开 HealthOmics 控制台。

  2. 如果需要,打开左侧导航窗格 (≡)。选择 私人工作流程。

  3. 在 私人工作流程 页面,选择新版本的工作流程。

  4. 在 工作流程详情 页面,选择 创建新版本。

  5. 在 创建版本 页面,提供以下信息:

    1. 版本名:输入工作流程版本的名称,该名称在整个工作流程中是唯一的。

    2. 版本描述 (可选):您可以使用描述字段添加有关此版本的注释。

  6. 在 工作流程定义 面板,提供以下信息:

    1. 工作流程语言 (可选):选择工作流程版本的规范语言。否则, HealthOmics 根据工作流程定义确定语言。

    2. 对于 工作流程定义来源,选择从 a 导入定义文件夹 Git-based 存储库、Amazon S3 位置或来自本地驱动器。

      1. 对于 从存储库服务导入:

        注意

        HealthOmics 支持公共和私有存储库 GitHub, GitLab, Bitbucket, GitHub self-managed, GitLab self-managed。

        1. 选择一个 连接 连接你的 AWS 资源到外部存储库。要创建连接,请参见 连接外部代码存储库。

          注意

          客户在 TLV 区域需要在中创建连接 IAD (us-east-1) 区域用于创建工作流程。

        2. 在 完整存储库 ID,以用户身份输入您的存储库 ID-name/repo-名称。确认您有权访问此存储库中的文件。

        3. 在 来源参考 (可选),输入存储库源引用(分支、标签或提交 ID)。 HealthOmics 如果未指定源引用,则使用默认分支。

        4. 在 排除文件模式,输入文件模式以排除特定的文件夹、文件或扩展名。这有助于在导入存储库文件时管理数据大小。最多有 50 个图案,并且图案必须遵循 glob 模式语法。例如:

          1. tests/

          2. *.jpeg

          3. large_data.zip

      2. 对于 从 S3 中选择定义文件夹:

        1. 输入包含压缩工作流程定义文件夹的 Amazon S3 位置。Amazon S3 存储桶必须与工作流程位于同一区域。

        2. 如果您的账户不拥有 Amazon S3 存储桶,请输入存储桶所有者的 AWS 中的账户 ID S3 存储桶所有者的账户 ID。此信息是必需的,以便 HealthOmics 可以验证存储桶所有权。

      3. 对于 从本地源中选择定义文件夹:

        1. 输入压缩的工作流定义文件夹的本地驱动器位置。

    3. 主工作流程定义文件路径 (可选):输入从压缩的工作流定义文件夹或存储库到 main 文件。如果工作流定义文件夹中只有一个文件,或者主文件名为 “main”,则不需要此参数。

  7. 在 自述文件 (可选)面板,选择 自述文件来源 并提供以下信息:

    • 对于 从存储库服务导入,在 自述文件路径,输入存储库中 README 文件的路径。

    • 对于 从 S3 中选择文件,在 S3 中的 README 文件,输入自述文件的 Amazon S3 URI。

    • 对于 从本地源中选择文件: 在 自述文件-可选,选择 选择文件 选择要上传的 markdown (.md) 文件。

  8. 在 默认运行存储配置 面板,为使用此工作流程的运行提供默认运行存储类型和容量:

    1. 运行存储类型:选择使用静态存储还是动态存储作为临时运行存储的默认存储。默认为静态存储。

    2. 运行存储容量 (可选):对于静态运行存储类型,您可以输入此工作流程所需的默认运行存储量。此参数的默认值为 1200 GiB。当你开始运行时,你可以覆盖这些默认值。

  9. 标签 (可选):您最多可以将 50 个标签与该工作流程版本关联。

  10. 选择下一步。

  11. 在 添加工作流程参数 (可选)页面,选择 参数来源:

    1. 对于 从工作流定义文件中解析, HealthOmics 将自动解析工作流定义文件中的工作流参数。

    2. 对于 提供来自 Git 存储库的参数模板,使用存储库中参数模板文件的路径。

    3. 对于 从本地源中选择 JSON 文件,上传一个 JSON 来自本地来源的文件,用于指定参数。

    4. 对于 手动输入工作流程参数,手动输入参数名称和描述。

  12. 在 参数预览 面板,您可以查看或更改此工作流程版本的参数。如果你恢复 JSON 文件,您会丢失所做的任何本地更改。

  13. 在 容器 URI 重映射 页面,在 映射规则 面板,您可以为工作流程定义 URI 映射规则。

    对于 映射文件来源,选择以下选项之一:

    • 没有 — 无需映射规则。

    • 从 S3 中选择 JSON 文件 — 指定映射文件的 S3 位置。

    • 从本地源中选择 JSON 文件 — 指定本地设备上的映射文件位置。

    • 手动输入映射 — 在中输入注册表映射和映像映射 映射 面板。

  14. 控制台显示 映射 面板。如果选择映射源文件,控制台将显示该文件中的值。

    1. 在 注册表映射,您可以编辑映射或添加映射(最多 20 个注册表映射)。

      每个注册表映射都包含以下字段:

      • 上游注册表 URL — 上游注册表的 URI。

      • ECR 存储库前缀 — 在 Amazon ECR 私有存储库中使用的存储库前缀。

      • (可选) 上游存储库前缀 — 上游注册表中存储库的前缀。

      • (可选) ECR 账户 ID — 拥有上游容器镜像的账户的账户 ID。

      • (可选) 凭证 ARN — 包含您的注册表凭据的密钥管理器密钥的 ARN。对于亚马逊 ECR 提取缓存不支持的注册表,例如 Seqera、NVIDIA NGC、谷歌神器注册表和谷歌容器注册表是必需的。有关更多信息,请参阅 使用拉入式缓存不支持的第三方注册表。

    2. 在 图像映射,您可以编辑图像映射或添加映射(最多 100 个图像映射)。

      每个图像映射都包含以下字段:

      • 源图片 — 指定上游注册表中源图像的 URI。

      • 目标图片 — 指定私有亚马逊 ECR 注册表中相应图像的 URI。

  15. 选择下一步。

  16. 查看版本配置,然后选择 创建版本。

创建版本后,控制台将返回工作流程详细信息页面,并将新版本显示在 工作流程和版本 桌子。

使用 CLI 创建工作流程版本

您可以使用创建工作流程版本 CreateWorkflowVersion API 操作。对于可选参数, HealthOmics 使用以下默认值:

参数 默认值
Engine 根据工作流程定义确定
存储类型 STATIC
存储容量(用于静态存储) 1200 GiB
Main 根据工作流定义文件夹的内容确定。有关更多信息,请参阅 HealthOmics 工作流程定义要求。
加速器 无
标签 无

以下 CLI 示例创建了以静态存储作为默认运行存储空间的工作流程版本:

aws omics create-workflow-version \ --workflow-id 1234567 \ --version-name "my_version" \ --engine WDL \ --definition-zip fileb://workflow-crambam.zip \ --description "my version description" \ --main file://workflow-params.json \ --parameter-template file://workflow-params.json \ --storage-type='STATIC' \ --storage-capacity 1200 \ --tags example123=string \ --accelerators GPU

如果您的工作流程定义文件位于 Amazon S3 文件夹中,请使用以下命令输入该位置 definition-uri 参数而不是 definition-zip。有关更多信息,请参阅 CreateWorkflowVersion 在 AWS 中 HealthOmics API 参考。

您将收到以下回复 create-workflow-version 请求。

{ "workflowId": "1234567", "versionName": "my_version", "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567/version/3", "status": "ACTIVE", "tags": { "environment": "production", "owner": "team-alpha" }, "uuid": "0ac9a563-355c-fc7a-1b47-a115167af8a2" }

使用 SDK 创建工作流程版本

您可以使用其中一个 SDK 创建工作流程。

以下示例显示如何使用 Python SDK 创建工作流程版本

import boto3 omics = boto3.client('omics') with open('definition.zip', 'rb') as f: definition = f.read() response = omics.create_workflow_version( workflowId='1234567', versionName='my_version', requestId='my_request_1' definitionZip=definition, parameterTemplate={ ... } )

验证工作流程版本的状态

创建工作流程版本后,您可以使用验证状态并查看工作流程的其他详细信息 获取工作流程版本,如图所示。

aws omics get-workflow-version --workflow-id 9876543 --version-name "my_version"

该响应为您提供工作流程详细信息,包括状态,如下所示。

{ "workflowId": "1234567", "versionName": "3.0.0", "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567/version/3.0.0", "status": "ACTIVE", "description": ... "uuid": "0ac9a563-355c-fc7a-1b47-a115167af8a2" }

在使用此工作流程版本开始运行之前,状态必须转换为 ACTIVE。