Process "validation error" response from Konnect update API when field of entity is invalid

[randmonkey]

Problem Statement

Currently when an error is returned from Konnect on updating an entity, controller will return error to trigger a requeue of the reconcile request. If the entity is invalid and "validation error" (HTTP status code is 400) is returned, controller will also try to retry to update it.

Proposed Solution

Parse the error returned from Konnect and stop endless requeueing if the error implies that the entity is invalid.
...

Additional Information

...

Acceptance Criteria

• Can stop requeueing of entities that is rejected by Konnect because its field is invalid

[pmalek]

Created https://github.com/Kong/platform-api/pull/768 to add missing error types.

[pmalek]

This will be solved in KHCP via https://konghq.atlassian.net/browse/KHCP-13816

[pmalek]

KHCP-13816 has been resolved but there is another issue here: the endless updates will persist since:

• we update the status conditions on the entity in here

  gateway-operator/controller/konnect/reconciler_generic.go

  Lines 561 to 562 in 52f9b09

  	setServerURLAndOrgID(ent, serverURL, apiAuth.Status.OrganizationID)
  	if errUpd := r.Client.Status().Update(ctx, ent); errUpd != nil {

• the irrecoverable API errors are ignored here

  gateway-operator/controller/konnect/ops/ops.go

  Lines 381 to 382 in 52f9b09

  	return ctrl.Result{}, IgnoreUnrecoverableAPIErr(err, loggerForEntity(ctx, e, UpdateOp))

• thus the generic reconciler will return no error and the status condition update will requeue endlessly

We have 2 solutions for this:

• either we handle the error when the status condition already has the same error message set (apart from kong trace id)

      {
        "lastTransitionTime": "2024-11-08T10:57:12Z",
        "message": "failed to update KonnectGatewayControlPlane on Konnect: {\"status\":400,\"title\":\"Invalid Request\",\"instance\":\"kong:trace:13218026017158295363\",\"detail\":\"Invalid Parameters\",\"invalid_parameters\":[{\"field\":\"labels\",\"rule\":\"is_label\",\"source\":\"body\",\"reason\":\"Label value exceeds maximum of 63 characters\"}]}",
        "observedGeneration": 5,
        "reason": "FailedToUpdate",
        "status": "False",
        "type": "Programmed"
      }
  

• we do not requeue on status update for objects, this might be desirable but might require a bit more refactoring to get right.