confdroid_alloy/README.md

# Readme

[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_alloy&style=plastic)](https://jenkins.confdroid.com/job/confdroid_alloy/)
[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_alloy&metric=security_hotspots&token=sqb_05c3bd9116b3d2585b1f06dd7b6d0d5a6433fe8b)](https://sonarqube.confdroid.com/dashboard?id=confdroid_alloy)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/grizzlycoda/puppet_collection)

- [Readme](#readme)
  - [Synopsis](#synopsis)
  - [WARNING](#warning)
  - [Features](#features)
  - [Repo Documentation](#repo-documentation)
  - [Dependencies](#dependencies)
  - [Deployment](#deployment)
  - [SELINUX](#selinux)
  - [Known Problems](#known-problems)
  - [Support](#support)
  - [Tests](#tests)
  - [Contact Us](#contact-us)
  - [Disclaimer](#disclaimer)

## Synopsis

Grafana Alloy is a log management agent built by Grafana labs to scrape and forward logs to Loki, a log management system also built by Grafana labs.  Then you can use Grafana itself to visualize those logs and built an alerting system.

`confdroid_alloy` is a Puppet module to automate installation and configuration of alloy.

## WARNING

***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production***

## Features

INSTALLATION

- installs alloy binaries

CONFIGURATION

- manage directories and files including templates
- manages the main alloy pipeline for loki and prometheus
- manages log rotation for rsyslog to allow adm membership
- manage service

## Repo Documentation

See the full Puppet documentation including parameters in `docs/index.html`

## Dependencies

All dependencies must be included in the catalogue.

## Deployment

- native Puppet deployment

via site.pp or nodes.pp

```bash
node 'example.example.net' {
  include confdroid_alloy
}
```

- through Foreman:

In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question.

See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).

## SELINUX

All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.

## Known Problems

## Support

- OS: Rocky 9
- Puppet 8

## Tests

- Puppet Lint
  - excluded tests:
    - `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
- Puppet Parser
- ERB Template Parser
- Sonar Quality Gate

## Contact Us

- [contact Us](https://confdroid.com/contact/)
- [Feedback Portal](https://feedback.confdroid.com)

## Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments  (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.