docs/content/en/guides/troubleshooting/meshery-operator-meshsync.md
{{% alert color="info" title="What is Meshery Operator?" %}} <a href='{{< ref "concepts/architecture/operator/index.md" >}}'>Meshery Operator</a> controls and monitors the lifecycle of components deployed inside Meshery-managed Kubernetes clusters. Learn more about <a href='{{< ref "concepts/_index.md" >}}'>Meshery's architecture</a>. {{% /alert %}}
This guide offers comprehensive troubleshooting instructions for [Meshery Operator]({{< ref "concepts/architecture/operator/index.md" >}}) and its custom controllers, [MeshSync]({{< ref "concepts/architecture/meshsync.md" >}}) and [Broker]({{< ref "concepts/architecture/broker/index.md" >}}). Follow the steps outlined in this document to ensure a smooth Meshery deployment.
First, understand the Meshery Operator Deployment Scenarios and the Status of Meshery Operator, MeshSync, and Meshery Broker to identify the deployment model fitting of your environment. Then, follow the guidance under the respective scenario to troubleshoot accordingly.
{{% alert color="dark" title="Meshery Error Code Reference" %}} Have specific error with an error code? See the <a href='{{< ref "reference/references/error-codes.md" >}}'>Meshery Error Code Reference</a> for probable cause and suggested remediations. {{% /alert %}}
Each Meshery Operator controller offers a health status that you can use to understand its current health in your deployment. These statuses are computed by Meshery Server from what it observes of the Operator, MeshSync, and Broker; their meanings are described below.
Because Meshery is versatile in its deployment models, there are different scenarios in which you may need to troubleshoot the health of Meshery Operator. Identify the deployment model fitting your environment and follow the guidance under the respective scenario to troubleshoot accordingly.
Whether using [mesheryctl system start]({{< ref "installation/_index.md" >}}), [helm install]({{< ref "installation/kubernetes/helm.md" >}}) or make run-local, Meshery Server will automatically connect to any available Kubernetes clusters found in your kubeconfig (under $HOME/.kube/config). Once connected, operator, broker(NATS) and meshsync will automatically get deployed in the same clusters.
If everything is fine, by viewing the connection in Meshery UI, MeshSync should be in CONNECTED: state. Otherwise, check the Operator's pod logs:
kubectl logs <meshery-operator-pod> -n meshery
In this model Meshery Server must both reach and authenticate to the in-cluster Meshery Broker (NATS):
ClusterIP only, which is not reachable from outside the cluster. When Meshery Server runs out-of-cluster it automatically establishes a self-healing port-forward to the Broker's NATS pod through the Kubernetes API server (like kubectl port-forward, using the credentials Meshery already holds) and connects over it - no manual step required. This is on by default out-of-cluster, skipped automatically in-cluster, and can be disabled with MESHERY_MANAGED_BROKER_PORTFORWARD=false (after which you must provide your own path, e.g. kubectl port-forward -n meshery svc/meshery-nats 4222:4222, or expose the Broker via NodePort/LoadBalancer).meshery-nats-auth); Meshery Server reads that token and presents it automatically. Without it the Broker rejects the connection with an authorization violation.For the full walkthrough of the Kubernetes connection lifecycle, its components, and these connectivity behaviors, see [Kubernetes Connection Lifecycle]({{< ref "guides/infrastructure-management/kubernetes-connection-lifecycle.md" >}}).
Some common failure situations that Meshery users might face are described below.
ClusterIP-only and unreachable, or Meshery is not presenting the NATS token. See Out-of-Cluster Deployment; the connection's Diagnostics will report broker_unreachable with remediation.meshery-nats (Broker) pod is in CrashLoopBackOff and never becomes ready.
nats.conf unquoted (token: $NATS_TOKEN). When the generated token happens to look like a number, the NATS config parser rejects it and the pod crash-loops. Confirm with kubectl logs -n meshery meshery-nats-0 -c nats (look for a variable reference for 'NATS_TOKEN' ... could not be parsed error). The fix belongs in the Operator (quote it: token: "$NATS_TOKEN"); redeploying often generates a token that parses.Meshery Operator, MeshSync, and Broker are crucial components in a Meshery deployment. Meshery can function without them, but some functions of Meshery will be disable / unusable. Whether Meshery Operator is initially deployed via mesheryctl command or via Meshery Server, you can monitor the health of the Meshery Operator deployment using either the CLI or UI clients.
The following commands are available to troubleshoot Meshery Operator, MeshSync, and Broker.
Meshery Server and Adapters
mesheryctl system status - Displays the status of Meshery Server and Meshery Adapters.Meshery Operator, MeshSync, and Broker
mesheryctl system check - Displays the status of Meshery Operator, MeshSync, and Broker.Based on discussed scenarios, the UI exposes tools to perform the following actions:
Click a Kubernetes connection's row in the Connections table to open its detail view. Below the Operator / MeshSync / Broker status chips, a Diagnostics section lists actionable problems and remediation, derived from the live controller status and Meshery's actual Broker connection:
| Code | Meaning | Remediation |
|---|---|---|
connection_inactive | No active session for the connection yet. | Connect the cluster. |
operator_not_deployed | The Operator is not deployed (operator mode). | Reconnect the cluster, or switch MeshSync mode; ensure Meshery can create resources in the meshery namespace. |
broker_unreachable | The Broker is up but Meshery cannot reach/authenticate to it. | The managed port-forward normally handles reachability out-of-cluster; otherwise port-forward the Broker, expose it via NodePort/LoadBalancer, or run Meshery in-cluster. |
The same data is available at GET /api/system/controllers/diagnostics?connectionId=<id>.
Initiate a synthetic check to verify a fully functional Operator deployment, testing MeshSync/Broker connectivity.
When the CLI and UI clients don't explain why data is missing or stale, inspect the MeshSync pod directly.
Read MeshSync logs (enable debug logging for detail):
kubectl -n meshery logs deploy/meshery-meshsync
# For verbose output, set DEBUG=true on the Deployment and let it restart:
kubectl -n meshery set env deploy/meshery-meshsync DEBUG=true
Check liveness and readiness (MeshSync serves these on port 11000):
kubectl -n meshery port-forward deploy/meshery-meshsync 11000:11000 &
curl -sS http://127.0.0.1:11000/healthz # liveness
curl -sS -o /dev/null -w '%{http_code}\n' http://127.0.0.1:11000/readyz # 200 == connected to Broker
{{% alert color="info" title="What readiness does and does not mean" %}} <code>/readyz</code> returns <code>200</code> once MeshSync has connected to the Broker, <strong>not</strong> once its informer caches have finished priming. Immediately after a (re)start MeshSync may report ready while its cluster snapshot is still filling in. If Meshery shows a partial cluster right after a restart, give discovery a moment or trigger a fresh discovery with <code>kubectl -n meshery rollout restart deploy/meshery-meshsync</code>. {{% /alert %}}
Verify the Broker is reachable from MeshSync. On startup MeshSync runs a connectivity test against the Broker's monitoring endpoint (http://<broker-host>:8222/connz) before opening its NATS client; a failure here appears in the MeshSync logs and blocks readiness. Confirm the BROKER_URL value and that the Broker Service is reachable:
kubectl -n meshery get deploy meshery-meshsync \
-o jsonpath='{.spec.template.spec.containers[0].env[?(@.name=="BROKER_URL")].value}{"\n"}'
caBundle fields), this can cause repeated re-discovery and transient load or gaps. If you observe this, scope discovery with a whitelist (see the [MeshSync configuration FAQ]({{< ref "concepts/architecture/meshsync.md#meshsync-faqs" >}})).secrets.v1., and the Secret objects it forwards to Meshery Server include their data and stringData payload. Those Secret contents are therefore transmitted over the Broker and persisted in the Meshery Database. In security-sensitive environments, either blacklist secrets.v1. (or use a whitelist that omits it) to keep Secrets out of discovery entirely, or set MESHSYNC_REDACT_SECRETS=true on the MeshSync Deployment to keep discovering Secrets while replacing their values with [REDACTED] (keys are preserved). See [Redacting Secret contents]({{< ref "guides/infrastructure-management/configuring-operator-meshsync-broker.md#redacting-secret-contents" >}}).kubectl -n meshery rollout restart deploy/meshery-meshsync or reset the Meshery Database from the UI.{{< related-discussions tag="meshery" >}}