kcp provider changes

Author: mjudeikis

.gitignore

@@ -25,3 +25,6 @@ go.work
 *.swp
 *.swo
 *~
+
+hack/tools/apigen
+bin/*

Makefile

@@ -96,8 +96,8 @@ build: manifests generate fmt vet ## Build manager binary.
 	go build -o bin/manager cmd/main.go
 
 .PHONY: run
-run: manifests generate fmt vet ## Run a controller from your host.
-	go run ./cmd/main.go
+run: manifests kcp-tools generate kcp-generate fmt vet ## Run a controller from your host.
+	go run ./cmd/main.go --server=$$(kubectl get apiexport apis.contrib.kcp.io -o jsonpath="{.status.virtualWorkspaces[0].url}")
 
 # If you wish to build the manager image targeting other platforms you can use the --platform flag.
 # (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
@@ -222,3 +222,30 @@ mv $(1) $(1)-$(3) ;\
 } ;\
 ln -sf $(1)-$(3) $(1)
 endef
+
+# MUTLICLUSTER-PROVIDER KCP SPECIFIC:
+TOOLS_DIR=hack/tools
+ARCH := $(shell go env GOARCH)
+OS := $(shell go env GOOS)
+
+KCP_APIGEN_BIN := apigen
+KCP_APIGEN_VERSION ?= 0.27.0-rc.1
+# Construct the download URL.
+DOWNLOAD_URL = https://github.com/kcp-dev/kcp/releases/download/v$(KCP_APIGEN_VERSION)/apigen_$(KCP_APIGEN_VERSION)_$(OS)_$(ARCH).tar.gz
+KCP_APIGEN_GEN := $(TOOLS_DIR)/$(KCP_APIGEN_BIN)
+export KCP_APIGEN_GEN # so hack scripts can use it
+
+# TODO: move to binary to avoid depeendencies
+$(KCP_APIGEN_GEN):
+# Create a temporary directory for download and extraction
+	TMP_DIR=$$(mktemp -d) ; \
+		curl -L -o $$TMP_DIR/apigen.tar.gz $(DOWNLOAD_URL) ; \
+		tar -xzf $$TMP_DIR/apigen.tar.gz -C $$TMP_DIR ; \
+		mv $$TMP_DIR/bin/apigen $(KCP_APIGEN_GEN) ; \
+		rm -rf $$TMP_DIR
+
+kcp-tools: $(KCP_APIGEN_GEN) 
+.PHONY: kcp-tools
+
+kcp-generate:
+	$(TOOLS_DIR)/apigen --input-dir ./config/crd/bases --output-dir ./config/kcp    

README.md

@@ -1,135 +1,78 @@
 # multicluster-provider-kubebuilder-example
-// TODO(user): Add simple overview of use/purpose
 
-## Description
-// TODO(user): An in-depth paragraph about your project and overview of use
+A full kcp multicluster-provider example using kubebuilder.
 
-## Getting Started
+This example demonstrates how to lift&shift a kubebuilder project to a multicluster-provider project for kcp.
 
-### Prerequisites
-- go version v1.23.0+
-- docker version 17.03+.
-- kubectl version v1.11.3+.
-- Access to a Kubernetes v1.11.3+ cluster.
-
-### To Deploy on the cluster
-**Build and push your image to the location specified by `IMG`:**
-
-```sh
-make docker-build docker-push IMG=<some-registry>/multicluster-provider-kubebuilder-example:tag
-```
+There should be 2 commits in this repository at all times:
 
-**NOTE:** This image ought to be published in the personal registry you specified.
-And it is required to have access to pull the image from the working environment.
-Make sure you have the proper permission to the registry if the above commands don’t work.
+1. The initial commit with the kubebuilder project.
 
-**Install the CRDs into the cluster:**
+Skeleton created by running [kubebuilder](https://book.kubebuilder.io/quick-start.html) with the following command:
 
 ```sh
-make install
+$ kubebuilder init --domain contrib.kcp.io --repo github.com/kcp-dev/multicluster-provider-kubebuilder-example
+$ kubebuilder create api --group apis --version v1alpha1 --kind Application
 ```
 
-**Deploy the Manager to the cluster with the image specified by `IMG`:**
+2. The commit with the kubebuilder project lifted&shifted to a multicluster-provider project to work with kcp.
 
-```sh
-make deploy IMG=<some-registry>/multicluster-provider-kubebuilder-example:tag
-```
+Please refer to main repositories for more information:
 
-> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
-privileges or be logged in as admin.
+- [multicluster-provider for kcp](https://github.com/kcp-dev/multicluster-provider)
+- [multicluster-runtime](https://github.com/multicluster-runtime/multicluster-runtime)
+- [kcp](https://github.com/kcp-dev/kcp)
 
-**Create instances of your solution**
-You can apply the samples (examples) from the config/sample:
 
-```sh
-kubectl apply -k config/samples/
-```
+## Customizations & Run
 
->**NOTE**: Ensure that the samples has default values to test it out.
-
-### To Uninstall
-**Delete the instances (CRs) from the cluster:**
-
-```sh
-kubectl delete -k config/samples/
-```
-
-**Delete the APIs(CRDs) from the cluster:**
+### Prerequisites
 
-```sh
-make uninstall
-```
+- [kcp](https://github.com/kcp-dev/kcp) installed and running
+- [kcp krew plugins](https://docs.kcp.io/kcp/v0.26/setup/kubectl-plugin/) installed
 
-**UnDeploy the controller from the cluster:**
+1. Make file targets to install kcp specific tooling and generate kcp specific manifests:
 
 ```sh
-make undeploy
+# install tooling
+make kcp-tools
+# generate kcp manifests
+make kcp-generate
 ```
 
-## Project Distribution
+After than content of `cmd/main.go` was updated with multicluster extension.
 
-Following the options to release and provide this solution to the users.
+It can be tested by applying the necessary manifests from the respective folder while connected to the `root` workspace of a kcp instance:
 
-### By providing a bundle with all YAML files
-
-1. Build the installer for the image built and published in the registry:
+export KUBECONFIG=admin.kubeconfig
 
 ```sh
-make build-installer IMG=<some-registry>/multicluster-provider-kubebuilder-example:tag
+kubectl ws create provider --enter
+kubectl apply -f ./config/kcp/apiresourceschema-applications.apis.contrib.kcp.io.yaml
+kubectl apply -f ./config/kcp/apiexport-apis.contrib.kcp.io.yaml
+
+# Consumer 1
+kubectl ws use :root
+kubectl ws create examples-kubebuilder-multicluster-1 --enter
+kubectl kcp bind apiexport root:provider:apis.contrib.kcp.io 
+kubectl apply -f ./config/samples/apis_v1alpha1_application.yaml
+
+# Consumer 2
+kubectl ws use :root
+kubectl ws create examples-kubebuilder-multicluster-2 --enter
+kubectl kcp bind apiexport root:provider:apis.contrib.kcp.io 
+kubectl apply -f ./config/samples/apis_v1alpha1_application.yaml
 ```
 
-**NOTE:** The makefile target mentioned above generates an 'install.yaml'
-file in the dist directory. This file contains all the resources built
-with Kustomize, which are necessary to install this project without its
-dependencies.
-
-2. Using the installer
-
-Users can just run 'kubectl apply -f <URL for YAML BUNDLE>' to install
-the project, i.e.:
+Then, start the example controller by passing the virtual workspace URL to it:
 
 ```sh
-kubectl apply -f https://raw.githubusercontent.com/<org>/multicluster-provider-kubebuilder-example/<tag or branch>/dist/install.yaml
+kubectl ws use :root:provider
+make run
 ```
 
-### By providing a Helm Chart
-
-1. Build the chart using the optional helm plugin
+Observe the controller reconciling the ` application-sample` Aplication in the workspaces:
 
 ```sh
-kubebuilder edit --plugins=helm/v1-alpha
-```
-
-2. See that a chart was generated under 'dist/chart', and users
-can obtain this solution from there.
-
-**NOTE:** If you change the project, you need to update the Helm Chart
-using the same command above to sync the latest changes. Furthermore,
-if you create webhooks, you need to use the above command with
-the '--force' flag and manually ensure that any custom configuration
-previously added to 'dist/chart/values.yaml' or 'dist/chart/manager/manager.yaml'
-is manually re-applied afterwards.
-
-## Contributing
-// TODO(user): Add detailed information on how you would like others to contribute to this project
-
-**NOTE:** Run `make help` for more information on all potential `make` targets
-
-More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
-
-## License
-
-Copyright 2025.
-
-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.
-
+2025-03-11T13:04:52+02:00       INFO    Reconciling Application {"controller": "kcp-applications-controller", "controllerGroup": "apis.contrib.kcp.io", "controllerKind": "Application", "reconcileID": "babfc696-50cc-4851-ab35-d1d956a6c120", "cluster": "1058d5hgzdd3ask6"}
+```