接口:HealthConfig
用于定义容器健康检查的配置选项。 要获取健康检查结果,您可以使用 containerEngine.inspectContainer,并在获得的 ContainerInspectInfo 中访问包含 HealthCheckResults 的 Status.Health
属性。
属性
Interval?
可选
Interval:number
检查之间等待的时间(以纳秒为单位)。 应该为 0 或至少 1000000(1 毫秒)。 0 表示继承。
示例
// Set interval to 1 second
Interval?: 1000000000;
定义于
packages/extension-api/src/extension-api.d.ts:2977
Retries?
可选
Retries:number
将容器视为不健康的连续失败次数。 0 表示继承。
示例
// Set retries to 3
Retries?: 3;
定义于
packages/extension-api/src/extension-api.d.ts:3005
StartPeriod?
可选
StartPeriod:number
容器在开始健康重试倒计时之前初始化的时间段(以纳秒为单位)。 应该为 0 或至少 1000000(1 毫秒)。 0 表示继承。
示例
// Set start period to 2 seconds
StartPeriod?: 2000000000;
定义于
packages/extension-api/src/extension-api.d.ts:2996
Test?
可选
Test:string
[]
要执行的测试。
示例
// Inherit healthcheck from image
Test?: [];
// Disable healthcheck
Test?: ["NONE"];
// Execute command in host system
Test?: ["CMD", "curl", "https://127.0.0.1"];
// Podman will execute the command inside the target container and wait for either a "0" or "failure exit" code.
Test?: ["CMD-SHELL", "curl https://127.0.0.1 || exit 1"];
定义于
packages/extension-api/src/extension-api.d.ts:2968
Timeout?
可选
Timeout:number
在将检查视为挂起之前等待的时间。 应该为 0 或至少 1000000(1 毫秒)。 0 表示继承。
示例
// Set timeout to 5 seconds
Timeout?: 5000000000;