Hello everyone! A couple of months ago, I published two blog posts:
SAP BTP, Kyma runtime: APIRule migration—noAuth and jwt handlersSAP BTP, Kyma runtime: APIRule migration—ORY Oathkeeper based OAuth2 handlers
The blog posts explain migration details focusing on API. Now, I would like to focus on timelines and important milestones.
Timeline Overview
Let’s quickly recap the events surrounding the migration to the stable v2 version of APIRule. API Gateway 2.7.0, promoted to the regular channel on October 28, 2024, introduced a fully functional APIRule v2alpha1. At the same time, APIRule v1beta1 became deprecated and scheduled for deletion. These two events opened a testing window, allowing you to start testing the API and the migration procedure, report any bugs, and provide feedback. By the end of March 2025, we plan to extend the API Gateway module with stable APIRule v2, and APIRule v2alpha1 will become deprecated. This date also opens a migration window, letting you change your configurations to version v2. In mid-May 2025, APIRule v1beta1 will be deleted, and finally, in mid-June 2025, APIRule v2alpha1 will be deleted. Then, the API Gateway module will only serve stable APIRule v2.
Milestones
October 28, 2024 – Introduced APIRule v2alpha1 (current state of the art)
The API Gateway module introduced a fully functional APIRule v2alpha1 that, in the future, will replace version v1beta1. The v2alpha1 API and its functionalities are considered stable and are expected to be promoted to v2 with minimal to no changes. APIRule v2alpha1 was introduced to give you the possibility to get familiar with the new API, test it out, and share your feedback. The API Gateway module fully supports migration to version v2alpha1, ensuring zero downtime during the process. At this point, no immediate action is required. Do not underestimate this change, though, and start planning for the next milestone. We highly encourage you to test the migration process to estimate the required effort accurately and thoroughly understand the changes. Can you already migrate? Yes! We are not discouraging this approach as we fully support APIRule v2alpha1 and provide assistance in case of any issues. You must remember, though, that APIRule v2alpha1 is not the final version and will be removed in June 2025.
APIRule v2alpha1 is not the final version and will be removed in June 2025. Therefore, you must migrate all APIRules to version v2 by that date.
March 31, 2025 – APIRule v2 stable version
That will be the day! APIRule v2 will come to life. On March 31, 2025, APIRule v2 will become the official stable version and the main serving version. This means that when you run the command ‘kubectl get apirules -A -o yaml`, APIRule v2 will be displayed by default. To request version v1beta1 or v2alpha2, you must explicitly specify these versions in the commands. For example, you can use `kubectl get apirules.v2alpha2.gateway.kyma-project.io my-rule -o yaml` or `kubectl get apirules.v1beta1.gateway.kyma-project.io my-rule -o yaml`. This is especially important if you rely on CI/CD tools or use the command-line interface to list deployed resources.
APIRule v2alpha1 and v2 are not fully compatible with v1beta1, so it might happen that v1beta1 rules, such as OAuth2 handlers, won’t be fully displayed as v2alpha1 or v2.
You might be wondering: What will happen to my old APIRules? The answer is nothing will change immediately. They will still be there and continue functioning until May 12, 2025. To view them, you must explicitly request the v1beta1 version.
The introduction of v2 will start the migration window. During this period, migrating all APIRules from v1beta1 and v2alpha1 to the newest version, v2, is mandatory. If you are migrating from v1beta1, please refer to my previous blog posts for guidance. If you are migrating from v2alpha1, it should be as simple as changing the version.
May 12, 2025 – APIRule v1beta1 end of life
At this point, you must have all your APIRules migrated and saved in version v2. APIGateway Controller will stop serving APIRule v1beta1, the version will be removed from CustomResourceDefinition (CRD), and the API Gateway module will delete all unmigrated custom resources (CRs). However, your workloads exposed with APIRule v1beta1 will not be taken down. We will ensure everything keeps running.
Resources created by APIGateway Controller will not be deleted but will become unmanaged. This means you will be responsible for configuring and maintaining them according to your needs. Additionally, Ory Oathkeeper will no longer be managed by the API Gateway module, and if you have APIRules based on it, you will need to take over its management. The migration procedure from unmanaged resources to APIRule v2 will not be supported in an automated way. Therefore, it is very important that you complete the migration to v2 before May 12, 2025, from both versions v1beta1 and v2alpha1.
June 16, 2025 – APIRule v2alpha1 end of life
Finally, v2alpha1 will be removed from the CRD, and all existing CRs will be stored as the v2 version. From now on, the only version of APIRule will be v2.
Summary
In this blog post, I outlined important events and their corresponding necessary actions. I hope this helps you understand what to expect and plan accordingly. If you have any concerns or feedback, leave us a question.
Hello everyone! A couple of months ago, I published two blog posts:SAP BTP, Kyma runtime: APIRule migration—noAuth and jwt handlersSAP BTP, Kyma runtime: APIRule migration—ORY Oathkeeper based OAuth2 handlersThe blog posts explain migration details focusing on API. Now, I would like to focus on timelines and important milestones. Timeline OverviewLet’s quickly recap the events surrounding the migration to the stable v2 version of APIRule. API Gateway 2.7.0, promoted to the regular channel on October 28, 2024, introduced a fully functional APIRule v2alpha1. At the same time, APIRule v1beta1 became deprecated and scheduled for deletion. These two events opened a testing window, allowing you to start testing the API and the migration procedure, report any bugs, and provide feedback. By the end of March 2025, we plan to extend the API Gateway module with stable APIRule v2, and APIRule v2alpha1 will become deprecated. This date also opens a migration window, letting you change your configurations to version v2. In mid-May 2025, APIRule v1beta1 will be deleted, and finally, in mid-June 2025, APIRule v2alpha1 will be deleted. Then, the API Gateway module will only serve stable APIRule v2. MilestonesOctober 28, 2024 – Introduced APIRule v2alpha1 (current state of the art)The API Gateway module introduced a fully functional APIRule v2alpha1 that, in the future, will replace version v1beta1. The v2alpha1 API and its functionalities are considered stable and are expected to be promoted to v2 with minimal to no changes. APIRule v2alpha1 was introduced to give you the possibility to get familiar with the new API, test it out, and share your feedback. The API Gateway module fully supports migration to version v2alpha1, ensuring zero downtime during the process. At this point, no immediate action is required. Do not underestimate this change, though, and start planning for the next milestone. We highly encourage you to test the migration process to estimate the required effort accurately and thoroughly understand the changes. Can you already migrate? Yes! We are not discouraging this approach as we fully support APIRule v2alpha1 and provide assistance in case of any issues. You must remember, though, that APIRule v2alpha1 is not the final version and will be removed in June 2025.APIRule v2alpha1 is not the final version and will be removed in June 2025. Therefore, you must migrate all APIRules to version v2 by that date.March 31, 2025 – APIRule v2 stable versionThat will be the day! APIRule v2 will come to life. On March 31, 2025, APIRule v2 will become the official stable version and the main serving version. This means that when you run the command ‘kubectl get apirules -A -o yaml`, APIRule v2 will be displayed by default. To request version v1beta1 or v2alpha2, you must explicitly specify these versions in the commands. For example, you can use `kubectl get apirules.v2alpha2.gateway.kyma-project.io my-rule -o yaml` or `kubectl get apirules.v1beta1.gateway.kyma-project.io my-rule -o yaml`. This is especially important if you rely on CI/CD tools or use the command-line interface to list deployed resources.APIRule v2alpha1 and v2 are not fully compatible with v1beta1, so it might happen that v1beta1 rules, such as OAuth2 handlers, won’t be fully displayed as v2alpha1 or v2.You might be wondering: What will happen to my old APIRules? The answer is nothing will change immediately. They will still be there and continue functioning until May 12, 2025. To view them, you must explicitly request the v1beta1 version.The introduction of v2 will start the migration window. During this period, migrating all APIRules from v1beta1 and v2alpha1 to the newest version, v2, is mandatory. If you are migrating from v1beta1, please refer to my previous blog posts for guidance. If you are migrating from v2alpha1, it should be as simple as changing the version. May 12, 2025 – APIRule v1beta1 end of lifeAt this point, you must have all your APIRules migrated and saved in version v2. APIGateway Controller will stop serving APIRule v1beta1, the version will be removed from CustomResourceDefinition (CRD), and the API Gateway module will delete all unmigrated custom resources (CRs). However, your workloads exposed with APIRule v1beta1 will not be taken down. We will ensure everything keeps running.Resources created by APIGateway Controller will not be deleted but will become unmanaged. This means you will be responsible for configuring and maintaining them according to your needs. Additionally, Ory Oathkeeper will no longer be managed by the API Gateway module, and if you have APIRules based on it, you will need to take over its management. The migration procedure from unmanaged resources to APIRule v2 will not be supported in an automated way. Therefore, it is very important that you complete the migration to v2 before May 12, 2025, from both versions v1beta1 and v2alpha1.June 16, 2025 – APIRule v2alpha1 end of lifeFinally, v2alpha1 will be removed from the CRD, and all existing CRs will be stored as the v2 version. From now on, the only version of APIRule will be v2.SummaryIn this blog post, I outlined important events and their corresponding necessary actions. I hope this helps you understand what to expect and plan accordingly. If you have any concerns or feedback, leave us a question. Read More Technology Blogs by SAP articles
#SAP
#SAPTechnologyblog
