Azure / aks-app-routing-operator

Kubernetes operator that implements AKS Application Routing
https://learn.microsoft.com/en-us/azure/aks/app-routing
MIT License
32 stars 23 forks source link

add prometheus annotations to Ingress controllers #46

Closed OliverMKing closed 1 year ago

OliverMKing commented 1 year ago

Description

This allows users to easily consume web app routing nginx-ingress prometheus metrics. It follows the guidance in the nginx docs.

E2e tests prove a user-created prometheus instance can connect to the web app routing nginx-ingress controller metrics. There are no failure scenarios to test. The failure scenario is a user-created prometheus instance is unable to connect to the ingress controller metric which will be caught by this test if it is true. A misconfigured prometheus instance would be a customer issue, not a problem with web app routing. There are no failure cases that web app routing can handle itself because this functionality is completely dependent on customer prometheus.

You can see local e2e tests passing. image

It won't disrupt or change the experience for users not using Prometheus in any way.

Type of change

Please delete options that are not relevant.

We should document this feature on our next release with examples.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. Is it a breaking change which will impact consuming tool(s)?

Checklist:

OliverMKing commented 1 year ago

Please add to the description of the PR how the new prom test integrate with existing tests and the failure scenarios covered. It would also be helpful, if possible, to see successful E2E runs from a local environment. Otherwise, nice PR!

Updated the description