NGINX Service Mesh API
Instructions for interacting with the NGINX Service Mesh API.
The NGINX Service Mesh API exists within a Kubernetes Custom Resource, and can be used to manage the global mesh configuration. This resource is created when the mesh is deployed, and can be updated at runtime using the Kubernetes API.
Modifying the global mesh configuration
To update the global mesh configuration, use
kubectl to edit the
meshconfig resource that lives in the NGINX Service Mesh namespace. By default, the name of the resource is
kubectl edit meshconfig nginx-mesh-config -n nginx-mesh
This will open your default text editor to make changes. To see the configurable fields, download the custom resource definition:
meshconfigresource is deleted, or the
spec.meshConfigClassNamefield is removed or changed, then the global mesh configuration cannot be updated, and unexpected behavior may occur.
Viewing the global mesh configuration
meshconfig custom resource only contains configuration fields that can be changed at runtime. To view the full state of the mesh configuration, including fields that were set at installation, you can use the
nginx-meshctl command line tool.
- View the full configuration of the mesh:
- View the services participating in the mesh:
For programmatic access, we recommend using a Kubernetes client SDK.