|
| 1 | +// Copyright 2024 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +// +tool:controller |
| 16 | +// proto.service: google.cloud.apigateway.v1.ApiGatewayService |
| 17 | +// proto.message: google.cloud.apigateway.v1.Api |
| 18 | +// crd.type: APIGatewayAPI |
| 19 | +// crd.version: v1alpha1 |
| 20 | + |
| 21 | +package apigateway |
| 22 | + |
| 23 | +import ( |
| 24 | + "context" |
| 25 | + "fmt" |
| 26 | + "reflect" |
| 27 | + |
| 28 | + gcp "cloud.google.com/go/apigateway/apiv1" |
| 29 | + pb "cloud.google.com/go/apigateway/apiv1/apigatewaypb" |
| 30 | + "google.golang.org/protobuf/types/known/fieldmaskpb" |
| 31 | + "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" |
| 32 | + "k8s.io/apimachinery/pkg/runtime" |
| 33 | + "k8s.io/klog/v2" |
| 34 | + "sigs.k8s.io/controller-runtime/pkg/client" |
| 35 | + |
| 36 | + krm "github.com/GoogleCloudPlatform/k8s-config-connector/apis/apigateway/v1alpha1" |
| 37 | + refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1" |
| 38 | + "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/config" |
| 39 | + "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct" |
| 40 | + "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/directbase" |
| 41 | + "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/registry" |
| 42 | +) |
| 43 | + |
| 44 | +func init() { |
| 45 | + registry.RegisterModel(krm.APIGatewayAPIGVK, NewApiModel) |
| 46 | +} |
| 47 | + |
| 48 | +func NewApiModel(ctx context.Context, config *config.ControllerConfig) (directbase.Model, error) { |
| 49 | + return &apiModel{config: *config}, nil |
| 50 | +} |
| 51 | + |
| 52 | +var _ directbase.Model = &apiModel{} |
| 53 | + |
| 54 | +type apiModel struct { |
| 55 | + config config.ControllerConfig |
| 56 | +} |
| 57 | + |
| 58 | +func (m *apiModel) AdapterForObject(ctx context.Context, reader client.Reader, u *unstructured.Unstructured) (directbase.Adapter, error) { |
| 59 | + obj := &krm.APIGatewayAPI{} |
| 60 | + if err := runtime.DefaultUnstructuredConverter.FromUnstructured(u.Object, &obj); err != nil { |
| 61 | + return nil, fmt.Errorf("error converting to %T: %w", obj, err) |
| 62 | + } |
| 63 | + |
| 64 | + id, err := krm.NewApiIdentity(ctx, reader, obj) |
| 65 | + if err != nil { |
| 66 | + return nil, err |
| 67 | + } |
| 68 | + // Get apigateway GCP client |
| 69 | + gcpClient, err := newGCPClient(ctx, &m.config) |
| 70 | + if err != nil { |
| 71 | + return nil, err |
| 72 | + } |
| 73 | + apiGatewayClient, err := gcpClient.newApiGatewayClient(ctx) |
| 74 | + if err != nil { |
| 75 | + return nil, err |
| 76 | + } |
| 77 | + return &apiAdapter{ |
| 78 | + gcpClient: apiGatewayClient, |
| 79 | + id: id, |
| 80 | + desired: obj, |
| 81 | + }, nil |
| 82 | +} |
| 83 | + |
| 84 | +func (m *apiModel) AdapterForURL(ctx context.Context, url string) (directbase.Adapter, error) { |
| 85 | + // TODO: Support URLs |
| 86 | + return nil, nil |
| 87 | +} |
| 88 | + |
| 89 | +type apiAdapter struct { |
| 90 | + gcpClient *gcp.Client |
| 91 | + id *krm.ApiIdentity |
| 92 | + desired *krm.APIGatewayAPI |
| 93 | + actual *pb.Api |
| 94 | +} |
| 95 | + |
| 96 | +var _ directbase.Adapter = &apiAdapter{} |
| 97 | + |
| 98 | +// Find retrieves the GCP resource. |
| 99 | +// Return true means the object is found. This triggers Adapter `Update` call. |
| 100 | +// Return false means the object is not found. This triggers Adapter `Create` call. |
| 101 | +// Return a non-nil error requeues the requests. |
| 102 | +func (a *apiAdapter) Find(ctx context.Context) (bool, error) { |
| 103 | + log := klog.FromContext(ctx) |
| 104 | + log.V(2).Info("getting apigateway api", "name", a.id) |
| 105 | + |
| 106 | + req := &pb.GetApiRequest{Name: a.id.String()} |
| 107 | + actual, err := a.gcpClient.GetApi(ctx, req) |
| 108 | + if err != nil { |
| 109 | + if direct.IsNotFound(err) { |
| 110 | + return false, nil |
| 111 | + } |
| 112 | + return false, fmt.Errorf("getting apigateway api %q from gcp: %w", a.id.String(), err) |
| 113 | + } |
| 114 | + |
| 115 | + a.actual = actual |
| 116 | + return true, nil |
| 117 | +} |
| 118 | + |
| 119 | +// Create creates the resource in GCP based on `spec` and update the Config Connector object `status` based on the GCP response. |
| 120 | +func (a *apiAdapter) Create(ctx context.Context, createOp *directbase.CreateOperation) error { |
| 121 | + log := klog.FromContext(ctx) |
| 122 | + log.V(2).Info("creating apigateway api", "name", a.id) |
| 123 | + mapCtx := &direct.MapContext{} |
| 124 | + |
| 125 | + desired := a.desired.DeepCopy() |
| 126 | + resource := APIGatewayAPISpec_ToProto(mapCtx, &desired.Spec) |
| 127 | + if mapCtx.Err() != nil { |
| 128 | + return mapCtx.Err() |
| 129 | + } |
| 130 | + |
| 131 | + req := &pb.CreateApiRequest{ |
| 132 | + Parent: a.id.Parent().String(), |
| 133 | + ApiId: a.id.ID(), |
| 134 | + Api: resource, |
| 135 | + } |
| 136 | + op, err := a.gcpClient.CreateApi(ctx, req) |
| 137 | + if err != nil { |
| 138 | + return fmt.Errorf("creating apigateway api %s: %w", a.id.String(), err) |
| 139 | + } |
| 140 | + created, err := op.Wait(ctx) |
| 141 | + if err != nil { |
| 142 | + return fmt.Errorf("apigateway api %s waiting creation: %w", a.id, err) |
| 143 | + } |
| 144 | + log.V(2).Info("successfully created apigateway api in gcp", "name", a.id) |
| 145 | + |
| 146 | + status := &krm.APIGatewayAPIStatus{} |
| 147 | + status.ObservedState = APIGatewayAPIObservedState_FromProto(mapCtx, created) |
| 148 | + if mapCtx.Err() != nil { |
| 149 | + return mapCtx.Err() |
| 150 | + } |
| 151 | + status.ExternalRef = direct.LazyPtr(a.id.String()) |
| 152 | + return createOp.UpdateStatus(ctx, status, nil) |
| 153 | +} |
| 154 | + |
| 155 | +// Update updates the resource in GCP based on `spec` and update the Config Connector object `status` based on the GCP response. |
| 156 | +func (a *apiAdapter) Update(ctx context.Context, updateOp *directbase.UpdateOperation) error { |
| 157 | + log := klog.FromContext(ctx) |
| 158 | + log.V(2).Info("updating apigateway api", "name", a.id) |
| 159 | + mapCtx := &direct.MapContext{} |
| 160 | + |
| 161 | + desired := a.desired.DeepCopy() |
| 162 | + resource := APIGatewayAPISpec_ToProto(mapCtx, &desired.Spec) |
| 163 | + if mapCtx.Err() != nil { |
| 164 | + return mapCtx.Err() |
| 165 | + } |
| 166 | + |
| 167 | + paths := []string{} |
| 168 | + if desired.Spec.DisplayName != nil && !reflect.DeepEqual(resource.DisplayName, a.actual.DisplayName) { |
| 169 | + paths = append(paths, "display_name") |
| 170 | + } |
| 171 | + if desired.Spec.Labels != nil && !reflect.DeepEqual(resource.Labels, a.actual.Labels) { |
| 172 | + paths = append(paths, "labels") |
| 173 | + } |
| 174 | + |
| 175 | + var updated *pb.Api |
| 176 | + if len(paths) == 0 { |
| 177 | + log.V(2).Info("no field needs update", "name", a.id) |
| 178 | + updated = a.actual |
| 179 | + } else { |
| 180 | + resource.Name = a.id.String() // we need to set the name so that GCP API can identify the resource |
| 181 | + req := &pb.UpdateApiRequest{ |
| 182 | + Api: resource, |
| 183 | + UpdateMask: &fieldmaskpb.FieldMask{Paths: paths}, |
| 184 | + } |
| 185 | + op, err := a.gcpClient.UpdateApi(ctx, req) |
| 186 | + if err != nil { |
| 187 | + return fmt.Errorf("updating apigateway api %s: %w", a.id.String(), err) |
| 188 | + } |
| 189 | + updated, err = op.Wait(ctx) |
| 190 | + if err != nil { |
| 191 | + return fmt.Errorf("apigateway api %s waiting for update: %w", a.id, err) |
| 192 | + } |
| 193 | + log.V(2).Info("successfully updated apigateway api", "name", a.id) |
| 194 | + } |
| 195 | + |
| 196 | + status := &krm.APIGatewayAPIStatus{} |
| 197 | + status.ObservedState = APIGatewayAPIObservedState_FromProto(mapCtx, updated) |
| 198 | + if mapCtx.Err() != nil { |
| 199 | + return mapCtx.Err() |
| 200 | + } |
| 201 | + return updateOp.UpdateStatus(ctx, status, nil) |
| 202 | +} |
| 203 | + |
| 204 | +// Export maps the GCP object to a Config Connector resource `spec`. |
| 205 | +func (a *apiAdapter) Export(ctx context.Context) (*unstructured.Unstructured, error) { |
| 206 | + if a.actual == nil { |
| 207 | + return nil, fmt.Errorf("Find() not called") |
| 208 | + } |
| 209 | + u := &unstructured.Unstructured{} |
| 210 | + |
| 211 | + obj := &krm.APIGatewayAPI{} |
| 212 | + mapCtx := &direct.MapContext{} |
| 213 | + obj.Spec = direct.ValueOf(APIGatewayAPISpec_FromProto(mapCtx, a.actual)) |
| 214 | + if mapCtx.Err() != nil { |
| 215 | + return nil, mapCtx.Err() |
| 216 | + } |
| 217 | + obj.Spec.ProjectRef = &refs.ProjectRef{External: a.id.Parent().ProjectID} |
| 218 | + uObj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(obj) |
| 219 | + if err != nil { |
| 220 | + return nil, err |
| 221 | + } |
| 222 | + |
| 223 | + u.SetName(a.actual.Name) |
| 224 | + u.SetGroupVersionKind(krm.APIGatewayAPIGVK) |
| 225 | + u.Object = uObj |
| 226 | + return u, nil |
| 227 | +} |
| 228 | + |
| 229 | +// Delete the resource from GCP service when the corresponding Config Connector resource is deleted. |
| 230 | +func (a *apiAdapter) Delete(ctx context.Context, deleteOp *directbase.DeleteOperation) (bool, error) { |
| 231 | + log := klog.FromContext(ctx) |
| 232 | + log.V(2).Info("deleting apigateway api", "name", a.id) |
| 233 | + |
| 234 | + req := &pb.DeleteApiRequest{Name: a.id.String()} |
| 235 | + op, err := a.gcpClient.DeleteApi(ctx, req) |
| 236 | + if err != nil { |
| 237 | + if direct.IsNotFound(err) { |
| 238 | + // Return success if not found (assume it was already deleted). |
| 239 | + log.V(2).Info("skipping delete for non-existent apigateway api, assuming it was already deleted", "name", a.id) |
| 240 | + return true, nil |
| 241 | + } |
| 242 | + return false, fmt.Errorf("deleting apigateway api %s: %w", a.id.String(), err) |
| 243 | + } |
| 244 | + log.V(2).Info("successfully deleted apigateway api", "name", a.id) |
| 245 | + |
| 246 | + err = op.Wait(ctx) |
| 247 | + if err != nil { |
| 248 | + return false, fmt.Errorf("waiting delete apigateway api %s: %w", a.id, err) |
| 249 | + } |
| 250 | + return true, nil |
| 251 | +} |
![google-oss-prow[bot]](https://avatars.githubusercontent.com/in/143327?v=4&size=40){kind=avatar}
0 commit comments