Reporting Bugs

3 minute read

Oh no! You found a bug? We’d love to hear about it.

Product bugs

Search our issue database to see if we already know about your problem and learn about when we think we can fix it. If you don’t find your problem in the database, please open a new issue and let us know what’s going on.

If you think a bug is in fact a security vulnerability, please visit Reporting Security Vulnerabilities to learn what to do.

Kubernetes cluster state archives

If you’re running on Kubernetes, consider including a cluster state archive with your bug report. For convenience, you can run the istioctl bug-report command to produce an archive containing all of the relevant state from your Kubernetes cluster:

$ istioctl bug-report

Then attach the produced bug-report.tgz with your reported problem.

If your mesh spans multiple clusters, run istioctl bug-report against each cluster, specifying the --context or --kubeconfig flags.

If you are unable to use the bug-report command, please attach your own archive containing:

Output of istioctl analyze:
```
$ istioctl analyze --all-namespaces
```

Pods, services, deployments, and endpoints across all namespaces:

$ kubectl get pods,services,deployments,endpoints --all-namespaces -o yaml > k8s_resources.yaml

Secret names in istio-system:

$ kubectl --namespace istio-system get secrets

configmaps in the istio-system namespace:

$ kubectl --namespace istio-system get cm -o yaml

Current and previous logs from all Istio components and sidecars. Here some examples on how to obtain those, please adapt for your environment:

Istiod logs:

$ kubectl logs -n istio-system -l app=istiod

Ingress Gateway logs:

$ kubectl logs -l istio=ingressgateway -n istio-system

Egress Gateway logs:

$ kubectl logs -l istio=egressgateway -n istio-system

Sidecar logs:

$ for ns in $(kubectl get ns -o jsonpath='{.items[*].metadata.name}') ; do kubectl logs -l service.istio.io/canonical-revision -c istio-proxy -n $ns ; done

All Istio configuration artifacts:

$ kubectl get istio-io --all-namespaces -o yaml

Documentation bugs

Search our documentation issue database to see if we already know about your problem and learn about when we think we can fix it. If you don’t find your problem in the database, please report the issue there. If you want to submit a proposed edit to a page, you will find an “Edit this Page on GitHub” link at the bottom right of every page.