デフォルトの構成ファイルのオプション

Oracle CNE CLIのデフォルト構成ファイルに含めることができるオプションをリストします。

デフォルトの構成ファイルはYAML形式で、$HOME/.ocne/defaults.yamlに保存する必要があります。ファイルには、次のいずれかのオプションを含めることができます:

autoStartUI

クラスタのインスタンス化時にOracle CNE UIサービスへのトンネルを作成するかどうかを設定し、デフォルトのブラウザを起動してUIをロードします。たとえば:

autoStartUI: true

bootVolumeContainerImage

Oracle Container Host for Kubernetes (OCK)ブート可能イメージを含むコンテナ・イメージ・レジストリおよびタグ。デフォルトはcontainer-registry.oracle.com/olcne/ockです:1.31. たとえば:

bootVolumeContainerImage: container-registry.oracle.com/olcne/ock:1.31

clusterDefinition

クラスタ構成ファイルへのパス。このデフォルト構成ファイルで指定されていない複雑な構成を使用するクラスタに対して、この追加の構成レイヤーを指定します。たとえば:

clusterDefinition: mycluster.yaml

clusterDefinitionInline

インライン構成オプションを指定します。このデフォルト構成ファイルで指定されていない複雑な構成を使用するクラスタに対して、この追加の構成レイヤーを指定します。このオプションはclusterDefinitionとともに使用できません。たとえば:

clusterDefinitionInline: |
  key1: value1
  key2: value2

cni

クラスタのインスタンス化時にインストールするコンテナ・ネットワーキング・インタフェース(CNI)プロバイダ。値は、Oracle CNEで使用可能な任意のCNI、または別のCNIを手動またはアプリケーション・カタログを使用してデプロイする場合はnoneです。

ノート:

MultusはプライマリCNIとして使用できません。 Multusは、デフォルトのアプリケーション・カタログでアプリケーションとして使用できます。 Multusアプリケーションをインストールする場合は、このオプションをnoneに設定します。

たとえば:

cni: flannel

cni: none

communityCatalog

アーティファクト・ハブ・アプリケーション・カタログがインストールされているかどうかを設定します。これをtrueに設定すると、カタログがインストールされます。これをfalseに設定すると、カタログはインストールされません。デフォルトはfalseです。たとえば:

communityCatalog: true

ephemeralCluster

ホスト・システムで完了できないタスクを実行するために生成される可能性のある短期間のクラスタをカスタマイズできます。これは、ブートOCKイメージの変更またはKubernetesクラスタAPIリソースのデプロイによく使用されます。使用できるオプションは次のとおりです:

name

クラスタの名前。たとえば:

ephemeralCluster:
  name: mycluster

preserve

作業の完了後にエフェメラル・クラスタを自動的に削除するかどうかを設定します。デフォルトはfalseであるため、エフェメラル・クラスタは使用後に削除されます。たとえば:

ephemeralCluster:
  preserve: true

node

VMsの構成を設定します。たとえば:

ephemeralCluster:
  node:
    cpus: 2
    memory: 4GB
    storage: 15GB

extraIgnition

クラスタの作成時またはクラスタへのノードの結合時に含める追加のIgnition情報を含むIgnitionファイルへのパス。 Ignition情報は、「アップストリームIgnitionのドキュメント」に記載されているIgnition仕様v3.4.0に準拠し、Butane Fedora CoreOS仕様v1.5.0を使用してYAMLに記述する必要があります(「アップストリームButaneドキュメント」を参照)。たとえば:

extraIgnition: /home/username/.ocne/ignition.ign

extraIgnitionInline

クラスタの作成時またはクラスタへのノードの結合時に含める追加のイグニッション情報。 Ignition情報は、「アップストリームIgnitionのドキュメント」に記載されているIgnition仕様v3.4.0に準拠し、Butane Fedora CoreOS仕様v1.5.0を使用してYAMLに記述する必要があります(「アップストリームButaneドキュメント」を参照)。形式は次のとおりです:

extraIgnitionInline: |
  key1: value1
  key2: value2
  ...

headless

Oracle CNE UIをインストールするかどうかを設定します。これがtrueに設定されている場合、UIはインストールされません。デフォルトはfalseです。たとえば:

headless: true

kubeApiServerBindPort

Kubernetes APIサーバーが公開されるポートを設定します。デフォルトは6443です。たとえば:

kubeApiServerBindPort: 6443

kubeApiServerBindPortAlt

KeepalivedおよびNGINXロード・バランサを使用して高可用性クラスタをデプロイするときに、Kubernetes APIサーバーがリスニングするポートを設定します。デフォルトは6444です。たとえば:

kubeApiServerBindPortAlt: 6444

kubeconfig

実行中のクラスタを必要とする操作に使用するkubeconfigファイルへのパス。たとえば:

kubeconfig: /home/username/.kube/kubeconfig.utilitycluster

kubeProxyMode

kube-proxyのモード。これは、iptablesまたはipvsに設定できます。デフォルトはiptablesです。たとえば:

kubeProxyMode: ipvs

kube-proxyモードの詳細は、「アップストリームのKubernetesドキュメント」を参照してください。

kubernetesVersion

これにより、Kubernetesバージョンが定義されます。デフォルトは最新バージョンです。たとえば:

kubernetesVersion: 1.31

osRegistry

osTagと組み合せると、コンテナ・レジストリ内のOSTreeイメージが識別されます。 OSTreeトランスポートおよびコンテナ・レジストリURIを指定します。

トランスポートに使用できるプレフィクスは次のとおりです:

ostree-image-signed
ostree-remote-image
ostree-unverified-image
ostree-unverified-registry

デフォルト値は次のとおりです。

osRegistry: ostree-unverified-registry:container-registry.oracle.com/olcne/ock-ostree

osTag

osRegistryと組み合せると、コンテナ・レジストリ内のOSTreeイメージが識別されます。イメージのタグを指定します。たとえば:

osTag: 1.31

password

クラスタ・ノードによる認証を行うOCKイメージ・ユーザー(ocne)のハッシュ・パスワード。たとえば:

password: $6$jfkldjfsd$n1YMnpdxlGXO...

パスワードを引用符で囲むことはオプションです。

opensslユーティリティを使用して、ハッシュ・パスワードを作成できます。たとえば、SHA512アルゴリズムと自動saltを使用してハッシュ・パスワードを生成するには:

openssl passwd -6 -salt password

指定されたsaltフレーズを使用してSHA512ハッシュ・パスワードを生成するには:

openssl passwd -6 -salt saltphrase password

podSubnet

ポッド・ネットワークに使用するサブネット。 CNIは、このサブネットを使用するように自動的に構成されます。たとえば:

podSubnet: 10.244.0.0/16

providers

プロバイダ構成オプションを指定します。たとえば:

providers:
  libvirt:
    options
  oci:
    options
  byo: 
    options
  none:
    options

各プロバイダのオプションを次に示します:

proxy

プロキシ・サーバー情報。この情報は、Kubernetesノードで構成されます。たとえば:

proxy:
  httpsProxy: http://myproxy.example.com:2138
  httpProxy: http://myproxy.example.com:2138
  noProxy: .example.com,127.0.0.1,localhost,169.254.169.254,10.96.0.0/12,10.244.0.0/16

quiet

ocneコマンドで出力されるメッセージを減らすかどうかを設定します。これがtrueに設定されている場合、メッセージは削減されます。 falseに設定すると、メッセージは削減されません。デフォルトはfalseです。たとえば:

quiet: true

registry

コンテナ・イメージのプロビジョニング元のレジストリを設定します。デフォルトはcontainer-registry.oracle.comです。たとえば:

registry: myregistry.example.com

serviceSubnet

サービス・ネットワークに使用するサブネット。デフォルトは10.96.0.0/12です。たとえば:

serviceSubnet: 10.96.0.0/12

sshPublicKey

OCKイメージ・ユーザー(ocne)のRSAキー・ペアの公開キー。公開キー・ファイルの内容を貼り付けます。

たとえば:

sshPublicKey: | 
    ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAA...

sshPublicKeyPath

クラスタ・ノードによる認証を行うOCKイメージ・ユーザー(ocne)のRSAキー・ペアの公開キーへのパス。

sshPublicKeyPath: /home/username/.ssh/id_rsa.ocne

libvirtプロバイダ・オプション

libvirtプロバイダのオプションは次のとおりです:

controlPlaneNode

コントロール・プレーン・ノードの構成オプションを設定します。サイズを指定するには、次を使用します:

M: メガバイト
G: ギガバイト
Mi: メビバイト
Gi: ギビバイト

たとえば:

providers:
  libvirt:
    controlPlaneNode:
      cpu: 2
      memory: 16Gi
      storage: 8Gi

network

ドメインに使用する仮想ネットワークの名前。たとえば:

providers:
  libvirt:
    network: bridge-1

sshKey

SSH接続に使用するSSHキーへのパス。たとえば:

providers:
  libvirt:
    sshKey: /home/username/.ssh/id_rsa.ocne

storagePool

OCKイメージに使用するストレージ・プールの名前。たとえば:

providers:
  libvirt:
    storagePool: mypool

uri

libvirt接続URIのデフォルト値。たとえば、ローカル接続の場合:

providers:
  libvirt:
    uri: qemu:///system

リモート接続の場合:

providers:
  libvirt:
    uri: qemu+ssh://user@host/system

workerNode

ワーカー・ノードの構成オプションを設定します。サイズを指定するには、次を使用します:

M: メガバイト
G: ギガバイト
Mi: メビバイト
Gi: ギビバイト

たとえば:

providers:
  libvirt:
    workerNode:
      cpu: 2
      memory: 16Gi
      storage: 8Gi

OCI プロバイダ・オプション

ociプロバイダのオプションは次のとおりです:

compartment

リソースをデプロイするOCIコンパートメント。これは、コンパートメントへのパス(mytenancy/mycompartmentなど)またはコンパートメントのOCIDのいずれかです。たとえば:

providers:
  oci:
    compartment: OCID

controlPlaneShape

コントロール・プレーン・ノードの作成時にコンピュート・インスタンスに使用するシェイプの名前。たとえば:

providers:
  oci:
    controlPlaneShape:
      shape: VM.Standard.E4.Flex
      ocpus: 2

imageBucket

OCIオブジェクト・ストレージにアップロードされるときにOCKブート・イメージを格納するために使用するバケットのOCIDまたは名前。デフォルト名はocne-imagesです。たとえば:

providers:
  oci:
    imageBucket: ocne-images

images

コンピュート・リソースの初期ディスク・イメージとして使用するOCKイメージのOCI OCIDs。 amd64およびarm64アーキテクチャのオプションを設定します。たとえば:

providers:
  oci:
    images:
      amd64: OCID
      arm64: OCID

kubeconfig

ターゲット管理クラスタに使用するkubeconfigファイルへのパス。たとえば:

providers:
  oci:
    kubeconfig: /home/username/.kube/kubeconfig.mgmtcluster

loadBalancer

OCIロード・バランサをデフォルト・デプロイメント用にプロビジョニングする際に使用するサブネットのOCIDs。たとえば:

providers:
  oci:
    loadBalancer:
      subnet1: OCID
      subnet2: OCID

namespace

KubernetesクラスタAPIリソースがデプロイされるKubernetesネームスペース。

providers:
  oci:
    namespace: mynamespace

selfManaged

クラスタが自己管理であるかどうかを設定します。 trueに設定すると、クラスタには、独自のライフ・サイクルを管理するために必要なコントローラおよびリソースが含まれます。 falseに設定するか、または設定しない場合、これらのリソースは初期管理クラスタに残ります。たとえば:

providers:
  oci:
    selfManaged: true

profile

使用するOCI CLIプロファイルを設定します。これは、OCI CLI構成ファイル内のプロファイルの名前です。デフォルトのプロファイルはDEFAULTです。たとえば:

providers:
  oci:
    profile: MYTENANCY

vcn

デフォルト・デプロイメントのロード・バランサの作成時に使用するVirtual Cloud NetworkのOCID。

providers:
  oci:
    vcn: OCID

workerShape

ワーカー・ノードの作成時にコンピュート・インスタンスに使用するシェイプの名前。たとえば:

providers:
  oci:
    workerShape:
      shape: VM.Standard.E4.Flex
      ocpus: 2

独自の持込みプロバイダ・オプション

byoプロバイダのオプションは次のとおりです:

automaticTokenCreation

trueに設定した場合、結合トークンが必要なときはいつでも、コマンドの一部として自動的に作成されます。 falseに設定されている場合は、トークンを手動で作成する必要があります。たとえば:

providers:
  byo:
    automaticTokenCreation: false

networkInterface

CNIおよび他のKubernetesサービスがバインドするネットワーク・インタフェースを設定します。このオプションは必須です。たとえば:

providers:
  byo:
    networkInterface: enp1s0