confluent-hub インストール¶

説明¶

Confluent Hub からコンポーネントをインストールします。

使用方法¶

confluent-hub install [ --component-dir <componentDir> ]
                      [ --dry-run ]
                      [ --no-prompt ]
                      [ --verbose ]
                      [ --worker-configs <workerConfigs> ]
                      [--]
                      <id>

ちなみに

使用方法を表示するには、confluent-hub help install を入力します。

オプション¶

名前	デフォルト	説明
`--component-dir <componentDir>`		コンポーネントのインストール先のローカルディレクトリ。クライアントが Confluent Platform のアーカイブインストールで実行されている場合のデフォルトは `$share/confluent-hub-components` 、クライアントが DEB または RPM インストールで実行されている場合のデフォルトは `/usr/share/confluent-hub-components` です。このオプションで指定する値は、ファイルシステムに実際に存在するパスでなければなりません。また、そのパスは読み取り/書き込みが可能である必要があります。
`--dry-run`		操作をシミュレーションします。実際の変更は行われませんが、通常の操作により実行される手順および変更内容がすべてレポートされます。
`--no-prompt`		ユーザーへの入力プロンプトは表示されず、すべてがデフォルト値または推奨値で実行されます。
`--verbose`		より詳細な情報が出力されます。
`--worker-configs <workerConfigs>`		1 つ以上の Connect ワーカーの構成ファイルへのパスです。これらのファイルのプラグインパスは、Connect で新規インストールされたコンポーネントを検索できるようにコンポーネントディレクトリを含むようにアップデートすることができます。複数のパスがある場合は、コロン（ `:` ）で区切って記述します。
`--`		このオプションは、引数のリストとコマンドラインオプションを区切るために使用します。引数がコマンドラインオプションに誤認識される可能性がある場合に便利です。

位置指定引数¶

名前	デフォルト	説明
`<id>`		Confluent Hub のコンポーネントの識別子を `owner/component:version` の形式で指定します。または、Confluent Hub からダウンロードしたローカル ZIP ファイルへのパスを指定します。

サンプル¶

Confluent の最新バージョンの JMS コネクターをインストールします。コンポーネント名は kafka-connect-jms、オーナーは confluentinc です。

confluent-hub install confluentinc/kafka-connect-jms:latest

対話型モードでツールを実行し、ソフトウェアをインストールします。ユーザーは最初に、このコンポーネントをインストールするかどうかの確認を求められます。

Do you want to install this into /Users/jsmith/confluent-/share/confluent-hub-components? (yN)

「 N 」と入力すると、ツールは何もせずに終了します。「 y 」と入力すると、クライアントは操作を続行し、さらに情報を出力します。

Downloading component Kafka Connect JMS , provided by Confluent, Inc. from Confluent Hub
and installing into /Users/jsmith/confluent-/share/confluent-hub-components

Detected Worker's configs:
  1. Standard: /Users/jsmith/confluent-/etc/kafka/connect-distributed.properties
  2. Standard: /Users/jsmith/confluent-/etc/kafka/connect-standalone.properties
Do you want to update all detected configs? (yN)

「 N 」と入力すると、ツールは何もせずに終了します。「 y 」と入力すると、クライアントは操作を続行し、さらに情報を出力します。

Adding installation directory to plugin path in the following files:
  /Users/jsmith/confluent-/etc/kafka/connect-distributed.properties
  /Users/jsmith/confluent-/etc/kafka/connect-standalone.properties

Completed

Confluent Hub クライアントが Confluent Platform インストールで実行されている場合、システムで指定するディレクトリパスや構成ファイルは変わることがあります。

ドライラン¶

Confluent Hub クライアントでソフトウェアをインストールする際に、慎重を期すために、まずはシステムに変更を加えずにインストールを実行する場合は、--dry-run オプションを指定します。この場合、最初に次の文が出力されます。

Doing a dry run of a command

最後に次の文が出力されます。

A dry run has been completed successfully. All requirements are met. You can proceed with the installation.

--dry-run オプションと --verbose オプションを組み合わせて、ドライランを実行していない場合での処理の詳細情報をクライアントに出力させることもできます。

スクリプト¶

Confluent Hub クライアントは、スクリプトでも使用できるように設計されています。アクセス可能であれば、Dockerfile でも使用できます。インストールプロセスを詳細に制御するオブションがいくつか用意されています。

1 番目は、--no-prompt オプションです。これを指定すると、クライアントはユーザー入力を求めずに、すべての入力にデフォルト値を使用します（他に指定値がない場合）。

2 番目は、--component-dir <componentDir> オプションです。これは、コンポーネントのインストール先のローカルディレクトリを指定します。相対パスまたは絶対パスを使用してディレクトリを指定します。

3 番目は、--worker-configs <workerConfigs> オプションです。これにはすべての Connect ワーカーの構成ファイルを指定します。これらの構成ファイルの plugin.path 構成のプロパティにはコンポーネントのディレクトリが記述される必要があるため、内容を確認して場合によってはファイルを変更する必要があります。複数のパスがある場合は、コロン（ : ）で区切って記述します。

最後に、インストール中に不具合が発生した場合には、その情報がクライアントのエラーコードで示されます。