You can use the Support Bundle feature in NSX to collect log files from Antrea container cluster nodes for detailed troubleshooting and diagnostic purposes.
NSX can upload the support bundles to an NSX Manager node from where you triggered the support bundle collection request, or it can upload the support bundles to a remote file server that you specified in the request. If the support bundles are uploaded to an NSX Manager node, you can download them to your local computer.
- Antrea Controller
- Antrea Agent
- Management Plane Adapter
- Central Control Plane Adapter
- Open vSwitch
- Supported and Unsupported Features
-
- From an NSX Manager node, you can start only a single support bundle collection request. But, you can collect support bundles for multiple Antrea container clusters with a single collection request.
- If you are using an NSX Manager cluster with three Management nodes, you can start a separate support bundle collection request simultaneously from each NSX Manager node. However, the container cluster that you select in each collection request must be different.
For example, assume that you have started a support bundle collection request on NSX Manager node A. In this collection request, you selected container cluster nodes 1 and 2 from container cluster X. Simultaneously, if you start a second collection request on NSX Manager node B for the container cluster nodes 3 and 4 in the container cluster X, one of these two collection requests will fail. You must wait for the first collection request to complete before triggering the second request for the same container cluster.
- Collection of support bundles from NSX Manager Central CLI is currently not supported for Antrea container clusters.
Prerequisites
Antrea container clusters are registered to NSX.
Procedure
Results
A support bundle collection request generates a single tape archive (TAR) file with the following file naming convention: nsx_support_archive_datestamp_timestamp.tar
- If the Antrea NSX Adapter on a container cluster fails when the support bundle request is in progress, the collection of logs fails for that container cluster.
- If the NSX Manager Appliance fails or is not reachable when the support bundle request is in progress, the collection of logs fails. Until the connectivity issue to the NSX Manager is resolved, you can use the native command line tool of Antrea (antctl) to collect log files from the Antrea container clusters.
- Partial Success Scenario
- Consider that you selected 10 nodes from a single Antrea container cluster for the support bundle collection. During the collection process, log files were collected successfully from five nodes in the container cluster, but were not collected for the remaining five nodes. In other words, the collection request succeeded partially. In this situation, the collection request status is Successful and the support bundle file (TAR) contains logs for the five successful nodes.
What to do next
- Extract the TAR file. The following files are displayed.
File Name Description manifest.json This file contains a summary of the collection request results and the properties of the collection request.
For example, it contains information about:- The nodes for which the collection succeeded.
- The nodes for which the collection failed.
- The cluster IDs and node IDs that were used in the collection request.
nsx_antrea_cluster-id.tgz A single .tgz archive file is created for each Antrea container cluster in the support bundle.
- Extract the nsx_antrea_cluster-id.tgz file. The following files are displayed.
File Name Description adapters.tar.gz This archive file contains the log files of the Management Plane Adapter and the Central Control Plane Adapter.
agent_node_name.tar.gz This archive file contains the log files of the Antrea Agent and Open vSwitch. One archive file is generated for each container cluster node in the collection request.
On extracting this archive file, you can view the following files:- agentinfo file
- Agent logs at /logs/agent
- Open vSwitch logs at /logs/ovs
- OpenFlow dump
- IPtables
- Route dump
clusterinfo This file is generated for each container cluster in the support bundle request. The file contains information about the various Kubernetes resources that are collected from the Kubernetes API server, such as Pods, Nodes, Deployments, ReplicaSets, DaemonSets, and so on.
controller.tar.gz This archive file contains the log files of the Antrea Controller.
On extracting this archive file, you can view the following files:- controllerinfo file
- Controller logs at /logs/controller