slo-generator/README.md

28 lines
1.1 KiB
Markdown

# YAML 2 Terraform Generator
## Description
The task was to create a first draft of a script that can use a specific YAML file datastructure to generate Terraform configuration files. Afterwards it can be used as part of a Jenkins pipeline.
## Info
- YAML files should be stored according to the business line
- DE-3
- DE-4
- DE-7
- EC-DE
- Some YAML files have been created for testing purposes based on the shared_configuration and CoCo_Terraform_Config repositories.
- [shared_configuration](https://atc.bmwgroup.net/bitbucket/projects/OPAPM/repos/shared_configuration)
- [CoCo_Terraform_Config](https://atc.bmwgroup.net/bitbucket/projects/OPAPM/repos/coco_terraform_config)
## Requirements
### Python
The used python version for running the script is 3.11.2.
### Libraries
Some python packages need to be installed. Please use the requirements.txt file to install missing packages.
## Running the program
Using the program is straightforward.
- `.\generate.py <business line>`
- Example: `.\generate.py DE-3`
- `.\generate DE-3,DE-4,DE-7,EC-DE`