Introduction

Skedler-Alerts v3.1.0 is now available in the Docker repository. It simplifies the installation process and shortens the time to get Skedler-Alerts up and running.   


Pre-requisites

System Requirements

  • Minimum of 4 CPU cores and 8 GB of RAM is recommended for deploying Skedler-Alerts.
  • Docker version greater than 1.8.0 should be installed.
  • Skedler-Alerts v3.1 or higher is only supported.


Step-by-Step Instruction

Step 1: Pull Skedler-Alerts from a Docker Repository

  • Obtaining Skedler-Alerts for Docker is a simple as issuing a docker pull command.
  • The Docker image for Skedler-Alerts 3.1 can be retrieved with the following command 

            sudo docker pull skedler/alerts:latest


Step 2: Start Skedler-Alerts as a Container

  • To start skedler-alerts as a container use the following command 

           sudo docker run --name alert -t -d -v alertdata:/data -p 0.0.0.0:3002:3001 skedler/alerts /bin/bash

Note: 0.0.0.0 is the bind address in which Skedler-Alerts runs, 3002 is the Host IP port which Skedler-Alerts uses and 3001 is the Docker IP port


Step 3: Basic Skedler-Alerts configurations using alertconfig.yml


To configure (or) edit Skedler-Alerts configurations like port, Elasticsearch URL and alert_index use the following command

         sudo docker exec -it alert nano /data/alertconfig.yml

  • port - The port in which skedler runs. Default port is 3001
  • elasticsearch_url - Elasticsearch URL with the port (even if the port is 80) in the following format <protocol>://<server>:<port>

  • alert_index - Skedler-Alerts index which will be created in Elasticsearch. It will create a new index if it doesn't already exist. Default skedler_index is .alert

Note: For more configuration options kindly refer the article alertConfig.yml in Skedler-Alerts Install Guide


Step 4: Run Skedler-Alerts as container

  • To run skedler-alerts as a container sudo docker exec alert service alert start
  • To stop skedler-alerts sudo docker stop alert


Step 5: Accessing Skedler-Alerts

  • Skedler-Alerts can be accessed from the following URL if it is using the port 3001. http://<hostIP>:3001
  • For example, if the HostIP: 192.168.0.101 and Docker IP: 172.17.0.1 respectively. Skedler-Alerts runs in 172.17.0.1 and you can access skedler-alerts using HostIP in the browser. http://192.168.0.101:3001


Step 6: Activate License Online

    

    Skedler-Alerts can be activated using Online or Offline. Refer the following articles to activate the license


Step 7: Configure Timezone, Index Pattern, Email and Webhook


To configure Skeldler-Alerts settings. Refer to How to configure time zone settings,index pattern settings, email settings, Webhook settings for skedler-alerts


Step 8: Schedule Alerts


    To start scheduling alerts. Refer to Step-by-Step User Guide for Skedler-Alerts to create alerts. 



References