# Functions
GenerateCAFileContent generates a pem file content from the TLS secret.
GenerateCertAndKeyFileContent generates a pem file content from the TLS secret.
GenerateEndpointsKey generates a key for the Endpoints map in VirtualServerEx.
GenerateExternalNameSvcKey returns the key to identify an ExternalName service.
GenerateNginxMainConfig generates MainConfig.
GetBackendPortAsString returns the port of a ServiceBackend of an Ingress resource as a string.
GetMapKeyAsBool searches the map for the given key and parses the key as bool.
GetMapKeyAsInt tries to find and parse a key in a map as int.
GetMapKeyAsInt64 tries to find and parse a key in a map as int64.
GetMapKeyAsStringSlice tries to find and parse a key in the map as string slice splitting it on delimiter.
GetMapKeyAsUint64 tries to find and parse a key in a map as uint64.
NewConfigurator creates a new Configurator.
NewDefaultConfigParams creates a ConfigParams with default values.
NewDefaultGlobalConfigParams creates a GlobalConfigParams with default values.
NewGlobalConfigParamsWithTLSPassthrough creates new GlobalConfigParams with enabled TLS Passthrough listener.
ParseBool ensures that the string value is a valid bool.
ParseConfigMap parses ConfigMap into ConfigParams.
ParseFloat64 ensures that the string value is a valid float64.
ParseInt ensures that the string value is a valid int.
ParseInt64 ensures that the string value is a valid int64.
ParseLBMethod parses method and matches it to a corresponding load balancing method in NGINX.
ParseLBMethodForPlus parses method and matches it to a corresponding load balancing method in NGINX Plus.
ParseOffset ensures that the string value is a valid offset.
ParsePortList ensures that the string is a comma-separated list of port numbers.
ParseProxyBuffersSpec ensures that the string value is a valid proxy buffer spec.
ParseRewriteList ensures that the string is a semicolon-separated list of services.
ParseServiceList ensures that the string is a comma-separated list of services.
ParseSize ensures that the string value is a valid size.
ParseStickyServiceList ensures that the string is a semicolon-separated list of sticky services.
ParseTime ensures that the string value in the annotation is a valid time.
ParseUint64 ensures that the string value is a valid uint64.
VerifyAppProtectThresholds ensures that threshold values are set correctly.
VerifyPath ensures that rewrite paths are in the correct format.
# Constants
AppProtectDosProtectedAnnotation is the namespace/name reference of a DosProtectedResource.
AppProtectLogConfAnnotation is where the NGINX AppProtect Log Configuration is specified.
AppProtectLogConfDstAnnotation is where the NGINX AppProtect Log Configuration destination is specified.
AppProtectPolicyAnnotation is where the NGINX App Protect policy is specified.
#nosec G101.
CAKey is the key of the data field of a Secret where the cert must be stored.
ClientSecretKey is the key of the data field of a Secret where the OIDC client secret must be stored.
DefaultServerSecretName is the filename of the Secret with a TLS cert and a key for the default server.
DefaultServerSecretPath is the full path to the Secret with a TLS cert and a key for the default server.
HtpasswdFileKey is the key of the data field of a Secret where the HTTP basic authorization list must be stored.
JWTKeyAnnotation is the annotation where the Secret with a JWK is specified.
JWTKeyKey is the key of the data field of a Secret where the JWK must be stored.
OffsetFmt http://nginx.org/en/docs/syntax.html.
SizeFmt http://nginx.org/en/docs/syntax.html.
WildcardSecretName is the filename of the Secret with a TLS cert and a key for the ingress resources with TLS termination enabled but not secret defined.
# Structs
AppProtectLog holds a single pair of log config and log destination.
AppProtectResources holds namespace names of App Protect resources relevant to an Ingress.
ConfigParams holds NGINX configuration parameters that affect the main NGINX config as well as configs for Ingress resources.
Configurator configures NGINX.
DosEx holds a DosProtectedResource and the dos policy and log confs it references.
ExtendedResources holds all extended configuration resources, for which Configurator configures NGINX.
GlobalConfigParams holds global configuration parameters.
IngressEx holds an Ingress along with the resources that are referenced in this Ingress.
JWTKey represents a secret that holds JSON Web Key.
Listener represents a listener that can be used in a TransportServer resource.
MergeableIngresses is a mergeable ingress of a master and minions.
MeshPodOwner contains the type and name of the K8s resource that owns the pod.
PodInfo contains the name of the Pod and the MeshPodOwner information which is used for NGINX Service Mesh metrics.
StaticConfigParams holds immutable NGINX configuration parameters that affect the main NGINX config.
TransportServerEx holds a TransportServer along with the resources referenced by it.
VirtualServerEx holds a VirtualServer along with the resources that are referenced in this VirtualServer.
# Type aliases
ResourceOperation represents a function that changes configuration in relation to an unstructured resource.
Warnings stores a list of warnings for a given runtime k8s object in a map.