Add adopted cluster template to adopt existing k8s clusters

README.md

@@ -29,8 +29,8 @@ or install using `helm`
 helm install hmc oci://ghcr.io/mirantis/hmc/charts/hmc --version 0.0.5 -n hmc-system --create-namespace
 ```
 
-Then follow the [Deploy a managed cluster](#deploy-a-managed-cluster) guide to
-create a managed cluster.
+Then follow the [Deploy a cluster deployment](#deploy-a-cluster-deployment) guide to
+create a cluster deployment.
 
 > [!NOTE]
 > The HMC installation using Kubernetes manifests does not allow
@@ -51,7 +51,7 @@ Mirantis Hybrid Container Cloud requires the following:
 Optionally, the following CLIs may be helpful:
 
 1. `helm` (required only when installing HMC using `helm`).
-2. `clusterctl` (to handle the lifecycle of the managed clusters).
+2. `clusterctl` (to handle the lifecycle of the cluster deployments).
 
 ### Providers configuration
 
@@ -109,9 +109,9 @@ own `Management` configuration:
 
     `kubectl --kubeconfig <path-to-management-kubeconfig> create -f management.yaml`
 
-## Deploy a managed cluster
+## Create a ClusterDeployment
 
-To deploy a managed cluster:
+To create a ClusterDeployment:
 
 1. Create `Credential` object with all credentials required.
 
@@ -173,7 +173,7 @@ kubectl -n <clusterdeployment-namespace> get cluster <clusterdeployment-name> -o
 > cluster <clusterdeployment-name> -n <clusterdeployment-namespace> --show-conditions
 > all ```
 
-6. Retrieve the `kubeconfig` of your managed cluster:
+6. Retrieve the `kubeconfig` of your cluster deployment:
 
 ```
 kubectl get secret -n hmc-system <clusterdeployment-name>-kubeconfig -o=jsonpath={.data.value} | base64 -d > kubeconfig

api/v1alpha1/managedcluster_types.go → api/v1alpha1/clusterdeployment_types.go

@@ -106,7 +106,7 @@ type ClusterDeploymentStatus struct {
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
-// +kubebuilder:resource:shortName=mcluster;mcl
+// +kubebuilder:resource:shortName=clusterd;cld
 // +kubebuilder:printcolumn:name="ready",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].status",description="Ready",priority=0
 // +kubebuilder:printcolumn:name="status",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].message",description="Status",priority=0
 // +kubebuilder:printcolumn:name="dryRun",type="string",JSONPath=".spec.dryRun",description="Dry Run",priority=1

api/v1alpha1/indexers.go

@@ -42,7 +42,7 @@ func SetupIndexers(ctx context.Context, mgr ctrl.Manager) error {
 	return merr
 }
 
-// managed cluster
+// cluster deployment
 
 // ClusterDeploymentTemplateIndexKey indexer field name to extract ClusterTemplate name reference from a ClusterDeployment object.
 const ClusterDeploymentTemplateIndexKey = ".spec.template"
@@ -89,12 +89,12 @@ func ExtractServiceTemplateNamesFromClusterDeployment(rawObj client.Object) []st
 const ClusterDeploymentCredentialIndexKey = ".spec.credential"
 
 func setupClusterDeploymentCredentialIndexer(ctx context.Context, mgr ctrl.Manager) error {
-	return mgr.GetFieldIndexer().IndexField(ctx, &ClusterDeployment{}, ClusterDeploymentCredentialIndexKey, ExtractCredentialNameFromClusterDeployment)
+	return mgr.GetFieldIndexer().IndexField(ctx, &ClusterDeployment{}, ClusterDeploymentCredentialIndexKey, extractCredentialNameFromClusterDeployment)
 }
 
-// ExtractCredentialNameFromClusterDeployment returns referenced Credential name
+// extractCredentialNameFromClusterDeployment returns referenced Credential name
 // declared in a ClusterDeployment object.
-func ExtractCredentialNameFromClusterDeployment(rawObj client.Object) []string {
+func extractCredentialNameFromClusterDeployment(rawObj client.Object) []string {
 	cluster, ok := rawObj.(*ClusterDeployment)
 	if !ok {
 		return nil

config/dev/adopted-clusterdeployment.yaml

@@ -0,0 +1,16 @@
+apiVersion: hmc.mirantis.com/v1alpha1
+kind: ClusterDeployment
+metadata:
+  name: adopted-dev
+  namespace: ${NAMESPACE}
+spec:
+  template: adopted-cluster-0-0-1
+  credential: adopted-cluster-cred
+  config: {}
+  services:
+    - template: kyverno-3-2-6
+      name: kyverno
+      namespace: kyverno
+    - template: ingress-nginx-4-11-0
+      name: ingress-nginx
+      namespace: ingress-nginx

config/dev/adopted-credentials.yaml

@@ -0,0 +1,21 @@
+apiVersion: v1
+data:
+  value: ${KUBECONFIG_DATA}
+kind: Secret
+metadata:
+  name: adopted-cluster-kubeconf
+  namespace: ${NAMESPACE}
+type: Opaque
+---
+apiVersion: hmc.mirantis.com/v1alpha1
+kind: Credential
+metadata:
+  name: adopted-cluster-cred
+  namespace: ${NAMESPACE}
+spec:
+  description: Adopted Credentials
+  identityRef:
+    apiVersion: v1
+    kind: Secret
+    name: adopted-cluster-kubeconf
+    namespace: ${NAMESPACE}

docs/dev.md

@@ -96,7 +96,7 @@ another provider change `DEV_PROVIDER` variable with the name of provider before
 running make (e.g. `export DEV_PROVIDER=azure`).
 
 1. Configure your cluster parameters in provider specific file
-   (for example `config/dev/aws-clusterDeployment.yaml` in case of AWS):
+   (for example `config/dev/aws-clusterdeployment.yaml` in case of AWS):
 
     * Configure the `name` of the ClusterDeployment
     * Change instance type or size for control plane and worker machines

internal/controller/clusterdeployment_controller.go

@@ -104,9 +104,7 @@ func (r *ClusterDeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Re
 	return r.reconcileUpdate(ctx, clusterDeployment)
 }
 
-func (r *ClusterDeploymentReconciler) setStatusFromChildObjects(
-	ctx context.Context, clusterDeployment *hmc.ClusterDeployment, gvr schema.GroupVersionResource, conditions []string,
-) (requeue bool, _ error) {
+func (r *ClusterDeploymentReconciler) setStatusFromChildObjects(ctx context.Context, clusterDeployment *hmc.ClusterDeployment, gvr schema.GroupVersionResource, conditions []string) (requeue bool, _ error) {
 	l := ctrl.LoggerFrom(ctx)
 
 	resourceConditions, err := status.GetResourceConditions(ctx, clusterDeployment.Namespace, r.DynamicClient, gvr,

internal/controller/management_controller.go

@@ -116,16 +116,14 @@ func (r *ManagementReconciler) Update(ctx context.Context, management *hmc.Manag
 		errs error
 
 		statusAccumulator = &mgmtStatusAccumulator{
-			providers:              hmc.Providers{},
+			providers:              hmc.Providers{"infrastructure-internal"},
 			components:             make(map[string]hmc.ComponentStatus),
 			compatibilityContracts: make(map[string]hmc.CompatibilityContracts),
 		}
 
 		requeue bool
 	)
 
-	statusAccumulator.providers = append(statusAccumulator.providers, "infrastructure-internal")
-
 	for _, component := range components {
 		l.V(1).Info("reconciling components", "component", component)
 		template := new(hmc.ProviderTemplate)

templates/cluster/adopted-cluster/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

templates/cluster/adopted-cluster/Chart.yaml

@@ -0,0 +1,11 @@
+apiVersion: v2
+name: adopted-cluster
+description: |
+  An HMC template to adopt an already existing kubernetes cluster
+type: application
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.0.1
+annotations:
+  cluster.x-k8s.io/provider: infrastructure-internal

templates/cluster/adopted-cluster/templates/_helpers.tpl

@@ -0,0 +1,4 @@
+{{- define "cluster.name" -}}
+    {{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+

templates/cluster/adopted-cluster/templates/sveltoscluster.yaml

@@ -0,0 +1,7 @@
+apiVersion: lib.projectsveltos.io/v1beta1
+kind: SveltosCluster
+metadata:
+  name: {{ include "cluster.name" . }}
+spec:
+  consecutiveFailureThreshold: {{ .Values.consecutiveFailureThreshold }}
+  kubeconfigName: {{ .Values.clusterIdentity.name }}

templates/cluster/adopted-cluster/values.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "An HMC template to adopt an existing k8s cluster.",
+  "type": "object",
+  "required": [
+    "clusterIdentity"
+  ],
+  "properties": {
+    "consecutiveFailureThreshold": {
+      "description": "The number of the failures prior to setting the status condition",
+      "type": "integer",
+      "minimum": 1
+    }
+  }
+}

templates/cluster/adopted-cluster/values.yaml

@@ -0,0 +1,6 @@
+# Cluster parameters
+
+clusterIdentity:
+  name: "adopted-cluster-identity"
+
+consecutiveFailureThreshold: 3

templates/provider/hmc-templates/files/templates/adopted-cluster-0-0-1.yaml

@@ -0,0 +1,15 @@
+apiVersion: hmc.mirantis.com/v1alpha1
+kind: ClusterTemplate
+metadata:
+  name: adopted-cluster-0-0-1
+  annotations:
+    helm.sh/resource-policy: keep
+spec:
+  helm:
+    chartSpec:
+      chart: adopted-cluster
+      version: 0.0.1
+      interval: 10m0s
+      sourceRef:
+        kind: HelmRepository
+        name: hmc-templates