MVP - OVA/AMI - Create Configurer module

[Enaraque]

Description

The Configurer module will be responsible for configuring everything required for Wazuh to function correctly.

This module assumes that an instance has already been created and all components and dependencies have been installed on it.

To make the various configurations more readable and organized, this module will include submodules, each responsible for configuring specific parts:

• core_configurer: This will be the primary module responsible for the initial configuration of each component. It will configure each component to ensure a functional product (similar to the installation assistant).
• ova_configurer: This submodule will focus on all configurations required for the OVA. After the essential configurations for a functional product are completed, this module will prepare the product for deployment as an OVA.
• ami_configurer: This submodule will focus on all configurations required for the AMI. After the essential configurations for a functional product are completed, this module will prepare the product for deployment as an AWS AMI.

Prerequisites for Execution

To execute the configurer, it will be necessary to specify the type of configuration desired (core, OVA, or AMI).

Additionally, the credentials required to connect to the machine and perform the various configurations will be needed.

Summary

In summary, two minimum requirements are currently needed for the module to work correctly:

• Credentials to access the remote machine.
• The type of configuration to be performed.
• (to be defined if any additional inputs are required)

Tests

Unit Tests

As the module is being developed, unit tests will need to be written continuously. These tests must validate the code to ensure that each method and/or function behaves as expected.

The tests will be written using pytest. To verify that an optimal percentage of the code is being tested, the overall test coverage should be calculated and monitored.

Deployment Tests

These tests must ensure that every configuration made on the remote machine functions as expected.

Proposed Provisioner Structure

├── configurer/
│   ├── __init__.py
|   ├── main.py
│   ├── core_configurer/
│   │   ├── __init__.py
│   │   ├── core_configurer.py
│   ├── ova_configurer/
│   │   ├── __init__.py
│   │   ├── ova_configurer.py
│   ├── ami_configurer/
│       ├── __init__.py
│       ├── ami_configurer.py
├── tests/
    ├── unit/
    |   ├── configurer/
    |       ├── core/
    |       │   ├── __init__.py
    |       │   ├── test_core_configurer.py
    |       ├── ova/
    |       │   ├── __init__.py
    |       │   ├── test_ova_configurer.py
    |       ├── ami/
    |           ├── __init__.py
    |           ├── test_ami_configurer.py
    ├── deployment/
        ├── configurer/
            ├── core/
            │   ├── __init__.py
            │   ├── test_core_deployment.py
            ├── ova/
            │   ├── __init__.py
            │   ├── test_ova_deployment.py
            ├── ami/
                ├── __init__.py
                ├── test_ami_deployment.py

Related issue

• MVP - Create OVA and AMI Configuration Modules #157

DRI

@teddytpc1