GitHub user mmiklavc opened a pull request:
https://github.com/apache/metron/pull/1196
METRON-1777: Fix Elasticsearch X-Pack sample pom in documentation
## Contributor Comments
https://issues.apache.org/jira/browse/METRON-1777
This addresses issues in the example pom for constructing the X-Pack client
that we provide in the kerberos/security README. There is a bug in the shade
plugin version that we had been using that appears to be fixed in the latest
version, 3.2.0, whereby attempting to shade a jar with log4j-api would cause
the build to fail with a nondescript error message as follows:
```
[ERROR] Failed to execute goal
org.apache.maven.plugins:maven-shade-plugin:2.4.3:shade (default) on project
elasticsearch-xpack-shaded: Error creating shaded jar: null:
IllegalArgumentException -> [Help 1]
```
Excluding the log4j-api caused some issues when managing the classpath
between the REST application and indexing topology. Upgrading the plugin
version now allows the log4j-api packages to be appropriately shaded and
relocated. Note, much of this classpath drama should hopefully be ameliorated
by transitioning from the Java low level client to the newer REST api provided
by Elasticsearch.
Validated in full dev with X-Pack enabled.
**Testing**
You can manually validate this doc change by following the README and
setting up X-Pack for Elasticsearch. You should continue to see data published
to Elasticsearch by the indexing topology as normal. Also, the Alerts UI should
be able to display alerts as normal.
## 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?
- [x] 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 &&
dev-utilities/build-utils/verify_licenses.sh
```
- n/a Have you written or updated unit tests and or integration tests to
verify your changes?
- n/a 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)?
- [x] 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:
- [x] 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/mmiklavc/metron xpack-install
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1196.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 #1196
----
commit 5b0d15c6ba07243efc6b1e2e6d0b1c9ff85a3706
Author: Michael Miklavcic <michael.miklavcic@...>
Date: 2018-09-12T20:06:24Z
Update xpack install instructions
commit be646e8d681c1d9cab2fcb02cbf00d55c6c57ead
Author: Michael Miklavcic <michael.miklavcic@...>
Date: 2018-09-12T23:30:22Z
Update sample pom for xpack client
commit a725bc758ff7bcd0209bb67b53afd3f9f8739fa2
Author: Michael Miklavcic <michael.miklavcic@...>
Date: 2018-09-12T23:51:10Z
Fix anchor link for Doxia
----
---
