Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fgouteroux/mimir2tf
Mimir YAML Prometheus Rules to Terraform HCL converter
https://github.com/fgouteroux/mimir2tf
Last synced: about 7 hours ago
JSON representation
Mimir YAML Prometheus Rules to Terraform HCL converter
- Host: GitHub
- URL: https://github.com/fgouteroux/mimir2tf
- Owner: fgouteroux
- License: mpl-2.0
- Created: 2022-10-04T13:23:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T14:32:34.000Z (2 months ago)
- Last Synced: 2024-08-26T17:13:03.242Z (2 months ago)
- Language: HCL
- Homepage: https://github.com/fgouteroux/terraform-provider-mimir
- Size: 194 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mimir2tf - Mimir YAML Prometheus Rules to Terraform HCL converter
A tool for converting Mimir Prometheus Rules (in YAML format) into HashiCorp's Terraform configuration language.
The converted `.tf` files are suitable for use with the [Terraform Mimir Provider](https://registry.terraform.io/providers/fgouteroux/mimir/latest/docs)
## Installation
**Pre-built Binaries**
Download Binary from GitHub [releases](https://github.com/fgouteroux/mimir2tf/releases/latest) page.
## Usage
```
Usage of mimir2tf:
-d, --debug enable debug output
-f, --filepath string file or directory that contains the YAML configuration to convert. Use "-" to read from stdin (default "-")
-o, --output string file or directory where Terraform config will be written (default "-")
-x, --overwrite-existing allow overwriting existing output file(s)
-r, --reverse Reverse mode (hcl to yaml)
-F, --tf12format Use Terraform 0.12 formatter
-v, --version Print mimir2tf version
```
## YAML to HCL
**Convert a single YAML file and write generated Terraform config to Stdout**
```
$ mimir2tf -f test-fixtures/rules.yaml
resource "mimir_rule_group_alerting" "example" {
name = "example"
namespace = "default"
rule {
alert = "HighRequestLatency"
expr = "sum by (job) (http_inprogress_requests)"
for = "5m"
labels = {
severity = "critical"
}
annotations = {
test = "annotation value"
}
}
}
resource "mimir_rule_group_recording" "mimir_ingester_rules" {
name = "mimir_ingester_rules"
namespace = "default"
rule {
record = "cluster_namespace_pod:cortex_ingester_ingested_samples_total:rate1m"
expr = "sum by(cluster, namespace, pod) (rate(cortex_ingester_ingested_samples_total[1m]))"
}
}
```
**Convert a single YAML file and write output to file**
```
$ mimir2tf -f test-fixtures/rules.yaml -o rules.tf
```
**Convert a directory of Mimir YAML files and write output to stdout**
```
$ mimir2tf -f test-fixtures/
```
**Convert a directory of Mimir YAML files and write output to file**
```
$ mimir2tf -f test-fixtures/ -o /tmp/mimir-alerts-rules.tf
```
## HCL to YAML
**Convert a single HCL file and write yaml output to file**
```
$ mimir2tf -r -f test-fixtures/mimir-rules.tf -o /tmp/mimir-rules.yaml
```
**Convert a directory of Mimir HCL files to YAML file**
```
$ mimir2tf -r -f test-fixtures -o /tmp/mimir-alert-rules.yaml
```
Then validate with [promtool](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#syntax-checking-rules)
```
$ promtool check rules /tmp/mimir-alert-rules.yaml
Checking /tmp/mimir-alert-rules.yaml
2 duplicate rule(s) found.
Metric: MimirCompactorHasNotUploadedBlocks
Label(s):
severity: critical
Metric: MimirRolloutStuck
Label(s):
severity: warning
Might cause inconsistency while recording expressions.
SUCCESS: 194 rules found
```
## Building
> **NOTE** Requires a working Golang build environment.
This project uses Golang modules for dependency management, so it can be cloned outside of the `$GOPATH`.
**Clone the repository**
```
$ git clone https://github.com/fgouteroux/mimir2tf.git
```
**Build**
```
$ cd mimir2tf
$ make build
```