Introduction

Skedler-Alerts v3.x 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.x can be retrieved with the following command 

            sudo docker pull skedler/alerts:latest

Note: To extract particular version Docker Skedler Alerts, sudo docker pull skedler/alerts:<tag>


Skedler Alerts version is available as tags in Docker.For Skedler Alerts available tags click here 


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


  • To start Skedler Alerts of a particular version 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:<tag> /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) edits 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 Alerts runs. The 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 alert_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 a container

  • To run Skedler Alerts as a container sudo docker exec alert service alert start
  • To start Skedler Alerts manually, 
    • sudo docker exec alert  /opt/alert/bin/alert
  • 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 3002. http://<hostIP>:3002
  • 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:3002


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



Step 8: Schedule Alerts


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



References