APIGateway Custom Resource

The apigateways.operator.kyma-project.io CustomResourceDefinition (CRD) describes the kind and the format of data that APIGateway Controller uses to configure the API Gateway resources. Applying the custom resource (CR) triggers the installation of API Gateway resources, and deleting it triggers the uninstallation of those resources. The default CR has the name default.

kubectl get crd apigateways.operator.kyma-project.io -o yaml

You are only allowed to have one APIGateway CR. If there are multiple APIGateway CRs in the cluster, the oldest one reconciles the module. Any additional APIGateway CR is placed in the Warning state.

Sample Custom Resource

This is a sample APIGateway CR:

apiVersion: operator.kyma-project.io/v1alpha1
kind: APIGateway
metadata:
  labels:
    operator.kyma-project.io/managed-by: kyma
  name: default
spec:
  enableKymaGateway: true

Custom Resource Parameters

The following tables list all the possible parameters of a given resource together with their descriptions.

APIVersions

• operator.kyma-project.io/v1alpha1

Resource Types

• APIGateway

APIGateway

APIGateway is the Schema for APIGateway APIs.

Field	Description	Validation
apiVersion string	operator.kyma-project.io/v1alpha1	Optional
kind string	APIGateway	Optional
metadata ObjectMeta	For more information on the metadata fields, see Kubernetes API documentation.	Optional
spec APIGatewaySpec	Defines the desired state of APIGateway CR.	Optional
status APIGatewayStatus	Defines the observed status of APIGateway CR.	Optional

APIGatewaySpec

Defines the desired state of APIGateway CR.

Appears in:

• APIGateway

Field	Description	Validation
enableKymaGateway boolean	Specifies whether the default Kyma Gateway kyma-gateway in kyma-system namespace is created.	Optional

APIGatewayStatus

Defines the observed state of APIGateway CR.

Appears in:

• APIGateway

Field	Description	Validation
state State	State signifies current state of APIGateway. The possible values are Ready, Processing, Error, Deleting, Warning.	Enum: [Processing Deleting Ready Error Warning] Required
description string	Contains the description of the APIGateway's state.	Optional
conditions Condition array	Contains conditions associated with the APIGateway's status.	Optional

State

Underlying type: string

Appears in:

• APIGatewayStatus

Field	Description
Ready	APIGateway Controller finished reconciliation.
Processing	APIGateway Controller is reconciling resources.
Error	An error occurred during the reconciliation. The error is rather related to the API Gateway module than the configuration of your resources.
Deleting	APIGateway Controller is deleting resources.
Warning	An issue occurred during reconciliation that requires your attention. Check the status.description message to identify the issue and make the necessary corrections to the APIGateway CR or any related resources.