Merge pull request #345 from oracle/release_0.11.0

Release 0.11.0

Author: ankitkumr10

Dockerfile

@@ -35,3 +35,5 @@ COPY --from=0 /go/src/github.com/oracle/oci-cloud-controller-manager/image/* /us
 RUN yum install -y util-linux \
   && yum install -y e2fsprogs \
   && yum clean all
+
+COPY --from=0 /go/src/github.com/oracle/oci-cloud-controller-manager/dist/* /usr/local/bin/

README.md

@@ -24,9 +24,8 @@ cloud-provider specific code out of the Kubernetes codebase.
 
 |          | Kubernetes 1.16        | Kubernetes 1.17        | Kubernetes 1.18        |
 |----------|------------------------|------------------------|------------------------|
-| <=v 0.7  | ✗                      | ✗                      | ✗                       |
-| v 0.8    | ✓                      | ✓                      | ✓                      |
-| v 0.9    | ✓                      | ✓                      | ✓                      |
+| <=v 0.7  | ✗                      | ✗                      | ✗                      |
+| \>=v 0.8 | ✓                      | ✓                      | ✓                      |
 
 Key:
 

docs/load-balancer-annotations.md

@@ -23,7 +23,9 @@ spec:
 | Name                                        | Description                                                                                                                                                                                                                                        | Default                                          |
 | -----                                       | -----------                                                                                                                                                                                                                                        | -------                                          |
 | `oci-load-balancer-internal`                | Create an [internal load balancer][1]. Cannot be modified after load balancer creation.                                                                                                                                                            | `false`                                          |
-| `oci-load-balancer-shape`                   | A template that determines the load balancer's total pre-provisioned maximum capacity (bandwidth) for ingress plus egress traffic. Available shapes include `100Mbps`, `400Mbps`, and `8000Mbps.` Cannot be modified after load balancer creation. | `"100Mbps"`                                      |
+| `oci-load-balancer-shape`                   | A template that determines the load balancer's total pre-provisioned capacity (bandwidth) for ingress plus egress traffic. Available shapes include `100Mbps`, `400Mbps`, `8000Mbps` and `flexible`. Use `oci lb shape list` to get the list of shapes supported on your account | `"100Mbps"`                                      |
+| `oci-load-balancer-shape-flex-min`                   | A template that determines the load balancer's minimum pre-provisioned capacity (bandwidth) for ingress plus egress traffic. Only used when `oci-load-balancer-shape` is set to `flexible`  | `N/A`                                      |
+| `oci-load-balancer-shape-flex-max`                   | A template that determines the load balancer's maximum pre-provisioned capacity (bandwidth) for ingress plus egress traffic. Only used when `oci-load-balancer-shape` is set to `flexible`  | `N/A`                                      |
 | `oci-load-balancer-subnet1`                 | The OCID of the one required regional subnet to attach the load balancer to OR The OCID of the first [subnet][2] of the two required Availability Domain specific subnets to attach the load balancer to. Must be in separate Availability Domains.                                                               | Value provided in config file                    |
 | `oci-load-balancer-subnet2`                 | The OCID of the second [subnet][2] of the two required subnets to attach the load balancer to. Must be in separate Availability Domains.                                                            | Value provided in config file                    |
 | `oci-load-balancer-health-check-retries`    | The number of retries to attempt before a backend server is considered "unhealthy".                                                                                                                                                                | `3`                                              |

go.mod

@@ -57,13 +57,12 @@ require (
 	github.com/onsi/ginkgo v1.8.0
 	github.com/onsi/gomega v1.5.0
 	github.com/opencontainers/go-digest v1.0.0-rc1 // indirect
-	github.com/oracle/oci-go-sdk v0.0.0-00000000000000-857a54193bc062afe3933d02b38e3fe9d158f744
+	github.com/oracle/oci-go-sdk/v31 v31.0.0
 	github.com/pkg/errors v0.8.0
 	github.com/prometheus/client_golang v0.9.2
 	github.com/spf13/cobra v0.0.5 // indirect
 	github.com/spf13/pflag v1.0.3
 	github.com/spf13/viper v1.3.2
-	github.com/stretchr/testify v1.4.0 // indirect
 	go.uber.org/atomic v1.3.2 // indirect
 	go.uber.org/zap v1.9.1
 	golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297

go.sum

@@ -273,6 +273,8 @@ github.com/opencontainers/runtime-spec v1.0.0/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/
 github.com/opencontainers/selinux v0.0.0-20170621221121-4a2974bf1ee9/go.mod h1:+BLncwf63G4dgOzykXAxcmnFlUaOlkDdmw/CqsW6pjs=
 github.com/oracle/oci-go-sdk v0.0.0-00000000000000-857a54193bc062afe3933d02b38e3fe9d158f744 h1:AqDL016+OkmPfrT8PkE/tmgLOj+8ljCs+Gktx5ZHtjs=
 github.com/oracle/oci-go-sdk v0.0.0-00000000000000-857a54193bc062afe3933d02b38e3fe9d158f744/go.mod h1:VQb79nF8Z2cwLkLS35ukwStZIg5F66tcBccjip/j888=
+github.com/oracle/oci-go-sdk/v31 v31.0.0 h1:LEstCAlSNcuuPIRUMLuX3UF+V3ID2B1LN4k9Dvbd5tM=
+github.com/oracle/oci-go-sdk/v31 v31.0.0/go.mod h1:4MlbGGDlqigjplvUfbVecEqNCN2cYZbdJ8PpAMVAQkw=
 github.com/pborman/uuid v1.2.0 h1:J7Q5mO4ysT1dv8hyrUGHb9+ooztCXu1D8MY8DZYsu3g=
 github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtPdI/k=
 github.com/pelletier/go-toml v1.0.1/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
@@ -338,6 +340,8 @@ github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXf
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/syndtr/gocapability v0.0.0-20160928074757-e7cb7fa329f4/go.mod h1:hkRG7XYTFWNJGYcbNJQlaLq0fg1yr4J4t/NcTQtrfww=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20170815181823-89b8d40f7ca8 h1:ndzgwNDnKIqyCvHTXaCqh9KlOWKvBry6nuXMJmonVsE=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20170815181823-89b8d40f7ca8/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
@@ -467,6 +471,8 @@ gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0/go.mod h1:WDnlLJ4WF5VGsH/HVa
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
 gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

hack/run_e2e_test.sh

@@ -39,6 +39,7 @@ function run_e2e_tests_existing_cluster() {
         --adlocation=${ADLOCATION} \
         --delete-namespace=${DELETE_NAMESPACE} \
         --image-pull-repo=${IMAGE_PULL_REPO} \
+        --cmek-kms-key=${CMEK_KMS_KEY} \
     retval=$?
     exit $retval
 }

pkg/cloudprovider/providers/oci/ccm.go

@@ -22,11 +22,6 @@ import (
 	"io"
 	"time"
 
-	"github.com/oracle/oci-go-sdk/core"
-
-	providercfg "github.com/oracle/oci-cloud-controller-manager/pkg/cloudprovider/providers/oci/config"
-	"github.com/oracle/oci-cloud-controller-manager/pkg/oci/client"
-	"github.com/oracle/oci-cloud-controller-manager/pkg/oci/instance/metadata"
 	"github.com/pkg/errors"
 	"go.uber.org/zap"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
@@ -36,6 +31,12 @@ import (
 	listersv1 "k8s.io/client-go/listers/core/v1"
 	"k8s.io/client-go/tools/cache"
 	cloudprovider "k8s.io/cloud-provider"
+
+	providercfg "github.com/oracle/oci-cloud-controller-manager/pkg/cloudprovider/providers/oci/config"
+	"github.com/oracle/oci-cloud-controller-manager/pkg/metrics"
+	"github.com/oracle/oci-cloud-controller-manager/pkg/oci/client"
+	"github.com/oracle/oci-cloud-controller-manager/pkg/oci/instance/metadata"
+	"github.com/oracle/oci-go-sdk/v31/core"
 )
 
 const (
@@ -66,6 +67,7 @@ type CloudProvider struct {
 
 	logger        *zap.SugaredLogger
 	instanceCache cache.Store
+	metricPusher  *metrics.MetricPusher
 }
 
 // Compile time check that CloudProvider implements the cloudprovider.Interface
@@ -109,11 +111,25 @@ func NewCloudProvider(config *providercfg.Config) (cloudprovider.Interface, erro
 		config.VCNID = *subnet.VcnId
 	}
 
+	metricPusher, err := metrics.NewMetricPusher(logger.Sugar())
+	if err != nil {
+		logger.Sugar().With("error", err).Error("Metrics collection could not be enabled")
+		// disable metrics
+		metricPusher = nil
+	}
+
+	if metricPusher != nil {
+		logger.Info("Metrics collection has been enabled")
+	} else {
+		logger.Info("Metrics collection has not been enabled")
+	}
+
 	return &CloudProvider{
 		client:        c,
 		config:        config,
 		logger:        logger.Sugar(),
 		instanceCache: cache.NewTTLStore(instanceCacheKeyFn, time.Duration(24)*time.Hour),
+		metricPusher:  metricPusher,
 	}, nil
 }
 

pkg/cloudprovider/providers/oci/config/config.go

@@ -19,8 +19,8 @@ import (
 	"io"
 	"os"
 
-	"github.com/oracle/oci-go-sdk/common"
-	"github.com/oracle/oci-go-sdk/common/auth"
+	"github.com/oracle/oci-go-sdk/v31/common"
+	"github.com/oracle/oci-go-sdk/v31/common/auth"
 	"github.com/pkg/errors"
 
 	"go.uber.org/zap"
@@ -103,12 +103,26 @@ type RateLimiterConfig struct {
 	DisableRateLimiter   bool    `yaml:"disableRateLimiter"`
 }
 
+// MetricsConfig holds the configuration for collection metrics
+// which are pushed to OCI Monitoring. More details present at
+// https://docs.cloud.oracle.com/en-us/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm
+type MetricsConfig struct {
+	CompartmentID string `yaml:"compartmentID"`
+	Namespace     string `yaml:"namespace"`
+	ResourceGroup string `yaml:"resourceGroup"`
+	// +optional
+	// This prefix is added to all the metric names
+	Prefix string `yaml:"prefix"`
+}
+
 // Config holds the OCI cloud-provider config passed to Kubernetes components
 // via the --cloud-config option.
 type Config struct {
 	Auth         AuthConfig          `yaml:"auth"`
 	LoadBalancer *LoadBalancerConfig `yaml:"loadBalancer"`
 	RateLimiter  *RateLimiterConfig  `yaml:"rateLimiter"`
+	// Metrics collection is enabled when this configuration is provided
+	Metrics *MetricsConfig `yaml:"metrics"`
 
 	RegionKey string `yaml:"regionKey"`
 

pkg/cloudprovider/providers/oci/config/config_validate.go

@@ -82,5 +82,21 @@ func ValidateConfig(c *Config) field.ErrorList {
 	if c.LoadBalancer != nil && !c.LoadBalancer.Disabled {
 		allErrs = append(allErrs, validateLoadBalancerConfig(c, field.NewPath("loadBalancer"))...)
 	}
+
+	// Validate metric config if the metrics block is not empty
+	if c.Metrics != nil {
+		if len(c.Metrics.CompartmentID) == 0 {
+			// The compartment is required for pushing metrics to OCI Monitoring
+			allErrs = append(allErrs, field.Required(field.NewPath("metrics", "compartment"), "Compartment is required for pushing custom metrics"))
+		}
+
+		if len(c.Metrics.Namespace) == 0 {
+			allErrs = append(allErrs, field.Required(field.NewPath("metrics", "namespace"), "Metric namespace is required for pushing custom metrics"))
+		}
+
+		if len(c.Metrics.ResourceGroup) == 0 {
+			allErrs = append(allErrs, field.Required(field.NewPath("metrics", "resourceGroup"), "Metric resource group is required for pushing custom metrics"))
+		}
+	}
 	return allErrs
 }

pkg/cloudprovider/providers/oci/config/config_validate_test.go

@@ -264,6 +264,76 @@ func TestValidateConfig(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "valid config for Auth, LB and metrics",
+			in: &Config{
+				metadataSvc: metadata.NewErrorMock(),
+				Auth: AuthConfig{
+					metadataSvc:   metadata.NewErrorMock(),
+					Region:        "us-phoenix-1",
+					TenancyID:     "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					CompartmentID: "ocid1.compartment.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					UserID:        "ocid1.user.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					PrivateKey:    "-----BEGIN RSA PRIVATE KEY----- (etc)",
+					Fingerprint:   "8c:bf:17:7b:5f:e0:7d:13:75:11:d6:39:0d:e2:84:74",
+				},
+				LoadBalancer: &LoadBalancerConfig{
+					Subnet1: "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					Subnet2: "ocid1.subnet.oc1.phx.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+				},
+				Metrics: &MetricsConfig{
+					CompartmentID: "ocid1.compartment.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					Namespace:     "test",
+					ResourceGroup: "test-rg",
+					Prefix:        "Prefix.",
+				},
+			},
+			errs: field.ErrorList{},
+		}, {
+			name: "valid config for Auth, LB and invalid config for metrics",
+			in: &Config{
+				metadataSvc: metadata.NewErrorMock(),
+				Auth: AuthConfig{
+					metadataSvc:   metadata.NewErrorMock(),
+					Region:        "us-phoenix-1",
+					TenancyID:     "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					CompartmentID: "ocid1.compartment.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					UserID:        "ocid1.user.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					PrivateKey:    "-----BEGIN RSA PRIVATE KEY----- (etc)",
+					Fingerprint:   "8c:bf:17:7b:5f:e0:7d:13:75:11:d6:39:0d:e2:84:74",
+				},
+				LoadBalancer: &LoadBalancerConfig{
+					Subnet1: "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+					Subnet2: "ocid1.subnet.oc1.phx.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+				},
+				Metrics: &MetricsConfig{
+					CompartmentID: "",
+					Namespace:     "",
+					ResourceGroup: "",
+					Prefix:        "Prefix.",
+				},
+			},
+			errs: field.ErrorList{
+				&field.Error{
+					Type:     field.ErrorTypeRequired,
+					Field:    "metrics.compartment",
+					BadValue: "",
+					Detail:   "Compartment is required for pushing custom metrics",
+				},
+				&field.Error{
+					Type:     field.ErrorTypeRequired,
+					Field:    "metrics.namespace",
+					BadValue: "",
+					Detail:   "Metric namespace is required for pushing custom metrics",
+				},
+				&field.Error{
+					Type:     field.ErrorTypeRequired,
+					Field:    "metrics.resourceGroup",
+					BadValue: "",
+					Detail:   "Metric resource group is required for pushing custom metrics",
+				},
+			},
+		},
 	}
 
 	for _, tt := range testCases {

pkg/cloudprovider/providers/oci/instances.go

@@ -19,7 +19,7 @@ import (
 	"fmt"
 	"net"
 
-	"github.com/oracle/oci-go-sdk/core"
+	"github.com/oracle/oci-go-sdk/v31/core"
 	"k8s.io/apimachinery/pkg/labels"
 
 	"github.com/oracle/oci-cloud-controller-manager/pkg/oci/client"
@@ -162,7 +162,7 @@ func (cp *CloudProvider) InstanceID(ctx context.Context, nodeName types.NodeName
 	name := mapNodeNameToInstanceName(nodeName)
 	compartmentID, err := cp.getCompartmentIDByNodeName(name)
 	if err != nil {
-		if  cp.config.CompartmentID != "" {
+		if cp.config.CompartmentID != "" {
 			compartmentID = cp.config.CompartmentID
 		} else {
 			return "", errors.Wrap(err, "error getting CompartmentID from Node Name")