typo

Author: AleC-IX

apis/network/v1alpha1/broker_status.go

@@ -1,4 +1,4 @@
-// Copyright 2022-2024 FLUIDOS Project
+// Copyright 2022-2025 FLUIDOS Project
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,8 +16,8 @@ package v1alpha1
 
 import "github.com/fluidos-project/node/pkg/utils/tools"
 
-// UpdateStatus updates the status of the Broker.
-func (Broker *Broker) UpdateStatus() {
-	Broker.Status.LastUpdateTime = tools.GetTimeNow()
-	Broker.Status.ExpirationTime = tools.GetExpirationTime(0, 0, 10)
+// UpdateStatus updates the status of the broker.
+func (broker *Broker) UpdateStatus() {
+	broker.Status.LastUpdateTime = tools.GetTimeNow()
+	broker.Status.ExpirationTime = tools.GetExpirationTime(0, 0, 10)
 }

apis/network/v1alpha1/broker_types.go

@@ -1,4 +1,4 @@
-// Copyright 2022-2024 FLUIDOS Project
+// Copyright 2022-2025 FLUIDOS Project
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

deployments/node/README.md

@@ -78,4 +78,4 @@ A Helm chart for Fluidos Node
 | webhook.issuer | string | `"self-signed"` | Configuration for the webhook server. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

docs/implementation/components.md

@@ -63,7 +63,8 @@ The Contract Manager is in charge of managing the reserve and purchase of resour
 ## Network Manager
 
 The **Network Manager** is the component that allows the discovery of other FLUIDOS Nodes, both in the same LAN and in the WAN.
-To do so it uses two CRDs: 
+To do so it uses two CRDs:
+
 - Broker containing all the parameters to connect to a remote broker (address, certificates etc.).
 - KnownCluster containing the parameters of the newly discovered FLUIDOS node.
 

docs/implementation/customresources.md

@@ -489,4 +489,3 @@ status:
   expirationTime: "2024-01-01T09:00:10Z"
   lastUpdateTime: "2024-01-01T09:00:00Z"
 ```
-    

docs/installation/installation.md

@@ -111,7 +111,6 @@ Here, the meaning of the various parameters:
 - THIRD_OCTET: This is the third byte of the IP address used by Multus CNI for sending broadcast messages into the LAN. **Warning**: this parameters should be different for each FLUIDOS Node to be working (e.g. 1 for the 1st cluster, 2 for the 2nd cluster, etc.)
 - NET_INTERFACE: The host network interface that Multus binds to
 
-
 ### Broker CR creation
 
 To enable the Network Manager to discover FLUIDOS Nodes outside a LAN, you need to configure and apply a Broker CR.

go.mod

@@ -36,7 +36,7 @@ require (
 	github.com/evanphx/json-patch/v5 v5.6.0 // indirect
 	github.com/fsnotify/fsnotify v1.6.0 // indirect
 	github.com/ghodss/yaml v1.0.0
-	github.com/go-logr/logr v1.2.4
+	github.com/go-logr/logr v1.2.4 // indirect
 	github.com/go-logr/zapr v1.2.4 // indirect
 	github.com/go-openapi/jsonpointer v0.19.6 // indirect
 	github.com/go-openapi/jsonreference v0.20.2 // indirect

pkg/network-manager/broker_client.go

@@ -1,4 +1,4 @@
-// Copyright 2022-2024 FLUIDOS Project
+// Copyright 2022-2025 FLUIDOS Project
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -57,10 +57,11 @@ type BrokerClient struct {
 	clientCert *corev1.Secret
 	rootCert   *corev1.Secret
 
-	brokerConn *BrokerConnection
+	brokerConn *brokerConnection
 }
 
-type BrokerConnection struct {
+// BrokerConnection keeps all the broker connection data.
+type brokerConnection struct {
 	amqpConn     *amqp.Connection
 	amqpChan     *amqp.Channel
 	exchangeName string
@@ -71,7 +72,7 @@ type BrokerConnection struct {
 	confirms     chan amqp.Confirmation
 }
 
-// Setup the Broker Client from NM reconcile
+// SetupBrokerClient sets the Broker Client from NM reconcile.
 func (bc *BrokerClient) SetupBrokerClient(cl client.Client, broker *networkv1alpha1.Broker) error {
 	klog.Info("Setting up Broker Client routines")
 
@@ -84,34 +85,34 @@ func (bc *BrokerClient) SetupBrokerClient(cl client.Client, broker *networkv1alp
 		return fmt.Errorf("failed to get Node Identity")
 	}
 
-	//server address and broker name
+	// Server address and broker name.
 	bc.brokerName = broker.Spec.Name
 	bc.serverAddr = broker.Spec.Address
 
-	bc.brokerConn = &BrokerConnection{}
+	bc.brokerConn = &brokerConnection{}
 	bc.brokerConn.exchangeName = "DefaultPeerRequest"
 
 	bc.brokerConn.outboundMsg, err = json.Marshal(bc.ID)
 	if err != nil {
 		return err
 	}
 
-	//setting pub/sub
-	if strings.EqualFold(broker.Spec.Role, "publisher") {
-		klog.Infof("brokerClient %s set as publisher only", bc.brokerName)
+	switch role := broker.Spec.Role; role {
+	case "publisher":
 		bc.pubFlag = true
 		bc.subFlag = false
-	} else if strings.EqualFold(broker.Spec.Role, "subscriber") {
-		klog.Infof("brokerClient %s set as subscriber only", bc.brokerName)
+		klog.Infof("brokerClient %s set as publisher only", bc.brokerName)
+	case "subscriber":
 		bc.pubFlag = false
 		bc.subFlag = true
-	} else {
-		klog.Infof("brokerClient %s set as publisher and subscriber", bc.brokerName)
+		klog.Infof("brokerClient %s set as subscriber only", bc.brokerName)
+	default:
 		bc.pubFlag = true
 		bc.subFlag = true
+		klog.Infof("brokerClient %s set as publisher and subscriber", bc.brokerName)
 	}
 
-	//certificates
+	// Certificates.
 	bc.clientCert = &corev1.Secret{}
 	bc.rootCert = &corev1.Secret{}
 
@@ -128,7 +129,7 @@ func (bc *BrokerClient) SetupBrokerClient(cl client.Client, broker *networkv1alp
 		return err
 	}
 
-	// Extract certs and key
+	// Extract certs and key.
 	clientCert, ok := bc.clientCert.Data["tls.crt"]
 	if !ok {
 		klog.Error("missing certificate: 'tls.crt' not found in clCert Data")
@@ -144,51 +145,48 @@ func (bc *BrokerClient) SetupBrokerClient(cl client.Client, broker *networkv1alp
 		klog.Error("missing certificate: 'tls.crt' not found in CACert Data")
 	}
 
-	// load client cert and privKey
+	// Load client cert and privKey.
 	cert, err := tls.X509KeyPair(clientCert, clientKey)
 	if err != nil {
 		klog.Error("error X509KeyPair: %v", err)
 		return err
 	}
 
-	// load CAcert
+	// Load root cert.
 	caCertPool := x509.NewCertPool()
 	ok = caCertPool.AppendCertsFromPEM(caCertData)
 	if !ok {
 		klog.Error("AppendCertsFromPEM error: %v", ok)
 	}
 
-	// Routing key for topic
+	// Routing key for topic.
 	bc.brokerConn.routingKey, err = extractCNfromCert(&clientCert)
 	if err != nil {
 		klog.Error("Common Name extraction error: %v", err)
 	}
 	bc.brokerConn.queueName = bc.brokerConn.routingKey
 
-	// TLS config
+	// TLS config.
 	tlsConfig := &tls.Config{
 		Certificates: []tls.Certificate{cert},
 		RootCAs:      caCertPool,
 		ServerName:   bc.serverAddr,
-		//InsecureSkipVerify: false, //skip/allow verif SSL
+		MinVersion:   tls.VersionTLS12,
 	}
 
 	err = bc.brokerConnectionConfig(tlsConfig)
 
 	return err
 }
 
-// Execute the Network Manager Broker routines.
+// ExecuteBrokerClient executes the Network Manager Broker routines.
 func (bc *BrokerClient) ExecuteBrokerClient(cl client.Client) error {
-
 	// Start sending messages
 	klog.Info("executing broker client routines")
 	var err error
 	if bc.pubFlag {
 		go func() {
-			if err = bc.publishOnBroker(); err != nil {
-				klog.ErrorS(err, "error sending advertisement")
-			}
+			bc.publishOnBroker()
 		}()
 	}
 
@@ -203,8 +201,7 @@ func (bc *BrokerClient) ExecuteBrokerClient(cl client.Client) error {
 	return err
 }
 
-func (bc *BrokerClient) publishOnBroker() error {
-
+func (bc *BrokerClient) publishOnBroker() {
 	ticker := time.NewTicker(10 * time.Second)
 	for {
 		select {
@@ -219,11 +216,10 @@ func (bc *BrokerClient) publishOnBroker() error {
 				amqp.Publishing{
 					ContentType: "application/json",
 					Body:        bc.brokerConn.outboundMsg,
-					Expiration:  "30000", //TTL ms
+					Expiration:  "30000", // TTL ms
 				})
 			if err != nil {
 				klog.Error("Error pub message: %v", err)
-			} else {
 			}
 
 			select {
@@ -240,28 +236,24 @@ func (bc *BrokerClient) publishOnBroker() error {
 		case <-bc.ctx.Done():
 			ticker.Stop()
 			klog.Info("Ticker stopped\n")
-			return nil
+			return
 		}
 	}
 }
 
 func (bc *BrokerClient) readMsgOnBroker(ctx context.Context, cl client.Client) error {
-
 	klog.Info("Listening from Broker")
 	for d := range bc.brokerConn.inboundMsgs {
-
 		klog.Info("Received remote advertisement from BROKER\n")
 		var remote NetworkManager
 		err := json.Unmarshal(d.Body, &remote.ID)
-
 		if err != nil {
 			klog.Error("Error unmarshalling message: ", err)
 			continue
 		}
 		// Check if received advertisement is remote
 		if bc.ID.IP != remote.ID.IP {
-
-			//create knownCluster CR
+			// Create knownCluster CR
 			kc := &networkv1alpha1.KnownCluster{}
 
 			if err := cl.Get(ctx, client.ObjectKey{Name: namings.ForgeKnownClusterName(remote.ID.NodeID), Namespace: flags.FluidosNamespace}, kc); err != nil {
@@ -312,7 +304,6 @@ func extractCNfromCert(certPEM *[]byte) (string, error) {
 }
 
 func (bc *BrokerClient) brokerConnectionConfig(tlsConfig *tls.Config) error {
-
 	var err error
 	config := amqp.Config{
 		SASL:            []amqp.Authentication{&amqp.ExternalAuth{}}, // auth EXTERNAL
@@ -330,7 +321,7 @@ func (bc *BrokerClient) brokerConnectionConfig(tlsConfig *tls.Config) error {
 		return err
 	}
 
-	// channel creation
+	// Channel creation
 	bc.brokerConn.amqpChan, err = bc.brokerConn.amqpConn.Channel()
 	if err != nil {
 		klog.Error("channel creation error: %v", err)
@@ -343,7 +334,7 @@ func (bc *BrokerClient) brokerConnectionConfig(tlsConfig *tls.Config) error {
 		"",                      // consumer name (empty -> generated)
 		true,                    // AutoAck
 		false,                   // Exclusive: queue is accessible only from this consumer
-		true,                    //false,        // NoLocal: does not recieve messages selfpublished
+		true,                    // false,        // NoLocal: does not receive selfpublished messages
 		false,                   // NoWait: server confirmation
 		nil,                     // Arguments
 	)
@@ -366,8 +357,7 @@ func (bc *BrokerClient) brokerConnectionConfig(tlsConfig *tls.Config) error {
 	return nil
 }
 
-func (bc *BrokerClient) extractSecret(cl client.Client, secretName string, secretNamespace string, secretDest *corev1.Secret) error {
-
+func (bc *BrokerClient) extractSecret(cl client.Client, secretName, secretNamespace string, secretDest *corev1.Secret) error {
 	err := cl.Get(context.TODO(), client.ObjectKey{
 		Name:      secretName,
 		Namespace: secretNamespace,