Kyma

Appearance

Migrate APIRule from Version v1beta1 to Version v2 ​

APIRule custom resource (CR) v1beta1 has been deprecated and scheduled for deletion. You must migrate all your APIRule CRs to version v2. Learn more about the timeline and see how to perform the migration.

WARNING

APIRule CRD v2 is the latest stable version. Version v1beta1 is removed in release 3.4 of the API Gateway module.

  • All existing v1beta1 APIRule configurations continue to function as expected.
  • APIRules v1beta1 are no longer visible in the Kyma dashboard. You can still display them using kubectl, but the resources are displayed in the converted v2 format.
  • You can no longer create new v1beta1 APIRules. You also can't delete or edit the existing APIRules v1beta1. To make any changes, you must migrate to version v2.

Required action: Migrate all your APIRule custom resources (CRs) to version v2. For the complete deletion timeline for SAP BTP, Kyma runtime, see APIRule Migration Timeline.

How to Migrate APIRules to Version v2 ​

To migrate to version v2, follow the steps:

  1. To identify which APIRules must be migrated, run the following command:

    bash
    kubectl get apirules.gateway.kyma-project.io -A -o json | jq '.items[] | select(.metadata.annotations["gateway.kyma-project.io/original-version"] == "v1beta1") | {namespace: .metadata.namespace, name: .metadata.name}'

  2. If two or more of your APIRules target the same workload, apply an additional AuthorizationPolicy to avoid traffic disruption during migration. See Migrate Multiple APIRules Targeting the Same Workload from v1beta1 to v2.

  3. To retrieve the complete spec with the rules field of an APIRule in version v1beta1, see Retrieving the Complete spec of an APIRule in Version v1beta1.

  4. To migrate an APIRule from version v1beta1 to version v2, follow the relevant guide:

For more information about APIRule v2, see also APIRule v2 Custom Resource and Changes Introduced in APIRule v2.

APIRule v1beta1 Migration Timeline ​

APIRule CRDs in versions v1beta1 and v2alpha1 have been deprecated and will be removed in upcoming releases. Due to the upcoming deletion, managing APIRules v1beta1 using Kyma dashboard is no longer possible. Additionally, you can't create APIRules v1beta1 in new clusters.

For the complete deletion timeline for SAP BTP, Kyma runtime, see APIRule Migration Timeline.