Skip to content

Commit

Permalink
Merge pull request #294 from nautobot/u/whitej6-renaming
Browse files Browse the repository at this point in the history
Renaming work
  • Loading branch information
smk4664 authored Dec 27, 2023
2 parents 5ed94b4 + f3a51b9 commit 5a4f354
Show file tree
Hide file tree
Showing 73 changed files with 187 additions and 189 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@
- [ ] Attached Screenshots, Payload Example
- [ ] Unit, Integration Tests
- [ ] Documentation Updates (when adding/changing features)
- [ ] Example Plugin Updates (when adding/changing features)
- [ ] Example App Updates (when adding/changing features)
- [ ] Outline Remaining Work, Constraints from Design
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on: # yamllint disable-line rule:truthy rule:comments
pull_request: ~

env:
PLUGIN_NAME: "nautobot-plugin-chatops"
PLUGIN_NAME: "nautobot-app-chatops"

jobs:
black:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/upstream_testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ jobs:
uses: "nautobot/nautobot/.github/workflows/plugin_upstream_testing_base.yml@develop"
with: # Below could potentially be collapsed into a single argument if a concrete relationship between both is enforced
invoke_context_name: "NAUTOBOT_CHATOPS"
plugin_name: "nautobot-plugin-chatops"
plugin_name: "nautobot-app-chatops"
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- markdownlint-disable MD024 -->
# Changelog - Nautobot Plugin ChatOps
# Changelog - Nautobot App ChatOps

The changelog has been moved to the [project release notes](https://docs.nautobot.com/projects/chatops/en/latest/admin/release_notes/).
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Nautobot ChatOps

<p align="center">
<img src="https://raw.githubusercontent.com/nautobot/nautobot-plugin-chatops/develop/docs/assets/icon-ChatOps.png" alt="ChatOps Logo" class="logo" height="200px">
<img src="https://raw.githubusercontent.com/nautobot/nautobot-app-chatops/develop/docs/assets/icon-ChatOps.png" alt="ChatOps Logo" class="logo" height="200px">
<br>
<a href="https://github.com/nautobot/nautobot-plugin-chatops/actions"><img src="https://github.com/nautobot/nautobot-plugin-chatops/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://github.com/nautobot/nautobot-app-chatops/actions"><img src="https://github.com/nautobot/nautobot-app-chatops/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://docs.nautobot.com/projects/chatops/en/latest"><img src="https://readthedocs.org/projects/nautobot-plugin-chatops/badge/"></a>
<a href="https://pypi.org/project/nautobot-chatops/"><img src="https://img.shields.io/pypi/v/nautobot-chatops"></a>
<a href="https://pypi.org/project/nautobot-chatops/"><img src="https://img.shields.io/pypi/dm/nautobot-chatops"></a>
Expand All @@ -25,9 +25,9 @@
- Cisco Meraki
- Palo Alto Panorama
- Write a command once and run it on every supported platform, including rich content formatting.
- Extensible - other Nautobot plugins can provide additional commands which will be dynamically discovered.
- 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`).
- Metrics of command usage via the `nautobot_capacity_metrics` plugin.
- Metrics of command usage via the `nautobot_capacity_metrics` app.

## Documentation

Expand Down Expand Up @@ -63,7 +63,7 @@ Sign up [here](https://slack.networktocode.com/)

## Acknowledgements

This project includes code originally written in separate plugins, which have been merged into this project:
This project includes code originally written in separate apps, which have been merged into this project:

- [nautobot-plugin-chatops-aci](https://github.com/nautobot/nautobot-plugin-chatops-aci):
Thanks
Expand Down
2 changes: 1 addition & 1 deletion development/towncrier_template.j2
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% if render_title %}
## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v{{ versiondata.version}})
## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v{{ versiondata.version}})

{% endif %}
{% for section, _ in sections.items() %}
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/compatibility_matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Changes to the support of upstream Nautobot releases will be announced 1 minor o

The **deprecation policy** will be announced within the [release notes](release_notes/index.md), and updated in the table below. There will be a `stable-<major>.<minor>` branch that will be minimally maintained. Any security enhancements or major bugs in that branch will be supported for a limited time.

While that last supported version will not be strictly enforced via the `max_version` setting, any issues with an updated Nautobot supported version in a minor release will require raising a bug and fixing it in Nautobot core, with no fixes expected in this plugin. This allows the Chatops plugin the ability to quickly take advantage of the latest features in Nautobot.
While that last supported version will not be strictly enforced via the `max_version` setting, any issues with an updated Nautobot supported version in a minor release will require raising a bug and fixing it in Nautobot core, with no fixes expected in this app. This allows the Chatops app the ability to quickly take advantage of the latest features in Nautobot.

| Chatops Version | Nautobot First Support Version | Nautobot Last Support Version |
| --------------- | ------------------------------ | ----------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/install/grafana_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Before configuring the integration, please ensure the following:
- `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).
- [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 Plugin for Grafana](https://grafana.com/grafana/plugins/grafana-image-renderer/) installed in your Grafana application.
- [Grafana Image Rending App for Grafana](https://grafana.com/grafana/plugins/grafana-image-renderer/) installed in your Grafana application.

## Command Setup

Expand Down
4 changes: 2 additions & 2 deletions docs/admin/install/ipfabric_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before configuring the integration, please ensure the following:

## Version Matrix

Here is a compatibility matrix and the minimum versions required to run this plugin:
Here is a compatibility matrix and the minimum versions required to run this app:

| IP Fabric | Python | Nautobot | chatops | chatops-ipfabric | [python-ipfabric](https://github.com/community-fabric/python-ipfabric) | [python-ipfabric-diagrams](https://github.com/community-fabric/python-ipfabric-diagrams) |
|-----------|--------|----------|---------|------------------|------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
Expand Down Expand Up @@ -96,6 +96,6 @@ PLUGINS_CONFIG = {
```
!!! warning
Configuration keys for IPFabric integration are now lowercased, compared to the old plugin.
Configuration keys for IPFabric integration are now lowercased, compared to the old app.
Environment variables for this integration are the same for both, old and new configuration.
2 changes: 1 addition & 1 deletion docs/admin/install/mattermost_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@

## General Chat Setup Instructions

See [admin_install](index.md) instructions here for general plugin setup instructions.
See [admin_install](index.md) instructions here for general app setup instructions.
4 changes: 2 additions & 2 deletions docs/admin/install/microsoft_teams_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
## MS Teams Developer Portal

1. To deploy the bot to your team, log in to the [Microsoft Developer Portal](https://dev.teams.microsoft.com/) and select “Apps” from the left-hand menu.
2. Select "Import app" and upload the Nautobot ChatOps_ms_teams.zip file. It can be found from this directory or downloaded from GitHub [here](https://github.com/nautobot/nautobot-plugin-chatops/blob/develop/Nautobot_ms_teams.zip). **NOTE:** If you get an error stating “App package has errors”, you can ignore this and click on “Import” to complete the import.
2. Select "Import app" and upload the Nautobot ChatOps_ms_teams.zip file. It can be found from this directory or downloaded from GitHub [here](https://github.com/nautobot/nautobot-app-chatops/blob/develop/Nautobot_ms_teams.zip). **NOTE:** If you get an error stating “App package has errors”, you can ignore this and click on “Import” to complete the import.
3. Under section “Configure”, select “Basic Information”. Scroll to the bottom. Under “Application (client) ID, type in the value that you took note of above in Azure step 10.
4. Under section “Configure”, select “App features”. Select the triple dots (...) next to the “Bot” tile and select “Edit”.
5. On the Bot Edit page, under section “Identify your bot,” select “Enter a bot ID” and type in the same App ID value used above in step 4. Click Save.
Expand Down Expand Up @@ -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 plugin setup instructions.
See [admin_install](index.md) instructions here for general app setup instructions.
22 changes: 11 additions & 11 deletions docs/admin/install/slack_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For now, take a mental note that in this section where we are configuring the Sl
Example config snippet from `nautobot_config.py` for configuring ChatOps with Slack:

```python
# Enable installed plugins. Add the name of each plugin to the list.
# Enable installed apps. Add the name of each app to the list.
PLUGINS = ["nautobot_chatops"]

PLUGINS_CONFIG = {
Expand All @@ -32,13 +32,13 @@ PLUGINS_CONFIG = {

!!! info
Optional: Logos rely on Slack being able to access the Static URL provided by Nautobot. If you are running
Slack in Socket Mode, Nautobot ChatOps Plugin will need you to specify where the static files are hosted.
Slack in Socket Mode, Nautobot ChatOps App will need you to specify where the static files are hosted.
This is helpful for giving Slack access to only the server hosting Nautobot Static Files. To configure the
static files host, use `slack_socket_static_host` ex. `slack_socket_static_host: 'https://example.com/static/'`.

## Connecting to Slack

The Nautobot ChatOps plugin supports two methods of communicating with Slack.
The Nautobot ChatOps app supports two methods of communicating with Slack.

1. Incoming Webhooks
2. Socket Mode
Expand All @@ -48,7 +48,7 @@ The Nautobot ChatOps plugin supports two methods of communicating with Slack.

### Webhooks vs. Socket Mode

With incoming webhooks, whenever a user sends a message to the bot via the client application (phone or desktop app), (1) the connection is initiated from the client, and the message gets sent to Slack's cloud. The Slack servers then initiate a connection to the ChatOps plugin running on the Nautobot server (2). Since this is a new, incoming connection, it must be port forwarded and allowed through any firewalls in your network between the internet and your Nautobot server (3). Nautobot then replies to the existing connection to Slack, which in turn forwards the response to the client.
With incoming webhooks, whenever a user sends a message to the bot via the client application (phone or desktop app), (1) the connection is initiated from the client, and the message gets sent to Slack's cloud. The Slack servers then initiate a connection to the ChatOps app running on the Nautobot server (2). Since this is a new, incoming connection, it must be port forwarded and allowed through any firewalls in your network between the internet and your Nautobot server (3). Nautobot then replies to the existing connection to Slack, which in turn forwards the response to the client.

![Chatops Slack Webhooks Mode](../../images/chatops-slack-webhooks-mode.png)

Expand All @@ -64,7 +64,7 @@ While there are sufficient ways of securing inbound API requests from the public

1. Log in to [https://api.slack.com/apps](https://api.slack.com/apps) and select "Create New App". Select "From an app manifest."
2. Select your preferred Slack workspace for your app.
3. In the window titled "Enter app manifest below," select the "YAML" formatting tab and copy/paste the contents of file [nautobot_slack_manifest.yml](https://github.com/nautobot/nautobot-plugin-chatops/blob/develop/setup_files/nautobot_slack_manifest.yml) from this repo. Update the below settings, then click Next.
3. In the window titled "Enter app manifest below," select the "YAML" formatting tab and copy/paste the contents of file [nautobot_slack_manifest.yml](https://github.com/nautobot/nautobot-app-chatops/blob/develop/setup_files/nautobot_slack_manifest.yml) from this repo. Update the below settings, then click Next.
- On line 5, you can change the name of the Chatbot here. By default it is set to `Nautobot`
- If using Socket mode:
- On line 34, update `socket_mode_enabled` to `true`
Expand All @@ -85,7 +85,7 @@ While there are sufficient ways of securing inbound API requests from the public
8. Under Settings --> Install App, copy the `Bot User OAuth Token` here. This will be needed later for setting `SLACK_API_TOKEN`.
9. Continue with below section "Post App-Creation Steps"

> **Optional:** You can configure the App Icon on the General --> Basic Information page. Under `App Icon`, select "Choose File." You can use the supplied icon [nautobot_chatops_icon.png](https://github.com/nautobot/nautobot-plugin-chatops/blob/develop/setup_files/nautobot_chatops_icon.png).
> **Optional:** You can configure the App Icon on the General --> Basic Information page. Under `App Icon`, select "Choose File." You can use the supplied icon [nautobot_chatops_icon.png](https://github.com/nautobot/nautobot-app-chatops/blob/develop/setup_files/nautobot_chatops_icon.png).
## Post App-Creation Steps

Expand Down Expand Up @@ -149,7 +149,7 @@ They will be differentiated in the workspace using the `slack_slash_command_pref
Here is an example `nautobot_config.py` for the first Nautobot chatbot implementation in the workspace. This chatbot will be called in the workspace using `/nautobot`.

```python
# Enable installed plugins. Add the name of each plugin to the list.
# Enable installed apps. Add the name of each app to the list.
PLUGINS = ["nautobot_chatops"]

PLUGINS_CONFIG = {
Expand All @@ -166,7 +166,7 @@ This configuration explicitly configures the `slack_slash_command_prefix` key/va
This chatbot will be called in the workspace using `/network2-nautobot`.

```python
# Enable installed plugins. Add the name of each plugin to the list.
# Enable installed apps. Add the name of each app to the list.
PLUGINS = ["nautobot_chatops"]

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

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

## Startup Slack Sockets (Socket Mode)

Expand Down Expand Up @@ -277,7 +277,7 @@ While this method is still possible, we recommend using the App Manifest method
> `/network2-nautobot` command would have a `slack_slash_command_prefix` of `/network2-`
4. On the "Basic Information" page for your app, under "App Credentials", find the "Signing Secret" and click "Show".
You will need to configure this value for the plugin as the `slack_signing_secret` value, such as through an
You will need to configure this value for the app as the `slack_signing_secret` value, such as through an
`.env` file. If this value is not correctly configured, the bot will be unable to validate that inbound
notifications it receives have been properly signed by the Slack server.
5. In the sidebar to the left, select "OAuth & Permissions".
Expand All @@ -295,7 +295,7 @@ While this method is still possible, we recommend using the App Manifest method
- `mpim:read`
- At the top of this page, select "Install App to Workspace" and confirm it.
- There should now be a "Bot User OAuth Access Token" displayed, typically a string starting with `xoxb-`.
You will need to configure this value for the plugin as the `slack_api_token` value, either directly or through an
You will need to configure this value for the app as the `slack_api_token` value, either directly or through an
`.env` file. If this value is not properly configured, the bot will be unable to send content to the user.
6. Returning to the "Basic Information" page for your app, under "Display Information", you can specify the name,
description, icon, and accent/background color for the app. You can use the `nautobot_logo.png` from this
Expand Down
6 changes: 3 additions & 3 deletions docs/admin/install/webex_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

## Deprecation Warning

As of Nautobot ChatOps Plugin v2.0.0, there are the following changes:
As of Nautobot ChatOps App v2.0.0, there are the following changes:

- The deprecated URL API path `webex_teams` has been removed. Please use `webex` as a substitute.
- The use and deprecation warnings for the obsolete `webex_teams` App configuration entries have been removed. These entries include:
Expand All @@ -50,7 +50,7 @@ As of Nautobot ChatOps Plugin v2.0.0, there are the following changes:
}
```

As of Nautobot ChatOps Plugin v1.4.0, the PLUGIN_CONFIG settings for Webex has changed to align with the official renaming of `Webex Teams` to `Webex`:
As of Nautobot ChatOps App v1.4.0, the PLUGIN_CONFIG settings for Webex has changed to align with the official renaming of `Webex Teams` to `Webex`:

- `enable_webex_teams` is deprecated. Use `enable_webex` instead.
- `webex_teams_token` is deprecated. Use `webex_token` instead.
Expand All @@ -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 plugin setup instructions.
See [admin_install](index.md) instructions here for general app setup instructions.
8 changes: 4 additions & 4 deletions docs/admin/release_notes/version_1.1.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# v1.1 Release Notes

## [v1.1.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.1.0)
## [v1.1.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.1.0)

### What's New

- Slack handling of list items > 100 items, now including a `next` option in the drop down list to get more options [#10](https://github.com/nautobot/nautobot-plugin-chatops/pull/10)
- Slack handling of list items > 100 items, now including a `next` option in the drop down list to get more options [#10](https://github.com/nautobot/nautobot-app-chatops/pull/10)

### Bug Fixes

- Updated MS Teams Zip File [#29](https://github.com/nautobot/nautobot-plugin-chatops/pull/29)
- Fix connection filter ordering [#23](https://github.com/nautobot/nautobot-plugin-chatops/pull/23)
- Updated MS Teams Zip File [#29](https://github.com/nautobot/nautobot-app-chatops/pull/29)
- Fix connection filter ordering [#23](https://github.com/nautobot/nautobot-app-chatops/pull/23)
4 changes: 2 additions & 2 deletions docs/admin/release_notes/version_1.10.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

<!-- towncrier release notes start -->

## [v1.10.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.10.0)
## [v1.10.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.10.0)

### What's Changed

* Drop official support for Nautobot <1.3.0
* Add support for Slack Socket Mode.

[**Full Changelog**](https://github.com/nautobot/nautobot-plugin-chatops/compare/v1.9.1...v1.10.0)
[**Full Changelog**](https://github.com/nautobot/nautobot-app-chatops/compare/v1.9.1...v1.10.0)
Loading

0 comments on commit 5a4f354

Please sign in to comment.