Add Slurpit Chatops Commands

README.md

@@ -26,6 +26,7 @@
     - IPFabric
     - Cisco Meraki
     - Palo Alto Panorama
+    - Slurpit
 - Write a command once and run it on every supported platform, including rich content formatting.
 - Extensible - other Nautobot apps can provide additional commands which will be dynamically discovered.
 - Automatic generation of basic help menus (accessed via `help`, `/command help`, or `/command sub-command help`).

changes/347.added

@@ -0,0 +1 @@
+Added support for Slurpit.io chat commands.

development/development.env

@@ -101,3 +101,8 @@ NAUTOBOT_CHATOPS_ENABLE_NSO="False"
 # NSO_URL="https://nso.example.com"
 # NSO_USERNAME="admin"
 # NSO_PASSWORD="admin"
+
+# - Slurpit ------------------------
+NAUTOBOT_CHATOPS_ENABLE_SLURPIT="False"
+SLURPIT_HOST="https://sandbox.slurpit.io"
+SLURPIT_VERIFY="True"

development/nautobot_config.py

@@ -201,6 +201,11 @@
         "nso_username": os.environ.get("NSO_USERNAME"),
         "nso_password": os.environ.get("NSO_PASSWORD"),
         "nso_request_timeout": os.environ.get("NSO_REQUEST_TIMEOUT", 60),
+        # - Slurpit --------------------------
+        "enable_slurpit": is_truthy(os.getenv("NAUTOBOT_CHATOPS_ENABLE_SLURPIT")),
+        "slurpit_host": os.environ.get("SLURPIT_HOST"),
+        "slurpit_token": os.environ.get("SLURPIT_API_TOKEN"),
+        "slurpit_verify": is_truthy(os.environ.get("SLURPIT_VERIFY", True)),
     },
 }
 if os.getenv("NAUTOBOT_CHATOPS_ENABLE_MATTERMOST", "") != "":
@@ -229,5 +234,7 @@
     PLUGINS_CONFIG["nautobot_chatops"]["enable_panorama"] = is_truthy(os.getenv("NAUTOBOT_CHATOPS_ENABLE_PANORAMA"))
 if os.getenv("NAUTOBOT_CHATOPS_ENABLE_NSO", "") != "":
     PLUGINS_CONFIG["nautobot_chatops"]["enable_nso"] = is_truthy(os.getenv("NAUTOBOT_CHATOPS_ENABLE_NSO"))
+if os.getenv("NAUTOBOT_CHATOPS_ENABLE_SLURPIT", "") != "":
+    PLUGINS_CONFIG["nautobot_chatops"]["enable_slurpit"] = is_truthy(os.getenv("NAUTOBOT_CHATOPS_ENABLE_SLURPIT"))
 
 METRICS_ENABLED = is_truthy(os.getenv("NAUTOBOT_METRICS_ENABLED"))

docs/admin/install.md

@@ -161,3 +161,4 @@ Set up integrations using the specific guides:
 - [Cisco Meraki](./integrations/meraki.md)
 - [Cisco NSO](./integrations/nso.md)
 - [Palo Alto Panorama](./integrations/panorama.md)
+- [Slurpit](./integrations/slurpit.md)

docs/admin/integrations/slurpit.md

@@ -0,0 +1,52 @@
+# Slurpit Integration Setup
+
+This guide will walk you through steps to set up Slurpit integration with the `nautobot_chatops` App.
+
+## Prerequisites
+
+Before configuring the integration, please ensure the following:
+
+- `nautobot-chatops` App was [installed with integration extra dependencies](../install.md#installation-guide).
+    ```shell
+    pip install nautobot-chatops[slurpit]
+    ```
+- `nautobot-chatops` App is set up with at least one [enabled chat platform](../install.md#chat-platforms-configuration) and [tested](./../install.md#test-your-chatbot).
+
+## Command Setup
+
+Create a top-level command named `slurpit` in your enabled chat platform. For detailed instructions related to your specific chat platform, refer to the [platform specific set up](../install.md#chat-platforms-configuration).
+
+## Configuration
+
+You must define the following values in your `nautobot_config.py` file:
+
+| Configuration Setting | Mandatory? | Default | Available on Admin Config |
+| --------------------- | ---------- | ------- | ------------------------- |
+| `enable_slurpit`      | **Yes**    | False   | Yes                       |
+| `slurpit_host`        | **Yes**    |         | No                        |
+| `slurpit_token`       | **Yes**    |         | No                        |
+| `slurpit_verify`      | **Yes**    |         | No                        |
+
+Below is an example snippet from `development/nautobot_config.py` that demonstrates how to enable and configure Cisco ACI integration:
+
+```python
+PLUGINS = ["nautobot_chatops"]
+
+PLUGINS_CONFIG = {
+    "nautobot_chatops": {
+        ...
+        "enable_slurpit": True,
+        "slurpit_host": os.environ.get("SLURPIT_HOST"),
+        "slurpit_token": os.environ.get("SLURPIT_API_TOKEN"),
+        "slurpit_verify": is_truthy(os.environ.get("SLURPIT_VERIFY", True)),
+    }
+}
+```
+
+The example configuration is using environment variables. Define these using the following environment variables:
+
+```shell
+export SLURPIT_HOST="{{ slurpit Host }}"
+export SLURPIT_API_TOKEN="{{ Slurpit API Token }}"
+export SLURPIT_VERIFY="{{ True }}"
+```

docs/user/app_getting_started.md

@@ -60,3 +60,4 @@ The `nautobot-chatops` package includes multiple integrations. Each integration
 - [Cisco Meraki](./integrations/meraki.md)
 - [Cisco NSO](./integrations/nso.md)
 - [Palo Alto Panorama](./integrations/panorama.md)
+- [Slurpit](./integrations/slurpit.md)

docs/user/integrations/slurpit.md

@@ -0,0 +1,35 @@
+# Slurpit Chat Commands
+
+## `/slurpit` Command
+
+Interact with [Slurpit](https://slurpit.io) by utilizing the following sub-commands:
+
+| Command           | Arguments                            | Description                             |
+| ----------------- | ------------------------------------ | --------------------------------------- |
+| `get-devices`     |                                      | Slurpit inventory device list.          |
+| `get-device`      | `[hostname]`                         | Slurpit device information.             |
+| `get-sites`       |                                      | Slurpit site list.                      |
+| `get-plannings`   |                                      | Configured plannings.                   |
+| `search-data`     | `[planning]` `[latest]` `[search]`   | Search planning data.                   |
+| `device-data`     | `[planning]` `[latest]` `[hostname]` | Get planning data for a given hostname. |
+
+
+!!! note
+    All sub-commands are intended to be used with the `/slurpit` prefix.
+
+## Screenshots
+
+![Commands list](../../images/slurpit-help.png)
+
+![Get Devices](../../images/slurpit-get-devices.png)
+
+![Get Device](../../images/slurpit-get-device.png)
+
+![Get Sites](../../images/slurpit-get-sites.png)
+
+![Get Plannings](../../images/slurpit-get-plannings.png)
+
+![Search Data](../../images/slurpit-search-data.png)
+
+![Device Data](../../images/slurpit-device-data.png)
+

mkdocs.yml

@@ -117,6 +117,7 @@ nav:
           - "user/integrations/meraki.md"
           - "user/integrations/panorama.md"
           - "user/integrations/nso.md"
+          - "user/integrations/slurpit.md"
   - Administrator Guide:
       - Install and Configure: "admin/install.md"
       - Platforms:
@@ -133,6 +134,7 @@ nav:
           - "admin/integrations/meraki.md"
           - "admin/integrations/panorama.md"
           - "admin/integrations/nso.md"
+          - "admin/integrations/slurpit.md"
       - Upgrade: "admin/upgrade.md"
       - Uninstall: "admin/uninstall.md"
       - Compatibility Matrix: "admin/compatibility_matrix.md"

nautobot_chatops/__init__.py

@@ -122,6 +122,10 @@ class NautobotChatOpsConfig(NautobotAppConfig):
         "nso_username": "",
         "nso_password": "",
         "nso_request_timeout": "",
+        # - Slurpit --------------------------
+        "slurpit_host": "",
+        "slurpit_token": "",
+        "slurpit_verify": True,
     }
     constance_config = {
         "fallback_chatops_user": ConstanceConfigItem(default="chatbot", help_text="Enable Mattermost Chat Platform."),
@@ -149,6 +153,7 @@ class NautobotChatOpsConfig(NautobotAppConfig):
             default=False, help_text="Enable Panorama Integration.", field_type=bool
         ),
         "enable_nso": ConstanceConfigItem(default=False, help_text="Enable NSO Integration.", field_type=bool),
+        "enable_slurpit": ConstanceConfigItem(default=False, help_text="Enable Slurpit Integration.", field_type=bool),
     }
 
     caching_config = {}

nautobot_chatops/integrations/slurpit/__init__.py

@@ -0,0 +1 @@
+"""Base module for Slurpit Integration."""