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/10/16 19:09:36 UTC
[GitHub] metron pull request #800: METRON-1251: Typo and formatting fixes for metron-...
GitHub user JonZeolla opened a pull request:
https://github.com/apache/metron/pull/800
METRON-1251: Typo and formatting fixes for metron-rest README
## Contributor Comments
This fix properly format the github md in addition to the site-book docs (previously the github formatting was broken).
## 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-1251
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/800.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 #800
----
commit 6dc567456ef740420fb79c1f707649b3c295b01e
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-10-16T19:04:28Z
METRON-1251 - Typo and formatting fixes for metron-rest README
----
---
[GitHub] metron issue #800: METRON-1251: Typo and formatting fixes for metron-rest RE...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/800
+1 by inspection. Good job here!
---
[GitHub] metron pull request #800: METRON-1251: Typo and formatting fixes for metron-...
Posted by JonZeolla <gi...@git.apache.org>.
GitHub user JonZeolla reopened a pull request:
https://github.com/apache/metron/pull/800
METRON-1251: Typo and formatting fixes for metron-rest README
## Contributor Comments
This fix properly format the github md in addition to the site-book docs (previously the github formatting was broken). It also fixes a typo regarding `/etc/sysconfig/metron`.
## 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-1251
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/800.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 #800
----
commit 6dc567456ef740420fb79c1f707649b3c295b01e
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-10-16T19:04:28Z
METRON-1251 - Typo and formatting fixes for metron-rest README
commit 46259e03a8d090389253d9024f3f6d14df77111e
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-10-16T19:10:35Z
Fix minor typo
----
---
[GitHub] metron pull request #800: METRON-1251: Typo and formatting fixes for metron-...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/800
---
[GitHub] metron issue #800: METRON-1251: Typo and formatting fixes for metron-rest RE...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/800
can you kick travis, @JonZeolla ? I think it ran at a weird time and the test failure is due to that. We should look into what caused that.
---
[GitHub] metron pull request #800: METRON-1251: Typo and formatting fixes for metron-...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla closed the pull request at:
https://github.com/apache/metron/pull/800
---
[GitHub] metron pull request #800: METRON-1251: Typo and formatting fixes for metron-...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on a diff in the pull request:
https://github.com/apache/metron/pull/800#discussion_r145415334
--- Diff: metron-interface/metron-rest/README.md ---
@@ -112,42 +112,42 @@ The following configures the application for MySQL:
1. Install MySQL if not already available (this example uses version 5.7, installation instructions can be found [here](https://dev.mysql.com/doc/refman/5.7/en/linux-installation-yum-repo.html))
1. Create a metron user and REST database and permission the user for that database:
- ```
-CREATE USER 'metron'@'node1' IDENTIFIED BY 'Myp@ssw0rd';
-CREATE DATABASE IF NOT EXISTS metronrest;
-GRANT ALL PRIVILEGES ON metronrest.* TO 'metron'@'node1';
- ```
+ ```
+ CREATE USER 'metron'@'node1' IDENTIFIED BY 'Myp@ssw0rd';
+ CREATE DATABASE IF NOT EXISTS metronrest;
+ GRANT ALL PRIVILEGES ON metronrest.* TO 'metron'@'node1';
+ ```
1. Install the MySQL JDBC client onto the REST application host and configurate the METRON_JDBC_CLIENT_PATH variable:
- ```
-cd $METRON_HOME/lib
-wget https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.41.tar.gz
-tar xf mysql-connector-java-5.1.41.tar.gz
- ```
+ ```
+ cd $METRON_HOME/lib
+ wget https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.41.tar.gz
+ tar xf mysql-connector-java-5.1.41.tar.gz
+ ```
1. Edit these variables in `/etc/sysconfig/metron` to configure the REST application for MySQL:
- ```
-METRON_JDBC_DRIVER="com.mysql.jdbc.Driver"
-METRON_JDBC_URL="jdbc:mysql://mysql_host:3306/metronrest"
-METRON_JDBC_USERNAME="metron"
-METRON_JDBC_PLATFORM="mysql"
-METRON_JDBC_CLIENT_PATH=$METRON_HOME/lib/mysql-connector-java-5.1.41/mysql-connector-java-5.1.41-bin.jar
- ```
+ ```
+ METRON_JDBC_DRIVER="com.mysql.jdbc.Driver"
+ METRON_JDBC_URL="jdbc:mysql://mysql_host:3306/metronrest"
+ METRON_JDBC_USERNAME="metron"
+ METRON_JDBC_PLATFORM="mysql"
+ METRON_JDBC_CLIENT_PATH=$METRON_HOME/lib/mysql-connector-java-5.1.41/mysql-connector-java-5.1.41-bin.jar
+ ```
1. Switch to the metron user
- ```
-sudo su - metron
- ```
+ ```
+ sudo su - metron
+ ```
1. Start the REST API. Adjust the password as necessary.
- ```
-set -o allexport;
-source /etc/metron/sysconfig;
-set +o allexport;
-export METRON_JDBC_PASSWORD='Myp@ssw0rd';
-$METRON_HOME/bin/metron-rest.sh
-unset METRON_JDBC_PASSWORD;
- ```
+ ```
+ set -o allexport;
+ source /etc/sysconfig/metron;
--- End diff --
Ahh, that would make more sense, I was just manually creating /etc/sysconfig/metron. Will update the docs.
---
[GitHub] metron pull request #800: METRON-1251: Typo and formatting fixes for metron-...
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on a diff in the pull request:
https://github.com/apache/metron/pull/800#discussion_r145197280
--- Diff: metron-interface/metron-rest/README.md ---
@@ -112,42 +112,42 @@ The following configures the application for MySQL:
1. Install MySQL if not already available (this example uses version 5.7, installation instructions can be found [here](https://dev.mysql.com/doc/refman/5.7/en/linux-installation-yum-repo.html))
1. Create a metron user and REST database and permission the user for that database:
- ```
-CREATE USER 'metron'@'node1' IDENTIFIED BY 'Myp@ssw0rd';
-CREATE DATABASE IF NOT EXISTS metronrest;
-GRANT ALL PRIVILEGES ON metronrest.* TO 'metron'@'node1';
- ```
+ ```
+ CREATE USER 'metron'@'node1' IDENTIFIED BY 'Myp@ssw0rd';
+ CREATE DATABASE IF NOT EXISTS metronrest;
+ GRANT ALL PRIVILEGES ON metronrest.* TO 'metron'@'node1';
+ ```
1. Install the MySQL JDBC client onto the REST application host and configurate the METRON_JDBC_CLIENT_PATH variable:
- ```
-cd $METRON_HOME/lib
-wget https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.41.tar.gz
-tar xf mysql-connector-java-5.1.41.tar.gz
- ```
+ ```
+ cd $METRON_HOME/lib
+ wget https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.41.tar.gz
+ tar xf mysql-connector-java-5.1.41.tar.gz
+ ```
1. Edit these variables in `/etc/sysconfig/metron` to configure the REST application for MySQL:
- ```
-METRON_JDBC_DRIVER="com.mysql.jdbc.Driver"
-METRON_JDBC_URL="jdbc:mysql://mysql_host:3306/metronrest"
-METRON_JDBC_USERNAME="metron"
-METRON_JDBC_PLATFORM="mysql"
-METRON_JDBC_CLIENT_PATH=$METRON_HOME/lib/mysql-connector-java-5.1.41/mysql-connector-java-5.1.41-bin.jar
- ```
+ ```
+ METRON_JDBC_DRIVER="com.mysql.jdbc.Driver"
+ METRON_JDBC_URL="jdbc:mysql://mysql_host:3306/metronrest"
+ METRON_JDBC_USERNAME="metron"
+ METRON_JDBC_PLATFORM="mysql"
+ METRON_JDBC_CLIENT_PATH=$METRON_HOME/lib/mysql-connector-java-5.1.41/mysql-connector-java-5.1.41-bin.jar
+ ```
1. Switch to the metron user
- ```
-sudo su - metron
- ```
+ ```
+ sudo su - metron
+ ```
1. Start the REST API. Adjust the password as necessary.
- ```
-set -o allexport;
-source /etc/metron/sysconfig;
-set +o allexport;
-export METRON_JDBC_PASSWORD='Myp@ssw0rd';
-$METRON_HOME/bin/metron-rest.sh
-unset METRON_JDBC_PASSWORD;
- ```
+ ```
+ set -o allexport;
+ source /etc/sysconfig/metron;
--- End diff --
Didn't all this move to /etc/default/metron for ubuntu compat?
---