README
¶
API Gateway
API Gateway is a Kyma module with which you can expose and secure APIs.
The API Gateway module offers the following features:
- Ory Oathkeeper installation: The module simplifies and manages the installation of Ory Oathkeeper.
- API Exposure: The module combines ORY Oathkeeper and Istio capabilities to offer the APIRule CustomResourceDefinition. By creating APIRule custom resources, you can easily and securely expose your workloads.
- Kyma Gateway installation: The module installs the default simple TLS Kyma Gateway.
Installation
Prerequisites
To use the API Gateway module, you must install Istio and Ory Oathkeeper in your cluster. Learn more about the API Gateway's dependencies and APIrules' dependencies.
Procedure
-
Create the
kyma-systemnamespace and label it withistio-injection=enabled:kubectl create namespace kyma-system kubectl label namespace kyma-system istio-injection=enabled --overwrite -
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 -
Apply the default API Gateway custom resource (CR):
kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/apigateway-default-cr.yamlYou should get a result similar to this example:
apigateways.operator.kyma-project.io/default created -
Check the state of API Gateway CR to verify if API Gateway was installed successfully:
kubectl get apigateways/defaultAfter successful installation, you get the following output:
NAME STATE default Ready
For more installation options, see 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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
gateway/ratelimit/v1alpha1
Package v1alpha1 contains API Schema definitions for the ratelimit v1alpha1 API group +kubebuilder:object:generate=true +groupName=gateway.kyma-project.io
|
Package v1alpha1 contains API Schema definitions for the ratelimit v1alpha1 API group +kubebuilder:object:generate=true +groupName=gateway.kyma-project.io |
|
gateway/v1beta1
Package v1beta1 contains API Schema definitions for the gateway v1beta1 API group +kubebuilder:object:generate=true +groupName=gateway.kyma-project.io
|
Package v1beta1 contains API Schema definitions for the gateway v1beta1 API group +kubebuilder:object:generate=true +groupName=gateway.kyma-project.io |
|
gateway/v2alpha1
Package v2alpha1 contains API Schema definitions for the gateway v2alpha1 API group +kubebuilder:object:generate=true +groupName=gateway.kyma-project.io
|
Package v2alpha1 contains API Schema definitions for the gateway v2alpha1 API group +kubebuilder:object:generate=true +groupName=gateway.kyma-project.io |
|
operator/v1alpha1
Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +kubebuilder:object:generate=true +groupName=operator.kyma-project.io
|
Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +kubebuilder:object:generate=true +groupName=operator.kyma-project.io |
|
internal
|
|
|
path/segment_trie
Package segment_trie provides a trie data structure for storing URL paths.
|
Package segment_trie provides a trie data structure for storing URL paths. |
|
processing/hashbasedstate
Package hashbasedstate provides types and functions to compare objects by a hash and a position in a yaml sequence.
|
Package hashbasedstate provides types and functions to compare objects by a hash and a position in a yaml sequence. |