<commit_before># k8comp

Separate the variables from the code.

#### Table of Contents

1. [Overview](#overview)
2. [Features](#features)
3. [Goals](#goals)
4. [Setup](#setup)
    * [Setup requirements](#setup-requirements)
5. [Usage - Configuration options and additional functionality](#usage)
    * [Main variables mapping](#main-variables-mapping)
    * [Variables](#variables)
    * [eyaml variables (encrypted variables)](#eyaml-variables)
    * [External files](#external-files)

## Overview

This is a tool which can help with the deployment files management. As different environments can have different requirements the tool simplifies the management of secrets (eyaml) and any value which is different from one environment to another (node ports, scaling requirements, environment variables and not only). A single file can be deployed to multiple environments.

The tool will read a file or multiple files from projects folder hierarchy, query hiera for the variables detected, replace them and create a new deployment output.

The output can be piped to kubectl or viewed on the console.
<commit_msg>readme clean<commit_after># k8comp

Separate the variables from the code.

#### Table of Contents

1. [Overview](#overview)
2. [Features](#features)
3. [Setup](#setup)
    * [Setup requirements](#setup-requirements)
4. [Usage - Configuration options and additional functionality](#usage)
    * [Main variables mapping](#main-variables-mapping)
    * [Variables](#variables)
    * [eyaml variables (encrypted variables)](#eyaml-variables)
    * [External files](#external-files)

## Overview

This is a tool which can help with the deployment files management. As different environments can have different requirements the tool simplifies the management of secrets (eyaml) and any value which is different from one environment to another (node ports, scaling requirements, environment variables and not only). A single file can be deployed to multiple environments.

The tool will read a file or multiple files from projects folder hierarchy, query hiera for the variables detected, replace them and create a new deployment output.

The output can be piped to kubectl or viewed on the console.

{'fraction_non_alphanumeric': 0.08068902991840435, 'fraction_numerical': 0.004986400725294651, 'mean_word_length': 4.948787061994609, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4504084', 'n_tokens_mistral': 552, 'n_tokens_neox': 520, 'n_words': 267}