Skip to content

Commit 03313ed

Browse files
authored
Merge pull request #3686 from replicatedhq/support-bundle-diagram
add support bundle diagram
2 parents c59cabe + 0b474cf commit 03313ed

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,17 @@ When it is necessary for the customer to escalate their issue, support bundles p
121121

122122
The data collected in a support bundle depends on the [collectors](#collect) and [redactors](#redact) defined by the vendor in the support bundle spec included with the application release. For more information about the automatic redactions that are made in support bundles, see [Redact](#redact) above. For more information about customizing the data that is collected in support bundles for your application, see [Customizing the Support Bundle Spec For Your Application](#customize) below.
123123

124-
When an end customer generates a support bundle, the process uses the vendor-defined spec to collect data from the cluster, redact sensitive fields, and then perform an analysis on the data to provide remediation steps. The output is a compressed `tar.gz` file that can be shared with the vendor as part of a support escalation. No data is shared outside the cluster unless the `tar.gz` support bundle file is explicitly shared by the end customer. For more information, see [How Customers Generate and Share Support Bundles](#generate-share) below.
124+
When an end customer generates a support bundle, the process uses the vendor-defined spec to collect data from the cluster, redact sensitive fields, and then perform an analysis on the data to provide remediation steps. The output is a compressed `tar.gz` file that can be shared with the vendor as part of a support escalation. For more information, see [How Customers Generate and Share Support Bundles](#generate-share) below.
125+
126+
:::note
127+
No data is shared outside the cluster unless the `tar.gz` support bundle file is explicitly shared by the end customer.
128+
:::
129+
130+
The following diagram demonstrates how end customers can generate support bundles in their installation environment, then upload the bundle to the Enterprise Portal and share it with the vendor. It also shows how, after a support bundle is uploaded and shared, vendors can inspect the bundle from the Vendor Portal **Support bundle analysis** page.
131+
132+
![workflow of generating, uploading, and sharing a support bundle](/images/support-bundle-workflow.png)
133+
134+
[View a larger version of this image](/images/support-bundle-workflow.png)
125135

126136
### About Host Support Bundles
127137

80.1 KB
Loading

0 commit comments

Comments
 (0)