GitHub user anandsubbu reopened a pull request:
https://github.com/apache/metron/pull/817
METRON-1283: Install Elasticsearch template as a part of the mpack startup
scripts
## Contributor Comments
For a Metron multi-node deployment using mpack, the Elasticsearch template
is required to be installed manually post-setup. These templates are required
for the proper working of, for e.g. the Alerts UI.
In the event that these templates are not installed, and if data is
ingested, these would not be shown in the Alerts UI, since there would be
missing fields without the template files (E.g. snort alert indices are not
displayed in the Alerts UI, since it is missing the "alerts" field from the
mapping). In such a case, one needs to install the templates, delete all
indices for the given parser and re-ingest data again into the parser for it to
appear in the Alerts UI.
Further, the indices from all the parsers will have to be deleted and
re-ingested again which could be a tedious job in the event that this step was
missed out by chance. I have also seen other ill-effects from having stale
indices for parsers that was created before template install.
While documenting the template installation is a good practice, nothing
would more failsafe than installing the template as a part of the mpack startup
scripts itself.
I have added the ES template install step just before starting the Indexing
topology, since I found this to be the closest related step when this could be
done. Do let me know if this needs to be moved to a different point in the
startup, and I can make the change.
**Testing Done**
* Built mpack with the changes
* Deployed a 12-node Metron setup using the mpack
* Validated that the start Indexing topology step also installs the
Elasticsearch template files.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development
Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235)
for the complete guide to follow for contributions.
Please refer also to our [Build Verification
Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview)
for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow
these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to
be created at [Metron
Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [x] Has your PR been rebased against the latest commit within the target
branch (typically master)?
### For code changes:
- [x] Have you included steps to reproduce the behavior or problem that is
being changed or addressed?
- [x] Have you included steps or a guide to how the change may be verified
and tested manually?
- [ ] Have you ensured that the full suite of tests and checks have been
executed in the root metron folder via:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [ ] Have you written or updated unit tests and or integration tests to
verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] Have you verified the basic functionality of the build by building
and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in
which it is rendered by building and verifying the site-book? If not then run
the following commands and the verify changes via
`site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build
issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up
for your personal repository such that your branches are built there before
submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/anandsubbu/incubator-metron METRON-1283
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/817.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #817
----
commit f6f0b976cf39b7e56a98a591ded3595c60b4467a
Author: Anand Subramanian <[email protected]>
Date: 2017-10-26T14:41:59Z
Install ES templates before starting indexing topology
commit 1bf25a9ae33f142624c8cf7ae309458083e317c0
Author: Anand Subramanian <[email protected]>
Date: 2017-10-26T18:20:42Z
Remove ES template install from load_web_templates role
commit 93bf31ff0ad83cbd76e644e3f5c29777eeaa914c
Author: Anand Subramanian <[email protected]>
Date: 2017-10-27T06:59:42Z
Move the template installation from Start step into Install step
----
---
