Create a Support Package from a Helm Installation
This guide outlines the steps for creating a support package from a Helm installation to aid in troubleshooting error scenarios.
This documentation applies to NGINX Management Suite Instance Manager 2.5.0 and later.
Use the Kubernetes support package script to collect information about your system for troubleshooting and debugging issues.
The script collects system and service information and then packages the data into a tar archive, which you can share with NGINX Customer Support.
Before You Begin
To complete the steps in this guide, you need the following:
bash4.0 or higher
The NGINX Management Suite Helm chart includes the
k8s-support-package.sh script in the following location:
To create a support package from a Helm installation:
Download the latest NGINX Management Suite Helm chart:
helm repo add nginx-stable https://helm.nginx.com/stable helm repo update helm pull nginx-stable/nms tar zxvf nms-<version>.tgz
Run the Kubernetes support package script. See the Arguments section for a list of the available options.
cd nms/charts/nms-hybrid/support-package ./k8s-support-package.sh
The Kubernetes support package is saved in the same location from where you run the script.
To extract the package, use the
tar -xvf k8s-support-pkg-<timestamp>.tar.gz
The following table lists the arguments you can use with the Kubernetes support package script.
||Prints information about the script arguments to
||The output directory where the tar archive is saved.||
||The namespace of the Helm installation.||
||Exclude Dqlite database backup data.||
||Exclude ClickHouse time series data.||
||Include specific modules in Dqlite database backup data.||
The Kubernetes support package includes several directories containing information about the cluster, namespace, application, and database state.
- A log of all output from the
- A snapshot of the Helm chart files in the parent directory (excluding the support-package directory you’re running the script from).
Includes the versions of:
- Helm chart
- NGINX gateway
Includes information for:
- Storage Class
Includes information for:
- General namespace data
- API version
- API services
- API resources
Includes information about the NGINX Management Suite application:
- Persistent Volumes
- Persistent Volume Claims
The logs of the NGINX Management Suite processes, NGINX gateway, and ClickHouse.
The files in the
pod-logs directory are named using the format
For example, the NGINX Management Suite
core service logs are stored in the file
Includes information about the status and state of each pod:
- Operating system version
- Environment variables
- Processes running
The Kubernetes support package script uses a Go executable file named
dqlite-backup (located in
/etc/nms/scripts/ inside applicable NGINX Management Suite containers) to connect to the databases and generate data dumps.
The collected data is saved to the following directories:
If you have specified a module using the
--modules flag, the collected data is saved to the
This folder contains status information, dumps, and statistics for the
nms ClickHouse database. In particular, for metrics and events.