[CC-7041] Update and start the SCADA provider in HCP manager (hashicorp#19976)

* Update SCADA provider version

Also update mocks for SCADA provider.

* Create SCADA provider w/o HCP config, then update

Adds a placeholder config option to allow us to initialize a SCADA provider
without the HCP configuration. Also adds an update method to then add the
HCP configuration. We need this to be able to eventually always register a
SCADA listener at startup before the HCP config values are known.

* Pass cloud configuration to HCP manager

Save the entire cloud configuration and pass it to the HCP
manager.

* Update and start SCADA provider in HCP manager

Move config updating and starting to the HCP manager. The HCP manager
will eventually be responsible for all processes that contribute
to linking to HCP.

Author: mkam

agent/agent.go

@@ -896,17 +896,6 @@ func (a *Agent) Start(ctx context.Context) error {
 		}()
 	}
 
-	if a.scadaProvider != nil {
-		a.scadaProvider.UpdateMeta(map[string]string{
-			"consul_server_id": string(a.config.NodeID),
-		})
-
-		if err = a.scadaProvider.Start(); err != nil {
-			a.baseDeps.Logger.Error("scada provider failed to start, some HashiCorp Cloud Platform functionality has been disabled",
-				"error", err, "resource_id", a.config.Cloud.ResourceID)
-		}
-	}
-
 	return nil
 }
 
@@ -1598,7 +1587,7 @@ func newConsulConfig(runtimeCfg *config.RuntimeConfig, logger hclog.Logger) (*co
 	cfg.RequestLimitsWriteRate = runtimeCfg.RequestLimitsWriteRate
 	cfg.Locality = runtimeCfg.StructLocality()
 
-	cfg.Cloud.ManagementToken = runtimeCfg.Cloud.ManagementToken
+	cfg.Cloud = runtimeCfg.Cloud
 
 	cfg.Reporting.License.Enabled = runtimeCfg.Reporting.License.Enabled
 

agent/agent_test.go

@@ -6343,6 +6343,7 @@ func TestAgent_scadaProvider(t *testing.T) {
 	pvd.EXPECT().Listen(scada.CAPCoreAPI.Capability()).Return(l, nil).Once()
 	pvd.EXPECT().Stop().Return(nil).Once()
 	pvd.EXPECT().SessionStatus().Return("test")
+	pvd.EXPECT().UpdateHCPConfig(mock.Anything).Return(nil).Once()
 	a := TestAgent{
 		OverrideDeps: func(deps *BaseDeps) {
 			deps.HCP.Provider = pvd

agent/consul/config.go

@@ -16,6 +16,7 @@ import (
 
 	"github.com/hashicorp/consul/agent/checks"
 	consulrate "github.com/hashicorp/consul/agent/consul/rate"
+	hcpconfig "github.com/hashicorp/consul/agent/hcp/config"
 	"github.com/hashicorp/consul/agent/structs"
 	libserf "github.com/hashicorp/consul/lib/serf"
 	"github.com/hashicorp/consul/tlsutil"
@@ -442,7 +443,7 @@ type Config struct {
 
 	Locality *structs.Locality
 
-	Cloud CloudConfig
+	Cloud hcpconfig.CloudConfig
 
 	Reporting Reporting
 

agent/consul/config_cloud.go

@@ -586,9 +586,11 @@ func NewServer(config *Config, flat Deps, externalGRPCServer *grpc.Server,
 	})
 
 	s.hcpManager = hcp.NewManager(hcp.ManagerConfig{
-		Client:   flat.HCP.Client,
-		StatusFn: s.hcpServerStatus(flat),
-		Logger:   logger.Named("hcp_manager"),
+		CloudConfig:   s.config.Cloud,
+		Client:        flat.HCP.Client,
+		StatusFn:      s.hcpServerStatus(flat),
+		Logger:        logger.Named("hcp_manager"),
+		SCADAProvider: flat.HCP.Provider,
 	})
 
 	var recorder *middleware.RequestRecorder

agent/consul/server.go

@@ -32,7 +32,7 @@ func NewDeps(cfg config.CloudConfig, logger hclog.Logger) (Deps, error) {
 		return Deps{}, fmt.Errorf("failed to init client: %w", err)
 	}
 
-	provider, err := scada.New(cfg, logger.Named("scada"))
+	provider, err := scada.New(logger.Named("scada"))
 	if err != nil {
 		return Deps{}, fmt.Errorf("failed to init scada: %w", err)
 	}

agent/hcp/deps.go

@@ -9,6 +9,8 @@ import (
 	"time"
 
 	hcpclient "github.com/hashicorp/consul/agent/hcp/client"
+	"github.com/hashicorp/consul/agent/hcp/config"
+	"github.com/hashicorp/consul/agent/hcp/scada"
 	"github.com/hashicorp/consul/lib"
 	"github.com/hashicorp/go-hclog"
 )
@@ -19,7 +21,9 @@ var (
 )
 
 type ManagerConfig struct {
-	Client hcpclient.Client
+	Client        hcpclient.Client
+	CloudConfig   config.CloudConfig
+	SCADAProvider scada.Provider
 
 	StatusFn    StatusCallback
 	MinInterval time.Duration
@@ -83,6 +87,15 @@ func (m *Manager) Run(ctx context.Context) {
 	var err error
 	m.logger.Debug("HCP manager starting")
 
+	// Update and start the SCADA provider
+	err = m.startSCADAProvider()
+	if err != nil {
+		// Log the error but continue starting the manager. The SCADA provider
+		// could potentially be updated later with a working configuration.
+		m.logger.Error("scada provider failed to start, some HashiCorp Cloud Platform functionality has been disabled",
+			"error", err)
+	}
+
 	// immediately send initial update
 	select {
 	case <-ctx.Done():
@@ -116,6 +129,34 @@ func (m *Manager) Run(ctx context.Context) {
 	}
 }
 
+func (m *Manager) startSCADAProvider() error {
+	provider := m.cfg.SCADAProvider
+	if provider == nil {
+		return nil
+	}
+
+	// Update the SCADA provider configuration with HCP configurations
+	m.logger.Debug("updating scada provider with HCP configuration")
+	err := provider.UpdateHCPConfig(m.cfg.CloudConfig)
+	if err != nil {
+		m.logger.Error("failed to update scada provider with HCP configuration", "err", err)
+		return err
+	}
+
+	// Update the SCADA provider metadata
+	provider.UpdateMeta(map[string]string{
+		"consul_server_id": string(m.cfg.CloudConfig.NodeID),
+	})
+
+	// Start the SCADA provider
+	err = provider.Start()
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func (m *Manager) UpdateConfig(cfg ManagerConfig) {
 	m.cfgMu.Lock()
 	defer m.cfgMu.Unlock()

agent/hcp/manager.go

@@ -9,6 +9,8 @@ import (
 	"time"
 
 	hcpclient "github.com/hashicorp/consul/agent/hcp/client"
+	"github.com/hashicorp/consul/agent/hcp/config"
+	"github.com/hashicorp/consul/agent/hcp/scada"
 	"github.com/hashicorp/go-hclog"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
@@ -22,10 +24,26 @@ func TestManager_Run(t *testing.T) {
 	}
 	updateCh := make(chan struct{}, 1)
 	client.EXPECT().PushServerStatus(mock.Anything, &hcpclient.ServerStatus{ID: t.Name()}).Return(nil).Once()
+
+	cloudCfg := config.CloudConfig{
+		ResourceID: "organization/85702e73-8a3d-47dc-291c-379b783c5804/project/8c0547c0-10e8-1ea2-dffe-384bee8da634/hashicorp.consul.global-network-manager.cluster/test",
+		NodeID:     "node-1",
+	}
+	scadaM := scada.NewMockProvider(t)
+	scadaM.EXPECT().UpdateHCPConfig(cloudCfg).Return(nil)
+	scadaM.EXPECT().UpdateMeta(
+		map[string]string{
+			"consul_server_id": string(cloudCfg.NodeID),
+		},
+	).Return()
+	scadaM.EXPECT().Start().Return(nil)
+
 	mgr := NewManager(ManagerConfig{
-		Client:   client,
-		Logger:   hclog.New(&hclog.LoggerOptions{Output: io.Discard}),
-		StatusFn: statusF,
+		Client:        client,
+		Logger:        hclog.New(&hclog.LoggerOptions{Output: io.Discard}),
+		StatusFn:      statusF,
+		CloudConfig:   cloudCfg,
+		SCADAProvider: scadaM,
 	})
 	mgr.testUpdateSent = updateCh
 	ctx, cancel := context.WithCancel(context.Background())