创建、删除和管理 Docker Compose 应用程序。
指令
| 命令 | 说明 |
|---|---|
| 创建 | 创建服务Fabric撰写部署。 |
| 列表 | 获取在服务Fabric群集中创建的撰写部署的列表。 |
| 删除 | 从群集中删除现有服务Fabric撰写部署。 |
| 状态 | 获取有关服务Fabric撰写部署的信息。 |
| 升级 | 开始在服务Fabric群集中升级撰写部署。 |
| upgrade-rollback | 开始在服务Fabric群集中回滚撰写部署升级。 |
| upgrade-status | 获取对此服务执行的最新升级的详细信息Fabric撰写部署。 |
sfctl compose create
创建服务Fabric撰写部署。
Arguments
| 论点 | 说明 |
|---|---|
| --deployment-name [必需] | 部署的名称。 |
| --file-path [必需] | 目标 Docker Compose 文件的路径。 |
| --encrypted-pass | 使用已加密的通行短语,而不是提示输入容器注册表密码。 |
| --has-pass | 将提示输入容器注册表的密码。 |
| --timeout -t | 默认值:60。 |
| --用户 | 用于连接到容器注册表的用户名。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl compose 列表
获取在服务Fabric群集中创建的撰写部署的列表。
获取有关创建或正在服务Fabric群集中创建的撰写部署的状态。 响应包括有关撰写部署的名称、状态和其他详细信息。 如果部署列表不适合在页面中,则会返回一页结果,并返回一个继续标记,该标记可用于获取下一页。
Arguments
| 论点 | 说明 |
|---|---|
| --continuation-token | 延续标记参数用于获取下一组结果。 当系统的结果不适合单个响应时,API 响应中将包含具有无空值的延续令牌。 当此值传递给下一个 API 调用时,API 将返回下一组结果。 如果没有进一步的结果,则继续标记不包含值。 不应对此参数的值进行 URL 编码。 |
| --max-results | 作为分页查询的一部分返回的最大结果数。 此参数定义返回的结果数的上限。 如果返回的结果不符合配置中定义的最大消息大小限制,则返回的结果可能小于指定的最大结果。 如果此参数为零或未指定,则分页查询将包含尽可能多的结果,这些结果适合返回消息。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl compose remove
从群集中删除现有服务Fabric撰写部署。
删除现有服务Fabric撰写部署。
Arguments
| 论点 | 说明 |
|---|---|
| --deployment-name [必需] | 部署的标识。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl compose 状态
获取有关服务Fabric撰写部署的信息。
返回创建或正在服务Fabric群集中创建的撰写部署的状态,其名称与指定为参数的部署匹配。 响应包括有关部署的名称、状态和其他详细信息。
Arguments
| 论点 | 说明 |
|---|---|
| --deployment-name [必需] | 部署的标识。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl compose 升级
开始在服务Fabric群集中升级撰写部署。
验证提供的升级参数,并在参数有效时开始升级部署。
Arguments
| 论点 | 说明 |
|---|---|
| --deployment-name [必需] | 部署的名称。 |
| --file-path [必需] | 目标 Docker compose 文件的路径。 |
| --default-svc-type-health-map | 描述用于评估服务运行状况的运行状况策略的 JSON 编码字典。 |
| --encrypted-pass | 使用已加密的通行短语,而不是提示输入容器注册表密码。 |
| --failure-action | 可能的值包括:“Invalid”、“Rollback”、“Manual”。 |
| --force-restart | 即使在代码版本未更改的情况下,升级期间也会强制重启进程。 升级仅更改配置或数据。 |
| --has-pass | 将提示输入容器注册表的密码。 |
| --health-check-retry | 尝试执行运行状况检查(如果应用程序或群集不正常)之间的时间长度。 |
| --health-check-stable | 在升级继续到下一个升级域之前,应用程序或群集必须保持正常运行的时间量。 它首先解释为表示 ISO 8601 持续时间的字符串。 如果失败,则会将其解释为表示总毫秒数的数字。 |
| --health-check-wait | 完成升级域后等待的时间长度,然后再启动运行状况检查过程。 |
| --replica-set-check | 阻止处理升级域的最大时间,并在出现意外问题时防止可用性丢失。 当此超时过期时,无论可用性丢失问题如何,升级域的处理都会继续。 超时是在每个升级域的开头重置的。 有效值介于 0 和 42949672925 之间( 非独占)。 |
| --svc-type-health-map | 描述用于评估不同服务类型的运行状况的运行状况策略的对象 JSON 编码列表。 |
| --timeout -t | 默认值:60。 |
| --unhealthy-app | 报告错误之前允许的最大不正常应用程序的百分比。 例如,若要允许 10 个应用程序% 运行不正常,此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的应用程序的最大允许百分比。 如果遵循百分比,但至少有一个不正常的应用程序,则运行状况将评估为“警告”。 这是通过将不正常的应用程序数除以群集中应用程序实例总数来计算的。 |
| --upgrade-domain-timeout | 执行 FailureAction 之前,每个升级域必须完成的时间。 它首先解释为表示 ISO 8601 持续时间的字符串。 如果失败,则会将其解释为表示总毫秒数的数字。 |
| --upgrade-kind | 默认值:滚动。 |
| --upgrade-mode | 可能的值包括:“Invalid”、“UnmonitoredAuto”、“UnmonitoredManual”、“Monitored”。 默认值:UnmonitoredAuto。 |
| --upgrade-timeout | 在执行 FailureAction 之前,整个升级必须完成的时间量。 它首先解释为表示 ISO 8601 持续时间的字符串。 如果失败,则会将其解释为表示总毫秒数的数字。 |
| --用户 | 用于连接到容器注册表的用户名。 |
| --warning-as-error | 指示是否以与错误相同的严重性处理警告。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl compose upgrade-rollback
开始在服务Fabric群集中回滚撰写部署升级。
回滚 Service Fabric 撰写部署升级。
Arguments
| 论点 | 说明 |
|---|---|
| --deployment-name [必需] | 部署的标识。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl compose upgrade-status
获取对此服务执行的最新升级的详细信息Fabric撰写部署。
返回有关撰写部署升级状态的信息,以及帮助调试应用程序运行状况问题的详细信息。
Arguments
| 论点 | 说明 |
|---|---|
| --deployment-name [必需] | 部署的标识。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |