annotations

Documentation

Index

• Constants
• func ParseInternalPorts(value string, isListenerPort func(port int32) bool) (sets.Set[int32], []string)

Constants

const InternalPorts = "agentgateway.dev/internal-ports"

InternalPorts is a comma-separated list of ports whose bind should be internal (routing-only: no OS listener socket, no Service port, no container port). It may be set on a Gateway or a ListenerSet and may only reference ports defined by that same object's listeners.

const LegacyMCPServiceHTTPPath = "kgateway.dev/mcp-path"

LegacyMCPServiceHTTPPath is the legacy annotation used to specify the HTTP path for the MCP service. Users should switch to MCPServiceHTTPPath.

const MCPServiceHTTPPath = "agentgateway.dev/mcp-path"

MCPServiceHTTPPath is the annotation used to specify the HTTP path for the MCP service

const MCPServiceTargetName = "agentgateway.dev/mcp-target-name"

MCPServiceTargetName is the annotation used to specify the target name for the MCP service. The value must be a valid Gateway API SectionName.

Functions

func ParseInternalPorts

func ParseInternalPorts(value string, isListenerPort func(port int32) bool) (sets.Set[int32], []string)

ParseInternalPorts parses the InternalPorts annotation value into the set of ports marked internal. isListenerPort reports whether a port is defined by the annotated object's own listeners; any referenced port that is malformed, out of range, or not an own listener port is returned as an error message so the caller can surface an Accepted=False condition. On any error the returned set is empty (the annotation is rejected wholesale rather than partially applied). The membership check is passed as a closure so callers can use whichever set type they already have.