Elasticsearch::XPack
A Ruby integration for the X-Pack extension for Elasticsearch.
Installation
Install the package from Rubygems:
gem install elasticsearch-xpack
To use an unreleased version, either add it to your Gemfile
for Bundler:
gem 'elasticsearch-xpack', git: 'https://github.com/elastic/elasticsearch-ruby.git'
Usage
If you use the official Ruby client for Elasticsearch,
require the library in your code, and all the methods will be automatically available in the xpack
namespace:
require 'elasticsearch'
require 'elasticsearch/xpack'
client = Elasticsearch::Client.new url: 'http://elastic:changeme@localhost:9200'
client.xpack.info
# => {"build"=> ..., "features"=> ...}
The integration is designed as a standalone Elasticsearch::XPack::API
module, so it's easy
to mix it into a different client, and the methods will be available in the top namespace.
For documentation, look into the RDoc annotations in the source files, which contain links to the official X-Pack for the Elastic Stack documentation.
For examples, look into the examples
folder in this repository.
You can use the provided test:elasticsearch
Rake task to launch
a Docker-based
Elasticsearch node with the full X-Pack license preinstalled.
License
This software is licensed under the Apache 2 license, quoted below.
Licensed to Elasticsearch B.V. under one or more contributor
license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright
ownership. Elasticsearch B.V. licenses this file to you under
the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.