State management

.github/dependabot.yaml

@@ -6,6 +6,7 @@ updates:
       interval: daily
     open-pull-requests-limit: 5
     ignore:
+      - dependency-name: k8s.io/api
       - dependency-name: k8s.io/apiextensions-apiserver
       - dependency-name: k8s.io/apimachinery
       - dependency-name: k8s.io/client-go
@@ -14,4 +15,4 @@ updates:
     directory: "/"
     schedule:
       interval: daily
-    open-pull-requests-limit: 5
+    open-pull-requests-limit: 5

.github/workflows/release.yml

@@ -38,7 +38,7 @@ jobs:
           cache-to: type=gha,mode=max
 
       - name: Prepare HMC chart
-        run: IMG="ghcr.io/mirantis/hmc/controller:${{ github.ref_name }}" make hmc-chart-release
+        run: VERSION="${{ github.ref_name }}" make hmc-chart-release
       - name: Push charts to GHCR
         run: REGISTRY_REPO="oci://ghcr.io/mirantis/hmc/charts" make helm-push
 

Makefile

@@ -54,30 +54,21 @@ help: ## Display this help.
 ##@ Development
 
 .PHONY: manifests
-manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
-	$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
+manifests: controller-gen ## Generate CustomResourceDefinition objects.
+	$(CONTROLLER_GEN) crd paths="./..." output:crd:artifacts:config=templates/hmc/templates/crds
 
 .PHONY: generate
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
-.PHONY: hmc-chart-generate
-hmc-chart-generate: kustomize helmify yq ## Generate hmc helm chart
-	rm -rf templates/hmc/values.yaml templates/hmc/templates/*.yaml
-	$(KUSTOMIZE) build config/default | $(HELMIFY) templates/hmc
-	$(YQ) eval -iN '' templates/hmc/values.yaml config/default/hmc_values.yaml
-
 .PHONY: set-hmc-version
-set-hmc-version:
+set-hmc-version: yq
 	$(YQ) eval '.version = "$(VERSION)"' -i templates/hmc/Chart.yaml
 	$(YQ) eval '.version = "$(VERSION)"' -i templates/hmc-templates/Chart.yaml
+	$(YQ) eval '.image.tag = "$(VERSION)"' -i templates/hmc/values.yaml
 
 .PHONY: hmc-chart-release
-hmc-chart-release: kustomize helmify yq set-hmc-version templates-generate ## Generate hmc helm chart
-	rm -rf templates/hmc/values.yaml templates/hmc/templates/*.yaml
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
-	$(KUSTOMIZE) build config/default | $(HELMIFY) templates/hmc
-	$(YQ) eval -iN '' templates/hmc/values.yaml config/default/hmc_values.yaml
+hmc-chart-release: set-hmc-version templates-generate ## Generate hmc helm chart
 
 .PHONY: hmc-dist-release
 hmc-dist-release: $(HELM) $(YQ)
@@ -94,7 +85,7 @@ templates-generate:
 	@hack/templates.sh
 
 .PHONY: generate-all
-generate-all: generate manifests hmc-chart-generate templates-generate add-license
+generate-all: generate manifests templates-generate add-license
 
 .PHONY: fmt
 fmt: ## Run go fmt against code.
@@ -119,11 +110,11 @@ test-e2e:
 
 .PHONY: lint
 lint: golangci-lint ## Run golangci-lint linter & yamllint
-	$(GOLANGCI_LINT) run
+	@$(GOLANGCI_LINT) run
 
 .PHONY: lint-fix
 lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
-	$(GOLANGCI_LINT) run --fix
+	@$(GOLANGCI_LINT) run --fix
 
 .PHONY: add-license
 add-license: addlicense
@@ -193,12 +184,6 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	- $(CONTAINER_TOOL) buildx rm project-v3-builder
 	rm Dockerfile.cross
 
-.PHONY: build-installer
-build-installer: generate-all 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
-
 ##@ Deployment
 
 KIND_CLUSTER_NAME ?= hmc-dev
@@ -244,26 +229,16 @@ registry-undeploy:
 
 .PHONY: hmc-deploy
 hmc-deploy: helm
-	$(HELM) dependency update templates/hmc
-	$(HELM) upgrade --values $(HMC_VALUES) --install --create-namespace hmc templates/hmc -n $(NAMESPACE)
-
-.PHONY: deploy
-deploy: generate-all 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 -
-
-.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 -
+	$(HELM) upgrade --values $(HMC_VALUES) --reuse-values --install --create-namespace hmc templates/hmc -n $(NAMESPACE)
 
 .PHONY: dev-deploy
-dev-deploy: hmc-chart-generate ## Deploy HMC helm chart to the K8s cluster specified in ~/.kube/config.
+dev-deploy: ## Deploy HMC helm chart to the K8s cluster specified in ~/.kube/config.
 	make hmc-deploy HMC_VALUES=config/dev/hmc_values.yaml
 	$(KUBECTL) rollout restart -n $(NAMESPACE) deployment/hmc-controller-manager
 
 .PHONY: dev-undeploy
-dev-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/dev | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
+dev-undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
+	$(HELM) delete -n $(NAMESPACE) hmc
 
 .PHONY: helm-push
 helm-push: helm-package
@@ -289,16 +264,12 @@ dev-push: docker-build helm-push
 dev-templates: templates-generate
 	$(KUBECTL) -n $(NAMESPACE) apply -f templates/hmc-templates/files/templates
 
-.PHONY: dev-management
-dev-management: yq
-	$(YQ) '.spec.core.hmc.config += (load("config/dev/hmc_values.yaml"))' config/dev/management.yaml | $(KUBECTL) -n $(NAMESPACE) apply -f -
-
 .PHONY: dev-aws
 dev-aws: yq
 	@$(YQ) e ".data.credentials = \"${AWS_CREDENTIALS}\"" config/dev/awscredentials.yaml | $(KUBECTL) -n $(NAMESPACE) apply -f -
 
 .PHONY: dev-apply
-dev-apply: kind-deploy registry-deploy dev-push dev-deploy dev-templates dev-management dev-aws
+dev-apply: kind-deploy registry-deploy dev-push dev-deploy dev-templates dev-aws
 
 .PHONY: dev-destroy
 dev-destroy: kind-undeploy registry-undeploy
@@ -333,36 +304,27 @@ FLUX_HELM_CRD ?= $(EXTERNAL_CRD_DIR)/helm-$(FLUX_HELM_VERSION).yaml
 
 ## Tool Binaries
 KUBECTL ?= kubectl
-KUSTOMIZE ?= $(LOCALBIN)/kustomize-$(KUSTOMIZE_VERSION)
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen-$(CONTROLLER_TOOLS_VERSION)
 ENVTEST ?= $(LOCALBIN)/setup-envtest-$(ENVTEST_VERSION)
 GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-$(GOLANGCI_LINT_VERSION)
 HELM ?= $(LOCALBIN)/helm-$(HELM_VERSION)
-HELMIFY ?= $(LOCALBIN)/helmify-$(HELMIFY_VERSION)
 KIND ?= $(LOCALBIN)/kind-$(KIND_VERSION)
 YQ ?= $(LOCALBIN)/yq-$(YQ_VERSION)
 CLUSTERAWSADM ?= $(LOCALBIN)/clusterawsadm
 CLUSTERCTL ?= $(LOCALBIN)/clusterctl
 ADDLICENSE ?= $(LOCALBIN)/addlicense-$(ADDLICENSE_VERSION)
 
 ## Tool Versions
-KUSTOMIZE_VERSION ?= v5.3.0
 CONTROLLER_TOOLS_VERSION ?= v0.14.0
 ENVTEST_VERSION ?= release-0.17
-GOLANGCI_LINT_VERSION ?= v1.57.2
+GOLANGCI_LINT_VERSION ?= v1.60.1
 HELM_VERSION ?= v3.15.1
-HELMIFY_VERSION ?= v0.4.13
 KIND_VERSION ?= v0.23.0
 YQ_VERSION ?= v4.44.2
 CLUSTERAWSADM_VERSION ?= v2.5.2
 CLUSTERCTL_VERSION ?= v1.7.3
 ADDLICENSE_VERSION ?= v1.1.1
 
-.PHONY: kustomize
-kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
-$(KUSTOMIZE): | $(LOCALBIN)
-	$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION))
-
 .PHONY: controller-gen
 controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
 $(CONTROLLER_GEN): | $(LOCALBIN)
@@ -385,11 +347,6 @@ $(HELM): | $(LOCALBIN)
 	rm -f $(LOCALBIN)/helm-*
 	curl -s $(HELM_INSTALL_SCRIPT) | USE_SUDO=false HELM_INSTALL_DIR=$(LOCALBIN) DESIRED_VERSION=$(HELM_VERSION) BINARY_NAME=helm-$(HELM_VERSION) PATH="$(LOCALBIN):$(PATH)" bash
 
-.PHONY: helmify
-helmify: $(HELMIFY) ## Download helmify locally if necessary.
-$(HELMIFY): | $(LOCALBIN)
-	$(call go-install-tool,$(HELMIFY),github.com/arttor/helmify/cmd/helmify,${HELMIFY_VERSION})
-
 $(FLUX_HELM_CRD): $(EXTERNAL_CRD_DIR)
 	rm -f $(FLUX_HELM_CRD)
 	curl -s https://raw.githubusercontent.com/fluxcd/helm-controller/$(FLUX_HELM_VERSION)/config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml > $(FLUX_HELM_CRD)

README.md

@@ -12,6 +12,10 @@ or install using `helm`
 
 Then follow the [Deploy a managed cluster](#deploy-a-managed-cluster) guide to create a managed cluster.
 
+> Note: The HMC installation using Kubernetes manifests does not allow customization of the deployment. To apply a custom HMC configuration, install HMC using the Helm chart.
+> deployment. If the custom HMC configuration should be applied, install HMC using
+> the Helm chart.
+
 ### Development guide
 
 See [Install HMC for development purposes](docs/dev.md#hmc-installation-for-development).
@@ -78,11 +82,11 @@ configuration:
    * Create `management.yaml` file and configure core components and providers.
    See [Management API](api/v1alpha1/management_types.go).
 
-   * Specify `--create-management=false` controllerManager argument and install HMC:
+   * Specify `--create-management=false` controller argument and install HMC:
 
     If installing using `helm` add the following parameter to the `helm install` command:
 
-    `--set="controllerManager.manager.args={--create-management=false}"`
+    `--set="controller.createManagement=false"`
 
    * Create `hmc-system/hmc` `Management` object after HMC installation:
 
@@ -232,3 +236,19 @@ spec:
       type: Ready
     observedGeneration: 1
 ```
+
+## Cleanup
+
+1. Remove the Management object:
+
+`kubectl delete management.hmc hmc -n hmc-system`
+
+> Note: make sure you have no HMC Deployment objects left in the cluster prior to Management deletion
+
+2. Remove the `hmc` Helm release:
+
+`helm uninstall hmc -n hmc-system`
+
+3. Remove the `hmc-system` namespace:
+
+`kubectl delete ns hmc-system`

api/v1alpha1/deployment_types.go

@@ -24,7 +24,8 @@ import (
 const (
 	DeploymentFinalizer = "hmc.mirantis.com/deployment"
 
-	HMCManagedLabelKey = "hmc.mirantis.com/managed"
+	HMCManagedLabelKey   = "hmc.mirantis.com/managed"
+	HMCManagedLabelValue = "true"
 )
 
 const (

api/v1alpha1/management_types.go

@@ -30,8 +30,19 @@ const (
 
 	ManagementName      = "hmc"
 	ManagementNamespace = "hmc-system"
+
+	ManagementFinalizer = "hmc.mirantis.com/management"
 )
 
+var DefaultCoreConfiguration = Core{
+	HMC: Component{
+		Template: DefaultCoreHMCTemplate,
+	},
+	CAPI: Component{
+		Template: DefaultCoreCAPITemplate,
+	},
+}
+
 // ManagementSpec defines the desired state of Management
 type ManagementSpec struct {
 	// Core holds the core Management components that are mandatory.
@@ -68,7 +79,19 @@ func (in *Component) HelmValues() (values map[string]interface{}, err error) {
 	return values, err
 }
 
-func (m *ManagementSpec) SetDefaults() {
+func (in *Component) HelmReleaseName() string {
+	return in.Template
+}
+
+func (m *ManagementSpec) SetDefaults() bool {
+	if m.Core != nil {
+		return false
+	}
+	m.Core = &DefaultCoreConfiguration
+	return true
+}
+
+func (m *ManagementSpec) SetProvidersDefaults() {
 	m.Providers = []Component{
 		{
 			Template: "k0smotron",