Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coralogix/dhall-prometheus-operator
Dhall types for Kubernetes Prometheus Operator
https://github.com/coralogix/dhall-prometheus-operator
Last synced: 3 months ago
JSON representation
Dhall types for Kubernetes Prometheus Operator
- Host: GitHub
- URL: https://github.com/coralogix/dhall-prometheus-operator
- Owner: coralogix
- License: other
- Created: 2019-03-17T19:05:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T13:47:09.000Z (9 months ago)
- Last Synced: 2024-01-08T18:02:43.967Z (6 months ago)
- Language: Dhall
- Homepage:
- Size: 158 KB
- Stars: 20
- Watchers: 9
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Lists
- awesome-dhall - dhall-prometheus-operator - Dhall types for the Prometheus Operator. (Libraries)
- awesome-dhall - dhall-prometheus-operator - Dhall types for the Prometheus Operator. (Libraries)
README
# dhall-prometheus-operator
[](https://github.com/RichardLitt/standard-readme)
> Dhall types for Kubernetes Prometheus Operator
This repository includes types, default records, and functions that produce default records in the [Dhall language](https://github.com/dhall-lang/dhall-lang) which model the Prometheus Operator API domain. They are based off the [Prometheus Operator documentation reference](https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md).
This allows the user to more easily generate type-safe Kubernetes resources for Prometheus/Alertmanager, through the use of the Dhall project's `dhall-to-yaml` tool.
### Note
This project relies upon resources provided by the [`dhall-kubernetes`](https://github.com/dhall-lang/dhall-kubernetes) project. However, as these resources are imported directly from `raw.githubusercontent.com`, they do not need to be manually installed.
## Install
For stability, users are encouraged to import from a tagged release, not from the master branch, and to watch for new releases. This project does not yet have rigorous testing set up for it and new commits on the master branch are prone to break compatibility and are almost sure to change the import hash for the expression.
```
https://raw.githubusercontent.com/coralogix/dhall-prometheus-operator/v8.0.0/package.dhall sha256:ebc5f0c5f57d410412c2b7cbb64d0883be648eafc094f0c3e10dba4e6bd46ed4
```
## Example Usage
### Example ServiceMonitor
```dhall
let Kubernetes = https://raw.githubusercontent.com/dhall-lang/dhall-kubernetes/v6.0.0/package.dhall sha256:532e110f424ea8a9f960a13b2ca54779ddcac5d5aa531f86d82f41f8f18d7ef1
let PrometheusOperator = (https://raw.githubusercontent.com/coralogix/dhall-prometheus-operator/v8.0.0/package.dhall sha256:ebc5f0c5f57d410412c2b7cbb64d0883be648eafc094f0c3e10dba4e6bd46ed4).v1
in PrometheusOperator.ServiceMonitor::{
, metadata =
Kubernetes.ObjectMeta::{ name = Some "example" }
, spec =
PrometheusOperator.ServiceMonitorSpec::{
, selector =
Kubernetes.LabelSelector::{
, matchLabels = Some
(toMap { app = "example" })
}
, endpoints =
Some [ PrometheusOperator.Endpoint.Union.TargetPort
PrometheusOperator.Endpoint.TargetPort::{
, targetPort = Kubernetes.NatOrString.String "example"
, interval = Some "60s"
, scrapeTimeout = Some "40s"
}
]
, namespaceSelector =
Some
( PrometheusOperator.NamespaceSelector.Any { any = True }
)
}
}
```
## Maintainers
[Ari Becker](https://github.com/ari-becker)
[Oded David](https://github.com/oded-dd)
[Shauli Solomovich](https://github.com/ShauliSolomovich)
## Contributing
TBD
## License
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) © Coralogix, Inc.