×

规范

属性 类型 描述

apiVersion

字符串

APIVersion 定义此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值,并可能拒绝无法识别的值。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值,表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰命名法。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

spec 是 Insights 期望行为的规范。

status

对象

status 是 Insights 运算符最新观察到的状态。

.spec

描述

spec 是 Insights 期望行为的规范。

类型

对象

属性 类型 描述

logLevel

字符串

logLevel 是基于意图的整体组件日志记录。它没有提供细粒度的控制,但它是一种简单的方法来管理操作员必须为其操作数解释的粗粒度日志记录选择。有效值为:“Normal”、“Debug”、“Trace”、“TraceAll”。默认为“Normal”。

managementState

字符串

managementState 指示操作员是否以及如何管理组件

observedConfig

``

observedConfig 保存控制器从集群状态中观察到的稀疏配置。它存在于 spec 中,因为它是操作符级别的一个输入。

operatorLogLevel

字符串

operatorLogLevel 是针对操作符本身的基于意图的日志记录。它不提供细粒度的控制,但它是一种简单的方法来管理操作符必须自行解释的粗粒度日志记录选择。“Normal”、“Debug”、“Trace”、“TraceAll”为有效值。默认为“Normal”。

unsupportedConfigOverrides

``

unsupportedConfigOverrides 保存一个稀疏配置,它将覆盖任何先前设置的选项。它只需要包含要覆盖的字段,它将按照以下顺序进行覆盖:1. 硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides

.status

描述

status 是 Insights 运算符最新观察到的状态。

类型

对象

属性 类型 描述

conditions

数组

conditions 是条件及其状态的列表。

conditions[]

对象

OperatorCondition 只是标准的条件字段。

gatherStatus

对象

gatherStatus 提供有关上次 Insights 数据收集的基本信息。省略此字段表示尚未进行数据收集。

generations

数组

generations 用于确定何时需要协调某个项目,或者项目以需要做出反应的方式发生了更改。

generations[]

对象

GenerationStatus 跟踪给定资源的代数,以便可以做出关于强制更新的决定。

insightsReport

对象

insightsReport 提供一般的 Insights 分析结果。省略此字段表示尚未进行数据收集。

observedGeneration

整数

observedGeneration 是您已处理的最后一代变更。

readyReplicas

整数

readyReplicas 指示有多少个副本已准备就绪并处于所需状态。

version

字符串

version 是此可用性适用的级别。

.status.conditions

描述

conditions 是条件及其状态的列表。

类型

数组

.status.conditions[]

描述

OperatorCondition 只是标准的条件字段。

类型

对象

属性 类型 描述

lastTransitionTime

字符串

message

字符串

reason

字符串

status

字符串

type

字符串

.status.gatherStatus

描述

gatherStatus 提供有关上次 Insights 数据收集的基本信息。省略此字段表示尚未进行数据收集。

类型

对象

属性 类型 描述

gatherers

数组

gatherers 是上次收集中活动收集器(及其状态)的列表。

gatherers[]

对象

gathererStatus 表示有关特定数据收集器的信息。

lastGatherDuration

字符串

lastGatherDuration 是上次收集事件期间处理所有收集器所花费的总时间。

lastGatherTime

字符串

lastGatherTime 是 Insights 数据收集完成的最后时间。空值表示尚未收集任何数据。

.status.gatherStatus.gatherers

描述

gatherers 是上次收集中活动收集器(及其状态)的列表。

类型

数组

.status.gatherStatus.gatherers[]

描述

gathererStatus 表示有关特定数据收集器的信息。

类型

对象

必需
  • conditions

  • lastGatherDuration

  • name

属性 类型 描述

conditions

数组

conditions 提供每个收集器状态的详细信息。

conditions[]

对象

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 的数组。例如,type FooStatus struct{ // 代表对 foo 当前状态的观察。 // 已知的 .status.conditions.type 为:“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

lastGatherDuration

字符串

lastGatherDuration 表示收集所花费的时间。

name

字符串

name 是收集器的名称。

.status.gatherStatus.gatherers[].conditions

描述

conditions 提供每个收集器状态的详细信息。

类型

数组

.status.gatherStatus.gatherers[].conditions[]

描述

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 的数组。例如,type FooStatus struct{ // 代表对 foo 当前状态的观察。 // 已知的 .status.conditions.type 为:“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

类型

对象

必需
  • lastTransitionTime

  • message

  • reason

  • status

  • type

属性 类型 描述

lastTransitionTime

字符串

lastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。这应该是底层条件更改的时间。如果不知道,则可以使用 API 字段更改的时间。

message

字符串

message 是一个易于理解的消息,指示有关转换的详细信息。这可能是一个空字符串。

observedGeneration

整数

observedGeneration 表示设置条件的 .metadata.generation。例如,如果 .metadata.generation 当前为 12,但 .status.conditions[x].observedGeneration 为 9,则该条件相对于实例的当前状态已过期。

reason

字符串

reason 包含一个编程标识符,指示条件最后一次转换的原因。特定条件类型的生产者可以为此字段定义预期的值和含义,以及是否将这些值视为保证的 API。该值应为驼峰式字符串。此字段不能为空。

status

字符串

条件的状态,True、False、Unknown 之一。

type

字符串

条件类型,使用驼峰式命名法或 foo.example.com/CamelCase。--- 许多 .condition.type 值在资源之间保持一致,例如 Available,但由于任意条件可能很有用(参见 .node.status.conditions),因此消除冲突的能力非常重要。它匹配的正则表达式为 (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.generations

描述

generations 用于确定何时需要协调某个项目,或者项目以需要做出反应的方式发生了更改。

类型

数组

.status.generations[]

描述

GenerationStatus 跟踪给定资源的代数,以便可以做出关于强制更新的决定。

类型

对象

属性 类型 描述

group

字符串

group 是您正在跟踪的事物的组。

hash

字符串

hash 是为没有代数且对内容敏感的资源(如密钥和配置映射)设置的可选字段。

lastGeneration

整数

lastGeneration 是所涉及的工作负载控制器的最后一代。

name

字符串

name 是您正在跟踪的事物的名称。

namespace

字符串

namespace 是您正在跟踪的事物所在的位置。

resource

字符串

resource 是您正在跟踪的事物的资源类型。

.status.insightsReport

描述

insightsReport 提供一般的 Insights 分析结果。省略此字段表示尚未进行数据收集。

类型

对象

属性 类型 描述

downloadedAt

字符串

downloadedAt 是上次下载 Insights 报告的时间。空值表示尚未下载任何 Insights 报告,通常出现在断开的集群中(或 Insights 数据收集被禁用的集群中)。

healthChecks

数组

healthChecks 提供有关集群中活动 Insights 健康检查的基本信息。

healthChecks[]

对象

healthCheck 表示 Insights 健康检查属性。

.status.insightsReport.healthChecks

描述

healthChecks 提供有关集群中活动 Insights 健康检查的基本信息。

类型

数组

.status.insightsReport.healthChecks[]

描述

healthCheck 表示 Insights 健康检查属性。

类型

对象

必需
  • advisorURI

  • description

  • state

  • totalRisk

属性 类型 描述

advisorURI

字符串

advisorURI 提供指向 Insights Advisor 的 URL 链接。

description

字符串

description 提供健康检查的基本描述。

state

字符串

state 确定健康检查的当前状态。健康检查默认情况下启用,用户可以在 Insights Advisor 用户界面中禁用它。

totalRisk

整数

healthcheck 的 totalRisk。检测到的问题的总风险指标;影响和可能性的组合。值可以从 1 到 4,数字越高,问题就越重要。

API 端点

提供以下 API 端点:

  • /apis/operator.openshift.io/v1/insightsoperators

    • DELETE:删除 InsightsOperator 集合。

    • GET:列出 InsightsOperator 类型的对象。

    • POST:创建 InsightsOperator。

  • /apis/operator.openshift.io/v1/insightsoperators/{name}

    • DELETE:删除 InsightsOperator。

    • GET:读取指定的 InsightsOperator。

    • PATCH:部分更新指定的 InsightsOperator。

    • PUT:替换指定的 InsightsOperator。

  • /apis/operator.openshift.io/v1/insightsoperators/{name}/scale

    • GET:读取指定 InsightsOperator 的规模。

    • PATCH:部分更新指定 InsightsOperator 的规模。

    • PUT:替换指定 InsightsOperator 的规模。

  • /apis/operator.openshift.io/v1/insightsoperators/{name}/status

    • GET:读取指定 InsightsOperator 的状态。

    • PATCH:部分更新指定 InsightsOperator 的状态。

    • PUT:替换指定 InsightsOperator 的状态。

/apis/operator.openshift.io/v1/insightsoperators

HTTP 方法

DELETE

描述

删除 InsightsOperator 集合

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出 InsightsOperator 对象

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

InsightsOperatorList 模式

401 - 未授权

HTTP 方法

POST

描述

创建 InsightsOperator

表 3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默丢弃的未知字段,并且将忽略解码器遇到的所有重复字段中的最后一个字段之前的字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为对象中每个被丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 4. 请求体参数
参数 类型 描述

body

InsightsOperator 模式

表 5. HTTP 响应
HTTP 代码 响应体

200 - OK

InsightsOperator 模式

201 - 已创建

InsightsOperator 模式

202 - 已接受

InsightsOperator 模式

401 - 未授权

/apis/operator.openshift.io/v1/insightsoperators/{name}

表 6. 全局路径参数
参数 类型 描述

name

字符串

InsightsOperator 的名称

HTTP 方法

DELETE

描述

删除 InsightsOperator

表 7. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

表 8. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 InsightsOperator

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

InsightsOperator 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 InsightsOperator

表 10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默丢弃的未知字段,并且将忽略解码器遇到的所有重复字段中的最后一个字段之前的字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为对象中每个被丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 11. HTTP 响应
HTTP 代码 响应体

200 - OK

InsightsOperator 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 InsightsOperator

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默丢弃的未知字段,并且将忽略解码器遇到的所有重复字段中的最后一个字段之前的字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为对象中每个被丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. 请求体参数
参数 类型 描述

body

InsightsOperator 模式

表 14. HTTP 响应
HTTP 代码 响应体

200 - OK

InsightsOperator 模式

201 - 已创建

InsightsOperator 模式

401 - 未授权

/apis/operator.openshift.io/v1/insightsoperators/{name}/scale

表 15. 全局路径参数
参数 类型 描述

name

字符串

InsightsOperator 的名称

HTTP 方法

GET

描述

读取指定的 InsightsOperator 的缩放比例

表 16. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 InsightsOperator 的缩放比例

表 17. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默丢弃的未知字段,并且将忽略解码器遇到的所有重复字段中的最后一个字段之前的字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为对象中每个被丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 18. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 InsightsOperator 的缩放比例

表 19. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默丢弃的未知字段,并且将忽略解码器遇到的所有重复字段中的最后一个字段之前的字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为对象中每个被丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 20. 请求体参数
参数 类型 描述

body

Scale 模式

表 21. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

/apis/operator.openshift.io/v1/insightsoperators/{name}/status

表 22. 全局路径参数
参数 类型 描述

name

字符串

InsightsOperator 的名称

HTTP 方法

GET

描述

读取指定的 InsightsOperator 的状态

表 23. HTTP 响应
HTTP 代码 响应体

200 - OK

InsightsOperator 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 InsightsOperator 的状态

表 24. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默丢弃的未知字段,并且将忽略解码器遇到的所有重复字段中的最后一个字段之前的字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为对象中每个被丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 25. HTTP 响应
HTTP 代码 响应体

200 - OK

InsightsOperator 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 InsightsOperator 的状态

表 26. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默丢弃的未知字段,并且将忽略解码器遇到的所有重复字段中的最后一个字段之前的字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为对象中每个被丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 27. 请求体参数
参数 类型 描述

body

InsightsOperator 模式

表 28. HTTP 响应
HTTP 代码 响应体

200 - OK

InsightsOperator 模式

201 - 已创建

InsightsOperator 模式

401 - 未授权