airbnb / streamalert

StreamAlert is a serverless, realtime data analysis framework which empowers you to ingest, analyze, and alert on data from any environment, using datasources and alerting logic you define.
https://streamalert.io
Apache License 2.0
2.86k stars 334 forks source link

Add missing subcommand when setting example SNS output in the "Getting Started" section #1254

Closed jordan-wright closed 4 years ago

jordan-wright commented 4 years ago

cc: @airbnb/streamalert-maintainers

Background

Reason for the change

The current Getting Started instructions don't mention that you need to add the set command. As it stands, this is the error I received when setting up Streamalert:

(.env) jordan@mac:~/src/aws/streamalert/streamalert$ python manage.py output aws-sns
usage: manage.py output [-h]
                        {set,set-from-file,generate-skeleton,get,list} ...
manage.py output: error: invalid choice: 'aws-sns' (choose from 'set', 'set-from-file', 'generate-skeleton', 'get', 'list')

Changes

Testing

Received an error when running the command as prescribed in the documentation. Things seem to work when I added the subcommand.