Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/develop' into drift-manager/pr
Browse files Browse the repository at this point in the history
  • Loading branch information
snaselj committed Feb 15, 2024
2 parents c5bc13b + 54e6c93 commit 544b928
Show file tree
Hide file tree
Showing 25 changed files with 117 additions and 116 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Default owner(s) of all files in this repository
* @glennmatthews @jvanderaa @smk4664 @whitej6 @romanukes
* @glennmatthews @smk4664 @whitej6 @romanukes
/nautobot_chatops/integrations/aci/ @pato23arg
/nautobot_chatops/integrations/ansible/ @smk4664
/nautobot_chatops/integrations/aristacv/ @qduk
Expand Down
1 change: 1 addition & 0 deletions changes/265.changed
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Aligned integrations documentation structure with SSoT.
33 changes: 16 additions & 17 deletions docs/admin/install/index.md → docs/admin/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide outlines the process of enabling Nautobot ChatOps, which includes:
- [Test Your Chatbot](#test-your-chatbot)
- [Integrations Configuration](#integrations-configuration)

{% include-markdown '../../glossary.md' heading-offset=1 %}
{% include-markdown '../glossary.md' heading-offset=1 %}

## Prerequisites

Expand Down Expand Up @@ -58,10 +58,10 @@ The `nautobot-chatops` package supports multiple chat platforms.

Set up your chosen chat platform:

- [Mattermost](./mattermost_setup.md)
- [Microsoft Teams](./microsoft_teams_setup.md)
- [Slack](./slack_setup.md)
- [Cisco Webex](./webex_setup.md)
- [Mattermost](./platforms/mattermost.md)
- [Microsoft Teams](./platforms/microsoft_teams.md)
- [Slack](./platforms/slack.md)
- [Cisco Webex](./platforms/webex.md)

## Installation Guide

Expand Down Expand Up @@ -107,9 +107,8 @@ PLUGINS_CONFIG = {
}
```

+++3.0.0

Some configuration settings have now been added to the Nautobot Admin Config page. See [Nautobot Admin](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/?h=administr#administratively-configurable-settings)
+++ 3.0.0
Some configuration settings have now been added to the Nautobot Admin Config page. See [Nautobot Admin](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/?h=administr#administratively-configurable-settings)

## Configuration Guide

Expand All @@ -126,15 +125,15 @@ Adjust the App's behavior with the following settings:
## Granting Access to the Chat Platform

{%
include-markdown '../../models/accessgrant.md'
include-markdown '../models/accessgrant.md'
start='<!--access-grant-->'
heading-offset=1
%}

## Link Nautobot Account

{%
include-markdown '../../models/chatopsaccountlink.md'
include-markdown '../models/chatopsaccountlink.md'
start='<!--account-link-->'
heading-offset=1
%}
Expand All @@ -149,10 +148,10 @@ The `nautobot-chatops` package includes multiple integrations. Each requires ext

Set up integrations using the specific guides:

- [Cisco ACI](./aci_setup.md)
- [AWX / Ansible Tower](./ansible_setup.md)
- [Arista CloudVision](./aristacv_setup.md)
- [Grafana](./grafana_setup.md)
- [IPFabric](./ipfabric_setup.md)
- [Cisco Meraki](./meraki_setup.md)
- [Palo Alto Panorama](./panorama_setup.md)
- [Cisco ACI](./integrations/aci.md)
- [AWX / Ansible Tower](./integrations/ansible.md)
- [Arista CloudVision](./integrations/aristacv.md)
- [Grafana](./integrations/grafana.md)
- [IPFabric](./integrations/ipfabric.md)
- [Cisco Meraki](./integrations/meraki.md)
- [Palo Alto Panorama](./integrations/panorama.md)
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ This guide will walk you through steps to set up Cisco ACI integration with the

Before configuring the integration, please ensure the following:

- `nautobot-chatops` App was [installed with integration extra dependencies](./index.md#installation-guide).
- `nautobot-chatops` App was [installed with integration extra dependencies](../install.md#installation-guide).
```shell
pip install nautobot-chatops[aci]
```
- `nautobot-chatops` App is set up with at least one [enabled chat platform](./index.md#chat-platforms-configuration) and [tested](./index.md#test-your-chatbot).
- `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 `aci` in your enabled chat platform. For detailed instructions related to your specific chat platform, refer to the [platform specific set up](./index.md#chat-platforms-configuration).
Create a top-level command named `aci` 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

Expand Down Expand Up @@ -66,7 +66,7 @@ When executing chat commands, you will be presented with a selection dialog cont
## Upgrading from `nautobot-plugin-chatops-aci` App
!!! warning
When upgrading from `nautobot-plugin-chatops-aci` App, it's necessary to [avoid conflicts](index.md#potential-apps-conflicts).
When upgrading from `nautobot-plugin-chatops-aci` App, it's necessary to [avoid conflicts](../install.md#potential-apps-conflicts).
- Uninstall the old App:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ This guide will walk you through steps to set up AWX / Ansible Tower integration

Before configuring the integration, please ensure the following:

- `nautobot-chatops` App was [installed with integration extra dependencies](./index.md#installation-guide).
- `nautobot-chatops` App was [installed with integration extra dependencies](../install.md#installation-guide).
```shell
pip install nautobot-chatops[ansible]
```
- `nautobot-chatops` App is set up with at least one [enabled chat platform](./index.md#chat-platforms-configuration) and [tested](./index.md#test-your-chatbot).
- `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 `ansible` in your enabled chat platform. For detailed instructions related to your specific chat platform, refer to the [platform specific set up](./index.md#chat-platforms-configuration).
Create a top-level command named `ansible` 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

Expand Down Expand Up @@ -52,7 +52,7 @@ PLUGINS_CONFIG = {
## Upgrading from `nautobot-plugin-chatops-ansible` App

!!! warning
When upgrading from `nautobot-plugin-chatops-ansible` App, it's necessary to [avoid conflicts](index.md#potential-apps-conflicts).
When upgrading from `nautobot-plugin-chatops-ansible` App, it's necessary to [avoid conflicts](../install.md#potential-apps-conflicts).

- Uninstall the old App:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ This guide will walk you through steps to set up Arista CloudVision integration

Before configuring the integration, please ensure the following:

- `nautobot-chatops` App was [installed with integration extra dependencies](./index.md#installation-guide).
- `nautobot-chatops` App was [installed with integration extra dependencies](../install.md#installation-guide).
```shell
pip install nautobot-chatops[aristacv]
```
- `nautobot-chatops` App is set up with at least one [enabled chat platform](./index.md#chat-platforms-configuration) and [tested](./index.md#test-your-chatbot).
- `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 `cloudvision` in your enabled chat platform. For detailed instructions related to your specific chat platform, refer to the [platform specific set up](./index.md#chat-platforms-configuration).
Create a top-level command named `aristacv` 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

Expand Down Expand Up @@ -69,7 +69,7 @@ Once you have updated your environment file, restart both nautobot and nautobot-
## Upgrading from `nautobot-plugin-chatops-arista-cloudvision` App

!!! warning
When upgrading from `nautobot-plugin-chatops-arista-cloudvision` App, it's necessary to [avoid conflicts](index.md#potential-apps-conflicts).
When upgrading from `nautobot-plugin-chatops-arista-cloudvision` App, it's necessary to [avoid conflicts](../install.md#potential-apps-conflicts).
- Uninstall the old App:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ This guide will walk you through steps to set up Grafana integration with the `n

Before configuring the integration, please ensure the following:

- `nautobot-chatops` App was [installed with integration extra dependencies](./index.md#installation-guide).
- `nautobot-chatops` App was [installed with integration extra dependencies](../install.md#installation-guide).
```shell
pip install nautobot-chatops[grafana]
```
- `nautobot-chatops` App is set up with at least one [enabled chat platform](./index.md#chat-platforms-configuration) and [tested](./index.md#test-your-chatbot).
- `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).
- [Grafana](https://grafana.com/docs/grafana/latest/installation/) application installed and configured with dashboards and panels.
- [Grafana Image Rendering Service](https://grafana.com/docs/grafana/latest/administration/image_rendering/) installed.
- [Grafana Image Rending App for Grafana](https://grafana.com/grafana/plugins/grafana-image-renderer/) installed in your Grafana application.

## Command Setup

Create a top-level command named `grafana` in your enabled chat platform. For detailed instructions related to your specific chat platform, refer to the [platform specific set up](./index.md#chat-platforms-configuration).
Create a top-level command named `grafana` 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

Expand Down Expand Up @@ -62,7 +62,7 @@ PLUGINS_CONFIG = {
## Upgrading from `nautobot-plugin-chatops-grafana` App

!!! warning
When upgrading from `nautobot-plugin-chatops-grafana` App, it's necessary to [avoid conflicts](index.md#potential-apps-conflicts).
When upgrading from `nautobot-plugin-chatops-grafana` App, it's necessary to [avoid conflicts](../install.md#potential-apps-conflicts).
- Uninstall the old App:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ This guide will walk you through steps to set up IPFabric integration with the `

Before configuring the integration, please ensure the following:

- `nautobot-chatops` App was [installed with integration extra dependencies](./index.md#installation-guide).
- `nautobot-chatops` App was [installed with integration extra dependencies](../install.md#installation-guide).
```shell
pip install nautobot-chatops[ipfabric]
```
- `nautobot-chatops` App is set up with at least one [enabled chat platform](./index.md#chat-platforms-configuration) and [tested](./index.md#test-your-chatbot).
- `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).

## Version Matrix

Expand All @@ -25,7 +25,7 @@ Here is a compatibility matrix and the minimum versions required to run this app

## Command Setup

Create a top-level command named `ipfabric` in your enabled chat platform. For detailed instructions related to your specific chat platform, refer to the [platform specific set up](./index.md#chat-platforms-configuration).
Create a top-level command named `ipfabric` 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

Expand Down Expand Up @@ -59,7 +59,7 @@ PLUGINS_CONFIG = {
## Upgrading from `nautobot-plugin-chatops-ipfabric` App

!!! warning
When upgrading from `nautobot-plugin-chatops-ipfabric` App, it's necessary to [avoid conflicts](index.md#potential-apps-conflicts).
When upgrading from `nautobot-plugin-chatops-ipfabric` App, it's necessary to [avoid conflicts](../install.md#potential-apps-conflicts).
- Uninstall the old App:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ This guide will walk you through steps to set up Cisco Meraki integration with t

Before configuring the integration, please ensure the following:

- `nautobot-chatops` App was [installed with integration extra dependencies](./index.md#installation-guide).
- `nautobot-chatops` App was [installed with integration extra dependencies](../install.md#installation-guide).
```shell
pip install nautobot-chatops[meraki]
```
- `nautobot-chatops` App is set up with at least one [enabled chat platform](./index.md#chat-platforms-configuration) and [tested](./index.md#test-your-chatbot).
- `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 `meraki` in your enabled chat platform. For detailed instructions related to your specific chat platform, refer to the [platform specific set up](./index.md#chat-platforms-configuration).
Create a top-level command named `meraki` 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

Expand Down Expand Up @@ -46,7 +46,7 @@ The alternative option is to set the environmental variable:
## Upgrading from `nautobot-plugin-chatops-meraki` App

!!! warning
When upgrading from `nautobot-plugin-chatops-meraki` App, it's necessary to [avoid conflicts](index.md#potential-apps-conflicts).
When upgrading from `nautobot-plugin-chatops-meraki` App, it's necessary to [avoid conflicts](../install.md#potential-apps-conflicts).
- Uninstall the old App:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ This guide will walk you through steps to set up Palo Alto Panorama integration

Before configuring the integration, please ensure the following:

- `nautobot-chatops` App was [installed with integration extra dependencies](./index.md#installation-guide).
- `nautobot-chatops` App was [installed with integration extra dependencies](../install.md#installation-guide).
```shell
pip install nautobot-chatops[panorama]
```
- `nautobot-chatops` App is set up with at least one [enabled chat platform](./index.md#chat-platforms-configuration) and [tested](./index.md#test-your-chatbot).
- `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 `panorama` in your enabled chat platform. For detailed instructions related to your specific chat platform, refer to the [platform specific set up](./index.md#chat-platforms-configuration).
Create a top-level command named `panorama` 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

Expand Down Expand Up @@ -46,7 +46,7 @@ PLUGINS_CONFIG = {
## Upgrading from `nautobot-plugin-chatops-panorama` App

!!! warning
When upgrading from `nautobot-plugin-chatops-panorama` App, it's necessary to [avoid conflicts](index.md#potential-apps-conflicts).
When upgrading from `nautobot-plugin-chatops-panorama` App, it's necessary to [avoid conflicts](../install.md#potential-apps-conflicts).
- Uninstall the old App:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
- Copy the displayed url matching the Server you want to add the chatbot to.
- Make sure to include the `http://` or `https://`.
- If shown, make sure to include the port. Ex. `https://example.com:8065`
6. Proceed to the [Install Guide](index.md#Install-Guide) section.
6. Proceed to the [Install Guide](../install.md#Install-Guide) section.

**Note:** For every Slash Command created for Mattermost, a separate token will be generated.

Expand All @@ -39,4 +39,4 @@

## General Chat Setup Instructions

See [admin_install](index.md) instructions here for general app setup instructions.
See [admin_install](../install.md) instructions here for general app setup instructions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
1. In the Microsoft Teams client, select “Apps” from the sidebar to the left.
2. Select “Built for your org.”
3. Select the tile for the new Nautobot app. Click the blue “Add” button.
4. Proceed to the [Install Guide](index.md#Install-Guide) section.
4. Proceed to the [Install Guide](../install.md#Install-Guide) section.

## Nautobot Config

Expand All @@ -53,4 +53,4 @@ Reference the [Setting Up Nautobot ChatOps With MSTeams Fall 2022](https://blog.

## General Chat Setup Instructions

See [admin_install](index.md) instructions here for general app setup instructions.
See [admin_install](../install.md) instructions here for general app setup instructions.
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ PLUGINS_CONFIG = {
![slack integration invite](../../images/add_nautobot.png)

Once these steps are completed, you can proceed to the [Install Guide](index.md#Install-Guide) section.
Once these steps are completed, you can proceed to the [Install Guide](../install.md#Install-Guide) section.

## Configuring Multiple Chatbots in a Workspace

Expand Down Expand Up @@ -186,7 +186,7 @@ PLUGINS_CONFIG = {
## General Chat Setup Instructions

See [admin_install](index.md) instructions here for general app setup instructions.
See [admin_install](../install.md) instructions here for general app setup instructions.

## Startup Slack Sockets (Socket Mode)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- secret: (enter a secret string that you don't mind having passed around as plaintext)
- Change the `resource` to "attachmentActions" and run the API call again to create a second webhook.
4. Configure the `webex_signing_secret` in your `.creds.env` to match the Webhook secret string that you selected above.
5. Proceed to the [Installation Guide](index.md#Install-Guide) section.
5. Proceed to the [Installation Guide](../install.md#Install-Guide) section.

## Deprecation Warning

Expand Down Expand Up @@ -60,4 +60,4 @@ Both settings will currently work, however support for `enable_webex_teams`, `we

## General Chat Setup Instructions

See [admin_install](index.md) instructions here for general app setup instructions.
See [admin_install](../install.md) instructions here for general app setup instructions.
2 changes: 1 addition & 1 deletion docs/dev/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Add the release notes (`docs/release-notes/X.Y.md`) to the table of contents wit

### Verify and Revise the Installation Documentation

Follow the [installation instructions](../admin/install/index.md) to perform a new production installation of Nautobot ChatOps.
Follow the [installation instructions](../admin/install.md) to perform a new production installation of Nautobot ChatOps.

The goal of this step is to walk through the entire install process *as documented* to make sure nothing there needs to be changed or updated, to catch any errors or omissions in the documentation, and to ensure that it is current with each release.

Expand Down
2 changes: 1 addition & 1 deletion docs/models/chatopsaccountlink.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Account Link

<!--account-link-->
+++3.0.0
+++ 3.0.0

Nautobot ChatOps now uses the built-in Nautobot permissions for Nautobot Objects (Devices, Locations, Racks, etc.). Each user will need to link their Nautobot Account with their Chat Platform User Account. Login to Nautobot then access the Link ChatOps Account within the Plugins menu. Here you can provide your email address and select the ChatOps Platform you are using, then click the Look up User ID from Email to get your Chat User ID.

Expand Down
Loading

0 comments on commit 544b928

Please sign in to comment.