nautobot / nautobot-app-chatops

Extensible ChatOps Framework to enable other chatbots and the Nautobot chat command.
https://docs.nautobot.com/projects/chatops/en/latest/
Other
51 stars 34 forks source link

Adding Slack `app_manifest` to documentation #96

Open dteycheney opened 3 years ago

dteycheney commented 3 years ago

Environment

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 commented 3 years ago

FYI @tim-fiola

whitej6 commented 3 years ago

@jvanderaa or @tim-fiola please assign to me

whitej6 commented 3 years ago

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.

jvanderaa commented 3 years ago

Assigned @whitej6

sdargoeuves commented 2 years ago

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 👍

jvanderaa commented 2 years ago

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!

tim-fiola commented 2 years ago

Thanks for the submission @dteycheney !