PCDdebugger Utility for PCD Troubleshooting

PCDdebugger

PCDdebugger is a command-line Python script designed to simplify and accelerate the troubleshooting process for PCD Virtualization environments. It automates the collection of diagnostic information for various services and resources, consolidating the output into a structured directory for easy analysis and sharing.

Features

• Comprehensive Data Collection: Gathers detailed information for key PCD resources including VMs (Nova), images (Glance), networks (Neutron), ports, volumes (Cinder), stacks (Heat), and users (Keystone).
• Kubernetes Integration: Performs a complete MySQL dump from a specified Kubernetes namespace, essential for debugging control plane issues.
• Dependency Traversal: Automatically discovers and collects data for resources related to a specified VM, such as its ports, volumes, network, subnets, image, and flavor.
• Organized Output: Saves all collected data into a timestamped directory, with subfolders for each service, making the information easy to navigate.
• Archive Option: Includes a --zip flag to automatically create a compressed archive of the collected data, ready for sharing.

Prerequisites

Before running the script, ensure the following are installed and configured on your machine:

• pcd client: Authenticated and configured to connect to your PCD cloud. (Ensure your rc file is sourced).
• kubectl: Authenticated and configured to connect to your Kubernetes cluster.( This is required only in case of mysql dump)

Installation

1. For Mac-OS:

• Download the binary using below command:

$ curl -LO https://github.com/platform9/PCDDebugger/releases/download/v2.0.1/PCDdebugger-v2.0.1-macos

• Rename the binary file (Optional):

$ mv PCDdebugger-v2.0.1-macos PCDdebugger

• Make the script executable:

$ chmod +x ./PCDdebugger

• To run PCDdebugger from any directory, move it to a location in your system's PATH (Optional)

$ sudo mv PCDdebugger /usr/local/bin/ 

2. For Linux:

• Download the binary using below command:

$ curl -LO https://github.com/platform9/PCDDebugger/releases/download/v2.0.1/PCDdebugger-v2.0.1-linux

• Rename the binary file (Optional):

$ mv PCDdebugger-v2.0.1-linux PCDdebugger

• Make the binary executable:

$ chmod +x PCDdebugger

• To run PCDdebugger from any directory, move it to a location in your system's PATH (Optional):

$ sudo mv PCDdebugger /usr/local/bin/ 

3. For Windows:

• Download the binary using below command:

curl -L https://github.com/platform9/PCDDebugger/releases/download/v2.0.1/PCDdebugger-v2.0.1-windows.exe -o PCDdebugger.exe

• Place it in a Folder: Move the downloaded PCDdebugger.exe file to a memorable location, for example, C:\Tools.

• Add to PATH (Optional): To run the tool from any command prompt, add the folder to system's PATH environment variable.

  1. Search for "Edit the system environment variables" in the Start Menu.
  2. Click the "Environment Variables..." button.
  3. Under "System variables", find and select the Path variable, then click "Edit...".
  4. Click "New" and add the path to folder (e.g., C:\Tools).
  5. Click OK on all windows to save.

• Run PCDdebugger.exe from PowerShell or Command Prompt.

Usage

The basic command structure is:

./PCDdebugger [RESOURCE_FLAG] [OPTIONS] [--insecure]

Examples

• Collect all information for a specific VM: This will gather details of the VM, its ports, volumes, network, subnets, image, and flavor.

./PCDdebugger  --vm <VM_UUID>

• Collect details for a specific Glance image:

./PCDdebugger  --image <IMAGE_UUID>

• Collect details for a Neutron network and its subnets: .

./PCDdebugger  --network <NETWORK_UUID>

• Perform a MySQL dump from a Kubernetes cluster: The --namespace flag is required for this operation.

./PCDdebugger  --mysql-dump --namespace <WORKLOAD_REGION>

• Combine multiple flags and create a zip archive:

./PCDdebugger  --vm <VM_UUID> --mysql-dump --namespace <K8S_NAMESPACE> --zip

• Specify a custom output directory and create a zip archive:

./PCDdebugger  --vm <VM_UUID> --output <PATH_TO_DIRECTORY> --zip

./PCDdebugger --vm aa1bb1cc3-dd4ee5ff6-gg7hh8-ii9jj10kk --output /tmp --zip

Command-Line Flags:

• --vm <ID_OR_NAME>: Collect details for a specific Nova VM and its related resources.
• --image <ID_OR_NAME>: Collect details for a specific Glance image.
• --network <ID_OR_NAME>: Collect details for a specific Neutron network and its subnets.
• --port <ID_OR_NAME>: Collect details for a specific Neutron port.
• --volume <ID_OR_NAME>: Collect details for a specific Cinder volume.
• --stack <ID_OR_NAME>: Collect details for a specific Heat stack.
• --user <ID_OR_NAME>: Collect details for a specific Keystone user.
• --mysql-dump: Perform a MySQL dump of all databases. Requires --namespace.
• --namespace <NAMESPACE>: The Kubernetes namespace to use for the MySQL dump.
• --output <DIRECTORY>: Specify a custom directory for the output files.
• --zip: Compress the final output directory into a .zip file.
• --help: Show the help message and exit.

Additional Information:

For more details, kindly visit the GitHub page: https://github.com/platform9/PCDDebugger