Skip to content

Commit

Permalink
move workspace status, wake,sleep, reboot to steampipe
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Oct 24, 2024
1 parent a198901 commit 7687f1c
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 38 deletions.
47 changes: 45 additions & 2 deletions docs/using/steampipe/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,52 @@ By default, Pipes builds the search path as follows:

Usually, this is the desired order, however you can set a default [search path prefix](https://steampipe.io/docs/guides/search-path#search-path-prefix) if you want to customize the search path

You can set the prefix from the **Advanced** / **Workspace** page for your workspace.
You can set the prefix from the Steampipe **Advanced** / **Status** page for your workspace. Navigate to your workspace, and from the **Pipes** tab, select **Steampipe**. From the Steampipe **Advanced** tab, select **Status** from the left hand menu.

![](/images/docs/pipes/steampipe/steampipe_settings_advanced.png)

![](/images/docs/pipes/pipes_workspace_search_path.png)

The active default search path is displayed. To add or change the prefix, click **edit**, select the schemas from the list, in the order you would like them to appear, then click **Save**.


## Workspace Maintenance

Your workspace may be updated and rebooted during the weekly maintenance window,
Sundays 2:00am - 5:00am EST/EDT. This window is not currently configurable.

During maintenance, your workspaces will be updated to the latest Steampipe
version and the latest plugin versions. At this time, you cannot opt out of the
weekly update.

## Sleeping, Waking, and Rebooting Workspace

After a workspace has been created, it is in the `enabled` state - the workspace's Steampipe database is running and available and any scheduled snapshots will run. If no one accesses the database for 4 days, it will be put to sleep and the status changed to `disabled`. You can wake up (enable) the workspace from the console. Simply click **Wake Up** in the banner that appears at the top of your sleeping workspace.

![](/images/docs/pipes/pipes_workspace_sleeping_banner.png)

<br />

You can also **Wake Up** (enable), **Sleep** (disable) or **Reboot** your workspace from the Steampipe **Advanced** page for your workspace. You can set the prefix from the Steampipe **Advanced** / **Status** page for your workspace. Navigate to your workspace, and from the **Pipes** tab, select **Steampipe**. From the Steampipe **Advanced** tab, select **Status** from the left hand menu.


![](/images/docs/pipes/steampipe/steampipe_advanced_status.png)


<br />

### Workspace States

| State | Description
|-------------|----------------------------
| `creating` | The workspace is being created but is not yet available.
| `enabling` | The workspace database is being started. Pipelines and datatanks are being enabled to run as scheduled.
| `enabled` | The workspace database is running and available in the API and via SQL. Pipelines and datatanks are running as scheduled.
| `disabling` | The workspace database is being shut down . All pipelines and datatanks are being disabled.
| `disabled` | The workspace database is shut down and users cannot access it. All pipelines and datatanks are disabled.
| `deleted` | The workspace has been deleted.


<!--
| `pausing` | The workspace database is running, but all pipelines and datatanks are being paused.
| `paused` ? | [Future??] The workspace database is running, but all pipelines and datatanks are paused.
-->
46 changes: 10 additions & 36 deletions docs/workspaces/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,50 +52,24 @@ workspace at this time.
<br />


## Deleting Workspaces

You can delete a workspace from its **Advanced** tab. From the **Workspaces**
tab for your developer account or organization, click on the workspace you wish to
delete. On the workspace page, go to the **Advanced** tab, select **Workspace**
from the menu on the left, and click **Delete workspace**. You will be prompted
to confirm deletion; enter the workspace name and click **Delete**.



## Workspace Maintenance
## Sleeping, Waking, and Rebooting Workspace

Your workspace may be updated and rebooted during the weekly maintenance window,
Sundays 2:00am - 5:00am EST/EDT. This window is not currently configurable.
After a workspace has been created, it is in the `enabled` state - the workspace's Steampipe database is running and available and any scheduled snapshots will run. If no one accesses the database for 4 days, it will be put to sleep and the status changed to `disabled`. You can wake up (enable) the workspace from the console. Simply click **Wake Up** in the banner that appears at the top of your sleeping workspace.

During maintenance, your workspaces will be updated to the latest Steampipe
version and the latest plugin versions. At this time, you cannot opt out of the
weekly update.
![](/images/docs/pipes/pipes_workspace_sleeping_banner.png)

## Sleeping, Waking, and Rebooting Workspaces

After a workspace has been created, it is in the `enabled` state - the workspace database is running and available and any scheduled pipelines will run. If no one accesses the database for 4 days, the workspace will be put to sleep and the status changed to `disabled`. You can wake up (enable) the workspace from the console. Simply click **Wake Up** in the banner that appears at the top of your sleeping workspace.

<img src="/images/docs/pipes/pipes_workspace_sleeping_banner.png" width="400pt"/>
<br />

You can also **Wake Up** (enable), **Sleep** (disable) or **Reboot** your workspace from the **Advanced** / **Workspace** page for your workspace.
You can also [wake up, sleep, or reboot](/pipes/docs/using/steampipe#sleeping-waking-and-rebooting-workspace) your workspace from the Steampipe **Advanced** page for your workspace.

<img src="/images/docs/pipes/pipes_workspace_settings_advanced.png" width="400pt"/>
<br />

### Workspace States
## Deleting Workspaces

| State | Description
|-------------|----------------------------
| `creating` | The workspace is being created but is not yet available.
| `enabling` | The workspace database is being started. Pipelines and datatanks are being enabled to run as scheduled.
| `enabled` | The workspace database is running and available in the API and via SQL. Pipelines and datatanks are running as scheduled.
| `disabling` | The workspace database is being shut down . All pipelines and datatanks are being disabled.
| `disabled` | The workspace database is shut down and users cannot access it. All pipelines and datatanks are disabled.
| `deleted` | The workspace has been deleted.
You can delete a workspace from its **Advanced** tab. From the **Workspaces**
tab for your developer account or organization, click on the workspace you wish to
delete. On the workspace page, go to the **Advanced** tab, select **Workspace**
from the menu on the left, and click **Delete workspace**. You will be prompted
to confirm deletion; enter the workspace name and click **Delete**.


<!--
| `pausing` | The workspace database is running, but all pipelines and datatanks are being paused.
| `paused` ? | [Future??] The workspace database is running, but all pipelines and datatanks are paused.
-->
Binary file removed images/pipes_workspace_search_path.png
Binary file not shown.
Binary file removed images/pipes_workspace_settings_advanced.png
Binary file not shown.
Binary file modified images/pipes_workspace_sleeping_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.
Binary file added images/steampipe/steampipe_advanced_status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/steampipe/steampipe_settings_advanced.png
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 7687f1c

Please sign in to comment.