fix: handle KongUpstream conflict on creation (#756)

Kong · Oct 18, 2024 · 9e8f425 · 9e8f425
1 parent b9abeb9
commit 9e8f425
Show file tree

Hide file tree

Showing 28 changed files with 329 additions and 160 deletions.
diff --git a/controller/konnect/ops/kongupstream.go b/controller/konnect/ops/kongupstream.go
@@ -12,4 +12,5 @@ type UpstreamsSDK interface {
 	CreateUpstream(ctx context.Context, controlPlaneID string, upstream sdkkonnectcomp.UpstreamInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateUpstreamResponse, error)
 	UpsertUpstream(ctx context.Context, req sdkkonnectops.UpsertUpstreamRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertUpstreamResponse, error)
 	DeleteUpstream(ctx context.Context, controlPlaneID, upstreamID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteUpstreamResponse, error)
+	ListUpstream(ctx context.Context, request sdkkonnectops.ListUpstreamRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListUpstreamResponse, error)
 }
diff --git a/controller/konnect/ops/kongupstream_mock.go b/controller/konnect/ops/kongupstream_mock.go
diff --git a/controller/konnect/ops/ops.go b/controller/konnect/ops/ops.go
@@ -115,15 +115,17 @@ func Create[
 		case *configurationv1alpha1.KongRoute:
 			id, err = getKongRouteForUID(ctx, sdk.GetRoutesSDK(), ent)
 		case *configurationv1alpha1.KongSNI:
-			id, err = getSNIForUID(ctx, sdk.GetSNIsSDK(), ent)
+			id, err = getKongSNIForUID(ctx, sdk.GetSNIsSDK(), ent)
 		case *configurationv1.KongConsumer:
-			id, err = getConsumerForUID(ctx, sdk.GetConsumersSDK(), ent)
+			id, err = getKongConsumerForUID(ctx, sdk.GetConsumersSDK(), ent)
 		case *configurationv1beta1.KongConsumerGroup:
-			id, err = getConsumerGroupForUID(ctx, sdk.GetConsumerGroupsSDK(), ent)
+			id, err = getKongConsumerGroupForUID(ctx, sdk.GetConsumerGroupsSDK(), ent)
 		case *configurationv1alpha1.KongKeySet:
 			id, err = getKongKeySetForUID(ctx, sdk.GetKeySetsSDK(), ent)
 		case *configurationv1alpha1.KongKey:
 			id, err = getKongKeyForUID(ctx, sdk.GetKeysSDK(), ent)
+		case *configurationv1alpha1.KongUpstream:
+			id, err = getKongUpstreamForUID(ctx, sdk.GetUpstreamsSDK(), ent)
 			// ---------------------------------------------------------------------
 			// TODO: add other Konnect types
 		default:

diff --git a/controller/konnect/ops/ops_controlplane.go b/controller/konnect/ops/ops_controlplane.go
@@ -35,9 +35,6 @@ func createControlPlane(
 
 	resp, err := sdk.CreateControlPlane(ctx, req)
 
-	// Can't adopt it as it will cause conflicts between the controller
-	// that created that entity and already manages it.
-	// TODO: implement entity adoption https://github.com/Kong/gateway-operator/issues/460
 	if errWrap := wrapErrIfKonnectOpFailed(err, CreateOp, cp); errWrap != nil {
 		return errWrap
 	}

diff --git a/controller/konnect/ops/ops_credentialacl.go b/controller/konnect/ops/ops_credentialacl.go
@@ -3,13 +3,11 @@ package ops
 import (
 	"context"
 	"errors"
-	"fmt"
 
 	sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
 	sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
 	sdkkonnecterrs "github.com/Kong/sdk-konnect-go/models/sdkerrors"
 	"github.com/samber/lo"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 
 	configurationv1alpha1 "github.com/kong/kubernetes-configuration/api/configuration/v1alpha1"
@@ -22,7 +20,7 @@ func createKongCredentialACL(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't create %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: CreateOp}
 	}
 
 	resp, err := sdk.CreateACLWithConsumer(ctx,
@@ -58,7 +56,7 @@ func updateKongCredentialACL(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't update %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: UpdateOp}
 	}
 
 	_, err := sdk.UpsertACLWithConsumer(ctx,

diff --git a/controller/konnect/ops/ops_credentialapikey.go b/controller/konnect/ops/ops_credentialapikey.go
@@ -3,13 +3,11 @@ package ops
 import (
 	"context"
 	"errors"
-	"fmt"
 
 	sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
 	sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
 	sdkkonnecterrs "github.com/Kong/sdk-konnect-go/models/sdkerrors"
 	"github.com/samber/lo"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 
 	configurationv1alpha1 "github.com/kong/kubernetes-configuration/api/configuration/v1alpha1"
@@ -22,7 +20,7 @@ func createKongCredentialAPIKey(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't create %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: CreateOp}
 	}
 
 	resp, err := sdk.CreateKeyAuthWithConsumer(ctx,
@@ -58,7 +56,7 @@ func updateKongCredentialAPIKey(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't update %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: UpdateOp}
 	}
 
 	_, err := sdk.UpsertKeyAuthWithConsumer(ctx,

diff --git a/controller/konnect/ops/ops_credentialbasicauth.go b/controller/konnect/ops/ops_credentialbasicauth.go
@@ -3,13 +3,11 @@ package ops
 import (
 	"context"
 	"errors"
-	"fmt"
 
 	sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
 	sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
 	sdkkonnecterrs "github.com/Kong/sdk-konnect-go/models/sdkerrors"
 	"github.com/samber/lo"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 
 	configurationv1alpha1 "github.com/kong/kubernetes-configuration/api/configuration/v1alpha1"
@@ -22,7 +20,7 @@ func createKongCredentialBasicAuth(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't create %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: CreateOp}
 	}
 
 	resp, err := sdk.CreateBasicAuthWithConsumer(ctx,
@@ -58,7 +56,7 @@ func updateKongCredentialBasicAuth(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't update %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: UpdateOp}
 	}
 
 	_, err := sdk.UpsertBasicAuthWithConsumer(ctx, sdkkonnectops.UpsertBasicAuthWithConsumerRequest{

diff --git a/controller/konnect/ops/ops_credentialhmac.go b/controller/konnect/ops/ops_credentialhmac.go
@@ -3,12 +3,10 @@ package ops
 import (
 	"context"
 	"errors"
-	"fmt"
 
 	sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
 	sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
 	sdkkonnecterrs "github.com/Kong/sdk-konnect-go/models/sdkerrors"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 
 	configurationv1alpha1 "github.com/kong/kubernetes-configuration/api/configuration/v1alpha1"
@@ -21,7 +19,7 @@ func createKongCredentialHMAC(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't create %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: CreateOp}
 	}
 
 	resp, err := sdk.CreateHmacAuthWithConsumer(ctx,
@@ -57,7 +55,7 @@ func updateKongCredentialHMAC(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't update %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: UpdateOp}
 	}
 
 	_, err := sdk.UpsertHmacAuthWithConsumer(ctx,

diff --git a/controller/konnect/ops/ops_credentialjwt.go b/controller/konnect/ops/ops_credentialjwt.go
@@ -3,12 +3,10 @@ package ops
 import (
 	"context"
 	"errors"
-	"fmt"
 
 	sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
 	sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
 	sdkkonnecterrs "github.com/Kong/sdk-konnect-go/models/sdkerrors"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 
 	configurationv1alpha1 "github.com/kong/kubernetes-configuration/api/configuration/v1alpha1"
@@ -21,7 +19,7 @@ func createKongCredentialJWT(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't create %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: CreateOp}
 	}
 
 	resp, err := sdk.CreateJwtWithConsumer(ctx,
@@ -57,7 +55,7 @@ func updateKongCredentialJWT(
 ) error {
 	cpID := cred.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't update %T %s without a Konnect ControlPlane ID", cred, client.ObjectKeyFromObject(cred))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cred, Op: UpdateOp}
 	}
 
 	_, err := sdk.UpsertJwtWithConsumer(ctx,

diff --git a/controller/konnect/ops/ops_errors.go b/controller/konnect/ops/ops_errors.go
@@ -31,6 +31,21 @@ func (e EntityWithMatchingUIDNotFoundError) Error() string {
 	)
 }
 
+// CantPerformOperationWithoutControlPlaneIDError is an error indicating that an
+// operation cannot be performed without a ControlPlane ID.
+type CantPerformOperationWithoutControlPlaneIDError struct {
+	Entity entity
+	Op     Op
+}
+
+// Error implements the error interface.
+func (e CantPerformOperationWithoutControlPlaneIDError) Error() string {
+	return fmt.Sprintf(
+		"can't %s %s %s without a Konnect ControlPlane ID",
+		e.Op, e.Entity.GetTypeName(), client.ObjectKeyFromObject(e.Entity),
+	)
+}
+
 type sdkErrorBody struct {
 	Code    int    `json:"code"`
 	Message string `json:"message"`

diff --git a/controller/konnect/ops/ops_kongcacertificate.go b/controller/konnect/ops/ops_kongcacertificate.go
@@ -3,12 +3,10 @@ package ops
 import (
 	"context"
 	"errors"
-	"fmt"
 
 	sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
 	sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
 	sdkkonnecterrs "github.com/Kong/sdk-konnect-go/models/sdkerrors"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 
 	configurationv1alpha1 "github.com/kong/kubernetes-configuration/api/configuration/v1alpha1"
@@ -23,7 +21,7 @@ func createCACertificate(
 ) error {
 	cpID := cert.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't create %T %s without a Konnect ControlPlane ID", cert, client.ObjectKeyFromObject(cert))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cert, Op: CreateOp}
 	}
 
 	resp, err := sdk.CreateCaCertificate(ctx,
@@ -55,7 +53,7 @@ func updateCACertificate(
 ) error {
 	cpID := cert.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't update %T without a ControlPlaneID", cert)
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cert, Op: UpdateOp}
 	}
 
 	_, err := sdk.UpsertCaCertificate(ctx,

diff --git a/controller/konnect/ops/ops_kongcertificate.go b/controller/konnect/ops/ops_kongcertificate.go
@@ -3,12 +3,10 @@ package ops
 import (
 	"context"
 	"errors"
-	"fmt"
 
 	sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
 	sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
 	sdkkonnecterrs "github.com/Kong/sdk-konnect-go/models/sdkerrors"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 
 	configurationv1alpha1 "github.com/kong/kubernetes-configuration/api/configuration/v1alpha1"
@@ -23,7 +21,7 @@ func createCertificate(
 ) error {
 	cpID := cert.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't create %T %s without a Konnect ControlPlane ID", cert, client.ObjectKeyFromObject(cert))
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cert, Op: CreateOp}
 	}
 
 	resp, err := sdk.CreateCertificate(ctx,
@@ -55,7 +53,7 @@ func updateCertificate(
 ) error {
 	cpID := cert.GetControlPlaneID()
 	if cpID == "" {
-		return fmt.Errorf("can't update %T without a ControlPlaneID", cert)
+		return CantPerformOperationWithoutControlPlaneIDError{Entity: cert, Op: UpdateOp}
 	}
 
 	_, err := sdk.UpsertCertificate(ctx,