datadog-operator icon indicating copy to clipboard operation
datadog-operator copied to clipboard

Better documentation and examples for DatadogMonitor CRD

Open red8888 opened this issue 3 years ago • 0 comments

I really want to use this, but the documentation is all but non existent.

I can't just export a monitor as json and convert it to yaml because the CRDs fields are totally different. So its up to me to read the source code and try to figure this out myself? https://github.com/DataDog/datadog-operator/blob/87632a90440e48ec0c7ba1015e3371345bb89cd1/apis/datadoghq/v1alpha1/datadogmonitor_types.go#L62

There should be a clear mapping of UI field names to CRD names. Maybe in an example here or something: https://github.com/DataDog/datadog-operator/tree/87632a90440e48ec0c7ba1015e3371345bb89cd1/examples/datadogmonitor

There should be something like this so its obvious what field maps to what UI field

  options:
    # Evaluation options: Before evaluating new groups, wait X seconds
    evaluationDelay: 303

red8888 avatar Jul 25 '22 14:07 red8888