You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/vendor/preflight-support-bundle-about.mdx
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,7 +115,9 @@ This section provides an overview of support bundles, including how support bund
115
115
116
116
### Overview
117
117
118
-
Support bundles collect and analyze troubleshooting data from customer environments, helping both users and support teams diagnose problems with application deployments.
118
+
A support bundle is a valuable diagnostic tool that collects and analyzes key troubleshooting data from the customer deployment to enable the end user to self-diagnose and resolve, and when escalating is necessary, it provides the supoprt teams with key necessary information upfront, reducing overall issue resolution time.
119
+
120
+
The data collected in a support bundle depends on the collectors and redactors defined by the Vendor in the support bundle specification included with the application release. When a support bundle process is generated the process collects defined data from the cluster, redacts sensitive fields, and then perform analysis on the data to provide remediation steps. The output is a compressed tar.gz file that can be subsequently shared during a support escalation.
119
121
120
122
Support bundles can collect a variety of important cluster-level data from customer environments, such as:
121
123
* Pod logs
@@ -127,7 +129,14 @@ Support bundles can collect a variety of important cluster-level data from custo
127
129
128
130
Support bundles can also be used for more advanced use cases, such as checking that a command successfully executes in a pod in the cluster, or that an HTTP request returns a succesful response.
129
131
130
-
Support bundles then use the data collected to provide insights to users on potential problems or suggested troubleshooting steps. The troubleshooting data collected and analyzed by support bundles not only helps users to self-resolve issues with their application deployment, but also helps reduce the amount of time required by support teams to resolve requests by ensuring they have access to all the information they need up front.
132
+
Support bundles also include automatic redactions such as:
133
+
* database connection strings
134
+
* passwords
135
+
* AWS credentials
136
+
* API token environment variables in JSON
137
+
* URLs that include usernames and passwords
138
+
139
+
Vendors and end customers can define additional custom redactors to protect sensitive information. Redactors are YAML specifications that define which data to remove when generating a support bundle.
131
140
132
141
### About Host Support Bundles
133
142
@@ -147,5 +156,5 @@ For more information, see [Add and Customize Support Bundles](support-bundle-cus
147
156
148
157
Users generate support bundles as `tar.gz` files from the command line, using the support-bundle kubectl plugin. Your customers can share their support bundles with your team by sending you the resulting `tar.gz` file.
149
158
150
-
KOTS users can also generate and share support bundles from the KOTS Admin Console.
159
+
KOTS and Embedded Cluster users can also generate and share support bundles from the KOTS Admin Console.
151
160
For more information, see [Generate Support Bundles](support-bundle-generating).
0 commit comments