confdroid_alloy/README.md

# Readme

[![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_alloy)](https://pipelines.confdroid.com/job/cd_alloy/)

[[_TOC_]]

## 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.

`cd_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

* ToDo

## Repo Documentation

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

## Dependencies

All dependencies must be included in the catalogue.

* [cd_resources](https://sourcecode.confdroid.com/12WW1160/cd_resources) to manage yum base repos

## Deployment

* native Puppet deployment

via site.pp or nodes.pp

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

* through Foreman:

In order to apply parameters through Foreman, **__cd_alloy::params__** 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: Roxky 9
* Puppet 6

## Tests

* Puppet Lint
  * excluded tests:
    * `--no-class_inherits_from_params_class-check`:relevant only to non-supported outdated puppet versions
    * `--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.
    * `--no-80chars-check`: it is not always possible to stay within 80 characters, although typically only occurring on the parameter vault `params.pp`.
    * `--no-arrow_alignment-check`: this check leads to actually not having am easily readable arrow alignment, as this checks `per block`, not per class.
* Puppet Parser
* ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
* Markdown-lint
* Spellcheck
* Sonar Quality Gate

## Contact Us

[contact Us](https://confdroid.com/contact/)

## 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.