2 CLIの使用
Kubernetesクラスタの作成および管理に使用するOracle CNE CLI (ocne
コマンド)を紹介します。
この章では、CLIの使用方法について説明します。
構文ヘルプの表示
CLI構文のヘルプを取得する方法について学習します。
すべてのocne
コマンドには、構文に関するヘルプを表示するオプションが含まれています。 オプションを指定せずにocne
コマンドを入力すると、ヘルプが表示されます:
ocne
出力は次のようになります:
The ocne tool manages an ocne environment
Usage:
ocne [command]
Available Commands:
application Manage ocne applications
catalog Manage ocne catalogs
cluster Manage ocne clusters
completion Generate the autocompletion script for the specified shell
help Help about any command
image Manage ocne images
info Display CLI version information and environment variables
node Manage ocne nodes
Flags:
-h, --help help for ocne
-l, --log-level string Sets the log level. Valid values are "error", "info", "debug", and "trace". (default "info")
Use "ocne [command] --help" for more information about a command.
コマンドに関するヘルプを表示するには、各コマンドで--help
または-h
オプションを使用します。 たとえば:
ocne cluster --help
または、ocne help
コマンドを使用します。 たとえば:
ocne help cluster
出力は次のようになります:
Manage the lifecycle of ocne clusters and application deployment.
Usage:
ocne cluster [flags]
ocne cluster [command]
Examples:
ocne cluster <subcommand>
Available Commands:
analyze Analyze the cluster and report problems
backup Backup the etcd database
console Launch a console on a node
delete Destroy a cluster
dump Dump the cluster
info Get cluster information
join Join a node to a cluster, or generate the materials required to do so
list List clusters
show Show cluster configuration
stage Stage a cluster update to a specified k8s version
start Start an OCNE cluster
template Outputs a cluster configuration template
update Updates the version of a cluster
Flags:
-h, --help help for cluster
-k, --kubeconfig string the kubeconfig filepath
Global Flags:
-l, --log-level string Sets the log level. Valid values are "error", "info", "debug", and "trace". (default "info")
Use "ocne cluster [command] --help" for more information about a command.
プレフィクス一致
CLIでプレフィクス・マッチングを使用する方法を学習します。
ocne
コマンドでは、あいまいでないプレフィクスに対してプレフィクス一致を使用できます。 たとえば、完全なocne cluster start
コマンドのかわりに次のものを使用できます:
ocne cl s
ocne clu star
完全なocne application list
コマンドを入力するかわりに、次のものを使用できます:
ocne ap l
もう1つの例は、ocne catalog list
コマンドの場合です。次のものを使用できます:
ocne ca l
コマンドライン補完
CLIでコマンド行補完を使用する方法について学習します。
ocne
コマンドのコマンドライン完了を設定できます。 コマンドライン完了がデフォルトで設定されていない場合は、ocne completion
コマンドを使用して、シェルのコマンドライン完了スクリプトを生成します。
たとえば、Oracle LinuxでBashシェルのコマンドライン完了スクリプトを生成するには、次を実行します:
ocne completion bash
生成されたコマンドライン完了スクリプトは、/etc/bash_completion.d/ocne
に保存する必要があります。
次のコマンドを使用して、スクリプトを生成し、正しいロケーションに保存できます:
ocne completion bash | sudo tee /etc/bash_completion.d/ocne
これを有効にするには、新しいシェル・セッションを開始します。 また、システムにbash-completion
パッケージをインストールする必要があります。
環境変数
CLIで環境変数を使用する方法について学習します。
環境変数を使用して、一部のocne
コマンドで使用されるオプションを設定できます。 使用される環境変数は次のとおりです:
-
KUBECONFIG
:kubeconfig
ファイルのロケーションを設定します。 これは、ほとんどのocne
コマンドで--kubeconfig
オプションと同じように動作します。 たとえば:export KUBECONFIG=$HOME/.kube/kubeconfig.ocne.local
-
EDITOR
: デフォルトのドキュメント・エディタを設定します。 たとえば:export EDITOR=/usr/bin/vim
-
OCNE_DEFAULTS
: デフォルトの構成ファイルのロケーションを設定します。 これは、デフォルト値の$HOME/.ocne/defaults.yaml
をオーバーライドするために使用されます。 たとえば:export OCNE_DEFAULTS=$HOME/.ocne/mydefaults.yaml
ocne info
コマンドを実行して、CLIが使用する環境変数の値を調べることができます:ocne info