coreos/prometheus-operator
1
0
Fork 0
mirror of https://github.com/coreos/prometheus-operator.git synced 2026-02-05 06:45:27 +01:00
Code Issues Releases Wiki Activity

Add CreateStatefulSetOrPatchLabels() to k8sutil package

Browse Source 
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
This commit is contained in:
Simon Pasquier
2026-01-30 15:17:13 +01:00
parent f61936b22d
commit 5e26cd163d
9 changed files with 135 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
pkg/alertmanager/operator.go
View File

@@ -756,10 +756,10 @@ func (c *Operator) UpdateStatus(ctx context.Context, key string) error {
a.Status.Conditions = operator.UpdateConditions(a.Status.Conditions, availableCondition, reconciledCondition)
a.Status.Paused = a.Spec.Paused
if _, err = c.mclient.MonitoringV1().Alertmanagers(a.Namespace).ApplyStatus(ctx, ApplyConfigurationFromAlertmanager(a, true), metav1.ApplyOptions{FieldManager: operator.PrometheusOperatorFieldManager, Force: true}); err != nil {
if _, err = c.mclient.MonitoringV1().Alertmanagers(a.Namespace).ApplyStatus(ctx, ApplyConfigurationFromAlertmanager(a, true), metav1.ApplyOptions{FieldManager: k8sutil.PrometheusOperatorFieldManager, Force: true}); err != nil {
c.logger.Info("failed to apply alertmanager status subresource, trying again without scale fields", "err", err)
// Try again, but this time does not update scale subresource.
if _, err = c.mclient.MonitoringV1().Alertmanagers(a.Namespace).ApplyStatus(ctx, ApplyConfigurationFromAlertmanager(a, false), metav1.ApplyOptions{FieldManager: operator.PrometheusOperatorFieldManager, Force: true}); err != nil {
if _, err = c.mclient.MonitoringV1().Alertmanagers(a.Namespace).ApplyStatus(ctx, ApplyConfigurationFromAlertmanager(a, false), metav1.ApplyOptions{FieldManager: k8sutil.PrometheusOperatorFieldManager, Force: true}); err != nil {
return fmt.Errorf("failed to apply alertmanager status subresource: %w", err)
}
}

46
pkg/k8sutil/k8sutil.go
View File

@@ -38,6 +38,7 @@ import (
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/validation"
"k8s.io/client-go/discovery"
@@ -55,10 +56,18 @@ import (
monitoringv1beta1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1beta1"
)
// KubeConfigEnv (optionally) specify the location of kubeconfig file.
const KubeConfigEnv = "KUBECONFIG"
const (
// KubeConfigEnv (optionally) specify the location of kubeconfig file.
KubeConfigEnv = "KUBECONFIG"
const StatusCleanupFinalizerName = "monitoring.coreos.com/status-cleanup"
// StatusCleanupFinalizerName is the name of the finalizer used to garbage
// collect status bindings on configuration resources.
StatusCleanupFinalizerName = "monitoring.coreos.com/status-cleanup"
// PrometheusOperatorFieldManager is the field manager name used by the
// operator.
PrometheusOperatorFieldManager = "PrometheusOperator"
)
var invalidDNS1123Characters = regexp.MustCompile("[^-a-z0-9]+")
@@ -316,6 +325,37 @@ func CreateOrUpdateEndpointSlice(ctx context.Context, c clientdiscoveryv1.Endpoi
})
}
// CreateStatefulSetOrPatchLabels creates a StatefulSet resource.
// If the StatefulSet already exists, it patches the labels from the input StatefulSet.
func CreateStatefulSetOrPatchLabels(ctx context.Context, ssetClient clientappsv1.StatefulSetInterface, sset *appsv1.StatefulSet) (*appsv1.StatefulSet, error) {
created, err := ssetClient.Create(ctx, sset, metav1.CreateOptions{})
if err == nil {
return created, nil
}
if !apierrors.IsAlreadyExists(err) {
return nil, err
}
// StatefulSet already exists, patch the labels
patchData, err := json.Marshal(map[string]any{
"metadata": map[string]any{
"labels": sset.Labels,
},
})
if err != nil {
return nil, err
}
return ssetClient.Patch(
ctx,
sset.Name,
types.StrategicMergePatchType,
patchData,
metav1.PatchOptions{FieldManager: PrometheusOperatorFieldManager},
)
}
// updateStatefulSet updates a StatefulSet resource preserving custom labels and annotations from the current resource.
func updateStatefulSet(ctx context.Context, sstClient clientappsv1.StatefulSetInterface, sset *appsv1.StatefulSet) error {
// As stated in the RetryOnConflict's documentation, the returned error shouldn't be wrapped.

79
pkg/k8sutil/k8sutil_test.go
View File

@@ -756,6 +756,85 @@ func TestEnsureCustomGoverningService(t *testing.T) {
}
}
func TestCreateStatefulSetOrPatchLabels(t *testing.T) {
testCases := []struct {
name string
existingStatefulSet *appsv1.StatefulSet
newStatefulSet *appsv1.StatefulSet
expectedLabels map[string]string
}{
{
name: "create new statefulset successfully",
newStatefulSet: &appsv1.StatefulSet{
ObjectMeta: metav1.ObjectMeta{
Name: "prometheus",
Namespace: "default",
Labels: map[string]string{
"app": "prometheus",
"env": "prod",
},
},
},
expectedLabels: map[string]string{
"app": "prometheus",
"env": "prod",
},
},
{
name: "statefulset already exists - patch labels",
existingStatefulSet: &appsv1.StatefulSet{
ObjectMeta: metav1.ObjectMeta{
Name: "prometheus",
Namespace: "default",
Labels: map[string]string{
"app": "prometheus",
"env": "dev",
},
},
},
newStatefulSet: &appsv1.StatefulSet{
ObjectMeta: metav1.ObjectMeta{
Name: "prometheus",
Namespace: "default",
Labels: map[string]string{
"app": "prometheus",
"env": "prod",
"version": "v2.0",
},
},
},
expectedLabels: map[string]string{
"app": "prometheus",
"env": "prod",
"version": "v2.0",
},
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
ctx := context.Background()
var clientSet *fake.Clientset
if tc.existingStatefulSet != nil {
clientSet = fake.NewClientset(tc.existingStatefulSet)
} else {
clientSet = fake.NewClientset()
}
ssetClient := clientSet.AppsV1().StatefulSets(tc.newStatefulSet.Namespace)
_, err := CreateStatefulSetOrPatchLabels(ctx, ssetClient, tc.newStatefulSet)
require.NoError(t, err)
// Verify the statefulset in the cluster has the expected labels
result, err := ssetClient.Get(ctx, tc.newStatefulSet.Name, metav1.GetOptions{})
require.NoError(t, err)
require.Equal(t, tc.expectedLabels, result.Labels)
})
}
}
func makeBarebonesPrometheus(name, ns string) *monitoringv1.Prometheus {
return &monitoringv1.Prometheus{
ObjectMeta: metav1.ObjectMeta{

6
pkg/operator/config_resource.go
View File

@@ -213,7 +213,7 @@ func (crs *ConfigResourceSyncer) UpdateBinding(ctx context.Context, configResour
ctx,
obj,
metav1.UpdateOptions{
FieldManager: PrometheusOperatorFieldManager,
FieldManager: k8sutil.PrometheusOperatorFieldManager,
FieldValidation: metav1.FieldValidationStrict,
},
); err != nil {
@@ -238,7 +238,7 @@ func (crs *ConfigResourceSyncer) UpdateBinding(ctx context.Context, configResour
types.JSONPatchType,
patch,
metav1.PatchOptions{
FieldManager: PrometheusOperatorFieldManager,
FieldManager: k8sutil.PrometheusOperatorFieldManager,
FieldValidation: metav1.FieldValidationStrict,
},
statusSubResource,
@@ -270,7 +270,7 @@ func (crs *ConfigResourceSyncer) RemoveBinding(ctx context.Context, configResour
types.JSONPatchType,
p,
metav1.PatchOptions{
FieldManager: PrometheusOperatorFieldManager,
FieldManager: k8sutil.PrometheusOperatorFieldManager,
FieldValidation: metav1.FieldValidationStrict,
},
statusSubResource,

2
pkg/operator/finalizer.go
View File

@@ -105,7 +105,7 @@ func (s *FinalizerSyncer) updateObject(
) error {
_, err := s.mdClient.Resource(s.gvr).
Namespace(p.GetNamespace()).
Patch(ctx, p.GetName(), types.JSONPatchType, patchBytes, metav1.PatchOptions{FieldManager: PrometheusOperatorFieldManager})
Patch(ctx, p.GetName(), types.JSONPatchType, patchBytes, metav1.PatchOptions{FieldManager: k8sutil.PrometheusOperatorFieldManager})
return err
}

4
pkg/operator/operator.go
View File

@@ -38,8 +38,8 @@ import (
)
const (
PrometheusOperatorFieldManager = "PrometheusOperator"
// InvalidConfigurationEvent is the type used for events reporting invalid
// configuration resources.
InvalidConfigurationEvent = "InvalidConfiguration"
)

4
pkg/prometheus/agent/operator.go
View File

@@ -1039,10 +1039,10 @@ func (c *Operator) UpdateStatus(ctx context.Context, key string) error {
p.Status.Selector = selector.String()
p.Status.Shards = ptr.Deref(p.Spec.Shards, 1)
if _, err = c.mclient.MonitoringV1alpha1().PrometheusAgents(p.Namespace).ApplyStatus(ctx, prompkg.ApplyConfigurationFromPrometheusAgent(p, true), metav1.ApplyOptions{FieldManager: operator.PrometheusOperatorFieldManager, Force: true}); err != nil {
if _, err = c.mclient.MonitoringV1alpha1().PrometheusAgents(p.Namespace).ApplyStatus(ctx, prompkg.ApplyConfigurationFromPrometheusAgent(p, true), metav1.ApplyOptions{FieldManager: k8sutil.PrometheusOperatorFieldManager, Force: true}); err != nil {
c.logger.Info("failed to apply prometheus status subresource, trying again without scale fields", "err", err)
// Try again, but this time does not update scale subresource.
if _, err = c.mclient.MonitoringV1alpha1().PrometheusAgents(p.Namespace).ApplyStatus(ctx, prompkg.ApplyConfigurationFromPrometheusAgent(p, false), metav1.ApplyOptions{FieldManager: operator.PrometheusOperatorFieldManager, Force: true}); err != nil {
if _, err = c.mclient.MonitoringV1alpha1().PrometheusAgents(p.Namespace).ApplyStatus(ctx, prompkg.ApplyConfigurationFromPrometheusAgent(p, false), metav1.ApplyOptions{FieldManager: k8sutil.PrometheusOperatorFieldManager, Force: true}); err != nil {
return fmt.Errorf("failed to Apply prometheus agent status subresource: %w", err)
}
}

4
pkg/prometheus/server/operator.go
View File

@@ -1230,10 +1230,10 @@ func (c *Operator) UpdateStatus(ctx context.Context, key string) error {
p.Status.Selector = selector.String()
p.Status.Shards = ptr.Deref(p.Spec.Shards, 1)
if _, err = c.mclient.MonitoringV1().Prometheuses(p.Namespace).ApplyStatus(ctx, prompkg.ApplyConfigurationFromPrometheus(p, true), metav1.ApplyOptions{FieldManager: operator.PrometheusOperatorFieldManager, Force: true}); err != nil {
if _, err = c.mclient.MonitoringV1().Prometheuses(p.Namespace).ApplyStatus(ctx, prompkg.ApplyConfigurationFromPrometheus(p, true), metav1.ApplyOptions{FieldManager: k8sutil.PrometheusOperatorFieldManager, Force: true}); err != nil {
c.logger.Info("failed to apply prometheus status subresource, trying again without scale fields", "err", err)
// Try again, but this time does not update scale subresource.
if _, err = c.mclient.MonitoringV1().Prometheuses(p.Namespace).ApplyStatus(ctx, prompkg.ApplyConfigurationFromPrometheus(p, false), metav1.ApplyOptions{FieldManager: operator.PrometheusOperatorFieldManager, Force: true}); err != nil {
if _, err = c.mclient.MonitoringV1().Prometheuses(p.Namespace).ApplyStatus(ctx, prompkg.ApplyConfigurationFromPrometheus(p, false), metav1.ApplyOptions{FieldManager: k8sutil.PrometheusOperatorFieldManager, Force: true}); err != nil {
return fmt.Errorf("failed to apply prometheus status subresource: %w", err)
}
}

2
pkg/thanos/operator.go
View File

@@ -721,7 +721,7 @@ func (o *Operator) UpdateStatus(ctx context.Context, key string) error {
tr.Status.Conditions = operator.UpdateConditions(tr.Status.Conditions, availableCondition, reconciledCondition)
tr.Status.Paused = tr.Spec.Paused
if _, err = o.mclient.MonitoringV1().ThanosRulers(tr.Namespace).ApplyStatus(ctx, applyConfigurationFromThanosRuler(tr), metav1.ApplyOptions{FieldManager: operator.PrometheusOperatorFieldManager, Force: true}); err != nil {
if _, err = o.mclient.MonitoringV1().ThanosRulers(tr.Namespace).ApplyStatus(ctx, applyConfigurationFromThanosRuler(tr), metav1.ApplyOptions{FieldManager: k8sutil.PrometheusOperatorFieldManager, Force: true}); err != nil {
return fmt.Errorf("failed to apply status subresource: %w", err)
}