Skip to content

Commit

Permalink
add backend service reference
Browse files Browse the repository at this point in the history
  • Loading branch information
gemmahou committed Dec 5, 2024
1 parent bc85425 commit 3d633c2
Show file tree
Hide file tree
Showing 17 changed files with 292 additions and 197 deletions.
145 changes: 145 additions & 0 deletions apis/compute/v1beta1/computebackendservice_reference.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
// 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 v1beta1

import (
"context"
"fmt"
"strings"

"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s"

refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"

"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
)

var _ refsv1beta1.ExternalNormalizer = &ComputeBackendServiceRef{}
var ComputeBackendServiceGVK = GroupVersion.WithKind("ComputeBackendService")

// ComputeBackendServiceRef defines the resource reference to ComputeBackendService, which "External" field
// holds the GCP identifier for the KRM object.
type ComputeBackendServiceRef struct {
// The value of an externally managed ComputeBackendService resource.
// Should be in the format "projects/{{project}}/global/backendServices/{{backendService}}"
// or "projects/{{project}}/regions/{{region}}/backendServices/{{backendService}}".
External string `json:"external,omitempty"`

// The name of a ComputeBackendService resource.
Name string `json:"name,omitempty"`

// The namespace of a ComputeBackendService resource.
Namespace string `json:"namespace,omitempty"`

//parent *ComputeBackendServiceParent
}

// NormalizedExternal provision the "External" value for other resource that depends on ComputeBackendService.
// If the "External" is given in the other resource's spec.ComputeBackendServiceRef, the given value will be used.
// Otherwise, the "Name" and "Namespace" will be used to query the actual ComputeBackendService object from the cluster.
func (r *ComputeBackendServiceRef) NormalizedExternal(ctx context.Context, reader client.Reader, otherNamespace string) (string, error) {
// Get value from spec.ComputeBackendServiceRef.external
if r.External != "" {
if r.Name != "" {
return "", fmt.Errorf("cannot specify both name and external on reference")
}
// To ensure backward compatibility for existing users, we do not enforce external format here
return r.External, nil
}

if r.Name == "" {
return "", fmt.Errorf("must specify either name or external on reference")
}

// Get value from the Config Connector object
if r.Namespace == "" {
r.Namespace = otherNamespace
}
key := types.NamespacedName{Name: r.Name, Namespace: r.Namespace}

u, err := refsv1beta1.ResolveResourceName(ctx, reader, key, ComputeBackendServiceGVK)
if err != nil {
return "", err
}

// Get value from object's status.externalRef(only support for objects created by direct controller)
// This is the most trustworthy place
actualExternalRef, found1, err1 := unstructured.NestedString(u.Object, "status", "externalRef")
if !found1 {
// Get value from object's status.selfLink(support for objects not created by direct controller)
selfLink, found2, err2 := unstructured.NestedString(u.Object, "status", "selfLink")
if !found2 {
return "", fmt.Errorf("cannot get referenced %s %v", u.GetKind(), u.GetNamespace())
}
if err2 != nil || selfLink == "" {
return "", fmt.Errorf("cannot get selfLink for referenced %s %v (status.selfLink is empty)", u.GetKind(), u.GetNamespace())
}
r.External = selfLink
return r.External, nil
}
if err1 != nil || actualExternalRef == "" {
return "", fmt.Errorf("cannot get externalRef for referenced %s %v (status.externalRef is empty)", u.GetKind(), u.GetNamespace())
}
r.External = actualExternalRef
return r.External, nil
}

func (r *ComputeBackendServiceRef) Parent() (*ComputeBackendServiceParent, error) {
if r.External != "" {
parent, _, err := ParseComputeBackendServiceExternal(r.External)
if err != nil {
return nil, err
}
return parent, nil
}
return nil, fmt.Errorf("ComputeBackendServiceRef not initialized by `NewComputeBackendServiceRef` or resolved by `ResolveExternal`")
}

type ComputeBackendServiceParent struct {
ProjectID string
Region string
}

func (p *ComputeBackendServiceParent) String() string {
if p.Region == "global" {
return "projects/" + p.ProjectID + "/global"
} else {
return "projects/" + p.ProjectID + "/regions/" + p.Region
}
}

func ParseComputeBackendServiceExternal(external string) (parent *ComputeBackendServiceParent, resourceID string, err error) {
external = strings.TrimPrefix(external, "/")
tokens := strings.Split(external, "/")
if len(tokens) == 5 && tokens[0] == "projects" && tokens[3] == "backendServices" {
parent = &ComputeBackendServiceParent{
ProjectID: tokens[1],
Region: tokens[2],
}
resourceID = tokens[4]
return parent, resourceID, nil
} else if len(tokens) == 6 && tokens[0] == "projects" && tokens[2] == "regions" && tokens[4] == "backendServices" {
parent = &ComputeBackendServiceParent{
ProjectID: tokens[1],
Region: tokens[3],
}
resourceID = tokens[5]
return parent, resourceID, nil
}
acceptedFormat := "projects/{{project}}/global/backendServices/{{backendService}} or projects/{{project}}/regions/{{region}}/backendServices/{{backendService}}"
return nil, "", k8s.NewInvalidFormatError(external, acceptedFormat)
}
2 changes: 1 addition & 1 deletion apis/compute/v1beta1/forwardingrule_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ type ComputeForwardingRuleSpec struct {
/* A ComputeBackendService to receive the matched traffic. This is
used only for internal load balancing. */
// +optional
BackendServiceRef *refs.ComputeBackendServiceRef `json:"backendServiceRef,omitempty"`
BackendServiceRef *ComputeBackendServiceRef `json:"backendServiceRef,omitempty"`

/* Immutable. An optional description of this resource. Provide this property when
you create the resource. */
Expand Down
3 changes: 1 addition & 2 deletions apis/compute/v1beta1/targettcpproxy_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
package v1beta1

import (
refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/apis/k8s/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
Expand All @@ -34,7 +33,7 @@ var (
type ComputeTargetTCPProxySpec struct {
// A reference to the ComputeBackendService resource.
// +required
BackendServiceRef *refs.ComputeBackendServiceRef `json:"backendServiceRef"`
BackendServiceRef *ComputeBackendServiceRef `json:"backendServiceRef"`

// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Description is immutable"
// Immutable. An optional description of this resource.
Expand Down
34 changes: 32 additions & 2 deletions apis/compute/v1beta1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 0 additions & 9 deletions apis/refs/v1beta1/computerefs.go
Original file line number Diff line number Diff line change
Expand Up @@ -256,15 +256,6 @@ type ComputeAddressRef struct {
Namespace string `json:"namespace,omitempty"`
}

type ComputeBackendServiceRef struct {
/* The ComputeBackendService selflink in the form "projects/{{project}}/global/backendServices/{{name}}" or "projects/{{project}}/regions/{{region}}/backendServices/{{name}}" when not managed by Config Connector. */
External string `json:"external,omitempty"`
/* The `name` field of a `ComputeBackendService` resource. */
Name string `json:"name,omitempty"`
/* The `namespace` field of a `ComputeBackendService` resource. */
Namespace string `json:"namespace,omitempty"`
}

type ComputeServiceAttachmentRef struct {
/* The ComputeServiceAttachment selflink in the form "projects/{{project}}/regions/{{region}}/serviceAttachments/{{name}}" when not managed by Config Connector. */
External string `json:"external,omitempty"`
Expand Down
19 changes: 19 additions & 0 deletions apis/refs/v1beta1/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,14 @@
package v1beta1

import (
"context"
"fmt"

"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime/schema"
"sigs.k8s.io/controller-runtime/pkg/client"

"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
)

Expand All @@ -41,3 +47,16 @@ func GetLocation(u *unstructured.Unstructured) (string, error) {
}
return location, nil
}

func ResolveResourceName(ctx context.Context, reader client.Reader, key client.ObjectKey, gvk schema.GroupVersionKind) (*unstructured.Unstructured, error) {
resource := &unstructured.Unstructured{}
resource.SetGroupVersionKind(gvk)
if err := reader.Get(ctx, key, resource); err != nil {
if apierrors.IsNotFound(err) {
return nil, k8s.NewReferenceNotFoundError(resource.GroupVersionKind(), key)
}
return nil, fmt.Errorf("error reading referenced %v %v: %w", gvk.Kind, key, err)
}

return resource, nil
}
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,15 @@ spec:
- external
properties:
external:
description: The ComputeBackendService selflink in the form "projects/{{project}}/global/backendServices/{{name}}"
or "projects/{{project}}/regions/{{region}}/backendServices/{{name}}"
when not managed by Config Connector.
description: The value of an externally managed ComputeBackendService
resource. Should be in the format "projects/{{project}}/global/backendServices/{{backendService}}"
or "projects/{{project}}/regions/{{region}}/backendServices/{{backendService}}".
type: string
name:
description: The `name` field of a `ComputeBackendService` resource.
description: The name of a ComputeBackendService resource.
type: string
namespace:
description: The `namespace` field of a `ComputeBackendService`
resource.
description: The namespace of a ComputeBackendService resource.
type: string
type: object
description:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,15 @@ spec:
- external
properties:
external:
description: The ComputeBackendService selflink in the form "projects/{{project}}/global/backendServices/{{name}}"
or "projects/{{project}}/regions/{{region}}/backendServices/{{name}}"
when not managed by Config Connector.
description: The value of an externally managed ComputeBackendService
resource. Should be in the format "projects/{{project}}/global/backendServices/{{backendService}}"
or "projects/{{project}}/regions/{{region}}/backendServices/{{backendService}}".
type: string
name:
description: The `name` field of a `ComputeBackendService` resource.
description: The name of a ComputeBackendService resource.
type: string
namespace:
description: The `namespace` field of a `ComputeBackendService`
resource.
description: The namespace of a ComputeBackendService resource.
type: string
type: object
description:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -539,3 +539,28 @@ func setStatus(u *unstructured.Unstructured, typedStatus any) error {

return nil
}

// This function get the normalized external values and convert it to the API required format
func resolveBackendService(ctx context.Context, reader client.Reader, obj *krm.ComputeTargetTCPProxy) (string, error) {
// API required format: selfLink
computeBasePath := "https://www.googleapis.com/compute/v1/"
ref := obj.Spec.BackendServiceRef
if ref != nil {
// Get normalized external
_, err := ref.NormalizedExternal(ctx, reader, obj.GetNamespace())
if err != nil {
return "", fmt.Errorf("failed to get BackendServiceRef: %w", err)
}
// Convert normalized external to API required format
v := ref.External
_, _, err = krm.ParseComputeBackendServiceExternal(v)
if err != nil {
// value follows KCC external format, add the compute prefix in front
return computeBasePath + v, nil
}
// for backward compatibility, we also accept values that does not match the KCC external format.
// return the value as is and let the API handle it
return v, nil
}
return "", fmt.Errorf("BackendServiceRef is nil")
}
6 changes: 3 additions & 3 deletions pkg/controller/direct/compute/forwardingrule/mapper.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,16 @@ func ComputeForwardingRuleSpec_IpAddress_FromProto(mapCtx *direct.MapContext, in
return out
}

func ComputeForwardingRuleSpec_BackendSeriviceRef_FromProto(mapCtx *direct.MapContext, in string) *refs.ComputeBackendServiceRef {
func ComputeForwardingRuleSpec_BackendSeriviceRef_FromProto(mapCtx *direct.MapContext, in string) *krm.ComputeBackendServiceRef {
if in == "" {
return nil
}
return &refs.ComputeBackendServiceRef{
return &krm.ComputeBackendServiceRef{
External: in,
}
}

func ComputeForwardingRuleSpec_BackendSeriviceRef_ToProto(mapCtx *direct.MapContext, in *refs.ComputeBackendServiceRef) *string {
func ComputeForwardingRuleSpec_BackendSeriviceRef_ToProto(mapCtx *direct.MapContext, in *krm.ComputeBackendServiceRef) *string {
if in == nil {
return nil
}
Expand Down
Loading

0 comments on commit 3d633c2

Please sign in to comment.