×
描述

ConsoleExternalLogLink 是用于自定义 OpenShift Web 控制台日志链接的扩展。兼容性级别 2:在主要版本中至少稳定 9 个月或 3 个次要版本(以较长者为准)。

类型

对象

必需
  • spec

规格说明

属性 类型 描述

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

对象

ConsoleExternalLogLinkSpec 是所需的日志链接配置。日志链接将显示在 Pod 详情页面的日志选项卡上。

.spec

描述

ConsoleExternalLogLinkSpec 是所需的日志链接配置。日志链接将显示在 Pod 详情页面的日志选项卡上。

类型

对象

必需
  • hrefTemplate

  • 文本

属性 类型 描述

hrefTemplate

字符串

hrefTemplate 是日志链接的绝对安全 URL(必须使用 https),包括要替换的变量。变量在 URL 中使用 ${variableName} 格式指定,例如 ${containerName},并将替换为资源中相应的数值。资源是一个 Pod。支持的变量有:- ${resourceName} - 包含日志的资源名称 - ${resourceUID} - 包含日志的资源的 UID - 例如:11111111-2222-3333-4444-555555555555 - ${containerName} - 包含日志的资源容器的名称 - ${resourceNamespace} - 包含日志的资源的命名空间 - ${resourceNamespaceUID} - 包含日志的资源的命名空间 UID - ${podLabels} - 与包含日志的 Pod 匹配的标签的 JSON 表示 - 例如:{"key1":"value1","key2":"value2"} 例如:https://example.com/logs?resourceName=${resourceName}&containerName=${containerName}&resourceNamespace=${resourceNamespace}&podLabels=${podLabels}

namespaceFilter

字符串

namespaceFilter 是一个正则表达式,用于将日志链接限制为与一组命名空间匹配(例如,^openshift-)。该字符串使用 JavaScript RegExp 构造函数转换为正则表达式。如果未指定,则将为所有命名空间显示链接。

文本

字符串

text 是链接的显示文本

API 端点

提供以下 API 端点

  • /apis/console.openshift.io/v1/consoleexternalloglinks

    • DELETE:删除 ConsoleExternalLogLink 集合

    • GET:列出 ConsoleExternalLogLink 类型的对象

    • POST:创建一个 ConsoleExternalLogLink

  • /apis/console.openshift.io/v1/consoleexternalloglinks/{name}

    • DELETE:删除一个 ConsoleExternalLogLink

    • GET:读取指定的 ConsoleExternalLogLink

    • PATCH:部分更新指定的 ConsoleExternalLogLink

    • PUT:替换指定的 ConsoleExternalLogLink

  • /apis/console.openshift.io/v1/consoleexternalloglinks/{name}/status

    • GET:读取指定的 ConsoleExternalLogLink 的状态

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

    • PUT:替换指定的 ConsoleExternalLogLink 的状态

HTTP 方法

DELETE

描述

删除 ConsoleExternalLogLink 集合

表 1. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出 ConsoleExternalLogLink 类型的对象

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleExternalLogLinkList 模式

401 - 未授权

HTTP 方法

POST

描述

创建一个 ConsoleExternalLogLink

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

dryRun

字符串

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

fieldValidation

字符串

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

表 4. 主体参数
参数 类型 描述

body

ConsoleExternalLogLink 模式

表 5. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleExternalLogLink 模式

201 - 已创建

ConsoleExternalLogLink 模式

202 - 已接受

ConsoleExternalLogLink 模式

401 - 未授权

/apis/console.openshift.io/v1/consoleexternalloglinks/{name}

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

name

字符串

ConsoleExternalLogLink 的名称

HTTP 方法

DELETE

描述

删除一个 ConsoleExternalLogLink

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

dryRun

字符串

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

表 8. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 ConsoleExternalLogLink

表 9. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleExternalLogLink 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 ConsoleExternalLogLink

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

dryRun

字符串

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

fieldValidation

字符串

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

表 11. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleExternalLogLink 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 ConsoleExternalLogLink

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

dryRun

字符串

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

fieldValidation

字符串

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

表 13. 主体参数
参数 类型 描述

body

ConsoleExternalLogLink 模式

表 14. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleExternalLogLink 模式

201 - 已创建

ConsoleExternalLogLink 模式

401 - 未授权

/apis/console.openshift.io/v1/consoleexternalloglinks/{name}/status

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

name

字符串

ConsoleExternalLogLink 的名称

HTTP 方法

GET

描述

读取指定的 ConsoleExternalLogLink 的状态

表 16. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleExternalLogLink 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 ConsoleExternalLogLink 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

表 18. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleExternalLogLink 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 ConsoleExternalLogLink 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

表 20. 主体参数
参数 类型 描述

body

ConsoleExternalLogLink 模式

表 21. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleExternalLogLink 模式

201 - 已创建

ConsoleExternalLogLink 模式

401 - 未授权