Merge pull request #57 from cybozu-go/extraparams-any-type

Support for Any Types in ExtraParams

api/v1beta1/params.go

@@ -0,0 +1,51 @@
+package v1beta1
+
+import (
+	"encoding/json"
+)
+
+// Params represents untyped configuration.
+// kubebuilder does not support interface{} member directly, so this struct is a workaround.
+// +kubebuilder:validation:Type=object
+type Params struct {
+	// Data holds the parameter keys and values.
+	Data map[string]interface{} `json:"-"`
+}
+
+// ToMap converts the Params to map[string]interface{}. If the receiver is nil, it returns nil.
+func (p *Params) ToMap() map[string]interface{} {
+	if p == nil {
+		return nil
+	}
+	return p.Data
+}
+
+// MarshalJSON implements the Marshaler interface.
+func (p *Params) MarshalJSON() ([]byte, error) {
+	return json.Marshal(p.Data)
+}
+
+// UnmarshalJSON implements the Unmarshaler interface.
+func (p *Params) UnmarshalJSON(data []byte) error {
+	var out map[string]interface{}
+	err := json.Unmarshal(data, &out)
+	if err != nil {
+		return err
+	}
+	p.Data = out
+	return nil
+}
+
+// DeepCopyInto is a deep copy function, copying the receiver, writing into `out`. `p` must be non-nil.
+func (p *Params) DeepCopyInto(out *Params) {
+	bytes, err := json.Marshal(p.Data)
+	if err != nil {
+		panic(err)
+	}
+	var clone map[string]interface{}
+	err = json.Unmarshal(bytes, &clone)
+	if err != nil {
+		panic(err)
+	}
+	out.Data = clone
+}

api/v1beta1/tenant_types.go

@@ -25,8 +25,9 @@ type TenantSpec struct {
 	ControllerName string `json:"controllerName,omitempty"`
 
 	// ExtraParams is a map of extra parameters that can be used in the templates.
+	// +kubebuilder:pruning:PreserveUnknownFields
 	// +optional
-	ExtraParams map[string]string `json:"extraParams,omitempty"`
+	ExtraParams *Params `json:"extraParams,omitempty"`
 }
 
 // RootNamespaceSpec defines the desired state of Namespace.

charts/cattage/crds/tenant.yaml

@@ -78,10 +78,9 @@ spec:
                     type: object
                   type: array
                 extraParams:
-                  additionalProperties:
-                    type: string
                   description: ExtraParams is a map of extra parameters that can be used in the templates.
                   type: object
+                  x-kubernetes-preserve-unknown-fields: true
                 rootNamespaces:
                   description: RootNamespaces are the list of root namespaces that belong to this tenant.
                   items:

config/crd/bases/cattage.cybozu.io_tenants.yaml

@@ -80,11 +80,10 @@ spec:
                   type: object
                 type: array
               extraParams:
-                additionalProperties:
-                  type: string
                 description: ExtraParams is a map of extra parameters that can be
                   used in the templates.
                 type: object
+                x-kubernetes-preserve-unknown-fields: true
               rootNamespaces:
                 description: RootNamespaces are the list of root namespaces that belong
                   to this tenant.

config/manager/configmap.yaml

@@ -41,6 +41,10 @@ data:
             - namespace: {{ . }}
               server: '*'
           {{- end }}
+          {{- range .ExtraParams.Destinations }}
+            - namespace: {{ . }}
+              server: '*'
+          {{- end }}
           namespaceResourceBlacklist:
             - group: ""
               kind: ResourceQuota

config/samples/tenant.yaml

@@ -24,4 +24,6 @@ spec:
       roles:
         - admin
   extraParams:
-    GitHubTeam: b-team-gh
+    Destinations:
+      - "extra-namespace-x"
+      - "extra-namespace-y"

controllers/tenant_controller.go

@@ -371,7 +371,7 @@ func (r *TenantReconciler) rolesMap(ctx context.Context, delegates []cattagev1be
 			}
 			result[role] = append(result[role], Role{
 				Name:        delegatedTenant.Name,
-				ExtraParams: delegatedTenant.Spec.ExtraParams,
+				ExtraParams: delegatedTenant.Spec.ExtraParams.ToMap(),
 			})
 		}
 	}
@@ -417,11 +417,11 @@ func (r *TenantReconciler) reconcileNamespaces(ctx context.Context, tenant *catt
 		err = tpl.Execute(&buf, struct {
 			Name        string
 			Roles       map[string][]Role
-			ExtraParams map[string]string
+			ExtraParams map[string]interface{}
 		}{
 			Name:        tenant.Name,
 			Roles:       roles,
-			ExtraParams: tenant.Spec.ExtraParams,
+			ExtraParams: tenant.Spec.ExtraParams.ToMap(),
 		})
 		if err != nil {
 			return err
@@ -467,7 +467,7 @@ func (r *TenantReconciler) reconcileNamespaces(ctx context.Context, tenant *catt
 
 type Role struct {
 	Name        string
-	ExtraParams map[string]string
+	ExtraParams map[string]interface{}
 }
 
 func (r *TenantReconciler) reconcileArgoCD(ctx context.Context, tenant *cattagev1beta1.Tenant) error {
@@ -505,13 +505,13 @@ func (r *TenantReconciler) reconcileArgoCD(ctx context.Context, tenant *cattagev
 		Namespaces   []string
 		Roles        map[string][]Role
 		Repositories []string
-		ExtraParams  map[string]string
+		ExtraParams  map[string]interface{}
 	}{
 		Name:         tenant.Name,
 		Namespaces:   namespaces,
 		Roles:        roles,
 		Repositories: tenant.Spec.ArgoCD.Repositories,
-		ExtraParams:  tenant.Spec.ExtraParams,
+		ExtraParams:  tenant.Spec.ExtraParams.ToMap(),
 	})
 	if err != nil {
 		return err

controllers/tenant_controller_test.go

@@ -107,9 +107,9 @@ var _ = Describe("Tenant controller", Ordered, func() {
 						"https://github.com/cybozu-go/*",
 					},
 				},
-				ExtraParams: map[string]string{
+				ExtraParams: &cattagev1beta1.Params{Data: map[string]interface{}{
 					"GitHubTeam": "c-team-gh",
-				},
+				}},
 			},
 		}
 		err := k8sClient.Create(ctx, cTeam)
@@ -143,9 +143,13 @@ var _ = Describe("Tenant controller", Ordered, func() {
 						},
 					},
 				},
-				ExtraParams: map[string]string{
+				ExtraParams: &cattagev1beta1.Params{Data: map[string]interface{}{
 					"GitHubTeam": "x-team-gh",
-				},
+					"Destinations": []string{
+						"extra-namespace-x",
+						"extra-namespace-y",
+					},
+				}},
 			},
 		}
 		err = k8sClient.Create(ctx, xTeam)
@@ -209,6 +213,14 @@ var _ = Describe("Tenant controller", Ordered, func() {
 					"namespace": Equal("sub-4"),
 					"server":    Equal("*"),
 				}),
+				MatchAllKeys(Keys{
+					"namespace": Equal("extra-namespace-x"),
+					"server":    Equal("*"),
+				}),
+				MatchAllKeys(Keys{
+					"namespace": Equal("extra-namespace-y"),
+					"server":    Equal("*"),
+				}),
 			),
 			"namespaceResourceBlacklist": ConsistOf(
 				MatchAllKeys(Keys{

controllers/testdata/appprojecttemplate.yaml

@@ -6,6 +6,10 @@ spec:
   - namespace: {{ . }}
     server: '*'
   {{- end }}
+  {{- range .ExtraParams.Destinations }}
+  - namespace: {{ . }}
+    server: '*'
+  {{- end }}
   namespaceResourceBlacklist:
     - group: ""
       kind: ResourceQuota

docs/crd_tenant.md

@@ -78,7 +78,7 @@ TenantSpec defines the desired state of Tenant.
 | argocd | ArgoCD is the settings of Argo CD for this tenant. | [ArgoCDSpec](#argocdspec) | false |
 | delegates | Delegates is a list of other tenants that are delegated access to this tenant. | [][DelegateSpec](#delegatespec) | false |
 | controllerName | ControllerName is the name of the application-controller that manages this tenant's applications. If not specified, the default controller is used. | string | false |
-| extraParams | ExtraParams is a map of extra parameters that can be used in the templates. | map[string]string | false |
+| extraParams | ExtraParams is a map of extra parameters that can be used in the templates. | *Params | false |
 
 [Back to Custom Resources](#custom-resources)