前書き
Elasticsearchは、データをリアルタイムで分散検索および分析するためのプラットフォームです。 その人気は、その使いやすさ、強力な機能、およびスケーラビリティによるものです。
ElasticsearchはRESTful操作をサポートします。 これは、HTTPメソッド(GET、POST、PUT、DELETEなど)をHTTP URI(/ collection / entry)と組み合わせて使用してデータを操作できることを意味します。 直感的なRESTfulアプローチは開発者にとってもユーザーにとっても使いやすいものであり、これがElasticsearchの人気の理由の1つです。
Elasticsearchは、堅固な企業の背後にある無料のオープンソースソフトウェア— Elasticです。 この組み合わせにより、個人テストから企業統合まで、あらゆる場所での使用に適しています。
この記事では、Elasticsearchを紹介し、インストール、設定、使用の開始方法を示します。
前提条件
このチュートリアルを実行する前に、次の前提条件を満たしていることを確認してください。
-
Ubuntu 14.04ドロップレット
-
非ルートsudoユーザー。 詳細については、Initial Server Setup with Ubuntu 14.04を確認してください。
特に断りのない限り、このチュートリアルでルート権限を必要とするすべてのコマンドは、sudo権限を持つ非ルートユーザーとして実行する必要があります。
仮定
このチュートリアルでは、サーバーがここで説明されているようなVPNを使用していることを前提としています:How To Use Ansible and Tinc VPN to Secure Your Server Infrastructure。 これにより、サーバーが使用している物理ネットワークに関係なく、プライベートネットワーク機能が提供されます。
DigitalOcean Private Networkingなどの共有プライベートネットワークを使用している場合、このセキュリティ機能は、同じチームまたは同じリージョンのアカウントのサーバーに対してすでに有効になっています。 Elasticsearchを使用する場合、HTTPインターフェースにセキュリティが組み込まれていないため、これは特に重要です。
[[step-1 -—- installing-java]] ==ステップ1—Javaのインストール
ElasticsearchはJavaプログラミング言語で記述されているため、まず、DropletにJavaランタイム環境(JRE)が必要です。 ElasticsearchにはJava 7以降が必要です。 ElasticsearchはOracle JDKバージョン1.8.0_73を推奨していますが、JREのネイティブUbuntu OpenJDKネイティブパッケージも機能します。
この手順では、両方のバージョンをインストールする方法を示し、どちらが最適かを判断できます。
OpenJDKのインストール
JRE用のネイティブUbuntu OpenJDKネイティブパッケージは無料で、十分にサポートされており、Ubuntu APTインストールマネージャーを介して自動的に管理されます。
APTでOpenJDKをインストールする前に、次のコマンドを実行して、Ubuntu Dropletにインストール可能なパッケージのリストを更新します。
sudo apt-get update
その後、次のコマンドでOpenJDKをインストールできます。
sudo apt-get install openjdk-7-jre
JREがインストールされ、使用できることを確認するには、次のコマンドを実行します。
java -version
結果は次のようになります。
Output of java -versionjava version "1.7.0_79"
OpenJDK Runtime Environment (IcedTea 2.5.6) (7u79-2.5.6-0ubuntu1.14.04.1)
OpenJDK 64-Bit Server VM (build 24.79-b02, mixed mode)
Java 8のインストール
Elasticsearchの使用を進め、より優れたJavaのパフォーマンスと互換性を探し始めたら、Oracle独自のJava(Oracle JDK 8)をインストールすることを選択できます。
aptにOracle Java PPAを追加します。
sudo add-apt-repository -y ppa:webupd8team/java
aptパッケージデータベースを更新します。
sudo apt-get update
次のコマンドを使用して、Oracle Java 8の最新の安定バージョンをインストールします(ポップアップ表示されるライセンス契約に同意します)。
sudo apt-get -y install oracle-java8-installer
最後に、インストールされていることを確認します。
java -version
[[step-2 -—- downloading-and-installing-elasticsearch]] ==ステップ2—Elasticsearchのダウンロードとインストール
Elasticsearchは、zip、tar.gz、deb、またはrpmパッケージのelastic.coから直接ダウンロードできます。 Ubuntuの場合、Elasticsearchを実行するために必要なすべてをインストールするdeb(Debian)パッケージを使用するのが最善です。
この記事の執筆時点では、最新のElasticsearchバージョンは1.7.2です。 次のコマンドを使用して、選択したディレクトリにダウンロードします。
wget https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-1.7.2.deb
次に、次のようにdpkg
コマンドを使用して通常のUbuntuの方法でインストールします。
sudo dpkg -i elasticsearch-1.7.2.deb
[.tip]#Tip: Elasticsearchの最新リリースバージョンが必要な場合は、elastic.coに移動してリンクを見つけ、wget
を使用してDropletにダウンロードします。 必ずdebパッケージをダウンロードしてください。
#
これにより、Elasticsearchが/usr/share/elasticsearch/
にインストールされ、構成ファイルが/etc/elasticsearch
に配置され、initスクリプトが/etc/init.d/elasticsearch
に追加されます。
ElasticsearchがDropletで自動的に開始および停止することを確認するには、次のコマンドを使用して、initスクリプトをデフォルトのランレベルに追加します。
sudo update-rc.d elasticsearch defaults
[[step-3 -—- configuring-elastic]] ==ステップ3—Elasticの構成
ElasticsearchとそのJava依存関係がインストールされたので、Elasticsearchを構成します。
Elasticsearch構成ファイルは/etc/elasticsearch
ディレクトリにあります。 次の2つのファイルがあります。
-
elasticsearch.yml
—Elasticsearchサーバーの設定を構成します。 これは、ロギングのオプションを除くすべてのオプションが保存される場所です。そのため、このファイルに最も関心があるのはこのためです。 -
logging.yml
—ロギングの構成を提供します。 最初は、このファイルを編集する必要はありません。 すべてのデフォルトのログオプションをそのまま使用できます。 結果のログは、デフォルトで/var/log/elasticsearch
にあります。
Elasticsearchサーバーでカスタマイズする最初の変数は、node.name
とelasticsearch.yml
のcluster.name
です。 それらの名前が示すように、node.name
は、サーバー(ノード)の名前と、後者が関連付けられているクラスターを指定します。
これらの変数をカスタマイズしない場合、Dropletホスト名に関してnode.name
が自動的に割り当てられます。 cluster.name
は、デフォルトのクラスターの名前に自動的に設定されます。
cluster.name
値は、Elasticsearchの自動検出機能によって使用され、Elasticsearchノードを自動的に検出してクラスターに関連付けます。 したがって、デフォルト値を変更しないと、クラスター内の同じネットワーク上に不要なノードが見つかる可能性があります。
メインのelasticsearch.yml
構成ファイルの編集を開始するには:
sudo nano /etc/elasticsearch/elasticsearch.yml
node.name
およびcluster.name
の行の先頭にある#
文字を削除してコメントを解除してから、それらの値を変更します。 /etc/elasticsearch/elasticsearch.yml
ファイルでの最初の構成変更は次のようになります。
/etc/elasticsearch/elasticsearch.yml
...
node.name: "My First Node"
cluster.name: mycluster1
...
もう1つの重要な設定は、サーバーの役割です。これは、「マスター」または「スレーブ」のいずれかです。 「マスター」は、クラスターの正常性と安定性を担当します。 多数のクラスターノードがある大規模な展開では、複数の専用「マスター」を持つことをお勧めします。通常、専用「マスター」はデータを保存したり、インデックスを作成したりしません。 したがって、過負荷になる可能性はなく、それによってクラスターの健全性が危険にさらされる可能性があります。
「スレーブ」は、データタスクをロードできる「作業馬」として使用されます。 「スレーブ」ノードが過負荷になっても、追加の負荷をかける他のノードがあれば、クラスターの状態に深刻な影響はありません。
サーバーの役割を決定する設定は、node.master
と呼ばれます。 Elasticsearchノードが1つしかない場合は、このオプションをコメントアウトしたままにして、デフォルト値のtrue
を維持する必要があります。 唯一のノードもマスターである必要があります。 または、ノードをスレーブとして構成する場合は、node.master
行の先頭にある#
文字を削除し、値をfalse
に変更します。
/etc/elasticsearch/elasticsearch.yml
...
node.master: false
...
もう1つの重要な構成オプションはnode.data
です。これは、ノードがデータを格納するかどうかを決定します。 ほとんどの場合、このオプションはデフォルト値(true
)のままにしておく必要がありますが、ノードにデータを保存したくない場合が2つあります。 1つは、既に述べたように、ノードが専用の「マスター」である場合です。 もう1つは、ノードがノードからのデータのフェッチと結果の集計にのみ使用される場合です。 後者の場合、ノードは「検索ロードバランサー」として機能します。
繰り返しますが、Elasticsearchノードが1つしかない場合は、この設定をコメントアウトしたままにして、デフォルトのtrue
値を維持する必要があります。 それ以外の場合、データのローカル保存を無効にするには、次の行のコメントを解除し、値をfalse
に変更します。
/etc/elasticsearch/elasticsearch.yml
...
node.data: false
...
他の2つの重要なオプションは、index.number_of_shards
とindex.number_of_replicas
です。 1つ目は、インデックスが分割される断片(断片)の数を決定します。 2番目は、クラスター全体に分散されるレプリカの数を定義します。 シャードを増やすとインデックス作成のパフォーマンスが向上し、レプリカを増やすと検索が高速になります。
まだ単一ノードでElasticsearchを調査およびテストしていると仮定すると、1つのシャードのみでレプリカなしで開始する方が適切です。 したがって、それらの値は次のように設定する必要があります(行の先頭にある#
を必ず削除してください)。
/etc/elasticsearch/elasticsearch.yml
...
index.number_of_shards: 1
index.number_of_replicas: 0
...
変更する可能性のある最後の設定の1つは、データが格納されるパスを決定するpath.data
です。 デフォルトのパスは/var/lib/elasticsearch
です。 実稼働環境では、Elasticsearchデータを保存するために専用のパーティションとマウントポイントを使用することをお勧めします。 最良の場合、この専用パーティションは、パフォーマンスとデータの分離を向上させる別個のストレージメディアになります。 path.data
行のコメントを解除し、その値を変更することで、別のpath.data
パスを指定できます。
/etc/elasticsearch/elasticsearch.yml
...
path.data: /media/different_media
...
すべての変更を行ったら、ファイルを保存して終了してください。 次のコマンドを使用して、Elasticsearchを初めて起動できます。
sudo service elasticsearch start
Elasticsearchを使用するには、Elasticsearchが完全に起動するまで少なくとも10秒かかります。 そうしないと、接続できないというエラーが表示される場合があります。
[[step-4 -—- securing-elastic]] ==ステップ4—Elasticの保護
Elasticsearchにはセキュリティが組み込まれていないため、HTTP APIにアクセスできるすべてのユーザーが制御できます。 このセクションは、Elasticsearchを保護するための包括的なガイドではありません。 それと、それが実行されているサーバー/仮想マシンへの不正アクセスを防ぐために必要な措置を講じてください。 システムをさらに保護するには、iptablesの使用を検討してください。
最初のセキュリティ調整は、パブリックアクセスを防止することです。 パブリックアクセスを削除するには、ファイルelasticsearch.yml
を編集します。
sudo nano /etc/elasticsearch/elasticsearch.yml
network.bind_host
を含む行を見つけ、行の先頭にある#
文字を削除してコメントを解除し、値をlocalhost
に変更して次のようにします。
/etc/elasticsearch/elasticsearch.yml
...
network.bind_host: localhost
...
[.warning]#Warning: Elasticsearchにはセキュリティが組み込まれていないため、制御または信頼していないサーバーからアクセスできるIPアドレスにこれを設定しないことが非常に重要です。 Elasticsearchをパブリックまたはshared private network IPアドレスにバインドしないでください!
#
また、セキュリティを強化するために、カスタム式の評価に使用される動的スクリプトを無効にすることができます。 カスタムの悪意のある表現を作成することにより、攻撃者が環境を危険にさらす可能性があります。
カスタム式を無効にするには、/etc/elasticsearch/elasticsearch.yml
ファイルの最後に次の行を追加します。
/etc/elasticsearch/elasticsearch.yml
...
script.disable_dynamic: true
...
[[ステップ-5 ----テスト]] ==ステップ5—テスト
現在、Elasticsearchはポート9200で実行されているはずです。 curl、コマンドラインのクライアント側URL転送ツール、および次のような簡単なGETリクエストでテストできます。
curl -X GET 'http://localhost:9200'
次の応答が表示されます。
Output of curl{
"status" : 200,
"name" : "Harry Leland",
"cluster_name" : "elasticsearch",
"version" : {
"number" : "1.7.2",
"build_hash" : "e43676b1385b8125d647f593f7202acbd816e8ec",
"build_timestamp" : "2015-09-14T09:49:53Z",
"build_snapshot" : false,
"lucene_version" : "4.10.4"
},
"tagline" : "You Know, for Search"
}
上記のような応答が表示された場合、Elasticsearchは正常に機能しています。 そうでない場合は、インストール手順を正しく実行し、Elasticsearchが完全に起動するまでしばらく時間を置いていることを確認してください。
[[step-6 --- using-elasticsearch]] ==ステップ6—Elasticsearchを使用する
Elasticsearchの使用を開始するには、まずデータを追加しましょう。 既に述べたように、ElasticsearchはRESTful APIを使用します。これは、通常のCRUDコマンド、Create、Read、Update、およびDeleteに応答します。 それを扱うために、再びcurlを使用します。
次のコマンドで最初のエントリを追加できます。
curl -X POST 'http://localhost:9200/tutorial/helloworld/1' -d '{ "message": "Hello World!" }'
次の応答が表示されます。
Output{"_index":"tutorial","_type":"helloworld","_id":"1","_version":1,"created":true}
curlを使用して、HTTP POSTリクエストをElasticsearchサーバーに送信しました。 リクエストのURIは/tutorial/helloworld/1
でした。 ここでパラメータを理解することが重要です。
-
tutorial
は、Elasticsearchのデータのインデックスです。 -
helloworld
はタイプです。 -
1
は、上記のインデックスとタイプの下にあるエントリのIDです。
この最初のエントリは、次のようなHTTP GETリクエストで取得できます。
curl -X GET 'http://localhost:9200/tutorial/helloworld/1'
結果は次のようになります。
Output{"_index":"tutorial","_type":"helloworld","_id":"1","_version":1,"found":true,"_source":{ "message": "Hello World!" }}
既存のエントリを変更するには、次のようなHTTP PUTリクエストを使用できます。
curl -X PUT 'localhost:9200/tutorial/helloworld/1?pretty' -d '
{
"message": "Hello People!"
}'
Elasticsearchは、次のような変更の成功を確認する必要があります。
Output{
"_index" : "tutorial",
"_type" : "helloworld",
"_id" : "1",
"_version" : 2,
"created" : false
}
上記の例では、最初のエントリのmessage
を「HelloPeople!」に変更しました。 これにより、バージョン番号は自動的に2
に増加しました。
上記のリクエストで余分な引数pretty
に気づいたかもしれません。 人間が読める形式を使用できるため、各データフィールドを新しい行に書き込むことができます。 また、データを取得するときに結果を「プリティ」化して、次のようなはるかに優れた出力を取得することもできます。
curl -X GET 'http://localhost:9200/tutorial/helloworld/1?pretty'
これで、応答はより優れた形式になります。
Output{
"_index" : "tutorial",
"_type" : "helloworld",
"_id" : "1",
"_version" : 2,
"found" : true,
"_source":{ "message": "Hello World!" }
}
これまで、Elasticsearchにデータを追加して照会しました。 その他の操作については、the API documentationを確認してください。
結論
Elasticsearchのインストール、設定、使用の開始は簡単です。 手動クエリで十分に遊んだら、次のタスクはアプリケーションから使用を開始することです。