-
Notifications
You must be signed in to change notification settings - Fork 235
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Add backend service reference and refactor reference code #3316
Open
gemmahou
wants to merge
2
commits into
GoogleCloudPlatform:master
Choose a base branch
from
gemmahou:backendserviceref
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // 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 | ||
|
|
||
| type BackendServiceIdentity struct { | ||
| id string | ||
| parent *BackendServiceParent | ||
| } | ||
|
|
||
| type BackendServiceParent struct { | ||
| ProjectID string | ||
| Region string | ||
| } | ||
|
|
||
| func (p *BackendServiceParent) String() string { | ||
| if p.Region == "global" { | ||
| return "projects/" + p.ProjectID + "/global" | ||
| } else { | ||
| return "projects/" + p.ProjectID + "/regions/" + p.Region | ||
| } | ||
| } | ||
|
|
||
| func (i *BackendServiceIdentity) ID() string { | ||
| return i.id | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| // 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"` | ||
| } | ||
|
|
||
| // 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) { | ||
| referenceContext := refsv1beta1.ReferenceContext{IsDirectOnly: false, TargetField: "status.selfLink"} | ||
| // Get value from spec.ComputeBackendServiceRef.external | ||
| if r.External != "" { | ||
| if r.Name != "" { | ||
| return "", fmt.Errorf("cannot specify both name and external on reference") | ||
| } | ||
| if referenceContext.IsDirectOnly { | ||
| if _, err := ParseBackendServiceExternal(r.External); err != nil { | ||
| return "", err | ||
| } | ||
| } | ||
| // To ensure backward compatibility for existing users, we do not enforce external format | ||
| // for non-direct resources | ||
| 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 | ||
| } | ||
|
|
||
| actualExternalRef, found, err := unstructured.NestedString(u.Object, "status", "externalRef") | ||
| if err != nil { | ||
| return "", fmt.Errorf("error getting status.externalRef for %s %s/%s: %w", u.GetKind(), u.GetNamespace(), u.GetName(), err) | ||
| } | ||
| // If object is DirectOnly, it is created by direct controller. | ||
| // Get value from status.externalRef, which is the most trustworthy source. | ||
| if referenceContext.IsDirectOnly { | ||
| if !found || actualExternalRef == "" { | ||
| return "", fmt.Errorf("status.externalRef is required for DirectOnly resources, but is missing or empty for %s %s/%s", u.GetKind(), u.GetNamespace(), u.GetName()) | ||
| } | ||
| r.External = actualExternalRef | ||
| } | ||
|
|
||
| // If object not DirectOnly, it can be created by either direct controller or legacy controller, depends on user's settings. | ||
| // If status.externalRef does not exist, it's created by legacy controller. Get values from target field. | ||
| if !found { | ||
| targetField := referenceContext.TargetField | ||
| tokens := strings.Split(targetField, ".") | ||
| targetField, found, err := unstructured.NestedString(u.Object, tokens...) | ||
| if err != nil { | ||
| return "", fmt.Errorf("error getting target field %s for %s %s/%s: %w", targetField, u.GetKind(), u.GetNamespace(), u.GetName(), err) | ||
| } | ||
| if !found || targetField == "" { | ||
| return "", fmt.Errorf("target field %s is required but is missing or empty for %s %s/%s", targetField, u.GetKind(), u.GetNamespace(), u.GetName()) | ||
| } | ||
| r.External = targetField | ||
| } else { | ||
| // If status.externalRef exists, it's created by direct controller. Get value from status.externalRef. | ||
| r.External = actualExternalRef | ||
| } | ||
| return r.External, nil | ||
| } | ||
|
|
||
| func ParseBackendServiceExternal(external string) (identity *BackendServiceIdentity, err error) { | ||
| external = strings.TrimPrefix(external, "/") | ||
| tokens := strings.Split(external, "/") | ||
| if len(tokens) == 5 && tokens[0] == "projects" && tokens[3] == "backendServices" { | ||
| return &BackendServiceIdentity{ | ||
| parent: &BackendServiceParent{ProjectID: tokens[1], Region: tokens[2]}, | ||
| id: tokens[4], | ||
| }, nil | ||
| } else if len(tokens) == 6 && tokens[0] == "projects" && tokens[2] == "regions" && tokens[4] == "backendServices" { | ||
| return &BackendServiceIdentity{ | ||
| parent: &BackendServiceParent{ProjectID: tokens[1], Region: tokens[3]}, | ||
| id: tokens[5], | ||
| }, nil | ||
| } | ||
| acceptedFormat := "projects/{{project}}/global/backendServices/{{backendService}} or projects/{{project}}/regions/{{region}}/backendServices/{{backendService}}" | ||
| return nil, k8s.NewInvalidFormatError(external, acceptedFormat) | ||
| } | ||
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thought: maybe we could rename
ResourceIdentitytoResourceExternal? I feel "Identity" is just the same thing as "ExternalRef", so that we don't introduce many new terms to people.