diff --git a/docs/workspaces/activity.md b/docs/workspaces/activity.md index c4a1861..d28e217 100644 --- a/docs/workspaces/activity.md +++ b/docs/workspaces/activity.md @@ -9,7 +9,7 @@ The **Activity** tab for your workspace tab provides visibility into all events ## Audit Log -The **Audit Log** provides a log of API activity associated with your workspace including _who_ did _what_ and _when_. +The **Audit Log** provides a log of API activity associated with your workspace, including _who_ did _what_ and _when_. To view the audit log for your workspace, navigate to your workspace and then to the **Activity** tab. From the left-hand menu, select **Audit Log**. diff --git a/docs/workspaces/connections.md b/docs/workspaces/connections.md index 9d36b31..78d4bbc 100644 --- a/docs/workspaces/connections.md +++ b/docs/workspaces/connections.md @@ -7,7 +7,7 @@ sidebar_label: Connections At its core, Turbot Pipes is a platform to help you manage **your** stuff, and **Connections** are the way to configure Pipes to interact with your systems and services. -Connections provide the credentials, scope, and configuration information for interacting with an external system. For example, you may create AWS connections and add them as schemas to Steampipe so that you can query your AWS configuration. Flowpipe pipelines can also use these connections, allowing you to perform remediaton actions in those same accounts. +Connections provide the credentials, scope, and configuration information for interacting with an external system. For example, you may create AWS connections and add them as schemas to Steampipe so that you can query your AWS configuration. Flowpipe pipelines can also use these connections, allowing you to perform remediation actions on those same accounts. You can organize connections into **Connection Folders**. This makes it easier to share groups of connections across workspaces in your tenant or organization. @@ -22,13 +22,13 @@ Some [Integrations](/pipes/docs/integrations) can create connections and folders ## Managing Workspace Connections -You can manage your workspace's connections from the **Connections** tab. Navigate to your workspace and then click to the **Connections** tab to see a list of the connections that are currently available to the workspace. +You can manage your workspace's connections from the **Connections** tab. Navigate to your workspace and then click on the **Connections** tab to see a list of the connections that are currently available to the workspace. ![](/images/docs/pipes/pipes_workspace_connections.png) The connections page will show the connections and folders in the workspace, arranged hierarchically, and you can click on folders to navigate the folder tree. -This view will include all the connections that the workspace has permission to use, including tenant-level and organization-level connections and folders, as well as the ones created directly in the workspace. Note that you can add and remove Steampipe schemas for the tenant-level and organization-level connections and folders, but you cannot manage their settings here; The connection properties and folder contents can only be managed on the object where they are defined. Connections and folders that are created by integrations are dynamically managed by the integration and cannot be manually modified. +This view will include all the connections that the workspace has permission to use, including tenant-level and organization-level connections and folders, as well as the ones created directly in the workspace. Note that you can add and remove Steampipe schemas for the tenant-level and organization-level connections and folders, but you cannot manage their settings here; the connection properties and folder contents can only be managed on the object where they are defined. Connections and folders created by integrations are dynamically managed by the integration and cannot be manually modified. ## Creating Connections & Folders @@ -49,7 +49,7 @@ You can create connections and folders manually, but they may also be created by Granting permissions on a connection or folder makes it available for a workspace to use, but it does not automatically add it as a schema to your Steampipe workspace database. After the connection or folder has been created and the permissions have been set, you can add the schema to your workspace from the **Connections** tab for your workspace. -You may add schemas for a single connection or a folder. Adding a folder schema makes the schemas for *all the descendent connections* available as schemas in your workspace database. Your workspace's schemas will remain synchronized when the folder changes; If a connection is subsequently added to the folder, the schema will automatically be added to any workspace that has the folder attached. Likewise, when connections are removed from the folder, the corresponding schemas are removed from the workspace. +You may add schemas for a single connection or a folder. Adding a folder schema makes the schemas for *all the descendent connections* available as schemas in your workspace database. Your workspace's schemas will remain synchronized when the folder changes. If a connection is subsequently added to the folder, the schema will automatically be added to any workspace that has the folder attached. Likewise, when connections are removed from the folder, the corresponding schemas are removed from the workspace. To add a schema, go to the **Connections** tab for your workspace, and navigate to the folder or connection you wish to add, then click **Add to Schema** from the list. @@ -57,7 +57,7 @@ To add a schema, go to the **Connections** tab for your workspace, and navigate ## Removing Schemas You can remove connection schemas from the **Connections** tab for your workspace. Simply find the connection or folder in the list and click **Remove from Schema**. -You may only detach connections or folders at the level from which they were attached. If a connection folder is attached, you cannot detach the connection schemas individually, you must detach the folder. +You may only detach connections or folders at the level from which they were attached. If a connection folder is attached, you cannot detach the connection schemas individually; you must detach the folder. ## Deleting Connections & Folders @@ -66,7 +66,7 @@ You can delete workspace-level connections and folders from the **Connections** ![](/images/docs/pipes/pipes_workspace_connection_advanced.png) -To delete a connection, click the gear icon for the connection that you wish to delete. On the **settings** tab, click **Delete Connection**. You will be prompted to confirm deletion. Enter the connection handle then click **Delete Connection**. +To delete a connection, click the gear icon for the connection that you wish to delete. On the **settings** tab, click **Delete Connection**. You will be prompted to confirm deletion. Enter the connection handle, then click **Delete Connection**. To delete a folder, click the gear icon for the folder that you wish to delete. On the **settings** tab, click **Delete Folder**. You will be prompted to confirm deletion. Enter the folder title, then click **Delete Folder**. diff --git a/docs/workspaces/index.md b/docs/workspaces/index.md index 5b76fef..f7e5efd 100644 --- a/docs/workspaces/index.md +++ b/docs/workspaces/index.md @@ -10,7 +10,7 @@ security, operational, or organizational purposes. Your workspace includes: - A dedicated [Steampipe](/pipes/docs/using/steampipe/) database instance hosted in Turbot Pipes and available via a public Postgres endpoint. You can query the workspace database from the Turbot Pipes web console, run queries or controls from a remote Powerpipe or Steampipe CLI instance, or connect to your workspace from many third-party tools. -- Your own hosted [Powerpipe](/pipes/docs/using/powerpipe/) server, providing secure access to your benchmarks and dashboards from any mod hosted in a public or private Github repository. +- Your own hosted [Powerpipe](/pipes/docs/using/powerpipe/) server, providing secure access to your benchmarks and dashboards from any mod hosted in a public or private GitHub repository. - Your own hosted [Flowpipe](/pipes/docs/using/flowpipe/) server allowing you to run pipelines and set up always-on triggers to run your pipelines automatically on a schedule or in response to events. @@ -27,7 +27,7 @@ your plan. If you are on a paid plan, you may select the **instance type** for your workspace. Select the instance type that meets your capacity, performance, capability, and cost requirements. Each workspace must have a **handle**. The workspace handle is a friendly -identifier for your workspace, and must be unique across your workspaces. You +identifier for your workspace and must be unique across your workspaces. You can change the handle later, but note that the DNS name for your workspace includes the handle. If you change the handle, your workspace's DNS name will also change. Enter a handle for your workspace and click **Create Workspace**. @@ -35,7 +35,7 @@ also change. Enter a handle for your workspace and click **Create Workspace**. If you have no connections defined, you will be prompted to create one. In order to query data, you'll need at least one connection. Click one of the plugins from the list. Enter the required settings for the plugin. You can verify your -credentials using the **Test Connection** button, and then click **Create**. +credentials using the **Test Connection** button and then click **Create**. You will be prompted to add a connection to the workspace that you just created. Select the connection that you wish to add and click **Add to Workspace** if you would like to add a connection to your @@ -55,7 +55,7 @@ workspace at this time. ## 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. +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 will be 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) @@ -66,10 +66,5 @@ You can also [wake up, sleep, or reboot](/pipes/docs/using/steampipe#sleeping-wa ## 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**. - - +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**. diff --git a/docs/workspaces/notifiers.md b/docs/workspaces/notifiers.md index 060ead1..5050915 100644 --- a/docs/workspaces/notifiers.md +++ b/docs/workspaces/notifiers.md @@ -6,11 +6,11 @@ sidebar_label: Notifiers # Notifiers -Pipelines may need to send notification messages or requests for input. You may want to route these notifications to multiple users, groups, or channels, perhaps via more than one delivery mechanism. For instance, you may want to request approval via [Slack](/pipes/docs/integrations/slack) and email. Mods can send these messages to a **notifier**, which provides a way for the mod to send the message in a standard way, without needing to be aware of the details of the particular delivery channels or destinations. +Pipelines may need to send notification messages or requests for input. You may want to route these notifications to multiple users, groups, or channels, perhaps via more than one delivery mechanism. For instance, you may want to request approval via [Slack](/pipes/docs/integrations/slack) and email. Mods can send these messages to a **notifier**, which provides a way for the mod to send the message in a standard way without needing to be aware of the details of the particular delivery channels or destinations. The [notifier](https://flowpipe.io/docs/reference/config-files/notifier) allows you to define a list of [integrations](/pipes/docs/integrations/) to send notifications to. Each notifier contains a list of integrations and related settings used to send and receive data to one or more integrations. -You can manages your workspace's notifiers from the **Notifiers** tab on your workspace. +You can manage your workspace's notifiers from the **Notifiers** tab on your workspace. ![](/images/docs/pipes/notifiers_list.png) @@ -19,8 +19,7 @@ You can manages your workspace's notifiers from the **Notifiers** tab on your wo Many [mods use the default notifier](https://flowpipe.io/docs/reference/config-files/notifier#using-notifiers-in-mods) by default, but allow you to override it via a [variable](https://flowpipe.io/docs/flowpipe-hcl/variable) or [param](https://flowpipe.io/docs/flowpipe-hcl/pipeline#parameters). -Pipes includes a built-in notifier named `workspace_admins` that is configured to send email to the [Workspace Owners](/pipes/docs/workspaces/people). This notifier is configured as the default notifier so that -it works out of the box with no configuration necessary. +Pipes includes a built-in notifier named `workspace_admins` that is configured to send email to the [Workspace Owners](/pipes/docs/workspaces/people). This notifier is configured as the default notifier so that it works out of the box, and no configuration is necessary. If you would prefer to use a different default notifier in your workspace, you can do so; Pipes allows you to mark *any* notifier as the default for your workspace. Navigate to the **Settings** page for the notifier that you would like to use. From the **Workspace precedence** section, click **Set Default**. @@ -30,9 +29,9 @@ Pipes allows you to mark *any* notifier as the default for your workspace. Navi ## Creating a Notifier -You can create notifiers at the [tenant](/pipes/docs/accounts/tenant/notifiers), [organization](/pipes/docs/accounts/org/notifiers), [developer account](/pipes/docs/accounts/developer/notifiers), or workspace. Notifiers that are create in a tenant, organization, or developer account are available in all child workspaces. +You can create notifiers at the [tenant](/pipes/docs/accounts/tenant/notifiers), [organization](/pipes/docs/accounts/org/notifiers), [developer account](/pipes/docs/accounts/developer/notifiers), or workspace. Notifiers that are created in a tenant, organization, or developer account are available in all child workspaces. -To create a notifier, navigate to the **Notifiers** for the tenant, organization, developer account or workspace where you wish to create it, and click **New Notifier** +To create a notifier, navigate to the **Notifiers** for the tenant, organization, developer account, or workspace where you wish to create it, and click **New Notifier** ![](/images/docs/pipes/notifiers_list.png) @@ -44,14 +43,14 @@ Choose the type of target you want to create. ![](/images/docs/pipes/create_notifier_add_target.png) -Enter the details for the target, the click **Create** to create the notifier. +Enter the details for the target, then click **Create** to create the notifier. ![](/images/docs/pipes/create_notifier_add_target_slack.png) ## Modifying a Notifier -Find the notifier from the list on the **Notifiers** tab and click its title or gear icon. From the **Settings** sub-tab, you can edit the notifier's name, or set it as the [default for your workspace](#default-notifier). +Find the notifier from the list on the **Notifiers** tab and click its title or gear icon. From the **Settings** sub-tab, you can edit the notifier's name or set it as the [default for your workspace](#default-notifier). ![](/images/docs/pipes/notifier_settings.png) diff --git a/docs/workspaces/people.md b/docs/workspaces/people.md index 803720e..2fe93cc 100644 --- a/docs/workspaces/people.md +++ b/docs/workspaces/people.md @@ -21,9 +21,9 @@ address or the user handle of an existing user and select a role for the user: | Role | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------- | -| **Reader** | Has full read access to the workspace. | +| **Reader** | Has full read access to the workspace. | | **Operator** | Has full read access to the workspace and can manage snapshots. | -| **Owner** | Has full administrative access to the workspace, aside from adding connections to the workspace which is reserved for org owners. | +| **Owner** | Has full administrative access to the workspace, aside from adding connections to the workspace, which is reserved for org owners. | Click **Add**. The user will receive an email invitation to join the organization. diff --git a/docs/workspaces/pipes.md b/docs/workspaces/pipes.md index a60a49e..fdf22b9 100644 --- a/docs/workspaces/pipes.md +++ b/docs/workspaces/pipes.md @@ -5,7 +5,7 @@ sidebar_label: Pipes # Pipes -The Turbot Pipes platform built provides hosted services for [Steampipe](/pipes/docs/using/steampipe/), [Powerpipe](/pipes/docs/using/powerpipe/), and [Flowpipe](/pipes/docs/using/flowpipe/). +The Turbot Pipes platform provides hosted services for [Steampipe](/pipes/docs/using/steampipe/), [Powerpipe](/pipes/docs/using/powerpipe/), and [Flowpipe](/pipes/docs/using/flowpipe/). To manage a service for your workspace, go to the **Pipes** tab for your workspace and click the service that you would like to manage. diff --git a/docs/workspaces/usage.md b/docs/workspaces/usage.md index 87775d1..bd377f4 100644 --- a/docs/workspaces/usage.md +++ b/docs/workspaces/usage.md @@ -8,11 +8,11 @@ sidebar_label: Usage Pipes provides **Usage** information to help you view and understand your workspace usage, including used storage and compute time. Because Pipes is billed based on your usage, understanding usage is -an essential aspect of managing and optimizing your resources effectively. By monitoring these metrics, you can ensure that your workspace operates efficiently ands cost-effectively. +an essential aspect of managing and optimizing your resources effectively. By monitoring these metrics, you can ensure that your workspace operates efficiently and cost-effectively. -## Viewing Worskpace Usage +## Viewing Workspace Usage You can view your usage from the **Advanced** tab of your workspace.