Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

studio: Add page about creating a support bundle #4471

Merged
merged 1 commit into from
Apr 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -706,6 +706,10 @@
{
"label": "502 Service Unavailable",
"slug": "502"
},
{
"label": "Providing data to our support",
"slug": "support-bundle"
}
]
}
Expand Down
39 changes: 39 additions & 0 deletions content/docs/studio/self-hosting/troubleshooting/support-bundle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Providing data to our support

To help you troubleshoot issues with Studio, we may request a support bundle,
which contains Studio's application logs.

This guide will walk you through how to create the support bundle.

## Prerequisites

<toggle>
<tab title="VM (AMI)">

If you've deployed Studio using a VM image, please launch an SSH session to the
instance before continuing.

</tab>

<tab title="Helm">

If you've deployed Studio directly with Helm, please download the
`create-support-bundle` script before continuing.

```cli
$ curl -o create-support-bundle https://raw.githubusercontent.com/iterative/studio-selfhosted/main/packer/create-support-bundle.sh
```

</tab>
</toggle>

## Creating the support bundle

Run the `create-support-bundle` script to create the support bundle ZIP file.

```cli
$ create-support-bundle
```

Copy the ZIP file from `/tmp/studio-support.tar.gz` to your local machine. To do
this, you can use SFTP or rsync.