Skip to content

Commit

Permalink
add section about sleeping/waking to cloud/workspace docs
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Jun 12, 2023
1 parent 1699d5f commit 1349629
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions docs/cloud/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,22 +45,33 @@ Click **Add**. The user will receive an email invitation to join the organizati

To remove a user from the organization, select the options menu button (hamburger) to the right of the user and click **Remove**.

## Rebooting and Disabling Workspaces
## Workspace Sleeping

Issues with workspaces are uncommon, but if you ever need to reboot your workspace, you can do so from the **Settings** > **Advanced** tab.

Under the **Workspace Status** section choose the `Reboot` option. This will cycle the workspace, which will cause a brief interruption in service. This typically takes no longer than 30 seconds.
Steampipe Cloud will put workspaces to sleep if they have been inactive for 7 days. When a workspace is sleeping the database is effectively shut down. You will not be able to query the workspace via any means until you wake it again, and all pipelines will be disabled.

You'll also find a **Disable** option there, which will effectively shut down the workspace. This means that all connections to the workspace will be terminated, and you will not be able to query the workspace via any means until you `Enable` it again. All pipelines will also be disabled as part of this change.
Any sleeping workspaces will show a persistent banner at the top of the workspace page as a reminder that the workspace is sleeping.

<img src="/images/docs/cloud/cloud-workspace-state-management.png" width="400pt"/>
<img src="/images/docs/cloud/cloud-workspace-disabled-banner.png" width="400pt"/>
<br />

Any disabled workspaces will show a persistent banner at the top of the workspace page as a reminder that the workspace is not enabled.
To wake up your workspace, click the **Wake Up** button on the banner. Your workspace will be started and available within a few seconds.

<img src="/images/docs/cloud/cloud-workspace-disabled-banner.png" width="400pt"/>
You can also manage your Workspace state from the the **Workspace Status** section in the **Settings** > **Advanced** tab. If your workspace is awake, you can put it to sleep or reboot it:

<img src="/images/docs/cloud/cloud-workspace-state-management-enabled.png" width="400pt"/>
<br />

If your workspace is sleeping, you can wake it:
<img src="/images/docs/cloud/cloud-workspace-state-management-disabled.png" width="400pt"/>
<br />

## Rebooting Workspaces

Issues with workspaces are uncommon, but if you ever need to reboot your workspace, you can do so from the **Settings** > **Advanced** tab.

Under the **Workspace Status** section choose the `Reboot` option. This will cycle the workspace, which will cause a brief interruption in service. This typically takes no longer than 30 seconds.


## Deleting Workspaces

You can delete a workspace from its **Settings** tab. From the **Workspaces** tab for your user account or organization, click on the workspace you wish to delete. On the workspace page, go to the **Settings** tab, select **Advanced** from the menu on the left, and click **Delete workspace**. You will be prompted to confirm deletion; enter the workspace name and click **Delete**.
Expand Down
Binary file modified images/docs/cloud/cloud-workspace-disabled-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1349629

Please sign in to comment.