diff --git a/docs/using/powerpipe/activity.md b/docs/using/powerpipe/activity.md index ce1a557..b018a5e 100644 --- a/docs/using/powerpipe/activity.md +++ b/docs/using/powerpipe/activity.md @@ -5,7 +5,7 @@ sidebar_label: Activity # Activity -The Powerpipe **Activity** tab provides visibility into the Powerpipe scheduled snapshot processes. You can view the status of running and completed processes and view the logs. +The Powerpipe **Activity** tab provides visibility into the Powerpipe scheduled snapshot processes. You can view the status of running and completed processes and view their logs. To view your activity, navigate to your workspace. From the **Pipes** tab, select **Powerpipe**, then go to the **Activity** tab. diff --git a/docs/using/powerpipe/dashboards.md b/docs/using/powerpipe/dashboards.md index e6a5572..79b58d7 100644 --- a/docs/using/powerpipe/dashboards.md +++ b/docs/using/powerpipe/dashboards.md @@ -8,11 +8,11 @@ sidebar_label: Dashboards Once you've added a connection and installed one or more mods into your workspace, the [Dashboards](https://powerpipe.io/docs/run/dashboard) and [Benchmarks](https://powerpipe.io/docs/run/benchmark) will become available for you to run in the -**Dashboards** tab. You can browse the list, or use the powerful search to -filter by name / tag etc. +**Dashboards** tab. You can browse the list or use the powerful search to +filter by name/tag, etc. -Navigate to your workspace, then from the **Pipes** tab choose **Powerpipe**. +Navigate to your workspace, then from the **Pipes** tab, choose **Powerpipe**. ![](/images/docs/pipes/gs_dashboard_list.png) @@ -38,9 +38,9 @@ has finished loading).
-Alternately, you can click the **Share** button to take a snapshot and share a +Alternatively, you can click the **Share** button to take a snapshot and share a link with others. You can set the visibility of the snapshot to restrict access -to only those with access to your workspace, or share it such that anyone on the +to only those with access to your workspace, or share it so that anyone on the internet with the link can view it. @@ -59,10 +59,10 @@ schedule, optionally setting it up with any required inputs and choosing the
-From here you can either choose to create a new schedule, or see any existing +From here, you can either choose to create a new schedule or see any existing schedules that are configured for this dashboard. -If you select **New Schedule** you'll be presented with the following screen. +If you select **New Schedule**, you'll be presented with the following screen.
@@ -81,13 +81,13 @@ If you select **New Schedule** you'll be presented with the following screen. Frequency How often scheduled snapshot should run: Weekly, Daily, Hourly, Custom
- For Weekly, Daily and Hourly frequencies, Turbot Pipes will automatically allocate a random time for these, with Weekly schedules being run at that time on a Sunday. For a Custom frequency, you can supply a cron schedule (not more than once every 15 minutes). + For Weekly, Daily and Hourly frequencies, Turbot Pipes will automatically allocate a random time for these, with Weekly schedules being run at that time on a Sunday. For a Custom frequency, you can supply a cron schedule (not more than once every 15 minutes). Visibility - Optionally choose the visibility of the snapshot generated. By default, visibility is restricted to only those with access to your workspace, but you can choose to share it such that anyone on the internet with the link can view it. + Optionally choose the visibility of the snapshot generated. By default, visibility is restricted to only those with access to your workspace, but you can choose to share it so that anyone on the internet with the link can view it. @@ -110,4 +110,3 @@ link out to the process logs. When the schedule runs, Pipes will upload the snapshot to your workspace as the `system` user, rather than attribute the activity to the user creating the schedule. - diff --git a/docs/using/powerpipe/index.md b/docs/using/powerpipe/index.md index bfe89ae..70eaa49 100644 --- a/docs/using/powerpipe/index.md +++ b/docs/using/powerpipe/index.md @@ -5,8 +5,8 @@ sidebar_label: Powerpipe # Powerpipe -Your workspace includes a hosted [Powerpipe](https://powerpipe.io) server. Powerpipe enables you to visualize your data with dashboards and assess security posture with massive library of benchmarks. +Your workspace includes a hosted [Powerpipe](https://powerpipe.io) server. Powerpipe enables you to visualize your data with dashboards and assess security posture with a massive library of benchmarks. -Once your workspace has been created, your Powerpipe server automatically available. The dashboard server is secured as well; only members of your workspace can view and run dashboards and reports. Your Powerpipe instance can connect to your Steampipe instance automatically; create and attach connections to Steampipe, then install Powerpipe mods to make their dashboards and benchmarks available. +Once your workspace has been created, your Powerpipe server will automatically be available. The dashboard server is secured as well; only members of your workspace can view and run dashboards and reports. Your Powerpipe instance can connect to your Steampipe instance automatically; create and attach connections to Steampipe, then install Powerpipe mods to make their dashboards and benchmarks available. You can take snapshots of your dashboards and benchmarks and share them with others. By default, snapshots are only visible to members of your workspace, but you can create them with public links if you prefer. You can schedule the snapshots to run, automating the creation and publishing of your reports. diff --git a/docs/using/powerpipe/mods.md b/docs/using/powerpipe/mods.md index bf37e00..cf80185 100644 --- a/docs/using/powerpipe/mods.md +++ b/docs/using/powerpipe/mods.md @@ -9,7 +9,7 @@ Your workspace includes a hosted [Powerpipe](https://powerpipe.io/) dashboard se You can manage mods from the **Mods** tab for the Powerpipe service in your workspace. -Navigate to your workspace, then the the **Pipes** tab, and choose **Powerpipe**. The **Mods** tab will list the mods that you have installed, as well as information about the version or branch that is installed. You can type a search string or filter in the search box to filter the list. +Navigate to your workspace, then to the **Pipes** tab, and choose **Powerpipe**. The **Mods** tab will list the mods that you have installed, as well as information about the version or branch that is installed. You can type a search string or filter in the search box to filter the list. ![](/images/docs/pipes/powerpipe/powerpipe_mods_list.png) @@ -28,7 +28,7 @@ in your workspace. To install them, choose one or more mods, then click the **Install Mods** button. Installation should typically only take a few seconds. You can then head over to -the **Dashboards** tab where you'll see a list of the available dashboards for +the **Dashboards** tab, where you'll see a list of the available dashboards for the mod(s) you installed. @@ -42,7 +42,7 @@ You can install custom mods from the **Settings** tab of your workspace. On the Choose the **Integration** that hosts the repo for the mod you wish to install, then select the **Mod Repo** from the dropdown list. -Choose the **Branch or Version Constraint** for the mod. Unlike recommended mods which are only updated once a day, custom mods from integrations are updated in Pipes whenever the source repository is modified. +Choose the **Branch or Version Constraint** for the mod. Unlike recommended mods, which are only updated once a day, custom mods from integrations are updated in Pipes whenever the source repository is modified. When finished, click **Install Mods**. @@ -53,10 +53,10 @@ You can install a mod from *any* public GitHub repo by clicking on **Install fro - The repo must be publicly hosted on GitHub. - There must be at least [one semver tag](https://devhints.io/semver) (not a - pre-release) satisfying the provided semver constraint. + pre-release) satisfying the provided semver constraint. - The tagged version must contain a `mod.pp` or `mod.sp` file at the root of the repo. -Installed mods are updated every day to the latest version satisfied by the +Installed mods are updated every day to the latest version that is satisfied by the semver constraint. The default of `*` means that the latest tagged version will be installed daily. @@ -69,7 +69,7 @@ applicable (if left empty, will default to `*`). When finished, click **Install Installation should typically only take a few seconds. You can then head over to -the **Dashboards** tab where you'll see a list of the available dashboards for +the **Dashboards** tab, where you'll see a list of the available dashboards for the custom mod you installed. @@ -77,7 +77,7 @@ the custom mod you installed. When you install a mod in a workspace, any [variables](https://powerpipe.io/docs/build/mod-variables) that the mod uses will be visible in Turbot Pipes. -From the Powerpipe **Mods** tab, can click the mod you wish to view/manage the variables for. +From the Powerpipe **Mods** tab, you can click the mod you wish to view/manage the variables for. ![](/images/docs/pipes/powerpipe/powerpipe_mod_variables.png) @@ -87,7 +87,7 @@ with a section per variable. You'll see the current value and can edit this and **Save** if you are an owner of the workspace. Depending on the type of the variable, the editor will change, but you'll -typically see either a text, a number or a text/number list editor that will +typically see either a text, a number, or a text/number list editor that will allow you to easily manage the value. Once you've saved a mod variable, this should take effect in your workspace @@ -100,7 +100,7 @@ You can delete a mod from its detail view. From the list of installed mods in th ![](/images/docs/pipes/powerpipe/powerpipe_mod_settings.png) -On the detail screen, scroll to the bottom and click **Uninstall Mod**. Follow the confirmation instructions in the modal and the mod will be uninstalled from your workspace. +On the detail screen, scroll to the bottom and click **Uninstall Mod**. Follow the confirmation instructions in the modal, and the mod will be uninstalled from your workspace. -After this has completed, you'll no longer see any dashboards for this mod in +After this has been completed, you'll no longer see any dashboards for this mod in the **Dashboards** tab. diff --git a/docs/using/powerpipe/snapshots.md b/docs/using/powerpipe/snapshots.md index 2f0ceed..ff3eee8 100644 --- a/docs/using/powerpipe/snapshots.md +++ b/docs/using/powerpipe/snapshots.md @@ -8,7 +8,7 @@ sidebar_label: Snapshots Turbot Pipes allows you to save and share **snapshots** of dashboards and benchmarks. A snapshot is a saved view of a dashboard at a point in time with a given set of inputs and -variables. You can [save](/pipes/docs/using/powerpipe/dashboards#saving-snapshots) and [schedule](/pipes/docs/using/powerpipe/dashboards#scheduling-snapshots) snapshots from a dashboard, or [take snapshots from the Powerpipe CLI](https://powerpipe.io/docs/run/snapshots/batch-snapshots) and upload them to your workspace. +variables. You can [save](/pipes/docs/using/powerpipe/dashboards#saving-snapshots) and [schedule](/pipes/docs/using/powerpipe/dashboards#scheduling-snapshots) snapshots from a dashboard or [take snapshots from the Powerpipe CLI](https://powerpipe.io/docs/run/snapshots/batch-snapshots) and upload them to your workspace. You can manage these snapshots from the **Snapshots** tab for the Powerpipe service in your workspace. @@ -29,7 +29,7 @@ Click on a snapshot title to [view or edit it](#editing-snapshots). ## Sharing Snapshots -When taking a snapshot, you can choose the visibility of the snapshot generated. By default, visibility is restricted to only those with access to your workspace, but you can choose to share it such that anyone on the internet with the link can view it. +When taking a snapshot, you can choose the visibility of the snapshot generated. By default, visibility is restricted to only those with access to your workspace, but you can choose to share it so that anyone on the internet with the link can view it. You can subsequently change the visibility in Pipes in multiple places: - From the Powerpipe **Snapshots** tab for your workspace, click the sharing icon for the snapshot you wish to modify. @@ -54,8 +54,8 @@ To restrict access to workspace members only, click **Delete Shared Link**. ## Editing Snapshots -You can edit a snapshots **Title**, **Tags**, and **Visibility** from the snapshot's properties panel. To view the properties panel: -- From the Powerpipe **Snapshots** tab for your workspace, click the gear icon for the snapshot you wish to modify; or +You can edit a snapshot's **Title**, **Tags**, and **Visibility** from the snapshot's properties panel. To view the properties panel: +- From the Powerpipe **Snapshots** tab for your workspace, click the gear icon for the snapshot you wish to modify or - From a snapshot, click the gear icon at the top right. @@ -70,7 +70,7 @@ You can also **download** or **delete** the snapshot from the properties panel. ## Deleting Snapshots To delete a snapshot, click the trash can icon for the snapshot you wish to delete. -You can also delete the snapshot directly from the snapshot itself. Click the gear icon at the top right to show the the properties panel, then click **Delete Snapshot**. +You can also delete the snapshot directly from the snapshot itself. Click the gear icon at the top right to show the properties panel, then click **Delete Snapshot**. You will be prompted to confirm deletion; click **Delete** to permanently delete the snapshot. @@ -79,7 +79,7 @@ You will be prompted to confirm deletion; click **Delete** to permanently delete To view a list of snapshot schedules, navigate to your workspace. From the **Pipes** tab, select **Powerpipe**, then go to the **Snapshots** tab. -Click the **Scheduled** sub-tab to view a list of all the snapshot schedules in the workspace, including the schedule title, the next run time, last run time, and tags. +Click the **Scheduled** sub-tab to view a list of all the snapshot schedules in the workspace, including the schedule title, the next run time, the last run time, and tags. ![](/images/docs/pipes/powerpipe/powerpipe_snapshot_schedules_list.png) @@ -88,8 +88,8 @@ Click on a schedule title to view or manage the schedule. ![](/images/docs/pipes/powerpipe/powerpipe_snapshot_schedule_detail.png) -From this page, you can edit the schedule **Title**, **Frequency** and **Notifications**, as well as the **Title**, **Tags**, and **Visibility** for the snapshots that it will generate. Click the pencil icon next to the relevant field to edit it. +From this page, you can edit the schedule **Title**, **Frequency**, and **Notifications**, as well as the **Title**, **Tags**, and **Visibility** for the snapshots that it will generate. Click the pencil icon next to the relevant field to edit it. -The status of the last run appears at the top of the page, but you can link to the previous executions as well by clicking **All Runs**. This will take you to the **Activity** page, filtered to show only the process related to this snapshot schedule. +The status of the last run appears at the top of the page, but you can link to the previous executions as well by clicking **All Runs**. This will take you to the **Activity** page, which will be filtered to show only the processes related to this snapshot schedule. -If you want to delete the schedule, click **Delete Scheduled Dashboard**. You will be prompted to confirm deletion. alternatively, can delete the schedule from the list on the **Scheduled** sub-tab by clicking the trashcan icon for the schedule you wish to delete. \ No newline at end of file +If you want to delete the schedule, click **Delete Scheduled Dashboard**. You will be prompted to confirm deletion. Alternatively, can delete the schedule from the list on the **Scheduled** sub-tab by clicking the trashcan icon for the schedule you wish to delete. \ No newline at end of file