部署

使用指定的组件配方、构件和运行时参数创建或更新本地部署。

摘要

greengrass-cli deployment create 
    --recipeDir path/to/component/recipe
    [--artifactDir path/to/artifact/folder ]
    [--update-config {component-configuration}]
    [--groupId <thing-group>]
    [--merge "<component-name>=<component-version>"]...
    [--runWith "<component-name>:posixUser=<user-name>[:<group-name>]"]...
    [--systemLimits "{component-system-resource-limits}]"]...
    [--remove <component-name>,...]
    [--failure-handling-policy <policy name[ROLLBACK, DO_NOTHING]>]

Arguments (参数)

• --recipeDir，-r。 包含组件配方文件的文件夹的完整路径。

• --artifactDir，-a。 包含要包含在部署中的构件文件的文件夹的完整路径。构件文件夹必须包含以下目录结构：

  /path/to/artifact/folder/<component-name>/<component-version>/<artifacts>

• --update-config，-c。 部署的配置参数，以 JSON 字符串或 JSON 文件形式提供。JSON 字符串应采用以下格式：

  { \
    "componentName": { \ 
      "MERGE": {"config-key": "config-value"}, \
      "RESET": ["path/to/reset/"] \
    } \
  }

  MERGE和区RESET分大小写并且必须为大写字母。

• --groupId，-g。 部署的目标事物组。

• --merge，-m。 要添加或更新的目标组件的名称和版本。必须以格式提供组件信息<component>=<version>。为每个要指定的其他组件使用单独的参数。如果需要，可使用--runWith参数提供posixUserposixGroup、和用于运行组件windowsUser的信息。

• --runWith。 posixUserposixGroup、和用于运行通用组件或 Lambda 组件windowsUser的信息。您必须按以下格式提供此信息<component>:{posixUser|windowsUser}=<user>[:<=posixGroup>]。例如，您可以指定HelloWorld:posixUser=ggc_user:ggc_group或HelloWorld:windowsUser=ggc_user。为每个其他选项使用单独的参数进行指定。

  有关更多信息，请参阅 配置运行组件的用户。

• --systemLimits。 适用于核心设备上的通用和非容器化 Lambda 组件进程的系统资源限制。您可以配置每个组件的进程可以使用的最大 CPU 和 RAM 使用量。指定序列化的 JSON 对象或 JSON 文件的文件路径。JSON 对象必须采用以下格式。

  {  \
    "componentName": { \ 
      "cpus": cpuTimeLimit, \
      "memory": memoryLimitInKb \
    } \
  }

  您可以为每个组件配置以下系统资源限制：

  • cpus— 此组件的进程可以在核心设备上使用的最大 CPU 时间。核心设备的总 CPU 时间等于 CPU 核心的设备数量。例如，在具有 4 个 CPU 内核的核心设备上，您可以将此值设置为，2将该组件的进程使用率限制为每个 CPU 内核的 50%。在具有 1 个 CPU 内核的设备上，您可以将此值设置为，0.25将此组件的进程使用率限制在 25% 以内。如果将此值设置为大于 CPU 内核数的数字，则 Amazon IoT Greengrass Core 软件不会限制组件的 CPU 使用率。

  • memory— 此组件的进程可以在核心设备上使用的最大 RAM 量（以千字节为单位）。

  有关更多信息，请参阅 为组件配置系统资源限制。

  此功能适用于 Linux 核心设备上的 Greengrass n ucleus 组件和 Greengrass CLI 的 v2.4.0 及更高版本。 Amazon IoT Greengrass 目前不支持在 Windows 核心设备上使用此功能。

• --remove。 要从本地部署中移除的目标组件的名称。要移除已从云部署中合并的组件，必须按以下格式提供目标事物组的群组 ID：

  Greengrass nucleus v2.4.0 and later

  --remove <component-name> --groupId <group-name>

  Earlier than v2.4.0

  --remove <component-name> --groupId thinggroup/<group-name>

• --failure-handling-policy。 定义部署失败时采取的操作。您可以指定两个操作：

  • ROLLBACK –

  • DO_NOTHING –

  此功能适用于 v2.11.0 及更高版本。Greengrass 核

输出

以下示例显示了运行此命令时生成的输出。

$ sudo greengrass-cli deployment create \
    --merge MyApp1=1.0.0 \
    --merge MyApp2=1.0.0 --runWith MyApp2:posixUser=ggc_user \
    --remove MyApp3 \
    --recipeDir recipes/ \ 
    --artifactDir artifacts/

Local deployment has been submitted! Deployment Id: 44d89f46-1a29-4044-ad89-5151213dfcbc

摘要

greengrass-cli deployment cancel
    -i <deployment-id>

参数

-i。 要取消的部署的唯一标识符。部署 ID 将在create命令的输出中返回。

输出

• 无

摘要

greengrass-cli deployment list

Arguments (参数)

无

输出

以下示例显示了运行此命令时生成的输出。根据您的部署状态，输出显示以下状态值之一：IN_PROGRESSSUCCEEDED、或FAILED。

$ sudo greengrass-cli deployment list

44d89f46-1a29-4044-ad89-5151213dfcbc: SUCCEEDED
Created on: 6/27/23 11:05 AM

摘要

greengrass-cli deployment status -i <deployment-id>

Arguments (参数)

-i。 部署的 ID。

输出

以下示例显示了运行此命令时生成的输出。根据您的部署状态，输出显示以下状态值之一：IN_PROGRESSSUCCEEDED、或FAILED。

$ sudo greengrass-cli deployment status -i 44d89f46-1a29-4044-ad89-5151213dfcbc

44d89f46-1a29-4044-ad89-5151213dfcbc: FAILED
Created on: 6/27/23 11:05 AM
Detailed Status: <Detailed deployment status>
Deployment Error Stack: List of error codes
Deployment Error Types: List of error types
Failure Cause: Cause