feat: implement direct controller for MonitoringDashboard

pkg/controller/direct/monitoring/client.go

@@ -0,0 +1,88 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package monitoring
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	api "cloud.google.com/go/monitoring/dashboard/apiv1"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/config"
+	"google.golang.org/api/option"
+)
+
+type gcpClient struct {
+	config config.ControllerConfig
+}
+
+func newGCPClient(ctx context.Context, config *config.ControllerConfig) (*gcpClient, error) {
+	gcpClient := &gcpClient{
+		config: *config,
+	}
+	return gcpClient, nil
+}
+
+func (m *gcpClient) options() ([]option.ClientOption, error) {
+	var opts []option.ClientOption
+	if m.config.UserAgent != "" {
+		opts = append(opts, option.WithUserAgent(m.config.UserAgent))
+	}
+	if m.config.HTTPClient != nil {
+		// TODO: Set UserAgent in this scenario (error is: WithHTTPClient is incompatible with gRPC dial options)
+
+		httpClient := &http.Client{}
+		*httpClient = *m.config.HTTPClient
+		httpClient.Transport = &optionsRoundTripper{
+			config: m.config,
+			inner:  m.config.HTTPClient.Transport,
+		}
+		opts = append(opts, option.WithHTTPClient(httpClient))
+	}
+	if m.config.UserProjectOverride && m.config.BillingProject != "" {
+		opts = append(opts, option.WithQuotaProject(m.config.BillingProject))
+	}
+
+	// TODO: support endpoints?
+	// if m.config.Endpoint != "" {
+	// 	opts = append(opts, option.WithEndpoint(m.config.Endpoint))
+	// }
+
+	return opts, nil
+}
+
+type optionsRoundTripper struct {
+	config config.ControllerConfig
+	inner  http.RoundTripper
+}
+
+func (m *optionsRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
+	if m.config.UserAgent != "" {
+		req.Header.Set("User-Agent", m.config.UserAgent)
+	}
+	return m.inner.RoundTrip(req)
+}
+
+func (m *gcpClient) newDashboardsClient(ctx context.Context) (*api.DashboardsClient, error) {
+	opts, err := m.options()
+	if err != nil {
+		return nil, err
+	}
+	client, err := api.NewDashboardsRESTClient(ctx, opts...)
+	if err != nil {
+		return nil, fmt.Errorf("building dashboard client: %w", err)
+	}
+	return client, err
+}

pkg/controller/direct/monitoring/monitoringdashboard_controller.go

@@ -0,0 +1,280 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package monitoring
+
+import (
+	"context"
+	"fmt"
+
+	api "cloud.google.com/go/monitoring/dashboard/apiv1"
+	pb "cloud.google.com/go/monitoring/dashboard/apiv1/dashboardpb"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/util/sets"
+	"k8s.io/klog/v2"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	krm "github.com/GoogleCloudPlatform/k8s-config-connector/apis/monitoring/v1beta1"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/config"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/directbase"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/references"
+)
+
+func init() {
+	directbase.ControllerBuilder.RegisterModel(krm.MonitoringDashboardGVK, newDashboardModel)
+}
+
+func newDashboardModel(config *config.ControllerConfig) directbase.Model {
+	return &dashboardModel{config: config}
+}
+
+type dashboardModel struct {
+	config *config.ControllerConfig
+}
+
+// model implements the Model interface.
+var _ directbase.Model = &dashboardModel{}
+
+type dashboardAdapter struct {
+	projectID  string
+	resourceID string
+
+	desired *pb.Dashboard
+	actual  *pb.Dashboard
+
+	dashboardsClient *api.DashboardsClient
+}
+
+// adapter implements the Adapter interface.
+var _ directbase.Adapter = &dashboardAdapter{}
+
+// AdapterForObject implements the Model interface.
+func (m *dashboardModel) AdapterForObject(ctx context.Context, kube client.Reader, u *unstructured.Unstructured) (directbase.Adapter, error) {
+	gcpClient, err := newGCPClient(ctx, m.config)
+	if err != nil {
+		return nil, fmt.Errorf("building gcp client: %w", err)
+	}
+
+	dashboardsClient, err := gcpClient.newDashboardsClient(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	obj := &krm.MonitoringDashboard{}
+	if err := runtime.DefaultUnstructuredConverter.FromUnstructured(u.Object, &obj); err != nil {
+		return nil, fmt.Errorf("error converting to %T: %w", obj, err)
+	}
+
+	resourceID := ValueOf(obj.Spec.ResourceID)
+	if resourceID == "" {
+		resourceID = obj.GetName()
+	}
+	if resourceID == "" {
+		return nil, fmt.Errorf("cannot resolve resource ID")
+	}
+
+	projectRef, err := references.ResolveProject(ctx, kube, obj, &obj.Spec.ProjectRef)
+	if err != nil {
+		return nil, err
+	}
+	projectID := projectRef.ProjectID
+	if projectID == "" {
+		return nil, fmt.Errorf("cannot resolve project")
+	}
+
+	if err := VisitFields(obj, &refNormalizer{ctx: ctx, src: obj, kube: kube}); err != nil {
+		return nil, err
+	}
+
+	mapCtx := &MapContext{}
+	desiredProto := MonitoringDashboardSpec_ToProto(mapCtx, &obj.Spec)
+	if mapCtx.Err() != nil {
+		return nil, mapCtx.Err()
+	}
+
+	return &dashboardAdapter{
+		projectID:        projectID,
+		resourceID:       resourceID,
+		desired:          desiredProto,
+		dashboardsClient: dashboardsClient,
+	}, nil
+}
+
+// Find implements the Adapter interface.
+func (a *dashboardAdapter) Find(ctx context.Context) (bool, error) {
+	if a.resourceID == "" {
+		return false, nil
+	}
+
+	req := &pb.GetDashboardRequest{
+		Name: a.fullyQualifiedName(),
+	}
+	dashboard, err := a.dashboardsClient.GetDashboard(ctx, req)
+	if err != nil {
+		if IsNotFound(err) {
+			return false, nil
+		}
+		return false, err
+	}
+
+	a.actual = dashboard
+
+	return true, nil
+}
+
+// Delete implements the Adapter interface.
+func (a *dashboardAdapter) Delete(ctx context.Context) (bool, error) {
+	// Check if exists / already deleted
+	// Technically we can just delete, but this is a little cleaner in logs etc.
+	exists, err := a.Find(ctx)
+	if err != nil {
+		return false, err
+	}
+	if !exists {
+		return false, nil
+	}
+
+	// TODO: Delete via status selfLink?
+	req := &pb.DeleteDashboardRequest{
+		Name: a.fullyQualifiedName(),
+	}
+
+	if err := a.dashboardsClient.DeleteDashboard(ctx, req); err != nil {
+		if IsNotFound(err) {
+			return false, nil
+		}
+		return false, fmt.Errorf("deleting dashboard %s: %w", a.fullyQualifiedName(), err)
+	}
+
+	return true, nil
+}
+
+// Create implements the Adapter interface.
+func (a *dashboardAdapter) Create(ctx context.Context, u *unstructured.Unstructured) error {
+	log := klog.FromContext(ctx)
+	log.V(2).Info("creating object", "u", u)
+
+	parent := "projects/" + a.projectID
+
+	req := &pb.CreateDashboardRequest{
+		Parent:    parent,
+		Dashboard: a.desired,
+	}
+	req.Dashboard.Name = a.fullyQualifiedName()
+
+	log.V(2).Info("creating dashboard", "req", req)
+	created, err := a.dashboardsClient.CreateDashboard(ctx, req)
+	if err != nil {
+		return fmt.Errorf("creating dashboard: %w", err)
+	}
+	log.V(2).Info("created dashboard", "dashboard", created)
+
+	resourceID := lastComponent(created.Name)
+	if err := unstructured.SetNestedField(u.Object, resourceID, "spec", "resourceID"); err != nil {
+		return fmt.Errorf("setting spec.resourceID: %w", err)
+	}
+
+	mapCtx := &MapContext{}
+	status := MonitoringDashboardStatus_FromProto(mapCtx, created)
+	if mapCtx.Err() != nil {
+		return mapCtx.Err()
+	}
+	return setStatus(u, status)
+}
+
+// Update implements the Adapter interface.
+func (a *dashboardAdapter) Update(ctx context.Context, u *unstructured.Unstructured) error {
+	log := klog.FromContext(ctx)
+	log.V(2).Info("updating object", "u", u)
+
+	// TODO: Where/how do we want to enforce immutability?
+
+	changedFields := ComputeChangedFields(onlySpec(a.desired), onlySpec(a.actual))
+	if len(changedFields) != 0 {
+		log.Info("changed fields", "fields", sets.List(changedFields))
+
+		req := &pb.UpdateDashboardRequest{
+			Dashboard: a.desired,
+		}
+		req.Dashboard.Name = a.fullyQualifiedName()
+
+		log.V(2).Info("updating dashboard", "request", req)
+		updated, err := a.dashboardsClient.UpdateDashboard(ctx, req)
+		if err != nil {
+			return err
+		}
+		log.V(2).Info("updated dashboard", "dashboard", updated)
+		a.actual = updated
+	}
+
+	mapCtx := &MapContext{}
+	status := MonitoringDashboardStatus_FromProto(mapCtx, a.actual)
+	if mapCtx.Err() != nil {
+		return mapCtx.Err()
+	}
+	return setStatus(u, status)
+}
+
+func (a *dashboardAdapter) Export(ctx context.Context) (*unstructured.Unstructured, error) {
+	if a.actual == nil {
+		return nil, fmt.Errorf("dashboard %q not found", a.fullyQualifiedName())
+	}
+
+	mc := &MapContext{}
+	spec := MonitoringDashboardSpec_FromProto(mc, a.actual)
+	if err := mc.Err(); err != nil {
+		return nil, fmt.Errorf("error converting dashboard from API %w", err)
+	}
+
+	specObj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(spec)
+	if err != nil {
+		return nil, fmt.Errorf("error converting dashboard spec to unstructured: %w", err)
+	}
+
+	u := &unstructured.Unstructured{
+		Object: make(map[string]interface{}),
+	}
+	u.SetName(a.resourceID)
+	u.SetGroupVersionKind(krm.MonitoringDashboardGVK)
+	if err := unstructured.SetNestedField(u.Object, specObj, "spec"); err != nil {
+		return nil, fmt.Errorf("setting spec: %w", err)
+	}
+
+	return u, nil
+}
+
+func onlySpec(in *pb.Dashboard) *pb.Dashboard {
+	// We could also do this "directly" with...
+	// c := proto.Clone(in).(*pb.Dashboard)
+	// c.Etag = ""
+	// c.Name = ""
+
+	// Remove unmapped fields by round-tripping through spec
+	mapCtx := &MapContext{}
+	spec := MonitoringDashboardSpec_FromProto(mapCtx, in)
+	if mapCtx.Err() != nil {
+		klog.Fatalf("error during onlySpec: %v", mapCtx.Err())
+	}
+
+	out := MonitoringDashboardSpec_ToProto(mapCtx, spec)
+	if mapCtx.Err() != nil {
+		klog.Fatalf("error during onlySpec: %v", mapCtx.Err())
+	}
+	return out
+}
+
+func (a *dashboardAdapter) fullyQualifiedName() string {
+	return fmt.Sprintf("projects/%s/dashboards/%s", a.projectID, a.resourceID)
+}