nginx-supportpkg-for-k8s

A kubectl plugin designed to collect diagnostics information on any NGINX product running on k8s.

Supported products

Currently, NIC, NGF and NGINX (OSS/NPLUS) in containers are the supported products.

Features

Depending on the product, the plugin might collect some or all of the following global and namespace-specific information:

• k8s version, nodes information and CRDs
• pods logs
• list of pods, events, configmaps, services, deployments, statefulsets, replicasets and leases
• k8s metrics
• helm deployments
• nginx -T output from NGINX pods

The plugin DOES NOT collect secrets or coredumps.

Prerequisites

• Install krew, the plugin manager for kubectl command-line tool, from the official pages
• Run kubectl krew to check the installation
• Run through some of the examples in krew's quickstart guide

Installation

Install from krew

The nginx-supportpkg plugin can be found in the list of kubectl plugins distributed on the centralized krew-index.

To install nginx-supportpkg plugin on your machine:

• Run kubectl krew install nginx-supportpkg

Building from source

Clone the repo and run make install. This will build the binary and copy it on /usr/local/bin/.

Verify that the plugin is properly found by kubectl:

$ kubectl plugin list
The following compatible plugins are available:

/usr/local/bin/kubectl-nginx_supportpkg

Downloading the binary

Navigate to the releases section and download the asset for your operating system and architecture from the most recent version.

Decompress the tarball and copy the binary somewhere in your $PATH. Make sure it is recognized by kubectl:

$ kubectl plugin list
The following compatible plugins are available:

/path/to/plugin/kubectl-nginx_supportpkg

Usage

The plugin is invoked via kubectl nginx-supportpkg and has two required flags:

• -n or --namespace indicates the namespace(s) where the product is running.
• -p or --product indicates the product to collect information from.

Optional flags:

• -u or --upload-to-ihealth uploads the generated support package directly to F5 iHealth.
• -d or --exclude-db-data excludes database data from collection (NIM only).
• -t or --exclude-time-series-data excludes time series data from collection (NIM only).

Basic Usage

$ kubectl nginx-supportpkg -n default -n nginx-ingress-0 -p nic
Running job pod-list... OK
Running job collect-pods-logs... OK
Running job events-list... OK
Running job configmap-list... OK
Running job service-list... OK
Running job deployment-list... OK
Running job statefulset-list... OK
Running job replicaset-list... OK
Running job lease-list... OK
Running job k8s-version... OK
Running job crd-info... OK
Running job nodes-info... OK
Running job metrics-information... OK
Running job helm-info... OK
Running job helm-deployments... OK
Supportpkg successfully generated: nic-supportpkg-1711384966.tar.gz

Upload to F5 iHealth

You can automatically upload the generated support package to F5 iHealth for analysis:

$ kubectl nginx-supportpkg -n nginx-ingress -p nic -u
Attempting to use iHealth Client ID from environment variable
Attempting to use iHealth Client Secret from environment variable
Enter iHealth Client ID: your-client-id
Enter iHealth Client Secret: [hidden]
Running job pod-list... OK
...
Supportpkg successfully generated: nic-supportpkg-1711384966.tar.gz
Uploading support package to iHealth...
Successfully uploaded nic-supportpkg-1711384966.tar.gz to iHealth.
File Name: nic-supportpkg-1711384966.tar.gz
Processing Status: NEW
iHealth Link: https://ihealth2.f5.com/qkview-analyzer/api/...

iHealth Authentication

For iHealth uploads, you need F5 iHealth API credentials. You can provide them in two ways:

Environment Variables (Recommended):

export IHEALTH_CLIENT_ID="your-client-id"
export IHEALTH_CLIENT_SECRET="your-client-secret"
kubectl nginx-supportpkg -n nginx-ingress -p nic -u

Interactive Prompts: If environment variables are not set, the tool will prompt you to enter your credentials interactively. The Client Secret input is hidden for security.

Note: You can obtain iHealth API credentials from the F5 Customer Portal under your account settings. For detailed instructions, see the F5 Knowledge Article K000130498.

The nginx-utils Package

Please refer to its dedicated README.