Add failure domain labels to created PVs (#101)

Author: prydie

Makefile

@@ -30,6 +30,8 @@ DOCKER_REGISTRY_USERNAME ?= oracle
 IMAGE ?= $(REGISTRY)/$(DOCKER_REGISTRY_TENANCY)/$(BIN)
 TEST_IMAGE ?= $(REGISTRY)/$(DOCKER_REGISTRY_TENANCY)/$(BIN)-test
 
+OCI_SHORT_REGION ?= iad
+
 GOOS ?= linux
 GOARCH ?= amd64
 SRC_DIRS := cmd pkg # directories which hold app source (not vendored)
@@ -116,6 +118,6 @@ version:
 
 .PHONY: run-dev
 run-dev: build
-	NODE_NAME=localhost ./dist/oci-volume-provisioner \
+	NODE_NAME=localhost OCI_VOLUME_PROVISIONER_REGION=$(OCI_SHORT_REGION) ./dist/oci-volume-provisioner \
 		--kubeconfig=${KUBECONFIG} \
 		-v=4

pkg/provisioner/block/block.go

@@ -32,6 +32,8 @@ import (
 	"github.com/oracle/oci-go-sdk/identity"
 	"github.com/oracle/oci-volume-provisioner/pkg/oci/client"
 	"github.com/oracle/oci-volume-provisioner/pkg/provisioner/plugin"
+
+	"github.com/oracle/oci-volume-provisioner/pkg/oci/instancemeta"
 )
 
 const (
@@ -43,15 +45,17 @@ const (
 
 // blockProvisioner is the internal provisioner for OCI block volumes
 type blockProvisioner struct {
-	client client.ProvisionerClient
+	client   client.ProvisionerClient
+	metadata instancemeta.Interface
 }
 
 var _ plugin.ProvisionerPlugin = &blockProvisioner{}
 
 // NewBlockProvisioner creates a new instance of the block storage provisioner
-func NewBlockProvisioner(client client.ProvisionerClient) plugin.ProvisionerPlugin {
+func NewBlockProvisioner(client client.ProvisionerClient, metadata instancemeta.Interface) plugin.ProvisionerPlugin {
 	return &blockProvisioner{
-		client: client,
+		client:   client,
+		metadata: metadata,
 	}
 }
 
@@ -72,13 +76,10 @@ func roundUpSize(volumeSizeBytes int64, allocationUnitBytes int64) int64 {
 }
 
 // Provision creates an OCI block volume acording to the spec
-func (block *blockProvisioner) Provision(options controller.VolumeOptions,
-	availabilityDomain *identity.AvailabilityDomain) (*v1.PersistentVolume, error) {
+func (block *blockProvisioner) Provision(options controller.VolumeOptions, ad *identity.AvailabilityDomain) (*v1.PersistentVolume, error) {
 	for _, accessMode := range options.PVC.Spec.AccessModes {
 		if accessMode != v1.ReadWriteOnce {
-			return nil, fmt.Errorf("invalid access mode %v specified. Only %v is supported",
-				accessMode,
-				v1.ReadWriteOnce)
+			return nil, fmt.Errorf("invalid access mode %q specified (only %q is supported)", accessMode, v1.ReadWriteOnce)
 		}
 	}
 
@@ -88,10 +89,10 @@ func (block *blockProvisioner) Provision(options controller.VolumeOptions,
 	glog.Infof("Volume size (bytes): %v", volSizeBytes)
 	volSizeMB := int(roundUpSize(volSizeBytes, 1024*1024))
 
-	glog.Infof("Creating volume size=%v AD=%s compartmentOCID=%q", volSizeMB, *availabilityDomain.Name, block.client.CompartmentOCID())
+	glog.Infof("Creating volume size=%v AD=%s compartmentOCID=%q", volSizeMB, *ad.Name, block.client.CompartmentOCID())
 
 	volumeDetails := core.CreateVolumeDetails{
-		AvailabilityDomain: availabilityDomain.Name,
+		AvailabilityDomain: ad.Name,
 		CompartmentId:      common.String(block.client.CompartmentOCID()),
 		DisplayName:        common.String(fmt.Sprintf("%s%s", os.Getenv(volumePrefixEnvVarName), options.PVC.Name)),
 		SizeInMBs:          common.Int(volSizeMB),
@@ -119,13 +120,25 @@ func (block *blockProvisioner) Provision(options controller.VolumeOptions,
 	//volumeName := mapVolumeIDToName(*newVolume.Id)
 	filesystemType := resolveFSType(options)
 
+	region, ok := os.LookupEnv("OCI_SHORT_REGION")
+	if !ok {
+		metadata, err := block.metadata.Get()
+		if err != nil {
+			return nil, err
+		}
+		region = metadata.Region
+	}
+
 	pv := &v1.PersistentVolume{
 		ObjectMeta: metav1.ObjectMeta{
 			Name: *newVolume.Id,
 			Annotations: map[string]string{
 				ociVolumeID: *newVolume.Id,
 			},
-			Labels: map[string]string{},
+			Labels: map[string]string{
+				plugin.LabelZoneRegion:        region,
+				plugin.LabelZoneFailureDomain: *ad.Name,
+			},
 		},
 		Spec: v1.PersistentVolumeSpec{
 			PersistentVolumeReclaimPolicy: options.PersistentVolumeReclaimPolicy,

pkg/provisioner/block/block_test.go

@@ -20,6 +20,7 @@ import (
 	"time"
 
 	"github.com/oracle/oci-volume-provisioner/pkg/oci/client"
+	"github.com/oracle/oci-volume-provisioner/pkg/oci/instancemeta"
 
 	"github.com/kubernetes-incubator/external-storage/lib/controller"
 	"github.com/oracle/oci-go-sdk/common"
@@ -113,7 +114,12 @@ func TestCreateVolumeFromBackup(t *testing.T) {
 			},
 		}}
 	ad := identity.AvailabilityDomain{Name: common.String("dummyAdName"), CompartmentId: common.String("dummyCompartmentId")}
-	block := blockProvisioner{client: NewClientProvisioner(nil)}
+	block := blockProvisioner{
+		client: NewClientProvisioner(nil),
+		metadata: instancemeta.NewMock(&instancemeta.InstanceMetadata{
+			CompartmentOCID: "",
+			Region:          "phx",
+		})}
 	provisionedVolume, err := block.Provision(options, &ad)
 	if err != nil {
 		t.Fatalf("Failed to provision volume from block storage: %v", err)

pkg/provisioner/core/provisioner.go

@@ -31,6 +31,7 @@ import (
 	"k8s.io/client-go/tools/cache"
 
 	"github.com/oracle/oci-volume-provisioner/pkg/oci/client"
+	"github.com/oracle/oci-volume-provisioner/pkg/oci/instancemeta"
 	"github.com/oracle/oci-volume-provisioner/pkg/provisioner/block"
 	"github.com/oracle/oci-volume-provisioner/pkg/provisioner/plugin"
 )
@@ -77,7 +78,7 @@ func NewOCIProvisioner(kubeClient kubernetes.Interface, nodeInformer informersv1
 		glog.Fatalf("Unable to create volume provisioner client: %v", err)
 	}
 
-	blockProvisioner := block.NewBlockProvisioner(client)
+	blockProvisioner := block.NewBlockProvisioner(client, instancemeta.New())
 
 	return &OCIProvisioner{
 		client:           client,

pkg/provisioner/plugin/plugin.go

@@ -23,6 +23,11 @@ import (
 const (
 	// OCIProvisionerName is the name of the provisioner defined in the storage class definitions
 	OCIProvisionerName = "oracle/oci"
+
+	// LabelZoneFailureDomain the availability domain in which the PD resides.
+	LabelZoneFailureDomain = "failure-domain.beta.kubernetes.io/zone"
+	// LabelZoneRegion the region in which the PD resides.
+	LabelZoneRegion = "failure-domain.beta.kubernetes.io/region"
 )
 
 // ProvisionerPlugin implements the controller plugin plus some extras that are common