Add --opencost flag to setup standard OpenCost configuration
#173
Conversation
This file contains hidden or 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
michaelmdresser
approved these changes
Jul 9, 2024
Contributor
michaelmdresser
left a comment
michaelmdresser
left a comment
There was a problem hiding this comment.
I no longer work at Kubecost, but this is how I would have done it. LGTM.
Comment on lines
+64
to
+69
| if o.OpenCost { | ||
| o.ServiceName = OpenCostServiceName | ||
| o.KubecostNamespace = OpenCostServiceNamespace | ||
| o.ServicePort = OpenCostServicePort | ||
| o.AllocationPath = OpenCostAllocationPath | ||
| } |
Contributor
There was a problem hiding this comment.
Nicely done, I appreciate that the opencost defaults first, and then additional flags can override field-by-field.
pkg/query/options.go
Outdated
| cmd.Flags().BoolVar(&options.UseProxy, "use-proxy", false, "Instead of temporarily port-forwarding, proxy a request to Kubecost through the Kubernetes API server.") | ||
| cmd.Flags().StringVar(&options.AllocationPath, "allocation-path", "/model/allocation", "URL path at which Allocation queries can be served from the configured service. If using OpenCost, you may want to set this to '/allocation/compute'") | ||
| cmd.Flags().StringVar(&options.PredictSpecCostPath, "predict-speccost-path", "/model/prediction/speccost", "URL path at which Prediction queries can be served from the configured service.") | ||
| cmd.Flags().BoolVar(&options.OpenCost, "opencost", false, " Set true to configure Kubecost parameters according to the OpenCost default specification.") |
Contributor
There was a problem hiding this comment.
It might be worth calling out the defaulting behavior in the help text.
Contributor
Author
There was a problem hiding this comment.
I initially thought it would be a little too verbose, but it will indeed make things clearer. I will commit the changes as soon as I get the chance. Thanks for the review!
thomasvn
approved these changes
Jul 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
What does this PR change?
This Pull Request adds the
--opencostflag to the cost command to setup standard OpenCost configuration. It is essentially an alias for the following flags:--service-port 9003 --service-name opencost --kubecost-namespace opencost --allocation-path /allocation/computeDoes this PR rely on any other PRs?
N/A
How does this PR impact users? (This is the kind of thing that goes in release notes!)
The user will have the possibility to easily set OpenCost as the target service to the
kubectl costcommand by simply setting the--opencostinstead of configuring the OpenCost default settings flag-by-flag.Links to Issues or ZD tickets this PR addresses or fixes
--opencostflag to specify standard OpenCost settings #156How was this PR tested?
This Pull Request was tested in an Oracle Kubernetes Engine (OKE)-based Kubernetes cluster configured with OpenCost and identical behaviour with providing the following flags was asserted:
--service-port 9003 --service-name opencost --kubecost-namespace opencost --allocation-path /allocation/computeHave you made an update to documentation?
An update was made in the README.md file.