APIGateway Controller is part of Kyma API Gateway Operator. Its role is to manage the installation of Ory Oathkeeper and handle the configuration of Kyma Gateway and the resources defined by the APIGateway custom resource (CR). The controller is responsible for:
- Installing, upgrading, and uninstalling Ory Oathkeeper
- Configuring Kyma Gateway
- Managing Certificates and DNS entries
- Configuring Istio Gateways
The apigateways.operator.kyma-project.io CustomResourceDefinition (CRD) describes the APIGateway CR that is used to manage the API Gateway resources. To learn more, read the APIGateway CR documentation.
| Code | Description |
|---|---|
Ready |
Controller finished reconciliation. |
Processing |
Controller is reconciling resources. |
Deleting |
Controller is deleting resources. |
Error |
An error occurred during reconciliation. |
Warning |
Controller is misconfigured. |
Conditions:
| CR state | Type | Status | Reason | Message |
|---|---|---|---|---|
| Ready | Ready | Unknown | ReconcileProcessing | Reconciliation processing |
| Ready | Ready | True | ReconcileSucceeded | Reconciliation succeeded |
| Error | Ready | False | ReconcileFailed | Reconciliation failed |
| Error | Ready | False | OlderCRExists | API Gateway CR is not the oldest one and does not represent the module state |
| Error | Ready | False | CustomResourceMisconfigured | API Gateway CR has invalid configuration |
| Error | Ready | False | DependenciesMissing | Module dependencies missing |
| Processing | Ready | False | KymaGatewayReconcileSucceeded | Kyma Gateway reconciliation succeeded |
| Error | Ready | False | KymaGatewayReconcileFailed | Kyma Gateway reconciliation failed |
| Warning | Ready | False | KymaGatewayDeletionBlocked | Kyma Gateway deletion blocked because of the existing custom resources: ... |
| Processing | Ready | False | OathkeeperReconcileSucceeded | Ory Oathkeeper reconciliation succeeded |
| Error | Ready | False | OathkeeperReconcileFailed | Ory Oathkeeper reconciliation failed |
| Warning | Ready | False | DeletionBlockedExistingResources | API Gateway deletion blocked because of the existing custom resources: ... |
In accordance with the decision Consistent Labeling of Kyma Modules, the APIGateway Operator resources use the standard Kubernetes labels:
kyma-project.io/module: api-gateway
app.kubernetes.io/name: api-gateway-operator
app.kubernetes.io/instance: api-gateway-operator-default
app.kubernetes.io/version: "x.x.x"
app.kubernetes.io/component: operator
app.kubernetes.io/part-of: api-gatewayAll other resources, such as the external ory-oathkeeper component and its respective resources, use only the Kyma module label:
kyma-project.io/module: api-gatewayRun this command to get all resources created by the API Gateway module:
kubectl get all|<resources-kind> -A -l kyma-project.io/module=api-gateway