Export CustomMetricsClient and NodeSorableMetric

- Exported func NewClient returns unexported type metrics.
customMetricsClient.
- Exported func OrderedList returns unexported type []core.nodeSort
ableMetric. Then, NodeSorableMetric type exported.
- Comment type change accordingly.

Author: togashidm

pkg/metrics/client.go

@@ -1,4 +1,4 @@
-//Provides instruments to read and cache Node Metrics from the custom metrics API.
+//Package metrics instruments to read and cache Node Metrics from the custom metrics API.
 package metrics
 
 import (
@@ -31,24 +31,24 @@ type NodeMetric struct {
 //NodeMetricsInfo holds a map of metric information related to a single named metric. The key for the map is the name of the node.
 type NodeMetricsInfo map[string]NodeMetric
 
-//customMetrics client embeds a client for the custom Metrics API
-type customMetricsClient struct {
+//CustomMetricsClient embeds a client for the custom Metrics API
+type CustomMetricsClient struct {
 	customclient.CustomMetricsClient
 }
 
 //NewClient creates a new Metrics Client including discovering and mapping the available APIs, and pulling the API version.
-func NewClient(config *restclient.Config) customMetricsClient {
+func NewClient(config *restclient.Config) CustomMetricsClient {
 	discoveryClient := discovery.NewDiscoveryClientForConfigOrDie(config)
 	cachedDiscoveryClient := cacheddiscovery.NewMemCacheClient(discoveryClient)
 	restMapper := restmapper.NewDeferredDiscoveryRESTMapper(cachedDiscoveryClient)
 	restMapper.Reset()
 	apiVersionsGetter := customclient.NewAvailableAPIsGetter(discoveryClient)
-	metricsClient := customMetricsClient{customclient.NewForConfig(config, restMapper, apiVersionsGetter)}
+	metricsClient := CustomMetricsClient{customclient.NewForConfig(config, restMapper, apiVersionsGetter)}
 	return metricsClient
 }
 
 //GetNodeMetric gets the given metric, time Window for Metric and timestamp for each node in the cluster.
-func (c customMetricsClient) GetNodeMetric(metricName string) (NodeMetricsInfo, error) {
+func (c CustomMetricsClient) GetNodeMetric(metricName string) (NodeMetricsInfo, error) {
 	metrics, err := c.RootScopedMetrics().GetForObjects(schema.GroupKind{Kind: "Node"}, labels.NewSelector(), metricName, labels.NewSelector())
 	if err != nil {
 		return nil, errors.New("unable to fetch metrics from custom metrics API: " + err.Error())

pkg/strategies/core/operator.go

@@ -23,12 +23,12 @@ func EvaluateRule(value resource.Quantity, rule telempol.TASPolicyRule) bool {
 	}
 	return operators[rule.Operator](value, rule.Target)
 }
-
+//OrderedList will return a list of nodes ordered by their linked metric and operator
 //TODO: Make this method more generic so it can use objects other than nodes.
-func OrderedList(metricsInfo metrics.NodeMetricsInfo, operator string) []nodeSortableMetric {
-	mtrcs := []nodeSortableMetric{}
+func OrderedList(metricsInfo metrics.NodeMetricsInfo, operator string) []NodeSortableMetric {
+	mtrcs := []NodeSortableMetric{}
 	for name, info := range metricsInfo {
-		mtrcs = append(mtrcs, nodeSortableMetric{name, info.Value})
+		mtrcs = append(mtrcs, NodeSortableMetric{name, info.Value})
 	}
 	switch operator {
 	case "GreaterThan":
@@ -39,9 +39,9 @@ func OrderedList(metricsInfo metrics.NodeMetricsInfo, operator string) []nodeSor
 	return mtrcs
 }
 
-//This type is necessary in order to call the sort.Slice method.
+//NodeSortableMetric type is necessary in order to call the sort.Slice method.
 //Note lack of usage of time windows or stamps.
-type nodeSortableMetric struct {
+type NodeSortableMetric struct {
 	NodeName    string
 	MetricValue resource.Quantity
 }