Merge pull request #2355 from fabriziopandini/clusterctl-map-uxname-to-manifestlabels

🐛clusterctl: allows usage providers with the same name but different type

Author: k8s-ci-robot

cmd/clusterctl/api/v1alpha3/labels.go

@@ -16,6 +16,8 @@ limitations under the License.
 
 package v1alpha3
 
+import "fmt"
+
 const (
 	// ClusterctlLabelName defines the label that is applied to all the components managed by clusterctl.
 	ClusterctlLabelName = "clusterctl.cluster.x-k8s.io"
@@ -38,3 +40,21 @@ const (
 	// if an instance of the provider is deleted.
 	ResourceLifecycleShared = ResourceLifecycle("shared")
 )
+
+// ManifestLabel returns the cluster.x-k8s.io/provider label value for a provider/type.
+// Please note that this label uniquely identifies the provider, e.g. bootstrap-kubeadm, but not the instances of
+// the provider, e.g. namespace-1/bootstrap-kubeadm and namespace-2/bootstrap-kubeadm.
+func ManifestLabel(name string, providerType ProviderType) string {
+	switch providerType {
+	case CoreProviderType:
+		return name
+	case BootstrapProviderType:
+		return fmt.Sprintf("bootstrap-%s", name)
+	case ControlPlaneProviderType:
+		return fmt.Sprintf("control-plane-%s", name)
+	case InfrastructureProviderType:
+		return fmt.Sprintf("infrastructure-%s", name)
+	default:
+		return fmt.Sprintf("unknown-type-%s", name)
+	}
+}

cmd/clusterctl/api/v1alpha3/provider_type.go

@@ -24,15 +24,20 @@ import (
 // +kubebuilder:resource:path=providers,scope=Namespaced,categories=cluster-api
 // +kubebuilder:storageversion
 // +kubebuilder:object:root=true
-// +kubebuilder:printcolumn:name="Type",type="string",JSONPath=".type"
+// +kubebuilder:printcolumn:name="Type",type="string",JSONPath=".provider"
+// +kubebuilder:printcolumn:name="Provider",type="string",JSONPath=".type"
 // +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".version"
 // +kubebuilder:printcolumn:name="Watch Namespace",type="string",JSONPath=".watchedNamespace"
 
-// Provider is the Schema for the providers API
+// Provider defines an entry in the provider inventory.
 type Provider struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
+	// Provider indicates the name of the provider.
+	// +optional
+	Provider string `json:"provider,omitempty"`
+
 	// Type indicates the type of the provider.
 	// See ProviderType for a list of supported values
 	// +optional
@@ -48,7 +53,57 @@ type Provider struct {
 	WatchedNamespace string `json:"watchedNamespace,omitempty"`
 }
 
-// ProviderType is a string representation of a TaskGroup create policy.
+// ManifestLabel returns the cluster.x-k8s.io/provider label value for an entry in the provider inventory.
+// Please note that this label uniquely identifies the provider, e.g. bootstrap-kubeadm, but not the instances of
+// the provider, e.g. namespace-1/bootstrap-kubeadm and namespace-2/bootstrap-kubeadm
+func (p *Provider) ManifestLabel() string {
+	return ManifestLabel(p.Provider, p.GetProviderType())
+}
+
+// InstanceName return the a name that uniquely identifies an entry in the provider inventory.
+// The instanceName is composed by the ManifestLabel and by the namespace where the provider is installed;
+// the resulting value uniquely identify a provider instance because clusterctl does not support multiple
+//instances of the same provider to be installed in the same namespace.
+func (p *Provider) InstanceName() string {
+	return types.NamespacedName{Namespace: p.Namespace, Name: p.ManifestLabel()}.String()
+}
+
+// HasWatchingOverlapWith returns true if the provider has an overlapping watching namespace with another provider.
+func (p *Provider) HasWatchingOverlapWith(other Provider) bool {
+	return p.WatchedNamespace == "" || p.WatchedNamespace == other.WatchedNamespace || other.WatchedNamespace == ""
+}
+
+// SameAs returns true if two providers have the same Provider and type.
+// Please note that there could be many instances of the same provider.
+func (p *Provider) SameAs(other Provider) bool {
+	return p.Provider == other.Provider && p.Type == other.Type
+}
+
+// Equals returns true if two providers are identical (same name, type, version etc.).
+func (p *Provider) Equals(other Provider) bool {
+	return p.Name == other.Name &&
+		p.Namespace == other.Namespace &&
+		p.Provider == other.Provider &&
+		p.Type == other.Type &&
+		p.WatchedNamespace == other.WatchedNamespace &&
+		p.Version == other.Version
+}
+
+// GetProviderType parse the Provider.Type string field and return the typed representation.
+func (p *Provider) GetProviderType() ProviderType {
+	switch t := ProviderType(p.Type); t {
+	case
+		CoreProviderType,
+		BootstrapProviderType,
+		InfrastructureProviderType,
+		ControlPlaneProviderType:
+		return t
+	default:
+		return ProviderTypeUnknown
+	}
+}
+
+// ProviderType is a string representation of a Provider type..
 type ProviderType string
 
 const (
@@ -68,42 +123,22 @@ const (
 	ProviderTypeUnknown = ProviderType("")
 )
 
-// GetProviderType attempts to parse the ProviderType field and return
-// the typed ProviderType representation.
-func (p *Provider) GetProviderType() ProviderType {
-	switch t := ProviderType(p.Type); t {
-	case
-		CoreProviderType,
-		BootstrapProviderType,
-		InfrastructureProviderType,
-		ControlPlaneProviderType:
-		return t
+// Order return an integer that can be used to sort ProviderType values.
+func (p ProviderType) Order() int {
+	switch p {
+	case CoreProviderType:
+		return 0
+	case BootstrapProviderType:
+		return 1
+	case ControlPlaneProviderType:
+		return 2
+	case InfrastructureProviderType:
+		return 3
 	default:
-		return ProviderTypeUnknown
+		return 4
 	}
 }
 
-// InstanceName return the instance name for the provider, that is composed by the provider name and the namespace
-// where the provider is installed (nb. clusterctl does not support multiple instances of the same provider to be
-// installed in the same namespace)
-func (p *Provider) InstanceName() string {
-	return types.NamespacedName{Namespace: p.Namespace, Name: p.Name}.String()
-}
-
-// HasWatchingOverlapWith returns true if the provider has an overlapping watching namespace with another provider.
-func (p *Provider) HasWatchingOverlapWith(other Provider) bool {
-	return p.WatchedNamespace == "" || p.WatchedNamespace == other.WatchedNamespace || other.WatchedNamespace == ""
-}
-
-// Equals returns true if two providers are exactly the same.
-func (p *Provider) Equals(other Provider) bool {
-	return p.Name == other.Name &&
-		p.Namespace == other.Namespace &&
-		p.Type == other.Type &&
-		p.WatchedNamespace == other.WatchedNamespace &&
-		p.Version == other.Version
-}
-
 // +kubebuilder:object:root=true
 
 // ProviderList contains a list of Provider
@@ -113,15 +148,15 @@ type ProviderList struct {
 	Items           []Provider `json:"items"`
 }
 
-func (l *ProviderList) FilterByName(name string) []Provider {
+func (l *ProviderList) FilterByNamespace(namespace string) []Provider {
 	return l.filterBy(func(p Provider) bool {
-		return p.Name == name
+		return p.Namespace == namespace
 	})
 }
 
-func (l *ProviderList) FilterByNamespace(namespace string) []Provider {
+func (l *ProviderList) FilterByProviderAndType(provider string, providerType ProviderType) []Provider {
 	return l.filterBy(func(p Provider) bool {
-		return p.Namespace == namespace
+		return p.Provider == provider && p.Type == string(providerType)
 	})
 }
 

cmd/clusterctl/api/v1alpha3/provider_type_test.go

@@ -0,0 +1,93 @@
+/*
+Copyright 2020 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha3
+
+import (
+	"testing"
+)
+
+func Test_Provider_ManifestLabel(t *testing.T) {
+	type fields struct {
+		provider     string
+		providerType ProviderType
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		want   string
+	}{
+		{
+			name: "core provider remains the same",
+			fields: fields{
+				provider:     "cluster-api",
+				providerType: CoreProviderType,
+			},
+			want: "cluster-api",
+		},
+		{
+			name: "kubeadm bootstrap",
+			fields: fields{
+				provider:     "kubeadm",
+				providerType: BootstrapProviderType,
+			},
+			want: "bootstrap-kubeadm",
+		},
+		{
+			name: "other bootstrap providers gets prefix",
+			fields: fields{
+				provider:     "xx",
+				providerType: BootstrapProviderType,
+			},
+			want: "bootstrap-xx",
+		},
+		{
+			name: "kubeadm control-plane",
+			fields: fields{
+				provider:     "kubeadm",
+				providerType: ControlPlaneProviderType,
+			},
+			want: "control-plane-kubeadm",
+		},
+		{
+			name: "other control-plane providers gets prefix",
+			fields: fields{
+				provider:     "xx",
+				providerType: ControlPlaneProviderType,
+			},
+			want: "control-plane-xx",
+		},
+		{
+			name: "infrastructure providers gets prefix",
+			fields: fields{
+				provider:     "xx",
+				providerType: InfrastructureProviderType,
+			},
+			want: "infrastructure-xx",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			p := &Provider{
+				Provider: tt.fields.provider,
+				Type:     string(tt.fields.providerType),
+			}
+			if got := p.ManifestLabel(); got != tt.want {
+				t.Errorf("got %v, want %v", got, tt.want)
+			}
+		})
+	}
+}