elasticsearch-keystore

この elasticsearch-keystore コマンドは、Elasticsearch キーストア内の セキュア設定 を管理します。

Synopsis

Shell

  1. bin/elasticsearch-keystore
  2. ( [add <settings>] [-f] [--stdin]
  3. | [add-file (<setting> <path>)+]
  4. | [create] [-p]
  5. | [has-passwd]
  6. | [list]
  7. | [passwd]
  8. | [remove <setting>]
  9. | [show [-o <output-file>] <setting>]
  10. | [upgrade]
  11. ) [-h, --help] ([-s, --silent] | [-v, --verbose])

Description

このコマンドは、Elasticsearch を実行するユーザーとして実行する必要があります。

現在、すべてのセキュア設定はノード固有の設定であり、すべてのノードで同じ値を持つ必要があります。したがって、このコマンドはすべてのノードで実行する必要があります。

キーストアがパスワードで保護されている場合、Elasticsearch が起動するたびにパスワードを入力する必要があります。

キーストアへの変更は、実行中の Elasticsearch ノードに自動的には適用されません。キーストアへの変更は、Elasticsearch を再起動したときに有効になります。一部のセキュア設定は、再起動なしで明示的に リロード できます。

キーストアから読み取るように設計されているのは一部の設定のみです。ただし、サポートされていない設定がキーストアからブロックされることはなく、Elasticsearch の起動に失敗する可能性があります。設定がキーストアでサポートされているかどうかを確認するには、設定リファレンスを参照してください。

Parameters

  • add <settings>
  • 設定をキーストアに追加します。複数の設定名を add コマンドの引数として指定できます。デフォルトでは、設定の値を入力するように求められます。キーストアがパスワードで保護されている場合、パスワードの入力も求められます。設定がすでにキーストアに存在する場合、現在の値を上書きすることを確認する必要があります。キーストアが存在しない場合、キーストアを作成することを確認する必要があります。これらの2つの確認プロンプトを回避するには、-f パラメータを使用します。
  • add-file (<setting> <path>)+
  • キーストアにファイルを追加します。
  • create
  • キーストアを作成します。
  • -f, --force
  • add パラメータと共に使用すると、コマンドはキーストア内の既存のエントリを上書きする前にプロンプトを表示しなくなります。また、まだキーストアを作成していない場合は、パスワードで保護されていないが難読化されたキーストアが作成されます。
  • -h, --help
  • すべてのコマンドパラメータを返します。
  • has-passwd
  • キーストアが存在し、パスワードで保護されている場合は成功メッセージを返します。それ以外の場合、コマンドは終了コード 1 で失敗し、エラーメッセージを返します。
  • list
  • キーストア内の設定をリストします。キーストアがパスワードで保護されている場合、パスワードの入力を求められます。
  • -p
  • create パラメータと共に使用すると、コマンドはキーストアパスワードの入力を求めます。-p フラグを指定しないか、空のパスワードを入力した場合、キーストアは難読化されますがパスワードで保護されません。
  • passwd
  • キーストアのパスワードを変更または設定します。キーストアがパスワードで保護されている場合、現在のパスワードと新しいパスワードの入力を求められます。オプションで、空の文字列を使用してパスワードを削除できます。キーストアがパスワードで保護されていない場合、このコマンドを使用してパスワードを設定できます。
  • remove <settings>
  • キーストアから設定を削除します。複数の設定名を remove コマンドの引数として指定できます。
  • show <setting>
  • キーストア内の単一設定の値を表示します。-o (または --output) パラメータを渡して、設定をファイルに書き込みます。標準出力（ターミナル）に書き込む場合、設定の値は常に UTF-8 文字列として解釈されます。設定にバイナリデータが含まれている場合（例えば、add-file コマンドを介して追加されたデータ）、常に -o オプションを使用してファイルに書き込む必要があります。
  • -s, --silent
  • 最小限の出力を表示します。
  • -x, --stdin
  • add パラメータと共に使用すると、標準入力（stdin）を介して設定値を渡すことができます。複数の値をキャリッジリターンまたは改行で区切ります。キーストアに設定を追加するを参照してください。
  • upgrade
  • キーストアの内部フォーマットをアップグレードします。
  • -v, --verbose
  • 詳細な出力を表示します。

Examples

Create the keystore

キーストアを作成するには、create コマンドを使用します: 

  1. bin/elasticsearch-keystore create -p

キーストアパスワードの入力を求められます。パスワードで保護された elasticsearch.keystore ファイルが elasticsearch.yml ファイルとともに作成されます。

Change the password of the keystore

キーストアのパスワードを変更するには、passwd コマンドを使用します: 

  1. bin/elasticsearch-keystore passwd

Elasticsearch キーストアがパスワードで保護されている場合、現在のパスワードの入力と新しいパスワードの入力を求められます。パスワードで保護されていない場合は、パスワードを設定するように求められます。

List settings in the keystore

キーストア内の設定をリストするには、list コマンドを使用します。 

  1. bin/elasticsearch-keystore list

Elasticsearch キーストアがパスワードで保護されている場合、パスワードの入力を求められます。

Add settings to the keystore

Cloud プラグインの認証情報などの機密文字列設定は、add コマンドを使用して追加できます: 

  1. bin/elasticsearch-keystore add the.setting.name.to.set

設定の値の入力を求められます。Elasticsearch キーストアがパスワードで保護されている場合、パスワードの入力も求められます。

add コマンドを使用して複数の設定を追加することもできます: 

  1. bin/elasticsearch-keystore add \
  2.   the.setting.name.to.set \
  3.   the.other.setting.name.to.set

設定の値の入力を求められます。Elasticsearch キーストアがパスワードで保護されている場合、パスワードの入力も求められます。

標準入力（stdin）を介して設定値を渡すには、--stdin フラグを使用します: 

  1. cat /file/containing/setting/value | bin/elasticsearch-keystore add --stdin the.setting.name.to.set

複数の設定の値はキャリッジリターンまたは改行で区切る必要があります。

Add files to the keystore

Cloud プラグインの認証キー ファイルなどの機密ファイルは、add-file コマンドを使用して追加できます。設定とファイルパスは、setting path からなるペアで指定されます。設定の値は、ファイルがキーストアに追加された時点でのファイルパスのバイナリ内容になります。 

  1. bin/elasticsearch-keystore add-file the.setting.name.to.set /path/example-file.json

add-file コマンドを使用して複数のファイルを追加できます: 

  1. bin/elasticsearch-keystore add-file \
  2.   the.setting.name.to.set /path/example-file.json \
  3.   the.other.setting.name.to.set /path/other-example-file.json

Elasticsearch キーストアがパスワードで保護されている場合、パスワードの入力を求められます。

Show settings in the keystore

キーストア内の設定の値を表示するには、show コマンドを使用します: 

  1. bin/elasticsearch-keystore show the.name.of.the.setting.to.show

設定にバイナリデータが含まれている場合は、-o (または --output) オプションを使用してファイルに書き込む必要があります: 

  1. bin/elasticsearch-keystore show -o my_file binary.setting.name

Elasticsearch キーストアがパスワードで保護されている場合、パスワードの入力を求められます。

Remove settings from the keystore

キーストアから設定を削除するには、remove コマンドを使用します: 

  1. bin/elasticsearch-keystore remove the.setting.name.to.remove

remove コマンドを使用して複数の設定を削除することもできます: 

  1. bin/elasticsearch-keystore remove \
  2.   the.setting.name.to.remove \
  3.   the.other.setting.name.to.remove

Elasticsearch キーストアがパスワードで保護されている場合、パスワードの入力を求められます。

Upgrade the keystore

時折、キーストアの内部フォーマットが変更されます。パッケージマネージャから Elasticsearch をインストールすると、パッケージのアップグレード中にディスク上のキーストアが新しいフォーマットにアップグレードされます。他のケースでは、Elasticsearch はノードの起動中にアップグレードを実行します。これには、Elasticsearch がキーストアを含むディレクトリへの書き込み権限を持っている必要があります。あるいは、upgrade コマンドを使用して手動でそのようなアップグレードを実行できます: 

  1. bin/elasticsearch-keystore upgrade