Finish integrations #218

snaselj · 2023-06-14T10:38:11Z

About

Finish adding integrations from baby plugins

What's Changed

Added /clear command to development Mattermost.
Improved integration workers loading.
Sorted App config and environment variables.
Sorted pyproject configurations.
Removed tests dependency on creds.example.env.
Added Cisco ACI documentation.
Renamed WebEx => Webex.
Simplified reading App config.
- Added def get_app_config_part(prefix) .
Removed webex_teams related deprecation warnings and usage.
Added webex_msg_char_limit App config entry.
Added attributions for original contributors

TODO

Add Cisco Meraki documentation
Add Palo Alto Panorama documentation
Add AWX / Ansible Tower documentation
Add Grafana documentation
Add Arista CloudVision documentation
Add IP Fabric documentation
Update developer documentation

- Added `/clear` command to Mattermost. - Improved integration workers loading and logging. - Sorted App config and environment variables. - Sorted pyproject configurations.

snaselj · 2023-06-14T14:27:03Z

This PR is missing documentation updates yet, however opinions are welcome.

ack @cmsirbu

smk4664 · 2023-06-17T17:39:58Z

development/creds.example.env

+# SLACK_APP_TOKEN="changeme"
+# SLACK_SIGNING_SECRET="changeme"
+
+# - Webex ----------------------------


We went with Webex Teams when it was rebranded. Did Webex Teams become Webex again?

In addition, I know it doesn't really matter, as Admins can change the nautobot_config.py to whatever they want, it will still cause issues when using an older creds.env for developers expecting WEBEX_TEAMS_ACCESS_TOKEN.

Expecting the next ChatOps App version to be 2.0, I was taking into account this deprecation: https://github.com/nautobot/nautobot-plugin-chatops/blob/develop/docs/admin/install/webex_setup.md#deprecation-warning

Webex Teams brand doesn't seem to be advertised by Ciso, when using search tools.

The old WEBEX_TEAMS_ACCESS_TOKEN is directly consumed by webexteamssdk library, however WEBEX_ACCESS_TOKEN is read by the App nautobot_config.py, passed to App config, and then passed to the library as arguments. Seems to me a bit better to use environment variables controlled by our App config to allow us some validations.

I would stay with Webex and emphasize this change in the documentation I'm preparing WDYT?

I can replace all WebEx occurrences with Webex including class names in the code, to be inline with the official Cisco naming, WDYT @smk4664 ?

I thought this was going out pre 2.0, but we are close to the Nautobot 2.0 release, so I am good with these changes.
As long as we document them.

Webex cleaned up:

Renamed WebEx => Webex.

Simplified reading App config.

Added def get_app_config_part(prefix) .

Removed webex_teams related deprecation warnings and usage.

Added webex_msg_char_limit App config entry.

snaselj · 2023-06-20T08:04:45Z

Improved developer documentation and added Cisco ACI user and admin install documentation. Could you pls. check it? @smk4664

After agreed, I'll add the rest of the plugins documentation in the same style.

snaselj · 2023-06-20T08:09:55Z

docs/user/app_getting_started.md

Proposing to format /nautobot and /clear commands into the table, the same way as here: https://github.com/nautobot/nautobot-plugin-chatops/pull/218/files#diff-a382cc7dcacafa83ebf8f8dfa4e92f19e1eaa57265b5df03212fec6da0439f87R5

WDYT? @smk4664

Sure! this would be great!

snaselj · 2023-06-20T08:56:02Z

docs/dev/dev_environment.md

+TBD: Update after merging https://github.com/nautobot/nautobot-plugin-chatops/pull/212
+


Remove this before merge

smk4664 · 2023-06-20T13:28:36Z

Could we also add attributions like @bryanculver did for the integrations we have already merged?

- Renamed `WebEx` => `Webex`. - Simplified reading App config. - Added `def get_app_config_part(prefix)` . - Removed `webex_teams` related deprecation warnings and usage. - Added `webex_msg_char_limit` App config entry.

snaselj · 2023-06-21T08:11:02Z

Could we also add attributions like @bryanculver did for the integrations we have already merged?

Fixed

smk4664 · 2023-06-22T21:30:28Z

It looks to me like this PR should still be in Draft, with all the incomplete checkmarks. If this is not the case, I will finalize my review.

snaselj · 2023-06-23T07:09:19Z

It looks to me like this PR should still be in Draft, with all the incomplete checkmarks. If this is not the case, I will finalize my review.

Converted to the Draft PR, will make it ready for review once all check marks will be done.

snaselj · 2023-06-23T07:51:23Z

Improved developer documentation and added Cisco ACI user and admin install documentation. Could you pls. check it? @smk4664

After agreed, I'll add the rest of the plugins documentation in the same style.

@smk4664 What is your opinion on the ACI documentation in this PR? If you will find it sufficient, I'll add the rest of integrations docs in the same style.

…ntegrations

snaselj · 2023-07-10T08:18:33Z

Proposing to rename arista_cloudvision and related config keys to aristacv to be in sync with https://github.com/nautobot/nautobot-plugin-ssot/pull/138/files

WDYT @smk4664 ?

…ntegrations

smk4664 · 2023-07-10T13:30:38Z

Proposing to rename arista_cloudvision and related config keys to aristacv to be in sync with https://github.com/nautobot/nautobot-plugin-ssot/pull/138/files

WDYT @smk4664 ?

Now would be a good time to do this. I am good with aligning on these.

smk4664 · 2023-07-10T13:47:10Z

Improved developer documentation and added Cisco ACI user and admin install documentation. Could you pls. check it? @smk4664

After agreed, I'll add the rest of the plugins documentation in the same style.

I agree of the Cisco ACI docs. Thank you for pulling these in!

smk4664 · 2023-07-10T13:48:16Z

docs/glossary.md

Can you move this into the user guide, just below the "Description/Overview".

Ah, I see it is included in the Development docs. I would also include it in the User Guide.

pyproject.toml

docs/dev/dev_environment.md

docs/user/aci_commands.md

cmsirbu · 2023-07-13T09:47:34Z

docs/user/app_getting_started.md

+    All sub-commands are intended to be used with the `nautobot` prefix. For example, to retrieve a filtered list of VLANs, use the command `/nautobot get-vlans`.
+
+{%


I think we'll need to see how it looks when all integrations have content, but I'm betting this will make for a lot of potential scrolling here. Maybe adding each page to the nav in an "Integrations commands" sub folder will be cleaner.

docs/admin/install/aci_setup.md

snaselj · 2023-07-19T13:03:19Z

Proposing to rename arista_cloudvision and related config keys to aristacv to be in sync with https://github.com/nautobot/nautobot-plugin-ssot/pull/138/files
WDYT @smk4664 ?

Now would be a good time to do this. I am good with aligning on these.

Done

snaselj · 2023-07-19T15:30:57Z

Updated integrations commands reference and resolved most comments here.

@cmsirbu @smk4664

snaselj · 2023-07-24T15:09:56Z

This PR is ready for review now.

cc: @cmsirbu @smk4664

smk4664

Thanks for all the hard work! I will merge in and create a new release for this.

snaselj added 6 commits June 14, 2023 10:35

chore: Improve integrations handling

8d8788d

- Added `/clear` command to Mattermost. - Improved integration workers loading and logging. - Sorted App config and environment variables. - Sorted pyproject configurations.

fix: Add changelog.

1b3050a

fix: Circular import

adea05c

fix: Replace obsolete WEBEX_TEAMS... with WEBEX...

62e1b68

fix: Unittest not to be dependent on creds.example

0bbbeae

fix: black

e740506

snaselj marked this pull request as ready for review June 14, 2023 14:25

snaselj requested review from glennmatthews, jvanderaa, smk4664 and whitej6 as code owners June 14, 2023 14:25

fix: Extra coma

dba7323

smk4664 reviewed Jun 17, 2023

View reviewed changes

snaselj added 2 commits June 19, 2023 19:19

doc: Admin install ACI

225028e

docs: Added /aci user commands, improvements

8ef287d

snaselj commented Jun 20, 2023

View reviewed changes

docs: ACI screenshots

2aa6be7

snaselj commented Jun 20, 2023

View reviewed changes

snaselj requested a review from bryanculver June 20, 2023 12:20

snaselj added 3 commits June 21, 2023 07:09

chore: Webex cleanup

beda413

- Renamed `WebEx` => `Webex`. - Simplified reading App config. - Added `def get_app_config_part(prefix)` . - Removed `webex_teams` related deprecation warnings and usage. - Added `webex_msg_char_limit` App config entry.

chore: Add missing empty docs

9a9a4df

chore: Credits to original contributors

1616ac7

snaselj added 2 commits June 21, 2023 09:13

fix: Better format nautobot subcommands help

b071c02

fix: pylint line length

db845d1

snaselj marked this pull request as draft June 23, 2023 07:08

Merge remote-tracking branch 'origin/develop' into u/snaselj-finish-i…

38a4631

…ntegrations

Merge remote-tracking branch 'origin/develop' into u/snaselj-finish-i…

0708160

…ntegrations

smk4664 reviewed Jul 10, 2023

View reviewed changes

cmsirbu reviewed Jul 13, 2023

View reviewed changes

snaselj added 3 commits July 19, 2023 12:38

fix: PR comments

65b06e9

fix: Include glossary to users guide

394ca88

chore: Rename arista_cloudvision to arista_cv

7f7cf9e

chore: Commands, some of install instructions

e370561

snaselj added 5 commits July 24, 2023 10:28

doc: Grafana and fixes

e05bb8e

doc: IPFabric

657689a

doc: Meraki

bb9905e

doc: Panorama

18b2ccb

doc: Dev and fixes

f545665

snaselj marked this pull request as ready for review July 24, 2023 15:08

smk4664 approved these changes Jul 25, 2023

View reviewed changes

smk4664 merged commit 0a93a77 into develop Jul 25, 2023
34 checks passed

smk4664 deleted the u/snaselj-finish-integrations branch July 25, 2023 13:13

This was referenced Jul 25, 2023

Prepare for ChatOps 2.0 release #222

Merged

Release v2.0.0 #225

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Finish integrations #218

Finish integrations #218

snaselj commented Jun 14, 2023 •

edited

snaselj commented Jun 14, 2023

smk4664 Jun 17, 2023

smk4664 Jun 17, 2023

snaselj Jun 19, 2023 •

edited

snaselj Jun 19, 2023

smk4664 Jun 20, 2023

snaselj Jun 21, 2023

snaselj commented Jun 20, 2023

snaselj Jun 20, 2023

smk4664 Jun 20, 2023

snaselj Jun 21, 2023

snaselj Jun 20, 2023

smk4664 commented Jun 20, 2023

snaselj commented Jun 21, 2023

smk4664 commented Jun 22, 2023

snaselj commented Jun 23, 2023

snaselj commented Jun 23, 2023

snaselj commented Jul 10, 2023

smk4664 commented Jul 10, 2023

smk4664 commented Jul 10, 2023

smk4664 Jul 10, 2023

smk4664 Jul 10, 2023

snaselj Jul 19, 2023

cmsirbu Jul 13, 2023

snaselj Jul 19, 2023

snaselj commented Jul 19, 2023

snaselj commented Jul 19, 2023

snaselj commented Jul 24, 2023

smk4664 left a comment

		TBD: Update after merging https://github.com/nautobot/nautobot-plugin-chatops/pull/212

		All sub-commands are intended to be used with the `nautobot` prefix. For example, to retrieve a filtered list of VLANs, use the command `/nautobot get-vlans`.

		{%

Finish integrations #218

Finish integrations #218

Conversation

snaselj commented Jun 14, 2023 • edited

About

What's Changed

TODO

snaselj commented Jun 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snaselj Jun 19, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snaselj commented Jun 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smk4664 commented Jun 20, 2023

snaselj commented Jun 21, 2023

smk4664 commented Jun 22, 2023

snaselj commented Jun 23, 2023

snaselj commented Jun 23, 2023

snaselj commented Jul 10, 2023

smk4664 commented Jul 10, 2023

smk4664 commented Jul 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snaselj commented Jul 19, 2023

snaselj commented Jul 19, 2023

snaselj commented Jul 24, 2023

smk4664 left a comment

Choose a reason for hiding this comment

snaselj commented Jun 14, 2023 •

edited

snaselj Jun 19, 2023 •

edited