Skip to content

Commit 05fc4e2

Browse files
authored
Update preflight-support-bundle-about.mdx
2nd pass
1 parent 8af9949 commit 05fc4e2

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

docs/vendor/preflight-support-bundle-about.mdx

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ During the redact phase, _redactors_ censor sensitive customer information from
3636
- Database connection strings
3737
- URLs that include usernames and passwords
3838

39-
For Replicated KOTS installations, it is also possible to add custom redactors to redact additional data. For more information, see the [Redact](https://troubleshoot.sh/docs/redact/) section in the Troubleshoot documentation.
39+
For Replicated KOTS and Embedded Cluster installations, it is also possible to add custom redactors to redact additional data. For more information, see the [Redact](https://troubleshoot.sh/docs/redact/) section in the Troubleshoot documentation.
4040

4141
### Analyze
4242

@@ -115,9 +115,9 @@ This section provides an overview of support bundles, including how support bund
115115

116116
### Overview
117117

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.
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. Replicated has found that Severity 1 issues are resolved three times faster when a support bundle is provided during an issue escalation.
119119

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.
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. No data is shared outside the cluster unless the resulting tar.gz file is explicitly shared.
121121

122122
Support bundles can collect a variety of important cluster-level data from customer environments, such as:
123123
* Pod logs
@@ -129,14 +129,7 @@ Support bundles can collect a variety of important cluster-level data from custo
129129

130130
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.
131131

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.
132+
See [Redact](### Redact) for automatic redactions in generated support bundles.
140133

141134
### About Host Support Bundles
142135

@@ -152,9 +145,26 @@ To enable support bundles for your application, add a support bundle YAML specif
152145

153146
For more information, see [Add and Customize Support Bundles](support-bundle-customizing).
154147

155-
### Generating Support Bundles
148+
### Generating and Sharing Support Bundles
149+
150+
Users generate support bundles as `tar.gz` files from the command line, using the support-bundle kubectl plugin. Your customers can then share their support bundles with your team by sending you the resulting `tar.gz` file.
151+
152+
Your customer has multiple options to provide you with the generated support bundle. We recommend adivising your customer to use one of the following methods:
153+
* Directly upload and manage their support bundles via their Enterprise Portal. For more information see [Upload and Manage Support Bundles](/vendor/enterprise-portal-use#collect-upload-and-manage-support-bundles).
154+
* KOTS and Embedded Cluster users can also generate and share support bundles from the KOTS Admin Console. For more information, see [Generate Support Bundles](support-bundle-generating).
155+
156+
By providing the support bundle via one of the above methods, the file and its comprehensive analysis results are directly available within the Vendor Portal, saving you the step of of manually uploading the provided file for the purpose of analaysis or sharing with Replicated Support.
157+
158+
The Support Bundle Analysis page includes:
159+
* Analysis Overview: Filterable view showing errors, warnings, and insights
160+
* Instance Reporting Data: Point-in-time information about the instance
161+
* File Inspector: Directory tree browser for examining collected files
162+
* Download Option: Ability to download the bundle for offline analysis
163+
164+
## Sharing Support Bundles with Replicated
165+
166+
167+
168+
156169

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.
158170

159-
KOTS and Embedded Cluster users can also generate and share support bundles from the KOTS Admin Console.
160-
For more information, see [Generate Support Bundles](support-bundle-generating).

0 commit comments

Comments
 (0)