OpenSearch/README.asciidoc
Hendrik Muhs b84e926431 improve documentation after ML got in and x-pack split (elastic/x-pack-elasticsearch#599)
Removing kibana and logstash disabling as it does not apply after x-pack split, document machine learning binary retrieval.

Original commit: elastic/x-pack-elasticsearch@fa63ce8ab5
2017-02-20 12:16:56 +01:00

68 lines
1.3 KiB
Plaintext

= Elasticsearch X Pack
A set of Elastic's commercial plugins:
- License
- Security
- Watcher
- Monitoring
- Machine Learning
= Setup
You must checkout x-pack and elasticsearch with a specific directory structure. The
elasticsearch checkout will be used when building x-pack. The structure is:
- /path/to/elastic/elasticsearch
- /path/to/elastic/elasticsearch-extra/x-pack-elasticsearch
== Native Code
**This is mandatory as tests depend on it**
Machine Learning requires platform specific binaries, build from https://github.com/elastic/machine-learning-cpp via CI servers.
The native artifacts are stored in S3. To retrieve them infra's team Vault service is utilized, which
requires a github token. Please setup a github token as documented:
https://github.com/elastic/infra/blob/master/docs/vault.md#github-auth
The github token has to be put into ~/.elastic/github.token, while the file rights must be set to 0600.
= Build
- Run unit tests:
+
[source, txt]
-----
gradle clean test
-----
- Run all tests:
+
[source, txt]
-----
gradle clean check
-----
- Run integration tests:
+
[source, txt]
-----
gradle clean integTest
-----
- Package X-Pack (wihtout running tests)
+
[source, txt]
-----
gradle clean assemble
-----
- Install X-Pack (wihtout running tests)
+
[source, txt]
-----
gradle clean install
-----