Skip to main content

Alert Action Agent Installation

Network Connectivity Requirements​

The Alert Action Agent is the application which is responsible for sending the Alert Notifications (Actions).

The Alert Agent will communicate only with the Shyama Central Server and the Notification Servers as per Alert Config (such as Slack, Pagerduty). If external Notification Servers are to be connected to for Alert Actions (such as an external Email server, Slack, etc), internet access will need to be provided to the host where the Alert Agent is installed.

Installation Instructions​

Different Install Options exist :

Except for Kubernetes installs, please ensure that the the Alert Agent Config file in env file format is ready as per Alert Agent Config.

Install using Shell script​

Users can download a shell script that takes care of the installation and configuration of the Alert Agent instance.

note

Before installing the Alert Agent, users need to create a config file as per the Alert Agent Config.


curl -o /tmp/install-gyeeta-alertaction.sh -s https://gyeeta.io/packages/install-gyeeta-alertaction.sh

# Then run the install script as : 
# sudo bash /tmp/install-gyeeta-alertaction.sh <Path to alertaction Config file in bash env format>

# Example Install Command (Please configure the /tmp/alertaction.env config file first) :

sudo bash /tmp/install-gyeeta-alertaction.sh /tmp/alertaction.env

The install script SHA256 can be checked before installing. The SHA256 of the install script is available at SHA256 file

Stopping/Starting/Uninstalling the Alert Agent​

Command to stop the Alert Agent

sudo systemctl stop gyeeta-alertaction

Command to start the Alert Agent

sudo systemctl start gyeeta-alertaction

Command to uninstall Alert Agent

sudo systemctl disable gyeeta-alertaction; sudo apt-get remove gyeeta-alertaction

Install using Kubernetes Helm Chart​

Kubernetes 1.19 or higher is needed along with Helm v3.

Refer to Alert Agent Helm Chart for a detailed explanation on installing to Kubernetes.

A short explanation is shown below :


helm repo add gyeeta https://gyeeta.io/helmcharts
helm repo update
helm show values gyeeta/alertaction > /tmp/alertaction.yaml

# Thereafter you can edit the /tmp/alertaction.yaml file if you need to change any option. 
# After editing the /tmp/alertaction.yaml, install the alertaction Helm chart using :

helm install --namespace gyeeta --create-namespace alertaction1  gyeeta/alertaction -f /tmp/alertaction.yaml

Running as a Docker container​

An env config file needs to be created first as per Alert Agent Config

In the example command below, /tmp/alertaction.env config file has already been created on the main host.

The docker container will only run under userid 1001 and groupid 1001.


docker run -td --rm --name gyeetaAlertAgent --read-only --user 1001:1001 --env CFG_ENV=/tmp/alertaction.env -v /tmp/alertaction.env:/tmp/alertaction.env:ro ghcr.io/gyeeta/alertaction

Install using native rpm or deb packages​

Gyeeta native rpm or deb packages are available. The install is to be followed by Alert Agent configuration.

curl https://pkg.gyeeta.workers.dev/pgp-key.public | sudo gpg --yes --dearmor --output /usr/share/keyrings/gyeeta-keyring.gpg
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/gyeeta-keyring.gpg] https://pkg.gyeeta.workers.dev/apt-repo stable main" | sudo tee /etc/apt/sources.list.d/gyeeta.list
sudo apt-get update
sudo apt-get install -y gyeeta-alertaction

Alert Agent Configuration post Installation​

After the deb or rpm package has been installed, the alertaction config file /opt/gyeeta/alertaction/.env needs to be edited as per Alert Agent Config.

Start alertaction after editing the .env

# After editing the /opt/gyeeta/alertaction/.env config file

sudo systemctl start gyeeta-alertaction
sudo systemctl enable gyeeta-alertaction

Stopping/Starting/Uninstalling the Alert Agent​

Command to stop the Alert Agent

sudo systemctl stop gyeeta-alertaction

Command to start the Alert Agent

sudo systemctl start gyeeta-alertaction

Command to uninstall Alert Agent

sudo systemctl disable gyeeta-alertaction; sudo apt-get remove gyeeta-alertaction

Manual Tar Package install​

If none of the above options can be used to install the Gyeeta Alert Agent component, a manual tarball extract and configure can be used to install.

Example Install Command

mkdir ~/gyeeta
cd ~/gyeeta
curl -L https://github.com/gyeeta/alertaction/releases/download/$( curl https://api.github.com/repos/gyeeta/alertaction/releases/latest -s | grep tag_name | awk -F\" '{print $4}' )/alertaction.tar.gz | tar xzf -
cd ./alertaction

# Thereafter edit the .env Alert Agent config file and then start the Alert Agent as

./runalertaction.sh start

Alert Agent Failover / Redundancy​

Alert Agents can be setup for Multi Node High Availablity by installing 2 or more instances of Alert Agents.

Please refer to Failover for further details.