Confluent CLI のインストール¶

インストール¶

Confluent CLI は、Confluent Platform のフルインストールパッケージに含まれています。

confluent update コマンドを使用したアップデートは、Confluent Platform のフルパッケージに含まれている CLI による互換性の確保のために無効にされています。スクリプトを使用した CLI の上位バージョンへのアップグレードについては、「 Confluent Platform パッケージにある代わりのバージョンのインストール」を参照してください。

Confluent Community ソフトウェアのユーザーは、CLI を別でダウンロードし、そのインストールを指すように手動で構成する必要があります。

重要

Confluent CLI を別でダウンロードしてインストールする場合は、実行している Confluent Platform のバージョンと互換性がある Confluent CLI バージョンをインストールしていることを確認してください。Confluent CLI の最新バージョンには、実行している Confluent Platform のバージョンとの互換性がない場合があります。詳細については、 Confluent CLI と Confluent Platform の間の互換性の表を参照してください。

サポートされる環境¶

Confluent CLI がサポートされるオペレーティングシステムは、macOS、Microsoft Windows、および Linux（Alpine を含む）です。

スクリプトによるインストール¶

注釈

Microsoft Windows の場合、コマンド curl と sh を使用するために、Windows Subsystem for Linux などの適切な Linux 環境をインストールする必要がある場合があります。

すべての使用可能な Confluent CLI バージョンのリストを表示します。
```
curl -sL --http1.1 https://cnfl.io/cli | sh -s -- -l
```
上記の出力リストに一覧表示される特定のバージョンをダウンロードします。

スクリプトは、実行されているシステムを検出し、適切なバイナリをダウンロードします。
- Confluent CLI をデフォルトのディレクトリ ./bin にダウンロードしてインストールするには、次のようにします。
```
curl -sL --http1.1 https://cnfl.io/cli | sh -s -- <version>
```
  たとえば、1.16.3 バージョンをダウンロードするには、次のように指定します。
```
curl -sL --http1.1 https://cnfl.io/cli | sh -s -- v1.16.3
```
- Confluent CLI を任意のカスタムディレクトリにダウンロードしてインストールするには、-b <path-to-cli> を指定します。
```
curl -sL --http1.1 https://cnfl.io/cli | sh -s -- v1.16.3 -b <path-to-cli>
```
  <path-to-cli> を PATH の中に入れる必要があります。
  
  使用している OS とアーキテクチャにご注意ください。たとえば、macOS で上記のスクリプトを実行すると、以下のターミナル出力が表示されます。これは、マシンの適切なバイナリが darwin オペレーティングシステムタイプおよび amd64 アーキテクチャタイプのものであることを示しています。
```
confluentinc/cli info found version: v1.16.3 for v1.16.3/darwin/amd64
```
前のステップで CLI バイナリをダウンロードしたディレクトリを PATH 環境に設定します。
CLI がログおよびデータを保存するデフォルトのディレクトリに十分な容量がない場合は、別のディレクトリを CONFLUENT_CURRENT 環境変数に設定できます（省略可）。
```
export CONFLUENT_CURRENT=<Directory you want to use for CLI logs and data>
```

Tarball または Zip によるインストール¶

プラットフォームごとに、最新リリースの未加工のバイナリをダウンロードしてインストールします。
前のステップで CLI バイナリをダウンロードしたディレクトリを PATH 環境に設定します。
CLI がログおよびデータを保存するデフォルトのディレクトリに十分な容量がない場合は、別のディレクトリを CONFLUENT_CURRENT 環境変数に設定できます（省略可）。
```
export CONFLUENT_CURRENT=<Directory you want to use for CLI logs and data>
```

Confluent Platform パッケージにある代わりのバージョンのインストール¶

Confluent Platform パッケージには、Confluent CLI によってサポートされている各オペレーティングシステムとアーキテクチャのタイプの Confluent CLI バイナリが含まれています。

Confluent Platform によって使用される Confluent CLI のバージョンは、特定の Confluent CLI バイナリをダウンロードして現在のバイナリの代わりに使用することによって変更することができます。

「スクリプトによるインストール」で説明されているように、Confluent CLI の適切なバージョンをダウンロードします。
ダウンロードしたバイナリを使用して、$CONFLUENT_HOME/libexec/cli/ のサブディレクトリにある既存の Confluent CLI バイナリを置き換えます。この例で該当するサブディレクトリは $CONFLUENT_HOME/libexec/cli/darwin_amd64/ で、これは上記のオペレーティングシステムタイプとアーキテクチャタイプに相当します。
以下のコマンドを使用して、CLI のバージョンと OS タイプを確認します。
```
confluent version
```

Java バージョンの要件¶

非 Windows プラットフォームの Confluent CLI では、 confluent local コマンド（Confluent Platform のローカルインストールで機能するように設計されている）を利用できます。このコマンドの実行には Java が必要であり、JDK バージョン 1.8 または 1.11 が推奨されています。複数のバージョンの Java がインストールされている場合は、JAVA_HOME を Confluent Platform で使用するバージョンに設定します。

重要

複数の JDK が存在する場合に JAVA_HOME を設定することで、Confluent CLI のデフォルトがインストール済みの最新バージョンの Java（サポート対象外の可能性があります）にならないようにすることができます。デフォルトの Java バージョンがサポートされていない場合、サポートされているバージョンがインストールされており、使用中の JDK として設定されている（ java -version への出力として示される）場合でも、CLI が失敗し、サポート対象外の Java バージョンに関するメッセージが表示されます。

JAVA_HOME を設定するには、サポートされる JDK の場所を .bash_profile などのファイル内の PATH に追加するか、現在のシェルで一時的に環境変数として設定します。
```
export JAVA_HOME=<path-to-JDK-home>
```
以下に例を示します。
```
export JAVA_HOME=/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home/
```
インストールされている Java のバージョンの場所を確認するには、コマンドシェルで次のように入力します。
```
/usr/libexec/java_home -V
```
出力は次の例のようになります。この例では、12.0.1、1.8.0_212 という 2 つの JDK が示されています。
```
/usr/libexec/java_home -V
Matching Java Virtual Machines (2):
    12.0.1, x86_64: "OpenJDK 12.0.1"        /Library/Java/JavaVirtualMachines/openjdk-12.0.1.jdk/Contents/Home
    1.8.0_212, x86_64:      "AdoptOpenJDK 8"        /Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home
```
ここでは、JDK 1.8 を .bash_profile に追加します。
```
#JAVA_HOME
export JAVA_HOME=/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home/
```
これにより、Confluent CLI は、インストールされている Java バージョンの数に関係なく、指定したサポート対象 JDK 1.8 を使用して実行されます。

Confluent Platform でサポートされている Java のバージョンも参照してください。

検証¶

PATH シェル変数を設定します。

export PATH=<$CONFLUENT_HOME>/bin:${PATH};

confluent とターミナルに入力して開始します。

confluent

Confluent CLI の使用方法が表示されます。

Manage your Confluent Platform.

Usage:
    confluent [command]

 Available Commands:
    completion  Print shell completion code.
    help        Help about any command
    iam         Manage RBAC and IAM permissions.
    local       Manage a local Confluent Platform development environment.
    login       Log in to Confluent Platform. This is required for RBAC.
    logout      Log out of Confluent Platform.
    secret      Manage secrets for Confluent Platform.
    update      Update the confluent CLI.
    version     Print the confluent CLI version.

 Flags:
    -h, --help            help for confluent
    -v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).
        --version         version for confluent

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

RBAC が有効になっている場合は、メタデータサービスの URL（ <url> ）を指定して Confluent CLI にログインする必要があります。詳しくは、「 confluent login」を参照してください。
```
confluent login --url <url>
```
```
Enter your Confluent credentials:
Email:
Password:
```
出力は以下のようになります。
```
Logged in as user
```
ローカル開発環境を使用して Confluent CLI を試してみます。

Confluent Platform のプロパティファイル¶

以下はデフォルトの Confluent Platform サービス構成プロパティファイルのリストです。 $CONFLUENT_HOME は、Confluent Platform をインストールしたディレクトリです。Confluent Platform サービスを使用するときに、適切なファイルを参照または変更します。

Connect : $CONFLUENT_HOME/etc/schema-registry/connect-avro-distributed.properties
Control Center : $CONFLUENT_HOME/etc/confluent-control-center/control-center-dev.properties
Kafka : $CONFLUENT_HOME/etc/kafka/server.properties
REST Proxy : $CONFLUENT_HOME/etc/kafka-rest/kafka-rest.properties
ksqlDB : $CONFLUENT_HOME/etc/ksqldb/ksql-server.properties
スキーマレジストリ : $CONFLUENT_HOME/etc/schema-registry/schema-registry.properties
ZooKeeper : $CONFLUENT_HOME/etc/kafka/zookeeper.properties