Qkview for CWC¶

The purpose of QKView collection is to facilitate collection and packaging of diagnostic information from the cluster, running containers and F5 pods.

This document provides the example commands of QKVview API and steps to upload QKView file to iHealth.

Before You Begin¶

Ensure the CWC is installed and running. Refer to Licensing APIs
Obtain the certificates. Refer to CWC
Refer to API Documentation for information on the JSON and relevant parameters.

QKView REST API commands¶

This table lists the supported actions.

API Command	Action
POST	- Create a new QKView. - Cancel a specific QKView by its unique identifier.
GET	- Retrieve a list of created QKView - Retrieve a specific QKView by its unique identifier - Download the QKView tarball - Retrieve the status of a specific QKView by its unique identifier
DELETE	- Delete a specific QKView by its unique identifier

Sample Commands¶

This section provides the example command to perform each action.

POST command¶

Create a new QKView The below command perfoms HTTPS POST to /v1/qkview for generating an F5 QKView diagnostic tarball, using mutual TLS with the provided client certificate, key, and CA. This request returns a QKView ID, an unique identifier of the qkview.

curl -X POST https://f5-spk-cwc.f5-utils:30881/v1/qkview 
   --cert client_certificate 
   --cacert ca_certificate 
   --key client_keyß

Cancel a specific QKView by its unique identifier

The below command cancels a QKView job by ID, using mutual TLS (client certificate, key, and CA). This cancels the QKView that is in progress.

curl -X POST https://f5-spk-cwc.f5-utils:30881/v1/qkview/{id}/cancel 
   --cert client_certificate 
   --cacert ca_certificate 
   --key client_key

GET command¶

Retrieve a list of created QKView

The below command performs HTTPS GET to /v1/qkview that retrieves available QKView jobs, authenticated via mutual TLS (client certificate, key, and CA).

curl -X GET https://f5-spk-cwc.f5-utils:30881/v1/qkview 
   --cert client_certificate 
   --cacert ca_certificate 
   --key client_key

Retrieve a specific QKView by its unique identifier

The below command performs HTTPS GET to /v1/qkview/{id} to retrieve details for the specified QKView job, authenticated via mutual TLS (client certificate, key, and CA).

curl -X GET https://f5-spk-cwc.f5-utils:30881/v1/qkview/{id} 
  --cert client_certificate 
  --cacert ca_certificate 
  --key client_key

Download the QKView tarball

The below command performs HTTPS GET to /v1/qkview/{id}/download that retrieves the QKView tarball for the specified job, using mutual TLS (client certificate, key, and CA).

curl -X GET https://f5-spk-cwc.f5-utils:30881/v1/qkview/{id}/download 
   --cert client_certificate 
   --cacert ca_certificate 
   --key client_key

Retrieve the status of a specific QKView by its unique identifier

The below command performs HTTPS GET to /v1/qkview/{id}/status that returns the current status (e.g., compelted, warning) of the specified QKView job, authenticated via mutual TLS (client certificate, key, and CA).

curl -X GET https://f5-spk-cwc.f5-utils:30881/v1/qkview/{id}/status 
   --cert client_certificate 
   --cacert ca_certificate 
   --key client_key

DELETE command¶

Delete a specific QKView by its unique identifier

Perform HTTPS DELETE to /v1/qkview/{id} removes the specified QKView job (and its archive, if applicable), using mutual TLS (client certificate, key, and CA).

curl -X DELETE https://f5-spk-cwc.f5-utils:30881/v1/qkview/{id} 
   --cert client_certificate 
   --cacert ca_certificate 
   --key client_key

Uploading the QKView File to iHealth¶

Important

The maximum file size for a QKView diagnostic tarball uploaded to iHealth is 8GB.

If the QKView diagnostic tarball size exceeds 8GB, we recommend users apply the following filtering options available in the QKView API to reduce the file size:

• Limit collection to only the relevant pods instead of the entire cluster.
• Collect only specific logs instead of all container logs.
• Apply log filters (e.g., only error or warning level entries) to avoid collecting unnecessary data.

These filtering options help tailor the QKView output to what’s actually needed, significantly reducing the tarball size. Users should refer to the QKView API documentation to explore and apply these and other options effectively.

To upload the QKView diagnostic tarball to the iHealth website and view the collected diagnostic data, follow the below instructions:

Open your web browser and go to the iHealth website at https://ihealth.f5.com/qkview-analyzer/.
Enter your login credentials to access your iHealth account.
Once logged in, locate and click Upload towards the top left of the page.
Click Choose to open a file selection dialog on your local workstation.
Navigate to the directory where the iHealth_qkview-packaging.tar.gz file is stored.
Select the iHealth_qkview-packaging.tar.gz file and click Open to confirm your selection.
If you have an open support case with F5, locate F5 Support Case (SR) field and enter the case number to associate the uploaded QKView with your support case.
Click Upload QKView(s) to start the upload process. The system will begin uploading the file to the iHealth website.
After the upload completes, the uploaded QKView link will appear at the top of the list on the iHealth page. You can use this link to view the collected diagnostic data.

Previous Next