このコンテンツを正しく表示するにはJavaScriptを有効にする必要があります

このドキュメントで説明されているソフトウェアは、サポートされなくなったか、拡張サポートされています。
Oracleでは、現在サポートされているリリースにアップグレードすることをお勧めします。

第1章 Platform CLIの概要

Oracle Cloud Native Environmentプラットフォーム・コマンドライン・インタフェースolcnectlを使用して、Oracle Cloud Native Environmentのコンポーネントを構成、デプロイおよび管理します。 olcnectlコマンドは、olcnectlパッケージを使用してオペレータ・ノードにインストールされます。オペレータ・ノードの設定の詳細は、スタート・ガイドを参照してください。

olcnectlは、一連のオプションを指定したコマンドを入力することで操作します。 Platform CLIの構文は次のとおりです。

olcnectl command [command_options|{-h|--help}]

各コマンドの完全な構文およびオプションは、第4章、「プラットフォームCLIコマンド」にあります。

olcnectlコマンドを使用すると、欠落しているオプションの入力が求められます。

1.1 構文ヘルプの表示

olcnectlコマンドの構文に関するヘルプを表示するには、--helpオプションを使用します。たとえば、olcnectlコマンドで使用可能なコマンド・オプションを表示するには、次のように入力します。

olcnectl --help

A CLI that talks to an Oracle Cloud Native Environment Platform API Server endpoint, 
facilitating deployment and management of Kubernetes clusters and their resources

Usage:
  olcnectl [command]

Available Commands:
  environment Environment operations
  help        Help about any command
  module      Modules that can be modified in an environment
  template    Generate a configuration file template


Flags:
  -h, --help   help for olcnectl

Use "olcnectl [command] --help" for more information about a command.

Available Commandsセクションには、olcnectlコマンドで使用可能なコマンドがリストされます。この場合、コマンドolcnectl environment、olcnectl help、olcnectl moduleおよびolcnectl templateを使用できます。

Flagsセクションには、使用できるコマンド・オプションがリストされます。

olcnectl helpコマンドは、olcnectl --helpを使用することと同じです。つまり、olcnectlコマンドのヘルプを出力します。

ヘルプ・システムにさらにドリルダウンするには、Available Commandsセクションにリストされているコマンドに--helpオプションを指定します。たとえば、olcnectl moduleコマンドで使用可能なコマンドとオプションを表示するには、次のように入力します。

olcnectl module --help

Modules that are used to customize your environment

Usage:
  olcnectl module [command]

Available Commands:
  backup      backup a module
  create      Create a module
  get         Get a module
  install     Install a module
  instances   List all module instances that are defined in an environment
  list        Show all modules that can be installed
  property    Commands that interact with module properties
  report      Display the report of the selected module instance
  restore     restore a module
  uninstall   Uninstall a module
  update      Update a module
  validate    Validate that an module can be installed

Flags:
  -a, --api-server string               Platform API Server to talk to. If this is not specified ...
      --config-file string              Location of configuration file that contains the        ...
  -h, --help                            help for olcnectl
      --olcn-ca-path string            Optional path to a predefined CA or the a destination if ...
      --olcne-node-cert-path string     Optional path to a predefined Key or the a destination   ...
      --olcne-node-key-path string      Optional path to a predefined Cert or the a destination  ...
      --olcne-tls-cipher-suites string  TLS Cipher Suites, Possible value(s) (comma separated):  ...
      --olcne-tls-max-version string    TLS Maximum Version, Default value: VersionTLS12,        ...
      --olcne-tls-min-version string    TLS Minimum Version, Default value: VersionTLS12,        ...
      --secret-manager-type string      Manager that will handle the secrets. Options are: file, ...
      --update-config                   When defined the global arguments will be writen to a    ...
      --vault-address string            Address of Vault. Default: https://127.0.0.1:8200 or     ...
      --vault-cert-sans string          Sans that will passed to Vault to generate the Platform  ...
      --vault-token string              Token to authentic with Vault

Use "olcnectl module [command] --help" for more information about a command.

ここでも、Available Commandsセクションには、そのコマンドで使用可能なサブコマンドがリストされます。この場合、olcnectl module backup、olcnectl module create、olcnectl module getなどのコマンドを使用できます。

Flags項には、すべてのサブコマンドで使用できるオプションが表示されます。

ヘルプ・システムにさらにドリルダウンすると、olcnectl module propertyコマンドにはさらにgetとlistの2つのオプションがあります。

olcnectl module property --help

Commands that interact with module properties

Usage:
  olcnectl module property [command]

Available Commands:
  get         Gets the value of one or more properties
  list        Show all properties for a module

Flags:
  -h, --help   help for property

Global Flags:
  -a, --api-server string                Platform API Server to talk to.  If this is not ...
      --config-file string               Location of configuration file that contains ...
      --olcne-ca-path string             Optional path to a predefined CA or the a ...
...
Use "olcnectl module property [command] --help" for more information about a command.

新しいコマンド・オプションのセットがGlobal Flags項にリストされます。この項に表示されるオプションは、すべてのolcnectlサブコマンドで使用されるグローバル・フラグです。グローバル・フラグの詳細は、第1.3項、「グローバル・フラグの使用」を参照してください。

コマンド・オプションのリストを取得するには、--helpオプションを指定して完全なコマンドを含める必要があります。この場合、olcnectl module property getコマンドには、Flagsセクションに示された4つのオプションがあります。

olcnectl module property get --help

Given a list of properties, fetch the value of each for a specific module

Usage:
  olcnectl module property get [flags]

Flags:
  -E, --environment-name string   Name of the environment
  -h, --help                      help for get
  -N, --name string               Name of the module
  -P, --property strings          Names of properties to fetch
...

olcnectl module createコマンドとolcnectl module updateコマンドのヘルプ・システムの動作は、--helpオプションのそれ以外の使用時とは異なります。環境内に複数のモジュールがあるため、Platform CLIで該当するヘルプを表示するには、モジュールに関する情報を指定する必要があります。 olcnectl module createコマンドのヘルプを表示するには、次のように入力します。

olcnectl module create --help

Create a module in a environment

Usage:
 olcnectl module create [flags]

Flags:
 -E, --environment-name string Name of the environment
 -h, --help help for create
 -M, --module strings Module to create
 -N, --name strings Name to assign the module
...

各モジュールを作成するためのオプションを表示するには、--moduleオプションを使用し、モジュール・タイプを指定する必要があります。モジュール・タイプは、4.5項「モジュールの作成」にリストされています。たとえば、Kubernetesモジュールの作成に関するヘルプを表示するには、モジュール・タイプをkubernetesとして指定します。

olcnectl module create --help --module kubernetes

Create a module in a environment

Usage:
  olcnectl module create [flags]

Flags:
  -o, --apiserver-advertise-address string   (DEPRECATED) Advertised address for internal       ...
  -b, --apiserver-bind-port string           Kubernetes API Server bind port (default "6443")
  -B, --apiserver-bind-port-alt string       Port for the Kubernetes API Server to bind to if   ...
  -e, --apiserver-cert-extra-sans string     Kubernetes API Server extra sans
  -r, --container-registry string            Container Registry that holds the kubernetes images
  -E, --environment-name string              Name of the environment
  -h, --help                                 help for create
  -x, --kube-proxy-mode string               Routing mode for the Kubernetes proxy (default     ...
  -v, --kube-version string                  Kubernetes version (default "1.17.4")
...

同様に、olcnectl module updateコマンドのヘルプを表示するには、次を使用します。

olcnectl module update --help

Update a module

Usage:
  olcnectl module update [flags]

Flags:
  -E, --environment-name string   Name of the environment
  -F, --force                     Update without prompting
  -g, --generate-scripts          Generate a script for each node that takes all suggested actions
  -h, --help                      help for update
  -N, --name strings              Modules to update
...

出力には、--nameオプションが表示されます。これは、モジュールの指定に使用するオプションです。この例では、myclusterというKubernetesモジュールに対するolcnectl module update --helpコマンドの出力を示しています。

olcnectl module update --help --name mycluster

Update a module

Usage:
  olcnectl module update [flags]

Flags:
  -E, --environment-name string   Name of the environment
  -F, --force                     Update without prompting
  -g, --generate-scripts          Generate a script for each node that takes all suggested actions
  -h, --help                      help for update
  -v, --kube-version string       Kubernetes version (default "1.21.14-3")
  -m, --master-nodes string       A comma separated list of master nodes
  -N, --name strings              Modules to update
  -w, --worker-nodes string       A comma separated list of worker nodes
...

出力には、Kubernetesモジュールのスケーリングまたは更新/アップグレードに使用できるオプションが表示されます。

1.2 Platform API Serverの設定

プラットフォームCLIは、Oracle Cloud Native EnvironmentプラットフォームAPIサーバーに接続します。 Platform CLIがインストールされているオペレータ・ノードを使用して、複数のPlatform API Serverインスタンスに接続できます。 olcnectl --api-server api_server_address:8091オプションを使用してPlatform API Serverを指定します。これにより、単一のオペレータ・ノードを使用して複数の環境を管理できます。たとえば、apiserver.example.com上のPlatform API Serverに接続するには、次を使用します。

olcnectl module property list \
--api-server apiserver.example.com:8091 \
--environment-name myenvironment \
--name mycluster

olcnectl environment createコマンドを使用して環境を作成する場合は、オプションで--update-configオプションを含めることができます。このオプションによって、環境に関する情報を$HOME/.olcne/olcne.confにあるローカル構成ファイルに書き込みます。この構成は、Platform API Serverへの以降のコールに使用されます。このオプションを使用する場合、以降のolcnectlコマンドでPlatform API Serverを指定する必要はありません。

たとえば、--update-configオプションを使用して環境を作成する場合は、次のようになります。

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

以降はどのolcnectlコマンドを記述する場合も、--api-serverオプションを省略できます。たとえば:

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

また、環境変数を設定してPlatform API Serverを設定することもできます。これを行うには、オペレータ・ノードで$OLCNE_API_SERVER_BIN環境変数を使用します。たとえば、Platform API Serverをlocalhostに設定するには、次を使用します。

export OLCNE_API_SERVER_BIN=127.0.0.1:8091

1.3 グローバル・フラグの使用

すべてのolcnectlコマンドで使用できるグローバル・フラグ(コマンド・オプション)が数多くあります。

これらのオプションは、olcnectl environment createコマンドを使用して環境を作成する際に最もよく使用しますが、それ以外のすべてのolcnectlコマンドでも使用できます。グローバル・オプションは次のとおりです。

[{-a|--api-server} api_server_address:8091]
[--config-file path]
[--secret-manager-type {file|vault}]
[--update-config]
[--olcne-ca-path ca_path]
[--olcne-node-cert-path node_cert_path]
[--olcne-node-node-key-path node_key_path]
[--olcne-tls-cipher-suites ciphers]
[--olcne-tls-max-version version]
[--olcne-tls-min-version version]
[--vault-address vault_address]
[--vault-cert-sans vault_cert_sans]
[--vault-token vault_token]

説明:

{-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の設定の詳細は、1.2項「Platform API Serverの設定」を参照してください。

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

--config-file path

環境の構成情報を含むYAMLファイルのロケーションおよびmodule(s)。ファイル名拡張子は、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サービス(プラットフォーム・エージェントおよびプラットフォームAPIサーバー)に使用するTLS暗号スイート。カンマ区切りリストで1つ以上入力します。オプションは次のとおりです。

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_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_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認証トークン。