GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/613
METRON-990: Clean up and organize flux properties
## Contributor Comments
This PR is mainly a refactor of the enrichment and indexing flux files
along with their matching property files. The changes include:
- moving important settings with hardcoded values in flux files to property
files so that they are configurable through Ambari
- removing old and unused properties
- elasticsearch.properties file is now implemented as a jinja2 template in
the mpack, matching the enrichment.properties implementation
- global.json is now implemented as a jinja2 template in the mpack
- properties are now organized in Ambari as separate tabs and sub sections,
hopefully making them easier to find
- changed a couple properties to use a dropdown widget in Ambari
I wrote descriptions for new properties in a similar style as existing
properties. I feel the descriptions are a little short, curious if others
agree. I also stopped short of improving ALL our properties with better
widgets than just a text box. I imagine people will have opinions on how to
best present properties in Ambari but this is a start.
This has been tested on full dev with the usual process. When reviewing,
spin up full dev and navigate to the Metron service in Ambari. The Config
section should look as described in the section above. The
enrichment.properties and elasticsearch.properties should look much shorter and
easier to read.
One more thing. I added a rat exception for *.json.j2 since we already
have an exception for *.json (no comments in json is the reason?). Let me know
if that's wrong.
## 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 incubating-metron folder via:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [x] Have you written or updated unit tests and or integration tests to
verify your changes?
- [x] 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/merrimanr/incubator-metron METRON-990
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/613.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 #613
----
commit 9cfa0181a95d0b2b21bd665530119e7b261962dc
Author: merrimanr <[email protected]>
Date: 2017-06-07T21:56:04Z
initial commit
commit a31cfc47e0f47016b7a8aa1a1675a2e791f72dea
Author: merrimanr <[email protected]>
Date: 2017-06-07T22:15:31Z
added *.json.j2 rat exception
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
