# Readme

[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_automatic&style=plastic)](https://jenkins.confdroid.com/job/confdroid_automatic/)
[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_automatic&metric=security_hotspots&token=sqb_c40a62afc3787918ade945dbc43089bb68ea7ab1)](https://sonarqube.confdroid.com/dashboard?id=confdroid_automatic)

- [Readme](#readme)
  - [Synopsis](#synopsis)
  - [WARNING](#warning)
  - [Features](#features)
  - [Dependencies](#dependencies)
  - [Support](#support)
  - [Parameter Inheritance](#parameter-inheritance)
  - [SELINUX](#selinux)
  - [Deployment](#deployment)
  - [Tests](#tests)
  - [Contact Us](#contact-us)
  - [Disclaimer](#disclaimer)

## Synopsis

dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9 and similar RHEL 9 based operating systems.

`confdroid_automatic` manages dnf-automatic installations and configurations.

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

- install required binaries,
- mane files and directories with proper selinux context
- manage main configurations files via parameters
- manage service

## Dependencies

## Support

- Rocky 9 (any RHEL 9-based OS should work)
- Puppet 8

## Parameter Inheritance

All parameters are listed in `params.pp` and inherited from there.  Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.

## SELINUX

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

## Deployment

- native Puppet deployment

via site.pp or nodes.pp

```ruby
node 'example.example.net' {
  include automatic
}
```

- through Foreman:

In order to apply parameters through Foreman, **confdroid_automatic::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/).

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