Add OpenCost to the ClusterMetrics feature #923
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
petewall
force-pushed
the
feat/v2-cost
branch
2 times, most recently
from
c5af60a to
2042f40
Compare
Signed-off-by: Pete Wall <pete.wall@grafana.com>
petewall
force-pushed
the
feat/v2-cost
branch
from
2042f40 to
dd4e79d
Compare
petewall
commented
Nov 19, 2024
Comment on lines
+38
to
+47
| {{- if ne .Values.cluster.name .Values.clusterMetrics.opencost.opencost.exporter.defaultClusterId }} | ||
| {{- $msg := list "" "The OpenCost default cluster id should match the cluster name." }} | ||
| {{- $msg = append $msg "Please set:" }} | ||
| {{- $msg = append $msg "clusterMetrics:" }} | ||
| {{- $msg = append $msg " opencost:" }} | ||
| {{- $msg = append $msg " opencost:" }} | ||
| {{- $msg = append $msg " exporter:" }} | ||
| {{- $msg = append $msg (printf " defaultClusterId: %s" .Values.cluster.name) }} | ||
| {{- fail (join "\n" $msg) }} | ||
| {{- end -}} |
There was a problem hiding this comment.
Guides the user to set the default cluster id for OpenCost to the cluster name.
| {{- fail (join "\n" $msg) }} | ||
| {{- end -}} | ||
|
|
||
| {{- if ne .Values.clusterMetrics.opencost.metricsSource "custom" }} |
There was a problem hiding this comment.
Setting to custom will skip all other guidance and validation. This allows a user to set things that we don't expect, like alternative auth types.
Comment on lines
+50
to
+62
| {{- if eq .Values.clusterMetrics.opencost.metricsSource "" }} | ||
| {{- $msg := list "" "OpenCost requires linking to a Prometheus data source." }} | ||
| {{- $msg = append $msg "Please set:" }} | ||
| {{- $msg = append $msg "clusterMetrics:" }} | ||
| {{- $msg = append $msg " opencost:" }} | ||
| {{- if eq (len $destinations) 1 }} | ||
| {{- $msg = append $msg (printf " metricsSource: %s" (first $destinations)) }} | ||
| {{- else }} | ||
| {{- $msg = append $msg " metricsSource: <metrics destination name>" }} | ||
| {{- $msg = append $msg (printf "Where <metrics destination name> is one of %s" (include "english_list_or" $destinations)) }} | ||
| {{- end }} | ||
| {{- fail (join "\n" $msg) }} | ||
| {{- end -}} |
There was a problem hiding this comment.
Requiring a metricSource is how we tie the rest of the validations to a specific destination.
Comment on lines
+71
to
+79
| {{- if regexMatch "/api/prom/push" $destinationUrl }} | ||
| {{- $openCostMetricsUrl = (regexReplaceAll "^(.*)/api/prom/push$" $destinationUrl "${1}/api/prom") }} | ||
| {{- else if regexMatch "/api/v1/push" $destinationUrl }} | ||
| {{- $openCostMetricsUrl = (regexReplaceAll "^(.*)/api/v1/push$" $destinationUrl "${1}/api/v1/query") }} | ||
| {{- else if regexMatch "/api/v1/write" $destinationUrl }} | ||
| {{- $openCostMetricsUrl = (regexReplaceAll "^(.*)/api/v1/write$" $destinationUrl "${1}/api/v1/query") }} | ||
| {{- else }} | ||
| {{- $openCostMetricsUrl = (printf "<%s Query URL>" $destinationName)}} | ||
| {{- end }} |
There was a problem hiding this comment.
This is attempting to generate a query URL given the push url. The first is for Grafana Cloud, the second for Mimir, the third for OSS prometheus.
Comment on lines
+96
to
+120
| {{- if eq $secretType "embedded" }} | ||
| {{- $destinationUsername := include "secrets.getSecretValue" (dict "object" $destination "key" ".auth.username") }} | ||
| {{- if ne $.Values.clusterMetrics.opencost.opencost.prometheus.username $destinationUsername}} | ||
| {{- $msg := list "" (printf "The username for %s and OpenCost do not match." $destinationName) }} | ||
| {{- $msg = append $msg "Please set:" }} | ||
| {{- $msg = append $msg "clusterMetrics:" }} | ||
| {{- $msg = append $msg " opencost:" }} | ||
| {{- $msg = append $msg " opencost:" }} | ||
| {{- $msg = append $msg " prometheus:" }} | ||
| {{- $msg = append $msg (printf " username: %s" $destinationUsername) }} | ||
| {{- fail (join "\n" $msg) }} | ||
| {{- end }} | ||
|
|
||
| {{- $destinationPassword := include "secrets.getSecretValue" (dict "object" $destination "key" ".auth.password") }} | ||
| {{- if ne $.Values.clusterMetrics.opencost.opencost.prometheus.password_key $destinationPassword}} | ||
| {{- $msg := list "" (printf "The password for %s and OpenCost do not match." $destinationName) }} | ||
| {{- $msg = append $msg "Please set:" }} | ||
| {{- $msg = append $msg "clusterMetrics:" }} | ||
| {{- $msg = append $msg " opencost:" }} | ||
| {{- $msg = append $msg " opencost:" }} | ||
| {{- $msg = append $msg " prometheus:" }} | ||
| {{- $msg = append $msg (printf " password: %s" $destinationPassword) }} | ||
| {{- fail (join "\n" $msg) }} | ||
| {{- end }} | ||
| {{- else }} |
There was a problem hiding this comment.
If the creds are embedded, there is no secret, so set the username and password directly.
Comment on lines
+157
to
+166
| {{- else if ne $authType "none" }} | ||
| {{- $msg := list "" (printf "Unable to provide guidance for configuring OpenCost to use %s authentication for %s." $authType $destinationName) }} | ||
| {{- $msg = append $msg "Please set:" }} | ||
| {{- $msg = append $msg "clusterMetrics:" }} | ||
| {{- $msg = append $msg " opencost:" }} | ||
| {{- $msg = append $msg " metricsSource: custom" }} | ||
| {{- $msg = append $msg ("And configure %s authentication for %s using guidance from the OpenCost Helm chart.") }} | ||
| {{- $msg = append $msg "Documentation: https://github.com/opencost/opencost-helm-chart/tree/main/charts/opencost" }} | ||
| {{- fail (join "\n" $msg) }} | ||
| {{- end }} |
There was a problem hiding this comment.
If we're using anything other than none or basic, I'm not writing guidance for it. The user can look at the docs and figure it out. That's why we have the metricsSource: custom.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are a ton of guidance steps for setting the required fields for OpenCost.