API Gateway

What Is API Gateway?

API Gateway provides functionalities that allow you to expose and secure APIs by using Ory Oathkeeper and the Istio service mesh resources.

Kyma API Gateway Operator

Kyma API Gateway Operator is an extension to the Kyma runtime that manages the application of API Gateway's configuration and handles resource reconciliation. Within Kyma API Gateway Operator, there are two controllers: APIGateway Controller, which applies the configuration specified in APIGateway custom resource (CR), and APIRule Controller, which applies the configuration specified in APIRule CR.

Installation

Prerequisites

To use API Gateway, you must install Istio and Ory Oathkeeper in your cluster. Learn more about the API Gateway's dependencies and APIrules' dependencies.

Procedure

1. Create the kyma-system namespace and label it with istio-injection=enabled:

   kubectl create namespace kyma-system
   kubectl label namespace kyma-system istio-injection=enabled --overwrite

2. To install API Gateway, you must install the latest version of Kyma API Gateway Operator and API Gateway CustomResourceDefinition first. Run:

   kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/api-gateway-manager.yaml

3. Apply the default API Gateway custom resource (CR):

   kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/apigateway-default-cr.yaml

   You should get a result similar to this example:

   apigateways.operator.kyma-project.io/default created

4. Check the state of API Gateway CR to verify if API Gateway was installed successfully:

   kubectl get apigateways/default

   After successful installation, you get the following output:

   NAME      STATE
   default   Ready

For more installation options, visit the installation guide.

Useful Links

To learn how to use the API Gateway module, read the documentation in the user directory.

If you are interested in the detailed documentation of the Kyma API Gateway Operator's design and technical aspects, check the contributor directory.

Contributing

See the Contributing guidelines.

Code of Conduct

See the Code of Conduct document.

Licensing

See the license file.