Add DownwardAPILabels support for Bucket

Author: Rohit-0505

broker/bucketbroker/apiutils/apiutils.go

@@ -9,7 +9,6 @@ import (
 	"fmt"
 
 	"github.com/ironcore-dev/controller-utils/metautils"
-	storagev1alpha1 "github.com/ironcore-dev/ironcore/api/storage/v1alpha1"
 	bucketbrokerv1alpha1 "github.com/ironcore-dev/ironcore/broker/bucketbroker/api/v1alpha1"
 	irimeta "github.com/ironcore-dev/ironcore/iri/apis/meta/v1alpha1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -128,10 +127,6 @@ func GetAnnotationsAnnotation(o metav1.Object) (map[string]string, error) {
 	return annotations, nil
 }
 
-func SetBucketManagerLabel(bucket *storagev1alpha1.Bucket, manager string) {
-	metautils.SetLabel(bucket, bucketbrokerv1alpha1.ManagerLabel, manager)
-}
-
 func IsManagedBy(o metav1.Object, manager string) bool {
 	actual, ok := o.GetLabels()[bucketbrokerv1alpha1.ManagerLabel]
 	return ok && actual == manager

broker/bucketbroker/cmd/bucketbroker/app/app.go

@@ -24,8 +24,9 @@ import (
 )
 
 type Options struct {
-	GetConfigOptions config.GetConfigOptions
-	Address          string
+	GetConfigOptions        config.GetConfigOptions
+	Address                 string
+	BrokerDownwardAPILabels map[string]string
 
 	QPS   float32
 	Burst int
@@ -38,6 +39,8 @@ type Options struct {
 func (o *Options) AddFlags(fs *pflag.FlagSet) {
 	o.GetConfigOptions.BindFlags(fs)
 	fs.StringVar(&o.Address, "address", "/var/run/iri-bucketbroker.sock", "Address to listen on.")
+	fs.StringToStringVar(&o.BrokerDownwardAPILabels, "broker-downward-api-label", nil, "The labels to broker via downward API."+
+		"Example: broker 'root-bucket-uid' from 'bucketpoollet.ironcore.dev/bucket-uid'.")
 
 	fs.StringVar(&o.Namespace, "namespace", o.Namespace, "Target Kubernetes namespace to use.")
 	fs.StringVar(&o.BucketPoolName, "bucket-pool-name", o.BucketPoolName, "Name of the target bucket pool to pin buckets to, if any.")
@@ -86,9 +89,10 @@ func Run(ctx context.Context, opts Options) error {
 	}
 
 	srv, err := server.New(cfg, server.Options{
-		Namespace:          opts.Namespace,
-		BucketPoolName:     opts.BucketPoolName,
-		BucketPoolSelector: opts.BucketPoolSelector,
+		BrokerDownwardAPILabels: opts.BrokerDownwardAPILabels,
+		Namespace:               opts.Namespace,
+		BucketPoolName:          opts.BucketPoolName,
+		BucketPoolSelector:      opts.BucketPoolSelector,
 	})
 	if err != nil {
 		return fmt.Errorf("error creating server: %w", err)

broker/bucketbroker/server/bucket_create.go

@@ -12,6 +12,9 @@ import (
 	bucketbrokerv1alpha1 "github.com/ironcore-dev/ironcore/broker/bucketbroker/api/v1alpha1"
 	"github.com/ironcore-dev/ironcore/broker/bucketbroker/apiutils"
 	iri "github.com/ironcore-dev/ironcore/iri/apis/bucket/v1alpha1"
+	bucketpoolletv1alpha1 "github.com/ironcore-dev/ironcore/poollet/bucketpoollet/api/v1alpha1"
+	poolletutils "github.com/ironcore-dev/ironcore/poollet/common/utils"
+	"github.com/ironcore-dev/ironcore/utils/maps"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -22,17 +25,37 @@ type AggregateIronCoreBucket struct {
 	AccessSecret *corev1.Secret
 }
 
+func (s *Server) prepareIronCoreBucketLabels(bucket *iri.Bucket) map[string]string {
+	labels := make(map[string]string)
+
+	for downwardAPILabelName, defaultLabelName := range s.brokerDownwardAPILabels {
+		value := bucket.GetMetadata().GetLabels()[poolletutils.DownwardAPILabel(bucketpoolletv1alpha1.BucketDownwardAPIPrefix, downwardAPILabelName)]
+		if value == "" {
+			value = bucket.GetMetadata().GetLabels()[defaultLabelName]
+		}
+		if value != "" {
+			labels[poolletutils.DownwardAPILabel(bucketpoolletv1alpha1.BucketDownwardAPIPrefix, downwardAPILabelName)] = value
+		}
+	}
+
+	return labels
+}
+
 func (s *Server) getIronCoreBucketConfig(_ context.Context, bucket *iri.Bucket) (*AggregateIronCoreBucket, error) {
 	var bucketPoolRef *corev1.LocalObjectReference
 	if s.bucketPoolName != "" {
 		bucketPoolRef = &corev1.LocalObjectReference{
 			Name: s.bucketPoolName,
 		}
 	}
+	labels := s.prepareIronCoreBucketLabels(bucket)
 	ironcoreBucket := &storagev1alpha1.Bucket{
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace: s.namespace,
 			Name:      s.generateID(),
+			Labels: maps.AppendMap(labels, map[string]string{
+				bucketbrokerv1alpha1.ManagerLabel: bucketbrokerv1alpha1.BucketBrokerManager,
+			}),
 		},
 		Spec: storagev1alpha1.BucketSpec{
 			BucketClassRef:     &corev1.LocalObjectReference{Name: bucket.Spec.Class},
@@ -43,7 +66,6 @@ func (s *Server) getIronCoreBucketConfig(_ context.Context, bucket *iri.Bucket)
 	if err := apiutils.SetObjectMetadata(ironcoreBucket, bucket.Metadata); err != nil {
 		return nil, err
 	}
-	apiutils.SetBucketManagerLabel(ironcoreBucket, bucketbrokerv1alpha1.BucketBrokerManager)
 
 	return &AggregateIronCoreBucket{
 		Bucket: ironcoreBucket,

broker/bucketbroker/server/bucket_create_test.go

@@ -10,6 +10,7 @@ import (
 	iri "github.com/ironcore-dev/ironcore/iri/apis/bucket/v1alpha1"
 	irimeta "github.com/ironcore-dev/ironcore/iri/apis/meta/v1alpha1"
 	bucketpoolletv1alpha1 "github.com/ironcore-dev/ironcore/poollet/bucketpoollet/api/v1alpha1"
+	poolletutils "github.com/ironcore-dev/ironcore/poollet/common/utils"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -46,6 +47,7 @@ var _ = Describe("CreateBucket", func() {
 
 		By("inspecting the ironcore bucket")
 		Expect(ironcoreBucket.Labels).To(Equal(map[string]string{
+			poolletutils.DownwardAPILabel(bucketpoolletv1alpha1.BucketDownwardAPIPrefix, "root-bucket-uid"): "foobar",
 			bucketbrokerv1alpha1.CreatedLabel: "true",
 			bucketbrokerv1alpha1.ManagerLabel: bucketbrokerv1alpha1.BucketBrokerManager,
 		}))

broker/bucketbroker/server/server.go

@@ -45,6 +45,8 @@ type Server struct {
 	client client.Client
 	iri.UnimplementedBucketRuntimeServer
 
+	brokerDownwardAPILabels map[string]string
+
 	namespace          string
 	bucketPoolName     string
 	bucketPoolSelector map[string]string
@@ -90,9 +92,14 @@ func (s *Server) setupCleaner(ctx context.Context, log logr.Logger, retErr *erro
 }
 
 type Options struct {
-	Namespace          string
-	BucketPoolName     string
-	BucketPoolSelector map[string]string
+	// BrokerDownwardAPILabels specifies which labels to broker via downward API and what the default
+	// label name is to obtain the value in case there is no value for the downward API.
+	// Example usage is e.g. to broker the root UID (map "root-bucket-uid" to bucketpoollet's
+	// "bucketpoollet.ironcore.dev/bucket-uid")
+	BrokerDownwardAPILabels map[string]string
+	Namespace               string
+	BucketPoolName          string
+	BucketPoolSelector      map[string]string
 }
 
 func setOptionsDefaults(o *Options) {
@@ -118,10 +125,11 @@ func New(cfg *rest.Config, opts Options) (*Server, error) {
 	}
 
 	return &Server{
-		client:             c,
-		namespace:          opts.Namespace,
-		bucketPoolName:     opts.BucketPoolName,
-		bucketPoolSelector: opts.BucketPoolSelector,
+		brokerDownwardAPILabels: opts.BrokerDownwardAPILabels,
+		client:                  c,
+		namespace:               opts.Namespace,
+		bucketPoolName:          opts.BucketPoolName,
+		bucketPoolSelector:      opts.BucketPoolSelector,
 	}, nil
 }
 

broker/bucketbroker/server/server_suite_test.go

@@ -16,6 +16,7 @@ import (
 	corev1alpha1 "github.com/ironcore-dev/ironcore/api/core/v1alpha1"
 	storagev1alpha1 "github.com/ironcore-dev/ironcore/api/storage/v1alpha1"
 	"github.com/ironcore-dev/ironcore/broker/bucketbroker/server"
+	bucketpoolletv1alpha1 "github.com/ironcore-dev/ironcore/poollet/bucketpoollet/api/v1alpha1"
 	utilsenvtest "github.com/ironcore-dev/ironcore/utils/envtest"
 	"github.com/ironcore-dev/ironcore/utils/envtest/apiserver"
 	. "github.com/onsi/ginkgo/v2"
@@ -138,6 +139,9 @@ func SetupTest() (*corev1.Namespace, *storagev1alpha1.BucketPool, *server.Server
 			BucketPoolSelector: map[string]string{
 				"pool": "test-pool",
 			},
+			BrokerDownwardAPILabels: map[string]string{
+				"root-bucket-uid": bucketpoolletv1alpha1.BucketUIDLabel,
+			},
 		})
 		Expect(err).NotTo(HaveOccurred())
 		*srv = *newSrv

config/bucketpoollet-broker/manager/manager.yaml

@@ -32,6 +32,9 @@ spec:
           args:
             - --health-probe-bind-address=:8081
             - --leader-elect
+            - --bucket-downward-api-label=root-bucket-namespace=metadata.labels['downward-api.bucketpoollet.ironcore.dev/root-bucket-namespace']
+            - --bucket-downward-api-label=root-bucket-name=metadata.labels['downward-api.bucketpoollet.ironcore.dev/root-bucket-name']
+            - --bucket-downward-api-label=root-bucket-uid=metadata.labels['downward-api.bucketpoollet.ironcore.dev/root-bucket-uid']
           image: bucketpoollet:latest
           name: manager
           securityContext:
@@ -62,6 +65,10 @@ spec:
             - /bucketbroker
           image: bucketbroker:latest
           name: broker
+          args:
+            - --broker-downward-api-label=root-bucket-namespace=bucketpoollet.ironcore.dev/root-bucket-namespace
+            - --broker-downward-api-label=root-bucket-name=bucketpoollet.ironcore.dev/root-bucket-name
+            - --broker-downward-api-label=root-bucket-uid=bucketpoollet.ironcore.dev/root-bucket-uid
           securityContext:
             allowPrivilegeEscalation: false
           livenessProbe:

config/volumepoollet-broker/manager/manager.yaml

@@ -66,9 +66,9 @@ spec:
           image: volumebroker:latest
           name: broker
           args:
-            - --broker-downward-api-label=root-volume-namespace=metadata.labels['downward-api.volumepoollet.ironcore.dev/root-volume-namespace']
-            - --broker-downward-api-label=root-volume-name=metadata.labels['downward-api.volumepoollet.ironcore.dev/root-volume-name']
-            - --broker-downward-api-label=root-volume-uid=metadata.labels['downward-api.volumepoollet.ironcore.dev/root-volume-uid']
+            - --broker-downward-api-label=root-volume-namespace=volumepoollet.ironcore.dev/root-volume-namespace
+            - --broker-downward-api-label=root-volume-name=volumepoollet.ironcore.dev/root-volume-name
+            - --broker-downward-api-label=root-volume-uid=volumepoollet.ironcore.dev/root-volume-uid
           securityContext:
             allowPrivilegeEscalation: false
           livenessProbe:

poollet/bucketpoollet/api/v1alpha1/common_types.go

@@ -10,4 +10,7 @@ const (
 
 	FieldOwner      = "bucketpoollet.ironcore.dev/field-owner"
 	BucketFinalizer = "bucketpoollet.ironcore.dev/bucket"
+
+	// DownwardAPIPrefix is the prefix for any downward label.
+	BucketDownwardAPIPrefix = "downward-api.bucketpoollet.ironcore.dev/"
 )

poollet/bucketpoollet/bem/bem_suite_test.go

@@ -41,6 +41,9 @@ const (
 	apiServiceTimeout = 5 * time.Minute
 
 	controllerManagerService = "controller-manager"
+
+	fooDownwardAPILabel = "custom-downward-api-label"
+	fooAnnotation       = "foo"
 )
 
 func TestControllers(t *testing.T) {