Fix integration tests + update docs (#178)

* Added managed by label - issue 110

* fixed integration tests

* update docs + add samples

* updated readme + contributing

* update make install expected output

* update contributing

Author: matthewgoodman13

CONTRIBUTING.md

@@ -74,14 +74,24 @@ kubectl create namespace example
 
 #### Run the controller from outside the cluster
 
-To register the custom CRDs (`ServiceImport`, `ServiceExport`) in the cluster and create installers:
+To register the custom CRDs (`ClusterProperties`, `ServiceImport`, `ServiceExport`) in the cluster and create installers:
 ```sh
 make install
 # ...
+# customresourcedefinition.apiextensions.k8s.io/clusterproperties.about.k8s.io created
 # customresourcedefinition.apiextensions.k8s.io/serviceexports.multicluster.x-k8s.io created
 # customresourcedefinition.apiextensions.k8s.io/serviceimports.multicluster.x-k8s.io created
 ```
 
+Register a unique `id.k8s.io` and `clusterset.k8s.io` in your cluster:
+```bash
+kubectl apply -f samples/example-clusterproperty.yaml
+# clusterproperty.about.k8s.io/id.k8s.io created
+# clusterproperty.about.k8s.io/clusterset.k8s.io created
+```
+> ⚠ **Note:** If you are creating multiple clusters, ensure you create unique `id.k8s.io` identifiers for each cluster.
+
+
 To run the controller, run the following command. The controller runs in an infinite loop so open another terminal to create CRDs.
 ```sh
 make run 

README.md

@@ -42,9 +42,9 @@ Install the The CoreDNS multicluster plugin into each participating cluster. The
 To install the plugin, run the following commands.
 
 ```bash
-kubectl apply -k "github.com/aws/aws-cloud-map-mcs-controller-for-k8s/samples/coredns-clusterrole.yaml
-kubectl apply -k "github.com/aws/aws-cloud-map-mcs-controller-for-k8s/samples/coredns-configmap.yaml
-kubectl apply -k "github.com/aws/aws-cloud-map-mcs-controller-for-k8s/samples/coredns-deployment.yaml
+kubectl apply -k "github.com/aws/aws-cloud-map-mcs-controller-for-k8s/samples/coredns-clusterrole.yaml"
+kubectl apply -k "github.com/aws/aws-cloud-map-mcs-controller-for-k8s/samples/coredns-configmap.yaml"
+kubectl apply -k "github.com/aws/aws-cloud-map-mcs-controller-for-k8s/samples/coredns-deployment.yaml"
 ```
 
 ### Install Controller
@@ -63,6 +63,45 @@ The controller must have sufficient IAM permissions to perform required Cloud Ma
 
 ## Usage
 
+### Configure `id.k8s.io` and `clusterset.k8s.io`
+
+`id.k8s.io` is a unique identifier that uniquely identifies a cluster.
+
+`clusterset.k8s.io` is a unique identifier that uniquely identifies the set of clusters in your multicluster. This will be the same across all clusters in the set.
+
+```yaml
+apiVersion: about.k8s.io/v1alpha1
+kind: ClusterProperty
+metadata:
+  name: id.k8s.io
+spec:
+  value: [Your cluster identifier]
+---
+apiVersion: about.k8s.io/v1alpha1
+kind: ClusterProperty
+metadata:
+  name: clusterset.k8s.io
+spec:
+  value: [Your cluster set identifier]
+```
+
+**Example:**
+```yaml
+apiVersion: about.k8s.io/v1alpha1
+kind: ClusterProperty
+metadata:
+  name: id.k8s.io
+spec:
+  value: my-first-cluster
+---
+apiVersion: about.k8s.io/v1alpha1
+kind: ClusterProperty
+metadata:
+  name: clusterset.k8s.io
+spec:
+  value: my-clusterset
+```
+
 ### Export services
 
 Then assuming you already have a Service installed, apply a `ServiceExport` yaml to the cluster in which you want to export a service. This can be done for each service you want to export.

integration/janitor/api.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/aws/aws-cloud-map-mcs-controller-for-k8s/pkg/cloudmap"
 	"github.com/aws/aws-cloud-map-mcs-controller-for-k8s/pkg/common"
+	"github.com/aws/aws-cloud-map-mcs-controller-for-k8s/test"
 	"github.com/aws/aws-sdk-go-v2/aws"
 	sd "github.com/aws/aws-sdk-go-v2/service/servicediscovery"
 )
@@ -22,7 +23,7 @@ type serviceDiscoveryJanitorApi struct {
 
 func NewServiceDiscoveryJanitorApiFromConfig(cfg *aws.Config) ServiceDiscoveryJanitorApi {
 	return &serviceDiscoveryJanitorApi{
-		ServiceDiscoveryApi: cloudmap.NewServiceDiscoveryApiFromConfig(cfg, common.ClusterUtils{}),
+		ServiceDiscoveryApi: cloudmap.NewServiceDiscoveryApiFromConfig(cfg, common.NewClusterUtilsForTest(test.ClusterId, test.ClusterSetId)),
 		janitorFacade:       NewSdkJanitorFacadeFromConfig(cfg),
 	}
 }

integration/kind-test/configs/e2e-clusterId.yaml

@@ -0,0 +1,8 @@
+# An example object of `id.k8s.io ClusterProperty` 
+
+apiVersion: about.k8s.io/v1alpha1
+kind: ClusterProperty
+metadata:
+  name: id.k8s.io
+spec:
+  value: test-mcs-clusterId

integration/kind-test/configs/e2e-clusterSetId.yaml

@@ -0,0 +1,8 @@
+# An example object of `clusterset.k8s.io ClusterProperty`:
+
+apiVersion: about.k8s.io/v1alpha1
+kind: ClusterProperty
+metadata:
+  name: clusterset.k8s.io
+spec:
+  value: test-mcs-clusterSetId

integration/kind-test/scripts/run-tests.sh

@@ -4,6 +4,9 @@
 
 source ./integration/kind-test/scripts/common.sh
 
+$KUBECTL_BIN apply -f "$CONFIGS/e2e-clusterId.yaml"
+$KUBECTL_BIN apply -f "$CONFIGS/e2e-clusterSetId.yaml"
+
 $KUBECTL_BIN apply -f "$CONFIGS/e2e-deployment.yaml"
 $KUBECTL_BIN apply -f "$CONFIGS/e2e-service.yaml"
 $KUBECTL_BIN apply -f "$CONFIGS/e2e-export.yaml"

integration/shared/scenarios/export_service.go

@@ -11,6 +11,7 @@ import (
 	"github.com/aws/aws-cloud-map-mcs-controller-for-k8s/pkg/common"
 	multiclustercontrollers "github.com/aws/aws-cloud-map-mcs-controller-for-k8s/pkg/controllers/multicluster"
 	"github.com/aws/aws-cloud-map-mcs-controller-for-k8s/pkg/model"
+	"github.com/aws/aws-cloud-map-mcs-controller-for-k8s/test"
 	"github.com/aws/aws-sdk-go-v2/aws"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/util/wait"
@@ -59,6 +60,8 @@ func NewExportServiceScenario(cfg *aws.Config, nsName string, svcName string, po
 				Protocol:   string(v1.ProtocolTCP),
 			},
 			EndpointPort: endpointPort,
+			ClusterId:    test.ClusterId,
+			ClusterSetId: test.ClusterSetId,
 			ServiceType:  model.ClusterSetIPType, // in scenario, we assume ClusterSetIP type
 			Attributes:   make(map[string]string),
 		})
@@ -70,7 +73,7 @@ func NewExportServiceScenario(cfg *aws.Config, nsName string, svcName string, po
 				NsTTL:    time.Second,
 				SvcTTL:   time.Second,
 				EndptTTL: time.Second,
-			}, common.ClusterUtils{}),
+			}, common.NewClusterUtilsForTest(test.ClusterId, test.ClusterSetId)),
 		expectedSvc: model.Service{
 			Namespace: nsName,
 			Name:      svcName,

pkg/cloudmap/api_test.go

@@ -23,7 +23,7 @@ import (
 )
 
 func TestNewServiceDiscoveryApi(t *testing.T) {
-	sdc := NewServiceDiscoveryApiFromConfig(&aws.Config{}, common.ClusterUtils{})
+	sdc := NewServiceDiscoveryApiFromConfig(&aws.Config{}, common.NewClusterUtilsForTest(test.ClusterId, test.ClusterSetId))
 	assert.NotNil(t, sdc)
 }
 
@@ -107,7 +107,7 @@ func TestServiceDiscoveryApi_DiscoverInstances_HappyCase(t *testing.T) {
 			HealthStatus:  types.HealthStatusFilterAll,
 			MaxResults:    aws.Int32(1000),
 			QueryParameters: map[string]string{
-				model.ClusterSetIdAttr: test.ClustersetId,
+				model.ClusterSetIdAttr: test.ClusterSetId,
 			},
 		}).
 		Return(&sd.DiscoverInstancesOutput{

pkg/cloudmap/client_test.go

@@ -24,7 +24,7 @@ type testSdClient struct {
 }
 
 func TestNewServiceDiscoveryClient(t *testing.T) {
-	sdc := NewDefaultServiceDiscoveryClient(&aws.Config{}, common.ClusterUtils{})
+	sdc := NewDefaultServiceDiscoveryClient(&aws.Config{}, common.NewClusterUtilsForTest(test.ClusterId, test.ClusterSetId))
 	assert.NotNil(t, sdc)
 }
 
@@ -284,7 +284,7 @@ func TestServiceDiscoveryClient_RegisterEndpoints(t *testing.T) {
 
 	attrs1 := map[string]string{
 		model.ClusterIdAttr:         test.ClusterId,
-		model.ClusterSetIdAttr:      test.ClustersetId,
+		model.ClusterSetIdAttr:      test.ClusterSetId,
 		model.EndpointIpv4Attr:      test.EndptIp1,
 		model.EndpointPortAttr:      test.PortStr1,
 		model.EndpointPortNameAttr:  test.PortName1,
@@ -297,7 +297,7 @@ func TestServiceDiscoveryClient_RegisterEndpoints(t *testing.T) {
 	}
 	attrs2 := map[string]string{
 		model.ClusterIdAttr:         test.ClusterId,
-		model.ClusterSetIdAttr:      test.ClustersetId,
+		model.ClusterSetIdAttr:      test.ClusterSetId,
 		model.EndpointIpv4Attr:      test.EndptIp2,
 		model.EndpointPortAttr:      test.PortStr2,
 		model.EndpointPortNameAttr:  test.PortName2,
@@ -369,7 +369,7 @@ func getHttpInstanceSummaryForTest() []types.HttpInstanceSummary {
 			InstanceId: aws.String(test.EndptId1),
 			Attributes: map[string]string{
 				model.ClusterIdAttr:         test.ClusterId,
-				model.ClusterSetIdAttr:      test.ClustersetId,
+				model.ClusterSetIdAttr:      test.ClusterSetId,
 				model.EndpointIpv4Attr:      test.EndptIp1,
 				model.EndpointPortAttr:      test.PortStr1,
 				model.EndpointPortNameAttr:  test.PortName1,
@@ -385,7 +385,7 @@ func getHttpInstanceSummaryForTest() []types.HttpInstanceSummary {
 			InstanceId: aws.String(test.EndptId2),
 			Attributes: map[string]string{
 				model.ClusterIdAttr:         test.ClusterId,
-				model.ClusterSetIdAttr:      test.ClustersetId,
+				model.ClusterSetIdAttr:      test.ClusterSetId,
 				model.EndpointIpv4Attr:      test.EndptIp2,
 				model.EndpointPortAttr:      test.PortStr2,
 				model.EndpointPortNameAttr:  test.PortName2,

pkg/common/cluster.go

@@ -28,6 +28,14 @@ func NewClusterUtils(client client.Client) ClusterUtils {
 	}
 }
 
+// constructor for tests
+func NewClusterUtilsForTest(clusterId string, clusterSetId string) ClusterUtils {
+	return ClusterUtils{
+		clusterId:    clusterId,
+		clusterSetId: clusterSetId,
+	}
+}
+
 // retrieve the clusterId from the local field. If not set, retrieve from client
 func (r *ClusterUtils) GetClusterId(ctx context.Context) (string, error) {
 	if r.clusterId != "" {