Skip to content

chore: retention mechanism for synchronized Kubernetes objects #2052

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
tolusha merged 5 commits into from
Oct 15, 2025
Merged

chore: retention mechanism for synchronized Kubernetes objects #2052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
51b1bcb
chore: do not remove synced users pvc
tolusha Oct 9, 2025
025efbc
Fixup
tolusha Oct 10, 2025
b3cb1ae
fixup
tolusha Oct 10, 2025
f8063d1
fixup
tolusha Oct 10, 2025
0b40a5f
fixup
tolusha Oct 13, 2025
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
11 changes: 8 additions & 3 deletions controllers/workspaceconfig/configmap2sync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,17 @@ func (p *configMap2Sync) newDstObject() client.Object {
}

func (p *configMap2Sync) getSrcObjectVersion() string {
if len(p.version) == 0 {
return p.cm.GetResourceVersion()
if p.version != "" {
return p.version
}
return p.version

return p.cm.GetResourceVersion()
}

func (p *configMap2Sync) hasROSpec() bool {
return false
}

func (p *configMap2Sync) defaultRetention() bool {
return false
}
125 changes: 125 additions & 0 deletions controllers/workspaceconfig/configmap2sync_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,3 +479,128 @@ func TestSyncConfigMapShouldRemoveSomeLabels(t *testing.T) {
assert.Empty(t, cm.Labels["argocd.argoproj.io/instance"])
assert.Empty(t, cm.Labels["argocd.argoproj.io/managed-by"])
}

func TestSyncConfigMapShouldRetainIfAnnotationSetTrue(t *testing.T) {
deployContext := test.NewCtxBuilder().WithObjects(
&corev1.ConfigMap{
TypeMeta: metav1.TypeMeta{
Kind: "ConfigMap",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: objectName,
Namespace: eclipseCheNamespace,
Labels: map[string]string{
constants.KubernetesPartOfLabelKey: constants.CheEclipseOrg,
constants.KubernetesComponentLabelKey: constants.WorkspacesConfig,
},
Annotations: map[string]string{
syncRetainOnDeleteAnnotation: "true",
},
},
}).Build()

workspaceConfigReconciler := NewWorkspacesConfigReconciler(
deployContext.ClusterAPI.Client,
deployContext.ClusterAPI.Client,
deployContext.ClusterAPI.Scheme,
&namespacecache.NamespaceCache{
Client: deployContext.ClusterAPI.Client,
KnownNamespaces: map[string]namespacecache.NamespaceInfo{
userNamespace: {
IsWorkspaceNamespace: true,
Username: "user",
CheCluster: &types.NamespacedName{Name: "eclipse-che", Namespace: "eclipse-che"},
},
},
Lock: sync.Mutex{},
})

// Sync ConfigMap
err := workspaceConfigReconciler.syncNamespace(context.TODO(), eclipseCheNamespace, userNamespace)
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 2, v1ConfigMapGKV)

// Check ConfigMap in a user namespace is created
cm := &corev1.ConfigMap{}
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, cm)
assert.Nil(t, err)
assert.Equal(t, "true", cm.Annotations[syncRetainOnDeleteAnnotation])

// Delete src ConfigMap
err = deploy.DeleteIgnoreIfNotFound(context.TODO(), deployContext.ClusterAPI.Client, objectKeyInCheNs, &corev1.ConfigMap{})
assert.Nil(t, err)

// Sync ConfigMap
err = workspaceConfigReconciler.syncNamespace(context.TODO(), eclipseCheNamespace, userNamespace)
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 0, v1ConfigMapGKV)

// Check that destination ConfigMap in a user namespace NOT is deleted
Copy link

Copilot AI Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar improvement.

Suggested change
// Check that destination ConfigMap in a user namespace NOT is deleted
// Check that destination ConfigMap in a user namespace is NOT deleted

Copilot uses AI. Check for mistakes.
cm = &corev1.ConfigMap{}
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, cm)
assert.NoError(t, err)
}

func TestSyncConfigMapShouldNotRetainIfAnnotationSetFalse(t *testing.T) {
deployContext := test.NewCtxBuilder().WithObjects(
&corev1.ConfigMap{
TypeMeta: metav1.TypeMeta{
Kind: "ConfigMap",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: objectName,
Namespace: eclipseCheNamespace,
Labels: map[string]string{
constants.KubernetesPartOfLabelKey: constants.CheEclipseOrg,
constants.KubernetesComponentLabelKey: constants.WorkspacesConfig,
},
Annotations: map[string]string{
syncRetainOnDeleteAnnotation: "false",
},
},
}).Build()

workspaceConfigReconciler := NewWorkspacesConfigReconciler(
deployContext.ClusterAPI.Client,
deployContext.ClusterAPI.Client,
deployContext.ClusterAPI.Scheme,
&namespacecache.NamespaceCache{
Client: deployContext.ClusterAPI.Client,
KnownNamespaces: map[string]namespacecache.NamespaceInfo{
userNamespace: {
IsWorkspaceNamespace: true,
Username: "user",
CheCluster: &types.NamespacedName{Name: "eclipse-che", Namespace: "eclipse-che"},
},
},
Lock: sync.Mutex{},
})

// Sync ConfigMap
err := workspaceConfigReconciler.syncNamespace(context.TODO(), eclipseCheNamespace, userNamespace)
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 2, v1ConfigMapGKV)

// Check ConfigMap in a user namespace is created
cm := &corev1.ConfigMap{}
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, cm)
assert.Nil(t, err)
assert.Equal(t, "false", cm.Annotations[syncRetainOnDeleteAnnotation])

// Delete src ConfigMap
err = deploy.DeleteIgnoreIfNotFound(context.TODO(), deployContext.ClusterAPI.Client, objectKeyInCheNs, &corev1.ConfigMap{})
assert.Nil(t, err)

// Sync ConfigMap
err = workspaceConfigReconciler.syncNamespace(context.TODO(), eclipseCheNamespace, userNamespace)
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 0, v1ConfigMapGKV)

// Check that destination ConfigMap in a user namespace is deleted
cm = &corev1.ConfigMap{}
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, cm)
assert.NotNil(t, err)
assert.True(t, errors.IsNotFound(err))
}
11 changes: 6 additions & 5 deletions controllers/workspaceconfig/object2sync_factory.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
"strings"

corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/client"

"github.com/eclipse-che/che-operator/pkg/common/utils"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
Expand All @@ -35,7 +35,7 @@ var (
v1PvcGKV = corev1.SchemeGroupVersion.WithKind("PersistentVolumeClaim")
)

func createObject2SyncFromRaw(
func createObject2SyncFromRawData(
raw []byte,
userName string,
namespaceName string) (Object2Sync, error) {
Expand Down Expand Up @@ -89,12 +89,11 @@ func createObject2SyncFromRaw(

return &unstructured2Sync{
srcObj: srcObj,
dstObj: srcObj,
version: hash,
}, nil
}

func createObject2SyncFromRuntimeObject(obj runtime.Object) Object2Sync {
func createObject2SyncFromObject(obj client.Object) Object2Sync {
gkv := obj.GetObjectKind().GroupVersionKind()
switch gkv {
case v1ConfigMapGKV:
Expand All @@ -110,5 +109,7 @@ func createObject2SyncFromRuntimeObject(obj runtime.Object) Object2Sync {
return &pvc2Sync{pvc: pvc}
}

return nil
return &unstructured2Sync{
srcObj: obj,
}
}
11 changes: 8 additions & 3 deletions controllers/workspaceconfig/pvc2sync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,17 @@ func (p *pvc2Sync) newDstObject() client.Object {
}

func (p *pvc2Sync) getSrcObjectVersion() string {
if len(p.version) == 0 {
return p.pvc.GetResourceVersion()
if p.version != "" {
return p.version
}
return p.version

return p.pvc.GetResourceVersion()
}

func (p *pvc2Sync) hasROSpec() bool {
return true
}

func (p *pvc2Sync) defaultRetention() bool {
return true
}
133 changes: 129 additions & 4 deletions controllers/workspaceconfig/pvc2sync_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,13 @@ import (
"testing"

"github.com/eclipse-che/che-operator/controllers/namespacecache"
"k8s.io/apimachinery/pkg/api/errors"

"k8s.io/apimachinery/pkg/types"

"github.com/eclipse-che/che-operator/pkg/deploy"
"k8s.io/apimachinery/pkg/api/errors"

"github.com/eclipse-che/che-operator/pkg/common/constants"
"github.com/eclipse-che/che-operator/pkg/common/test"
"github.com/eclipse-che/che-operator/pkg/deploy"
"github.com/stretchr/testify/assert"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
Expand Down Expand Up @@ -133,9 +132,135 @@ func TestSyncPVC(t *testing.T) {
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 0, v1PvcGKV)

// Check that destination PersistentVolumeClaim in a user namespace is deleted
// Check that destination PersistentVolumeClaim in a user namespace is NOT deleted
pvc = &corev1.PersistentVolumeClaim{}
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, pvc)
assert.Nil(t, err)
}

func TestSyncPVCShouldRetainIfAnnotationSetTrue(t *testing.T) {
deployContext := test.NewCtxBuilder().WithObjects(
&corev1.PersistentVolumeClaim{
TypeMeta: metav1.TypeMeta{
Kind: "PersistentVolumeClaim",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: objectName,
Namespace: eclipseCheNamespace,
Labels: map[string]string{
constants.KubernetesPartOfLabelKey: constants.CheEclipseOrg,
constants.KubernetesComponentLabelKey: constants.WorkspacesConfig,
},
Annotations: map[string]string{
syncRetainOnDeleteAnnotation: "true",
},
},
}).Build()

workspaceConfigReconciler := NewWorkspacesConfigReconciler(
deployContext.ClusterAPI.Client,
deployContext.ClusterAPI.Client,
deployContext.ClusterAPI.Scheme,
&namespacecache.NamespaceCache{
Client: deployContext.ClusterAPI.Client,
KnownNamespaces: map[string]namespacecache.NamespaceInfo{
userNamespace: {
IsWorkspaceNamespace: true,
Username: "user",
CheCluster: &types.NamespacedName{Name: "eclipse-che", Namespace: "eclipse-che"},
},
},
Lock: sync.Mutex{},
})

assertSyncConfig(t, workspaceConfigReconciler, 0, v1PvcGKV)

// Sync PVC to a user namespace
err := workspaceConfigReconciler.syncNamespace(context.TODO(), eclipseCheNamespace, userNamespace)
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 2, v1PvcGKV)

// Check if PVC in a user namespace is created
pvc := &corev1.PersistentVolumeClaim{}
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, pvc)
assert.Nil(t, err)
assert.Equal(t, "true", pvc.Annotations[syncRetainOnDeleteAnnotation])

// Delete src PVC
err = deploy.DeleteIgnoreIfNotFound(context.TODO(), deployContext.ClusterAPI.Client, objectKeyInCheNs, &corev1.PersistentVolumeClaim{})
assert.Nil(t, err)

// Sync PVC
err = workspaceConfigReconciler.syncNamespace(context.TODO(), eclipseCheNamespace, userNamespace)
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 0, v1PvcGKV)

// Check that destination PVC in a user namespace is NOT deleted
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, &corev1.PersistentVolumeClaim{})
assert.NoError(t, err)
}

func TestSyncPVCShouldNotRetainIfAnnotationSetFalse(t *testing.T) {
deployContext := test.NewCtxBuilder().WithObjects(
&corev1.PersistentVolumeClaim{
TypeMeta: metav1.TypeMeta{
Kind: "PersistentVolumeClaim",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: objectName,
Namespace: eclipseCheNamespace,
Labels: map[string]string{
constants.KubernetesPartOfLabelKey: constants.CheEclipseOrg,
constants.KubernetesComponentLabelKey: constants.WorkspacesConfig,
},
Annotations: map[string]string{
syncRetainOnDeleteAnnotation: "false",
},
},
}).Build()

workspaceConfigReconciler := NewWorkspacesConfigReconciler(
deployContext.ClusterAPI.Client,
deployContext.ClusterAPI.Client,
deployContext.ClusterAPI.Scheme,
&namespacecache.NamespaceCache{
Client: deployContext.ClusterAPI.Client,
KnownNamespaces: map[string]namespacecache.NamespaceInfo{
userNamespace: {
IsWorkspaceNamespace: true,
Username: "user",
CheCluster: &types.NamespacedName{Name: "eclipse-che", Namespace: "eclipse-che"},
},
},
Lock: sync.Mutex{},
})

assertSyncConfig(t, workspaceConfigReconciler, 0, v1PvcGKV)

// Sync PVC to a user namespace
err := workspaceConfigReconciler.syncNamespace(context.TODO(), eclipseCheNamespace, userNamespace)
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 2, v1PvcGKV)

// Check if PVC in a user namespace is created
pvc := &corev1.PersistentVolumeClaim{}
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, pvc)
assert.Nil(t, err)
assert.Equal(t, "false", pvc.Annotations[syncRetainOnDeleteAnnotation])

// Delete src PVC
err = deploy.DeleteIgnoreIfNotFound(context.TODO(), deployContext.ClusterAPI.Client, objectKeyInCheNs, &corev1.PersistentVolumeClaim{})
assert.Nil(t, err)

// Sync PVC
err = workspaceConfigReconciler.syncNamespace(context.TODO(), eclipseCheNamespace, userNamespace)
assert.Nil(t, err)
assertSyncConfig(t, workspaceConfigReconciler, 0, v1PvcGKV)

// Check that destination PVC in a user namespace is deleted
err = deployContext.ClusterAPI.Client.Get(context.TODO(), objectKeyInUserNs, &corev1.PersistentVolumeClaim{})
assert.NotNil(t, err)
assert.True(t, errors.IsNotFound(err))
}
11 changes: 8 additions & 3 deletions controllers/workspaceconfig/secret2sync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,17 @@ func (p *secret2Sync) newDstObject() client.Object {
}

func (p *secret2Sync) getSrcObjectVersion() string {
if len(p.version) == 0 {
return p.secret.GetResourceVersion()
if p.version != "" {
return p.version
}
return p.version

return p.secret.GetResourceVersion()
}

func (p *secret2Sync) hasROSpec() bool {
return false
}

func (p *secret2Sync) defaultRetention() bool {
return false
}
Loading
Loading