# Functions
Resource takes an unqualified resource and returns a Group qualified GroupResource.
# Constants
CIDRAddressType specifies that the address is a CIDR block.
ControllerLogLevelDebug is the debug level for control plane logging.
ControllerLogLevelError is the error level for control plane logging.
ControllerLogLevelInfo is the info level for control plane logging.
Dual specifies that NGINX will use both IPv4 and IPv6.
GroupName specifies the group name used to register the objects.
HostnameAddressType specifies that the address is a Hostname.
IPAddressType specifies that the address is an IP address.
IPv4 specifies that NGINX will use only IPv4.
IPv6 specifies that NGINX will use only IPv6.
NginxContextHTTP is the http context of the NGINX configuration.
NginxContextHTTPServer is the server context of the NGINX configuration.
NginxContextHTTPServerLocation is the location context of the NGINX configuration.
NginxContextMain is the main context of the NGINX configuration.
NginxGatewayConditionValid is a condition that is true when the NginxGateway configuration is syntactically and semantically valid.
NginxGatewayReasonInvalid is a reason that is used with the "Valid" condition when the condition is False.
NginxGatewayReasonValid is a reason that is used with the "Valid" condition when the condition is True.
NginxLogLevelAlert is the alert level for NGINX error logs.
NginxLogLevelCrit is the crit level for NGINX error logs.
NginxLogLevelDebug is the debug level for NGINX error logs.
NginxLogLevelEmerg is the emerg level for NGINX error logs.
NginxLogLevelError is the error level for NGINX error logs.
NginxLogLevelInfo is the info level for NGINX error logs.
NginxLogLevelNotice is the notice level for NGINX error logs.
NginxLogLevelWarn is the warn level for NGINX error logs.
RewriteClientIPModeProxyProtocol configures NGINX to accept PROXY protocol and set the client's IP address to the IP address in the PROXY protocol header.
RewriteClientIPModeXForwardedFor configures NGINX to set the client's IP address to the IP address in the X-Forwarded-For HTTP header.
SnippetsFilterConditionReasonAccepted is used with the Accepted condition type when the condition is true.
SnippetsFilterConditionReasonInvalid is used with the Accepted condition type when SnippetsFilter is invalid.
SnippetsFilterConditionTypeAccepted indicates that the SnippetsFilter is accepted.
TraceContextExtract uses an existing trace context from the request, so that the identifiers of a trace and the parent span are inherited from the incoming request.
TraceContextIgnore skips context headers processing.
TraceContextInject adds a new context to the request, overwriting existing headers, if any.
TraceContextPropagate updates the existing context (combines extract and inject).
TraceStrategyParent enables tracing and only records spans if the parent span was sampled.
TraceStrategyRatio enables ratio-based tracing, defaulting to 100% sampling rate.
# Variables
AddToScheme applies all the stored functions to the scheme.
SchemeBuilder collects functions that add things to a scheme.
SchemeGroupVersion is group version used to register these objects.
# Structs
Address is a struct that specifies address type and value.
ClientBody contains the settings for the client request body.
ClientKeepAlive defines the keep-alive settings for clients.
ClientKeepAliveTimeout defines the timeouts related to keep-alive client connections.
ClientSettingsPolicy is an Inherited Attached Policy.
ClientSettingsPolicyList contains a list of ClientSettingsPolicies.
ClientSettingsPolicySpec defines the desired state of ClientSettingsPolicy.
No description provided by the author
Logging defines logging related settings for the control plane.
NginxGateway represents the dynamic configuration for an NGINX Gateway Fabric control plane.
NginxGatewayList contains a list of NginxGateways.
NginxGatewaySpec defines the desired state of the NginxGateway.
NginxGatewayStatus defines the state of the NginxGateway.
NginxLogging defines logging related settings for NGINX.
NginxProxy is a configuration object that is attached to a GatewayClass parametersRef.
NginxProxyList contains a list of NginxProxies.
NginxProxySpec defines the desired state of the NginxProxy.
ObservabilityPolicy is a Direct Attached Policy.
ObservabilityPolicyList contains a list of ObservabilityPolicies.
ObservabilityPolicySpec defines the desired state of the ObservabilityPolicy.
RewriteClientIP specifies the configuration for rewriting the client's IP address.
Snippet represents an NGINX configuration snippet.
SnippetsFilter is a filter that allows inserting NGINX configuration into the generated NGINX config for HTTPRoute and GRPCRoute resources.
SnippetsFilterList contains a list of SnippetFilters.
SnippetsFilterSpec defines the desired state of the SnippetsFilter.
SnippetsFilterStatus defines the state of SnippetsFilter.
SpanAttribute is a key value pair to be added to a tracing span.
Telemetry specifies the OpenTelemetry configuration.
TelemetryExporter specifies OpenTelemetry export parameters.
Tracing allows for enabling and configuring OpenTelemetry tracing.
# Type aliases
AddressType specifies the type of address.
ControllerLogLevel type defines the logging level for the control plane.
Duration is a string value representing a duration in time.
IPFamilyType specifies the IP family to be used by NGINX.
NginxContext represents the NGINX configuration context.
NginxErrorLogLevel type defines the log level of error logs for NGINX.
NginxGatewayConditionReason defines the set of reasons that explain why a particular NginxGateway condition type has been raised.
NginxGatewayConditionType is a type of condition associated with an NginxGateway.
RewriteClientIPModeType defines how NGINX Gateway Fabric will determine the client's original IP address.
Size is a string value representing a size.
SnippetsFilterConditionReason is a reason for a SnippetsFilter condition type.
SnippetsFilterConditionType is a type of condition associated with SnippetsFilter.
TraceContext specifies how to propagate traceparent/tracestate headers.
TraceStrategy defines the tracing strategy.