How to Generate a Support Bundle (Kubernetes)

If it is not already installed, you must install bash shell and yq to generate a Hyperscale support bundle. For more information on downloading yq, refer to yq Downloads page on GitHub.

1. Find the “generate_support_bundle.sh” script

Login to Hyperscale VM for which you want to generate the support bundle.
generate_support_bundle.sh” file is bundled with the helm package file. You can find this script under the tools/ directory(present under the directory, where you will untar the helm package tar file). For example, /path_to_hyperscale_helm/tools/.

Example:

CODE

dlpxuser@delphix:~/test$ cd tools/support-scripts/
dlpxuser@delphix:~/test$ ls -ltr
total 16
-rw-r--r--  1 delphix staff  1032 May  3 13:09 generate_support_bundle.sh
-rw-r--r--  1 delphix  staff    54 May  3 13:12 values-redact.properties

2. Modify the “values-redact.properties”

The values-redact.properties file contains property values (in values.yaml file) which are sensitive and should be redacted before adding them to the support bundle. By default, it includes image repository-related properties. The property name will follow a format like .<rootProperty>.<childProperty>.<innerChildProperty> .

Example:

CODE

.unload.loggingLevelRoot // here we want to redact loggingLevelRoot property of unload

3. Execute the “generate_support_bundle.sh” script

Execute the “generate_support_bundle.sh” script from hyperscale-helm/tools/ directory.

Example:

CODE

delphix@ip-xx-xxx-xxx-xxx:~$ ./hyperscale-helm/tools/generate_support_bundle.sh 
/home/delphix/support/values.yaml created.
.....
Generating support bundle tar file...
.....

4. Find the Generated Support Bundle Tar File

The resulting support bundle (hyperscale-support-****.tar.gz) will be located at the same level where the hyperscale-helm was extracted

Example:

CODE

delphix@ip-10-110-254-92:~$ ls 
hyperscale-helm  hyperscale-helm-9.0.0-6.tgz  hyperscale-support-20230502-14-36-36.tar.gz

The support bundle tar file contains the following information:

Hyperscale Logs
The output of mpstat for CPU utilization info.
The output of proc/meminfo for memory info.
The output of proc/cpuinfo for CPU info.
Files to show the application container's memory limit and the app container's max usage in bytes.
Redacted database file to restore the Hyperscale VM
Redacted values.yaml file