https://github.com/goldstrike77/ansible-role-linux-alerta
Ansible role for install and configure Alerta on linux operating system.
https://github.com/goldstrike77/ansible-role-linux-alerta
alerta ansible ansible-role monitoring webhook
Last synced: 3 months ago
JSON representation
Ansible role for install and configure Alerta on linux operating system.
- Host: GitHub
- URL: https://github.com/goldstrike77/ansible-role-linux-alerta
- Owner: goldstrike77
- License: mit
- Created: 2020-04-24T01:07:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-05T08:29:10.000Z (almost 4 years ago)
- Last Synced: 2025-01-12T17:47:53.108Z (over 1 year ago)
- Topics: alerta, ansible, ansible-role, monitoring, webhook
- Language: Python
- Homepage:
- Size: 3.99 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
>__Please note that the original design goal of this role was more concerned with the initial installation and bootstrapping environment, which currently does not involve performing continuous maintenance, and therefore are only suitable for testing and development purposes, should not be used in production environments. The author does not guarantee the accuracy, completeness, reliability, and availability of the role content. Under no circumstances will the author be held responsible or liable in any way for any claims, damages, losses, expenses, costs or liabilities whatsoever, including, without limitation, any direct or indirect damages for loss of profits, business interruption or loss of information.__
>__请注意，此角色的最初设计目标更关注初始安装和引导环境，目前不涉及执行连续维护，因此仅适用于测试和开发目的，不应在生产环境中使用。作者不对角色内容之准确性、完整性、可靠性、可用性做保证。在任何情况下，作者均不对任何索赔，损害，损失，费用，成本或负债承担任何责任，包括但不限于因利润损失，业务中断或信息丢失而造成的任何直接或间接损害。__
___
__Table of Contents__
- [Overview](#overview)
- [Requirements](#requirements)
* [Operating systems](#operating-systems)
* [alerta Versions](#alerta-versions)
- [ Role variables](#Role-variables)
* [Main Configuration](#Main-parameters)
* [Other Configuration](#Other-parameters)
- [Dependencies](#dependencies)
- [Example Playbook](#example-playbook)
* [Hosts inventory file](#Hosts-inventory-file)
* [Vars in role configuration](#vars-in-role-configuration)
* [Combination of group vars and playbook](#combination-of-group-vars-and-playbook)
- [License](#license)
- [Author Information](#author-information)
- [Donations](#Donations)
## Overview
The alerta monitoring system is a tool used to consolidate and de-duplicate alerts from multiple sources for quick ‘at-a-glance’ visualisation. With just one system you can monitor alerts from many other monitoring tools on a single screen.
## Requirements
### Operating systems
This Ansible role installs Alerta on linux operating system, including establishing a filesystem structure and server configuration with some common operational features. This role will work on the following operating systems:
* CentOS 7
### alerta versions
The following list of supported the alerta releases:
* alerta 7.5+
## Role variables
### Main parameters #
There are some variables in defaults/main.yml which can (Or needs to) be overridden:
##### General parameters
* `alerta_admin_user`: Alerta Superuser name.
* `alerta_admin_pass`: Alerta Superuser password.
* `alerta_ngx_domain`: Defines domain name.
* `alerta_incident_levels_map`: Defines the display mode of incident alarm, severity or priority.
##### Role dependencies
* `alerta_mongod_dept`: A boolean to determine whether or not to install the MongoDB together.
* `alerta_ngx_dept`: A boolean to determine whether or not to proxy web interface and API traffic using NGinx.
##### Listen port
* `alerta_port_arg.api`: The port number of API.
* `alerta_port_arg.webui`: The port number of Web UI.
##### MongoDB parameters
* `alerta_mongod_auth`: A boolean to determine whether or not to enable MongoDB authentication.
* `alerta_mongod_hosts`: Group of MongoDB hosts should connect to.
* `alerta_mongod_node_role`: Member role for ReplicaSet.
* `alerta_mongod_path`: Specify the MongoDB data directory.
* `alerta_mongod_port`: The MongoDB instance port.
* `alerta_mongod_ssl`: A boolean to determine whether or not to encrypting client and cluster communications.
* `alerta_mongod_replset`: MongoDB ReplicaSet name.
* `alerta_mongod_sa_pass`: MongoDB Superuser password.
* `alerta_mongod_sa_user`: MongoDB Superuser name.
* `alerta_mongod_user`: MongoDB username.
* `alerta_mongod_pass`: MongoDB password.
* `alerta_mongod_version`: Specify the MongoDB version.
* `alerta_mongod_backupset_arg`: Defines backup parameters.
##### System Variables
* `alerta_arg.auth_provider`: Defines authentication providers.
* `alerta_arg.base_url`: API served on a path or behind a proxy use it to fix relative links.
* `alerta_arg.log_backup_count`: Number of rollover files before older files are deleted.
* `alerta_arg.log_format`: Defines log file formatter.
* `alerta_arg.log_max_mib`: Maximum mebibyte size of log file before rollover.
* `alerta_arg.site_logo_url`: URL of company logo to replace "alerta" in navigation bar.
##### Plugins Variables
* `alerta_plugins`: Define additional plugins to install.
##### Service Mesh
* `environments`: Define the service environment.
* `datacenter`: Define the DataCenter.
* `domain`: Define the Domain.
* `customer`: Define the customer name.
* `tags`: Define the service custom label.
* `exporter_is_install`: A boolean to determine whether or not to install Prometheus exporter.
* `consul_public_register`: A boolean to determine whether or not to register an exporter with a public consul client.
* `consul_public_exporter_token`: Public Consul client ACL token.
* `consul_public_http_prot`: The consul Hypertext Transfer Protocol.
* `consul_public_clients`: List of public consul clients.
* `consul_public_http_port`: The consul HTTP API port.
### Other parameters
There are some variables in vars/main.yml:
## Dependencies
- Ansible versions >= 2.8
- Python >= 2.7.5
- [MongoDB](https://github.com/goldstrike77/ansible-role-linux-mongodb.git)
## Example
### Hosts inventory file
See tests/inventory for an example.
### Vars in role configuration
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
```yaml
- hosts: all
roles:
- role: ansible-role-linux-alerta
```
### Combination of group vars and playbook
You can also use the group_vars or the host_vars files for setting the variables needed for this role. File you should change: group_vars/all or host_vars/`group_name`.
```yaml
alerta_admin_user: 'admin'
alerta_admin_pass: 'changeme'
alerta_ngx_domain: 'alerta.example.com'
alerta_incident_levels_map: 'severity'
alerta_mongod_dept: true
alerta_ngx_dept: true
alerta_port_arg:
api: '7443'
webui: '8443'
alerta_mongod_auth: true
alerta_mongod_hosts: 'localhost'
alerta_mongod_node_role: 'replica'
alerta_mongod_path: '/data'
alerta_mongod_port: '27017'
alerta_mongod_ssl: true
alerta_mongod_replset: 'alerta'
alerta_mongod_sa_pass: 'changeme'
alerta_mongod_sa_user: 'sa'
alerta_mongod_user: 'alerta'
alerta_mongod_pass: 'changeme'
alerta_mongod_version: '36'
alerta_mongod_backupset_arg:
keep: '7'
encryptkey: 'wEX6nE3eHAJp'
cloud_rsync: true
cloud_drive: 'azureblob'
cloud_bwlimit: '10M'
cloud_event: 'sync'
cloud_config:
account: 'blobuser'
key: 'base64encodedkey=='
endpoint: 'blob.core.chinacloudapi.cn'
alerta_arg:
auth_provider: 'basic'
base_url: ''
site_logo_url: ''
log_max_mib: '25'
log_backup_count: '10'
log_format: 'verbose'
alerta_plugins:
prometheus:
- alertmanager_api_url: 'demo-prd-infra-monitor-alertmanager.service.dc01.local:9093'
alertmanager_silence_days: '2'
environments: 'prd'
datacenter: 'dc01'
domain: 'local'
customer: 'demo'
tags:
subscription: 'default'
owner: 'nobody'
department: 'Infrastructure'
organization: 'The Company'
region: 'China'
exporter_is_install: false
consul_public_register: false
consul_public_exporter_token: '00000000-0000-0000-0000-000000000000'
consul_public_http_prot: 'https'
consul_public_http_port: '8500'
consul_public_clients:
- '127.0.0.1'
```
## License
## Author Information
Please send your suggestions to make this role better.
## Donations
Please donate to the following monero address.
46CHVMbb6wQV2PJYEbahb353SYGqXhcdFQVEWdCnHb6JaR5125h3kNQ6bcqLye5G7UF7qz6xL9qHLDSAY3baagfmLZABz75