## 4.3.1.2.4.5  Migrating APIRule v1beta1 of type oauth2\_introspection to version v2
Learn how to migrate an APIRule created in version v1beta1 using the oauth2\_introspection handler to the extAuth handler in version v2 . In APIRule v2 , the extAuth handler replaces all Ory Oathkeeper-based handlers used in the v1beta1 version. The instructions focus on oauth2\_introspection because it is the most popular Ory Oathkeeper-based handler.
## Prerequisites
- You have read Changes Introduced in APIRule v2 [page 1851], which details the updates implemented in the new version of APIRule. If any of these changes affect your setup, you must consider them when migrating to APIRule v2 and make the necessary adjustments.
- You have the Istio and API Gateway modules added.
- You have installed kubectl and curl .
- You have a deployed workload exposed by an APIRule in the deprecated v1beta1 version. The APIRule uses the jwt handler.
##  Note
To expose a workload using APIRule in version v2 , the workload must be a part of the Istio service mesh. See Enabling Istio Sidecar Proxy Injection [page 1783].
## Context
APIRule in version v1beta1 is deprecated and scheduled for removal. Once the APIRule custom resource definition (CRD) stops serving version v1beta1 , the API server will no longer respond to requests for APIRules in this version. As a result, you will encounter errors when attempting to access the APIRule custom resource using the deprecated v1beta1 version. Therefore, you must migrate to version v2 .
In this example, the APIRule v1beta1 was created with the oauth2\_introspection handler, so the migration targets an APIRule v2 using the extAuth handler. To illustrate the migration, the HTTPBin service is used, exposing the /anything and /.* endpoints. The HTTPBin service is deployed in its own namespace, with Istio enabled, ensuring the workload is part of the Istio service mesh.
## Procedure
1. Retrieve a configuration of the APIRule in version v1beta1 and save it for further modifications. For instructions, see Retrieving the Complete spec of an APIRule in Version v1beta1 [page 1854].
See a sample of the retrieved spec in the YAML format. The following configuration uses the oauth2\_introspection handler to expose HTTPBin service's /anything and /.* endpoints:
```
 Sample Code host: httpbin.local.kyma.dev service: name: httpbin namespace: test port: 8000 gateway: kyma-system/kyma-gateway rules: - path: /anything methods: - POST accessStrategies: - handler: oauth2_introspection config: introspection_request_headers: Authorization: Basic {ENCODED_CREDENTIALS} introspection_url: https://{IAS_TENANT}.accounts.ondemand.com/ oauth2/introspect required_scope: - write - path: /.* methods: - GET accessStrategies: - handler: oauth2_introspection config: introspection_request_headers: Authorization: Basic {ENCODED_CREDENTIALS} introspection_url: https://{IAS_TENANT}.accounts.ondemand.com/ oauth2/introspect required_scope: - read
```
2. In order for the extAuth handler in APIRule v2 to work, you must first deploy a service that acts as an external authorizer for Istio.
The following instructions use OAuth2 Proxy with an OAuth2.0-compliant authorization server supporting OIDC discovery.
- a. Replace the placeholders and create the values.yaml file with the OAuth2 Proxy configuration.
The following example shows the configuration of OAuth2 Proxy with the following parameters:
- CLIENT\_SECRET , CLIENT\_ID , and OIDC\_ISSUER\_URL . T o get them, follow Get a JSON Web Token (JWT) .
- DOMAIN\_TO\_EXPOSE\_WORKLOADS refers to either a custom domain or, as in this example, the default domain local.kyma.dev.
- COOKIE\_SECRET that you can generate using the following command:
```
openssl rand -base64 32 | tr -- '+/''-_'
```
- TOKEN\_SCOPES specifies the OAuth scopes. Each provider has a default set of scopes that are used if you haven't configured custom scopes.
For a list of options and further details, refer to the OAuth2 Proxy documentation .
```
 Sample Code cat <<EOF > values.yaml config: clientID: {CLIENT_ID} clientSecret: {CLIENT_SECRET} cookieName: "" cookieSecret: {COOKIE_SECRET} extraArgs: auth-logging: true cookie-domain: "{DOMAIN_TO_EXPOSE_WORKLOADS}" cookie-samesite: lax cookie-secure: false force-json-errors: true login-url: static://401 oidc-issuer-url: {OIDC_ISSUER_URL} pass-access-token: true pass-authorization-header: true pass-host-header: true pass-user-headers: true provider: oidc request-logging: true reverse-proxy: true scope: "{TOKEN_SCOPES}" set-authorization-header: true set-xauthrequest: true skip-jwt-bearer-tokens: true skip-oidc-discovery: false skip-provider-button: true standard-logging: true upstream: static://200 whitelist-domain: "*.{DOMAIN_TO_EXPOSE_WORKLOADS}:*" EOF
```
- b. To install OAuth2 Proxy with your configuration, use OAuth2 Proxy helm chart :
- c. Register OAuth2 Proxy as an authorization provider in the Istio module:
3. Adjust the obtained configuration of the APIRule to use the extAuth handler in version v2 .
```
kubectl create namespace oauth2-proxy helm repo add oauth2-proxy https://oauth2-proxy.github.io/manifests helm upgrade --install oauth2-proxy oauth2-proxy/oauth2-proxy -f values.yaml -n oauth2-proxy
```
```
kubectl patch istio -n kyma-system default --type merge --patch '{"spec":{"config": {"authorizers":[{"name":"oauth2-proxy","port":80,"service":"oauth2proxy.oauth2-proxy.svc.cluster.local","headers":{"inCheck":{"include":["xforwarded-for", "cookie", "authorization"]}}}]}}}'
```
The following APIRule example delegates token validation to the previously configured OAuth2 Proxy. Existing tokens stay valid throughout the migration, ensuring that the process does not disrupt any exposed or secured workloads.
## 
```
Sample Code apiVersion: gateway.kyma-project.io/v2 kind: APIRule
```
```
metadata: name: httpbin namespace: test spec: hosts: - httpbin service: name: httpbin namespace: test port: 8000 gateway: kyma-system/kyma-gateway rules: - extAuth: authorizers: - oauth2-proxy methods: - POST path: /anything - extAuth: authorizers: - oauth2-proxy methods: - GET path: /{**}
```
##  Note
The hosts field accepts a short host name (without a domain). Additionally, the path /.* has been changed to /{**} because APIRule v2 does not support regular expressions in the spec.rules.path field.
For more information, see Changes Introduced in APIRule v2 [page 1851].
4. Update the APIRule to version v2 by applying the adjusted configuration.
To verify the version of the applied APIRule, check the value of the gateway.kyma-project.io/ original-version annotation in the APIRule spec. A value of v2 indicates that the APIRule has been successfully migrated. To see the value, run:
kubectl get apirules.gateway.kyma-project.io -n $NAMESPACE $APIRULE\_NAME -oyaml
The following output indicates that the APIRule has been successfully migrated to version v2 :
## 
```
Sample Code apiVersion: gateway.kyma-project.io/v2 kind: APIRule metadata: annotations: gateway.kyma-project.io/original-version: v2 ...
```
##  Caution
Do not manually change the gateway.kyma-project.io/original-version annotation. This annotation is automatically updated when you apply your APIRule in version v2 . Modifying the annotation's value manually causes your APIRule v1beta1 to be handled and configured as version v2 , potentially leading to reconciliation errors.
5. To preserve the internal traffic policy from the APIRule v1beta1 , you must apply the following AuthorizationPolicy.
In APIRule v2 , internal traffic is blocked by default. Without this AuthorizationPolicy, attempts to connect internally to the workload cause an RBAC: access denied error. Ensure that the selector label is updated to match the target workload.
| Option                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| {NAMESPACE}                | The namespace to which the AuthorizationPolicy applies. This namespace must include the target workload for which you allow internal traffic. The selector matches workloads in the same namespace as the Authorization- Policy.                                                                                                                                                                                                                  |
| {LABEL_KEY}: {LABEL_VALUE} | To further restrict the scope of the AuthorizationPolicy, specify label selectors that match the target workload. Replace these placeholders with the actual key and value of the label. The label indicates a specific set of Pods to which a policy should be applied. The scope of the label search is restricted to the configuration namespace in which the AuthorizationPolicy is present. For more information, see Authorization Policy . |
```
apiVersion: security.istio.io/v1 kind: AuthorizationPolicy metadata: name: allow-internal namespace: {NAMESPACE} spec: selector: matchLabels: {LABEL_KEY}: {LABEL_VALUE} action: ALLOW rules: - from: - source: notPrincipals: ["cluster.local/ns/istio-system/sa/istioingressgateway-service-account"]
```
6. To retain the CORS configuration from the APIRule v1beta1 , update the APIRule in version v2 to include the same CORS settings.
For preflight requests to work correctly, you must explicitly add the "OPTIONS" method to the rules.methods field of your APIRule v2 . For guidance, see the sample APIRule CRs .
## Results
You have migrated your APIRule CR to version v2 . Now, access your workload:
- Send a GET request to the exposed workload using JWT authentication::
```
 Sample Code curl -ik -X GET https://{SUBDOMAIN}.{DOMAIN_NAME}/ip --header "Authorization:Bearer $ACCESS_TOKEN"
```
If successful, the call returns the 200 OK response code.
- Send a POST request to the exposed workload using JWT authentication:
```
 Sample Code curl -ik -X POST https://{SUBDOMAIN}.{DOMAIN_NAME}/anything -d "test data" --header "Authorization:Bearer $ACCESS_TOKEN"
```
If successful, the call returns the 200 OK response code.
- Send a POST request to the exposed workload without JWT authentication:
```
 Sample Code curl -ik -X POST https://{SUBDOMAIN}.{DOMAIN_NAME}/anything -d "test data"
```
The call returns the 403 error code.