Add APIRule v2 documentation #1694
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kyma-bot
added
cla: yes
strekm
reviewed
Feb 15, 2025
docs/user/custom-resources/apirule/04-10-apirule-custom-resource.md
Outdated
Show resolved
Hide resolved
| @@ -3,7 +3,15 @@ | |||
| The `apirules.gateway.kyma-project.io` CRD describes the kind and the format of data the APIRule Controller uses to configure resources. The APIRule CR is available in two versions: `v2alpha1` and `v1beta1`. | |||
|
|
|||
| > [!WARNING] | |||
| > APIRule in version `v1beta1` will become deprecated on October 28, 2024. To prepare for the introduction of the stable APIRule in version `v2`, you can start testing the API and the migration procedure using version `v2alpha1`. APIRule `v2alpha1` was introduced for testing purposes only and is not meant for use in a production environment. For more information, see the [APIRule migration blog post](https://community.sap.com/t5/technology-blogs-by-sap/sap-btp-kyma-runtime-apirule-migration-noauth-and-jwt-handlers/ba-p/13882833). | |||
| > APIRule in version `v1beta1` has been deprecated. Version `v2alpha1` was introduced for testing purposes. It will become deprecated on March 31, 2025 and removed on June 16, 2025. The stable APIRule `v2` will be introduced on March 31, 2025. | |||
There was a problem hiding this comment.
Maybe you can rephrase to read it is planned / it is scheduled
| # APIRule v1beta1 Custom Resource <!-- {docsify-ignore-all} --> | ||
|
|
||
| > [!WARNING] | ||
| > APIRule in version `v1beta1` has been deprecated. Version `v2alpha1` was introduced for testing purposes. It will become deprecated on March 31, 2025 and removed on June 16, 2025. The stable APIRule `v2` will be introduced on March 31, 2025. |
There was a problem hiding this comment.
same as above comment. Please rephrase it to it is planned / scheduled
| @@ -1,7 +1,11 @@ | |||
| # APIRule v2alpha1 Custom Resource <!-- {docsify-ignore-all} --> | |||
|
|
|||
| > [!WARNING] | |||
| > APIRule in version `v1beta1` will become deprecated on October 28, 2024. To prepare for the introduction of the stable APIRule in version `v2`, you can start testing the API and the migration procedure using version `v2alpha1`. APIRule `v2alpha1` was introduced for testing purposes only and is not meant for use in a production environment. For more information, see the [APIRule migration blog post](https://community.sap.com/t5/technology-blogs-by-sap/sap-btp-kyma-runtime-apirule-migration-noauth-and-jwt-handlers/ba-p/13882833). | |||
| > APIRule in version `v1beta1` has been deprecated. Version `v2alpha1` was introduced for testing purposes. It will become deprecated on March 31, 2025 and removed on June 16, 2025. The stable APIRule `v2` will be introduced on March 31, 2025. | |||
There was a problem hiding this comment.
Please rephrase it to it is scheduled / it is planned
| > APIRule in version `v1beta1` has been deprecated. Version `v2alpha1` was introduced for testing purposes. It will become deprecated on March 31, 2025 and removed on June 16, 2025. The stable APIRule `v2` will be introduced on March 31, 2025. |
There was a problem hiding this comment.
please rephrase it to it is planned / scheduled
| This tutorial demonstrates how to expose an unsecured instance of the HTTPBin Service using a short host name instead of the full domain name. Using a short host makes it simpler to apply APIRules because the domain name is automatically retrieved from the referenced Gateway, and you don’t have to manually set it in each APIRule. This might be particularly useful when reconfiguring resources in a new cluster, as it reduces the chance of errors and streamlines the process. | ||
|
|
||
| > [!WARNING] | ||
| > Exposing a workload to the outside world is a potential security vulnerability, so tread carefully. In a production environment, always secure the workload you expose with [JWT](../../01-50-expose-and-secure-a-workload/v2alpha1/01-52-expose-and-secure-workload-jwt.md). |
There was a problem hiding this comment.
it is, fixed now
| @@ -2,14 +2,23 @@ | |||
| Browse the API Gateway tutorials to learn how to expose workloads. The tutorials are available in two versions: one uses the APIRule resource in version `v2alpha1` and the other uses the APIRule resource in version `v1beta1`. | |||
|
|
|||
| > [!WARNING] | |||
| > APIRule in version `v1beta1` will become deprecated on October 28, 2024. To prepare for the introduction of the stable APIRule in version `v2`, you can start testing the API and the migration procedure using version `v2alpha1`. APIRule `v2alpha1` was introduced for testing purposes only and is not meant for use in a production environment. For more information, see the [APIRule migration blog post](https://community.sap.com/t5/technology-blogs-by-sap/sap-btp-kyma-runtime-apirule-migration-noauth-and-jwt-handlers/ba-p/13882833). | |||
| > APIRule in version `v1beta1` has been deprecated. Version `v2alpha1` was introduced for testing purposes. It will become deprecated on March 31, 2025 and removed on June 16, 2025. The stable APIRule `v2` will be introduced on March 31, 2025. | |||
There was a problem hiding this comment.
please rephrase it to it is planned / scheduled
| @@ -2,14 +2,23 @@ | |||
| Browse the API Gateway tutorials to learn how to expose workloads. The tutorials are available in two versions: one uses the APIRule resource in version `v2alpha1` and the other uses the APIRule resource in version `v1beta1`. | |||
There was a problem hiding this comment.
ugh in three versions instead of two? v2 -> main stable version, v1beta1 -> deprecated, scheduled for removal, v2alpha1 -> testing short living version
| @@ -2,15 +2,23 @@ | |||
| Browse the API Gateway tutorials to learn how to expose and secure workloads. The tutorials are available in two versions: one uses the APIRule resource in version `v2alpha1` and the other uses the APIRule resource in version `v1beta1`. | |||
|
|
|||
| > [!WARNING] | |||
| > APIRule in version `v1beta1` will become deprecated on October 28, 2024. To prepare for the introduction of the stable APIRule in version `v2`, you can start testing the API and the migration procedure using version `v2alpha1`. APIRule in version `v2alpha1` was introduced for testing purposes only and is not meant for use in a production environment. For more information, see the [APIRule migration blog post](https://community.sap.com/t5/technology-blogs-by-sap/sap-btp-kyma-runtime-apirule-migration-noauth-and-jwt-handlers/ba-p/13882833). | |||
| > APIRule in version `v1beta1` has been deprecated. Version `v2alpha1` was introduced for testing purposes. It will become deprecated on March 31, 2025 and removed on June 16, 2025. The stable APIRule `v2` will be introduced on March 31, 2025. | |||
There was a problem hiding this comment.
please rephrase it to it is planned / scheduled
…ce.md Co-authored-by: Magda Stręk <[email protected]>
nataliasitko
commented
Feb 18, 2025
docs/user/troubleshooting-guides/03-00-cannot-connect-to-service/README.md
Outdated
Show resolved
Hide resolved
mmitoraj
approved these changes
Feb 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes proposed in this pull request:
Related issues