pbhcp: update proto documentation

agent/hcp/client/client_test.go

@@ -22,10 +22,6 @@ type mockTGW struct {
 	mockError    error
 }
 
-func (m *mockTGW) GetServiceTopology(params *hcptelemetry.GetServiceTopologyParams, authInfo runtime.ClientAuthInfoWriter, opts ...hcptelemetry.ClientOption) (*hcptelemetry.GetServiceTopologyOK, error) {
-	return hcptelemetry.NewGetServiceTopologyOK(), nil
-}
-
 func (m *mockTGW) AgentTelemetryConfig(params *hcptelemetry.AgentTelemetryConfigParams, authInfo runtime.ClientAuthInfoWriter, opts ...hcptelemetry.ClientOption) (*hcptelemetry.AgentTelemetryConfigOK, error) {
 	return m.mockResponse, m.mockError
 }

agent/hcp/client/telemetry_config.go

@@ -35,7 +35,6 @@ var (
 // TelemetryConfig contains configuration for telemetry data forwarded by Consul servers
 // to the HCP Telemetry gateway.
 type TelemetryConfig struct {
-	Endpoint      string
 	MetricsConfig *MetricsConfig
 	RefreshConfig *RefreshConfig
 }
@@ -91,7 +90,6 @@ func convertAgentTelemetryResponse(ctx context.Context, resp *hcptelemetry.Agent
 	metricLabels := convertMetricLabels(telemetryConfig.Labels, cfg)
 
 	return &TelemetryConfig{
-		Endpoint: telemetryConfig.Endpoint,
 		MetricsConfig: &MetricsConfig{
 			Endpoint: metricsEndpoint,
 			Labels:   metricLabels,

internal/hcp/internal/controllers/telemetrystate/controller.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
 package telemetrystate
 
 import (
@@ -45,10 +48,6 @@ func (r *telemetryStateReconciler) Reconcile(ctx context.Context, rt controller.
 
 	rt.Logger.Trace("reconciling telemetry-state")
 
-	if resource.EqualID(req.ID, globalID) {
-
-	}
-
 	// First get the link resource in order to build a hcp client. If the link resource
 	// doesn't exist then the telemetry-state should not exist either.
 	res, err := getLinkResource(ctx, rt)

internal/hcp/internal/controllers/telemetrystate/controller_test.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
 package telemetrystate
 
 import (

internal/hcp/internal/controllers/telemetrystate/status.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
 package telemetrystate
 
 const (

internal/hcp/internal/types/telemetry_state.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
 package types
 
 import (
@@ -57,9 +60,5 @@ func validateTelemetryState(res *DecodedTelemetryState) error {
 		})
 	}
 
-	if res.Data.HcpConfig != nil {
-		err = multierror.Append(err, validateHCPConfig(res.Data.HcpConfig))
-	}
-
 	return err
 }

proto-public/pbhcp/v2/hcp_config.proto

@@ -6,10 +6,18 @@ syntax = "proto3";
 package hashicorp.consul.hcp.v2;
 
 // HCPConfig is used to configure the HCP SDK for communicating with
-// the HashiCorp Cloud Platform
+// the HashiCorp Cloud Platform. All configuration is optional with default
+// values provided by the SDK.
 message HCPConfig {
+  // AuthUrl is the URL which will be used to authenticate.
   string auth_url = 1;
+
+  // ApiAddress is the address (<hostname>[:port]) of the HCP api.
   string api_address = 2;
+
+  // ScadaAddress is the address (<hostname>[:port]) of the HCP SCADA endpoint.
   string scada_address = 3;
+
+  // TlsInsecureSkipVerify if true will ignore server name verification when making HTTPS requests
   bool tls_insecure_skip_verify = 4;
 }

proto-public/pbhcp/v2/link.proto

@@ -5,8 +5,8 @@ syntax = "proto3";
 
 package hashicorp.consul.hcp.v2;
 
-import "pbresource/annotations.proto";
 import "pbhcp/v2/hcp_config.proto";
+import "pbresource/annotations.proto";
 
 enum AccessLevel {
   ACCESS_LEVEL_UNSPECIFIED = 0;

proto-public/pbhcp/v2/telemetry_state.proto

@@ -2,29 +2,54 @@ syntax = "proto3";
 
 package hashicorp.consul.hcp.v2;
 
-import "pbresource/annotations.proto";
 import "pbhcp/v2/hcp_config.proto";
+import "pbresource/annotations.proto";
 
+// TelemetryState describes configuration required to forward telemetry to the HashiCorp Cloud Platform.
+// This resource is managed internally and is only written if the cluster is linked to HCP. Any
+// manual changes to the resource will be reconciled and overwritten with the internally computed
+// state.
 message TelemetryState {
   option (hashicorp.consul.resource.spec) = {scope: SCOPE_CLUSTER};
 
+  // ResourceId is the identifier for the cluster linked with HCP.
   string resource_id = 1;
+
+  // ClientId is the oauth client identifier for cluster.
+  // This client has capabilities limited to writing telemetry data for this cluster.
   string client_id = 2;
+
+  // ClientSecret is the oauth secret used to authenticate requests to send telemetry data to HCP.
   string client_secret = 3;
+
   HCPConfig hcp_config = 4;
   ProxyConfig proxy = 5;
   MetricsConfig metrics = 6;
 }
 
+// MetricsConfig configures metric specific collection details
 message MetricsConfig {
+  // Endpoint is the HTTPS address and path to forward metrics to
   string endpoint = 1;
+
+  // IncludeList contains patterns to match against metric names. Only matched metrics are forwarded.
   repeated string include_list = 2;
-  map<string,string> labels = 3;
+
+  // Labels contains key value pairs that are associated with all metrics collected and fowarded.
+  map<string, string> labels = 3;
+
+  // Disabled toggles metric forwarding. If true, metric forwarding will stop until disabled is set to false.
   bool disabled = 4;
 }
 
+// ProxyConfig describes configuration for forwarding requests through an http proxy
 message ProxyConfig {
+  // HttpProxy configures the http proxy to use for HTTP (non-TLS) requests.
   string http_proxy = 1;
+
+  // HttpsProxy configures the http proxy to use for HTTPS (TLS) requests.
   string https_proxy = 2;
+
+  // NoProxy can be configured to include domains which should NOT be forwarded through the configured http proxy
   repeated string no_proxy = 3;
 }