CARRY: KCP example

Author: mjudeikis

.gitignore

@@ -24,4 +24,6 @@
 hack/tools/bin
 
 junit-report.xml
-/artifacts
+/artifacts
+
+examples/kcp/bin/*

Makefile

@@ -105,7 +105,7 @@ modules: ## Runs go mod to ensure modules are up to date.
 
 .PHONY: generate
 generate: $(CONTROLLER_GEN) ## Runs controller-gen for internal types for config file
-	$(CONTROLLER_GEN) object paths="./pkg/config/v1alpha1/...;./examples/configfile/custom/v1alpha1/..."
+	$(CONTROLLER_GEN) object paths="./pkg/config/v1alpha1/...;./examples/configfile/custom/v1alpha1/...;./examples/kcp/..."
 
 ## --------------------------------------
 ## Cleanup / Verification

examples/builtins/main.go

@@ -42,6 +42,7 @@ func main() {
 
 	// Setup a Manager
 	entryLog.Info("setting up manager")
+
 	mgr, err := manager.New(config.GetConfigOrDie(), manager.Options{})
 	if err != nil {
 		entryLog.Error(err, "unable to set up overall controller manager")

examples/kcp/Makefile

@@ -0,0 +1,13 @@
+
+LOCALBIN ?= $(shell pwd)/bin
+KCP ?= $(LOCALBIN)/kcp
+KCP_VERSION ?= 0.23.0
+
+OS ?= $(shell go env GOOS )
+ARCH ?= $(shell go env GOARCH )
+
+$(KCP): ## Download kcp locally if necessary.
+	mkdir -p $(LOCALBIN)
+	curl -L -s -o - https://github.com/kcp-dev/kcp/releases/download/v$(KCP_VERSION)/kcp_$(KCP_VERSION)_$(OS)_$(ARCH).tar.gz | tar --directory $(LOCALBIN)/../ -xvzf - bin/kcp
+	touch $(KCP) # we download an "old" file, so make will re-download to refresh it unless we make it newer than the owning dir
+

examples/kcp/api/v1alpha1/groupversion_info.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2024.
+
+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 v1alpha1 contains API Schema definitions for the data v1alpha1 API group
+// +kubebuilder:object:generate=true
+// +groupName=data.my.domain
+package v1alpha1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "data.my.domain", Version: "v1alpha1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)

examples/kcp/api/v1alpha1/widget_types.go

@@ -0,0 +1,56 @@
+/*
+Copyright 2024.
+
+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 v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// WidgetSpec defines the desired state of Widget
+type WidgetSpec struct {
+	Foo string `json:"foo,omitempty"`
+}
+
+// WidgetStatus defines the observed state of Widget
+type WidgetStatus struct {
+	Total int `json:"total,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+
+// Widget is the Schema for the widgets API
+type Widget struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   WidgetSpec   `json:"spec,omitempty"`
+	Status WidgetStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// WidgetList contains a list of Widget
+type WidgetList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Widget `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Widget{}, &WidgetList{})
+}

examples/kcp/api/v1alpha1/zz_generated.deepcopy.go

@@ -0,0 +1,154 @@
+/*
+Copyright 2024 The KCP 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 controllers
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	corev1 "k8s.io/api/core/v1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+
+	"github.com/kcp-dev/logicalcluster/v3"
+
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
+	"sigs.k8s.io/controller-runtime/pkg/log"
+)
+
+type ConfigMapReconciler struct {
+	client.Client
+}
+
+func (r *ConfigMapReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	log := log.FromContext(ctx).WithValues("cluster", req.ClusterName)
+
+	ctx = logicalcluster.WithCluster(ctx, logicalcluster.New(req.ClusterName))
+
+	// Test get
+	var configMap corev1.ConfigMap
+
+	if err := r.Get(ctx, req.NamespacedName, &configMap); err != nil {
+		log.Error(err, "unable to get configmap")
+		return ctrl.Result{}, nil
+	}
+
+	log.Info("Get: retrieved configMap")
+	labels := configMap.Labels
+
+	if labels["name"] != "" {
+		response := fmt.Sprintf("hello-%s", labels["name"])
+
+		if labels["response"] != response {
+			labels["response"] = response
+
+			// Test Update
+			if err := r.Update(ctx, &configMap); err != nil {
+				return ctrl.Result{}, err
+			}
+			log.Info("Update: updated configMap")
+			return ctrl.Result{}, nil
+		}
+	}
+
+	// Test list
+	var configMapList corev1.ConfigMapList
+	if err := r.List(ctx, &configMapList); err != nil {
+		log.Error(err, "unable to list configmaps")
+		return ctrl.Result{}, nil
+	}
+	log.Info("List: got", "itemCount", len(configMapList.Items))
+	found := false
+	for _, cm := range configMapList.Items {
+		if !logicalcluster.From(&cm).Empty() {
+			log.Info("List: got", "clusterName", logicalcluster.From(&cm).String(), "namespace", cm.Namespace, "name", cm.Name)
+		} else {
+			if cm.Name == configMap.Name && cm.Namespace == configMap.Namespace {
+				if found {
+					return ctrl.Result{}, fmt.Errorf("there should be listed only one configmap with the given name '%s' for the given namespace '%s' when the clusterName is not available", cm.Name, cm.Namespace)
+				}
+				found = true
+				log.Info("Found in listed configmaps", "namespace", cm.Namespace, "name", cm.Name)
+			}
+		}
+	}
+
+	// If the configmap has a namespace field, create the corresponding namespace
+	nsName, exists := configMap.Data["namespace"]
+	if exists {
+		var namespace corev1.Namespace
+		nsKey := types.NamespacedName{Name: nsName}
+
+		if err := r.Get(ctx, nsKey, &namespace); err != nil {
+			if !apierrors.IsNotFound(err) {
+				log.Error(err, "unable to get namespace")
+				return ctrl.Result{}, err
+			}
+
+			// Need to create ns
+			namespace.SetName(nsName)
+			if err = r.Create(ctx, &namespace); err != nil {
+				log.Error(err, "unable to create namespace")
+				return ctrl.Result{}, err
+			}
+			log.Info("Create: created ", "namespace", nsName)
+			return ctrl.Result{RequeueAfter: time.Second * 5}, nil
+		}
+		log.Info("Exists", "namespace", nsName)
+	}
+
+	// If the configmap has a secretData field, create a secret in the same namespace
+	// If the secret already exists but is out of sync, it will be non-destructively patched
+	secretData, exists := configMap.Data["secretData"]
+	if exists {
+		var secret corev1.Secret
+
+		secret.SetName(configMap.GetName())
+		secret.SetNamespace(configMap.GetNamespace())
+		secret.SetOwnerReferences([]metav1.OwnerReference{metav1.OwnerReference{
+			Name:       configMap.GetName(),
+			UID:        configMap.GetUID(),
+			APIVersion: "v1",
+			Kind:       "ConfigMap",
+			Controller: func() *bool { x := true; return &x }(),
+		}})
+		secret.Data = map[string][]byte{"dataFromCM": []byte(secretData)}
+
+		operationResult, err := controllerutil.CreateOrPatch(ctx, r, &secret, func() error {
+			secret.Data["dataFromCM"] = []byte(secretData)
+			return nil
+		})
+		if err != nil {
+			log.Error(err, "unable to create or patch secret")
+			return ctrl.Result{}, err
+		}
+		log.Info(string(operationResult), "secret", secret.GetName())
+	}
+
+	return ctrl.Result{}, nil
+}
+
+func (r *ConfigMapReconciler) SetupWithManager(mgr ctrl.Manager) error {
+	return ctrl.NewControllerManagedBy(mgr).
+		For(&corev1.ConfigMap{}).
+		Owns(&corev1.Secret{}).
+		Complete(r)
+}