機械翻訳について
  1. Platform Command-Line Interface forリリース1.7
  2. Platform CLIのコマンド

4 Platform CLIコマンド

重要:

このドキュメントで説明されているソフトウェアは、Extended SupportまたはSustaining Supportにあります。 詳細は、「Oracleオープン・ソース・サポート・ポリシー」を参照してください。

このドキュメントに記載されているソフトウェアをできるだけ早くアップグレードすることをお勧めします。

この章では、使用方法や例など、各olcnectlコマンド・オプションの構文について説明します。

Certificates Copy

生成されたCA証明書および秘密キーをKubernetesノードにコピーします。

既存のセットから一連のノードのCA証明書と非公開キーをコピーしてインストールします。 ファイルは特定のディレクトリ構造内に保存する必要があります。

認証局バンドルを保存する必要があります: <cert-dir>/ca.cert.

各ノードの証明書を保存する必要があります: <cert-dir>/<node-address>/node.cert.

ノード・キーの保存先: <cert-dir>/<node-address>/node.key.

構文

olcnectl certificates copy
[--cert-dir certificate-directory]
[{-h|--help}]
{-n|--nodes} nodes
[{-R|--remote-command} remote-command]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]

説明:

--cert-dir certificate-directory

このユーティリティによって生成されたキー・データを読み書きするディレクトリ。 デフォルトは<CURRENT_DIR>/certificatesです。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

例

例4-1 ノードへの証明書のコピー

この例では、リストされているノードに証明書をコピーします。

olcnectl certificates copy \
--nodes operator.example.com,control1.example.com,worker1.example.com,worker2.example.com

Certificates Distribute

CA証明書およびキーを生成し、ノードに配布します。

構文

olcnectl certificates distribute
[--byo-ca-cert certificate-path]
[--byo-ca-key key-path]
[--cert-dir certificate-directory]
[--cert-request-common-name common_name]
[--cert-request-country country]
[--cert-request-locality locality]
[--cert-request-organization organization]
[--cert-request-organization-unit organization-unit]
[--cert-request-state state]
[{-h|--help}]
[{-n|--nodes} nodes]
[--one-cert]
[{-R|--remote-command} remote-command]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]
[{-y|--yes}]

説明:

--byo-ca-cert certificate-path

既存のパブリックCA証明書へのパス。

--byo-ca-key key-path

既存の秘密キーへのパス。

--cert-dir certificate-directory

このユーティリティによって生成されたキー・データを読み書きするディレクトリ。 デフォルトは<CURRENT_DIR>/certificatesです。

--cert-request-common-name common_name

証明書共通名サフィクス。 デフォルトはexample.comです。

--cert-request-country country

会社の2文字の国コード。たとえば、米国ではUS、英国ではGB、中国ではCNです。 デフォルトはUSです。

--cert-request-locality locality

会社が所在する市の名前。 デフォルトはRedwood Cityです。

--cert-request-organization organization

会社の名前。 デフォルトはOLCNEです。

--cert-request-organization-unit organization-unit

会社内の部門の名前。 デフォルトはOLCNEです。

--cert-request-state state

会社が所在する州または州の名前。 デフォルトはCaliforniaです。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

--one-cert

すべてのホストの認証に使用できる単一の証明書を生成するかどうかを設定します。 デフォルトでは、このオプションは設定されていません。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

例

例4-2 ノードへの証明書の配布

この例では、リストされているノードに証明書を配布します。 

olcnectl certificates distribute \
--nodes operator.example.com,control1.example.com,worker1.example.com,worker2.example.com

例4-3 証明書およびSSHログイン情報を持つノードの証明書の配布

この例では、リストされたノードの証明書を配布し、証明書およびSSHログイン情報を設定します。 これは、すべてのプロンプトも受け入れます。 

olcnectl certificates distribute \
--nodes operator.example.com,control1.example.com,worker1.example.com,worker2.example.com \
--cert-request-common-name cloud.example.com \
--cert-request-country US \
--cert-request-locality "My Town" \
--cert-request-organization "My Company" \
--cert-request-organization-unit "My Company Unit" \
--cert-request-state "My State" \
--ssh-identity-file ~/.ssh/id_rsa \
--ssh-login-name oracle \
--yes

例4-4 既存のCA証明書と秘密キーを使用してノードの証明書を配布

この例では、既存のCA証明書と非公開キーを使用して、リストされたノードの証明書を配布します。 これは、既存のKubernetesクラスタに追加するノードに証明書情報を生成およびコピーする場合に便利です。 

olcnectl certificates distribute \
--nodes worker3.example.com,worker4.example.com \
--byo-ca-cert /etc/olcne/configs/certificates/production/ca.cert \
--byo-ca-key /etc/olcne/configs/certificates/production/ca.key

例4-5 既存のCA証明書と秘密キーを使用してノードの証明書を配布

この例では、既存のCA証明書と非公開キーを使用して、リストされたノードの証明書を配布します。 これは、既存のKubernetesクラスタに追加するノードに証明書情報を生成およびコピーする場合に便利です。 

olcnectl certificates distribute \
--nodes worker3.example.com,worker4.example.com \
--byo-ca-cert $HOME/certificates/ca/ca.cert \
--byo-ca-key $HOME/certificates/ca/ca.key

例4-6 既存のCA証明書、秘密キーおよびSSHログイン情報を使用して、ノードの証明書を配布

この例では、既存のCA証明書と非公開キーを使用して、リストされたノードの証明書を配布します。 

olcnectl certificates distribute \
--nodes operator.example.com,control1.example.com,worker1.example.com,worker2.example.com \
--byo-ca-cert /etc/olcne/certificates/ca.cert \
--byo-ca-key /etc/olcne/certificates/ca.key

例4-7 既存のCA証明書、秘密キーおよびSSHログイン情報を使用して、ノードの証明書を配布

この例では、既存のCA証明書と非公開キーを使用して、リストされたノードの証明書を配布します。 

olcnectl certificates distribute \
--nodes operator.example.com,control1.example.com,worker1.example.com,worker2.example.com \
--byo-ca-cert $HOME/certificates/ca/ca.cert \
--byo-ca-key $HOME/certificates/ca/ca.key

Certificates Generate

ノードのCA証明書を生成します。

ホストのセットに対して、Platform CLI、Platform API ServerおよびPlatform Agentを認証するために必要なCA証明書およびキーを作成します。

認証局が作成された場合、そのキー・データは--cert-dirオプションで指定されたディレクトリに格納されます。 CA証明書はそのディレクトリ内のファイルca.certに書き込まれ、秘密キーはca.keyに書き込まれます。

構文

olcnectl certificates generate
[--byo-ca-cert certificate-path]
[--byo-ca-key key-path]
[--cert-dir certificate-directory]
[--cert-request-common-name common_name]
[--cert-request-country country]
[--cert-request-locality locality]
[--cert-request-organization organization]
[--cert-request-organization-unit organization-unit]
[--cert-request-state state]
[{-h|--help}]
{-n|--nodes} nodes
[--one-cert]

説明:

--byo-ca-cert certificate-path

既存のパブリックCA証明書へのパス。

--byo-ca-key key-path

既存の秘密キーへのパス。

--cert-dir certificate-directory

このユーティリティによって生成されたキー・データを読み書きするディレクトリ。 デフォルトは<CURRENT_DIR>/certificatesです。

--cert-request-common-name common_name

証明書共通名サフィクス。 デフォルトはexample.comです。

--cert-request-country country

会社の2文字の国コード。たとえば、米国ではUS、英国ではGB、中国ではCNです。 デフォルトはUSです。

--cert-request-locality locality

会社が所在する市の名前。 デフォルトはRedwood Cityです。

--cert-request-organization organization

会社の名前。 デフォルトはOLCNEです。

--cert-request-organization-unit organization-unit

会社内の部門の名前。 デフォルトはOLCNEです。

--cert-request-state state

会社が所在する州または州の名前。 デフォルトはCaliforniaです。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

--one-cert

すべてのホストの認証に使用できる単一の証明書を生成するかどうかを設定します。 デフォルトでは、このオプションは設定されていません。

例

例4-8 ノードの証明書の生成

この例では、リストされたノードの証明書を生成します。

olcnectl certificates generate \
--nodes operator.example.com,control1.example.com,worker1.example.com,worker2.example.com

例4-9 証明書情報を持つノードの証明書を生成

この例では、リストされたノードの証明書を生成し、証明書情報を設定します。

olcnectl certificates generate \
--nodes operator.example.com,control1.example.com,worker1.example.com,worker2.example.com \
--cert-request-common-name cloud.example.com \
--cert-request-country US \
--cert-request-locality "My Town" \
--cert-request-organization "My Company" \
--cert-request-organization-unit "My Company Unit" \
--cert-request-state "My State"

例4-10 既存のキー情報を使用してKubernetes ExternalIPsサービスの証明書を生成

この例では、既存のCA証明書および秘密キーを使用して、Kubernetes ExternalIPsサービスの証明書を生成します。

olcnectl certificates generate \
--nodes externalip-validation-webhook-service.externalip-validation-system.svc,\
externalip-validation-webhook-service.externalip-validation-system.svc.cluster.local \
--cert-dir /etc/olcne/certificates/restrict_external_ip/ \
--byo-ca-cert /etc/olcne/configs/certificates/production/ca.cert \
--byo-ca-key /etc/olcne/configs/certificates/production/ca.key \
--one-cert

例4-11 既存のキー情報を使用してKubernetes ExternalIPsサービスの証明書を生成

この例では、既存のCA証明書および秘密キーを使用して、Kubernetes ExternalIPsサービスの証明書を生成します。

olcnectl certificates generate \
--nodes externalip-validation-webhook-service.externalip-validation-system.svc,\
externalip-validation-webhook-service.externalip-validation-system.svc.cluster.local \
--cert-dir $HOME/certificates/restrict_external_ip/ \
--byo-ca-cert $HOME/certificates/ca/ca.cert \
--byo-ca-key $HOME/certificates/ca/ca.key \
--one-cert

例4-12 Kubernetes ExternalIPsサービスの証明書の生成

この例では、その時点で生成されるプライベートCA証明書および秘密キーを使用して、Kubernetes ExternalIPsサービスの証明書を生成します。 

olcnectl certificates generate \
--nodes externalip-validation-webhook-service.externalip-validation-system.svc,\
externalip-validation-webhook-service.externalip-validation-system.svc.cluster.local \
--cert-dir /etc/olcne/certificates/restrict_external_ip/ \
--cert-request-organization-unit "My Company Unit" \
--cert-request-organization "My Company" \
--cert-request-locality "My Town" \
--cert-request-state "My State" \
--cert-request-country US \
--cert-request-common-name cloud.example.com \
--one-cert

Completion

コマンドライン完了スクリプト(タブ完了スクリプトとも呼ばれる)を生成します。

構文

olcnectl completion 
shell
[--no-descriptions]
[{-h|--help}]

説明:

shell

シェル・タイプ。 オプションは次のとおりです。

  • bash: Bashシェルのコマンドライン完了スクリプトを生成します。

  • fish: fishシェルのコマンドライン完了スクリプトを生成します。

  • powershell: PowerShellシェルのコマンドライン完了スクリプトを生成します。

  • zsh: Zshシェルのコマンドライン完了スクリプトを生成します。

--no-descriptions

生成されたスクリプトの完了の説明を無効にします。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

例

例4-13 Bashのコマンドライン完了スクリプトの生成

この例では、Bashシェルのコマンドライン完了スクリプトを生成します。 

olcnectl completion bash

Environment Create

空の環境を作成します。

Oracle Cloud Native Environmentをデプロイする最初のステップは、空の環境を作成することです。 環境の作成には、Vaultによって提供される証明書を使用することも、ノードに存在している証明書を使用することもできます。

構文

olcnectl environment create 
{-E|--environment-name} environment_name 
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

ここで、globalsは:

{-a|--api-server} api_server_address:8091

環境のPlatform API Server。 これは、環境内でolcne-api-serverサービスを実行しているホストです。 api_server_addressの値は、Platform API ServerのIPアドレスまたはホスト名です。 ポート番号は、olcne-api-serverサービスが使用可能なポートです。 デフォルト・ポートは8091です。

Platform API Serverが指定されていない場合、ローカル・インスタンスが使用されます。 ローカル・インスタンスが設定されていない場合は、$HOME/.olcne/olcne.confファイルで構成されます。

Platform API Serverの設定の詳細は、「Platform API Serverの設定」を参照してください。

このオプションは、$OLCNE_API_SERVER_BIN環境変数にマップされます。 この環境変数が設定されている場合は、Platform CLIの設定よりも優先され、それをオーバーライドします。

--config-file path

環境およびモジュールの構成情報を含むYAMLファイルのロケーション。 ファイル名拡張子は、yamlまたはymlのいずれかにする必要があります。 このオプションを使用すると、--forceオプションを除くほかのすべてのコマンド行オプションは無視されます。 構成ファイルに含まれている情報のみが使用されます。

--secret-manager-type {file|vault}

シークレット・マネージャのタイプ。 オプションは、fileまたはvaultです。 ノードに保存されている証明書にはfileを使用し、Vaultによって管理されている証明書にはvaultを使用します。

--update-config

環境のグローバル引数がローカル構成ファイルに書き込まれ、それがPlatform API Serverへの今後のコールに使用されます。 このオプションが以前に使用されていなかった場合は、Platform API Serverのコールごとにグローバル引数を指定する必要があります。

グローバル引数の構成情報は、ローカル・ホストの$HOME/.olcne/olcne.confに保存されます。

Vaultを使用してノードの証明書を生成すると、証明書はローカル・ホストの$HOME/.olcne/certificates/environment_name/に保存されます。

--olcne-ca-path ca_path

事前定義済の認証局証明書へのパス。または、証明書のダウンロードにシークレット・マネージャを使用する場合は証明書のダウンロード先。 デフォルトは/etc/olcne/certificates/ca.certで、--update-configオプションが使用されている場合はローカル構成から収集されます。

このオプションは、$OLCNE_SM_CA_PATH環境変数にマップされます。 この環境変数が設定されている場合は、Platform CLIの設定よりも優先され、それをオーバーライドします。

--olcne-node-cert-path node_cert_path

事前定義済の証明書へのパス。または、証明書のダウンロードにシークレット・マネージャを使用している場合は証明書のダウンロード先。 デフォルトは/etc/olcne/certificates/node.certで、--update-configオプションが使用されている場合はローカル構成から収集されます。

このオプションは、$OLCNE_SM_CERT_PATH環境変数にマップされます。 この環境変数が設定されている場合は、Platform CLIの設定よりも優先され、それをオーバーライドします。

--olcne-node-key-path node_key_path

事前定義済のキーへのパス。または、キーのダウンロードにシークレット・マネージャを使用する場合はキーのダウンロード先。 デフォルトは/etc/olcne/certificates/node.keyで、--update-configオプションが使用されている場合はローカル構成から収集されます。

このオプションは、$OLCNE_SM_KEY_PATH環境変数にマップされます。 この環境変数が設定されている場合は、Platform CLIの設定よりも優先され、それをオーバーライドします。

--olcne-tls-cipher-suites ciphers

Oracle Cloud Native Environmentサービス(Platform AgentおよびPlatform API Server)に使用するTLS暗号スイート。 カンマ区切りリストで1つ以上入力します。 オプションは次のとおりです。

  • TLS_AES_128_GCM_SHA256

  • TLS_AES_256_GCM_SHA384

  • TLS_CHACHA20_POLY1305_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA

  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA

  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384

  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305

  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA

  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305

  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256

  • TLS_ECDHE_RSA_WITH_RC4_128_SHA

  • TLS_RSA_WITH_3DES_EDE_CBC_SHA

  • TLS_RSA_WITH_AES_128_CBC_SHA

  • TLS_RSA_WITH_AES_128_CBC_SHA256

  • TLS_RSA_WITH_AES_128_GCM_SHA256

  • TLS_RSA_WITH_AES_256_CBC_SHA

  • TLS_RSA_WITH_AES_256_GCM_SHA384

  • TLS_RSA_WITH_RC4_128_SHA

たとえば:

--olcne-tls-cipher-suites TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

このオプションは、$OLCNE_TLS_CIPHER_SUITES環境変数にマップされます。 この環境変数が設定されている場合は、Platform CLIの設定よりも優先され、それをオーバーライドします。

--olcne-tls-max-version version

Oracle Cloud Native EnvironmentコンポーネントのTLS最大バージョン。 デフォルトはVersionTLS12です。 オプションは次のとおりです。

  • VersionTLS10

  • VersionTLS11

  • VersionTLS12

  • VersionTLS13

このオプションは、$OLCNE_TLS_MAX_VERSION環境変数にマップされます。 この環境変数が設定されている場合は、Platform CLIの設定よりも優先され、それをオーバーライドします。

--olcne-tls-min-version version

Oracle Cloud Native EnvironmentコンポーネントのTLS最小バージョン。 デフォルトはVersionTLS12です。 オプションは次のとおりです。

  • VersionTLS10

  • VersionTLS11

  • VersionTLS12

  • VersionTLS13

このオプションは、$OLCNE_TLS_MIN_VERSION環境変数にマップされます。 この環境変数が設定されている場合は、Platform CLIの設定よりも優先され、それをオーバーライドします。

--vault-address vault_address

VaultインスタンスのIPアドレス。 デフォルトはhttps://127.0.0.1:8200ですが、--update-configオプションを使用するとローカル構成から収集されます。

--vault-cert-sans vault_cert_sans

Oracle Cloud Native Environment証明書を生成するためにVaultに渡すサブジェクト代替名(SAN)。 デフォルトは127.0.0.1ですが、--update-configオプションを使用するとローカル構成から収集されます。

--vault-token vault_token

Vault認証トークン。

例

例4-14 Vaultを使用した環境の作成

Vaultインスタンスから生成された証明書を使用してmyenvironmentという環境を作成するには、--secret-manager-type vaultオプションを使用します。 

olcnectl environment create \
--api-server 127.0.0.1:8091 \
--environment-name myenvironment \
--secret-manager-type vault \
--vault-token s.3QKNuRoTqLbjXaGBOmO6Psjh \
--vault-address https://192.0.2.20:8200 \
--update-config

例4-15 証明書を使用した環境の作成

ノードのファイル・システム上の証明書を使用してmyenvironmentという環境を作成するには、--secret-manager-type fileオプションを使用します。 

olcnectl environment create \
--api-server 127.0.0.1:8091 \
--environment-name myenvironment \
--secret-manager-type file \
--olcne-node-cert-path /etc/olcne/certificates/node.cert \
--olcne-ca-path /etc/olcne/certificates/ca.cert \
--olcne-node-key-path /etc/olcne/certificates/node.key \
--update-config

Environment Delete

既存のキーを削除します。

削除する前に、環境からすべてのモジュールをアンインストールする必要があります。

構文

olcnectl environment delete 
{-E|--environment-name} environment_name
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-16 環境の削除

myenvironmentという環境を削除するには: 

olcnectl environment delete \
--environment-name myenvironment

Environment Update

既存の環境のノードでPlatform Agentを更新またはアップグレードします。

構文

olcnectl environment update 
olcne
{-E|--environment-name} environment_name
[{-N|--name} name] 
[{-h|--help}]
[globals]

説明:

olcne

環境内の各ノードでPlatform Agentを更新することを指定します。

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

Platform Agentは、このモジュールで使用されているノードでのみ更新されます。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-17 Platform Agentの更新

myenvironmentという名前の環境の各ノードでPlatform Agentを更新するには: 

olcnectl environment update olcne \
--environment-name myenvironment

例4-18 モジュールのPlatform Agentの更新

myenvironmentという名前の環境のmyclusterという名前のKubernetesモジュールの各ノードでPlatform Agentを更新するには: 

olcnectl environment update olcne \
--environment-name myenvironment \
--name mycluster

Environment Report

環境に関するサマリーおよび詳細情報を報告します。

構文

olcnectl environment report 
[{-E|--environment-name} environment_name]
[--children]
[--exclude pattern]
[--include pattern]
[--format {yaml|table}] 
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

--children

このオプションをコマンドに追加すると、モジュール・インスタンスのすべての子のプロパティが再帰的に表示されます。 デフォルト値は、falseです。

--exclude pattern

レポートから除外するプロパティを選択するRE2正規表現。 このオプションでは、複数のプロパティをカンマ区切りリストとして指定できます。

--include pattern

レポートに含めるプロパティを選択するRE2正規表現。 このオプションでは、複数のプロパティをカンマ区切りリストとして指定できます。 デフォルトでは、すべてのプロパティが表示されます。 このオプションを使用すると、この動作が1回以上オーバーライドされます。

--format {yaml|table}

YAMLまたは表形式でレポートを生成するには、このオプションを使用します。 デフォルトの形式はtableです。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-19 環境に関するサマリー詳細のレポート

myenvironmentという名前の環境に関するサマリーをレポートするには: 

olcnectl environment report \
--environment-name myenvironment

例4-20 環境に関する詳細のレポート

myenvironmentという名前の環境の詳細をレポートするには: 

olcnectl environment report \
--environment-name myenvironment \
--children

Module Backup

環境内のモジュールをバックアップします。

構文

olcnectl module backup 
{-E|--environment-name} environment_name 
{-N|--name} name
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-21 コントロール・プレーン・ノードのバックアップ

myenvironmentという環境に含まれるmyclusterというkubernetesモジュールのKubernetesコントロール・プレーン・ノードの構成をバックアップするには: 

olcnectl module backup \
--environment-name myenvironment \
--name mycluster

Module Create

環境にモジュールを追加して構成します。

構文

olcnectl module create 
{-E|--environment-name} environment_name 
{-M|--module} module 
{-N|--name} name
[{-h|--help}]
[module_args ...]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-M|--module} module

環境に作成するモジュール・タイプ。 moduleの値は、モジュール・タイプの名前です。 使用可能なモジュールタイプは次のとおりです。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

ここで、module_argsは:

module_argsの値は、1つの環境でモジュールを構成するための1つ以上の引数です。

kubernetesモジュールのmodule_args:

{-o|--apiserver-advertise-address} IP_address

KubernetesクラスタのメンバーにKubernetes APIサーバーを通知するためのIPアドレス。 このアドレスは、クラスタのノードからアクセスできる必要があります。 値が指定されていない場合、コントロール・プレーン・ノードのインタフェースは--control-plane-nodes引数で指定されます。

このオプションは、多くのコントロール・プレーン・ノードを持つ高可用性(HA)クラスタでは使用されません。

重要:

この引数は非推奨になりました。 かわりに--control-plane-nodes引数を使用します。

{-b|--apiserver-bind-port} port

Kubernetes APIサーバーのバインド・ポート。 デフォルトは6443です。

{-B|--apiserver-bind-port-alt} port

ロード・バランサに仮想IPアドレスを使用するときに、Kubernetes APIサーバーがリスニングするポート。 デフォルトは6444です。 これはオプションです。

仮想IPアドレスを使用すると、Kubernetes APIサーバー・ポートがデフォルトの6443から6444に変更されます。 ロード・バランサはポート6443でリスニングして、受信したリクエストをKubernetes APIサーバーに渡します。 この状況でKubernetes APIサーバー・ポートを6444から変更するには、このオプションを使用します。

{-e|--apiserver-cert-extra-sans} api_server_sans

Kubernetes APIサーバーによる証明書の提供に使用するサブジェクト代替名(SAN)。 この値には、IPアドレスとDNS名の両方を含めることができます。

--compact {true|false}

システム以外のKubernetesワークロードをコントロール・プレーン・ノードで実行できるようにするかどうかを設定します。 デフォルトは、falseです。

これをtrueに設定すると、Platform API Serverはコントロール・プレーン・ノードを汚染しません。 これにより、システム以外のKubernetesワークロードをスケジュールし、コントロール・プレーン・ノードで実行できます。

重要:

本番環境では、このオプションをfalse (デフォルト)に設定する必要があります。

{-r|--container-registry} container_registry

Kubernetesイメージを格納しているコンテナ・レジストリ。 container-registry.oracle.com/olcneを使用して、Oracle Container RegistryからKubernetesイメージをプルします。

この値を指定していないと、Platform CLIから値の指定が求められます。

{-c|--control-plane-nodes} nodes ...

Kubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト(Platform Agentのポート番号を含めます)。 たとえば、control1.example.com:8090,control2.example.com:8090などです。

この値を指定していないと、Platform CLIから値の指定が求められます。

{-x|--kube-proxy-mode} {userspace|iptables|ipvs}

Kubernetesプロキシのルーティング・モード。 デフォルトはiptablesです。 使用可能なプロキシのモードは次のとおりです。

  • userspace: 従来のプロキシ・モードです。

  • iptables: 最速のプロキシ・モードです。 これはデフォルトのモードです。

  • ipvs: 試験的なモードです。

値を指定しないと、デフォルトのiptablesが使用されます。 システムのカーネルまたはiptablesのバージョンが不十分な場合は、userspaceプロキシが使用されます。

{-v|--kube-version} version

インストールするKubernetesのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

{-t|--kubeadm-token} token

Kubernetesノードとコントロール・プレーン・ノードの間の双方向信頼を確立するために使用するトークン。 この形式は[a-z0-9]{6}\.[a-z0-9]{16}です。たとえば、abcdef.0123456789abcdefのようになります。

--kube-tls-cipher-suites ciphers

Kubernetesコンポーネントに使用するTLS暗号スイート。 カンマ区切りリストで1つ以上入力します。 オプションは次のとおりです。

  • TLS_AES_128_GCM_SHA256

  • TLS_AES_256_GCM_SHA384

  • TLS_CHACHA20_POLY1305_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA

  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA

  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384

  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305

  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA

  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305

  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256

  • TLS_ECDHE_RSA_WITH_RC4_128_SHA

  • TLS_RSA_WITH_3DES_EDE_CBC_SHA

  • TLS_RSA_WITH_AES_128_CBC_SHA

  • TLS_RSA_WITH_AES_128_CBC_SHA256

  • TLS_RSA_WITH_AES_128_GCM_SHA256

  • TLS_RSA_WITH_AES_256_CBC_SHA

  • TLS_RSA_WITH_AES_256_GCM_SHA384

  • TLS_RSA_WITH_RC4_128_SHA

たとえば:

--kube-tls-cipher-suites TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

--kube-tls-min-version version

KubernetesコンポーネントのTLS最小バージョン。 デフォルトはVersionTLS12です。 オプションは次のとおりです。

  • VersionTLS10

  • VersionTLS11

  • VersionTLS12

  • VersionTLS13

{-l|--load-balancer} load_balancer

Kubernetes APIサーバー・ロード・バランサのホスト名またはIPアドレスとポート。 デフォルト・ポートは6443です。 たとえば、192.0.2.100:6443などです。

{-m|--master-nodes} nodes ...

Kubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト(Platform Agentのポート番号を含めます)。 たとえば、control1.example.com:8090,control2.example.com:8090などです。

この値を指定していないと、Platform CLIから値の指定が求められます。

重要:

このオプションは非推奨です。 代わりに--control-plane-nodesオプションを使用してください。
{-g|--nginx-image} container_location

多くのコントロール・プレーン・ノードを持つ高可用性(HA)クラスタで使用するNGINXコンテナ・イメージのロケーション。 これはオプションです。

このオプションは、--load-balancerオプションを使用してロード・バランサを指定しない場合に使用できます。 このオプションは、ミラー化コンテナ・レジストリを使用している場合に役立ちます。 たとえば:

--nginx-image mirror.example.com:5000/olcne/nginx:1.17.7

デフォルトでは、podmanは、/usr/libexec/pull_olcne_nginxで構成されているNGINXイメージのプルに使用されます。 別のNGINXコンテナ・イメージを使用するために--nginx-imageオプションを設定すると、そのイメージの場所が/etc/olcne-nginx/imageに書き込まれ、デフォルト・イメージがオーバーライドされます。

--node-labels label

重要:

このオプションと、このオプションを必要とするOracle Cloud Infrastructureコンテナ・ストレージ・インタフェース・モジュール(oci-csi)は、リリース1.5では非推奨です。

ポッドの可用性ドメインを設定するために、Oracle Cloud InfrastructureインスタンスのKubernetesノードに追加するラベル。 このオプションは、Oracle Cloud Infrastructureコンテナ・ストレージ・インタフェース・モジュール(oci-csi)とともに使用します。 ラベル形式は次のとおりです:

failure-domain.beta.kubernetes.io/zone=region-identifier-AD-availability-domain-number

たとえば:

--node-labels failure-domain.beta.kubernetes.io/zone=US-ASHBURN-AD-1

アベイラビリティ・ドメインのリストは、「Oracle Cloud Infrastructureのドキュメント」を参照してください。

--node-ocids OCIDs

重要:

このオプションと、このオプションを必要とするOracle Cloud Infrastructureコンテナ・ストレージ・インタフェース・モジュール(oci-csi)は、リリース1.5では非推奨です。

Oracle Cloud Identifier (OCID)を使用したKubernetesノード(コントロール・プレーンとワーカー・ノードの両方)のカンマ区切りリスト。 このオプションは、Oracle Cloud Infrastructureコンテナ・ストレージ・インタフェース・モジュール(oci-csi)とともに使用します。 リストの形式は次のとおりです:

FQDN=OCID,...

たとえば:

--node-ocids control1.example.com=ocid1.instance...,worker1.example.com=ocid1.instance...,worker2.example.com=ocid1.instance...

OCIDの詳細は、「Oracle Cloud Infrastructureのドキュメント」を参照してください。

{-p|--pod-cidr} pod_CIDR

KubernetesポッドのCIDR。 デフォルトは10.244.0.0/16です。 これは、各Kubernetesポッド・ネットワーク・インタフェースに割り当てられるIPアドレスの範囲です。

{-n|--pod-network} {flannel|calico|none}
Kubernetesクラスタのネットワーク・ファブリック。 オプションは次のとおりです。
  • flannel: Flannelをインストールします。 これがデフォルトです。
  • calico: Calicoモジュールをインストールします。 このオプションを使用するには、すべてのKubernetesノードでfirewalldを無効にする必要があります。
  • none: ネットワーク・ファブリックをインストールしません。
{-P|--pod-network-iface} network_interface

Kubernetesデータ・プレーン・ネットワーク通信に使用するノード上のネットワーク・インタフェースの名前。 データ・プレーン・ネットワークは、Kubernetesで実行されているポッドによって使用されます。 regexを使用してインタフェース名を設定する場合、カーネルによって返された最初に一致するインタフェースが使用されます。 たとえば:

--pod-network-iface "ens[1-5]|eth5"

--selinux {enforcing|permissive}

SELinuxのenforcingモードかpermissiveモードのどちらを使用するか。デフォルトはpermissiveです。

このオプションは、コントロール・プレーンおよびワーカー・ノードでSELinuxがenforcingに設定されている場合に使用します。 SELinuxは、OSではデフォルトでenforcingモードに設定されており、推奨モードです。

{-s|--service-cidr} service_CIDR

KubernetesサービスのCIDR。 デフォルトは10.96.0.0/12です。 これは、各Kubernetesサービスに割り当てられるIPアドレスの範囲です。

{-i|--virtual-ip} virtual_ip

ロード・バランサの仮想IPアドレス。 これはオプションです。

このオプションは、--load-balancerオプションを使用してロード・バランサを指定しない場合に使用します。 仮想IPアドレスを指定すると、それがコントロール・プレーン・ノードのプライマリIPアドレスとして使用されます。

{-w|--worker-nodes} nodes ...

Kubernetesワーカー・ノードのホスト名またはIPアドレス(Platform Agentのポート番号を含む)のカンマ区切りリスト。 ワーカー・ノードがNATゲートウェイの背後にある場合は、ノードのパブリックIPアドレスを使用します。 NATゲートウェイの背後にあるワーカー・ノードのインタフェースには、Kubernetesクラスタからアクセス可能な /32サブネット・マスクを使用するパブリックIPアドレスが必要です。 /32サブネットは、サブネットを1つのIPアドレスに制限し、KubernetesクラスタからのすべてのトラフィックがこのパブリックIPアドレスを流れるようにします(NATの構成の詳細は、「スタート・ガイド」を参照してください)。 デフォルトのポート番号は8090です。 たとえば、worker1.example.com:8090,worker2.example.com:8090のようにします。

この値を指定していないと、Platform CLIから値の指定が求められます。

--restrict-service-externalip {true|false}

Kubernetesサービスの外部IPアドレスへのアクセスを制限するかどうかを設定します。 デフォルトはtrueで、外部IPアドレスへのアクセスが制限されます。

このオプションは、externalip-validation-webhook-serviceという名前のKubernetesサービスをデプロイして、Kubernetesサービス構成ファイルに設定されているexternalIPsを検証します。 外部IPアドレスへのアクセスは、specセクションのexternalIPsオプションを使用して、Kubernetesサービス構成ファイルで設定されます。

--restrict-service-externalip-ca-cert path

--restrict-service-externalipオプションがtrueに設定されている場合にデプロイされるexternalip-validation-webhook-serviceアプリケーションのCA証明書ファイルへのパス。 たとえば、/etc/olcne/certificates/restrict_external_ip/ca.certなどです。

--restrict-service-externalip-tls-cert path

--restrict-service-externalipオプションがtrueに設定されている場合にデプロイされるexternalip-validation-webhook-serviceアプリケーションのCA証明書ファイルへのパス。 たとえば、/etc/olcne/certificates/restrict_external_ip/node.certなどです。

--restrict-service-externalip-tls-key path

--restrict-service-externalipオプションがtrueに設定されている場合にデプロイされるexternalip-validation-webhook-serviceアプリケーションの秘密キーへのパス。 たとえば、/etc/olcne/certificates/restrict_external_ip/node.keyなどです。

--restrict-service-externalip-cidrs allowed_cidrs

指定されたCIDRブロックからのIPアドレスのみを許可するには、1つ以上のカンマ区切りのCIDRブロックを入力します。 たとえば、192.0.2.0/24,198.51.100.0/24などです。

calicoモジュールのmodule_args:

--calico-container-registry container_registry

Calicoコンテナ・イメージのデプロイ時に使用するコンテナ・イメージ・レジストリ。 デフォルトはcontainer-registry.oracle.com/olcneです。

--calico-helm-module helm_module

Calicoモジュールが関連付けられるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--calico-kubernetes-moduleオプションを使用してください。
--calico-kubernetes-module kubernetes_module

Calicoモジュールが関連付けられるkubernetesモジュールの名前。

--calico-installation-config config-file-path

Calico構成ファイルのパスおよびロケーション。

--calico-namespace namespace

CalicoコンポーネントがデプロイされるKubernetesネームスペース。 デフォルトはtigera-operatorです。

--calico-version version

インストールするCalicoのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

multusモジュールのmodule_args:

--multus-config config-file-path

Multus構成ファイルのパスとロケーション。

--multus-container-registry container_registry

Multusコンテナ・イメージをデプロイするときに使用するコンテナ・イメージ・レジストリ。 デフォルトはcontainer-registry.oracle.com/olcneです。

--multus-helm-module helm_module

Multusモジュールが関連付けられるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--multus-kubernetes-moduleオプションを使用してください。
--multus-kubernetes-module kubernetes_module

Multusモジュールが関連付けられるkubernetesモジュールの名前。

--multus-namespace namespace

MultusコンポーネントがデプロイされるKubernetesネームスペース。 デフォルトはkube-systemです。

--multus-version version

インストールするMultusのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

oci-ccmモジュールのmodule_args:

--oci-ccm-helm-module helm_module

Oracle Cloud Infrastructure Cloud Controller Managerモジュールが関連付けられるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--oci-ccm-kubernetes-moduleオプションを使用してください。
--oci-ccm-kubernetes-module kubernetes_module

Oracle Cloud Infrastructure Cloud Controller Managerモジュールが関連付けられるkubernetesモジュールの名前。

--oci-tenancy OCID

Oracle Cloud InfrastructureテナンシのOCID。

--oci-region region_identifier

Oracle Cloud Infrastructureリージョン識別子。 デフォルトはus-ashburn-1です。

リージョン識別子のリストは、「Oracle Cloud Infrastructureのドキュメント」を参照してください。

--oci-compartment OCID

Oracle Cloud InfrastructureコンパートメントのOCID。

--oci-user OCID

Oracle Cloud InfrastructureユーザーのOCID。

--oci-private-key path

Oracle Cloud Infrastructure API署名キーの秘密キーのロケーション。 秘密キーはプライマリ・コントロール・プレーン・ノード上にある必要があります。 デフォルトは/root/.ssh/id_rsaです。

重要:

このオプションは、リリース1.6.1では非推奨です。 リリース1.6.1以降では、代わりに--oci-private-key-fileオプションを使用します。

--oci-private-key-file path

Oracle Cloud Infrastructure API署名キーの秘密キーのロケーション。

重要:

秘密キーはオペレータ・ノードで使用可能である必要があります。

--oci-fingerprint fingerprint

Oracle Cloud Infrastructure API署名キーの公開キーのフィンガープリント。

--oci-passphrase passphrase

Oracle Cloud Infrastructure API署名キーの秘密キーのパスフレーズ(設定されている場合)。

--oci-vcn OCID

Kubernetesクラスタが使用可能なOracle Cloud Infrastructure Virtual Cloud NetworkのOCID。

--oci-lb-subnet1 OCID

「Oracle Cloud Infrastructureロード・バランサ」のリージョナル・サブネットのOCID。

または、「Oracle Cloud Infrastructureロード・バランサ」に必要な2つの可用性ドメイン固有のサブネットの最初のサブネットのOCID。 サブネットは個別の可用性ドメインに存在する必要があります。

--oci-lb-subnet2 OCID

「Oracle Cloud Infrastructureロード・バランサ」の2つのサブネットの2番目のサブネットのOCID。 サブネットは個別の可用性ドメインに存在する必要があります。

--oci-lb-security-mode {All|Frontend|None}

このオプションは、Oracle Cloud Infrastructure Cloud Controller Managerモジュールがロード・バランサ・サービスのセキュリティ・リストを管理するかどうかを設定します。 このオプションは、Kubernetes Cloud Controller Managerによって管理されるセキュリティ・リストに使用される構成モードを設定します。 デフォルトはNoneです。

セキュリティ・モードの詳細は、「Oracle Cloud InfrastructureドキュメントのKubernetes Cloud Controller Manager実装」を参照してください。

--oci-use-instance-principals {true|false}

インスタンスがOracle Cloud InfrastructureサービスでAPIコールを実行できるようにするかどうかを設定します。 デフォルトは、falseです。

--oci-container-registry container_registry

Oracle Cloud Infrastructureクラウド・プロビジョナ・イメージのデプロイ時に使用するコンテナ・イメージ・レジストリ。 デフォルトは空の文字列です。 Platform API Serverは、インストールされるOracle Cloud Infrastructure Cloud Controller Managerモジュールのバージョンに対して正しいリポジトリを決定します。 プライベート・レジストリを使用することもできます。

--ccm-container-registry container_registry

Oracle Cloud Infrastructure Cloud Controller Managerコンポーネント・イメージをデプロイするときに使用するコンテナ・イメージ・レジストリ。 デフォルトは空の文字列です。 Platform API Serverは、インストールされるOracle Cloud Infrastructure Cloud Controller Managerモジュールのバージョンに対して正しいリポジトリを決定します。 プライベート・レジストリを使用することもできます。

--oci-ccm-version version

インストールするOracle Cloud Infrastructure Cloud Controller Managerのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

metallbモジュールのmodule_args:

--metallb-helm-module helm_module

MetalLBを関連付けるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--metallb-kubernetes-moduleオプションを使用してください。
--metallb-kubernetes-module kubernetes_module

MetalLBモジュールが関連付けられるkubernetesモジュールの名前。

--metallb-config path

MetalLBの構成情報を含むファイルのロケーション。 このファイルはオペレータ・ノード上にある必要があります。

--metallb-namespace namespace

MetalLBをインストールするKubernetesネームスペース。 デフォルト・ネームスペースはmetallb-system です。

--metallb-version version

インストールするMetalLBのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--metallb-container-registry container_registry

MetalLBのインストール時に使用するコンテナ・イメージ・レジストリおよびオプションのタグ。 デフォルトはcontainer-registry.oracle.com/olcneです。

rookモジュールのmodule_args:

--rook-kubernetes-module kubernetes_module

Rookモジュールが関連付けられるkubernetesモジュールの名前。

--rook-config path

Rookの構成情報を含むファイルのロケーション。 このファイルはオペレータ・ノード上にある必要があります。

--rook-namespace namespace

RookモジュールをインストールするKubernetesネームスペース。 デフォルトはrookです。

--rook-version version

インストールするRookのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--rook-container-registry container_registry

Rookモジュールのデプロイ時に使用するコンテナ・イメージ・レジストリ。 デフォルトはcontainer-registry.oracle.com/olcneです。

kubevirtモジュールのmodule_args:

--kubevirt-kubernetes-module kubernetes_module

KubeVirtモジュールが関連付けられるkubernetesモジュールの名前。

--kubevirt-config path

kubevirt.io/v1/KubeVirtオブジェクトを含む、KubeVirtの構成情報を含むファイルのロケーション。 このファイルはオペレータ・ノード上にある必要があります。

--kubevirt-namespace namespace

KubeVirtモジュールをインストールするKubernetesネームスペース。 デフォルトはkubevirtです。

--kubevirt-version version

インストールするKubeVirtのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--kubevirt-container-registry container_registry

KubeVirtモジュールのデプロイ時に使用するコンテナ・イメージ・レジストリ。 デフォルトはcontainer-registry.oracle.com/olcneです。

operator-lifecycle-managerモジュールのmodule_args:

--olm-helm-module helm_module

Operator Lifecycle Managerを関連付けるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--olm-kubernetes-moduleオプションを使用してください。
--olm-kubernetes-module kubernetes_module

Operator Lifecycle Managerモジュールが関連付けられるkubernetesモジュールの名前。

--olm-version version

インストールするOperator Lifecycle Managerのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--olm-container-registry container_registry

Operator Lifecycle Managerをデプロイするときに使用するコンテナ・イメージ・レジストリ。 デフォルトはcontainer-registry.oracle.com/olcneです。

--olm-enable-operatorhub {true|false}

Operator Lifecycle ManagerでOperatorHubレジストリをカタログ・ソースとして使用できるようにするかどうかを設定します。

デフォルトは、trueです。

istioモジュールのmodule_args:

--istio-helm-module helm_module

Istioが関連付けられるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--istio-kubernetes-moduleオプションを使用してください。
--istio-kubernetes-module kubernetes_module

Istioモジュールが関連付けられるkubernetesモジュールの名前。

--istio-version version

インストールするIstioのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--istio-container-registry container_registry

Istioのデプロイ時に使用するコンテナ・イメージ・レジストリ。 デフォルトはcontainer-registry.oracle.com/olcneです。

--istio-enable-grafana {true|false}

Grafanaモジュールをデプロイして、IstioのPrometheusに格納されているメトリックをビジュアル化するかどうかを設定します。 デフォルトは、trueです。

--istio-enable-prometheus {true|false}

Istioのメトリックを格納するためにPrometheusモジュールをデプロイするかどうかを設定します。 デフォルトは、trueです。

--istio-mutual-tls {true|false}

Istioのコントロール・プレーンのポッド間の通信と、Istioサービス・メッシュにデプロイされたポッドに対してMutual Transport Layer Security (mTLS)を有効化するかどうかを設定します。

デフォルトは、trueです。

重要:

この値は、特に本番環境ではfalseに設定しないことをお薦めします。

--istio-parent name

カスタム・プロファイルで使用するistioモジュールの名前。 --istio-profileオプションとともに使用すると、istioモジュールの多くのインスタンスで、Istioプラットフォーム・コンポーネントを単一のIstioコントロール・プレーンにアタッチできます。 このオプションを設定すると、デフォルトのIstioプロファイルがほとんど空のプロファイルで置き換えられます。 プロファイルの内容は、コンテナ・イメージ・ハブのロケーションと、インストールされているバージョンのistioモジュールに対応するタグのみです。

--istio-profile path

install.istio.io/v1alpha1 Kubernetes APIのIstioOperatorリソースのspecセクションを含むファイルへのパス。 このリソースの値は、Istioのデフォルト・プロファイルの上に配置され、オーバーライドされます。

IstioOperatorリソース・ファイルの詳細は、アップストリーム「Istioドキュメント」を参照してください。

prometheusモジュールのmodule_args:

--prometheus-helm-module helm_module

Prometheusを関連付けるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--prometheus-kubernetes-moduleオプションを使用してください。
--prometheus-kubernetes-module kubernetes_module

Prometheusモジュールが関連付けられるkubernetesモジュールの名前。

--prometheus-version version

インストールするPrometheusのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--prometheus-image container_registry

Prometheusのインストール時に使用するコンテナ・イメージ・レジストリおよびタグ。 デフォルトはcontainer-registry.oracle.com/olcne/prometheus です。

--prometheus-namespace namespace

PrometheusをインストールするKubernetesネームスペース。 デフォルトのネームスペースはdefaultです。

--prometheus-persistent-storage {true|false}

この値がfalseの場合、Prometheusは、ポッドを実行しているホストのemptydirにデータを書き込みます。 ポッドを移行すると、メトリック・データが失われます。

この値がtrueの場合、PrometheusはKubernetes PersistentVolumeClaimを要求し、ポッドの破棄または移行にかかわらず、そのデータが保持されるようにします。

デフォルトは、falseです。

--prometheus-alerting-rules path

Prometheusアラートの構成ファイルへのパス。

--prometheus-recording-rules path

Prometheus記録ルールの構成ファイルへのパス。

--prometheus-scrape-configuration path

Prometheusメトリックをスクレイプするための構成ファイルへのパス。

grafanaモジュールのmodule_args:

--grafana-helm-module helm_module

Grafanaを関連付けるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--grafana-kubernetes-moduleオプションを使用してください。
--grafana-kubernetes-module kubernetes_module

Grafanaモジュールが関連付けられるkubernetesモジュールの名前。

--grafana-version version

インストールするGrafanaのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--grafana-container-registry container_registry

Grafanaのインストール時に使用するコンテナ・イメージ・レジストリおよびタグ。 デフォルトはcontainer-registry.oracle.com/olcneです。

--grafana-namespace namespace

GrafanaをインストールするKubernetesネームスペース。 デフォルトのネームスペースはdefaultです。

--grafana-dashboard-configmaps configmap

Grafanaダッシュボードを含むConfigMap参照の名前。

--grafana-dashboard-providers path

Grafanaダッシュボード・プロバイダの構成を含むファイルのロケーション。

--grafana-datasources path

Grafanaデータ・ソースの構成を含むファイルのロケーション。

--grafana-existing-sercret-name secret

Grafana管理パスワードを含む既存のシークレットの名前。

--grafana-notifiers path

Grafana修飾子の構成を含むファイルのロケーション。

--grafana-pod-annotations annotations

Grafanaポッドに追加する注釈のカンマ区切りリスト。

--grafana-pod-env env_vars

Grafanaデプロイメント・ポッドに渡される環境変数のカンマ区切りリスト。

--grafana-service-port port

Grafanaサービスのポート番号。 デフォルトは3000です。

--grafana-service-type service

Grafanaにアクセスするためのサービス・タイプ。 デフォルトはClusterIPです。

glusterモジュールのmodule_args:

重要:

GlusterのインストールとGlusterfsの設定に使用されるGlusterコンテナ・ストレージ・インタフェース・モジュールは非推奨です。 Gluster Container Storage Interfaceモジュールは、将来のリリースで削除される可能性があります。

--gluster-helm-module helm_module

Glusterコンテナ・ストレージ・インタフェース・モジュールを関連付けるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--gluster-kubernetes-moduleオプションを使用してください。
--gluster-kubernetes-module kubernetes_module

Glusterモジュールが関連付けられるkubernetesモジュールの名前。

--gluster-server-url URL

Heketi APIサーバー・エンドポイントのURL。 デフォルトはhttp://127.0.0.1:8080です。

--gluster-server-user user

Heketiサーバー管理ユーザーのユーザー名。 デフォルトはadminです。

--gluster-existing-secret-name secret

管理パスワードを含む既存のシークレットの名前。 デフォルトはheketi-adminです。

--gluster-secret-key secret

管理パスワードを含むシークレット。 デフォルトはsecretです。

--gluster-namespace namespace

Glusterコンテナ・ストレージ・インタフェース・モジュールをインストールするKubernetesネームスペース。 デフォルトはdefaultです。

--gluster-sc-name class_name

Glusterfs StorageClassのStorageClass名。 デフォルトはhyperconvergedです。

--gluster-server-rest-auth {true|false}

Heketi APIサーバーがREST認可を受け入れるかどうか。 デフォルトは、trueです。

helmモジュールのmodule_args:

重要:

helmモジュールは、リリース1.6で非推奨になりました。 Helmは、オプションのモジュール・インストールを実行するために、Kubernetesモジュールとともに自動的にインストールされるようになりました。
--helm-kubernetes-module kubernetes_module

Helmを関連付けるkubernetesモジュールの名前。 Kubernetesの各インスタンスには、それに関連付けられた1つのHelmインスタンスを保持できます。

--helm-version version

インストールするHelmのバージョン。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

oci-csiモジュールのmodule_args:

重要:

oci-csiモジュールは、リリース1.5で非推奨になりました。 かわりに、リリース1.5以降のoci-ccmモジュールを使用してください。 リリース1.4から1.5にアップグレードした場合、oci-csiモジュールは自動的にoci-ccmに変更されます。 また、モジュールが正しく構成されていることを確認するために、アップグレード後に別のステップを実行する必要があります。 oci-csiモジュールをoci-ccmモジュールにアップグレードする方法の詳細は、「更新およびアップグレード」を参照してください。
--oci-csi-helm-module helm_module

Oracle Cloud Infrastructureコンテナ・ストレージ・インタフェース・モジュールを関連付けるhelmモジュールの名前。

重要:

このオプションは非推奨です。 代わりに--oci-ccm-kubernetes-moduleオプションを使用してください。
--oci-tenancy OCID

Oracle Cloud InfrastructureテナンシのOCID。

--oci-region region_identifier

Oracle Cloud Infrastructureリージョン識別子。 デフォルトはus-ashburn-1です。

リージョン識別子のリストは、「Oracle Cloud Infrastructureドキュメント」を参照してください。

--oci-compartment OCID

Oracle Cloud InfrastructureコンパートメントのOCID。

--oci-user OCID

Oracle Cloud InfrastructureユーザーのOCID。

--oci-private-key path

Oracle Cloud Infrastructure API署名キーの秘密キーのロケーション。 これはプライマリ・コントロール・プレーン・ノード上にある必要があります。 デフォルトは/root/.ssh/id_rsaです。

重要:

秘密キーはプライマリ・コントロール・プレーン・ノードで使用可能である必要があります。 これは、Kubernetesモジュールの作成時に--control-plane-nodesオプションにリストされた最初のコントロール・プレーン・ノードです。

--oci-fingerprint fingerprint

Oracle Cloud Infrastructure API署名キーの公開キーのフィンガープリント。

--oci-passphrase passphrase

Oracle Cloud Infrastructure API署名キーの秘密キーのパスフレーズ(設定されている場合)。

--oci-vcn OCID

Kubernetesクラスタが使用可能なOracle Cloud Infrastructure Virtual Cloud NetworkのOCID。

--oci-lb-subnet1 OCID

「Oracle Cloud Infrastructureロード・バランサ」のリージョナル・サブネットのOCID。

または、「Oracle Cloud Infrastructureロード・バランサ」に必要な2つの可用性ドメイン固有のサブネットの最初のサブネットのOCID。 サブネットは個別の可用性ドメインに存在する必要があります。

--oci-lb-subnet2 OCID

「Oracle Cloud Infrastructureロード・バランサ」の2つのサブネットの2番目のサブネットのOCID。 サブネットは個別の可用性ドメインに存在する必要があります。

--oci-lb-security-mode {All|Frontend|None}

このオプションは、Oracle Cloud Infrastructure CSIプラグインがロード・バランサ・サービスのセキュリティ・リストを管理するかどうかを設定します。 このオプションは、Kubernetes Cloud Controller Managerによって管理されるセキュリティ・リストに使用される構成モードを設定します。 デフォルトはNoneです。

セキュリティ・モードの詳細は、「Oracle Cloud InfrastructureドキュメントのKubernetes Cloud Controller Manager実装」を参照してください。

--oci-container-registry container_registry

Oracle Cloud Infrastructureクラウド・プロビジョナ・イメージのデプロイ時に使用するコンテナ・イメージ・レジストリ。 デフォルトはiad.ocir.io/oracleです。

--csi-container-registry container_registry

CSIコンポーネント・イメージのデプロイ時に使用するコンテナ・イメージ・レジストリ。 デフォルトはquay.io/k8scsiです。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-22 外部ロード・バランサを使用したHAクラスタ用のモジュールの作成

この例では、ホストlb.example.comで使用可能で、ポート6443で実行されている外部ロード・バランサを使用してHAクラスタを作成します。

externalip-validation-webhook-service Kubernetesサービスの証明書のロケーションも含める必要があります。 

olcnectl module create \
--environment-name myenvironment \
--module kubernetes \
--name mycluster \
--container-registry container-registry.oracle.com/olcne \
--load-balancer lb.example.com:6443 \
--control-plane-nodes control1.example.com:8090,control2.example.com:8090,control3.example.com:8090 \
--worker-nodes worker1.example.com:8090,worker2.example.com:8090,worker3.example.com:8090 \
--selinux enforcing \
--restrict-service-externalip-ca-cert /etc/olcne/certificates/restrict_external_ip/ca.cert \
--restrict-service-externalip-tls-cert /etc/olcne/certificates/restrict_external_ip/node.cert \
--restrict-service-externalip-tls-key /etc/olcne/certificates/restrict_external_ip/node.key

例4-23 内部ロード・バランサを使用したHAクラスタ用のモジュールの作成

この例では、Platform CLIによってデプロイされたロード・バランサを使用してHA Kubernetesクラスタを作成します。 --virtual-ipオプションによって、仮想IPアドレスをプライマリ・コントロール・プレーン・ノードのIPアドレスである192.0.2.100に設定します。 プライマリ・コントロール・プレーン・ノードは、コントロール・プレーン・ノードのリスト内の最初のノードです。 このクラスタには、3つのコントロール・プレーン・ノードと3つのワーカー・ノードが含まれます。

externalip-validation-webhook-service Kubernetesサービスの証明書のロケーションも含める必要があります。 

olcnectl module create \
--environment-name myenvironment \
--module kubernetes \
--name mycluster \
--container-registry container-registry.oracle.com/olcne \
--virtual-ip 192.0.2.100 \
--control-plane-nodes control1.example.com:8090,control2.example.com:8090,control3.example.com:8090 \
--worker-nodes worker1.example.com:8090,worker2.example.com:8090,worker3.example.com:8090 \
--selinux enforcing \
--restrict-service-externalip-ca-cert /etc/olcne/certificates/restrict_external_ip/ca.cert \
--restrict-service-externalip-tls-cert /etc/olcne/certificates/restrict_external_ip/node.cert \
--restrict-service-externalip-tls-key /etc/olcne/certificates/restrict_external_ip/node.key

例4-24 サービスIPアドレス範囲へのアクセスを許可するクラスタのモジュールの作成

この例では、Kubernetesサービスがアクセスできる外部IPアドレスを設定するKubernetesクラスタを作成します。 許可されるIP範囲は、192.0.2.0/24および198.51.100.0/24 CIDRブロック内です。

externalip-validation-webhook-service Kubernetesサービスの証明書のロケーションも含める必要があります。 

olcnectl module create \
--environment-name myenvironment \
--module kubernetes \
--name mycluster \
--container-registry container-registry.oracle.com/olcne \
--virtual-ip 192.0.2.100 \
--control-plane-nodes control1.example.com:8090,control2.example.com:8090,control3.example.com:8090 \
--worker-nodes worker1.example.com:8090,worker2.example.com:8090,worker3.example.com:8090 \
--selinux enforcing \
--restrict-service-externalip-ca-cert /etc/olcne/certificates/restrict_external_ip/ca.cert \
--restrict-service-externalip-tls-cert /etc/olcne/certificates/restrict_external_ip/node.cert \
--restrict-service-externalip-tls-key /etc/olcne/certificates/restrict_external_ip/node.key \
--restrict-service-externalip-cidrs 192.0.2.0/24,198.51.100.0/24

例4-25 すべてのサービスIPアドレスへのアクセスを許可するクラスタのモジュールの作成

この例では、Kubernetesサービスのすべての外部IPアドレスへのアクセスを許可するKubernetesクラスタを作成します。 これにより、externalip-validation-webhook-service Kubernetesサービスのデプロイメントが無効になります。つまり、Kubernetesサービスに対して外部IPアドレスの検証は実行されず、すべてのCIDRブロックに対してアクセスが許可されます。 

olcnectl module create \
--environment-name myenvironment \
--module kubernetes \
--name mycluster \
--container-registry container-registry.oracle.com/olcne \
--virtual-ip 192.0.2.100 \
--control-plane-nodes control1.example.com:8090,control2.example.com:8090,control3.example.com:8090 \
--worker-nodes worker1.example.com:8090,worker2.example.com:8090,worker3.example.com:8090 \
--selinux enforcing \
--restrict-service-externalip false

例4-26 単一のコントロール・プレーン・ノードによるクラスタのモジュールの作成

この例では、単一のコントロール・プレーン・ノードを使用してKubernetesクラスタをデプロイするKubernetesモジュールを作成します。 Kubernetesモジュールを作成するには、--moduleオプションをkubernetesに設定します。 このクラスタには、1つのコントロール・プレーン・ノードと2つのワーカー・ノードが含まれます。

externalip-validation-webhook-service Kubernetesサービスの証明書のロケーションも含める必要があります。 

olcnectl module create \
--environment-name myenvironment \
--module kubernetes \
--name mycluster \
--container-registry container-registry.oracle.com/olcne \
--control-plane-nodes control1.example.com:8090 \
--worker-nodes worker1.example.com:8090,worker2.example.com:8090 \
--selinux enforcing \
--restrict-service-externalip-ca-cert /etc/olcne/certificates/restrict_external_ip/ca.cert \
--restrict-service-externalip-tls-cert /etc/olcne/certificates/restrict_external_ip/node.cert \
--restrict-service-externalip-tls-key /etc/olcne/certificates/restrict_external_ip/node.key

例4-27 Calicoモジュールの作成

この例では、CalicoをKubernetesクラスタのポッド・ネットワーキングCNIとして設定するCalicoモジュールを作成します。 この例では、myclusterという名前のKubernetesモジュールと、mycalicoという名前のCalicoモジュールを使用します。 calico-config.yamlという名前の既存の構成ファイルを使用してCalicoを構成します。 

olcnectl module create \
--environment-name myenvironment \
--module calico \
--name mycalico \
--calico-kubernetes-module mycluster \
--calico-installation-config calico-config.yaml

例4-28 Multusモジュールの作成

この例では、ポッドへのブリッジ・ネットワーキングを有効にするMultusモジュールを作成します。 Multusモジュールを作成するには、--moduleオプションがmultusに設定されています。 この例では、myclusterという名前のKubernetesモジュールと、mymultusという名前のMultusモジュールを使用します。 

olcnectl module create \
--environment-name myenvironment \
--module multus \
--name mymultus \
--multus-kubernetes-module mycluster

例4-29 サービス・メッシュのモジュールの作成

この例では、Istioモジュールを使用してサービス・メッシュを作成します。 Istioモジュールを作成するには、--moduleオプションをistioに設定します。 この例では、myclusterという名前のKubernetesモジュールと、myistioという名前のIstioモジュールを使用します。

モジュールの追加時に必要なオプションの一部が含まれていないと、そのオプションを指定するように求められます。 

olcnectl module create \
--environment-name myenvironment \
--module istio \
--name myistio \
--istio-kubernetes-module mycluster

例4-30 Operator Lifecycle Managerのモジュールの作成

この例では、Operator Lifecycle Managerのインストールに使用できるモジュールを作成します。 Operator Lifecycle Managerモジュールを作成するには、--moduleオプションがoperator-lifecycle-managerに設定されます。 この例では、myclusterという名前のKubernetesモジュールと、myolmという名前のOperator Lifecycle Managerモジュールを使用します。

モジュールの追加時に必要なオプションの一部が含まれていないと、そのオプションを指定するように求められます。 

olcnectl module create \
--environment-name myenvironment \
--module operator-lifecycle-manager \
--name myolm \
--olm-kubernetes-module mycluster

例4-31 Oracle Cloud Infrastructureのモジュールの作成

この例では、高可用性アプリケーション・ロード・バランサをプロビジョニングするために、Oracle Cloud InfrastructureストレージにアクセスするKubernetes StorageClassプロビジョナを作成するモジュールを作成します。 Oracle Cloud Infrastructure Cloud Controller Managerモジュールを作成するには、--moduleオプションがoci-ccmに設定されます。 この例では、myclusterという名前のKubernetesモジュールと、myociという名前のOracle Cloud Infrastructure Cloud Controller Managerモジュールを使用します。

次の例に示すように、次のオプションを使用して、Oracle Cloud Infrastructureへのアクセスに必要な情報を指定します:

  • --oci-tenancy

  • --oci-compartment

  • --oci-user

  • --oci-fingerprint

  • --oci-private-key-file

  • --oci-vcn
  • --oci-lb-subnet1
  • --oci-lb-subnet2

環境によっては、Oracle Cloud Infrastructureにアクセスするために、より多くのオプションを指定する必要がある場合があります。

モジュールの追加時に必要なオプションの一部が含まれていないと、そのオプションを指定するように求められます。 

olcnectl module create \
--environment-name myenvironment \
--module oci-ccm \
--name myoci \
--oci-ccm-kubernetes-module mycluster \
--oci-tenancy ocid1.tenancy.oc1..unique_ID \
--oci-compartment ocid1.compartment.oc1..unique_ID \
--oci-user ocid1.user.oc1..unique_ID \
--oci-fingerprint b5:52:... \
--oci-private-key-file /home/opc/.oci/oci_api_key.pem \
--oci-vcn ocid1.vcn.oc1..unique_ID \
--oci-lb-subnet1 ocid1.subnet.oc1..unique_ID \
--oci-lb-subnet2 ocid1.subnet.oc1..unique_ID

Module Install

環境にモジュールをインストールします。 モジュールをインストールすると、そのモジュールを実行するためにノードが正しく設定されているかどうか確認されます。 ノードが正しく設定されていない場合は、各ノードの修正に必要なコマンドが出力に表示され、オプションでファイルに保存できます。

構文

olcnectl module install 
{-E|--environment-name} environment_name 
{-N|--name} name 
[{-g|--generate-scripts}]
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-g|--generate-scripts}

モジュール内のノードの設定エラーを修正するために必要なコマンドが含まれた一連のスクリプトを生成します。 モジュール内の各ノードに対してスクリプトが作成され、ローカル・ディレクトリに保存され、hostname:8090.shという名前が付けられます。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-32 モジュールのインストール

myenvironmentという環境にmyclusterというKubernetesモジュールをインストールするには: 

olcnectl module install \
--environment-name myenvironment \
--name mycluster

Module Instances

環境にインストールされているモジュールをリストします。

構文

olcnectl module instances 
{-E|--environment-name} environment_name
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-33 環境内のデプロイ済モジュールのリスト

myenvironmentという環境にデプロイされているモジュールをリストするには: 

olcnectl module instances \
--environment-name myenvironment

Module List

環境で使用可能なモジュールをリストします。

構文

olcnectl module list 
{-E|--environment-name} environment_name
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-34 環境で使用可能なモジュールの一覧表示

myenvironmentという環境のモジュールをリストするには: 

olcnectl module list \
--environment-name myenvironment

Module Property Get

モジュール・プロパティの値をリストします。

構文

olcnectl module property get 
{-E|--environment-name} environment_name 
{-N|--name} name
{-P|--property} property_name
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-P|--property} property_name

プロパティの名前。 olcnectl module property listコマンドを使用して、使用可能なプロパティのリストを取得できます。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-35 モジュール・プロパティのリスト

myenvironmentという環境に含まれるmyclusterというKubernetesモジュールのkubecfgプロパティの値をリストするには: 

olcnectl module property get \
--environment-name myenvironment \
--name mycluster \
--property kubecfg

Module Property List

環境内のモジュールで使用可能なプロパティをリストします。

構文

olcnectl module property list 
{-E|--environment-name} environment_name 
{-N|--name} name
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-36 モジュール・プロパティのリスト

myenvironmentという環境に含まれるmyclusterというKubernetesモジュールのプロパティをリストするには: 

olcnectl module property list \
--environment-name myenvironment \
--name mycluster

Module Report

環境内のモジュールおよびプロパティに関するサマリーおよび詳細情報を報告します。

構文

olcnectl module report 
{-E|--environment-name} environment_name 
[{-N|--name} name]
[--children]
[--exclude pattern]
[--include pattern]
[--format {yaml|table}] 
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。 名前が指定されていない場合、コマンドの出力には、選択した環境にデプロイされているすべてのモジュールに関する情報が含まれます。

--children

このオプションをコマンドに追加すると、モジュール・インスタンスのすべての子のプロパティが再帰的に表示されます。 デフォルト値は、falseです。

--exclude pattern

レポートから除外するプロパティを選択するRE2正規表現。 このオプションでは、複数のプロパティをカンマ区切りリストとして指定できます。

--include pattern

レポートに含めるプロパティを選択するRE2正規表現。 このオプションでは、複数のプロパティをカンマ区切りリストとして指定できます。 デフォルトでは、すべてのプロパティが表示されます。 このオプションを使用すると、この動作が1回以上オーバーライドされます。

--format {yaml|table}

YAMLまたは表形式でレポートを生成するには、このオプションを使用します。 デフォルトの形式はtableです。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-37 環境に関するサマリー詳細のレポート

myenvironmentという名前の環境にデプロイされているすべてのモジュールのサマリーをレポートするには: 

olcnectl module report \
--environment-name myenvironment \

例4-38 Kubernetesモジュールに関するサマリー詳細のレポート

myclusterという名前のKubernetesモジュールに関するサマリー詳細をレポートするには: 

olcnectl module report \
--environment-name myenvironment \
--name mycluster

例4-39 Kubernetesモジュールに関する包括的な詳細のレポート

myclusterという名前のKubernetesモジュールに関する包括的な詳細をレポートするには: 

olcnectl module report \
--environment-name myenvironment \
--name mycluster \
--children

Module Restore

環境からモジュールをリストアします。

構文

olcnectl module restore 
{-E|--environment-name} environment_name 
{-N|--name} name
[{-g|--generate-scripts}]
[{-F|--force}]
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-g|--generate-scripts}

モジュール内のノードの設定エラーを修正するために必要なコマンドが含まれた一連のスクリプトを生成します。 モジュール内の各ノードに対してスクリプトが作成され、ローカル・ディレクトリに保存され、hostname:8090.shという名前が付けられます。

{-F|--force}

確認プロンプトをスキップします。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-40 バックアップからのコントロール・プレーン・ノードのリストア

myenvironmentという環境に含まれるmyclusterというKubernetesモジュールのバックアップからKubernetesコントロール・プレーン・ノードをリストアするには: 

olcnectl module restore \
--environment-name myenvironment \
--name mycluster

Module Uninstall

環境からモジュールをアンインストールします。 モジュールをアンインストールすると、そのモジュールの構成もPlatform API Serverから削除されます。

構文

olcnectl module uninstall 
{-E|--environment-name} environment_name 
{-N|--name} name
[{-F|--force}]
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-F|--force}

確認プロンプトをスキップします。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-41 モジュールのアンインストール

myenvironmentという環境からmyclusterというKubernetesモジュールをアンインストールするには: 

olcnectl module uninstall \
--environment-name myenvironment \
--name mycluster

この例では、各ノードでKubernetesコンテナが停止されてから削除され、Kubernetesクラスタが削除されます。

Module Update

環境内のモジュールを更新します。 モジュールの構成は、Platform API Serverから自動的に取得されます。 このコマンドを使用すると、次のことができます。

  • ノード上のKubernetesリリースを最新のエラータ・リリースに更新

  • ノード上のKubernetesリリースを最新リリースにアップグレード

  • 他のモジュールおよびコンポーネントを更新またはアップグレードします。

  • Kubernetesクラスタをスケール・アップします(コントロール・プレーンまたはワーカー・ノードを追加します)。

  • Kubernetesクラスタをスケール・ダウンします(コントロール・プレーンまたはワーカー・ノードを削除します)。

重要:

Kubernetesクラスタを更新またはアップグレードする前に、Oracle Cloud Native Environmentを最新のリリースに更新またはアップグレードしたことを確認してください。 Oracle Cloud Native Environmentの更新またはアップグレードについては、「更新およびアップグレード」を参照してください。

構文

olcnectl module update 
{-E|--environment-name} environment_name 
{-N|--name} name 
[{-g|--generate-scripts}]
[{-F|--force}]
[{-h|--help}]
[module_args ...]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-g|--generate-scripts}

モジュール内のノードの設定エラーを修正するために必要なコマンドが含まれた一連のスクリプトを生成します。 モジュール内の各ノードに対してスクリプトが作成され、ローカル・ディレクトリに保存され、hostname:8090.shという名前が付けられます。

{-F|--force}

確認プロンプトをスキップします。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

ここで、module_argsは:

module_argsの値は、環境内のモジュールを更新するための1つ以上の引数です。

kubernetesモジュールのmodule_args:

{-k|--kube-version} version

アップグレード用のKubernetesバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

このオプションを指定しない場合、Kubernetesエラータ更新がインストールされます。

{-r|--container-registry} container_registry

更新またはアップグレードの実行時にKubernetesイメージが格納されるコンテナ・レジストリ。 Oracle Container Registryまたはローカル・レジストリを使用して、Kubernetesイメージをプルします。

このオプションを使用すると、別のコンテナ・レジストリを使用して更新またはアップグレードできます。 このオプションは、以降のすべての更新またはアップグレード時にデフォルトのコンテナ・レジストリを設定し、デフォルトのコンテナ・レジストリを変更する場合にのみ使用する必要があります。

{-m|--master-nodes} nodes ...

Platform Agentのポート番号を含む、Kubernetesクラスタに残すか、またはKubernetesクラスタに追加されるKubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 このリストに含まれていないコントロール・プレーン・ノードは、クラスタから削除されます。 このリスト内のノードは、クラスタに含められるノードです。

Platform Agentのデフォルト・ポート番号は8090です。 たとえば、control1.example.com:8090,control2.example.com:8090などです。

重要:

このオプションは非推奨です。 代わりに--control-plane-nodesオプションを使用してください。
{-c|--control-plane-nodes} nodes ...

Platform Agentのポート番号を含む、Kubernetesクラスタに残すか、またはKubernetesクラスタに追加されるKubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 このリストに含まれていないコントロール・プレーン・ノードは、クラスタから削除されます。 このリスト内のノードは、クラスタに含められるノードです。

Platform Agentのデフォルト・ポート番号は8090です。 たとえば、control1.example.com:8090,control2.example.com:8090などです。

{-w|--worker-nodes} nodes ...

Platform Agentのポート番号を含む、Kubernetesクラスタに残すか、またはKubernetesクラスタに追加される、Kubernetesワーカー・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 このリストに含まれていないワーカー・ノードは、クラスタから削除されます。 このリスト内のノードは、クラスタに含められるノードです。

Platform Agentのデフォルト・ポート番号は8090です。 たとえば、worker1.example.com:8090,worker2.example.com:8090のようにします。

--compact {true|false}

システム以外のKubernetesワークロードをコントロール・プレーン・ノードで実行できるようにするかどうかを設定します。 デフォルトは、falseです。

これをtrueに設定すると、Platform API Serverはコントロール・プレーン・ノードがテントされている場合、それらのノードを保持解除します。 これにより、システム以外のKubernetesワークロードをスケジュールし、コントロール・プレーン・ノードで実行できます。

これをfalseに設定すると、Platform API Serverはコントロール・プレーン・ノードが保持されていない場合、それらのノードを汚染します。 これにより、システム以外のKubernetesワークロードがスケジュールされ、コントロール・プレーン・ノードで実行されなくなります。

重要:

本番環境では、このオプションをfalse (デフォルト)に設定する必要があります。

--nginx-image container_location

更新するNGINXコンテナ・イメージの場所。 これはオプションです。

このオプションは、コントロール・プレーン・ノードのNGINXを更新するために、指定したコンテナ・レジストリの場所からNGINXコンテナ・イメージをプルします。 たとえば:

--nginx-image container-registry.oracle.com/olcne/nginx:1.17.7

--helm-version version

アップグレード用のHelmバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--restrict-service-externalip {true|false}

Kubernetesサービスの外部IPアドレスへのアクセスを制限するかどうかを設定します。 デフォルトはtrueで、外部IPアドレスへのアクセスが制限されます。

このオプションは、externalip-validation-webhook-serviceという名前のKubernetesサービスをデプロイして、Kubernetesサービス構成ファイルに設定されているexternalIPsを検証します。 外部IPアドレスへのアクセスは、specセクションのexternalIPsオプションを使用して、Kubernetesサービス構成ファイルで設定されます。

--restrict-service-externalip-ca-cert path

--restrict-service-externalipオプションがtrueに設定されている場合にデプロイされるexternalip-validation-webhook-serviceアプリケーションのCA証明書ファイルへのパス。 たとえば、/etc/olcne/certificates/restrict_external_ip/ca.certなどです。

--restrict-service-externalip-tls-cert path

--restrict-service-externalipオプションがtrueに設定されている場合にデプロイされるexternalip-validation-webhook-serviceアプリケーションのCA証明書ファイルへのパス。 たとえば、/etc/olcne/certificates/restrict_external_ip/node.certなどです。

--restrict-service-externalip-tls-key path

--restrict-service-externalipオプションがtrueに設定されている場合にデプロイされるexternalip-validation-webhook-serviceアプリケーションの秘密キーへのパス。 たとえば、/etc/olcne/certificates/restrict_external_ip/node.keyなどです。

--restrict-service-externalip-cidrs allowed_cidrs

指定されたCIDRブロックからのIPアドレスのみを許可するには、1つ以上のカンマ区切りのCIDRブロックを入力します。 たとえば、192.0.2.0/24,198.51.100.0/24などです。

--selinux {enforcing|permissive}

SELinuxのenforcingモードかpermissiveモードのどちらを使用するか。デフォルトはpermissiveです。

このオプションは、コントロール・プレーンおよびワーカー・ノードでSELinuxがenforcingに設定されている場合に使用します。 SELinuxは、OSではデフォルトでenforcingモードに設定されており、推奨モードです。

calicoモジュールのmodule_args:

--calico-version version

アップグレード用のCalicoバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--calico-container-registry container_registry

更新またはアップグレードの実行時にCalicoイメージを含むコンテナ・レジストリ。 Oracle Container Registry (デフォルト)またはローカル・レジストリを使用して、Calicoイメージをプルします。

multusモジュールのmodule_args:

--multus-version version

アップグレード用のMultusバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--multus-container-registry container_registry

更新またはアップグレードの実行時にMultusイメージが格納されるコンテナ・レジストリ。 Oracle Container Registry (デフォルト)またはローカル・レジストリを使用して、Multusイメージをプルします。

oci-ccmモジュールのmodule_args:

--oci-ccm-version version

アップグレードのOracle Cloud Infrastructure Cloud Controller Managerバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--oci-container-registry container_registry

Oracle Cloud Infrastructureクラウド・プロビジョナ・イメージの更新時に使用するコンテナ・イメージ・レジストリ。 デフォルトは空の文字列です。 Platform API Serverは、アップグレードするOracle Cloud Infrastructure Cloud Controller Managerモジュールのバージョンに対して正しいリポジトリを決定します。 プライベート・レジストリを使用することもできます。

--ccm-container-registry container_registry

Oracle Cloud Infrastructure Cloud Controller Managerコンポーネント・イメージの更新時に使用するコンテナ・イメージ・レジストリ。 デフォルトは空の文字列です。 Platform API Serverは、アップグレードするOracle Cloud Infrastructure Cloud Controller Managerモジュールのバージョンに対して正しいリポジトリを決定します。 プライベート・レジストリを使用することもできます。

--oci-lb-subnet1 OCID

「Oracle Cloud Infrastructureロード・バランサ」のリージョナル・サブネットのOCID。

または、「Oracle Cloud Infrastructureロード・バランサ」に必要な2つの可用性ドメイン固有のサブネットの最初のサブネットのOCID。 サブネットは個別の可用性ドメインに存在する必要があります。

--oci-lb-subnet2 OCID

「Oracle Cloud Infrastructureロード・バランサ」の2つのサブネットの2番目のサブネットのOCID。 サブネットは個別の可用性ドメインに存在する必要があります。

--oci-lb-security-mode {All|Frontend|None}

このオプションは、Oracle Cloud Infrastructure Cloud Controller Managerモジュールがロード・バランサ・サービスのセキュリティ・リストを管理するかどうかを設定します。 このオプションは、Kubernetes Cloud Controller Managerによって管理されるセキュリティ・リストに使用される構成モードを設定します。 デフォルトはNoneです。

セキュリティ・モードの詳細は、「Oracle Cloud InfrastructureドキュメントのKubernetes Cloud Controller Manager実装」を参照してください。

rookモジュールのmodule_args:

--rook-version version

アップグレード用のRookバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--rook-container-registry container_registry

Rookのアップグレード時に使用するコンテナ・イメージ・レジストリおよびオプションのタグ。 デフォルトはcontainer-registry.oracle.com/olcneです。

kubevirtモジュールのmodule_args:

--kubevirt-version version

アップグレードのKubeVirtバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--kubevirt-config path

kubevirt.io/v1/KubeVirtオブジェクトを含む、KubeVirtの構成情報を含むファイルのロケーション。 このファイルはオペレータ・ノード上にある必要があります。

--kubevirt-container-registry container_registry

KubeVirtのアップグレード時に使用するコンテナ・イメージ・レジストリおよびオプションのタグ。 デフォルトはcontainer-registry.oracle.com/olcneです。

metallbモジュールのmodule_args:

--metallb-version version

アップグレードのMetalLBバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--metallb-container-registry container_registry

MetalLBのアップグレード時に使用するコンテナ・イメージ・レジストリおよびオプションのタグ。 デフォルトはcontainer-registry.oracle.com/olcneです。

operator-lifecycle-managerモジュールのmodule_args:

--olm-version version

アップグレードのOperator Lifecycle Managerバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

istioモジュールのmodule_args:

--istio-version version

アップグレード用のIstioバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--istio-container-registry container_registry

更新またはアップグレードの実行時にIstioイメージを含むコンテナ・レジストリ。 Oracle Container Registry (デフォルト)またはローカル・レジストリを使用して、Istioイメージをプルします。

prometheusモジュールのmodule_args:

--prometheus-version version

アップグレードのPrometheusバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--prometheus-container-registry container_registry

更新またはアップグレードの実行時にPrometheusイメージを含むコンテナ・レジストリ。 Oracle Container Registry (デフォルト)またはローカル・レジストリを使用して、Prometheusイメージをプルします。

grafanaモジュールのmodule_args:

--grafana-version version

アップグレードのGrafanaバージョンを設定します。 デフォルトは最新バージョンです。 最新バージョン番号については、「リリース・ノート」を参照してください。

--grafana-container-registry container_registry

更新またはアップグレードの実行時にGrafanaイメージを含むコンテナ・レジストリ。 Oracle Container Registry (デフォルト)またはローカル・レジストリを使用して、Grafanaイメージをプルします。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-42 クラスタのスケーリング

クラスタをスケール・アップするには、クラスタに含めるすべてのノードをリストします。 既存のクラスタに2つのコントロール・プレーン・ノードと2つのワーカー・ノードが含まれていて、新しいコントロール・プレーンとワーカーを1つずつ追加する場合は、含めるすべてのノードをリストします。 たとえば、コントロール・プレーン・ノードcontrol3.example.comおよびワーカー・ノードworker3.example.comをmyclusterというKubernetesモジュールに追加するには、次のようにします。 

olcnectl module update \
--environment-name myenvironment \  
--name mycluster \
--control-plane-nodes control1.example.com:8090,control2.example.com:8090,control3.example.com:8090 \
--worker-nodes worker1.example.com:8090,worker2.example.com:8090,worker3.example.com:8090

クラスタをスケール・ダウンするには、クラスタに含めるすべてのノードをリストします。 myclusterというkubernetesモジュールからコントロール・プレーン・ノードcontrol3.example.comおよびワーカー・ノードworker3.example.comを削除するには: 

olcnectl module update \
--environment-name myenvironment \
--name mycluster \
--control-plane-nodes control1.example.com:8090,control2.example.com:8090 \
--worker-nodes worker1.example.com:8090,worker2.example.com:8090

control3.example.comコントロール・プレーン・ノードおよびworker3.example.comワーカー・ノードが--control-plane-nodesおよび--worker-nodesオプションにリストされていないため、Platform API Serverはそれらのノードをクラスタから削除します。

例4-43 Kubernetesリリースのエラータ更新の更新

myenvironmentという環境に含まれるmyclusterというKubernetesモジュールを最新のKubernetesエラータ・リリースに更新するには、次のように入力します。 

olcnectl module update \
--environment-name myenvironment \
--name mycluster

環境内のノードは、最新のKubernetes errataリリースに更新されます。

例4-44 別のコンテナ・レジストリを使用した更新

Kubernetesモジュールの作成時に指定したデフォルトとは異なるコンテナ・レジストリを使用して、myenvironmentという環境に含まれるmyclusterというKubernetesモジュールを最新のKubernetesエラータ・リリースに更新するには、次のように入力します。 

olcnectl module update \
--environment-name myenvironment \
--name mycluster \
--container-registry container-registry-austin-mirror.oracle.com/olcne/

環境内のノードは、ミラー・コンテナ・レジストリに含まれる最新のKubernetesエラータ・リリースに更新されます。

例4-45 Kubernetesリリースのアップグレード

myenvironmentという名前の環境のmyclusterという名前のKubernetesモジュールをKubernetesリリース1.26.15にアップグレードするには、次のように入力します: 

olcnectl module update \
--environment-name myenvironment \
--name mycluster \
--kube-version 1.26.15

--kube-versionオプションでは、アップグレード先のリリースを指定します。 この例では、リリース番号を使用します。

必ず最新のKubernetesリリースにアップグレードしてください。 最新のKubernetesリリースのバージョン番号を取得するには、「リリース・ノート」を参照してください。

環境内のノードは、Kubernetesリリース1.26.15に更新されます。

例4-46 別のコンテナ・レジストリを使用したアップグレード

myenvironmentという名前の環境のmyclusterという名前のKubernetesモジュールを、現在のデフォルトのコンテナ・レジストリとは異なるコンテナ・レジストリを使用してKubernetesリリース1.26.15にアップグレードするには、次のように入力します: 

olcnectl module update \
--environment-name myenvironment \
--name mycluster \
--container-registry container-registry-austin-mirror.oracle.com/olcne/ \
--kube-version 1.26.15

--kube-versionオプションでは、アップグレード先のリリースを指定します。 この例では、リリース番号1.26.15を使用します。 指定したコンテナ・レジストリが、これから行われるすべての更新またはアップグレードにおける新しいデフォルト・コンテナ・レジストリになります。

必ず最新のKubernetesリリースにアップグレードしてください。 最新のKubernetesリリースのバージョン番号を取得するには、「リリース・ノート」を参照してください。

環境内のノードは、Kubernetes 1.26.15に更新されます。

例4-47 Kubernetesサービスの外部IPアドレスへのアクセスの設定

この例では、Kubernetesサービスがアクセスできる外部IPアドレスの範囲を設定します。 

olcnectl module update \
--environment-name myenvironment \
--name mycluster \
--restrict-service-externalip-cidrs 192.0.2.0/24,198.51.100.0/24

例4-48 SELinux設定の変更

この例では、Kubernetesクラスタ内のノードでSELinux enforcingモードが有効になっているPlatform API Serverで構成を更新します。 

olcnectl module update \
--environment-name myenvironment \
--name mycluster \
--selinux enforcing

Module Validate

環境のモジュールを検証します。 モジュールを検証すると、ノードがチェックされ、モジュールを実行するために正しく設定されていることが確認されます。 ノードが正しく設定されていない場合は、各ノードの修正に必要なコマンドが出力に表示され、オプションでファイルに保存できます。

構文

olcnectl module validate 
{-E|--environment-name} environment_name 
{-N|--name} name 
[{-g|--generate-scripts}]
[{-h|--help}]
[globals]

説明:

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

{-g|--generate-scripts}

モジュール内のノードの設定エラーを修正するために必要なコマンドが含まれた一連のスクリプトを生成します。 モジュール内の各ノードに対してスクリプトが作成され、ローカル・ディレクトリに保存され、hostname:8090.shという名前が付けられます。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-49 モジュールの検証

myenvironmentという環境に含まれるmyclusterというKubernetesモジュールを検証するには: 

olcnectl module validate \
--environment-name myenvironment \
--name mycluster

Module Version

インストールされているOracle Cloud Native Environmentリリースにインストールできる、Oracle Container Registryの最新のモジュール・バージョンをリストします。

olcnectl module updateを実行する前にこのコマンドを使用して、どのバージョンのモジュールとそのサブコンポーネントをインストールできるかを確認できます。

コマンド・パラメータを使用すると、特定のモジュールとそのサブコンポーネントのバージョン情報を出力するか、使用可能なすべてのモジュールについて出力するかを選択できます。

構文

olcnectl module version 
{-E|--environment-name} environment_name 
[{--all | {-M|--module} module_name}]
[--print-subcomponents] 
[{-o|--output} {pretty|yaml|json}]
[{-h|--help}]
[globals]
説明:
{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{--all | {-M|--module} module_name}
使用可能なすべてのモジュールのバージョン情報を出力するか、指定したモジュールのみのバージョン情報を出力するかを指定します。 オプションは次のとおりです。
  • --all: 使用可能なすべてのモジュールのバージョンを出力します。
  • {-M|--module} module_name: module_nameという名前のモジュールのバージョンのみを出力します。
--print-subcomponents

モジュール・サブコンポーネントのバージョンも出力に含めることを指定します。 これはオプションです。

{-o|--output} {pretty|yaml|json}

指定された形式で出力を出力します。 書式オプションは、pretty (人間が読める形式)、yamlおよびjsonです。 デフォルトはprettyです。 これはオプションです。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

globalsは、「グローバル・フラグの使用」で説明されている1つ以上のグローバル・オプションです。

例

例4-50 使用可能なすべてのモジュールの最新バージョンの印刷

myenvironmentという名前の環境用にインストールできるOracle Container Registry内のすべてのモジュールの最新バージョンを出力するには、次を実行します: 

olcnectl module version \
--environment-name myenvironment \
--all

例4-51 特定のモジュールの最新バージョンをYAML形式で出力

myenvironmentという名前の環境で使用可能な、kubernetesなど、特定のモジュールの最新バージョンをyaml形式で出力するには、次を実行します: 

olcnectl module version \
--environment-name myenvironment \
--module kubernetes \
--output yaml

例4-52 特定のモジュールとそのサブコンポーネントの最新バージョンの出力

kubernetesなどの特定のモジュールの最新バージョン、およびmyenvironmentという名前の環境で使用可能なサブコンポーネントを出力するには、次を実行します: 

olcnectl module version \
--environment-name myenvironment \
--module kubernetes \
--print-subcomponents \

Node Install-Agent

Platform Agentソフトウェア・パッケージをKubernetesノードにインストールします。

構文

olcnectl node install-agent 
[{-h|--help}]
{-n|--nodes} nodes
[{-R|--remote-command} remote-command]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]

説明:

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

例

例4-53 ノードへのPlatform Agentのインストール

この例では、表示されているノードにPlatform Agentをインストールします。 

olcnectl node install-agent \
--nodes control1.example.com,worker1.example.com,worker2.example.com

Node Install-Api-Server

Platform API Serverソフトウェア・パッケージをオペレータ・ノードにインストールします。

構文

olcnectl node install-api-server 
[{-h|--help}]
{-n|--nodes} nodes
[{-R|--remote-command} remote-command]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]

説明:

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

例

例4-54 Platform API Serverのノードへのインストール

この例では、Platform API Serverがリストされたノードにインストールされます。 

olcnectl install-api-server \
--nodes operator.example.com

Node Install-Certificates

Platform API ServerおよびPlatform AgentのCA証明書およびキーを、適切なファイル所有権とともにノードにインストールします。

証明書とキー:

  • ノードの/etc/olcne/certificatesにコピーされます。
  • (chownを使用して)証明書ファイルの所有権をolcne:olcneに設定します。
  • (chmodを使用して)証明書ファイルの権限を0440に設定します。

構文

olcnectl node install-certificates 
[{-c|--certificate} path]
[{-C|--certificate-authority-chain} path]
[{-h|--help}]
[{-K|--key} path]
{-n|--nodes} nodes
[{-R|--remote-command} remote-command]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]

ここで :

{-c|--certificate} path

node.cert証明書へのパス。

{-C|--certificate-authority-chain} path

ca.cert認証局証明書へのパス。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-K|--key} path

node.keyキーへのパス。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

例

例4-55 ノードへの証明書のインストール

この例では、リストされているノードに証明書をインストールします。 

olcnectl node install-certificates \
--nodes operator.example.com,control1.example.com,worker1.example.com,worker2.example.com

Node Setup-Kubernetes

Kubernetesモジュールのインストールを準備するノードを設定します。

Kubernetesコントロール・プレーンまたはワーカー・ノードとして使用できるようにホストを構成します。 ファイアウォール・ルールの構成やネットワーク・ポートのオープンなどの操作を実行します。 ホストに変更を加える前に、加える変更をリストするプロンプトが表示され、確認を求められます。

構文

olcnectl node setup-kubernetes 
{-a|--api-server} api-server-address
[--control-plane-ha-nodes nodes ]
[{-c|--control-plane-nodes} nodes] 
[{-d|--debug}]
[{-h|--help}]
[{-m|--master-nodes} nodes] (Deprecated)
[{-n|--nodes} nodes]
[{-R|--remote-command} remote-command]
[{-r|--role} role]
[--selinux {permissive|enforcing}]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]
[{-w|--worker-nodes} nodes]
[{-y|--yes}]

説明:

{-a|--api-server} api-server-address

Platform API Serverホストのホスト名またはIPアドレス。

{-c|--control-plane-nodes} nodes

Kubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、control1.example.com,control2.example.comなどです。

--control-plane-ha-nodes nodes

高可用性クラスタ内のKubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、control1.example.com,control2.example.com,control3.example.comなどです。

{-d|--debug}

デバッグ・ロギングを有効にします。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-m|--master-nodes} nodes

Kubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、control1.example.com,control2.example.com,control3.example.comなどです。

ノート:

この引数は非推奨になりました。 かわりに--control-plane-nodes引数を使用します。
{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-r|--role} role

ホストのロール。 ロールは次のいずれかです:

  • api-server: Platform API Server。

  • control-plane: 1つのみのクラスタのKubernetesコントロール・プレーン・ノード。

  • control-plane-ha: 複数のクラスタがあるクラスタのKubernetesコントロール・プレーン・ノード。

  • worker: Kubernetesワーカー・ノード。

--selinux {permissive|enforcing}

SELinuxをenforcingに設定するか、permissiveに設定するかを設定します。 デフォルトはpermissiveです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

{-w|--worker-nodes} nodes

Kubernetesワーカー・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、worker1.example.com,worker2.example.comのようにします。

{-y|--yes}

確認プロンプトに対する回答を肯定的(yes)とするかどうかを設定します。

Node Setup-Package-Repositories

ノードにソフトウェア・パッケージ・リポジトリを設定します。

構文

olcnectl node setup-package-repositories
[{-d|--debug}]
[{-h|--help}]
{-n|--nodes} nodes
[{-R|--remote-command} remote-command]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]

説明:

{-d|--debug}

デバッグ・ロギングを有効にします。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

例

例4-56 ソフトウェア・リポジトリの設定

この例では、リストされているノードのソフトウェア・パッケージ・リポジトリを設定します。

olcnectl node setup-package-repositories \
--nodes control1.example.com,worker1.example.com,worker2.example.com

Node Setup-Platform

Oracle Cloud Native Environmentプラットフォーム (Platform API ServerおよびPlatform Agent)をインストールし、プラットフォーム・サービスを起動します。

ホストのセットで、Oracle Cloud Native Environmentプラットフォーム・コンポーネントを構成、インストールおよび起動します。

  1. yumソフトウェア・パッケージ・リポジトリを構成します。

  2. ネットワーク・ポートを構成します。

  3. Platform API ServerおよびPlatform Agentをインストールします。

  4. CA証明書を生成してインストールします。

  5. プラットフォーム・サービス(olcne-api-server.serviceおよびolcne-agent.service)を起動します。

構文

olcnectl node setup-platform 
{-a|--api-server} api-server-address
[--byo-ca-cert certificate-path]
[--byo-ca-key key-path]
[--cert-dir certificate-directory]
[--cert-request-common-name common_name]
[--cert-request-country country]
[--cert-request-locality locality]
[--cert-request-organization organization]
[--cert-request-organization-unit organization-unit]
[--cert-request-state state]
[--control-plane-ha-nodes nodes ]
[--control-plane-nodes nodes]
[{-d|--debug}]
[{-h|--help}]
[--http-proxy proxy-server]
[--https-proxy proxy-server]
[--no-proxy no_proxy]
[{-n|--nodes} nodes]
[--one-cert]
[{-R|--remote-command} remote-command]
[{-r|--role} role]
[--selinux {permissive|enforcing}]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]
[{-w|--worker-nodes} nodes]
[{-y|--yes}]

説明:

{-a|--api-server} api-server-address

Platform API Serverホストのホスト名またはIPアドレス。

--byo-ca-cert certificate-path

既存のパブリックCA証明書へのパス。

--byo-ca-key key-path

既存の秘密キーへのパス。

--cert-dir certificate-directory

このユーティリティによって生成されたキー・データを読み書きするディレクトリ。 デフォルトは<CURRENT_DIR>/certificatesです。

--cert-request-common-name common_name

証明書共通名サフィクス。 デフォルトはexample.comです。

--cert-request-country country

会社の2文字の国コード。たとえば、米国ではUS、英国ではGB、中国ではCNです。 デフォルトはUSです。

--cert-request-locality locality

会社が所在する市の名前。 デフォルトはRedwood Cityです。

--cert-request-organization organization

会社の名前。 デフォルトはOLCNEです。

--cert-request-organization-unit organization-unit

会社内の部門の名前。 デフォルトはOLCNEです。

--cert-request-state state

会社が所在する州または州の名前。 デフォルトはCaliforniaです。

--control-plane-ha-nodes nodes

高可用性クラスタ内のKubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、control1.example.com,control2.example.com,control3.example.comなどです。

{-c|--control-plane-nodes} nodes

Kubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、control1.example.com,control2.example.comなどです。

{-d|--debug}

デバッグ・ロギングを有効にします。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

--http-proxy proxy-server

必要に応じて、HTTPプロキシ・サーバーのロケーション。

--https-proxy proxy-server

必要に応じてHTTPSプロキシ・サーバーのロケーション。

--no-proxy no_proxy

プロキシ・サーバー設定から除外するホストのリスト。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

--one-cert

すべてのホストの認証に使用できる単一の証明書を生成するかどうかを設定します。 デフォルトでは、このオプションは設定されていません。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-r|--role} role

ホストのロール。 ロールは次のいずれかです:

  • api-server: Platform API Server。

  • control-plane: 1つのみのクラスタのKubernetesコントロール・プレーン・ノード。

  • control-plane-ha: 複数のクラスタがあるクラスタのKubernetesコントロール・プレーン・ノード。

  • worker: Kubernetesワーカー・ノード。

--selinux {permissive|enforcing}

SELinuxをenforcingに設定するか、permissiveに設定するかを設定します。 デフォルトはpermissiveです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

{-w|--worker-nodes} nodes

Kubernetesワーカー・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、worker1.example.com,worker2.example.comのようにします。

{-y|--yes}

確認プロンプトに対する回答を肯定的(yes)とするかどうかを設定します。

例

例4-57 デフォルト・オプションを使用してプラットフォームをインストール

この例では、デフォルト・オプションを使用してOracle Cloud Native Environmentプラットフォームをインストールします。 

olcnectl node setup-platform \
--api-server operator.example.com \
--control-plane-nodes control1.example.com,control2.example.com,control3.example.com \
--worker-nodes worker1.example.com,worker2.example.com,worker2.example.com

例4-58 デフォルト・オプションを使用してHAデプロイ用のプラットフォームをインストール

この例では、デフォルト・オプションを使用してOracle Cloud Native Environmentプラットフォームをインストールします。 

olcnectl node setup-platform \
--api-server operator.example.com \
--control-plane-ha-nodes control1.example.com,control2.example.com,control3.example.com \
--worker-nodes worker1.example.com,worker2.example.com,worker2.example.com

例4-59 デフォルト・オプションを使用してHAデプロイ用のプラットフォームをインストール

この例では、デフォルト・オプションを使用してOracle Cloud Native Environmentプラットフォームをインストールします。 

olcnectl node setup-platform \
--api-server operator.example.com \
--control-plane-ha-nodes control1.example.com,control2.example.com,control3.example.com \
--worker-nodes worker1.example.com,worker2.example.com,worker2.example.com

例4-60 Platform API Serverのインストール

この例では、Platform API Serverをインストールし、すべてのプロンプトを受け入れます。

olcnectl node setup-platform \
--nodes operator.example.com \
--role api-server \
--yes

例4-61 HAコントロール・プレーン・ノードへのPlatform Agentのインストール

この例では、HAインストール用のKubernetesコントロール・プレーン・ノードにPlatform Agentをインストールします。 すべてのプロンプトを受け入れます。 

olcnectl node setup-platform \
--nodes control1.example.com,control2.example.com,control3.example.com \
--role control-plane-ha \
--yes

例4-62 プロキシ・サーバーおよびSSHログイン情報を持つワーカー・ノードへのPlatform Agentのインストール

この例では、Kubernetesワーカー・ノードにPlatform Agentをインストールします。 プロキシ・サーバー情報を使用し、SSHログイン情報を提供し、すべてのプロンプトを受け入れます。 

olcnectl node setup-platform \
--nodes worker1.example.com,worker2.example.com,worker2.example.com \
--role worker \
--ssh-identity-file ~/.ssh/id_rsa \
--ssh-login-name oracle \
--http-proxy "http://www-proxy.example.com:80" \
--https-proxy "https://www-proxy.example.com:80" \
--no-proxy ".example.com" \
--yes

Node Start-Platform

オペレータ・ノードでPlatform API Serverサービスを起動し、KubernetesノードでPlatform Agentサービスを起動します。

構文

olcnectl node start-platform
[{-h|--help}]
{-n|--nodes} nodes
[{-R|--remote-command} remote-command]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]
[{-y|--yes}]

説明:

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

{-y|--yes}

確認プロンプトに対する回答を肯定的(yes)とするかどうかを設定します。

例

例4-63 プラットフォーム・サービスの開始

この例では、リストされているノード上でプラットフォーム・サービスを起動します。

olcnectl node start-platform \
--ssh-identity-file ~/.ssh/id_rsa \
--ssh-login-name oracle \
--nodes control01.example.com,worker01.example.com,worker02.example.com

Provision

ノードを設定し、Kubernetesモジュールの作成およびインストールを含むOracle Cloud Native Environmentプラットフォーム (Platform API ServerおよびPlatform Agent)をインストールします。

このコマンドは、すべてのノードを構成し、証明書およびキーを作成して配布し、Platform API ServerおよびPlatform Agentをインストールし、必要なシステム・サービスを起動し、Kubernetesモジュールのインスタンスを作成してインストールします。 これにより、KubernetesクラスタでOracle Cloud Native Environmentを迅速にインストールできます。

このコマンドを実行すると、ホストに加えられた変更をリストするプロンプトが表示され、確認を求められます。 このプロンプトが表示されないようにするには、--yesオプションを使用します。

--config-fileオプションを指定して構成ファイルを使用すると、より複雑なデプロイメントを行うことができます。

構文

olcnectl provision 
{-a|--api-server} api-server-address
[--byo-ca-cert certificate-path]
[--byo-ca-key key-path]
[--cert-dir certificate-directory]
[--cert-request-common-name common_name]
[--cert-request-country country]
[--cert-request-locality locality]
[--cert-request-organization organization]
[--cert-request-organization-unit organization-unit]
[--cert-request-state state]
[--config-file config-file-path]
[--container-registry registry]
{-c|--control-plane-nodes} nodes
[{-d|--debug}]
{-E|--environment-name} environment_name 
[{-h|--help}]
[--http-proxy proxy-server]
[--https-proxy proxy-server]
[--load-balancer load-balancer]
{-m|--master-nodes} nodes (Deprecated)
{-N|--name} name
[--no-proxy no_proxy]
[{-n|--nodes} nodes]
[--one-cert]
[{-R|--remote-command} remote-command]
[--restrict-service-externalip-cidrs allowed_cidrs]
[--selinux {permissive|enforcing}]
[{-i|--ssh-identity-file} file_location]
[{-l|--ssh-login-name} username]
[--timeout minutes]
[--virtual-ip IP_address]
{-w|--worker-nodes} nodes
[{-y|--yes}]

説明:

{-a|--api-server} api-server-address

Platform API Serverホストのホスト名またはIPアドレス。

--byo-ca-cert certificate-path

既存のパブリックCA証明書へのパス。

--byo-ca-key key-path

既存の秘密キーへのパス。

--cert-dir certificate-directory

このユーティリティによって生成されたキー・データを読み書きするディレクトリ。 デフォルトは<CURRENT_DIR>/certificatesです。

--cert-request-common-name common_name

証明書共通名サフィクス。 デフォルトはexample.comです。

--cert-request-country country

会社の2文字の国コード。たとえば、米国ではUS、英国ではGB、中国ではCNです。 デフォルトはUSです。

--cert-request-locality locality

会社が所在する市の名前。 デフォルトはRedwood Cityです。

--cert-request-organization organization

会社の名前。 デフォルトはOLCNEです。

--cert-request-organization-unit organization-unit

会社内の部門の名前。 デフォルトはOLCNEです。

--cert-request-state state

会社が所在する州または州の名前。 デフォルトはCaliforniaです。

--config-file config-file-path

Oracle Cloud Native Environment構成ファイルのパスおよびロケーション。

--container-registry registry

Kubernetesコンテナ・イメージのプル元のコンテナ・レジストリ。 デフォルトはcontainer-registry.oracle.com/olcneです。

{-c|--control-plane-nodes} nodes

Kubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、control1.example.com,control2.example.comなどです。

{-d|--debug}

デバッグ・ロギングを有効にします。

{-E|--environment-name} environment_name

Oracle Cloud Native Environment。 environment_nameの値は、環境の識別に使用する名前です。

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

--http-proxy proxy-server

必要に応じて、HTTPプロキシ・サーバーのロケーション。

--https-proxy proxy-server

必要に応じてHTTPSプロキシ・サーバーのロケーション。

--load-balancer load-balancer

必要に応じて、外部ロード・バランサのロケーション。

{-m|--master-nodes} nodes

Kubernetesコントロール・プレーン・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、control1.example.com,control2.example.com,control3.example.comなどです。

ノート:

この引数は非推奨になりました。 かわりに--control-plane-nodes引数を使用します。
{-N|--name} name

モジュール名。 nameの値は、環境内のモジュールを識別するために使用する名前です。

--no-proxy no_proxy

プロキシ・サーバー設定から除外するホストのリスト。

{-n|--nodes} nodes

ノードのホスト名またはIPアドレスのカンマ区切りリスト。

アクションを実行するノードを設定します。 ローカル・ノードでないノードは、--remote-commandで指定されたコマンドを使用してホストに接続します(デフォルトではssh)。 ノード・アドレスがローカル・システムに解決された場合、リモート・コマンドを使用せずにすべてのコマンドがローカルで実行されます。

--one-cert

すべてのホストの認証に使用できる単一の証明書を生成するかどうかを設定します。 デフォルトでは、このオプションは設定されていません。

{-R|--remote-command} remote-command

リモート・ホストへの接続を開きます。 ホストのアドレスとコマンドは、このコマンドの最後に追加されます。 たとえば:

ssh -i ~/.ssh/myidfile -l myuser

デフォルトのリモート・コマンドはsshです。

--restrict-service-externalip-cidrs allowed_cidrs

指定されたCIDRブロックからのIPアドレスのみを許可するには、1つ以上のカンマ区切りのCIDRブロックを入力します。 たとえば、192.0.2.0/24,198.51.100.0/24などです。

--selinux {permissive|enforcing}

SELinuxをenforcingに設定するか、permissiveに設定するかを設定します。 デフォルトはpermissiveです。

{-i|--ssh-identity-file} file_location

SSH識別ファイルのロケーション。 値を指定しない場合は、OSのデフォルトが使用されます。

{-l|--ssh-login-name} username

SSHを使用してログインするユーザー名。 デフォルトはopcです。

--timeout minutes

コマンド・タイムアウトに設定する分数。 デフォルトは40分です。

--virtual-ip IP_address

内部ロード・バランサに使用する仮想IPアドレス。

{-w|--worker-nodes} nodes

Kubernetesワーカー・ノードのホスト名またはIPアドレスのカンマ区切りリスト。 たとえば、worker1.example.com,worker2.example.comのようにします。

{-y|--yes}

確認プロンプトに対する回答を肯定的(yes)とするかどうかを設定します。

例

例4-64 クイック・インストール

クイック・インストールを実行するには:

olcnectl provision \
--api-server operator.example.com \
--control-plane-nodes control1.example.com \
--worker-nodes worker1.example.com,worker2.example.com,worker3.example.com \
--environment-name myenvironment \
--name mycluster

例4-65 SSHログイン情報を使用したクイック・インストール

SSHログイン情報を使用してクイック・インストールを実行し、すべてのプロンプトを受け入れるには:

olcnectl provision \
--api-server operator.example.com \
--control-plane-nodes control1.example.com \
--worker-nodes worker1.example.com,worker2.example.com,worker3.example.com \
--environment-name myenvironment \
--name mycluster \
--ssh-identity-file ~/.ssh/id_rsa \
--ssh-login-name oracle \
--yes

例4-66 外部ロード・バランサを使用したクイックHAインストール

外部ロード・バランサを使用してクイックHAインストールを実行し、すべてのプロンプトを受け入れるには:

olcnectl provision \
--api-server operator.example.com \
--control-plane-nodes control1.example.com,control2.example.com,control3.example.com \
--worker-nodes worker1.example.com,worker2.example.com,worker3.example.com \
--environment-name myenvironment \
--name mycluster \
--load-balancer lb.example.com:6443 \
--yes

例4-67 プロキシ・サーバーを使用したクイック・インストール

SSHログイン情報とプロキシ・サーバーを使用してクイック・インストールを実行し、すべてのプロンプトを受け入れるには:

olcnectl provision  \
--api-server operator.example.com \
--control-plane-nodes control1.example.com \
--worker-nodes worker1.example.com,worker2.example.com,worker3.example.com \
--environment-name myenvironment \
--name mycluster \
--ssh-identity-file ~/.ssh/id_rsa \
--ssh-login-name oracle \
--http-proxy "http://www-proxy.example.com:80" \
--https-proxy "https://www-proxy.example.com:80" \
--no-proxy ".example.com" \
--yes

例4-68 externalIPsサービスによるクイック・インストール

externalIPs Kubernetesサービスを含むクイック・インストールを実行するには、サービスへのアクセスを許可するCIDRブロックを指定します。 これにより、externalip-validation-webhook-service Kubernetesサービスがデプロイされます: 

olcnectl provision \
--api-server operator.example.com \
--control-plane-nodes control1.example.com \
--worker-nodes worker1.example.com,worker2.example.com,worker3.example.com \
--environment-name myenvironment \
--name mycluster \
--restrict-service-externalip-cidrs 192.0.2.0/24,198.51.100.0/24

例4-69 構成ファイルを使用したクイック・インストール

構成ファイルとSSHログイン情報を使用してクイック・インストールを実行するには:

olcnectl provision \
--config-file myenvironment.yaml \
--ssh-identity-file ~/.ssh/id_rsa \
--ssh-login-name oracle \
--yes

Template

構成ファイル・テンプレートを生成します。 テンプレート・ファイルの名前はconfig-file-template.yamlで、ローカル・ディレクトリに作成されます。

構文

olcnectl template 
[{-h|--help}]

説明:

{-h|--help}

コマンドと使用可能なオプションに関する情報を一覧表示します。

例

例4-70 サンプル構成テンプレートの作成

サンプル構成テンプレートを作成するには: 

olcnectl template