MCPGateway

MCPGateway is the Schema for the mcpgateways API. It defines a gateway that routes MCP traffic to backend servers.

Spec

FieldDescriptionDefaultValidation
apiVersion stringmcp-gateway.ohcs.io/v1alpha1
kind stringMCPGateway
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec MCPGatewaySpecspec defines the desired state of MCPGateway.Required
status MCPGatewayStatusstatus defines the observed state of MCPGateway.

MCPGatewaySpec

FieldDescriptionDefaultValidation
domain stringdomain is the base domain for MCP server endpoints (e.g., “mcp.example.com”). All MCPRemoteServer and MCPContainerServer resources referencing this gateway will be accessible under this domain.MinLength: 1, Required
replicas integerreplicas is the number of gateway proxy replicas to run.1Minimum: 1
image stringimage is the container image for the gateway proxy. If not specified, uses MCP_GATEWAY_IMAGE env var from operator, or defaults to latest.
resources ResourceRequirementsresources defines compute resources for the gateway proxy containers.
ingressClassName stringingressClassName is the name of the IngressClass to use for the gateway Ingress.
tls TLSConfigtls configures TLS for the gateway.
nodeSelector object (keys:string, values:string)nodeSelector is a selector for nodes to run the gateway proxy on.
tolerations Toleration arraytolerations are tolerations for the gateway proxy pods.
affinity Affinityaffinity is the affinity configuration for the gateway proxy pods.
authSecretRef LocalObjectReferenceauthSecretRef references a Secret containing the AUTH_TOKEN for gateway authentication. The Secret must have a key named “token”.

MCPGatewayStatus

FieldDescriptionDefaultValidation
phase stringphase represents the current phase of the MCPGateway.
conditions Condition arrayconditions represent the current state of the MCPGateway resource.
activeServers integeractiveServers is the count of active MCP servers routing through this gateway.
endpoint stringendpoint is the URL where the gateway is accessible (e.g., “https://mcp.example.com”).
ready booleanready indicates whether the gateway is ready to accept traffic.
deploymentName stringdeploymentName is the name of the Deployment created for the gateway.
serviceName stringserviceName is the name of the Service created for the gateway.
ingressName stringingressName is the name of the Ingress created for the gateway.
configMapName stringconfigMapName is the name of the ConfigMap containing gateway routing configuration.

Supporting Types

TLSConfig

TLSConfig defines TLS configuration for the gateway.

FieldDescriptionDefaultValidation
enabled booleanenabled specifies whether TLS is enabled.true
secretName stringsecretName is the name of the TLS secret containing tls.crt and tls.key.
clusterIssuer stringclusterIssuer is the name of the cert-manager ClusterIssuer to use for certificate generation.