第 2 章 OLSConfig API 参考


OLSConfig 是 OpenShift Lightspeed 配置对象的 Schema,用于定义底层部署的结构和参数。

注意

API 参数信息源自 OLSConfig API 参考,此处提供。

2.1. OLSConfig API 规格

描述
Red Hat OpenShift Lightspeed Lightspeed 实例。OLSConfigolsconfigs API 的 Schema
类型
object
必填
  • spec
Expand
属性类型描述

apiVersion

string

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

kind

string

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

对象

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

spec

object

OLSConfigSpec 定义 OLSConfig 的所需状态

2.1.1. .metadata

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

2.1.2. .spec

描述
OLSConfigSpec 定义 OLSConfig 的所需状态
类型
object
必填
  • llm
  • ols
Expand
属性类型描述

llm

object

LLMSpec 定义大型语言模型(LLM)的所需状态。

ols

object

OLSSpec 定义 OLS 部署所需状态。

olsDataCollector

object

OLSDataCollectorSpec 定义允许的 OLS 数据收集器配置。

2.1.3. .spec.llm

描述
LLMSpec 定义大型语言模型(LLM)的所需状态。
类型
object
必填
  • providers
Expand
属性类型描述

providers

数组

 

2.1.4. .spec.llm.providers

描述
类型
数组

2.1.5. .spec.llm.providers[]

描述
providerSpec 定义 LLM 供应商所需状态。
类型
object
必填
  • credentialsSecretRef
  • models
  • name
  • type
Expand
属性类型描述

apiVersion

string

Azure OpenAI 供应商的 API 版本

credentialsSecretRef

object

存储 API 供应商凭证的 secret 对象的名称

deploymentName

string

Azure OpenAI 部署名称

models

数组

供应商中的模型列表

name

string

供应商名称

projectID

string

Watsonx 项目 ID

tlsSecurityProfile

object

连接到供应商的 TLS 安全配置集

type

string

供应商类型

url

string

Provider API URL

2.1.6. .spec.llm.providers[].credentialsSecretRef

描述
存储 API 供应商凭证的 secret 对象的名称
类型
object
Expand
属性类型描述

name

字符串

引用的名称。有效地需要此字段,但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

2.1.7. .spec.llm.providers[].models

描述
供应商中的模型列表
类型
数组

2.1.8. .spec.llm.providers[].models[]

描述
ModelSpec 定义要使用的 LLM 模型及其参数。
类型
object
必填
  • name
Expand
属性类型描述

contextWindowSize

整数

定义模型的上下文窗口大小。默认为 provider/model。

name

string

型号名称

parameters

object

模型 API 参数

url

string

Model API URL

2.1.9. .spec.llm.providers[].models[].parameters

描述
模型 API 参数
类型
object
Expand
属性类型描述

maxTokensForResponse

整数

最大令牌用于响应

2.1.10. .spec.llm.providers[].tlsSecurityProfile

描述
连接到供应商的 TLS 安全配置集
类型
object
Expand
属性类型描述

custom

``

Custom 是一个用户定义的 TLS 安全配置集。使用自定义配置集时要非常小心,因为无效的配置可能是灾难性的。自定义配置集示例类似如下:

密码 :

- ECDHE-ECDSA-CHACHA20-POLY1305

- ECDHE-RSA-CHACHA20-POLY1305

- ECDHE-RSA-AES128-GCM-SHA256

- ECDHE-ECDSA-AES128-GCM-SHA256

minTLSVersion: VersionTLS11

intermediate

``

intermediate 是一个基于以下内容的 TLS 安全配置集:

https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29

如下所示:

密码 :

- TLS_AES_128_GCM_SHA256

- TLS_AES_256_GCM_SHA384

- TLS_CHACHA20_POLY1305_SHA256

- ECDHE-ECDSA-AES128-GCM-SHA256

- ECDHE-RSA-AES128-GCM-SHA256

- ECDHE-ECDSA-AES256-GCM-SHA384

- ECDHE-RSA-AES256-GCM-SHA384

- ECDHE-ECDSA-CHACHA20-POLY1305

- ECDHE-RSA-CHACHA20-POLY1305

- DHE-RSA-AES128-GCM-SHA256

- DHE-RSA-AES256-GCM-SHA384

minTLSVersion: VersionTLS12

modern

``

modern 是一个基于以下内容的 TLS 安全配置集:

https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility

如下所示:

密码 :

- TLS_AES_128_GCM_SHA256

- TLS_AES_256_GCM_SHA384

- TLS_CHACHA20_POLY1305_SHA256

minTLSVersion: VersionTLS13

old

``

旧是一个基于以下的 TLS 安全配置集:

https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility

如下所示:

密码 :

- TLS_AES_128_GCM_SHA256

- TLS_AES_256_GCM_SHA384

- TLS_CHACHA20_POLY1305_SHA256

- ECDHE-ECDSA-AES128-GCM-SHA256

- ECDHE-RSA-AES128-GCM-SHA256

- ECDHE-ECDSA-AES256-GCM-SHA384

- ECDHE-RSA-AES256-GCM-SHA384

- ECDHE-ECDSA-CHACHA20-POLY1305

- ECDHE-RSA-CHACHA20-POLY1305

- DHE-RSA-AES128-GCM-SHA256

- DHE-RSA-AES256-GCM-SHA384

- DHE-RSA-CHACHA20-POLY1305

- ECDHE-ECDSA-AES128-SHA256

- ECDHE-RSA-AES128-SHA256

- ECDHE-ECDSA-AES128-SHA

- ECDHE-RSA-AES128-SHA

- ECDHE-ECDSA-AES256-SHA384

- ECDHE-RSA-AES256-SHA384

- ECDHE-ECDSA-AES256-SHA

- ECDHE-RSA-AES256-SHA

- DHE-RSA-AES128-SHA256

- DHE-RSA-AES256-SHA256

- AES128-GCM-SHA256

- AES256-GCM-SHA384

- AES128-SHA256

- AES256-SHA256

- AES128-SHA

- AES256-SHA

- DES-CBC3-SHA

minTLSVersion: VersionTLS10

type

字符串

type 是 Old、Intermediate、Modern 或 Custom 之一。自定义提供指定各个 TLS 安全配置集参数的功能。旧、Intermediate 和 Modern 是基于以下内容的 TLS 安全配置集:

https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations

该配置集基于意图,因此当开发新密码时,它们可能会随时间变化,并且发现现有密码不安全。根据具体哪些密码可用于进程,可能会减少列表。

请注意,Modern 配置集目前还不被支持,因为它还没有被常见软件库正确采用。

2.1.11. .spec.ols

描述
OLSSpec 定义 OLS 部署所需状态。
类型
object
必填
  • defaultModel
Expand
属性类型描述

additionalCAConfigMapRef

object

用于 OLS 服务和 LLM 供应商之间的 TLS 通信的额外 CA 证书

conversationCache

object

对话缓存设置

defaultModel

string

使用的默认模型

defaultProvider

string

使用的默认供应商

部署

object

OLS 部署设置

introspectionEnabled

布尔值

启用内省功能

logLevel

string

日志级别。有效选项为 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。默认:"INFO"。

queryFilters

数组

查询过滤器

tlsConfig

object

Lightspeed 后端 HTTPS 端点的 TLS 配置

tlsSecurityProfile

object

API 端点使用的 TLS 安全配置集

userDataCollection

object

用户数据收集交换机

2.1.12. .spec.ols.additionalCAConfigMapRef

描述
用于 OLS 服务和 LLM 供应商之间的 TLS 通信的额外 CA 证书
类型
object
Expand
属性类型描述

name

字符串

引用的名称。有效地需要此字段,但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

2.1.13. .spec.ols.conversationCache

描述
对话缓存设置
类型
object
Expand
属性类型描述

postgres

object

PostgresSpec 定义 Postgres 的所需状态。

type

string

对话缓存类型。默认:"postgres"

2.1.14. .spec.ols.conversationCache.postgres

描述
PostgresSpec 定义 Postgres 的所需状态。
类型
object
Expand
属性类型描述

credentialsSecret

string

包含 postgres 凭证的 secret

dbName

string

postgres 数据库名称

maxConnections

整数

Postgres maxconnections。默认:"2000"

sharedBuffers

integer-or-string

postgres sharedbuffers

user

string

Postgres 用户名

2.1.15. .spec.ols.deployment

描述
OLS 部署设置
类型
object
Expand
属性类型描述

api

object

API 容器设置。

控制台

object

控制台容器设置。

dataCollector

object

数据收集器容器设置。

replicas

整数

定义所需 OLS pod 的数量。默认:"1"

2.1.16. .spec.ols.deployment.api

描述
API 容器设置。
类型
object
Expand
属性类型描述

nodeSelector

对象(字符串)

 

resources

对象

ResourceRequirements 描述了计算资源要求。

容限(tolerations)

数组

 

2.1.17. .spec.ols.deployment.api.resources

描述
ResourceRequirements 描述了计算资源要求。
类型
object
Expand
属性类型描述

claims

数组

claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段不可变。它只能为容器设置。

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。请求不能超过限值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

2.1.18. .spec.ols.deployment.api.resources.claims

描述

claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段不可变。它只能为容器设置。

类型
数组

2.1.19. .spec.ols.deployment.api.resources.claims[]

描述
ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。
类型
object
必填
  • name
Expand
属性类型描述

name

string

name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中的一个条目的名称匹配。它允许容器内部使用该资源。

Request (请求)

string

在引用的声明中为请求选择请求的名称。如果为空,则提供声明中的所有内容,否则仅提供此请求的结果。

2.1.20. .spec.ols.deployment.api.tolerations

描述
类型
数组

2.1.21. .spec.ols.deployment.api.tolerations[]

描述
此 Toleration 附加到 pod,以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。
类型
object
Expand
属性类型描述

effect

字符串

effect 表示要匹配的污点效果。空意味着匹配所有污点效果。指定后,允许的值为 NoSchedule,PreferNoSchedule 和 NoExecute。

key

字符串

key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空,则必须存在运算符;组合意味着匹配所有值和所有键。

operator

字符串

Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认值为 Equal。exists 等同于值的通配符,以便 pod 可以容忍特定类别的所有污点。

tolerationSeconds

整数

tolerationSeconds 代表容限的期间(必须生效 NoExecute,否则此字段将被忽略)可以容忍污点。默认情况下,它不会被设置,这意味着容许任何污点(不要驱除)。零值和负值将被视为 0 (立即删除)。

value

字符串

value 是容限匹配的污点值。如果运算符是 Exists,则该值应该为空,否则仅是一个常规字符串。

2.1.22. .spec.ols.deployment.console

描述
控制台容器设置。
类型
object
Expand
属性类型描述

caCertificate

string

控制台代理端点使用的证书颁发机构(CA)证书。

nodeSelector

对象(字符串)

 

replicas

整数

定义所需控制台 pod 的数量。默认:"1"

resources

对象

ResourceRequirements 描述了计算资源要求。

容限(tolerations)

数组

 

2.1.23. .spec.ols.deployment.console.resources

描述
ResourceRequirements 描述了计算资源要求。
类型
object
Expand
属性类型描述

claims

数组

claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段不可变。它只能为容器设置。

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。请求不能超过限值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

2.1.24. .spec.ols.deployment.console.resources.claims

描述

claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段不可变。它只能为容器设置。

类型
数组

2.1.25. .spec.ols.deployment.console.resources.claims[]

描述
ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。
类型
object
必填
  • name
Expand
属性类型描述

name

string

name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中的一个条目的名称匹配。它允许容器内部使用该资源。

Request (请求)

string

在引用的声明中为请求选择请求的名称。如果为空,则提供声明中的所有内容,否则仅提供此请求的结果。

2.1.26. .spec.ols.deployment.console.tolerations

描述
类型
数组

2.1.27. .spec.ols.deployment.console.tolerations[]

描述
此 Toleration 附加到 pod,以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。
类型
object
Expand
属性类型描述

effect

字符串

effect 表示要匹配的污点效果。空意味着匹配所有污点效果。指定后,允许的值为 NoSchedule,PreferNoSchedule 和 NoExecute。

key

字符串

key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空,则必须存在运算符;组合意味着匹配所有值和所有键。

operator

字符串

Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认值为 Equal。exists 等同于值的通配符,以便 pod 可以容忍特定类别的所有污点。

tolerationSeconds

整数

tolerationSeconds 代表容限的期间(必须生效 NoExecute,否则此字段将被忽略)可以容忍污点。默认情况下,它不会被设置,这意味着容许任何污点(不要驱除)。零值和负值将被视为 0 (立即删除)。

value

字符串

value 是容限匹配的污点值。如果运算符是 Exists,则该值应该为空,否则仅是一个常规字符串。

2.1.28. .spec.ols.deployment.dataCollector

描述
数据收集器容器设置。
类型
object
Expand
属性类型描述

resources

对象

ResourceRequirements 描述了计算资源要求。

2.1.29. .spec.ols.deployment.dataCollector.resources

描述
ResourceRequirements 描述了计算资源要求。
类型
object
Expand
属性类型描述

claims

数组

claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段不可变。它只能为容器设置。

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。请求不能超过限值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

2.1.30. .spec.ols.deployment.dataCollector.resources.claims

描述

claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段不可变。它只能为容器设置。

类型
数组
描述
ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。
类型
object
必填
  • name
Expand
属性类型描述

name

string

name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中的一个条目的名称匹配。它允许容器内部使用该资源。

Request (请求)

string

在引用的声明中为请求选择请求的名称。如果为空,则提供声明中的所有内容,否则仅提供此请求的结果。

2.1.32. .spec.ols.queryFilters

描述
查询过滤器
类型
数组

2.1.33. .spec.ols.queryFilters[]

描述
QueryFiltersSpec 定义用于操作问题/查询的过滤器。
类型
object
Expand
属性类型描述

name

string

过滤名称。

pattern

string

过滤器模式.

replaceWith

string

替换匹配模式。

2.1.34. .spec.ols.tlsConfig

描述
Lightspeed 后端 HTTPS 端点的 TLS 配置
类型
object
Expand
属性类型描述

keyCertSecretRef

object

KeySecretRef 是包含 TLS 密钥的 secret。

2.1.35. .spec.ols.tlsConfig.keyCertSecretRef

描述
KeySecretRef 是包含 TLS 密钥的 secret。
类型
object
Expand
属性类型描述

name

字符串

引用的名称。有效地需要此字段,但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

2.1.36. .spec.ols.tlsSecurityProfile

描述
API 端点使用的 TLS 安全配置集
类型
object
Expand
属性类型描述

custom

``

Custom 是一个用户定义的 TLS 安全配置集。使用自定义配置集时要非常小心,因为无效的配置可能是灾难性的。自定义配置集示例类似如下:

密码 :

- ECDHE-ECDSA-CHACHA20-POLY1305

- ECDHE-RSA-CHACHA20-POLY1305

- ECDHE-RSA-AES128-GCM-SHA256

- ECDHE-ECDSA-AES128-GCM-SHA256

minTLSVersion: VersionTLS11

intermediate

``

intermediate 是一个基于以下内容的 TLS 安全配置集:

https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29

如下所示:

密码 :

- TLS_AES_128_GCM_SHA256

- TLS_AES_256_GCM_SHA384

- TLS_CHACHA20_POLY1305_SHA256

- ECDHE-ECDSA-AES128-GCM-SHA256

- ECDHE-RSA-AES128-GCM-SHA256

- ECDHE-ECDSA-AES256-GCM-SHA384

- ECDHE-RSA-AES256-GCM-SHA384

- ECDHE-ECDSA-CHACHA20-POLY1305

- ECDHE-RSA-CHACHA20-POLY1305

- DHE-RSA-AES128-GCM-SHA256

- DHE-RSA-AES256-GCM-SHA384

minTLSVersion: VersionTLS12

modern

``

modern 是一个基于以下内容的 TLS 安全配置集:

https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility

如下所示:

密码 :

- TLS_AES_128_GCM_SHA256

- TLS_AES_256_GCM_SHA384

- TLS_CHACHA20_POLY1305_SHA256

minTLSVersion: VersionTLS13

old

``

旧是一个基于以下的 TLS 安全配置集:

https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility

如下所示:

密码 :

- TLS_AES_128_GCM_SHA256

- TLS_AES_256_GCM_SHA384

- TLS_CHACHA20_POLY1305_SHA256

- ECDHE-ECDSA-AES128-GCM-SHA256

- ECDHE-RSA-AES128-GCM-SHA256

- ECDHE-ECDSA-AES256-GCM-SHA384

- ECDHE-RSA-AES256-GCM-SHA384

- ECDHE-ECDSA-CHACHA20-POLY1305

- ECDHE-RSA-CHACHA20-POLY1305

- DHE-RSA-AES128-GCM-SHA256

- DHE-RSA-AES256-GCM-SHA384

- DHE-RSA-CHACHA20-POLY1305

- ECDHE-ECDSA-AES128-SHA256

- ECDHE-RSA-AES128-SHA256

- ECDHE-ECDSA-AES128-SHA

- ECDHE-RSA-AES128-SHA

- ECDHE-ECDSA-AES256-SHA384

- ECDHE-RSA-AES256-SHA384

- ECDHE-ECDSA-AES256-SHA

- ECDHE-RSA-AES256-SHA

- DHE-RSA-AES128-SHA256

- DHE-RSA-AES256-SHA256

- AES128-GCM-SHA256

- AES256-GCM-SHA384

- AES128-SHA256

- AES256-SHA256

- AES128-SHA

- AES256-SHA

- DES-CBC3-SHA

minTLSVersion: VersionTLS10

type

字符串

type 是 Old、Intermediate、Modern 或 Custom 之一。自定义提供指定各个 TLS 安全配置集参数的功能。旧、Intermediate 和 Modern 是基于以下内容的 TLS 安全配置集:

https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations

该配置集基于意图,因此当开发新密码时,它们可能会随时间变化,并且发现现有密码不安全。根据具体哪些密码可用于进程,可能会减少列表。

请注意,Modern 配置集目前还不被支持,因为它还没有被常见软件库正确采用。

2.1.37. .spec.ols.userDataCollection

描述
用户数据收集交换机
类型
object
Expand
属性类型描述

feedbackDisabled

布尔值

 

transcriptsDisabled

布尔值

 

2.1.38. .spec.olsDataCollector

描述
OLSDataCollectorSpec 定义允许的 OLS 数据收集器配置。
类型
object
Expand
属性类型描述

logLevel

string

日志级别。有效选项为 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。默认:"INFO"。

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat