Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
66 lines (43 sloc) 3.29 KB
title layout
Share Errors and Cluster State with Snapshots
docs

As this feature is new and being improved the screenshots here may not exactly match what is currently in the UI. Thanks for understanding!

What is a snapshot?

A snapshot is a link that you can send to someone that will allow them to interactively explore your current Tilt state. This is useful for async debugging and adding context to bug reports. They look like pretty much just like Tilt, but frozen in time:

https://cloud.tilt.dev/snapshot/AYSV59gLhM3GVMuuR28=

A snapshot is a frozen "moment-in-time" version of the Tilt UI. In a snapshot you can drill in to specific services, see alerts and Kubernetes events. Pretty much anything you can do in normal Tilt, you can do in a snapshot!

Sharing Snapshots

If you have upgraded Tilt since Snapshots were released, you'll have a button in the Tilt web UI:

share snapshot

If you click this button a modal will appear.

snapshot modal

If you haven't already connected Tilt to TiltCloud, you'll need to click a couple buttons to create a TiltCloud account:

link to TiltCloud

Once you've done that, just click "Get Link" and you should be presented with a URL that looks something like this: https://cloud.tilt.dev/snapshot/AYSV59gLhM3GVMuuR28=.

Click the button that appeared to see the snapshot. Or you can take the generated link, post it in a Slack channel, bug report or on Twitter so anyone will be able to what you were seeing in Tilt when you ran in to an issue.

Managing Snapshots

You can view and delete all of the snapshots associated with your account on TiltCloud. Go to https://cloud.tilt.dev/snapshots (this is also linked from the bottom of the "Share Snapshot" window). This will display a list of all of your snapshots, with a button to delete the ones you don't want anymore.

snapshots list

FAQ

Q: What data do you store for each snapshot?

For each snapshot we store the entirety of your Tilt's state, including all logs and build history. In addition we store two pieces of metadata: the time that the snapshot was taken and the user, if any, that created it.

Q: How private are snapshots?

A snapshot is accessible to anyone who has the link, which includes an unguessable ID. Providing stricter access control is on our roadmap. If this is important to you, let us know!

Q: My company doesn't allow sharing data with a SaaS. How can I disable snapshots?

Add the disable_snapshots directive to your Tiltfile.

Q: If I delete a snapshot is any data retained?

No. If you delete a snapshot all associated data is removed from the data store. There is no soft delete.

Q: What data do you store when I create a TiltCloud account?

Our database table for users looks like this:

 id |      name      | provider | provider_user_id | provider_user_name
----+----------------+----------+------------------+--------------------
  2 | Mary Miranda   | github   | 1234567          | mmiranda
You can’t perform that action at this time.