From 5ef1c138c3218db8e4a963cdf11cff26e854ccc1 Mon Sep 17 00:00:00 2001 From: Ryan Deivert Date: Thu, 2 Apr 2020 13:42:47 -0700 Subject: [PATCH] updating docs --- docs/source/apps.rst | 2 +- docs/source/deployment.rst | 24 ++++++++++++------------ docs/source/getting-started.rst | 2 +- docs/source/historical-search.rst | 4 ++-- docs/source/rule-promotion.rst | 2 +- docs/source/rule-staging.rst | 2 +- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/source/apps.rst b/docs/source/apps.rst index d102af7bd..384a1333f 100644 --- a/docs/source/apps.rst +++ b/docs/source/apps.rst @@ -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 diff --git a/docs/source/deployment.rst b/docs/source/deployment.rst index 43fb01e6e..1d6195f41 100644 --- a/docs/source/deployment.rst +++ b/docs/source/deployment.rst @@ -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: @@ -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. diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index bcdd47f91..1ed8a4ca3 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -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. diff --git a/docs/source/historical-search.rst b/docs/source/historical-search.rst index 38c7c2c4f..12905ca13 100644 --- a/docs/source/historical-search.rst +++ b/docs/source/historical-search.rst @@ -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 `_ @@ -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 `_ diff --git a/docs/source/rule-promotion.rst b/docs/source/rule-promotion.rst index 7d4ce403f..d25c3c213 100644 --- a/docs/source/rule-promotion.rst +++ b/docs/source/rule-promotion.rst @@ -76,7 +76,7 @@ function code. .. code-block:: bash - python manage.py deploy --function rule_promo + python manage.py deploy --functions rule_promo .. note:: diff --git a/docs/source/rule-staging.rst b/docs/source/rule-staging.rst index 6ceba6dd5..e158d08f0 100644 --- a/docs/source/rule-staging.rst +++ b/docs/source/rule-staging.rst @@ -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