METRON-1701: Update steps to run the pycapa on kerberized cluster. #1136
Conversation
nickwallen
left a comment
nickwallen
left a comment
There was a problem hiding this comment.
Thanks for the updates @MohanDV !
metron-sensors/pycapa/README.md
Outdated
| * The keytab used is located at `/etc/security/keytabs/metron.headless.keytab` | ||
| * The service principal is `metron@EXAMPLE.COM` | ||
|
|
||
| If it is not, ensure that you have `libsasl` or `libsasl2` installed. On CentOS, this can be installed with the following command. |
There was a problem hiding this comment.
Can we start numbering the list from here? Just add 1. before this line.
metron-sensors/pycapa/README.md
Outdated
| yum install -y cyrus-sasl cyrus-sasl-devel cyrus-sasl-gssapi | ||
| ``` | ||
|
|
||
| 1. Use the non-binary wheel to install confluent-kafka-python. |
There was a problem hiding this comment.
You say "you will need to use the non-binary wheel", but in this step there are no instructions on how to do that.
Should everything here just be added as additional commentary to what is currently step 4 ("The source install of confluent-kafka?") I believe that is the step that actually has the instructions on how to do that.
There was a problem hiding this comment.
Moved these instruction to the top as description .
| If you need SASL Kerberos support you must install librdkafka and | ||
| its dependencies using the above repositories and then build | ||
| confluent-kafka from source. | ||
| ``` |
There was a problem hiding this comment.
Its probably sufficient to just say "The pre-built Linux wheels do NOT contain SASL Kerberos support." and include a link to the README. No need to copy verbatim the whole paragraph. IMHO.
metron-sensors/pycapa/README.md
Outdated
| 1. The source install of confluent-kafka: | ||
|
|
||
| ``` | ||
| // If you have already installed, remove the binary wheel python client first, repeat until it says no longer installed |
There was a problem hiding this comment.
Can you extract the comment from the code block? Seems like it just just be part of the text.
| wget https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz -O - | tar -xz | ||
| cd librdkafka-0.9.4/ | ||
| wget https://github.com/edenhill/librdkafka/archive/v0.11.5.tar.gz -O - | tar -xz | ||
| cd librdkafka-0.11.5/ |
There was a problem hiding this comment.
Did you test both the kerberos and non-kerberos deployment of Pycapa with Librdkafka 0.11.5 ? The README is now advising this version, so I just want to make sure it works in all cases.
There was a problem hiding this comment.
Yes it works for unsecured deployment as well.
|
+1 This looks great. Thanks for making these updates. Very useful! |
2 participants
Contributor Comments
Updated the steps to run Pycapa with Kerberos
Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines 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:
For code changes:
Have you included steps to reproduce the behavior or problem that is being changed or addressed?
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:
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?
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: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 is set up for your personal repository such that your branches are built there before submitting a pull request.