eve-bot

README

eve-bot

Table of Contents

1. About The Project
2. Building
3. Running
4. Environment Variables
5. Getting Started
   • Slack

About The Project

This is the eve-bot ChatOps service. It is responsible for handling all communication between the User (Slack) and the Backend Pipeline API.

Building

run: make

Running

This application uses sane defaults for most of the config, but there are some required secrets that need to be set as Environment Variables. All application config use EnvVars.

Environment Variables

EVE_SERVICE_NAME=eve-bot
EVE_LOG_LEVEL=debug
EVEBOT_PORT=3000
EVEBOT_METRICS_PORT=3001
EVEBOT_EVEAPI_BASE_URL=""
EVEBOT_EVEAPI_CALLBACK_URL=""
EVEBOT_EVEAPI_ADMIN_TOKEN=""
EVEBOT_IDENTITY_CONNECTION_URL=""
EVEBOT_IDENTITY_CLIENT_ID=""
EVEBOT_OIDC_CLIENT_SECRET=""
EVEBOT_OIDC_REDIRECT_URL=""
EVEBOT_AWS_REGION=""
EVEBOT_LOGGING_DASHBOARD_BASE_URL=""
EVEBOT_USER_TABLE_NAME=""
EVEBOT_DEVOPS_MONITORING_CHANNEL=""

Getting Started

Slack

Slack Environment Variables

EVEBOT_SLACK_SIGNING_SECRET=""
EVEBOT_SLACK_VERIFICATION_TOKEN=""
EVEBOT_SLACK_OAUTH_ACCESS_TOKEN=""

• Create an App ( From Scratch )
• App summary will have the Signing Secret which will be EVEBOT_SLACK_SIGNING_SECRET and the Verification Token for EVEBOT_SLACK_VERIFICATION_TOKEN
• Enable Incoming web hooks
• Add bot via OAuth & Permissions to your channel
  • Copy Bot User OAuth Token, this will be the value for EVEBOT_SLACK_OAUTH_ACCESS_TOKEN

_metadata:
  major_version: 1
  minor_version: 1
display_information:
  name: {{bot-name}}
features:
  bot_user:
    display_name: {{bot-name}}
    always_online: true
oauth_config:
  scopes:
    user:
      - users:read
    bot:
      - app_mentions:read
      - incoming-webhook
      - users:read
settings:
  event_subscriptions:
    request_url: https://{{domain}}/slack-events
    bot_events:
      - app_mention
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false