第2章 OLSConfig API リファレンス

featureGates

array (string)

フィーチャーゲートは明示的に有効にする機能のリストを格納します。リストに含まれない機能は、デフォルトで無効になります。指定可能な値: MCPServer

llm

object

LLMSpec は、大規模言語モデル (LLM) の望ましい状態を定義します。

mcpServers

array

MCP サーバーの設定

ols

object

OLSSpec は、OLS デプロイメントの望ましい状態を定義します。

olsDataCollector

object

OLSDataCollectorSpec は、許可される OLS データコレクター設定を定義します。

providers

array

apiVersion

string

Azure OpenAI プロバイダーの API バージョン

credentialsSecretRef

object

API プロバイダーの認証情報を保存するシークレットオブジェクトの名前

deploymentName

string

Azure OpenAI デプロイメント名

models

array

プロバイダーのモデルのリスト

name

string

プロバイダー名

projectID

string

Watsonx プロジェクト ID

tlsSecurityProfile

object

プロバイダーへの接続で使用される TLS セキュリティープロファイル

type

string

プロバイダータイプ

url

string

プロバイダー API URL

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

contextWindowSize

integer

モデルのコンテキストウィンドウのサイズをトークン単位で定義します。デフォルトは 128k トークンです。

name

string

モデル名

parameters

object

モデル API パラメーター

url

string

モデル API URL

maxTokensForResponse

integer

回答の最大トークン数。デフォルトは 2048 トークンです。

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

以下のようになります (yaml):

暗号化:

- 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

以下のようになります (yaml):

暗号化:

- TLS_AES_128_GCM_SHA256

- TLS_AES_256_GCM_SHA384

- TLS_CHACHA20_POLY1305_SHA256

minTLSVersion: VersionTLS13

old

``

old は、以下に基づく TLS セキュリティープロファイルです。

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

以下のようになります (yaml):

暗号化:

- 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

string

type は、Old、Intermediate、Modern、または Custom のいずれかです。カスタムは、個々の TLS セキュリティープロファイルパラメーターを指定する機能を提供します。Old、Intermediate、Modern は、以下に基づく TLS セキュリティープロファイルです。

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

プロファイルは意図に基づいているため、時間の経過とともに新しい暗号が開発され、既存の暗号が安全でないことが判明すると、変更される可能性があります。プロセスで使用できる暗号の種類に応じて、リストが短縮される可能性があります。

Modern プロファイルは、一般的なソフトウェアライブラリーでまだ十分に採用されていないため、現在サポートされていないことに注意してください。

name

string

MCP サーバーの名前

streamableHTTP

object

Streamable HTTP Transport の設定

enableSSE

boolean

サーバー送信イベントを有効にします。

headers

object (string)

MCP サーバーに送信するヘッダー

sseReadTimeout

integer

SSE 読み取りタイムアウト。デフォルトは 10 秒です。

timeout

integer

MCP サーバーのタイムアウト。デフォルトは 5 秒です。

url

string

MCP サーバーの URL

additionalCAConfigMapRef

object

OLS サービスと LLM プロバイダー間の TLS 通信用の追加 CA 証明書

byokRAGOnly

boolean

BYOK RAG ソースのみを使用します。Red Hat OpenShift Lightspeed ドキュメントの RAG は無視します。

conversationCache

object

会話キャッシュ設定

defaultModel

string

使用のデフォルトモデル

defaultProvider

string

使用時のデフォルトプロバイダー

deployment

object

OLS デプロイメント設定

introspectionEnabled

boolean

イントロスペクション機能を有効にする

logLevel

string

ログレベル。有効なオプションは、DEBUG、INFO、WARNING、ERROR、および CRITICAL です。デフォルト: "INFO".

proxyConfig

object

LLM プロバイダーなどの外部サーバーに接続するためのプロキシー設定。

queryFilters

array

クエリーフィルター

quotaHandlersConfig

object

LLM トークンクォータの設定

rag

array

RAG データベース

storage

object

永続ストレージの設定

tlsConfig

object

Lightspeed バックエンドの HTTPS エンドポイントの TLS 設定

tlsSecurityProfile

object

API エンドポイントで使用される TLS セキュリティープロファイル

userDataCollection

object

ユーザーデータ収集スイッチ

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

postgres

object

PostgresSpec は、Postgres の望ましい状態を定義します。

type

string

会話キャッシュタイプ。デフォルト: "postgres"

credentialsSecret

string

Postgres の認証情報を保持するシークレット

dbName

string

Postgres データベース名

maxConnections

integer

Postgres の最大接続数。デフォルト: "2000"

sharedBuffers

integer-or-string

Postgres の共有バッファー

user

string

Postgres ユーザー名

api

object

API コンテナーの設定。

console

object

コンソールコンテナーの設定。

dataCollector

object

データコレクターコンテナーの設定。

database

object

データベースコンテナーの設定。

mcpServer

object

MCP サーバーコンテナーの設定。

replicas

integer

必要な OLS Pod の数を定義します。デフォルト: "1"

nodeSelector

object (string)

resources

object

ResourceRequirements は、コンピュートリソースの要件を説明します。

tolerations

array

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細は、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/ を参照してください。

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

effect

string

effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。

operator

string

Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。

tolerationSeconds

integer

tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。

value

string

value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。

caCertificate

string

コンソールプロキシーエンドポイントで使用される認証局 (CA) の証明書。

nodeSelector

object (string)

replicas

integer

必要なコンソール Pod の数を定義します。デフォルト: "1"

resources

object

ResourceRequirements は、コンピュートリソースの要件を説明します。

tolerations

array

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細は、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/ を参照してください。

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

effect

string

effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。

operator

string

Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。

tolerationSeconds

integer

tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。

value

string

value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。

resources

object

ResourceRequirements は、コンピュートリソースの要件を説明します。

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細は、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/ を参照してください。

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

nodeSelector

object (string)

resources

object

ResourceRequirements は、コンピュートリソースの要件を説明します。

tolerations

array

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細は、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/ を参照してください。

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

effect

string

effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。

operator

string

Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。

tolerationSeconds

integer

tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。

value

string

value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。

resources

object

ResourceRequirements は、コンピュートリソースの要件を説明します。

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細は、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/ を参照してください。

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

proxyCACertificate

object

プロキシー CA 証明書を保持する configmap

proxyURL

string

プロキシー URL (例: https://proxy.example.com:8080) 指定しない場合は、環境変数 "https_proxy" に関係なく、クラスター全体のプロキシーが使用されます。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

name

string

フィルター名。

pattern

string

フィルターパターン。

replaceWith

string

一致したパターンの置換。

enableTokenHistory

boolean

トークン履歴を有効にします。

limitersConfig

array

トークンクォータリミッター

initialQuota

integer

トークンクォータの初期値

name

string

リミッターの名前

period

string

トークンクォータの対象となる期間

quotaIncrease

integer

トークンクォータの増加ステップ

type

string

リミッターの種類

image

string

RAG ソースとして使用するコンテナーイメージの URL

indexID

string

RAG データベースのインデックス ID

indexPath

string

コンテナーイメージ内の RAG データベースへのパス

class

string

要求されるボリュームのストレージクラス

size

integer-or-string

要求されるボリュームのサイズ

keyCertSecretRef

object

KeySecretRef は TLS キーを保持するシークレットです。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

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

以下のようになります (yaml):

暗号化:

- 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

以下のようになります (yaml):

暗号化:

- TLS_AES_128_GCM_SHA256

- TLS_AES_256_GCM_SHA384

- TLS_CHACHA20_POLY1305_SHA256

minTLSVersion: VersionTLS13

old

``

old は、以下に基づく TLS セキュリティープロファイルです。

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

以下のようになります (yaml):

暗号化:

- 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

string

type は、Old、Intermediate、Modern、または Custom のいずれかです。カスタムは、個々の TLS セキュリティープロファイルパラメーターを指定する機能を提供します。Old、Intermediate、Modern は、以下に基づく TLS セキュリティープロファイルです。

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

プロファイルは意図に基づいているため、時間の経過とともに新しい暗号が開発され、既存の暗号が安全でないことが判明すると、変更される可能性があります。プロセスで使用できる暗号の種類に応じて、リストが短縮される可能性があります。

Modern プロファイルは、一般的なソフトウェアライブラリーでまだ十分に採用されていないため、現在サポートされていないことに注意してください。

feedbackDisabled

boolean

transcriptsDisabled

boolean

logLevel

string

ログレベル。有効なオプションは、DEBUG、INFO、WARNING、ERROR、および CRITICAL です。デフォルト: "INFO".