Skip to content

feat: support full cluster-based templating for referenced resource n… #1183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gianlucam76 merged 1 commit into from
May 6, 2025
Merged

feat: support full cluster-based templating for referenced resource n… #1183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 56 additions & 40 deletions controllers/clustersummary_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ func (r *ClusterSummaryReconciler) Reconcile(ctx context.Context, req ctrl.Reque
r.resetFeatureStatus(clusterSummaryScope, configv1beta1.FeatureStatusFailed)
// if cluster is not ready, do nothing and don't queue for reconciliation.
// When cluster becomes ready, all matching clusterSummaries will be requeued for reconciliation
_ = r.updateMaps(clusterSummaryScope, logger)
_ = r.updateMaps(ctx, clusterSummaryScope, logger)

return reconcile.Result{}, nil
}
Expand Down Expand Up @@ -337,7 +337,7 @@ func (r *ClusterSummaryReconciler) reconcileNormal(
return reconcile.Result{}, nil
}

err := r.updateMaps(clusterSummaryScope, logger)
err := r.updateMaps(ctx, clusterSummaryScope, logger)
if err != nil {
return reconcile.Result{}, err
}
Expand Down Expand Up @@ -711,13 +711,15 @@ func (r *ClusterSummaryReconciler) cleanMaps(clusterSummaryScope *scope.ClusterS
}
}

func (r *ClusterSummaryReconciler) updateMaps(clusterSummaryScope *scope.ClusterSummaryScope, logger logr.Logger) error {
func (r *ClusterSummaryReconciler) updateMaps(ctx context.Context, clusterSummaryScope *scope.ClusterSummaryScope,
logger logr.Logger) error {

if clusterSummaryScope.ClusterSummary.Spec.ClusterProfileSpec.SyncMode == configv1beta1.SyncModeOneTime {
logger.V(logs.LogDebug).Info("sync mode is one time. No need to reconcile on policies change.")
return nil
}
logger.V(logs.LogDebug).Info("update policy map")
currentReferences, err := r.getCurrentReferences(clusterSummaryScope)
currentReferences, err := r.getCurrentReferences(ctx, clusterSummaryScope)
if err != nil {
logger.V(logs.LogInfo).Info("failed to get current references: %v", err)
return err
Expand Down Expand Up @@ -834,21 +836,21 @@ func (r *ClusterSummaryReconciler) shouldReconcile(clusterSummaryScope *scope.Cl
return false
}

func (r *ClusterSummaryReconciler) getCurrentReferences(clusterSummaryScope *scope.ClusterSummaryScope,
) (*libsveltosset.Set, error) {
func (r *ClusterSummaryReconciler) getCurrentReferences(ctx context.Context,
clusterSummaryScope *scope.ClusterSummaryScope) (*libsveltosset.Set, error) {

currentReferences, err := r.getPolicyRefReferences(clusterSummaryScope)
currentReferences, err := r.getPolicyRefReferences(ctx, clusterSummaryScope)
if err != nil {
return nil, err
}

kustomizationRefs, err := r.getKustomizationRefReferences(clusterSummaryScope)
kustomizationRefs, err := r.getKustomizationRefReferences(ctx, clusterSummaryScope)
if err != nil {
return nil, err
}
currentReferences.Append(kustomizationRefs)

helmRefs, err := r.getHelmChartsReferences(clusterSummaryScope)
helmRefs, err := r.getHelmChartsReferences(ctx, clusterSummaryScope)
if err != nil {
return nil, err
}
Expand All @@ -858,17 +860,22 @@ func (r *ClusterSummaryReconciler) getCurrentReferences(clusterSummaryScope *sco
}

// getPolicyRefReferences get all references considering the PolicyRef section
func (r *ClusterSummaryReconciler) getPolicyRefReferences(clusterSummaryScope *scope.ClusterSummaryScope,
) (*libsveltosset.Set, error) {
func (r *ClusterSummaryReconciler) getPolicyRefReferences(ctx context.Context,
clusterSummaryScope *scope.ClusterSummaryScope) (*libsveltosset.Set, error) {

cs := clusterSummaryScope.ClusterSummary
currentReferences := &libsveltosset.Set{}
for i := range clusterSummaryScope.ClusterSummary.Spec.ClusterProfileSpec.PolicyRefs {
referencedNamespace := clusterSummaryScope.ClusterSummary.Spec.ClusterProfileSpec.PolicyRefs[i].Namespace
namespace := libsveltostemplate.GetReferenceResourceNamespace(clusterSummaryScope.Namespace(), referencedNamespace)
namespace, err := libsveltostemplate.GetReferenceResourceNamespace(ctx, getManagementClusterClient(),
cs.Spec.ClusterNamespace, cs.Spec.ClusterName, referencedNamespace, cs.Spec.ClusterType)
if err != nil {
return nil, err
}

cs := clusterSummaryScope.ClusterSummary
referencedName, err := libsveltostemplate.GetReferenceResourceName(cs.Spec.ClusterNamespace, cs.Spec.ClusterName,
string(cs.Spec.ClusterType), clusterSummaryScope.ClusterSummary.Spec.ClusterProfileSpec.PolicyRefs[i].Name)
referencedName, err := libsveltostemplate.GetReferenceResourceName(ctx, getManagementClusterClient(),
cs.Spec.ClusterNamespace, cs.Spec.ClusterName,
clusterSummaryScope.ClusterSummary.Spec.ClusterProfileSpec.PolicyRefs[i].Name, cs.Spec.ClusterType)
if err != nil {
return nil, err
}
Expand All @@ -884,21 +891,24 @@ func (r *ClusterSummaryReconciler) getPolicyRefReferences(clusterSummaryScope *s
}

// getKustomizationRefReferences get all references considering the KustomizationRef section
func (r *ClusterSummaryReconciler) getKustomizationRefReferences(clusterSummaryScope *scope.ClusterSummaryScope,
) (*libsveltosset.Set, error) {
func (r *ClusterSummaryReconciler) getKustomizationRefReferences(ctx context.Context,
clusterSummaryScope *scope.ClusterSummaryScope) (*libsveltosset.Set, error) {

cs := clusterSummaryScope.ClusterSummary
currentReferences := &libsveltosset.Set{}
for i := range clusterSummaryScope.ClusterSummary.Spec.ClusterProfileSpec.KustomizationRefs {
kr := &clusterSummaryScope.ClusterSummary.Spec.ClusterProfileSpec.KustomizationRefs[i]

referencedNamespace := kr.Namespace

namespace := libsveltostemplate.GetReferenceResourceNamespace(
clusterSummaryScope.Namespace(), referencedNamespace)
namespace, err := libsveltostemplate.GetReferenceResourceNamespace(ctx, getManagementClusterClient(),
cs.Spec.ClusterNamespace, cs.Spec.ClusterName, referencedNamespace, cs.Spec.ClusterType)
if err != nil {
return nil, err
}

cs := clusterSummaryScope.ClusterSummary
referencedName, err := libsveltostemplate.GetReferenceResourceName(cs.Spec.ClusterNamespace,
cs.Spec.ClusterName, string(cs.Spec.ClusterType), kr.Name)
referencedName, err := libsveltostemplate.GetReferenceResourceName(ctx, getManagementClusterClient(),
cs.Spec.ClusterNamespace, cs.Spec.ClusterName, kr.Name, cs.Spec.ClusterType)
if err != nil {
return nil, err
}
Expand All @@ -921,7 +931,7 @@ func (r *ClusterSummaryReconciler) getKustomizationRefReferences(clusterSummaryS
Name: referencedName,
})

valuesFromReferences, err := getKustomizationValueFrom(clusterSummaryScope, kr)
valuesFromReferences, err := getKustomizationValueFrom(ctx, clusterSummaryScope, kr)
if err != nil {
return nil, err
}
Expand All @@ -933,19 +943,22 @@ func (r *ClusterSummaryReconciler) getKustomizationRefReferences(clusterSummaryS
// getKustomizationValueFrom gets referenced ConfigMap/Secret in a KustomizationRef.
// KustomizationRef can reference both ConfigMap/Secret each containing key-value pairs that will be used, if defined,
// to replace placeholder value in the output generated by Kustomize SDK.
func getKustomizationValueFrom(clusterSummaryScope *scope.ClusterSummaryScope, kr *configv1beta1.KustomizationRef,
) (*libsveltosset.Set, error) {
func getKustomizationValueFrom(ctx context.Context, clusterSummaryScope *scope.ClusterSummaryScope,
kr *configv1beta1.KustomizationRef) (*libsveltosset.Set, error) {

currentValuesFromReferences := &libsveltosset.Set{}

cs := clusterSummaryScope.ClusterSummary
for i := range kr.ValuesFrom {
referencedNamespace := kr.ValuesFrom[i].Namespace
namespace := libsveltostemplate.GetReferenceResourceNamespace(
clusterSummaryScope.Namespace(), referencedNamespace)
namespace, err := libsveltostemplate.GetReferenceResourceNamespace(ctx, getManagementClusterClient(),
cs.Spec.ClusterNamespace, cs.Spec.ClusterName, referencedNamespace, cs.Spec.ClusterType)
if err != nil {
return nil, err
}

cs := clusterSummaryScope.ClusterSummary
referencedName, err := libsveltostemplate.GetReferenceResourceName(cs.Spec.ClusterNamespace,
cs.Spec.ClusterName, string(cs.Spec.ClusterType), kr.ValuesFrom[i].Name)
referencedName, err := libsveltostemplate.GetReferenceResourceName(ctx, getManagementClusterClient(),
cs.Spec.ClusterNamespace, cs.Spec.ClusterName, kr.ValuesFrom[i].Name, cs.Spec.ClusterType)
if err != nil {
return nil, err
}
Expand All @@ -962,8 +975,8 @@ func getKustomizationValueFrom(clusterSummaryScope *scope.ClusterSummaryScope, k
}

// getHelmChartsReferences get all references considering the HelmChart section
func (r *ClusterSummaryReconciler) getHelmChartsReferences(clusterSummaryScope *scope.ClusterSummaryScope,
) (*libsveltosset.Set, error) {
func (r *ClusterSummaryReconciler) getHelmChartsReferences(ctx context.Context,
clusterSummaryScope *scope.ClusterSummaryScope) (*libsveltosset.Set, error) {

currentReferences := &libsveltosset.Set{}
for i := range clusterSummaryScope.ClusterSummary.Spec.ClusterProfileSpec.HelmCharts {
Expand All @@ -977,7 +990,7 @@ func (r *ClusterSummaryReconciler) getHelmChartsReferences(clusterSummaryScope *
currentReferences.Insert(sourceRef)
}

valuesFromReferences, err := getHelmChartValueFrom(clusterSummaryScope, hc)
valuesFromReferences, err := getHelmChartValueFrom(ctx, clusterSummaryScope, hc)
if err != nil {
return nil, err
}
Expand All @@ -988,19 +1001,22 @@ func (r *ClusterSummaryReconciler) getHelmChartsReferences(clusterSummaryScope *

// getHelmChartValueFrom gets referenced ConfigMap/Secret in a HelmChart.
// HelmChart can reference both ConfigMap/Secret each containing configuration for the helm release.
func getHelmChartValueFrom(clusterSummaryScope *scope.ClusterSummaryScope, hc *configv1beta1.HelmChart,
) (*libsveltosset.Set, error) {
func getHelmChartValueFrom(ctx context.Context, clusterSummaryScope *scope.ClusterSummaryScope,
hc *configv1beta1.HelmChart) (*libsveltosset.Set, error) {

currentValuesFromReferences := &libsveltosset.Set{}

cs := clusterSummaryScope.ClusterSummary
for i := range hc.ValuesFrom {
referencedNamespace := hc.ValuesFrom[i].Namespace
namespace := libsveltostemplate.GetReferenceResourceNamespace(
clusterSummaryScope.Namespace(), referencedNamespace)
namespace, err := libsveltostemplate.GetReferenceResourceNamespace(ctx, getManagementClusterClient(),
cs.Spec.ClusterNamespace, cs.Spec.ClusterName, referencedNamespace, cs.Spec.ClusterType)
if err != nil {
return nil, err
}

cs := clusterSummaryScope.ClusterSummary
referencedName, err := libsveltostemplate.GetReferenceResourceName(cs.Spec.ClusterNamespace,
cs.Spec.ClusterName, string(cs.Spec.ClusterType), hc.ValuesFrom[i].Name)
referencedName, err := libsveltostemplate.GetReferenceResourceName(ctx, getManagementClusterClient(),
cs.Spec.ClusterNamespace, cs.Spec.ClusterName, hc.ValuesFrom[i].Name, cs.Spec.ClusterType)
if err != nil {
return nil, err
}
Expand Down
4 changes: 2 additions & 2 deletions controllers/clustersummary_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,7 @@ var _ = Describe("ClustersummaryController", func() {
clusterSummaryScope := getClusterSummaryScope(c,
textlogger.NewLogger(textlogger.NewConfig()), clusterProfile, clusterSummary)
reconciler := getClusterSummaryReconciler(nil, nil)
set, err := controllers.GetCurrentReferences(reconciler, clusterSummaryScope)
set, err := controllers.GetCurrentReferences(reconciler, context.TODO(), clusterSummaryScope)
Expect(err).To(BeNil())
Expect(set.Len()).To(Equal(4))
})
Expand All @@ -885,7 +885,7 @@ var _ = Describe("ClustersummaryController", func() {
clusterSummaryScope := getClusterSummaryScope(c,
textlogger.NewLogger(textlogger.NewConfig()), clusterProfile, clusterSummary)
reconciler := getClusterSummaryReconciler(nil, nil)
set, err := controllers.GetCurrentReferences(reconciler, clusterSummaryScope)
set, err := controllers.GetCurrentReferences(reconciler, context.TODO(), clusterSummaryScope)
Expect(err).To(BeNil())
Expect(set.Len()).To(Equal(1))
items := set.Items()
Expand Down
1 change: 1 addition & 0 deletions controllers/clustersummary_deployer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@ var _ = Describe("ClustersummaryDeployer", func() {
configMap,
clusterSummary,
clusterProfile,
cluster,
}

c := fake.NewClientBuilder().WithScheme(scheme).WithStatusSubresource(initObjects...).WithObjects(initObjects...).Build()
Expand Down
48 changes: 29 additions & 19 deletions controllers/handlers_helm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,8 +350,7 @@ func uninstallHelmCharts(ctx context.Context, c client.Client, clusterSummary *c

logger.V(logs.LogInfo).Info("ClusterProfile StopMatchingBehavior set to LeavePolicies")
} else {
credentialsPath, caPath, err := getCredentialsAndCAFiles(ctx, c,
clusterSummary.Spec.ClusterNamespace, currentChart)
credentialsPath, caPath, err := getCredentialsAndCAFiles(ctx, c, clusterSummary, currentChart)
if err != nil {
logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to process credentials %v", err))
return nil, err
Expand Down Expand Up @@ -828,8 +827,8 @@ func createRegistryClientOptions(ctx context.Context, clusterSummary *configv1be
return registryOptions, nil
}

credentialsPath, caPath, err := getCredentialsAndCAFiles(ctx, getManagementClusterClient(),
clusterSummary.Spec.ClusterNamespace, currentChart)
credentialsPath, caPath, err := getCredentialsAndCAFiles(ctx, getManagementClusterClient(), clusterSummary,
currentChart)
if err != nil {
logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to process credentials %v", err))
return registryOptions, err
Expand All @@ -841,8 +840,12 @@ func createRegistryClientOptions(ctx context.Context, clusterSummary *configv1be
registryOptions.skipTLSVerify = getInsecureSkipTLSVerify(currentChart)

if currentChart.RegistryCredentialsConfig.CredentialsSecretRef != nil {
credentialSecretNamespace := libsveltostemplate.GetReferenceResourceNamespace(clusterSummary.Spec.ClusterNamespace,
currentChart.RegistryCredentialsConfig.CredentialsSecretRef.Namespace)
credentialSecretNamespace, err := libsveltostemplate.GetReferenceResourceNamespace(ctx, getManagementClusterClient(),
clusterSummary.Spec.ClusterNamespace, clusterSummary.Spec.ClusterName,
currentChart.RegistryCredentialsConfig.CredentialsSecretRef.Namespace, clusterSummary.Spec.ClusterType)
if err != nil {
return nil, err
}

secret := &corev1.Secret{}
err = getManagementClusterClient().Get(ctx,
Expand Down Expand Up @@ -2077,8 +2080,7 @@ func collectResourcesFromManagedHelmChartsForDriftDetection(ctx context.Context,
l.V(logs.LogDebug).Info("collecting resources for helm chart")
// Conflicts are already resolved by the time this is invoked. So it is safe to call CanManageChart
if chartManager.CanManageChart(clusterSummary, currentChart) {
credentialsPath, caPath, err := getCredentialsAndCAFiles(ctx, c,
clusterSummary.Spec.ClusterNamespace, currentChart)
credentialsPath, caPath, err := getCredentialsAndCAFiles(ctx, c, clusterSummary, currentChart)
if err != nil {
logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to process credentials %v", err))
return nil, err
Expand Down Expand Up @@ -2666,15 +2668,15 @@ func getValueHashFromHelmChartSummary(requestedChart *configv1beta1.HelmChart,
return nil
}

func getCredentialsAndCAFiles(ctx context.Context, c client.Client, clusterNamespace string,
func getCredentialsAndCAFiles(ctx context.Context, c client.Client, clusterSummary *configv1beta1.ClusterSummary,
requestedChart *configv1beta1.HelmChart) (credentialsPath, caPath string, err error) {

credentialsPath, err = createFileWithCredentials(ctx, c, clusterNamespace, requestedChart)
credentialsPath, err = createFileWithCredentials(ctx, c, clusterSummary, requestedChart)
if err != nil {
return "", "", err
}

caPath, err = createFileWithCA(ctx, c, clusterNamespace, requestedChart)
caPath, err = createFileWithCA(ctx, c, clusterSummary, requestedChart)
if err != nil {
return "", "", err
}
Expand All @@ -2684,7 +2686,7 @@ func getCredentialsAndCAFiles(ctx context.Context, c client.Client, clusterNames

// createFileWithCredentials fetches the credentials from a Secret and writes it to a temporary file.
// Returns the path to the temporary file.
func createFileWithCredentials(ctx context.Context, c client.Client, clusterNamespace string,
func createFileWithCredentials(ctx context.Context, c client.Client, clusterSummary *configv1beta1.ClusterSummary,
requestedChart *configv1beta1.HelmChart) (string, error) {

if requestedChart.RegistryCredentialsConfig == nil ||
Expand All @@ -2693,11 +2695,15 @@ func createFileWithCredentials(ctx context.Context, c client.Client, clusterName
return "", nil
}
credSecretRef := requestedChart.RegistryCredentialsConfig.CredentialsSecretRef
namespace := libsveltostemplate.GetReferenceResourceNamespace(
clusterNamespace, requestedChart.RegistryCredentialsConfig.CredentialsSecretRef.Namespace)
namespace, err := libsveltostemplate.GetReferenceResourceNamespace(ctx, c,
clusterSummary.Spec.ClusterNamespace, clusterSummary.Spec.ClusterName,
requestedChart.RegistryCredentialsConfig.CredentialsSecretRef.Namespace, clusterSummary.Spec.ClusterType)
if err != nil {
return "", err
}

secret := &corev1.Secret{}
err := c.Get(ctx,
err = c.Get(ctx,
types.NamespacedName{
Namespace: namespace,
Name: credSecretRef.Name,
Expand Down Expand Up @@ -2734,7 +2740,7 @@ func createFileWithCredentials(ctx context.Context, c client.Client, clusterName

// createFileWithCA fetches the CA certificate from a Secret and writes it to a temporary file.
// Returns the path to the temporary file.
func createFileWithCA(ctx context.Context, c client.Client, clusterNamespace string,
func createFileWithCA(ctx context.Context, c client.Client, clusterSummary *configv1beta1.ClusterSummary,
requestedChart *configv1beta1.HelmChart) (string, error) {

if requestedChart.RegistryCredentialsConfig == nil {
Expand All @@ -2745,11 +2751,15 @@ func createFileWithCA(ctx context.Context, c client.Client, clusterNamespace str
return "", nil
}

namespace := libsveltostemplate.GetReferenceResourceNamespace(
clusterNamespace, requestedChart.RegistryCredentialsConfig.CASecretRef.Namespace)
namespace, err := libsveltostemplate.GetReferenceResourceNamespace(ctx, c,
clusterSummary.Spec.ClusterNamespace, clusterSummary.Spec.ClusterName,
requestedChart.RegistryCredentialsConfig.CASecretRef.Namespace, clusterSummary.Spec.ClusterType)
if err != nil {
return "", err
}

secret := &corev1.Secret{}
err := c.Get(ctx,
err = c.Get(ctx,
types.NamespacedName{
Namespace: namespace,
Name: requestedChart.RegistryCredentialsConfig.CASecretRef.Name,
Expand Down
Loading