commit	20a3fa71e83a6ae3bcd6852e6f21270b7ac0e473	[log] [tgz]
author	Ievgeniia Zadorozhna <izadorozhna@mirantis.com>	Thu Mar 07 21:18:04 2024 +0100
committer	Ievgeniia Zadorozhna <izadorozhna@mirantis.com>	Thu Mar 07 21:18:04 2024 +0100
tree	77be731fc882eee77cfb99b2a907b73a9c7a7afc
parent	51cf182d1a55c413ffeeec933e6db65f19ba4b79 [diff]

tree: 77be731fc882eee77cfb99b2a907b73a9c7a7afc

README.md

salt-cfg-checker

This checker module is used to verify and validate cloud after the deployment using number of routines to create reports

Background.

Many of our deployments comes with the monitoring solutions, but none of them keeps track of the package versions that is included in release. nd it is very important to have proper package versions. That is critical for cloud stability. here is more, it is critical to keep track of configuration values for networks (and others too..) in Runtime, in Configuration and at Reclass. Also, it is important to keep track of the changes in reclass and be able to have tool that gives clear report on what has been changed.

So, this tool here that can do some checks on the cloud that will be handy for:

Engineers that deployed the clouds and need to be sure that proper versions installed on every node
Services Team to check cloud at deploy time
ProdCare engineers that is supporting client environments
Support team

Main use cases for the MCP-checker is:

Generate a package versions report that will show which package versions must be payed attention on: Installed vs Candidates vs Release Notes. This will really help on understanding if some node has some strangely versioned package
Generate network check against running nodes to collect IPs, mach them into subnets and check MTUs in Runtime (ip a) vs reclass configuration
Compare two reclass models recursively (folder1 vs folder2) and generate differences report.

Installation

It is pretty simple:

deploy on cfg node, using root creds, on /root/

git clone http://gerrit.mcp.mirantis.com/mcp/cfg-checker
cd cfg-checker
virtualenv .cfgcheck
source .cfgcheck/bin/activate
pip install -r requirements.txt

you can check your local.env file for parameters (no need to update for running on cfg node)

Running

    "mos-checker = cfg_checker.cfg_check:config_check_entrypoint",
    "chk-pkg = cfg_checker.cli.packages:entrypoint",
    "chk-net = cfg_checker.cli.network:entrypoint",
    "chk-reclass = cfg_checker.cli.reclass:entrypoint",
    "checker-agent = cfg_checker.agent.cfg_agent:entrypoint"

Packages report (HTML): mos-checker packages report --html __packages_html_filename.html__
Packages report (CSV): mos-checker packages report --csv __packages_csv_filename.csv__
Network check (CLI output): mos-checker network check
Network check (HTML report): mcp-checker network report --html __network_html_filename.html__
Ceph Info (HTML report): mos-checker ceph info --tgz __ceph_info_filename.tgz__
Ceph Benchmark (HTML report) mos-checker ceph bench --html __ceph_bench_filename.html__
List folders that can be used for Reclass Compare: mcp-checker reclass list -p __models_path__
Compare two Reclass models (file and parameter wise): mcp-checker reclass diff --model1 __model1_path__ --model2 __model2_path__ --html __reclass_html_filename.html__

External cloud

You can also create your env file to connect to env

create your *.env file or supply environment vars to module other way
in the env file set host and user for SSH. For options, use your ~/.ssh/config
if node listing fails, execute salt-key on master and create an etc/nodes.list file with minions list

Cheers!