METRON-1434 - Ability to deploy Metron full dev as a single node (centos6) to AWS with Vagrant and AMI #916
Conversation
|
I have taken down the AMI (ami-93cb4ff7) from the AWS Community marketplace. The AMI id was listed in the README.md. The AMI was originally created to be a test/proof-of-concept for launching Metron in AWS. |
| @@ -112,6 +115,130 @@ To build the DEB packages, follow the instructions at [packaging/docker/deb-dock | |||
|
|
|||
| How do I deploy Metron within AWS? | |||
| ---------------------------------- | |||
| You can deploy Metron into Amazon Web Service(AWS) in three ways: | |||
| i) [As a single node using Vagrant](#aws-single-node-cluster-deployment-using-vagrant) | |||
There was a problem hiding this comment.
Small nit - this type of roman numeral ordered list won't show up in markdown properly. Throw an extra line before the first item (so it line breaks) and replace "i)" with "1. ", and so on. You can usually experiment be hitting the "view" button on your file in github. See https://github.com/apache/metron/blob/master/metron-deployment/Kerberos-manual-setup.md for another example.
|
Thanks for the contribution! I'm just starting to look at this so expect some comments rolling in as I have time. |
|
Thanks. If needed here is the deployment script that worked with Metron 0.4.1. |
|
@as22323 Let me first say that this is a nice piece of work. You've followed all the existing patterns and your contribution looks solid. But ultimately I am +0 on this. I want others to speak up should they see value in this, but I'd argue that this should not be merged. Please let me explain my reasoning. Support Burden IMHO, the 'surface area' to support in Metron has always been too large. We as a community spend too much time supporting non-core functionality, which impedes our progress in delivering features targeted toward the cybersecurity use case. One key example of this are the multiple different deployment targets that we support. This has been a difficult and time consuming support task over the history of the project. I've done plenty of work on this myself. Coalescing Metron installation around the MPack was a major step forward for us. This was intended to help remove some of that support burden. With the MPack, much of that burden is shifted to Ambari. For example, with everything in Metron today, you can stand-up a single node in AWS and use the Mpack to install Metron. It is not as "push button" simple as your contribution here, but it is "good enough" considering the resources we have in the community today. Uncommon Use Case We should also consider that running Metron on a single node is a recipe for a horrible user experience. It should only be run on a single node for development purposes, which is something that we already do support. I would not recommend that anyone run Metron on a single node for any other purpose. -- I'd prefer not too add to our ongoing support burden by merging this PR. What you've done is a great contribution and I'd love to see you publicly share and support this as a separate project, outside of Apache Metron, going forward. If others agree or disagree with my reasoning, please do feel free to share. |
|
Why not add it to /contrib ? Or can we have a way to like to it from docs or site? |
|
I'd be perfectly happy to reference in Metron docs, external resources/projects like this that community members might find useful. Good idea @ottobackwards |
|
Thanks for the great feedback! I found a place in the Metron docs to refer to the AWS/Vagrantfile. |
|
@nickwallen, @ottobackwards , my 0.02$ :)
Unfortunately, "push button" style setup is what most people want nowadays want to quickly set up a test environment and start playing around. I do understand that supporting different installation methods (including mine :p) adds a burden, but I think it is a burden we have to bear until Metron grows bigger.
That's why AWS has a bunch of different VM types :) Maybe we should add a big fat warning somewhere saying "Your experience will be very bad if you not use at least an m5.4xlarge instance if you're going the single node way." I think having quick & easy ways to setup Metron on a single node to play around is necessary until the Metron community grows... Anyway, back to lurking mode for now. |
|
@lvets Putting the vagrant file into a /contrib area with a notice that sets expectation correctly is the way to go then |
|
Hello, Just wondering what the the /contrib is folder for? If the files in /contrib is not part of the core maintenance(continuous update for n+1) then perhaps we can make a reference to the Vagrant/AWS deployment method in this doc [metron-deployment/other-examples/README.md](PR 980) then store the code and the "notice that sets expectation" in the /contrib folder. Right now PR 980 points to the Vagrantfile at our github site (as apposed to putting it into /contrib folder within the Apache Metron project). The proposed update could look like this (see file path structure): The README.md here will list the Vagrant/AWS method. The readme.md in this path can refer to the "notice" and Vagrantfile in the /contrib folder: FYI I'm working on using Vagrant to deploy to 0.4.1 to ESXi. That could be posted at some point using the file structure above. |
ottobackwards
changed the title
|
Getting back to this, I'm OK with adding the new readme's and the links to the /contrib area, |
|
We may want to refactor this to be centos7 now that we have support for this |
Contributor Comments
[Please place any comments here. A description of the problem/enhancement, how to reproduce the issue, your testing methodology, etc.]
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.