8.10. IBM Cloud のインストール設定パラメーター

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}} のサブドメインです。

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

platform:

インストールを実行する特定のプラットフォームの設定: aws、baremetal、azure、gcp、ibmcloud、nutanix、openstack、powervs、vsphere、または {}。platform.<platform> パラメーターに関する追加情報は、以下の表で特定のプラットフォームを参照してください。

オブジェクト

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

networking:
  clusterNetwork:
    cidr:

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

IPv4 ネットワーク

CIDR (Classless Inter-Domain Routing) 表記の IP アドレスブロック。IPv4 ブロックの接頭辞長は 0 から 32 の間になります。

networking:
  clusterNetwork:
    hostPrefix:

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

サブネット接頭辞。

デフォルト値は 23 です。

networking:
  serviceNetwork:

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

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

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

networking:
  serviceNetwork:
   - 172.30.0.0/16

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 です。クラスターを既存の Virtual Private Cloud (VPC) にデプロイする場合、CIDR には platform.ibmcloud.controlPlaneSubnets および platform.ibmcloud.computeSubnets で定義されたサブネットが含まれている必要があります。

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

例: 10.0.0.0/16

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 (デフォルト) です。

文字列

compute:
  hyperthreading:

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

Enabled または Disabled

compute:
  name:

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

worker

compute:
  platform:

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

aws、azure、gcp、ibmcloud、nutanix、openstack、powervs、vsphere、または {}

compute:
  replicas:

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

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

featureSet:

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

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

controlPlane:

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

MachinePool オブジェクトの配列。

controlPlane:
  architecture:

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

文字列

controlPlane:
  hyperthreading:

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

Enabled または Disabled

controlPlane:
  name:

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

master

controlPlane:
  platform:

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

aws、azure、gcp、ibmcloud、nutanix、openstack、powervs、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。プライベートクラスターをデプロイするには、publish を Internal に設定します。これはインターネットからアクセスできません。デフォルト値は External です。

sshKey:

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

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

controlPlane:
  platform:
    ibmcloud:
      bootVolume:
        encryptionKey:

IBM® Key Protect for IBM Cloud® (Key Protect) のルート鍵。コントロールプレーンマシンのルート (ブート) ボリュームの暗号化にのみ使用します。

ルート鍵の Cloud Resource Name (CRN)。

CRN は引用符 ("") で囲む必要があります。

compute:
  platform:
    ibmcloud:
      bootVolume:
        encryptionKey:

Key Protect ルート鍵。コンピュートマシンのみのルート (ブート) ボリュームの暗号化にのみ使用します。

ルート鍵の CRN。

CRN は引用符 ("") で囲む必要があります。

platform:
  ibmcloud:
    defaultMachinePlatform:
      bootvolume:
        encryptionKey:

Key Protect ルート鍵。クラスターのマシンすべてのルート (ブート) ボリュームの暗号化に使用します。

デフォルトのマシン設定の一部として指定されると、すべてのマネージドストレージクラスがこの鍵で更新されます。そのため、インストール後にプロビジョニングされるデータボリュームもこの鍵を使用して暗号化されます。

ルート鍵の CRN。

CRN は引用符 ("") で囲む必要があります。

platform:
  ibmcloud:
    resourceGroupName:

既存のリソースグループの名前。デフォルトでは、installer-provisioned VPC およびクラスターリソースは、このリソースグループに配置されます。指定しない場合、インストールプログラムはクラスターのリソースグループを作成します。クラスターを既存の VPC にデプロイする場合、installer-provisioned クラスターリソースは、このリソースグループに配置されます。指定しない場合、インストールプログラムはクラスターのリソースグループを作成します。プロビジョニングした VPC リソースは、networkResourceGroupName パラメーターを使用して指定したリソースグループに存在する必要があります。いずれの場合も、クラスターコンポーネントはリソースグループ内のすべてのリソースの所有権を引き受けるため、このリソースグループは単一のクラスターインストールのみに使用する必要があります。[¹]

文字列 (例: existing_resource_group)。

platform:
  ibmcloud:
    serviceEndpoints:
      - name:
        url:

サービスエンドポイント名と URI のリスト。

デフォルトでは、インストールプログラムとクラスターコンポーネントはパブリックサービスエンドポイントを使用して、必要な IBM Cloud® サービスにアクセスします。

ネットワーク制限によってパブリックサービスエンドポイントへのアクセスが制限されている場合は、代替サービスエンドポイントを指定してデフォルトの動作をオーバーライドできます。

次の各サービスに、代替サービスエンドポイントを 1 つだけ指定できます。

有効なサービスエンドポイント名と完全修飾 URI。

有効な名前は次のとおりです。

platform:
  ibmcloud:
    networkResourceGroupName:

既存のリソースグループの名前。このリソースには、クラスターがデプロイされる既存の VPC とサブネットが含まれています。このパラメーターは、プロビジョニングした VPC にクラスターをデプロイする際に必要です。

文字列 (例: existing_network_resource_group)。

platform:
  ibmcloud:
    dedicatedHosts:
      profile:

作成する新しい専用ホスト。platform.ibmcloud.dedicatedHosts.name に値を指定する場合、このパラメーターは必須ではありません。

cx2-host-152x304 などの有効な IBM Cloud® 専用ホストプロファイル。 [²]

platform:
  ibmcloud:
    dedicatedHosts:
      name:

既存の専用ホスト。platform.ibmcloud.dedicatedHosts.profile に値を指定する場合、このパラメーターは必須ではありません。

文字列、たとえば my-dedicated-host-name。

platform:
  ibmcloud:
    type:

すべての IBM Cloud® マシンのインスタンスタイプ。

bx2-8x32 などの有効な IBM Cloud® インスタンスタイプ。 [²]

platform:
  ibmcloud:
    vpcName:

クラスターをデプロイする既存 VPC の名前。

文字列。

platform:
  ibmcloud:
    controlPlaneSubnets:

コントロールプレーンマシンをデプロイする VPC の既存サブネットの名前。各アベイラビリティーゾーンのサブネットを指定します。

文字列配列

platform:
  ibmcloud:
    computeSubnets:

コンピュートマシンをデプロイする VPC の既存サブネットの名前。各アベイラビリティーゾーンのサブネットを指定します。サブネット ID はサポートされていません。

文字列配列