Merge pull request #143 from kubecost/mmd/use-new-spec-predict

Switch 'kubectl cost predict' to use /prediction/speccost

Author: michaelmdresser

README.md

@@ -15,11 +15,11 @@ of any Kubernetes workload.
 now with `kubectl cost predict -f your-deployment.yaml`:
 
 ```
-+-------------------------------------+-----+-----+-----+------------+-----------+----------+-----------+-----------+------------+
-| WORKLOAD                            | CPU | MEM | GPU | CPU/MO     | MEM/MO    | GPU/MO   | Δ CPU/MO  | Δ MEM/MO  | TOTAL/MO   |
-+-------------------------------------+-----+-----+-----+------------+-----------+----------+-----------+-----------+------------+
-| default/Deployment/test1-deployment | 9   | 6Gi | 0   | 207.68 USD | 18.56 USD | 0.00 USD | 38.30 USD | 11.51 USD | 226.24 USD |
-+-------------------------------------+-----+-----+-----+------------+-----------+----------+-----------+-----------+------------+
++-------------------------------------+------------+-----------+----------+------------+
+| WORKLOAD                            | Δ CPU/MO   | Δ MEM/MO  | Δ GPU/MO | Δ TOTAL/MO |
++-------------------------------------+------------+-----------+----------+------------+
+| default/deployment/test1-deployment | 209.47 USD | 18.72 USD | 0.00 USD | 228.19 USD |
++-------------------------------------+------------+-----------+----------+------------+
 ```
 
 
@@ -145,11 +145,11 @@ echo "$DEF" | kubectl cost predict -f -
 ```
 Example output:
 ```
-+-------------------------------------+-----+-----+-----+------------+-----------+----------+-----------+-----------+------------+
-| WORKLOAD                            | CPU | MEM | GPU | CPU/MO     | MEM/MO    | GPU/MO   | Δ CPU/MO  | Δ MEM/MO  | TOTAL/MO   |
-+-------------------------------------+-----+-----+-----+------------+-----------+----------+-----------+-----------+------------+
-| default/Deployment/nginx-deployment | 9   | 6Gi | 0   | 207.68 USD | 18.56 USD | 0.00 USD | 38.30 USD | 11.51 USD | 226.24 USD |
-+-------------------------------------+-----+-----+-----+------------+-----------+----------+-----------+-----------+------------+
++---------------------------------------+------------+-----------+----------+------------+
+| WORKLOAD                              | Δ CPU/MO   | Δ MEM/MO  | Δ GPU/MO | Δ TOTAL/MO |
++---------------------------------------+------------+-----------+----------+------------+
+| michaelkc/deployment/nginx-deployment | 209.47 USD | 18.72 USD | 0.00 USD | 228.18 USD |
++---------------------------------------+------------+-----------+----------+------------+
 ```
 
 Show how much each namespace cost over the past 5 days
@@ -253,17 +253,19 @@ subcommand has its own set of flags for adjusting query behavior and output.
 There are several flags that modify the behavior of queries to the backing
 Kubecost/OpenCost APIs:
 ```
-    -r, --release-name string                 The name of the Helm release, used to template service names if they are unset. For example, if Kubecost is installed with 'helm install kubecost2 kubecost/cost-analyzer', then this should be set to 'kubecost2'. (default "kubecost")
-    --service-name string                 The name of the Kubecost cost analyzer service. By default, it is derived from the Helm release name and should not need to be overridden.
-    --service-port int               The port of the service at which the APIs are running. If using OpenCost, you may want to set this to 9003. (default 9090)
-    -N, --kubecost-namespace string           The namespace that Kubecost is deployed in. Requests to the API will be directed to this namespace. Defaults to the Helm release name.
+    -r, --release-name string         The name of the Helm release, used to template service names if they are unset. For example, if Kubecost is installed with 'helm install kubecost2 kubecost/cost-analyzer', then this should be set to 'kubecost2'. (default "kubecost")
+    --service-name string             The name of the Kubecost cost analyzer service. By default, it is derived from the Helm release name and should not need to be overridden.
+    --service-port int                The port of the service at which the APIs are running. If using OpenCost, you may want to set this to 9003. (default 9090)
+    -N, --kubecost-namespace string   The namespace that Kubecost is deployed in. Requests to the API will be directed to this namespace. Defaults to the Helm release name.
 
-    --use-proxy                   Instead of temporarily port-forwarding, proxy a request to Kubecost through the Kubernetes API server.
+    --use-proxy                       Instead of temporarily port-forwarding, proxy a request to Kubecost through the Kubernetes API server.
 
-    --allocation-path string         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' (default "/model/allocation")
-    --predict-resource-cost-path string   URL path at which Resource Cost Prediction queries can be served from the configured service. (default "/model/prediction/resourcecost")
-    --predict-resource-cost-diff-path string   URL path at which Resource Cost Prediction diff queries can be served from the configured service. (default "/model/prediction/resourcecostdiff")
-    --no-diff                                  Set true to not attempt a cost difference with a matching in-cluster workload, if one can be found.
+    --allocation-path string          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' (default "/model/allocation")
+
+    --predict-speccost-path string    URL path at which Prediction queries can be served from the configured service. (default "/model/prediction/speccost")
+    --no-usage                        Set true ignore historical usage data (if any exists) when performing cost prediction.
+    --only-after                      Set true to only show the overall predicted cost of the workload.
+    --only-diff                       Set true to only show the cost difference (cost "impact") instead of the overall cost plus diff. (default true)
 ```
 
 

pkg/cmd/aggregatedcommandbuilder.go

@@ -9,13 +9,20 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/kubecost/kubectl-cost/pkg/cmd/display"
+	"github.com/kubecost/kubectl-cost/pkg/cmd/utilities"
 	"github.com/kubecost/kubectl-cost/pkg/query"
 	"github.com/opencost/opencost/pkg/log"
 )
 
+type AggregatedAllocationOptions struct {
+	CostOptions
+	display.AllocationDisplayOptions
+}
+
 func buildStandardAggregatedAllocationCommand(streams genericclioptions.IOStreams, commandName string, commandAliases []string, aggregation []string, enableNamespaceFilter bool) *cobra.Command {
-	kubeO := NewKubeOptions(streams)
-	costO := CostOptions{}
+	kubeO := utilities.NewKubeOptions(streams)
+	o := AggregatedAllocationOptions{}
 
 	cmd := &cobra.Command{
 		Use:     commandName,
@@ -29,33 +36,34 @@ func buildStandardAggregatedAllocationCommand(streams genericclioptions.IOStream
 				return err
 			}
 
-			if err := costO.Complete(kubeO.restConfig); err != nil {
+			if err := o.CostOptions.Complete(kubeO.RestConfig); err != nil {
 				return fmt.Errorf("completing options: %s", err)
 			}
-			if err := costO.Validate(); err != nil {
+			if err := o.CostOptions.Validate(); err != nil {
 				return err
 			}
 
-			return runAggregatedAllocationCommand(kubeO, costO, aggregation)
+			return runAggregatedAllocationCommand(kubeO, o, aggregation)
 		},
 	}
 
 	// TODO: Replace entirely when we have generic filter language (v2)
 	if enableNamespaceFilter {
-		cmd.Flags().StringVarP(&costO.filterNamespace, "namespace", "n", "", "Limit results to only one namespace. Defaults to all namespaces.")
+		cmd.Flags().StringVarP(&o.CostOptions.filterNamespace, "namespace", "n", "", "Limit results to only one namespace. Defaults to all namespaces.")
 	}
 
-	addCostOptionsFlags(cmd, &costO)
-	addKubeOptionsFlags(cmd, kubeO)
+	addCostOptionsFlags(cmd, &o.CostOptions)
+	display.AddAllocationDisplayOptionsFlags(cmd, &o.AllocationDisplayOptions)
+	utilities.AddKubeOptionsFlags(cmd, kubeO)
 
 	return cmd
 }
 
-func runAggregatedAllocationCommand(ko *KubeOptions, co CostOptions, aggregation []string) error {
+func runAggregatedAllocationCommand(ko *utilities.KubeOptions, o AggregatedAllocationOptions, aggregation []string) error {
 
 	currencyCode, err := query.QueryCurrencyCode(query.CurrencyCodeParameters{
 		Ctx:                 context.Background(),
-		QueryBackendOptions: co.QueryBackendOptions,
+		QueryBackendOptions: o.QueryBackendOptions,
 	})
 	if err != nil {
 		log.Debugf("failed to get currency code, displaying as empty string: %s", err)
@@ -65,18 +73,18 @@ func runAggregatedAllocationCommand(ko *KubeOptions, co CostOptions, aggregation
 	allocations, err := query.QueryAllocation(query.AllocationParameters{
 		Ctx: context.Background(),
 		QueryParams: map[string]string{
-			"window":           co.window,
+			"window":           o.window,
 			"aggregate":        strings.Join(aggregation, ","),
 			"accumulate":       "true",
-			"filterNamespaces": co.filterNamespace,
+			"filterNamespaces": o.filterNamespace,
 		},
-		QueryBackendOptions: co.QueryBackendOptions,
+		QueryBackendOptions: o.QueryBackendOptions,
 	})
 	if err != nil {
 		return fmt.Errorf("failed to query allocation API: %s", err)
 	}
 
-	writeAllocationTable(ko.Out, aggregation, allocations[0], co.displayOptions, currencyCode, !co.isHistorical)
+	display.WriteAllocationTable(ko.Out, aggregation, allocations[0], o.AllocationDisplayOptions, currencyCode, !o.isHistorical)
 
 	return nil
 }

pkg/cmd/common.go

@@ -2,10 +2,8 @@ package cmd
 
 import (
 	"fmt"
-	"strings"
 
 	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
 	"k8s.io/client-go/rest"
 
 	"github.com/kubecost/kubectl-cost/pkg/query"
@@ -19,97 +17,18 @@ type CostOptions struct {
 	filterNamespace string
 
 	isHistorical bool
-	showAll      bool
 
-	displayOptions
 	query.QueryBackendOptions
 }
 
-const (
-	envPrefix = "KUBECTL_COST"
-)
-
-// With the addition of commands which query the assets API,
-// some of these don't apply to all commands. However, as they
-// are applied during the output, this shouldn't cause issues.
-type displayOptions struct {
-	showCPUCost          bool
-	showMemoryCost       bool
-	showGPUCost          bool
-	showPVCost           bool
-	showNetworkCost      bool
-	showEfficiency       bool
-	showSharedCost       bool
-	showLoadBalancerCost bool
-	showAssetType        bool
-}
-
 func addCostOptionsFlags(cmd *cobra.Command, options *CostOptions) {
 	cmd.Flags().StringVar(&options.window, "window", "1d", "The window of data to query. See https://github.com/kubecost/docs/blob/master/allocation.md#querying for a detailed explanation of what can be passed here.")
 	cmd.Flags().BoolVar(&options.isHistorical, "historical", false, "show the total cost during the window instead of the projected monthly rate based on the data in the window")
-	cmd.Flags().BoolVar(&options.showCPUCost, "show-cpu", false, "show data for CPU cost")
-	cmd.Flags().BoolVar(&options.showMemoryCost, "show-memory", false, "show data for memory cost")
-	cmd.Flags().BoolVar(&options.showGPUCost, "show-gpu", false, "show data for GPU cost")
-	cmd.Flags().BoolVar(&options.showPVCost, "show-pv", false, "show data for PV (physical volume) cost")
-	cmd.Flags().BoolVar(&options.showNetworkCost, "show-network", false, "show data for network cost")
-	cmd.Flags().BoolVar(&options.showSharedCost, "show-shared", false, "show shared cost data")
-	cmd.Flags().BoolVar(&options.showLoadBalancerCost, "show-lb", false, "show load balancer cost data")
-	cmd.Flags().BoolVar(&options.showEfficiency, "show-efficiency", true, "show efficiency of cost alongside CPU and memory cost")
-	cmd.Flags().BoolVar(&options.showAssetType, "show-asset-type", false, "show type of assets displayed.")
-	cmd.Flags().BoolVarP(&options.showAll, "show-all-resources", "A", false, "Equivalent to --show-cpu --show-memory --show-gpu --show-pv --show-network --show-efficiency for namespace, deployment, controller, lable and pod OR --show-type --show-cpu --show-memory for node.")
-
-	addQueryBackendOptionsFlags(cmd, &options.QueryBackendOptions)
-}
-
-func addQueryBackendOptionsFlags(cmd *cobra.Command, options *query.QueryBackendOptions) {
-	cmd.Flags().StringVarP(&options.HelmReleaseName, "release-name", "r", "kubecost", "The name of the Helm release, used to template service names if they are unset. For example, if Kubecost is installed with 'helm install kubecost2 kubecost/cost-analyzer', then this should be set to 'kubecost2'.")
-	cmd.Flags().StringVarP(&options.KubecostNamespace, "kubecost-namespace", "N", "", "The namespace that Kubecost is deployed in. Requests to the API will be directed to this namespace. Defaults to the Helm release name.")
-
-	cmd.Flags().IntVar(&options.ServicePort, "service-port", 9090, "The port of the service at which the APIs are running. If using OpenCost, you may want to set this to 9003.")
-	cmd.Flags().StringVar(&options.ServiceName, "service-name", "", "The name of the Kubecost cost analyzer service. By default, it is derived from the Helm release name and should not need to be overridden.")
-	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.PredictResourceCostPath, "predict-resource-cost-path", "/model/prediction/resourcecost", "URL path at which Resource Cost Prediction queries can be served from the configured service.")
-	cmd.Flags().StringVar(&options.PredictResourceCostDiffPath, "predict-resource-cost-diff-path", "/model/prediction/resourcecostdiff", "URL path at which Resource Cost Prediction diff queries can be served from the configured service.")
 
-	//Check if environment variable KUBECTL_COST_USE_PROXY is set, it defaults to false
-	v := viper.New()
-	v.SetEnvPrefix(envPrefix)
-	v.AutomaticEnv()
-	bindAFlagToViperEnv(cmd, v, "use-proxy")
-}
-
-// addKubeOptionsFlags sets up the cobra command with the flags from
-// KubeOptions' configFlags so that a kube client can be built to a
-// user's specification. Its one modification is to change the name
-// of the namespace flag to kubecost-namespace because we want to
-// "behave as expected", i.e. --namespace affects the request to the
-// kubecost API, not the request to the k8s API.
-func addKubeOptionsFlags(cmd *cobra.Command, ko *KubeOptions) {
-	// By setting Namespace to nil, AddFlags won't create
-	// the --namespace flag, which we want to use for scoping
-	// kubecost requests (for some subcommands). We can then
-	// create a differently-named flag for the same variable.
-	ko.configFlags.Namespace = nil
-	ko.configFlags.AddFlags(cmd.Flags())
-
-	// Reset Namespace to a valid string to avoid a nil pointer
-	// deref.
-	// emptyStr := ""
-	// ko.configFlags.Namespace = &emptyStr
+	query.AddQueryBackendOptionsFlags(cmd, &options.QueryBackendOptions)
 }
 
 func (co *CostOptions) Complete(restConfig *rest.Config) error {
-	if co.showAll {
-		co.showCPUCost = true
-		co.showMemoryCost = true
-		co.showGPUCost = true
-		co.showPVCost = true
-		co.showNetworkCost = true
-		co.showSharedCost = true
-		co.showLoadBalancerCost = true
-		co.showAssetType = true
-	}
 	if err := co.QueryBackendOptions.Complete(restConfig); err != nil {
 		return fmt.Errorf("complete backend opts: %s", err)
 	}
@@ -129,15 +48,3 @@ func (co *CostOptions) Validate() error {
 
 	return nil
 }
-
-// Binds the flag with viper environment variable and ensures the order of precendence
-// command line > environment variable > default value
-func bindAFlagToViperEnv(cmd *cobra.Command, v *viper.Viper, flag string) {
-	flagPtr := cmd.Flags().Lookup(flag)
-	envVarSuffix := strings.ToUpper(strings.ReplaceAll(flagPtr.Name, "-", "_"))
-	v.BindEnv(flagPtr.Name, fmt.Sprintf("%s_%s", envPrefix, envVarSuffix))
-	if !flagPtr.Changed && v.IsSet(flagPtr.Name) {
-		val := v.Get(flagPtr.Name)
-		cmd.Flags().Set(flagPtr.Name, fmt.Sprintf("%v", val))
-	}
-}

pkg/cmd/cost.go

@@ -5,7 +5,6 @@ import (
 
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
-	"k8s.io/client-go/rest"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -79,31 +78,6 @@ var (
 	errNoContext = fmt.Errorf("no context is currently set, use %q to select a new one", "kubectl config use-context <context>")
 )
 
-// KubeOptions provides information required to communicate
-// with the Kubernetes API
-type KubeOptions struct {
-	configFlags *genericclioptions.ConfigFlags
-
-	restConfig *rest.Config
-	args       []string
-
-	// Namespace should be the currently-configured defaultNamespace of the client.
-	// This allows e.g. predict to fill in the defaultNamespace if one is not provided
-	// in the workload spec.
-	defaultNamespace string
-
-	genericclioptions.IOStreams
-}
-
-// NewCommonCostOptions creates the default set of cost options
-func NewKubeOptions(streams genericclioptions.IOStreams) *KubeOptions {
-	return &KubeOptions{
-		configFlags: genericclioptions.NewConfigFlags(true),
-
-		IOStreams: streams,
-	}
-}
-
 // NewCmdCost provides a cobra command that acts as a parent command
 // for all subcommands. It provides only basic usage information. See
 // common.go and the subcommands for the actual functionality.
@@ -186,32 +160,7 @@ helm install \
 	cmd.AddCommand(newCmdCostNode(streams))
 	cmd.AddCommand(newCmdTUI(streams))
 	cmd.AddCommand(newCmdVersion(streams, GitCommit, GitBranch, GitState, GitSummary, BuildDate))
-	cmd.AddCommand(newCmdPredict(streams))
+	cmd.AddCommand(NewCmdPredict(streams))
 
 	return cmd
 }
-
-// Complete sets all information required for getting cost information
-func (o *KubeOptions) Complete(cmd *cobra.Command, args []string) error {
-	o.args = args
-
-	var err error
-
-	o.restConfig, err = o.configFlags.ToRESTConfig()
-	if err != nil {
-		return fmt.Errorf("converting to REST config: %s", err)
-	}
-
-	o.defaultNamespace, _, err = o.configFlags.ToRawKubeConfigLoader().Namespace()
-	if err != nil {
-		return fmt.Errorf("retrieving default namespace: %s", err)
-	}
-
-	return nil
-}
-
-// Validate ensures that all required arguments and flag values are provided
-func (o *KubeOptions) Validate() error {
-
-	return nil
-}