Skip to content

Commit

Permalink
Merge pull request #6 from StackStorm-Exchange/lm-ydubler-patch-3
Browse files Browse the repository at this point in the history
Lm ydubler patch 3
  • Loading branch information
cognifloyd authored Apr 9, 2022
2 parents 741d118 + 0358df1 commit 1c8cd16
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ StackStorm to load these new values by running `st2ctl reload --register-configs
#### Custom Port

The LogicMonitor Pack launches a webhook-sensor (a Flask server) on port 5000 by default. You can
choose a custom port on which to launch the webhook-sensor by modifying the _
/opt/stackstorm/packs/logicmonitor/sensors/**logicmonitor_sensor.py**_ file. Once the port has been
changed, run the `st2 pack register logicmonitor` terminal command to reload the pack and relaunch
the sensor-webhook on your custom port. If that command fails, use `st2ctl reload`.
choose a custom port on which to launch the webhook-sensor by modifying the
/opt/stackstorm/packs/logicmonitor/sensors/<b>logicmonitor_sensor.py</b> file. Once the port has
been changed, run the `st2 pack register logicmonitor` terminal command to reload the pack and
relaunch the sensor-webhook on your custom port. If that command fails, use `st2ctl reload`.

#### Networking: Allowing LogicMonitor Traffic to Reach Your StackStorm Machine

Expand Down Expand Up @@ -124,16 +124,16 @@ into your `/opt/stackstorm/configs/logicmonitor.yaml` configuration file.

LogicMonitor API Tokens have a set
of **[Privileges](https://www.logicmonitor.com/support/settings/users-and-roles/roles)** in your
LogicMonitor Portal. For example, if you supply an API Token that is associated with the _
administrator_ Role in your LogicMonitor Portal to your LogicMonitor Pack, then your LogicMonitor
Pack can do everything in your Portal: reading, creating, updating, and deleting resources in
addition to security-sensitive actions. If a nefarious user gains access to your LogicMonitor Pack,
and your pack is using an _administrator_ API Token, the nefarious user would have the ability to
destroy your entire Portal! This undesired scenario (that resulted from the over-prescription of
Privilege) would be disastrous to experience and is why it is **STRONGLY RECCOMENDED** that you
apply
LogicMonitor Portal. For example, if you supply an API Token that is associated with the <i><b>
administrator</b></i> Role in your LogicMonitor Portal to your LogicMonitor Pack, then your
LogicMonitor Pack can do everything in your Portal: reading, creating, updating, and deleting
resources in addition to security-sensitive actions. If a nefarious user gains access to your
LogicMonitor Pack, and your pack is using an <i><b>administrator</b></i> API Token, the nefarious
user would have the ability to destroy your entire Portal! This undesired scenario (that resulted
from the over-prescription of Privilege) would be disastrous to experience and is why it is <b><u>
STRONGLY RECCOMENDED</u></b> that you apply
the **[Principle of Least Privilege](https://www.cisa.gov/uscert/bsi/articles/knowledge/principles/least-privilege#:~:text=The%20Principle%20of%20Least%20Privilege%20states%20that%20a%20subject%20should,control%20the%20assignment%20of%20rights.)**
when supplying your LogicMonitor Pack with a LogicMonitor API Token. You should provide the
when supplying your LogicMonitor Pack with a LogicMonitor API Token: You should provide the
LogicMonitor Pack with an API Token that has the **MINIMUM REQUIRED PRIVILEGE** for the LogicMonitor
Pack to do it's job. To accomplish this, you can create a
custom **[Role](https://www.logicmonitor.com/support/settings/users-and-roles/roles)**
Expand Down Expand Up @@ -289,13 +289,13 @@ More specifically, the LogicMonitor Pack has provided these Actions:

LogicMonitor returns an API Response when you use the LogicMonitor Python SDK to interact with your
Portal. The API Response returned from LogicMonitor has been serialized so that it can be accessed
by subsequent actions in an Orquesta Workflow. An example Orquesta workflow that restarts a downed collector
has been provided to illustrate this functionality:
by subsequent actions in an Orquesta Workflow. An example Orquesta workflow that restarts a downed
collector has been provided to illustrate this functionality:

#### Example Workflow: Orquesta (Restart Collector Down)

* logicmonitor/rules/<b>example_orquesta_restart_collector_down_rule.yaml</b>
* logicmonitor/actions/<b>example_orquesta_restart_collector_down.yaml</b>
* logicmonitor/rules/<b>example_orquesta_restart_collector_down.yaml_rule</b>
* logicmonitor/actions/workflows/<b>example_orquesta_restart_collector_down_workflow.yaml</b>

## Thank you for downloading the LogicMonitor Pack!

0 comments on commit 1c8cd16

Please sign in to comment.