# Functions
GetSwagger returns the Swagger specification corresponding to the generated code in this file.
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewGetConfigRequest generates requests for GetConfig.
NewGetServicesRequest generates requests for GetServices.
NewInjectSidecarProxyRequestWithBody generates requests for InjectSidecarProxy with any type of body.
NewMeshClient returns a new Client object for communicating with the mesh API.
NewPatchConfigRequest calls the generic PatchConfig builder with application/json body.
NewPatchConfigRequestWithBody generates requests for PatchConfig with any type of body.
ParseAPIError parses the error message from an HTTP response.
ParseGetConfigResponse parses an HTTP response from a GetConfigWithResponse call.
ParseGetServicesResponse parses an HTTP response from a GetServicesWithResponse call.
ParseInjectSidecarProxyResponse parses an HTTP response from a InjectSidecarProxyWithResponse call.
ParsePatchConfigResponse parses an HTTP response from a PatchConfigWithResponse call.
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
RegisterHandlers adds each server route to the EchoRouter.
Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.
# Constants
Defines values for PatchConfigOp.
AutoInjectLabel tells whether a pod should be injected with the sidecar.
Defines values for TraceConfigBackend.
DeployLabel is the label key for deployment type of the resource.
Defines values for MtlsConfigCaKeyType.
Defines values for MtlsConfigCaKeyType.
FileField is the field that contains the binary data of the file to inject.
HTTPRouteGroupKind is the kind for HTTPRouteGroups.
IgnoreIncomingPortsField is the field that lists ports to ignore for incoming traffic.
IgnoreOutgoingPortsField is the field that lists ports to ignore for outgoing traffic.
Injected is used as the value in the InjectedAnnotation.
InjectedAnnotation tells us if a pod has been injected.
Defines values for TraceConfigBackend.
Defines values for MeshConfigEnvironment.
MeshAPI is the name of the mesh api.
MeshCertReloader is the name of the mesh cert reloader image.
Defines values for MeshConfigAccessControlMode.
Defines values for MeshConfigAccessControlMode.
MeshConfigFileName is the name of the file where the mesh config is stored.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
Defines values for MeshConfigLoadBalancingMethod.
MeshConfigMap is the name of the config map that holds the mesh config.
Defines values for MeshConfigNginxErrorLogLevel.
Defines values for MeshConfigNginxErrorLogLevel.
Defines values for MeshConfigNginxErrorLogLevel.
Defines values for MeshConfigNginxErrorLogLevel.
Defines values for MeshConfigNginxErrorLogLevel.
Defines values for MeshConfigNginxErrorLogLevel.
Defines values for MeshConfigNginxErrorLogLevel.
Defines values for MeshConfigNginxErrorLogLevel.
Defines values for MeshConfigNginxLogFormat.
Defines values for MeshConfigNginxLogFormat.
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.
NatsAgentConfigChannel sends the mesh config from mesh-api to agent.
NatsAgentSubChannel sends a subscription and version notice from agent to mesh-api.
NatsAPIPingChannel sends a ping from mesh-api to agent on restart.
NatsServer is the name of the nats-server service.
Defines values for MtlsConfigMode.
Defines values for MeshConfigEnvironment.
Defines values for PatchConfigFieldAccessControlMode.
Defines values for PatchConfigFieldAccessControlMode.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldLoadBalancingMethod.
Defines values for PatchConfigFieldNginxErrorLogLevel.
Defines values for PatchConfigFieldNginxErrorLogLevel.
Defines values for PatchConfigFieldNginxErrorLogLevel.
Defines values for PatchConfigFieldNginxErrorLogLevel.
Defines values for PatchConfigFieldNginxErrorLogLevel.
Defines values for PatchConfigFieldNginxErrorLogLevel.
Defines values for PatchConfigFieldNginxErrorLogLevel.
Defines values for PatchConfigFieldNginxErrorLogLevel.
Defines values for PatchConfigFieldNginxLogFormat.
Defines values for PatchConfigFieldNginxLogFormat.
Defines values for MtlsConfigMode.
Defines values for PatchConfigOp.
Defines values for PatchConfigOp.
Defines values for MtlsConfigCaKeyType.
Defines values for MtlsConfigCaKeyType.
Defines values for MtlsConfigMode.
TCPRouteKind is the kind of TcpRoutes.
Defines values for TraceConfigBackend.
# Variables
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.
TracingBackends are the supported tracing backends.
# Structs
APIConfig The configuration of the NGINX Service Mesh API.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
ErrorDetail defines model for ErrorDetail.
ErrorModel defines model for ErrorModel.
ExportersConfig The configuration of exporters to send telemetry data to.
No description provided by the author
No description provided by the author
Image A container image, comprised of an image name and image tag.
InjectConfig The configuration for injection of the NGINX Service Mesh sidecar.
InjectSidecarProxyMultipartBody defines parameters for InjectSidecarProxy.
No description provided by the author
MeshConfig Holds combined configuration required to run the NGINX Service Mesh control plane and the data plane.
MetricsConfig holds the data that may be dynamically updated at runtime for the nginx-mesh-metrics component.
MtlsConfig The configuration for mTLS.
OtlpExporterConfig The configuration for an OTLP gRPC exporter.
PatchConfig The configuration object that holds the updates to be made to the NGINX Service Mesh configuration.
PatchConfigJSONBody defines parameters for PatchConfig.
No description provided by the author
PortsConfig The ports that the NGINX Service Mesh sidecar proxies listen on.
ProxyConfig The configuration of the NGINX Service Mesh sidecar proxies.
ServerInterfaceWrapper converts echo contexts to parameters.
Service The configuration of a Service resource in NGINX Service Mesh.
ServicePort A representation of a Service Port in NGINX Service Mesh.
TelemetryConfig The configuration for telemetry.
TraceConfig The configuration for tracing.
# Interfaces
The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration.
Doer performs HTTP requests.
ServerInterface represents all server handlers.
# Type aliases
BadRequest defines model for BadRequest.
ClientOption allows setting custom parameters during construction.
Forbidden defines model for Forbidden.
InjectSidecarProxyMultipartRequestBody defines body for InjectSidecarProxy for multipart/form-data ContentType.
InternalServerError defines model for InternalServerError.
MeshConfigAccessControlMode The access control mode of NGINX Service Mesh.
MeshConfigEnvironment The environment that the NGINX Service Mesh control plane is installed in.
MeshConfigLoadBalancingMethod The global load balancing method for Services in NGINX Service Mesh.
MeshConfigNginxErrorLogLevel The error log level of the NGINX Service Mesh sidecar proxies.
MeshConfigNginxLogFormat The log format of the NGINX Service Mesh sidecar proxies.
MtlsConfigCaKeyType The key type used for the SPIRE Server CA.
MtlsConfigMode The mTLS mode of NGINX Service Mesh.
PatchConfigFieldAccessControlMode The access control mode of NGINX Service Mesh.
PatchConfigFieldLoadBalancingMethod The global load balancing method for Services in NGINX Service Mesh.
PatchConfigFieldNginxErrorLogLevel The error log level of the NGINX Service Mesh sidecar proxies.
PatchConfigFieldNginxLogFormat The log format of the NGINX Service Mesh sidecar proxies.
PatchConfigJSONBody1 defines parameters for PatchConfig.
PatchConfigJSONRequestBody defines body for PatchConfig for application/json ContentType.
PatchConfigOp The type of operation to be performed on the NGINX Service Mesh configuration.
ProxiedResources is a map of namespace -> k8s resource type -> resource names; used by the CLI to print out proxied resources when removing the mesh.
RequestEditorFn is the function signature for the RequestEditor callback function.
TraceConfigBackend The name of the tracing backend.
Unauthorized defines model for Unauthorized.