You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by JonZeolla <gi...@git.apache.org> on 2017/11/07 02:10:40 UTC
[GitHub] metron pull request #833: METRON-1275: Fix Metron Documentation
GitHub user JonZeolla opened a pull request:
https://github.com/apache/metron/pull/833
METRON-1275: Fix Metron Documentation
## Contributor Comments
Documentation fixes, pretty straightforward. Most notably documents all of the `start_parser_topology.sh` params.
## 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 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/JonZeolla/metron METRON-1275
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/833.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 #833
----
commit 821ccac205a69d40ae3d6ba37ce6e4136d8ff2a8
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-10-23T20:13:41Z
METRON-1275: Fix Metron Documentation
commit 237341a1918e8c022e692b3d07bc2b3ef11aa8cb
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-10-23T20:33:14Z
Add all valid start_parser_topology.sh params
commit 729ff2ef21c77326da665956811d5f801307e1d1
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-11-01T14:17:31Z
Merge branch 'master' of https://github.com/apache/metron into METRON-1275
commit 2b4ca33c5aa5afcfd30ab0224b48318de51bae37
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-11-01T14:39:16Z
More changes
commit bf2b3dc6528896352d464dfde5b49e142a47d7e8
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-11-07T02:07:34Z
Merge branch 'master' of https://github.com/apache/metron into METRON-1275
commit 0957f47c4382526c6ab1b0aab933500a6e776fbe
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-11-07T02:08:14Z
Change to 0.4.2
----
---
[GitHub] metron issue #833: METRON-1275: Fix Metron Documentation
Posted by nickwallen <gi...@git.apache.org>.
Github user nickwallen commented on the issue:
https://github.com/apache/metron/pull/833
Yes @lvets your +1 is definitely relevant. I wish more community members would review PRs.
---
[GitHub] metron pull request #833: METRON-1275: Fix Metron Documentation
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/833
---
[GitHub] metron issue #833: METRON-1275: Fix Metron Documentation
Posted by lvets <gi...@git.apache.org>.
Github user lvets commented on the issue:
https://github.com/apache/metron/pull/833
I don't know whether my +1 is actually relevant, but here it goes: +1. Looks good to me :)
---
[GitHub] metron issue #833: METRON-1275: Fix Metron Documentation
Posted by nickwallen <gi...@git.apache.org>.
Github user nickwallen commented on the issue:
https://github.com/apache/metron/pull/833
@JonZeolla I am assuming you just added additional options that are now available. That being the case, +1 from me.
---
[GitHub] metron issue #833: METRON-1275: Fix Metron Documentation
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/833
Piling on with a +1, great job @JonZeolla
---
[GitHub] metron pull request #833: METRON-1275: Fix Metron Documentation
Posted by nickwallen <gi...@git.apache.org>.
Github user nickwallen commented on a diff in the pull request:
https://github.com/apache/metron/pull/833#discussion_r149420478
--- Diff: metron-platform/Performance-tuning-guide.md ---
@@ -219,38 +219,49 @@ And we ran our bro parser topology with the following options. We did not need t
though you could certainly do so if necessary. Notice that we only needed 1 worker.
```
-/usr/metron/0.4.0/bin/start_parser_topology.sh -k $BROKERLIST -z $ZOOKEEPER -s bro -ksp SASL_PLAINTEXT
- -ot enrichments
+/usr/metron/0.4.2/bin/start_parser_topology.sh \
-e ~metron/.storm/storm-bro.config \
-esc ~/.storm/spout-bro.config \
- -sp 24 \
- -snt 24 \
+ -k $BROKERLIST \
+ -ksp SASL_PLAINTEXT \
--- End diff --
Oops, sorry that's already how the docs were. I wasn't following what you were doing here. All you're doing is a reformat. LGTM.
---
[GitHub] metron pull request #833: METRON-1275: Fix Metron Documentation
Posted by nickwallen <gi...@git.apache.org>.
Github user nickwallen commented on a diff in the pull request:
https://github.com/apache/metron/pull/833#discussion_r149420193
--- Diff: metron-platform/Performance-tuning-guide.md ---
@@ -219,38 +219,49 @@ And we ran our bro parser topology with the following options. We did not need t
though you could certainly do so if necessary. Notice that we only needed 1 worker.
```
-/usr/metron/0.4.0/bin/start_parser_topology.sh -k $BROKERLIST -z $ZOOKEEPER -s bro -ksp SASL_PLAINTEXT
- -ot enrichments
+/usr/metron/0.4.2/bin/start_parser_topology.sh \
-e ~metron/.storm/storm-bro.config \
-esc ~/.storm/spout-bro.config \
- -sp 24 \
- -snt 24 \
+ -k $BROKERLIST \
+ -ksp SASL_PLAINTEXT \
--- End diff --
This will only work in a Kerberized environment, no? Should that be called out?
---