nautobot-app-chatops icon indicating copy to clipboard operation
nautobot-app-chatops copied to clipboard

Adding Slack `app_manifest` to documentation

Open dteycheney opened this issue 4 years ago • 7 comments

Environment

  • Nautobot version: 1.1.2
  • nautobot-plugin-chatops version: 1.5.0

Proposed Functionality

Slack has a Beta functionality to add an app_manifest, which if adopted by nautobot, could greatly simplify the documentation and setup:

https://github.com/nautobot/nautobot-plugin-chatops/blob/develop/docs/chat_setup/slack_setup.md

Slack Doco: https://api.slack.com/reference/manifests

Below is a rough example of the template file which could be provided to speed up the setup process:

_metadata:
  major_version: 1
  minor_version: 1
display_information:
  name: Nautobot ChatOps
features:
  bot_user:
    display_name: Nautobot ChatOps
    always_online: false
  slash_commands:
    - command: /nautobot
      url: https://<nautobot_server>/api/plugins/chatops/slack/slash_command/
      description: Nautobot Utility Function
      should_escape: false
oauth_config:
  scopes:
    bot:
      - commands
      - chat:write
      - channels:read
      - files:write
      - incoming-webhook
      - users:read
      - app_mentions:read
      - im:read
      - groups:read
      - mpim:read
settings:
  interactivity:
    is_enabled: true
    request_url: https://<nautobot_server>/api/plugins/chatops/slack/interaction/
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false

Use Case

Could be used to speed up the initial deployment of a Slack app or, ensure consistency is undertaken when deploying new apps.

dteycheney avatar Sep 13 '21 00:09 dteycheney

FYI @tim-fiola

dteycheney avatar Sep 13 '21 00:09 dteycheney

@jvanderaa or @tim-fiola please assign to me

whitej6 avatar Oct 19 '21 22:10 whitej6

Just created a new custom app and it looks like manifest is out of beta and is the only way to do certain configuration items now for slack.

whitej6 avatar Oct 19 '21 22:10 whitej6

Assigned @whitej6

jvanderaa avatar Oct 19 '21 23:10 jvanderaa

Hi, I have tried without success to create the manifest on Slack. I get this error, and I'm struggling to find out what it could be: image I've seen in one of the youtube video, that the server needs to have a valid SSL certificate, could that be the reason for this error? --> ignore this, it was indeed due to having my nautobot not reachable over the internet. ngrok fixed it all for me 👍

sdargoeuves avatar Dec 09 '21 01:12 sdargoeuves

Thanks @sdargoeuves let us know in discussions if there is something else for ideas, or perhaps help generate ideas for others about what you are doing for the Chat Ops!

jvanderaa avatar Dec 09 '21 21:12 jvanderaa

Thanks for the submission @dteycheney !

tim-fiola avatar Dec 09 '21 23:12 tim-fiola