11.6. Agent-based Installer のインストール設定パラメーター

apiVersion:

install-config.yaml コンテンツの API バージョン。現在のバージョンは v1 です。インストールプログラムは、古い API バージョンもサポートしている場合があります。

文字列

baseDomain:

クラウドプロバイダーのベースドメイン。ベースドメインは、OpenShift Container Platform クラスターコンポーネントへのルートを作成するために使用されます。クラスターの完全な DNS 名は、baseDomain と <metadata.name>.<baseDomain> 形式を使用する metadata.name パラメーターの値の組み合わせです。

example.com などの完全修飾ドメインまたはサブドメイン名。

metadata:

Kubernetes リソース ObjectMeta。ここからは name パラメーターのみが消費されます。

オブジェクト

metadata:
  name:

クラスターの名前。クラスターの DNS レコードはすべて {{.metadata.name}}.{{.baseDomain}} のサブドメインです。install-config.yaml ファイルまたは agent-config.yaml ファイルのいずれかを介して metadata.name を指定しない場合 (たとえば、ZTP マニフェストのみを使用する場合)、クラスター名は agent-cluster に設定されます。

dev などの小文字、ハイフン (-)、およびピリオド (.) が含まれる文字列。

platform:

インストールの実行に使用する特定プラットフォームの設定: baremetal、external、none、または vsphere。

オブジェクト

pullSecret:

Red Hat OpenShift Cluster Manager からプルシークレット を取得して、Quay.io などのサービスから OpenShift Container Platform コンポーネントのコンテナーイメージをダウンロードすることを認証します。

{
   "auths":{
      "cloud.openshift.com":{
         "auth":"b3Blb=",
         "email":"you@example.com"
      },
      "quay.io":{
         "auth":"b3Blb=",
         "email":"you@example.com"
      }
   }
}

networking:

クラスターのネットワークの設定。

オブジェクト

networking:
  networkType:

インストールする Red Hat OpenShift Networking ネットワークプラグイン。

OVNKubernetes。OVNKubernetes は、Linux ネットワークと、Linux サーバーと Windows サーバーの両方を含む Linux ネットワークおよびハイブリッドネットワーク用の CNI プラグインです。デフォルトの値は OVNKubernetes です。

networking:
  clusterNetwork:

Pod の IP アドレスブロック。

デフォルト値は 10.128.0.0/14 で、ホストの接頭辞は /23 です。

複数の IP アドレスブロックを指定する場合は、ブロックが重複しないようにしてください。

オブジェクトの配列。以下に例を示します。

networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23
  - cidr: fd01::/48
    hostPrefix: 64

networking:
  clusterNetwork:
    cidr:

networking.clusterNetwork を使用する場合に必須です。IP アドレスブロック。

OVN-Kubernetes ネットワークプラグインを使用する場合は、IPv4 および IPv6 ネットワークを指定できます。

CIDR (Classless Inter-Domain Routing) 表記の IP アドレスブロック。IPv4 ブロックの接頭辞長は 0 から 32 の間になります。IPv6 ブロックの接頭辞長は 0 から 128 までです。例: 10.128.0.0/14 または fd01::/48

networking:
  clusterNetwork:
    hostPrefix:

それぞれの個別ノードに割り当てるサブネット接頭辞長。たとえば、hostPrefix が 23 に設定される場合、各ノードに指定の cidr から /23 サブネットが割り当てられます。hostPrefix 値の 23 は、510 (2^(32 - 23) - 2) Pod IP アドレスを提供します。

サブネット接頭辞。

IPv4 ネットワークの場合、デフォルト値は 23 です。IPv6 ネットワークの場合、デフォルト値は 64 です。デフォルト値は、IPv6 の最小値でもあります。

networking:
  serviceNetwork:

サービスの IP アドレスブロック。デフォルト値は 172.30.0.0/16 です。

OVN-Kubernetes ネットワークプラグインは、サービスネットワークに対して単一の IP アドレスブロックのみをサポートします。

OVN-Kubernetes ネットワークプラグインを使用する場合、IPv4 および IPv6 アドレスファミリーの両方に IP アドレスブロックを指定できます。

CIDR 形式の IP アドレスブロックを持つ配列。以下に例を示します。

networking:
  serviceNetwork:
   - 172.30.0.0/16
   - fd02::/112

networking:
  machineNetwork:

マシンの IP アドレスブロック。

複数の IP アドレスブロックを指定する場合は、ブロックが重複しないようにしてください。

オブジェクトの配列。以下に例を示します。

networking:
  machineNetwork:
  - cidr: 10.0.0.0/16

networking:
  machineNetwork:
    cidr:

networking.machineNetwork を使用する場合に必須です。IP アドレスブロック。libvirt と IBM Power® Virtual Server を除くすべてのプラットフォームのデフォルト値は 10.0.0.0/16 です。libvirt の場合、デフォルト値は 192.168.126.0/24 です。IBM Power® Virtual Server の場合、デフォルト値は 192.168.0.0/24 です。

CIDR 表記の IP ネットワークブロック。

例: 10.0.0.0/16 または fd00::/48

additionalTrustBundle:

ノードの信頼済み証明書ストアに追加される PEM でエンコードされた X.509 証明書バンドル。この信頼バンドルは、プロキシーが設定される際にも使用できます。

文字列

capabilities:

オプションのコアクラスターコンポーネントのインストールを制御します。オプションのコンポーネントを無効にすることで、OpenShift Container Platform クラスターのフットプリントを削減できます。詳細は、インストール の「クラスター機能ページ」を参照してください。

文字列配列

capabilities:
  baselineCapabilitySet:

有効にするオプション機能の初期セットを選択します。有効な値は None、v4.11、v4.12、vCurrent です。デフォルト値は vCurrent です。

文字列

capabilities:
  additionalEnabledCapabilities:

オプションの機能のセットを、baselineCapabilitySet で指定したものを超えて拡張します。このパラメーターで複数の機能を指定できます。

文字列配列

cpuPartitioningMode:

ワークロードパーティション設定を使用して、OpenShift Container Platform サービス、クラスター管理ワークロード、およびインフラストラクチャー Pod を分離し、予約された CPU セットで実行できます。ワークロードパーティショニングはインストール中にのみ有効にすることができ、インストール後に無効にすることはできません。このフィールドはワークロードのパーティショニングを有効にしますが、特定の CPU を使用するようにワークロードを設定するわけではありません。詳細は、スケーラビリティとパフォーマンス セクションの ワークロードパーティショニング ページを参照してください。

None または AllNodes。デフォルト値は None です。

compute:

コンピュートノードを構成するマシンの設定。

MachinePool オブジェクトの配列。

compute:
  architecture:

プール内のマシンの命令セットアーキテクチャーを決定します。現在、さまざまなアーキテクチャーのクラスターはサポートされていません。すべてのプールは同じアーキテクチャーを指定する必要があります。有効な値は、amd64、arm64、ppc64le、および s390x です。

文字列

compute:
  hyperthreading:

コンピュートマシンで同時マルチスレッドまたは hyperthreading を有効/無効にするかどうか。デフォルトでは、同時スレッドはマシンのコアのパフォーマンスを上げるために有効にされます。

Enabled または Disabled

compute:
  name:

compute を使用する場合に必須です。マシンプールの名前。

worker

compute:
  platform:

compute を使用する場合に必須です。このパラメーターを使用して、ワーカーマシンをホストするクラウドプロバイダーを指定します。このパラメーターの値は controlPlane.platform パラメーターの値に一致する必要があります。

baremetal、vsphere、または {}

compute:
  replicas:

プロビジョニングするコンピュートマシン (ワーカーマシンとしても知られる) の数。

2 以上の正の整数。デフォルト値は 3 です。

featureSet:

機能セットのクラスターを有効にします。機能セットは、デフォルトで有効にされない OpenShift Container Platform 機能のコレクションです。インストール中に機能セットを有効にする方法の詳細は、「機能ゲートの使用による各種機能の有効化」を参照してください。

文字列。TechPreviewNoUpgrade など、有効にする機能セットの名前。

controlPlane:

コントロールプレーンを構成するマシンの設定。

MachinePool オブジェクトの配列。

controlPlane:
  architecture:

プール内のマシンの命令セットアーキテクチャーを決定します。現在、さまざまなアーキテクチャーのクラスターはサポートされていません。すべてのプールは同じアーキテクチャーを指定する必要があります。有効な値は、amd64、arm64、ppc64le、および s390x です。

文字列

controlPlane:
  hyperthreading:

コントロールプレーンマシンで同時マルチスレッドまたは hyperthreading を有効/無効にするかどうか。デフォルトでは、同時スレッドはマシンのコアのパフォーマンスを上げるために有効にされます。

Enabled または Disabled

controlPlane:
  name:

controlPlane を使用する場合に必須です。マシンプールの名前。

master

controlPlane:
  platform:

controlPlane を使用する場合に必須です。このパラメーターを使用して、コントロールプレーンマシンをホストするクラウドプロバイダーを指定します。このパラメーターの値は compute.platform パラメーターの値に一致する必要があります。

baremetal、vsphere、または {}

controlPlane:
  replicas:

プロビジョニングするコントロールプレーンマシンの数。

サポートされる値は 3、シングルノード OpenShift をデプロイする場合は 1 です。

credentialsMode:

Cloud Credential Operator (CCO) モード。モードを指定しないと、CCO は指定された認証情報の機能を動的に判別しようとします。この場合、複数のモードがサポートされるプラットフォームで Mint モードが優先されます。

Mint、Passthrough、Manual、または空の文字列 ("")。

fips:

FIPS モードを有効または無効にします。デフォルトは false (無効) です。FIPS モードが有効にされている場合、OpenShift Container Platform が実行される Red Hat Enterprise Linux CoreOS (RHCOS) マシンがデフォルトの Kubernetes 暗号スイートをバイパスし、代わりに RHCOS で提供される暗号モジュールを使用します。

false または true

imageContentSources:

release-image コンテンツのソースおよびリポジトリー。

オブジェクトの配列。この表の以下の行で説明されているように、source およびオプションで mirrors が含まれます。

imageContentSources:
  source:

imageContentSources を使用する場合に必須です。ユーザーが参照するリポジトリーを指定します (例: イメージプル仕様)。

文字列

imageContentSources:
  mirrors:

同じイメージが含まれる可能性のあるリポジトリーを 1 つ以上指定します。

文字列の配列。

publish:

Kubernetes API、OpenShift ルートなどのクラスターのユーザーに表示されるエンドポイントをパブリッシュまたは公開する方法。

Internal または External。デフォルト値は External です。

このパラメーターを Internal に設定することは、クラウド以外のプラットフォームではサポートされません。

sshKey:

クラスターマシンへのアクセスを認証するための SSH キー。

たとえば、sshKey: ssh-ed25519 AAAA.. です。

platform:
  baremetal:
    clusterProvisioningIP:

プロビジョニングサービスが実行されるクラスター内の IP アドレス。デフォルトは、プロビジョニングサブネットの 3 番目の IP アドレスに設定されます。たとえば、172.22.0.3 または 2620:52:0:1307::3 です。

IPV4 または IPV6 アドレス。

platform:
  baremetal:
    provisioningNetwork:

provisioningNetwork 設定は、クラスターがプロビジョニングネットワークを使用するかどうかを決定します。存在する場合、設定はクラスターがネットワークを管理するかどうかも決定します。

Managed: デフォルト。DHCP、TFTP などのプロビジョニングネットワークを完全に管理するには、このパラメーターを Managed に設定します。

Disabled: プロビジョニングネットワークの要件を無効にするには、このパラメーターを Disabled に設定します。Disabled に設定した場合、Day 2 に使用できるプロビジョニングが、仮想メディアベースのプロビジョニングだけになります。Disabledにして、電源管理を使用する場合、BMC はベアメタルネットワークからアクセスできる必要があります。Disabled の場合は、プロビジョニングサービスに使用するベアメタルネットワークに 2 つの IP アドレスを指定する必要があります。

Managed または Disabled。

platform:
  baremetal:
    provisioningMACAddress:

プロビジョニングサービスを実行するクラスター内の MAC アドレス。

MAC アドレス

platform:
  baremetal:
    provisioningNetworkCIDR:

プロビジョニングに使用するネットワークの CIDR。このオプションは、プロビジョニングネットワークでデフォルトのアドレス範囲を使用しない場合に必要です。

有効な CIDR (例: 10.0.0.0/16)。

platform:
  baremetal:
    provisioningNetworkInterface:

ベアメタルネットワークに接続されたノード上のネットワークインターフェイス名。provisioningNetworkInterface 設定を使用して NIC の名前を識別する代わりに、bootMACAddress 設定を使用して、Ironic が NIC の IP アドレスを識別できるようにします。

文字列。

platform:
  baremetal:
    provisioningDHCPRange:

プロビジョニングネットワーク上のノードの IP 範囲を定義します (例: 172.22.0.10,172.22.0.254)。

IP アドレスの範囲。

platform:
  baremetal:
    hosts:

ベアメタルホストの設定。

ホスト設定オブジェクトの配列。

platform:
  baremetal:
    hosts:
      name:

ホストの名前。

文字列。

platform:
  baremetal:
    hosts:
      bootMACAddress:

ホストのプロビジョニングに使用する NIC の MAC アドレス。

MAC アドレス

platform:
  baremetal:
    hosts:
      bmc:

ホストがベースボード管理コントローラー (BMC) に接続するための設定。

BMC 設定オブジェクトのディクショナリー。

platform:
  baremetal:
    hosts:
      bmc:
        username:

BMC のユーザー名。

文字列。

platform:
  baremetal:
    hosts:
      bmc:
        password:

BMC のパスワード。

文字列。

platform:
  baremetal:
    hosts:
      bmc:
        address:

ホストの BMC コントローラーと通信するための URL。address 設定ではプロトコルを指定します。たとえば、redfish+http://10.10.10.1:8000/redfish/v1/Systems/1234 を指定すると、Redfish が有効になります。詳細は、「installer-provisioned クラスターのベアメタルへのデプロイ」セクションの「BMC アドレス指定」を参照してください。

URL。

platform:
  baremetal:
    hosts:
      bmc:
        disableCertificateVerification:

redfish および redfish-virtualmedia では、このパラメーターで BMC アドレスを管理する必要があります。BMC アドレスに自己署名証明書を使用する場合は、値が True である必要があります。

ブール値。

platform:
  vsphere:

クラスターをホストするクラウドプラットフォーム上のアカウントを説明します。パラメーターを使用してプラットフォームをカスタマイズできます。マシンプール内のコンピュートマシンとコントロールプレーンマシンに追加の設定を指定する場合、このパラメーターは必要ありません。OpenShift Container Platform クラスターに指定できる vCenter サーバーは 1 つだけです。

vSphere 設定オブジェクトのディクショナリー

platform:
  vsphere:
    failureDomains:

リージョンとゾーン間の関係を確立します。障害ドメインは、datastore オブジェクトなどの vCenter オブジェクトを使用して定義します。障害ドメインは、OpenShift Container Platform クラスターノードの vCenter の場所を定義します。

障害ドメイン設定オブジェクトの配列。

platform:
  vsphere:
    failureDomains:
      name:

障害ドメインの名前。

文字列

platform:
  vsphere:
    failureDomains:
      region:

クラスターに複数の障害ドメインを定義する場合は、タグを各 vCenter データセンターにアタッチする必要があります。リージョンを定義するには、openshift-region タグカテゴリーのタグを使用します。単一の vSphere データセンター環境の場合、タグをアタッチする必要はありませんが、パラメーターに英数字の値 (例: datacenter) を入力する必要があります。

文字列

platform:
  vsphere:
    failureDomains:
      server:

クライアントが障害ドメインリソースにアクセスできるように、VMware vCenter Server の完全修飾ホスト名または IP アドレスを指定します。server ロールを vSphere vCenter サーバーの場所に適用する必要があります。

文字列

platform:
  vsphere:
    failureDomains:
      zone:

クラスターに複数の障害ドメインを定義する場合は、各 vCenter クラスターにタグをアタッチする必要があります。ゾーンを定義するには、openshift-zone タグカテゴリーのタグを使用します。単一の vSphere データセンター環境の場合、タグをアタッチする必要はありませんが、パラメーターに英数字の値 (例: cluster) を入力する必要があります。

文字列

platform:
  vsphere:
    failureDomains:
      topology:
        computeCluster:

vSphere コンピュートクラスターへのパス。

文字列

platform:
  vsphere:
    failureDomains:
      topology:
        datacenter:

OpenShift Container Platform 仮想マシン (VM) が動作するデータセンターをリストして定義します。データセンターのリストは、vcenters フィールドで指定したデータセンターのリストと一致する必要があります。

文字列

platform:
  vsphere:
    failureDomains:
      topology:
        datastore:

仮想マシンファイル、テンプレート、ISO イメージを保持する vSphere データストアへのパス。

文字列

platform:
  vsphere:
    failureDomains:
      topology:
        folder:

オプション: ユーザーが仮想マシンを作成する既存のフォルダーの絶対パス (例: /<data_center_name>/vm/<folder_name>/<subfolder_name>)。

文字列

platform:
  vsphere:
    failureDomains:
      topology:
        networks:

設定した仮想 IP アドレスと DNS レコードを含む vCenter インスタンス内のネットワークをリスト表示します。

文字列

platform:
  vsphere:
    failureDomains:
      topology:
        resourcePool:

オプション: このパラメーターは、インストールプログラムが仮想マシンを作成する既存のリソースプールの絶対パスを設定します (例: /<data_center_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>)。

文字列

platform:
  vsphere:
    failureDomains:
      topology
        template:

既存の Red Hat Enterprise Linux CoreOS (RHCOS) イメージテンプレートまたは仮想マシンへの絶対パスを指定します。その後、インストールプログラムはイメージテンプレートまたは仮想マシンを使用して、vSphere ホストに RHCOS を迅速にインストールできます。RHCOS イメージを vSphere ホストにアップロードする代わりに、このパラメーターを使用することを検討してください。このパラメーターは、installer-provisioned infrastructure でのみ使用できます。

文字列

platform:
  vsphere:
    vcenters:

サービスが vCenter サーバーと通信できるように接続の詳細を設定します。現在、単一の vCenter サーバーのみサポートされます。

vCenter 設定オブジェクトの配列。

platform:
  vsphere:
    vcenters:
      datacenters:

OpenShift Container Platform 仮想マシン (VM) が動作するデータセンターをリストして定義します。データセンターのリストは、failureDomains フィールドで指定されたデータセンターのリストと一致する必要があります。

文字列

platform:
  vsphere:
    vcenters:
      password:

vSphere ユーザーに関連付けられたパスワード。

文字列

platform:
  vsphere:
    vcenters:
      port:

vCenter サーバーとの通信に使用するポート番号。

整数

platform:
  vsphere:
    vcenters:
      server:

vCenter サーバーの完全修飾ホスト名 (FQHN) または IP アドレス。

文字列

platform:
  vsphere:
    vcenters:
      user:

vSphere ユーザーに関連付けられたユーザー名。

文字列

platform:
  vsphere:
    cluster:

OpenShift Container Platform クラスターをインストールする vCenter クラスター。

文字列

platform:
  vsphere:
    datacenter:

OpenShift Container Platform 仮想マシン (VM) が動作するデータセンターを定義します。

文字列

platform:
  vsphere:
    defaultDatastore:

ボリュームのプロビジョニングに使用するデフォルトデータストアの名前。

文字列

platform:
  vsphere:
    folder:

オプション: インストールプログラムが仮想マシンを作成する既存のフォルダーの絶対パス。この値を指定しない場合、インストールプログラムは、データセンターの仮想マシンフォルダーにインフラストラクチャー ID を使用して名前が付けられたフォルダーを作成します。

文字列 (例: /<data_center_name>/vm/<folder_name>/<subfolder_name>)

platform:
  vsphere:
    password:

vCenter ユーザー名のパスワード。

文字列

platform:
  vsphere:
    resourcePool:

オプション: インストールプログラムが仮想マシンを作成する既存のリソースプールの絶対パス。値を指定しない場合、インストールプログラムは /<data_center_name>/host/<cluster_name>/Resources の下のクラスターのルートにリソースをインストールします。

文字列 (例: /<data_center_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>)

platform:
  vsphere:
    username:

vCenter インスタンスに接続するために使用するユーザー名。このユーザーには、少なくとも vSphere の 静的または動的な永続ボリュームのプロビジョニング に必要なロールおよび権限がなければなりません。

文字列

platform:
  vsphere:
    vCenter:

vCenter サーバーの完全修飾ホスト名または IP アドレス。

文字列

apiVersion:

agent-config.yaml コンテンツの API バージョン。現在のバージョンは v1beta1 です。インストールプログラムは、古い API バージョンもサポートしている場合があります。

文字列

metadata:

Kubernetes リソース ObjectMeta。ここからは name パラメーターのみが消費されます。

オブジェクト

metadata:
  name:

クラスターの名前。クラスターの DNS レコードはすべて {{.metadata.name}}.{{.baseDomain}} のサブドメインです。agent-config.yaml ファイルに入力された値は無視され、代わりに install-config.yaml ファイルに指定された値が使用されます。install-config.yaml ファイルまたは agent-config.yaml ファイルのいずれかを介して metadata.name を指定しない場合 (たとえば、ZTP マニフェストのみを使用する場合)、クラスター名は agent-cluster に設定されます。

小文字いちぶハイフン (-) の文字列 (dev など)。

rendezvousIP:

ブートストラッププロセスを実行し、assisted-service コンポーネントを実行するノードの IP アドレス。networkConfig パラメーターで少なくとも 1 つのホストの IP アドレスを指定しない場合は、ランデブー IP アドレスを指定する必要があります。このアドレスが指定されていない場合、指定されたホストの networkConfig から 1 つの IP アドレスが選択されます。

IPV4 または IPV6 アドレス。

bootArtifactsBaseURL:

Agent-based Installer を使用して iPXE スクリプトを生成する際に、Preboot Execution Environment (PXE) アセットをアップロードするサーバーの URL。詳細は、「OpenShift Container Platform の PXE アセットの準備」を参照してください。

文字列。

additionalNTPSources:

すべてのクラスターホストに追加される Network Time Protocol (NTP) ソースのリスト。これらは、他の手段で設定された NTP ソースに追加されます。

ホスト名または IP アドレスのリスト。

hosts:

ホストの設定。オプションのホストリスト。定義されたホストの数は、install-config.yaml ファイルで定義されたホストの総数 (compute.replicas および controlPlane.replicas パラメーターの値の合計) を超えてはなりません。

ホスト設定オブジェクトの配列。

hosts:
  hostname:

ホスト名。動的ホスト設定プロトコル (DHCP) または逆引き DNS ルックアップから取得したホスト名をオーバーライドします。各ホストには、いずれかの手段で指定された一意のホスト名が必要ですが、このパラメーターを使用したホスト名の設定はオプションです。

文字列。

hosts:
  interfaces:

ホスト上のインターフェイスの名前と MAC アドレスのマッピングテーブルを提供します。agent-config.yaml ファイルに NetworkConfig セクションが指定されている場合は、このテーブルを含める必要があり、値は NetworkConfig セクションで指定されたマッピングと一致する必要があります。

ホスト設定オブジェクトの配列。

hosts:
  interfaces:
    name:

ホスト上のインターフェイスの名前。

文字列。

hosts:
  interfaces:
    macAddress:

ホスト上のインターフェイスの MAC アドレス。

たとえば 00-B0-D0-63-C2-26 などの MAC アドレス。

hosts:
  role:

ホストが master ノードと worker ノードのどちらであるかを定義します。agent-config.yaml ファイルにロールが定義されていない場合は、クラスターのインストール時にロールがランダムに割り当てられます。

master または worker。

hosts:
  rootDeviceHints:

特定デバイスへの Red Hat Enterprise Linux CoreOS (RHCOS) イメージのプロビジョニングを有効にします。インストールプログラムは、検出順にデバイスを検査し、検出された値をヒントの値と比較します。ヒントの値と一致する最初に検出されたデバイスが使用されます。これは、インストール中にオペレーティングシステムが書き込まれるデバイスです。

キーと値のペアのディクショナリー。詳細は、「OpenShift インストール環境のセットアップ」ページの「ルートデバイスのヒント」を参照してください。

hosts:
  rootDeviceHints:
    deviceName:

RHCOS イメージがプロビジョニングされるデバイスの名前。

文字列。

hosts:
  networkConfig:

ホストネットワーク定義。この設定は、nmstate ドキュメント で定義されている Host Network Management API と一致する必要があります。

ホストネットワーク設定オブジェクトのディクショナリー。