QKview for Kubernetes¶

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 QKView API.

Permission: Only users with the f5-ops-admin role can execute the qkview command. For details on role permissions,refer Available roles.

F5ops Plugin Commands¶

Command	Description
`kubectl f5ops qkview create`	Triggers a new Qkview diagnostic collection job.
`kubectl f5ops qkview list`	Lists existing Qkview collections
`kubectl f5ops qkview get <id>`	Retrieves metadata for a specific Qkview collection.
`kubectl f5ops qkview status <id>`	Displays the real-time progress of an active collection.
`kubectl f5ops qkview download <id>`	Downloads the completed Qkview `.tar.gz` bundle.
`kubectl f5ops qkview cancel <id> [id...]`	Cancels an ongoing Qkview collection job.
`kubectl f5ops qkview delete <id> [id...]`	Deletes a Qkview collection record and artifact.

Note:: Qkview can be abbreviated to qk

create¶

kubectl f5ops qkview create
kubectl create -f qkview.yaml

apiVersion: ops.f5net.com/v1alpha1
kind: Qkview
spec:
 filename: my-qkview
 namespace: default
 description: manual collection for investigating pod restarts
 timeout: 120s
 preferIPv6: false
 skipDefault: false
 podPatterns:
   - "tmm-*"
   - "sidecar-*"
 coreFiles:
   maxFiles: 2
   filePatterns:
     - "core.*"
   since: 3600s
 logQueries:
   - filePattern: "*.log"
     query: "| logfmt"
 kubeResources:
   - GroupVersionResource:
       group: apps
       version: v1
       resource: deployments
     namePatterns:
       - "*"
     optional: true
 kubePodLogs:
   - podPattern: "tmm-*"
     containerPattern: tmm
     since: 300s
     tail: 100
     previous: true

list¶

kubectl f5ops qkview list
kubectl get qk

get¶

kubectl f5ops qkview get bf7851a3-59bf-4699-b8e5-bc8de12290bc
kubectl get qk bf7851a3-59bf-4699-b8e5-bc8de12290bc

delete¶

Note: A qkview must be completed before deletion. Cancel first if needed.

kubectl f5ops qkview delete bf7851a3-59bf-4699-b8e5-bc8de12290bc
kubectl delete qk bf7851a3-59bf-4699-b8e5-bc8de12290bc \
  7587c0eb-54cb-45b1-acc4-9d232a96fb33

status¶

kubectl f5ops qkview status bf7851a3-59bf-4699-b8e5-bc8de12290bc
kubectl get qk bf7851a3-59bf-4699-b8e5-bc8de12290bc --subresource=status

download¶

kubectl f5ops qkview download bf7851a3-59bf-4699-b8e5-bc8de12290bc \
--file /tmp/my-qkview.tar.gz
kubectl get --raw /apis/ops.f5net.com/v1alpha1/qkviews/bf7851a3-59bf-4699-b8e5-bc8de12290bc/download \
  > my-qkview.tar.gz

cancel¶

kubectl f5ops qkview cancel bf7851a3-59bf-4699-b8e5-bc8de12290bc
kubectl f5ops qkview cancel bf7851a3-59bf-4699-b8e5-bc8de12290bc \
7587c0eb-54cb-45b1-acc4-9d232a96fb33

Previous Next