第2章 設定ファイルを使用した MicroShift のカスタマイズ

advertiseAddress

string

API サーバーがノードのメンバーにアドバタイズされる IP アドレスを指定する文字列。デフォルト値は、サービスネットワークのアドレスに基づいて計算されます。

auditLog.maxFileAge

number

自動削除前にログファイルが保存される期間。maxFileAge パラメーターのデフォルト値 0 に設定すると、ログファイルが経過時間をベースに削除されなくなります。この値は設定できます。

auditLog.maxFileSize

number

デフォルトでは、audit.log ファイルが maxFileSize の制限に達すると、audit.log ファイルがローテーションされ、MicroShift は新しい audit.log ファイルへの書き込みを開始します。この値は設定できます。

auditLog.maxFiles

number

保存されるログファイルの合計数。デフォルトでは、MicroShift は 10 個のログファイルを保持します。余分なファイルが作成されると、最も古いものが削除されます。この値は設定できます。

auditLog.profile

Default、WriteRequestBodies、AllRequestBodies または None

読み取りおよび書き込み要求のメタデータのみをログに記録します。OAuth アクセストークン要求を除く要求の本文はログに記録されません。このフィールドを指定しない場合は、Default プロファイルが使用されます。

namedCertificates

list

カスタム認証局を使用して、外部で生成された証明書およびドメイン名を定義します。

namedCertificates.certPath

path

証明書への完全パス。

namedCertificates.keyPath

path

証明書キーへの完全パス。

namedCertificates.names

list

オプション: 明示的な DNS 名のリストを追加します。ワイルドカードは、先頭に指定できます。名前を一覧表示しないと、暗黙的な名前が証明書から抽出されます。

subjectAltNames

完全修飾ドメイン名 (FQDN)、*.domain.com などのワイルドカード、または IP アドレス

API サーバー証明書のサブジェクト代替名。SAN は、証明書で保護されたすべてのドメイン名および IP アドレスを示します。

debugging.logLevel

Normal、Debug、Trace、または TraceAll

ログの詳細レベル。デフォルトは Normal です。

dns.baseDomain

valid domain

ノードのベースドメイン。管理されるすべての DNS レコードはこのベースのサブドメインです。

etcd.memoryLimitMB

number

デフォルトでは、etcd はシステムの負荷を処理するために必要な量のメモリーを使用します。ただし、メモリー制約のあるシステムでは、etcd が特定の時点で使用できるメモリーの量を制限することが望ましいか、または制限する必要がある場合があります。

ingress.defaultHTTPVersion

number

ingress に使用するデフォルトの HTTP バージョンを決定します。デフォルト値は 1 で、これは HTTP/1.1 プロトコルです。

ingress.forwardedHeaderPolicy

Append, Replace, IfNone, Never

Ingress ルーターが Forwarded、X-Forwarded-For、X-Forwarded-Host、X-Forwarded-Port、X-Forwarded-Proto、および X-Forwarded-Proto-Version HTTP ヘッダーを設定するタイミングと方法を指定します。

ingress.httpCompression

object

httpCompression は、HTTP トラフィック圧縮のポリシーを定義します。デフォルトでは HTTP 圧縮はありません。

ingress.httpCompression.mimeTypes

array または null

mimeTypes は、圧縮する MIME タイプのリストです。リストが空の場合、Ingress コントローラーは圧縮を適用しません。リストを定義するには、メッセージボディーのデータのタイプとサブタイプ、およびデータのネイティブエンコーディングを指定する RFC 1341 の Content-Type 定義の形式を使用します。たとえば、Content-Type := type \"/\" subtype *[\";\" parameter] です。

すべての MIME タイプが圧縮の恩恵を受けるわけではありませんが、圧縮が設定されていれば、HAProxy がリソースを使用してファイルの圧縮を試みます。一般的に、html、ccs、js などのテキスト形式は圧縮の恩恵を受けます。イメージ、オーディオ、ビデオなど、すでに圧縮されているファイルタイプを圧縮するために CPU リソースを費やしても、おそらく限られた効果しか得られません。

ingress.httpEmptyRequestsPolicy

Respond または Ignore

デフォルト値は Respond です。リクエストを受信する前に接続がタイムアウトした場合に HTTP 接続をどのように処理するかを指定します。このような接続は、通常、ロードバランサーサービスのヘルスプローブ、または preconnect などの Web ブラウザーの投機的な接続から発生します。

ingress.listenAddress

IP アドレス、NIC 名、またはその複数。

デフォルト値は、ホストのネットワーク全体になります。有効な設定可能な値は、単一の IP アドレスまたは NIC 名、あるいは複数の IP アドレスと NIC 名のリストです。

ingress.logEmptyRequests

Log または Ignore

デフォルト値は Log です。空のリクエストを受信した接続をどのようにログに記録するかを指定します。このような接続は、通常、ロードバランサーサービスのヘルスプローブ、または preconnect などの Web ブラウザーの投機的な接続から発生します。通常のリクエストをログに記録することは望ましくない場合もあります。しかし、リクエストはネットワークエラーやポートスキャンによって発生する場合もあります。その場合、ロギングはエラーの診断や侵入の試みの検出に役立ちます。

ingress.ports.http

80

デフォルトのポートが表示されます。設定可能です。有効な値は、1 - 65535 の範囲に含まれる単一の一意のポートです。ports.http および ports.https フィールドの値は、同じにすることはできません。

ingress.ports.https

443

デフォルトのポートが表示されます。設定可能です。有効な値は、1 - 65535 の範囲に含まれる単一の一意のポートです。ports.http および ports.https フィールドの値は、同じにすることはできません。

ingress.routeAdmissionPolicy.namespaceOwnership

Strict または InterNamespaceAllowed

複数の namespace のホスト名要求の処理方法を記述します。デフォルトでは、複数の namespace にまたがって、ルートが同じホスト名の異なるパスを要求することを許可します。Strict を指定すると、namespace が異なるルートが、同じホスト名を要求しなくなります。カスタマイズされた MicroShift の config.yaml で値が削除されると、InterNamespaceAllowed 値が自動的に設定されます。

ingress.status

Managed または Removed

ルーターのステータス。デフォルトは Managed です。

ingress.tuningOptions

オブジェクト

Ingress コントローラー Pod のパフォーマンスをチューニングするためのオプションを指定します。

ingress.tuningOptions.clientFinTimeout

duration 形式の string

接続を閉じる前に、サーバー/バックエンドへのクライアントのレスポンスを待機している間、接続を開いたままにする時間を定義します。デフォルトのタイムアウトは 1s (1 秒) です。

ingress.tuningOptions.clientTimeout

duration 形式の string

クライアントのレスポンスを待機している間、接続を開いたままにする時間を定義します。デフォルトのタイムアウトは 30s (30 秒) です。

ingress.tuningOptions.headerBufferBytes

int32 format の integer。HTTP/2 が有効な場合の最小値は 16384 です。

IngressController 接続セッション用に予約する必要があるメモリーの量をバイト単位で指定します。デフォルト値は 32768 バイトです。

ingress.tuningOptions.headerBufferMaxRewriteBytes

int32 形式の integer。最小値は 4096 です。

IngressController 接続セッションの HTTP ヘッダーの書き換えと追加のために、headerBufferBytes から予約する必要があるメモリーの量 (バイト単位) を指定します。デフォルト値は 8192 バイトです。受信 HTTP リクエストは、headerBufferBytes バイトから headerBufferMaxRewriteBytes バイトを引いた値に制限されます。つまり、headerBufferBytes の値を headerBufferMaxRewriteByte の値よりも大きくする必要があります。

ingress.tuningOptions.healthCheckInterval: ""

次のパターンを持つ string: ^(0|((\\.[0-9])?(ns|us|µs|μs|ms|s|m|h))+)$

デフォルトの healthCheckInterval 値は 5s (5 秒) です。このパラメーター値は、ルーターに設定されたバックエンドに対する次回のヘルスチェックまでの間にルーターがどれだけの時間待機するかを定義します。現在、許容最小値は 1s、許容最大値は 2147483647m (24.85 日) です。この範囲は今後のリリースで変更される可能性があります。

ingress.tuningOptions.maxConnections

integer、有効な値: empty、0、-1、および 2000-2000000 の範囲

デフォルト値は 0 です。HAProxy プロセスごとに確立できる同時接続の最大数を定義します。この値を増やすと、消費されるシステムリソースが増える代わりに、各 Ingress コントローラー Pod がより多くの接続を処理できるようになります。

ingress.tuningOptions.serverFinTimeout

duration 形式の string

接続を閉じる前に、サーバーまたはバックエンドからのクライアントへのレスポンスを待機している間、接続を開いたままにする時間を定義します。デフォルトのタイムアウトは 1s です。

ingress.tuningOptions.serverTimeout

duration 形式の string

サーバーまたはバックエンドのレスポンスを待機している間、接続を開いたままにする時間を定義します。デフォルトのタイムアウトは 30s です。

ingress.tuningOptions.threadCount

int32 形式の integer。最小値は 1、最大値は 64 です。

HAProxy プロセスごとに作成されるスレッドの数を定義します。デフォルト値は 4 です。このフィールドが空の場合、デフォルト値が使用されます。

ingress.tuningOptions.tlsInspectDelay

duration 形式の string

一致するルートを検出するためにルーターがデータを保持できる時間を定義します。この間隔の設定値が短すぎると、より適合性の高い証明書を使用できる場合でも、ルーターがエッジ終端クライアントまたは再暗号化ルート用のデフォルト証明書に戻す可能性があります。

ingress.tuningOptions.tunnelTimeout

duration 形式の string

トンネルがアイドル状態の間、websocket を含むトンネル接続を開いたままにする時間を定義します。デフォルトのタイムアウトは 1h (1 時間) です。

kubelet

MicroShift の低レイテンシーの手順を参照してください

kubelet ノードエージェントのパススルー設定のパラメーター。低レイテンシー設定に使用されます。デフォルト値は null です。

manifests

list of paths

マニフェストをロードするために使用する kustomization ファイルをスキャンするファイルシステム上の場所。パスのリストを設定すると、それらのパスのみをスキャンします。マニフェストの読み込みを無効にするには、空のリストに設定します。リスト内のエントリーは、複数のサブディレクトリーに一致する glob パターンに指定できます。デフォルト値は、/usr/lib/microshift/manifests、/usr/lib/microshift/manifests.d/、/etc/microshift/manifests、/etc/microshift/manifests.d/ です。

network.clusterNetwork

IP アドレスブロック

Pod IP アドレスの割り当てに使用する IP アドレスのブロック。IPv4 がデフォルトのネットワークです。デュアルスタックエントリーはサポートされています。このフィールドの最初のエントリーは、MicroShift の起動後は変更できません。デフォルトの範囲は 10.42.0.0/16 です。

network.cniPlugin

String

空の場合、または "ovnk" に設定されている場合は、Open Virtual Networking - Kubernetes (OVN-K) ネットワークプラグインをデフォルトの Container Network Interface (CNI) としてデプロイします。サポートされる値は、空、""、または "ovnk" です。"none" に設定すると CNI が削除されるため、推奨されません。OVN-K のみが MicroShift により管理されます。

network.serviceNetwork

IP アドレスブロック

Kubernetes サービスの仮想 IP アドレスのブロック。サービスの IP アドレスプール。IPv4 がデフォルトです。デュアルスタックエントリーはサポートされています。このフィールドの最初のエントリーは、MicroShift の起動後は変更できません。デフォルトの範囲は 10.43.0.0/16 です。

network.serviceNodePortRange

range

NodePort タイプの Kubernetes サービスに許可されるポート範囲。指定しない場合、デフォルトの範囲の 30000-32767 が使用されます。NodePort が指定されていないサービスは、この範囲から自動的に割り当てられます。このパラメーターは、MicroShift の開始後に更新できます。

node.hostnameOverride

string

ノードの名前。デフォルト値はホスト名です。空でない場合、この文字列はホスト名ではなく、ノードを識別するために使用されます。この値は、MicroShift の起動後は変更できません。

node.nodeIP

IPv4 アドレス

ノードの IPv4 アドレス。デフォルト値は、デフォルトルートの IP アドレスです。

nodeIPv6

IPv6 アドレス

デュアルスタック設定のノードの IPv6 アドレス。IPv4 または IPv6 のいずれかのシングルスタックでは設定できません。デフォルトは空の値または null です。

storage.driver

none または lvms

デフォルト値は空です。空の値または null フィールドのデフォルトは LVMS デプロイメントです。

storage.optionalCsiComponents

array

デフォルト値は null または空の配列です。null または空の配列の場合、デフォルトで snapshot-controller がデプロイされます。指定可能な値は csi-snapshot-controller または none です。none のエントリーは、他のいかなる値とも同時に使用できません。