Generate the VMware Blockchain Orchestrator Support Bundle

If you experience problems with your blockchain transaction, you can generate a VMware Blockchain Orchestrator support bundle for debugging purposes.

For example, the blockchain transaction error might be because one of the containers in the VM became unresponsive, and the transaction is taking a long time to complete. The VMware support team can use your support bundle to determine the source of the problem and provide possible solutions to resolve the error.

Procedure

1. Create a JSON input file.

   You can also reuse the output file specified in the deploymentInfo parameter from a prior provisioning deployment as the JSON input file.

2. To collect support bundle, populate the details of the VMware Blockchain node VMs in the input file.

   A sample JSON input file with VMware Blockchain node VM details.

   {
         "nodes": [
             {
                 "PRIVATE_IP": "10.72.216.84",
                 "NODE_LOGIN": "Bl0ckch@!n"
             },
             {
                 "PRIVATE_IP": "10.72.216.85",
                 "NODE_LOGIN": "Bl0ckch@!n"
             },
             {
                 "PRIVATE_IP": "10.72.216.86",
                 "NODE_LOGIN": "Bl0ckch@!n"
             },
             {
                 "PRIVATE_IP": "10.72.216.87",
                 "NODE_LOGIN": "Bl0ckch@!n"
             },
             {
                 "PRIVATE_IP": "10.72.216.88",
                 "NODE_LOGIN": "Bl0ckch@!n"
             },
             {
                 "PRIVATE_IP": "10.72.216.89",
                 "NODE_LOGIN": "Bl0ckch@!n"
             }
         ]
     }

3. Log in to the VMware Blockchain Orchestrator appliance as a root user.
4. Change directory to /opt/vmware/blockchain/.
5. To generate the VMware Blockchain Orchestrator support bundle, run the python script.

   python3 orchestrator_support_bundle_collector.py --deploymentInfo /root/support-bundle/deployment_info.json --outputDir /root/support-bundle 2>&1 | tee /root/support-bundle/collector.out

   The deploymentInfo parameter is the JSON input file that you created which specifies the root user IP address and password of the VMware Blockchain node VMs. You can provide a JSON output from a prior deployment to this parameter. This parameter is mandatory.

   The outputDir parameter is the directory on the VMware Blockchain Orchestrator appliance. The support bundle information of all the VMware Blockchain node VMs is gathered and saved in this directory.

   This parameter is optional. If the path is specified, the support bundles are saved under the directory/<timestamp> path. The default support bundle output directory path is, /tmp/support-bundle/<timestamp>.

   If a VMware Blockchain node VM is not reachable using SSH, support bundle information for that node is not collected.

   The support bundles are created in the tar.gz format for each VMware Blockchain node VM specified in the JSON input file.

6. Send the newly generated support bundle to the VMware support team.
7. (Optional) As a best practice, delete the support bundle files to maximize your disk space.
   1. Delete the support bundle files from the VMware Blockchain node VM /var/log/deployment_support_logs/daml-logs_<IP-address-timestamp>.tar.gz directory.
   2. Delete the support bundle files from the designated VMware Blockchain Orchestrator appliance output directory.