# Packages
Package v1alpha2 defines and implements NGINX Service Mesh APIs.
# Functions
AddIgnoredNamespace adds a namespace to IgnoredNamespaces map.
GetMeshConfig attempts to get the mesh config from Kubernetes.
NewConfigManager creates a new mesh config manager.
ValidateLBMethod ensures the load balancing method is not set to "random" when circuit breakers exist.
# Constants
Access Control Modes.
Access Control Modes.
AutoInjectLabel tells whether a pod should be injected with the sidecar.
AutoInjectorPort is the port that the automatic injection webhook binds to.
ClientMaxBodySizeAnnotation tells us the client-max-body-size of the pod.
ControllerVersionPort is the port that the controller runs the /version endpoint on.
DefaultEgressRouteAllowedAnnotation tells us if a pod is allowed to send egress traffic to the egress endpoint.
DefaultSamplerRatio is the default sampler ratio for telemetry.
DeployLabel is the label key for deployment type of the resource.
Enabled is used as the value in the AutoInjectLabel.
EnableEgressLabel tells us if the pod is the NGINX Ingress Controller and if egress traffic is enabled.
EnableIngressLabel tells us if the pod is the NGINX Ingress Controller and if ingress traffic is enabled.
ExternalServiceAnnotation tells us if an endpoint is for an external service.
GroupName identifies the API Group Name for the mesh.
HTTPRouteGroupKind is the kind for HTTPRouteGroups.
IgnoreIncomingPortsAnnotation tells us which ports to ignore for incoming traffic.
IgnoreOutgoingPortsAnnotation tells us which ports to ignore for outgoing traffic.
Injected is used as the value in the InjectedAnnotation.
InjectedAnnotation tells us if a pod has been injected.
Kubernetes environments.
NGINX load balancing methods.
NGINX load balancing methods.
NGINX load balancing methods.
NGINX load balancing methods.
LoadBalancingAnnotation tells us the load balancing method for the service.
MeshCertReloader is the name of the mesh cert reloader image.
MeshConfigFileName is the name of the file where the mesh config is stored.
MeshConfigMap is the name of the config map that holds the mesh config.
MeshController is the name of the mesh controller.
MeshSidecar is the name of the mesh sidecar.
MeshSidecarInit is the name of the mesh init container.
MetricsDeployment is the name of the traffic metrics deployment.
MetricsService is the name of the traffic metrics service.
MetricsServiceAccount is the name of the service account of traffic metrics.
MTLSModeAnnotation tells us the mtls-mode of the pod.
MTLS modes.
MTLS modes.
MTLS modes.
NatsAgentConfigChannel sends the mesh config from mesh-controller to agent.
NatsAgentSubChannel sends a subscription and version notice from agent to mesh-controller.
NatsAPIPingChannel sends a ping from mesh-controller to agent on restart.
NatsCtlrPingChannel sends a ping from mesh-controller to agent on restart.
NatsServer is the name of the nats-server service.
NGINX error log levels.
NGINX error log levels.
NGINX error log levels.
NGINX error log levels.
NGINX error log levels.
NGINX error log levels.
NGINX error log levels.
NGINX error log levels.
NGINX log formats.
NGINX log formats.
Kubernetes environments.
NGINX load balancing methods.
NGINX load balancing methods.
NGINX load balancing methods.
NGINX load balancing methods.
NGINX load balancing methods.
NGINX load balancing methods.
SpiffeIDLabel is the label to tell SPIRE to issue certs.
Svid cert and key names.
Svid cert and key names.
Svid cert and key names.
TCPRouteKind is the kind of TcpRoutes.
# Variables
AccessControlModes are the supported access control modes.
Environments are the supported kubernetes environments.
IgnoredNamespaces is a map of the namespaces that the service mesh will ignore.
LoadBalancingMethods are the available NGINX load balancing methods.
MtlsModes are the supported mtls modes.
NGINXLogFormats are the supported NGINX log formats.
# Structs
ConfigManager manages the in-memory mesh configuration.
Exporters defines the telemetry exporters configuration.
FullMeshConfig defines the entire static configuration for NGINX Service Mesh.
MetricsConfig holds the data that may be dynamically updated at runtime for the nginx-mesh-metrics component.
Mtls defines the mTLS configuration.
Otlp defines the OTLP exporter configuration.
Registry contains the NGINX Service Mesh image registry settings.
Telemetry defines the OpenTelemetry configuration.