共用方式為

sfctl 命令集群

选择、管理和操作服务Fabric群集。

指令

命令 说明
code-versions 获取在服务Fabric群集中预配的fabric代码版本的列表。
config-versions 获取服务Fabric群集中预配的fabric配置版本的列表。
健康状况 获取服务Fabric群集的运行状况。
清单 获取服务Fabric群集清单。
operation-cancel 取消用户引起的故障操作。
operation-list 获取按提供的输入筛选的用户诱发故障操作的列表。
规定 预配服务Fabric群集的代码或配置包。
recover-system 向服务Fabric群集指示它应尝试恢复当前停滞在仲裁丢失中的系统服务。
report-health 在服务Fabric群集上发送运行状况报告。
选择 连接到服务Fabric群集终结点。
show-connection 显示此 sfctl 实例连接到的群集Fabric服务。
取消预配 取消预配服务Fabric群集的代码或配置包。
升级 开始升级服务Fabric群集的代码或配置版本。
upgrade-resume 使群集升级继续转到下一个升级域。
upgrade-rollback 回滚服务Fabric群集的升级。
upgrade-status 获取当前群集升级的进度。
upgrade-update 更新服务Fabric群集升级的升级参数。

sfctl cluster code-versions

获取在服务Fabric群集中预配的fabric代码版本的列表。

获取有关群集中预配的构造代码版本的信息列表。 参数 CodeVersion 可用于选择性地将输出筛选为仅该特定版本。

Arguments

论点 说明
--code-version 服务Fabric的产品版本。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster config-versions

获取服务Fabric群集中预配的fabric配置版本的列表。

获取有关群集中预配的构造配置版本的信息列表。 参数 ConfigVersion 可用于选择性地将输出筛选为仅该特定版本。

Arguments

论点 说明
--config-version 服务Fabric的配置版本。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster health

获取服务Fabric群集的运行状况。

使用 EventsHealthStateFilter 根据运行状况筛选针对群集报告的运行状况事件的集合。 同样,使用 NodesHealthStateFilter 和 ApplicationsHealthStateFilter 根据节点的聚合运行状况筛选返回的节点和应用程序的集合。

Arguments

论点 说明
--applications-health-state-filter 允许根据群集运行状况查询的结果筛选返回的应用程序运行状况对象。 此参数的可能值包括从成员获取的整数值或 HealthStateFilter 枚举成员的按位操作。 仅返回与筛选器匹配的应用程序。 所有应用程序都用于评估聚合运行状况。 如果未指定,则返回所有条目。 状态值是基于标志的枚举,因此该值可以是使用按位“OR”运算符获取的这些值的组合。 例如,如果提供的值为 6,则返回 HealthState 值为 OK (2) 和 Warning (4) 的应用程序的运行状况状态。
- 默认值 - 默认值。 匹配任何 HealthState。 值为零。
- None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。
- 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
- 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
- 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
- All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。
--events-health-state-filter 允许筛选基于运行状况返回的 HealthEvent 对象的集合。 此参数的可能值包括以下运行状况状态之一的整数值。 仅返回与筛选器匹配的事件。 所有事件都用于评估聚合的运行状况状态。 如果未指定,则返回所有条目。 状态值是基于标志的枚举,因此该值可以是使用按位“OR”运算符获取的这些值的组合。 例如,如果提供的值为 6,则返回 HealthState 值为 OK (2) 和 Warning (4) 的所有事件。
- 默认值 - 默认值。 匹配任何 HealthState。 值为零。
- None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。
- 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
- 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
- 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
- All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。
--exclude-health-statistics 指示健康统计数据是否应作为查询结果的一部分返回。 默认情况下为 False。 统计数据显示健康状态为OK、警告和错误的儿童实体数量。
--include-system-application-health-statistics 指示运行状况统计信息是否应包括 fabric:/System 应用程序运行状况统计信息。 默认情况下为 False。 如果 IncludeSystemApplicationHealthStatistics 设置为 true,则运行状况统计信息包括属于 fabric:/System 应用程序的实体。 否则,查询结果仅包括用户应用程序的运行状况统计信息。 运行状况统计信息必须包含在要应用的此参数的查询结果中。
--nodes-health-state-filter 允许根据群集运行状况查询的结果中返回的节点运行状况对象进行筛选。 此参数的可能值包括以下运行状况状态之一的整数值。 仅返回与筛选器匹配的节点。 所有节点用于评估聚合运行状况。 如果未指定,则返回所有条目。 状态值是基于标志的枚举,因此该值可以是使用按位“OR”运算符获取的这些值的组合。 例如,如果提供的值为 6,则返回 HealthState 值为 OK (2) 和 Warning (4) 的节点的运行状况状态。
- 默认值 - 默认值。 匹配任何 HealthState。 值为零。
- None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。
- 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
- 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
- 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
- All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster manifest

获取服务Fabric群集清单。

获取服务Fabric群集清单。 群集清单包含群集的属性,这些属性包括群集上的不同节点类型、安全配置、故障和升级域拓扑等。部署独立群集时,这些属性被指定为ClusterConfig.JSON文件的一部分。 但是,群集清单中的大部分信息都是在其他部署方案中的群集部署期间由 Service Fabric 在内部生成的(例如,使用Azure门户时)。 群集清单的内容仅供参考,用户不应依赖文件内容的格式或其解释。

Arguments

论点 说明
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster operation-cancel

取消用户引起的故障操作。

以下 API 使用 CancelOperation 启动可取消的故障操作:StartDataLoss、StartQuorumLoss、StartPartitionRestart、StartNodeTransition。 如果强制为 false,则指定的用户诱发操作会正常停止。 如果 force 为 true,则命令已中止,并且某些内部状态可能被抛在后面。 应谨慎使用强制设置为 true。 除非在强制设置为 true 的同一测试命令上调用此 API(强制设置为 false),否则除非测试命令已具有 OperationState.RollingBack 的 OperationState,否则不允许调用此 API。 说明:OperationState.RollingBack 表示系统将/正在清理由执行命令引起的内部系统状态。 如果测试命令导致数据丢失,则不会还原数据。 例如,如果调用 StartDataLoss 然后调用此 API,则系统只会从运行命令中清除内部状态。 如果命令进展得足够远,无法还原目标分区的数据,从而导致数据丢失。 重要说明:如果使用 force==true 调用此 API,则内部状态可能保留。

Arguments

论点 说明
--operation-id [必需] 标识此 API 调用的 GUID。 这会传递到相应的 GetProgress API。
--力 指示是否通过执行用户诱发操作来正常回滚和清理修改的内部系统状态。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster operation-list

获取按提供的输入筛选的用户诱发故障操作的列表。

获取按提供的输入筛选的用户诱发故障操作的列表。

Arguments

论点 说明
--state-filter 用于筛选 OperationState 的用户诱发操作。 - 65535 - 全选 - 1 - 选择“正在运行” - 2 - 选择“滚动回 - 8 - 选择已完成 - 16 - 选择故障 - 32 - 选择已取消 - 64 - 选择 ForceCancelled。 默认值:65535。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。
--type-filter 用于筛选 OperationType 以获取用户诱发的操作。 - 65535 - 全选 - 1 - 选择 PartitionDataLoss。 - 2 - 选择 PartitionQuorumLoss。 - 4 - 选择 PartitionRestart。 - 8 - 选择 NodeTransition。 默认值:65535。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster provision

预配服务Fabric群集的代码或配置包。

验证和预配服务Fabric群集的代码或配置包。

Arguments

论点 说明
--cluster-manifest-file-path 群集清单文件路径。
--code-file-path 群集代码包文件路径。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster recover-system

向服务Fabric群集指示它应尝试恢复当前停滞在仲裁丢失中的系统服务。

向服务Fabric群集指示它应尝试恢复当前停滞在仲裁丢失中的系统服务。 仅当已知无法恢复关闭的副本时,才应执行此操作。 使用此 API 不正确可能会导致潜在的数据丢失。

Arguments

论点 说明
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster report-health

在服务Fabric群集上发送运行状况报告。

在服务Fabric群集上发送运行状况报告。 报告必须包含有关其报告的运行状况报告源和属性的信息。 报告将发送到服务Fabric网关节点,该节点将转发到运行状况存储。 网关可能接受报告,但在进行额外验证后,运行状况存储会拒绝该报告。 例如,运行状况存储可能会因为参数无效而拒绝报告,例如过时的序列号。 若要查看报表是否在运行状况存储中应用,请运行 GetClusterHealth 并检查该报表是否显示在 HealthEvents 部分中。

Arguments

论点 说明
--health-property [必需] 运行状况信息的属性。

实体可以具有不同属性的运行状况报告。 该属性是一个字符串,而不是固定枚举,使记者能够灵活地对触发报表的状态条件进行分类。 例如,具有 SourceId“LocalWatchdog”的记者可以监视节点上可用磁盘的状态,以便它可以报告该节点上的“AvailableDisk”属性。 同一记者可以监视节点连接,因此它可以报告同一节点上的属性“Connectivity”。 在运行状况存储中,这些报告被视为指定节点的单独运行状况事件。 属性与 SourceId 一起唯一标识运行状况信息。
--health-state [必需] 可能的值包括:“Invalid”、“Ok”、“Warning”、“Error”、“Unknown”。
--source-id [必需] 标识生成运行状况信息的客户端/监视器/系统组件的源名称。
--描述 运行状况信息的说明。

它表示用于添加有关报表的人工可读信息的自由文本。 说明的最大字符串长度为 4,096 个字符。 如果提供的字符串较长,则会自动截断。 截断时,说明的最后一个字符包含标记“[截断]”,总字符串大小为 4,096 个字符。 标记的存在表示用户发生了截断。 截断时,说明的原始字符串中少于 4,096 个字符。
--立即 指示是否应立即发送报表的标志。

运行状况报告将发送到服务Fabric网关应用程序,该应用程序将转发到运行状况存储。 如果“立即”设置为 true,则无论 HTTP 网关应用程序使用的构造客户端设置如何,报表都会立即从 HTTP 网关发送到运行状况存储。 这对于应尽快发送的关键报告非常有用。 根据计时和其他条件,发送报告可能仍然失败,例如,如果 HTTP 网关已关闭或消息未到达网关。 如果“即时”设置为 false,则根据 HTTP 网关中的运行状况客户端设置发送报告。 因此,它根据 HealthReportSendInterval 配置进行批处理。 这是建议的设置,因为它允许运行状况客户端优化运行状况报告消息到运行状况存储以及运行状况报告处理。 默认情况下,不会立即发送报表。
--remove-when-expired 指示报表在过期时是否从运行状况存储中删除的值。

如果设置为 true,则报告在过期后会从运行状况存储中删除。 如果设置为 false,则报告在过期时被视为错误。 此属性的值默认为 false。 客户端定期报告时,应设置 RemoveWhenExpired false (默认值)。 这样,如果记者有问题(例如死锁),并且无法报告,则当运行状况报告过期时,会以错误方式评估实体。 这会将实体标记为处于错误运行状况状态。
--sequence-number 此运行状况报告的序列号作为数字字符串。

运行状况存储使用报表序列号来检测过时的报告。 如果未指定,则添加报表时,运行状况客户端自动生成序列号。
--timeout -t 默认值:60。
--ttl 此运行状况报告有效的持续时间。 此字段使用ISO8601格式来指定持续时间。

客户端定期报告时,应发送频率高于生存时间的报告。 如果客户端报告转换情况,则可以将生存时间设置为无限。 生存时间过期时,如果 RemoveWhenExpired 为 true,则从运行状况存储中删除包含运行状况信息的运行状况事件;如果 RemoveWhenExpired 为 false,则以错误方式进行评估。 如果未指定,生存时间默认为无限值。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster select

连接到服务Fabric群集终结点。

如果连接到安全群集,请指定证书(.crt)和密钥文件的绝对路径(.key)或具有两者(.pem)的单个文件。 不要同时指定这两者。 (可选)如果连接到安全群集,还指定 CA 捆绑文件或受信任 CA 证书目录的绝对路径。 无需先运行此命令即可连接到群集,包括与 localhost 的连接。 但是,连接到本地群集不需要显式终结点。 如果使用自签名证书或其他未由已知 CA 签名的证书,请传入 --ca 参数以确保验证通过。 如果未在生产群集上,若要绕过客户端验证(对于自签名或未知的 CA 签名非常有用),请使用 --no-verify 选项。 虽然可能,但不建议用于生产群集。 否则,证书验证错误可能会导致。

Arguments

论点 说明
--aad 使用Microsoft Entra ID进行身份验证。
--约 要视为有效或 CA 捆绑文件的 CA 证书目录的绝对路径。 如果使用 CA 证书的目录, c_rehash <directory> 则首先必须运行 OpenSSL 提供的证书哈希,以计算证书哈希并创建相应的符号链接。 这用于验证群集返回的证书是否有效。
--证书 客户端证书文件的绝对路径。
--端点 群集终结点 URL,包括端口和 HTTP 或 HTTPS 前缀。 通常,终结点如下所示 https\://<your-url>\:19080。 如果未提供任何终结点,则默认为 http\://localhost\:19080.
--关键 客户端证书密钥文件的绝对路径。
--no-verify 使用 HTTPS 时禁用证书验证,请注意:这是不安全的选项,不应用于生产环境。
--Pem 客户端证书的绝对路径,作为 .pem 文件。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster show-connection

显示此 sfctl 实例连接到的群集Fabric服务。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster unprovision

取消预配服务Fabric群集的代码或配置包。

支持单独取消预配代码和配置。

Arguments

论点 说明
--code-version 群集代码包版本。
--config-version 群集清单版本。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster upgrade

开始升级服务Fabric群集的代码或配置版本。

验证提供的升级参数,并在参数有效时开始升级服务Fabric群集的代码或配置版本。

Arguments

论点 说明
--app-health-map 在引发错误之前,应用程序名称对的 JSON 编码字典和最大百分比不正常。
--app-type-health-map 在引发错误之前,应用程序类型名称对的 JSON 编码字典和最大百分比不正常。
--code-version 群集代码版本。
--config-version 群集配置版本。
--delta-health-evaluation 在每个升级域完成后启用增量运行状况评估,而不是绝对运行状况评估。
--delta-unhealthy-nodes 群集升级期间允许的最大节点运行状况降级百分比。 默认值:10。

在升级开始时的节点状态与运行状况评估时节点的状态之间测量增量。 在完成每个升级域后执行检查,以确保群集的全局状态处于允许的限制范围内。
--failure-action 可能的值包括:“Invalid”、“Rollback”、“Manual”。
--force-restart 即使在代码版本未更改的情况下,升级期间也会强制重启进程。

升级仅更改配置或数据。
--health-check-retry 尝试执行运行状况检查(如果应用程序或群集不正常)之间的时间长度。
--health-check-stable 在升级继续到下一个升级域之前,应用程序或群集必须保持正常运行的时间量。

它首先解释为表示 ISO 8601 持续时间的字符串。 如果失败,则会将其解释为表示总毫秒数的数字。
--health-check-wait 完成升级域后等待的时间长度,然后再启动运行状况检查过程。
--replica-set-check-timeout 阻止处理升级域的最大时间,并在出现意外问题时防止可用性丢失。

当此超时过期时,无论可用性丢失问题如何,升级域的处理都会继续。 超时是在每个升级域的开头重置的。 有效值介于 0 和 42949672925 之间( 非独占)。
--rolling-upgrade-mode 可能的值包括:“Invalid”、“UnmonitoredAuto”、“UnmonitoredManual”、“Monitored”。 默认值:UnmonitoredAuto。
--timeout -t 默认值:60。
--unhealthy-applications 报告错误之前允许的最大不正常应用程序的百分比。

例如,若要允许 10 个应用程序% 运行不正常,此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的应用程序的最大允许百分比。 如果遵循百分比,但至少有一个不正常的应用程序,则运行状况将评估为“警告”。 这是通过除以群集中应用程序实例总数的不正常应用程序数(不包括 ApplicationTypeHealthPolicyMap 中包含的应用程序类型的应用程序)来计算的。 计算四舍五入,以容忍少量应用程序出现一次故障。
--unhealthy-nodes 报告错误之前允许的最大不正常节点百分比。

例如,若要允许 10 个节点% 运行不正常,此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的节点的最大允许百分比。 如果遵循百分比,但至少有一个不正常的节点,则运行状况将评估为“警告”。 通过除以群集中节点总数的不正常节点数来计算百分比。 计算向上舍入,以容忍少量节点上的一次故障。 在大型群集中,某些节点将始终关闭或退出进行修复,因此应将此百分比配置为容忍该百分比。
--upgrade-domain-delta-unhealthy-nodes 群集升级期间允许的最大升级域节点运行状况降级百分比。 默认值:15。

在升级开始时的升级域节点的状态与运行状况评估时升级域节点的状态之间测量增量。 在完成所有已完成升级域的每个升级域后执行检查,以确保升级域的状态处于允许的限制范围内。
--upgrade-domain-timeout 执行 FailureAction 之前,每个升级域必须完成的时间。

它首先解释为表示 ISO 8601 持续时间的字符串。 如果失败,则会将其解释为表示总毫秒数的数字。
--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 cluster upgrade-resume

使群集升级继续转到下一个升级域。

如果适用,请将群集代码或配置升级转到下一个升级域。

Arguments

论点 说明
--upgrade-domain [必需] 此群集升级的下一个升级域。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster upgrade-rollback

回滚服务Fabric群集的升级。

回滚服务Fabric群集的代码或配置升级。

Arguments

论点 说明
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster upgrade-status

获取当前群集升级的进度。

获取正在进行的群集升级的当前进度。 如果当前未进行升级,请获取上一个群集升级的最后一个状态。

Arguments

论点 说明
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl cluster upgrade-update

更新服务Fabric群集升级的升级参数。

Arguments

论点 说明
--app-health-map 在引发错误之前,应用程序名称对的 JSON 编码字典和最大百分比不正常。
--app-type-health-map 在引发错误之前,应用程序类型名称对的 JSON 编码字典和最大百分比不正常。
--delta-health-evaluation 在每个升级域完成后启用增量运行状况评估,而不是绝对运行状况评估。
--delta-unhealthy-nodes 群集升级期间允许的最大节点运行状况降级百分比。 默认值:10。

在升级开始时的节点状态与运行状况评估时节点的状态之间测量增量。 在完成每个升级域后执行检查,以确保群集的全局状态处于允许的限制范围内。
--failure-action 可能的值包括:“Invalid”、“Rollback”、“Manual”。
--force-restart 即使在代码版本未更改的情况下,升级期间也会强制重启进程。

升级仅更改配置或数据。
--health-check-retry 尝试执行运行状况检查(如果应用程序或群集不正常)之间的时间长度。
--health-check-stable 在升级继续到下一个升级域之前,应用程序或群集必须保持正常运行的时间量。

它首先解释为表示 ISO 8601 持续时间的字符串。 如果失败,则会将其解释为表示总毫秒数的数字。
--health-check-wait 完成升级域后等待的时间长度,然后再启动运行状况检查过程。
--replica-set-check-timeout 阻止处理升级域的最大时间,并在出现意外问题时防止可用性丢失。

当此超时过期时,无论可用性丢失问题如何,升级域的处理都会继续。 超时是在每个升级域的开头重置的。 有效值介于 0 和 42949672925 之间( 非独占)。
--rolling-upgrade-mode 可能的值包括:“Invalid”、“UnmonitoredAuto”、“UnmonitoredManual”、“Monitored”。 默认值:UnmonitoredAuto。
--timeout -t 默认值:60。
--unhealthy-applications 报告错误之前允许的最大不正常应用程序的百分比。

例如,若要允许 10 个应用程序% 运行不正常,此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的应用程序的最大允许百分比。 如果遵循百分比,但至少有一个不正常的应用程序,则运行状况将评估为“警告”。 这是通过除以群集中应用程序实例总数的不正常应用程序数(不包括 ApplicationTypeHealthPolicyMap 中包含的应用程序类型的应用程序)来计算的。 计算四舍五入,以容忍少量应用程序出现一次故障。
--unhealthy-nodes 报告错误之前允许的最大不正常节点百分比。

例如,若要允许 10 个节点% 运行不正常,此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的节点的最大允许百分比。 如果遵循百分比,但至少有一个不正常的节点,则运行状况将评估为“警告”。 通过除以群集中节点总数的不正常节点数来计算百分比。 计算向上舍入,以容忍少量节点上的一次故障。 在大型群集中,某些节点将始终关闭或退出进行修复,因此应将此百分比配置为容忍该百分比。
--upgrade-domain-delta-unhealthy-nodes 群集升级期间允许的最大升级域节点运行状况降级百分比。 默认值:15。

在升级开始时的升级域节点的状态与运行状况评估时升级域节点的状态之间测量增量。 在完成所有已完成升级域的每个升级域后执行检查,以确保升级域的状态处于允许的限制范围内。
--upgrade-domain-timeout 执行 FailureAction 之前,每个升级域必须完成的时间。

它首先解释为表示 ISO 8601 持续时间的字符串。 如果失败,则会将其解释为表示总毫秒数的数字。
--upgrade-kind 可能的值包括:“Invalid”、“Rolling”、“Rolling_ForceRestart”。 默认值:滚动。
--upgrade-timeout 在执行 FailureAction 之前,整个升级必须完成的时间量。

它首先解释为表示 ISO 8601 持续时间的字符串。 如果失败,则会将其解释为表示总毫秒数的数字。
--warning-as-error 指示是否以与错误相同的严重性处理警告。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。
--查询 JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

后续步骤

  • Setup Service Fabric CLI。
  • 了解如何使用 sample 脚本使用 Service Fabric CLI。