update scaffolding && support tilt local deployment

Signed-off-by: bo.jiang <bo.jiang@daocloud.io>

Author: ErikJiang

.gitignore

@@ -1,23 +1,28 @@
-# Binaries
+# Binaries for programs and plugins
 *.exe
 *.exe~
 *.dll
 *.so
 *.dylib
-bin/
+bin/*
+Dockerfile.cross
 
-# Test binary, build with `go test -c`
+# Test binary, built with `go test -c`
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
-# goland
-.idea
+# Go workspace file
+go.work
 
-.DS_Store
+# Kubernetes Generated files - skip generated files, except for vendored files
+!vendor/**/zz_generated.*
 
-# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
-# Ignore build and test binaries.
-bin/
-testbin/
+# editor and IDE paraphernalia
+.idea
+.vscode
+*.swp
+*.swo
+*~
+.tiltbuild/*

Dockerfile

@@ -12,16 +12,14 @@ COPY go.sum go.sum
 RUN go mod download
 
 # Copy the go source
-COPY cmd/main.go cmd/main.go
-COPY api/ api/
-COPY internal/ internal/
+COPY ./ ./
 
 # Build
 # the GOARCH has not a default value to allow the binary be built according to the host where the command
 # was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO
 # the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore,
 # by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
-RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

Makefile

@@ -1,5 +1,5 @@
 # Image URL to use all building/pushing image targets
-IMG ?= controller:latest
+IMG ?= gcr.io/k8s-staging-cluster-api-huawei/cluster-api-huawei-controller:latest
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.31.0
 
@@ -92,11 +92,11 @@ lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
 
 .PHONY: build
 build: manifests generate fmt vet ## Build manager binary.
-	go build -o bin/manager cmd/main.go
+	go build -o bin/manager main.go
 
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.
-	go run ./cmd/main.go
+	go run ./main.go
 
 # 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.
@@ -130,7 +130,7 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
 	mkdir -p dist
 	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
-	$(KUSTOMIZE) build config/default > dist/install.yaml
+	$(KUSTOMIZE) build config/default | envsubst > dist/install.yaml
 
 ##@ Deployment
 
@@ -149,11 +149,11 @@ uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified
 .PHONY: deploy
 deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
 	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
-	$(KUSTOMIZE) build config/default | $(KUBECTL) apply -f -
+	$(KUSTOMIZE) build config/default | envsubst | $(KUBECTL) apply -f -
 
 .PHONY: undeploy
 undeploy: kustomize ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
-	$(KUSTOMIZE) build config/default | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
+	$(KUSTOMIZE) build config/default | envsubst | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
 
 ##@ Dependencies
 

PROJECT

@@ -6,24 +6,32 @@ domain: cluster.x-k8s.io
 layout:
 - go.kubebuilder.io/v4
 projectName: cluster-api-provider-huawei
-repo: github.com/HuaweiCloudDeveloper/cluster-api-provider-Huawei
+repo: github.com/HuaweiCloudDeveloper/cluster-api-provider-huawei
 resources:
 - api:
     crdVersion: v1
     namespaced: true
   controller: true
   domain: cluster.x-k8s.io
   group: infrastructure
-  kind: HuaweiCloudMachine
-  path: github.com/HuaweiCloudDeveloper/cluster-api-provider-Huawei/api/v1alpha1
+  kind: HuaweiCloudCluster
+  path: github.com/HuaweiCloudDeveloper/cluster-api-provider-huawei/api/v1alpha1
   version: v1alpha1
 - api:
     crdVersion: v1
     namespaced: true
   controller: true
   domain: cluster.x-k8s.io
   group: infrastructure
-  kind: HuaweiCloudCluster
-  path: github.com/HuaweiCloudDeveloper/cluster-api-provider-Huawei/api/v1alpha1
+  kind: HuaweiCloudMachine
+  path: github.com/HuaweiCloudDeveloper/cluster-api-provider-huawei/api/v1alpha1
+  version: v1alpha1
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: cluster.x-k8s.io
+  group: infrastructure
+  kind: HuaweiCloudMachineTemplate
+  path: github.com/HuaweiCloudDeveloper/cluster-api-provider-huawei/api/v1alpha1
   version: v1alpha1
 version: "3"

README.md

@@ -3,12 +3,12 @@
 Kubernetes-native declarative infrastructure for [Huawei Cloud](https://www.huaweicloud.com/).
 
 <!-- goreportcard badge -->
-<a href="https://goreportcard.com/report/HuaweiCloudDeveloper/cluster-api-provider-Huawei">
-<img src="https://goreportcard.com/badge/HuaweiCloudDeveloper/cluster-api-provider-Huawei"></a>
+<a href="https://goreportcard.com/report/HuaweiCloudDeveloper/cluster-api-provider-huawei">
+<img src="https://goreportcard.com/badge/HuaweiCloudDeveloper/cluster-api-provider-huawei"></a>
 
 ## What is the Cluster API Provider Huawei Cloud?
 
 The Cluster API Provider Huawei Cloud is a Kubernetes project to bring declarative,
 Kubernetes-style APIs to cluster creation, configuration, and management.
 It provides optional, additive functionality on top of [Cluster API](https://github.com/kubernetes-sigs/cluster-api)
-to deploy and manage Kubernetes clusters on Huawei Cloud.
+to deploy and manage Kubernetes clusters on Huawei Cloud.

api/v1alpha1/groupversion_info.go

@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2025.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -20,26 +20,17 @@ limitations under the License.
 package v1alpha1
 
 import (
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/runtime"
 	"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: "infrastructure.cluster.x-k8s.io", Version: "v1alpha1"}
 
-	// schemeBuilder is used to add go types to the GroupVersionKind scheme.
-	schemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
+	// 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
-
-	objectTypes = []runtime.Object{}
+	AddToScheme = SchemeBuilder.AddToScheme
 )
-
-func addKnownTypes(scheme *runtime.Scheme) error {
-	scheme.AddKnownTypes(GroupVersion, objectTypes...)
-	metav1.AddToGroupVersion(scheme, GroupVersion)
-	return nil
-}

api/v1alpha1/huaweicloudcluster_types.go

@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2025.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -18,7 +18,6 @@ package v1alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 )
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
@@ -29,15 +28,8 @@ type HuaweiCloudClusterSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
 
-	// The ECS Region the cluster lives in.
-	Region string `json:"region,omitempty"`
-
-	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
-	// +optional
-	ControlPlaneEndpoint clusterv1.APIEndpoint `json:"controlPlaneEndpoint"`
-
-	// TODO, Network related fields need to be defined in the future
-	// other fields may like S3, SSHKey, etc.
+	// Foo is an example field of HuaweiCloudCluster. Edit huaweicloudcluster_types.go to remove/update
+	Foo string `json:"foo,omitempty"`
 }
 
 // HuaweiCloudClusterStatus defines the observed state of HuaweiCloudCluster.
@@ -68,5 +60,5 @@ type HuaweiCloudClusterList struct {
 }
 
 func init() {
-	objectTypes = append(objectTypes, &HuaweiCloudCluster{}, &HuaweiCloudClusterList{})
+	SchemeBuilder.Register(&HuaweiCloudCluster{}, &HuaweiCloudClusterList{})
 }

api/v1alpha1/huaweicloudmachine_types.go

@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2025.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -18,69 +18,24 @@ package v1alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 )
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
 // HuaweiCloudMachineSpec defines the desired state of HuaweiCloudMachine.
-// Most attributes are referred to https://github.com/huaweicloud/huaweicloud-sdk-go-v3/blob/master/services/ecs/v2/model/model_nova_create_servers_option.go
 type HuaweiCloudMachineSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
 
-	// 弹性云服务器uuid。
-	// ProviderID is the unique identifier as specified by the cloud provider.
-	ProviderID *string `json:"providerID,omitempty"`
-
-	// InstanceID is the ECS instance ID for this machine.
-	InstanceID *string `json:"instanceID,omitempty"`
-
-	// 镜像ID或者镜像资源的URL
-	// ImageRef is the reference from which to create the machine instance.
-	ImageRef *string `json:"imageRef,omitempty"`
-
-	// FlavorRef is similar to instanceType.
-	// FlavorRef is the type of instance to create. Example: s2.small.1
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:MinLength:=2
-	FlavorRef string `json:"flavorRef"`
-
-	// TODO, need to define the type of Volume struct in the future
-	// RootVolume encapsulates the configuration options for the root volume
-	// +optional
-	// RootVolume *model.RootVolume `json:"rootVolume,omitempty"`
-	// Configuration options for the data storage volumes.
-	// +optional
-	// DataVolumes *[]model.DataVolumes `json:"dataVolumes,omitempty"`
-
-	// TODO, more fields need to be defined in the future
-	// AdminPass *string `json:"admin_pass,omitempty"`
-	// NetConfig *NetConfig `json:"net_config"`
-	// Bandwidth *BandwidthConfig `json:"bandwidth,omitempty"`
+	// Foo is an example field of HuaweiCloudMachine. Edit huaweicloudmachine_types.go to remove/update
+	Foo string `json:"foo,omitempty"`
 }
 
 // HuaweiCloudMachineStatus defines the observed state of HuaweiCloudMachine.
 type HuaweiCloudMachineStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
-
-	// Ready is true when the provider resource is ready.
-	// +optional
-	Ready bool `json:"ready"`
-
-	// Addresses contains the ECS instance associated addresses.
-	Addresses []clusterv1.MachineAddress `json:"addresses,omitempty"`
-
-	// InstanceState is the state of the ECS instance for this machine.
-	// +optional
-	InstanceState *InstanceState `json:"instanceState,omitempty"`
-
-	// +optional
-	FailureMessage *string `json:"failureMessage,omitempty"`
-
-	// TODO add conditions and more fields in the future
 }
 
 // +kubebuilder:object:root=true
@@ -105,5 +60,5 @@ type HuaweiCloudMachineList struct {
 }
 
 func init() {
-	objectTypes = append(objectTypes, &HuaweiCloudMachine{}, &HuaweiCloudMachineList{})
+	SchemeBuilder.Register(&HuaweiCloudMachine{}, &HuaweiCloudMachineList{})
 }

api/v1alpha1/huaweicloudmachinetemplate_types.go

@@ -0,0 +1,64 @@
+/*
+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.
+*/
+
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+// HuaweiCloudMachineTemplateSpec defines the desired state of HuaweiCloudMachineTemplate.
+type HuaweiCloudMachineTemplateSpec struct {
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// Foo is an example field of HuaweiCloudMachineTemplate. Edit huaweicloudmachinetemplate_types.go to remove/update
+	Foo string `json:"foo,omitempty"`
+}
+
+// HuaweiCloudMachineTemplateStatus defines the observed state of HuaweiCloudMachineTemplate.
+type HuaweiCloudMachineTemplateStatus struct {
+	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+
+// HuaweiCloudMachineTemplate is the Schema for the huaweicloudmachinetemplates API.
+type HuaweiCloudMachineTemplate struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   HuaweiCloudMachineTemplateSpec   `json:"spec,omitempty"`
+	Status HuaweiCloudMachineTemplateStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// HuaweiCloudMachineTemplateList contains a list of HuaweiCloudMachineTemplate.
+type HuaweiCloudMachineTemplateList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []HuaweiCloudMachineTemplate `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&HuaweiCloudMachineTemplate{}, &HuaweiCloudMachineTemplateList{})
+}