Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryandeivert committed Apr 3, 2020
1 parent 8742306 commit cc6ceb9
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/source/apps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ The recommended process is to deploy both the `apps` function and the `classifie

.. code-block:: bash
python manage.py deploy --function classifier apps
python manage.py deploy --functions classifier apps
Authorizing the Slack App
Expand Down
24 changes: 12 additions & 12 deletions docs/source/deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,20 @@ To deploy new changes for all AWS Lambda functions:

.. code-block:: bash
python manage.py deploy --function all
python manage.py deploy
Optionally, to deploy changes for only a specific AWS Lambda function:

.. code-block:: bash
python manage.py deploy --function alert
python manage.py deploy --function alert_merger
python manage.py deploy --function apps
python manage.py deploy --function athena
python manage.py deploy --function classifier
python manage.py deploy --function rule
python manage.py deploy --function rule_promo
python manage.py deploy --function threat_intel_downloader
python manage.py deploy --functions alert
python manage.py deploy --functions alert_merger
python manage.py deploy --functions apps
python manage.py deploy --functions athena
python manage.py deploy --functions classifier
python manage.py deploy --functions rule
python manage.py deploy --functions rule_promo
python manage.py deploy --functions threat_intel_downloader
To apply infrastructure level changes (additional Kinesis Shards, new CloudTrails, etc), run:

Expand Down Expand Up @@ -95,8 +95,8 @@ to point to the previous version:

.. code-block:: bash
python manage.py rollback --function rule
python manage.py rollback --function alert
python manage.py rollback --function all
python manage.py rollback --functions rule
python manage.py rollback --functions alert
python manage.py rollback
This is helpful to quickly revert changes to Lambda functions, e.g. if a bad rule was deployed.
2 changes: 1 addition & 1 deletion docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ alerts on any usage of the root AWS account. Change the rule decorator to:
python manage.py build
# Deploy a new version of all of the Lambda functions with the updated rule and config files
python manage.py deploy --function all
python manage.py deploy
.. note:: Use ``build`` and ``deploy`` to apply any changes to StreamAlert's
configuration or Lambda functions, respectively. Some changes (like this example) require both.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/historical-search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Alerts Search

.. code-block:: bash
python manage.py deploy --function athena
python manage.py deploy --functions athena
* Search alerts in `Athena Console <https://console.aws.amazon.com/athena>`_

Expand All @@ -99,7 +99,7 @@ It is optional to store data in S3 bucket and available for search in Athena tab

.. code-block:: bash
python manage.py deploy --function classifier
python manage.py deploy --functions classifier
* Search data `Athena Console <https://console.aws.amazon.com/athena>`_

Expand Down
2 changes: 1 addition & 1 deletion docs/source/rule-promotion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ function code.

.. code-block:: bash
python manage.py deploy --function rule_promo
python manage.py deploy --functions rule_promo
.. note::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/rule-staging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ staged during a deploy. To allow for this, the Rules Engine can be deployed with

.. code-block:: bash
python manage.py deploy --function rule --skip-rule-staging
python manage.py deploy --functions rule --skip-rule-staging
This will force all new rules to send to user-defined outputs immediately upon deploy, bypassing
the default staging period. Alternatively, the ``--stage-rules`` and ``--unstage-rules`` flags
Expand Down

0 comments on commit cc6ceb9

Please sign in to comment.