-
Notifications
You must be signed in to change notification settings - Fork 238
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2819 from jasonvigil/workstationconfig
feat: Add types for WorkstationConfig
- Loading branch information
Showing
32 changed files
with
4,824 additions
and
200 deletions.
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,184 @@ | ||
| // 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 v1alpha1 | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1" | ||
| "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s" | ||
| apierrors "k8s.io/apimachinery/pkg/api/errors" | ||
| "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| ) | ||
|
|
||
| var _ refsv1beta1.ExternalNormalizer = &WorkstationClusterRef{} | ||
|
|
||
| // WorkstationClusterRef defines the resource reference to WorkstationCluster, which "External" field | ||
| // holds the GCP identifier for the KRM object. | ||
| type WorkstationClusterRef struct { | ||
| // A reference to an externally managed WorkstationCluster resource. | ||
| // Should be in the format "projects/<projectID>/locations/<location>/workstationClusters/<workstationclusterID>". | ||
| External string `json:"external,omitempty"` | ||
|
|
||
| // The name of a WorkstationCluster resource. | ||
| Name string `json:"name,omitempty"` | ||
|
|
||
| // The namespace of a WorkstationCluster resource. | ||
| Namespace string `json:"namespace,omitempty"` | ||
| } | ||
|
|
||
| // NormalizedExternal provision the "External" value for other resource that depends on WorkstationCluster. | ||
| // If the "External" is given in the other resource's spec.WorkstationClusterRef, the given value will be used. | ||
| // Otherwise, the "Name" and "Namespace" will be used to query the actual WorkstationCluster object from the cluster. | ||
| func (r *WorkstationClusterRef) NormalizedExternal(ctx context.Context, reader client.Reader, otherNamespace string) (string, error) { | ||
| if r.External != "" && r.Name != "" { | ||
| return "", fmt.Errorf("cannot specify both name and external on %s reference", WorkstationClusterGVK.Kind) | ||
| } | ||
| // From given External | ||
| if r.External != "" { | ||
| if _, _, err := parseWorkstationClusterExternal(r.External); err != nil { | ||
| return "", err | ||
| } | ||
| return r.External, nil | ||
| } | ||
|
|
||
| // From the Config Connector object | ||
| if r.Namespace == "" { | ||
| r.Namespace = otherNamespace | ||
| } | ||
| key := types.NamespacedName{Name: r.Name, Namespace: r.Namespace} | ||
| u := &unstructured.Unstructured{} | ||
| u.SetGroupVersionKind(WorkstationClusterGVK) | ||
| if err := reader.Get(ctx, key, u); err != nil { | ||
| if apierrors.IsNotFound(err) { | ||
| return "", k8s.NewReferenceNotFoundError(u.GroupVersionKind(), key) | ||
| } | ||
| return "", fmt.Errorf("reading referenced %s %s: %w", WorkstationClusterGVK, key, err) | ||
| } | ||
| // Get external from status.externalRef. This is the most trustworthy place. | ||
| actualExternalRef, _, err := unstructured.NestedString(u.Object, "status", "externalRef") | ||
| if err != nil { | ||
| return "", fmt.Errorf("reading status.externalRef: %w", err) | ||
| } | ||
| if actualExternalRef == "" { | ||
| return "", k8s.NewReferenceNotReadyError(u.GroupVersionKind(), key) | ||
| } | ||
| r.External = actualExternalRef | ||
| return r.External, nil | ||
| } | ||
|
|
||
| // New builds a WorkstationClusterRef from the Config Connector WorkstationCluster object. | ||
| func NewWorkstationClusterRef(ctx context.Context, reader client.Reader, obj *WorkstationCluster) (*WorkstationClusterRef, error) { | ||
| id := &WorkstationClusterRef{} | ||
|
|
||
| // Get Parent | ||
| projectRef, err := refsv1beta1.ResolveProject(ctx, reader, obj, &obj.Spec.ProjectRef) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| projectID := projectRef.ProjectID | ||
| if projectID == "" { | ||
| return nil, fmt.Errorf("cannot resolve project") | ||
| } | ||
| location := obj.Spec.Location | ||
| if location == "" { | ||
| return nil, fmt.Errorf("cannot resolve location") | ||
| } | ||
|
|
||
| // Get desired ID | ||
| resourceID := valueOf(obj.Spec.ResourceID) | ||
| if resourceID == "" { | ||
| resourceID = obj.GetName() | ||
| } | ||
| if resourceID == "" { | ||
| return nil, fmt.Errorf("cannot resolve resource ID") | ||
| } | ||
|
|
||
| // Use approved External | ||
| externalRef := valueOf(obj.Status.ExternalRef) | ||
| if externalRef == "" { | ||
| parent := &WorkstationClusterParent{ProjectID: projectID, Location: location} | ||
| id.External = asWorkstationClusterExternal(parent, resourceID) | ||
| return id, nil | ||
| } | ||
|
|
||
| // Validate desired with actual | ||
| actualParent, actualResourceID, err := parseWorkstationClusterExternal(externalRef) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if actualParent.ProjectID != projectID { | ||
| return nil, fmt.Errorf("spec.projectRef changed, expect %s, got %s", actualParent.ProjectID, projectID) | ||
| } | ||
| if actualParent.Location != location { | ||
| return nil, fmt.Errorf("spec.location changed, expect %s, got %s", actualParent.Location, location) | ||
| } | ||
| if actualResourceID != resourceID { | ||
| return nil, fmt.Errorf("cannot reset `metadata.name` or `spec.resourceID` to %s, since it has already assigned to %s", | ||
| resourceID, actualResourceID) | ||
| } | ||
| id.External = externalRef | ||
| return id, nil | ||
| } | ||
|
|
||
| func (r *WorkstationClusterRef) Parent() (*WorkstationClusterParent, error) { | ||
| if r.External != "" { | ||
| parent, _, err := parseWorkstationClusterExternal(r.External) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return parent, nil | ||
| } | ||
| return nil, fmt.Errorf("WorkstationClusterRef not initialized from `NewWorkstationClusterRef` or `NormalizedExternal`") | ||
| } | ||
|
|
||
| type WorkstationClusterParent struct { | ||
| ProjectID string | ||
| Location string | ||
| } | ||
|
|
||
| func (p *WorkstationClusterParent) String() string { | ||
| return "projects/" + p.ProjectID + "/locations/" + p.Location | ||
| } | ||
|
|
||
| func asWorkstationClusterExternal(parent *WorkstationClusterParent, resourceID string) (external string) { | ||
| return parent.String() + "/workstationConfigs/" + resourceID | ||
| } | ||
|
|
||
| func parseWorkstationClusterExternal(external string) (parent *WorkstationClusterParent, resourceID string, err error) { | ||
| external = strings.TrimPrefix(external, "/") | ||
| tokens := strings.Split(external, "/") | ||
| if len(tokens) != 6 || tokens[0] != "projects" || tokens[2] != "locations" || tokens[4] != "workstationClusters" { | ||
| return nil, "", fmt.Errorf("format of WorkstationCluster external=%q was not known (use projects/<projectID>/locations/<location>/workstationClusters/<workstationclusterID>)", external) | ||
| } | ||
| parent = &WorkstationClusterParent{ | ||
| ProjectID: tokens[1], | ||
| Location: tokens[3], | ||
| } | ||
| resourceID = tokens[5] | ||
| return parent, resourceID, nil | ||
| } | ||
|
|
||
| func valueOf[T any](t *T) T { | ||
| var zeroVal T | ||
| if t == nil { | ||
| return zeroVal | ||
| } | ||
| return *t | ||
| } |
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.