Repository files navigation

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

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

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.

• Installkrew, the plugin manager for kubectl command-line tool, from theofficial pages
• Runkubectl krew to check the installation
• Run through some of the examples in krew'squickstart guide

Thenginx-supportpkg plugin can be found in the list of kubectl plugins distributed on the centralizedkrew-index.

To installnginx-supportpkg plugin on your machine:

• Runkubectl krew install nginx-supportpkg

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

Verify that the plugin is properly found bykubectl:

$ kubectl plugin listThe following compatible plugins are available:/usr/local/bin/kubectl-nginx_supportpkg

Navigate to thereleases 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 bykubectl:

$ kubectl plugin listThe following compatible plugins are available:/path/to/plugin/kubectl-nginx_supportpkg

The plugin is invoked viakubectl 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.

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