Skip to content

Commit

Permalink
proofread integrations
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Oct 25, 2024
1 parent 1b69edd commit 0dfe39b
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 32 deletions.
6 changes: 3 additions & 3 deletions docs/connect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can get the Postgres connection string and other database information from t

![](/images/docs/pipes/query-info-connect.png)

The **Database** tab will provide general database connection details - the **Connection String**, **Host**, **Port**, **Database**, **Username** and **Password**. Click on any field to copy it to your clipboard. Note that the password is masked on the screen, but clicking it will add the un-redacted text to your clipboard so that you can paste it into your tool's configuration screen. Individual users can access the database with their credentials, and the information in this view is specific to the logged in user, enabling secure, personalized access.
The **Database** tab will provide general database connection details - the **Connection String**, **Host**, **Port**, **Database**, **Username** and **Password**. Click on any field to copy it to your clipboard. Note that the password is masked on the screen, but clicking it will add the un-redacted text to your clipboard so that you can paste it into your tool's configuration screen. Individual users can access the database with their credentials, and the information in this view is specific to the logged-in user, enabling secure, personalized access.

You can also get specific [Steampipe](https://steampipe.io/) commands from the **Steampipe CLI** tab:

Expand All @@ -28,15 +28,15 @@ Or retrieve the [psql](/pipes/docs/connect/psql) and [pgcli](/pipes/docs/connect



## Examples of Postgres-Compatable Clients
## Examples of Postgres-Compatible Clients
Our community leverages a diverse range of PostgreSQL clients to connect to Turbot Pipes. This flexibility accommodates different workflows, whether you prefer traditional SQL IDEs for database management, BI tools for data analysis and visualization, or [programming languages and SDKs](https://turbot.com/pipes/blog/2024/01/turbot-pipes-as-software-component) for custom integrations.

### SQL IDEs

| Tool | Description |
|------|-------------|
| [Azure Data Studio](https://turbot.com/pipes/docs/connect/azuredatastudio) | Azure Data Studio is a cross-platform database tool for data professionals. |
| [DataGrip](https://turbot.com/pipes/docs/connect/datagrip) | DataGrip is a professional SQL IDE by JetBrains, designed for database developers. |
| [DataGrip](https://turbot.com/pipes/docs/connect/datagrip) | DataGrip is a professional SQL IDE by JetBrains designed for database developers. |
| [DBeaver](https://turbot.com/pipes/docs/connect/dbeaver) | DBeaver is a free, multi-platform database tool for developers and database administrators. |
| [dbt](https://turbot.com/pipes/docs/connect/dbt) | dbt is a transformation tool that enables data analysts and engineers to transform data in their warehouses. |
| [Deepnote](https://turbot.com/pipes/docs/connect/deepnote) | Deepnote is a data science notebook for collaborative projects. |
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Developers

# Developers

Turbot Pipes is built by developers, for developers! It easy to manage your
Turbot Pipes is built by developers, for developers! It's easy to manage your
cloud assets with our [REST API](/pipes/docs/reference/api) or
[Go SDK](/pipes/docs/reference/gosdk), manage your Turbot Pipes infrastructure as code
using our [Terraform provider](/pipes/docs/reference/terraform), or query your
Expand Down
18 changes: 9 additions & 9 deletions docs/develop/query-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@ export PIPES_TOKEN=tpt_c6rnjt8afakemj4gha10_svpnmxqfaketokenad431k

## Query Your Data

The Turbot Pipes API makes it easy query your data and integrate it into your
The Turbot Pipes API makes it easy to query your data and integrate it into your
scripts and applications!

You can issue a simple query with a GET request:

```bash
curl -H "Authorization: Bearer ${PIPES_TOKEN}" \
https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query?sql=select+*+from+aws_s3_bucket
https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query?sql=select+*+from+aws_s3_bucket
```

If you POST you can avoid encoding the SQL:
If you POST, you can avoid encoding the SQL:

```bash
curl -H "Authorization: Bearer ${PIPES_TOKEN}" \
-d 'sql=select name,arn from aws_s3_bucket' \
-d 'sql=select name,arn from aws_s3_bucket' \
https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query
```

Expand All @@ -43,15 +43,15 @@ results in CSV:

```bash
curl -H "Authorization: Bearer ${PIPES_TOKEN}" \
-d sql'=select name,arn from aws_s3_bucket' \
-d sql'=select name,arn from aws_s3_bucket' \
https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query/my-file.csv
```

Or markdown:

```bash
curl -H "Authorization: Bearer ${PIPES_TOKEN}" \
-d sql'=select name,arn from aws_s3_bucket' \
-d sql'=select name,arn from aws_s3_bucket' \
https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query/my-file.md
```

Expand All @@ -60,15 +60,15 @@ parameter:

```bash
curl -H "Authorization: Bearer ${PIPES_TOKEN}" \
-d sql'=select name,arn from aws_s3_bucket' \
-d sql'=select name,arn from aws_s3_bucket' \
https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query?content_type=csv
```

Or via HTTP headers:

```bash
curl -H "Authorization: Bearer ${PIPES_TOKEN}" \
-H "Accept: text/csv" \
-H "Accept: text/csv" \
-X POST -d sql='select name,arn from aws_s3_bucket' \
https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query
https://pipes.turbot.com/api/latest/user/foo/workspace/bar/query
```
10 changes: 5 additions & 5 deletions docs/integrations/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Configure the **Connection settings**.
![](/images/docs/pipes/org-integrations-aws-setup.png)


Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes, or to ensure the uniqueness of the generated connection handles.
Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes or to ensure the uniqueness of the generated connection handles.

Next, set up the trust relationship for the discovered accounts. In order for Pipes to access the discovered accounts, a cross-account role must be created in each discovered account. You can set these roles up manually, or Pipes can generate a CloudFormation StackSet to help automate the process. Depending on your preference, follow the **Automatic Setup** or **Manual Setup** instructions, then enter the **Role Name** and **External ID**. Pipes will dynamically generate the **Role ARN** for each discovered account based on its ID and the provided **Role Name**. Choose the **Regions** that you would like configured in the child connections.

Expand All @@ -72,7 +72,7 @@ These options will be inherited by all connections imported by the integration.
<!-- this is redundant with the screenshot now...
- **Default region**: This region will be used for calls to global APIs. Defaults to us-east-1 for commercial accounts, the closest region to Turbot Pipes, and us-gov-west-1 for GovCloud accounts.
- **Max retry attempts**: The maximum number of attempts (including the initial call) that Turbot Pipes will make for failing API calls. Defaults to 9 and must be greater than or equal to 1.
- **Min error retry delay**: The minimum retry delay in milliseconds after which retries will be performed. Defaults to 25ms and must be greater than or equal to 1ms.
- **Min error retry delay**: The minimum retry delay in milliseconds, after which retries will be performed. Defaults to 25ms and must be greater than or equal to 1ms.
- **Ignore error codes**: List of AWS error codes to ignore for all queries. By default, common not found error codes are ignored and will still be ignored even if this option is not set.
-->

Expand All @@ -86,7 +86,7 @@ Finally, select the [Permissions](/pipes/docs/accounts/tenant/connections#permis
![](/images/docs/pipes/org-integrations-perms.png)


The permissions on this screen apply to the top-level folders and therefore to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered.
The permissions on this screen apply to the top-level folders and, therefore, to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered.

Note also that **All Workspaces** will not only add permissions for the existing organization workspaces but will also allow access for any new workspaces that are created.

Expand All @@ -100,7 +100,7 @@ After you have created an integration, you can change its **Handle**, **Handle P
*Modifying the integration after it has been created will potentially impact any workspaces that use its connections!*
- Changing the **Handle Prefix** will change the handles of all of its connections.
This means that the schema names will change in any workspace to which they are attached. The schema names, in turn, impact the search path and aggregators that use wildcards.
- Discovery of accounts and OUs occurs using the supplied **Credentials**. If changing the credentials affects access to these accounts and OUs that will be reflected in the folders and connections. For example, if the new credentials do not have access to some OUs or accounts that were visible to the previous credentials, then the corresponding folders and connections will be deleted and removed from any workspaces where they are attached.
- Discovery of accounts and OUs occurs using the supplied **Credentials**. If changing the credentials affects access to these accounts and OUs, that will be reflected in the folders and connections. For example, if the new credentials do not have access to some OUs or accounts that were visible to the previous credentials, then the corresponding folders and connections will be deleted and removed from any workspaces where they are attached.

To modify the integration, navigate to the **Integrations** page for the appropriate resource:
- To configure an AWS integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant.
Expand All @@ -109,7 +109,7 @@ To modify the integration, navigate to the **Integrations** page for the appropr

In the list of integrations, click the gear icon next to the integration that you want to modify.

You can change credentials used for discovert in the **Discovery Settings** section of the **Config** tab.
You can change credentials used for discovery in the **Discovery Settings** section of the **Config** tab.
![](/images/docs/pipes/org-integrations-aws-settings-config-discovery.png)

You can also change the **Connection Settings** from the **Config** tab, including the **Handle Prefix**, **Regions**, the connection credentials, and the **Advanced Options**,
Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ Enter the **Azure Credentials**. Pipes requires a Client ID and Client secret w

Enter the **Tenant ID**, **Client ID**, and **Client Secret**.

Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes, or to ensure the uniqueness of the generated connection handles.
Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes or to ensure the uniqueness of the generated connection handles.

Click the **Test Connection** button to verify that the credentials are configured correctly, then click **Next**.

Finally, select the [Permissions](/pipes/docs/accounts/tenant/connections#permissions).

![](/images/docs/pipes/org-integrations-perms.png)

The permissions on this screen apply to the top-level folders and therefore to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered.
The permissions on this screen apply to the top-level folders and, therefore, to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered.

Note also that **All Workspaces** will not only add permissions for the existing organization workspaces but will also allow access for any new workspaces that are created.

Expand All @@ -75,7 +75,7 @@ After you have created an integration, you can change its **Handle**, **Handle P
*Modifying the integration after it has been created will potentially impact any workspaces that use its connections!*
- Changing the **Handle Prefix** will change the handles of all of its connections.
This means that the schema names will change in any workspace to which they are attached. The schema names, in turn, impact the search path and aggregators that use wildcards.
- Discovery of subscriptions and management groups occurs using the supplied **Credentials**. If changing the credentials affects access to these subscriptions and management groups that will be reflected in the folders and connections. For example, if the new credentials do not have access to some management groups or subscriptions that were visible to the previous credentials, then the corresponding folders and connections will be deleted and removed from any workspaces where they are attached.
- Discovery of subscriptions and management groups occurs using the supplied **Credentials**. If changing the credentials affects access to these subscriptions and management groups, that will be reflected in the folders and connections. For example, if the new credentials do not have access to some management groups or subscriptions that were visible to the previous credentials, then the corresponding folders and connections will be deleted and removed from any workspaces where they are attached.

To modify the integration, navigate to the **Integrations** page for the appropriate resource:
- To configure an Azure integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant.
Expand Down
10 changes: 5 additions & 5 deletions docs/integrations/gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ You can create an integration for a [tenant](/pipes/docs/accounts/tenant/) or an


First, navigate to the **Integrations** page for the appropriate resource:
- To configure an GCP integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant.
- To configure an GCP integration for your **Organization**, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the **Integrations** tab to manage the integrations for the organization.
- To configure a GCP integration for your **Tenant**, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select **Tenant Settings**. This option will only be visible in a custom tenant for which you are a [tenant owner](/pipes/docs/accounts/tenant/people#tenant-roles). Once you've selected your tenant, go to the **Integrations** tab to manage the integrations for the tenant.
- To configure a GCP integration for your **Organization**, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the **Integrations** tab to manage the integrations for the organization.


![](/images/docs/pipes/org-integrations-tab.png)
Expand Down Expand Up @@ -52,7 +52,7 @@ Configure the **Connection settings**.

![](/images/docs/pipes/org-integrations-gcp-connection.png)

Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes, or to ensure the uniqueness of the generated connection handles.
Optionally, provide a **Handle Prefix** to be pre-pended to the names of connections created from this integration. This is optional but may be useful for organizational purposes or to ensure the uniqueness of the generated connection handles.

If desired, you can click **Advanced Options** to set default settings for the imported connections. All connections created by the integration will inherit these settings, though you can override them later for each connection if you want.

Expand All @@ -64,7 +64,7 @@ Finally, select the [Permissions](/pipes/docs/accounts/tenant/connections#permis

![](/images/docs/pipes/org-integrations-perms.png)

The permissions on this screen apply to the top-level folders and therefore to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered.
The permissions on this screen apply to the top-level folders and, therefore, to *all connections and folders* discovered by this integration. If you want to assign permissions more granularly, on a per-subfolder or per-connection basis, select **No Permissions** at this time, and then manage the permissions on the connections and folders once they have been discovered.

Note also that **All Workspaces** will not only add permissions for the existing organization workspaces but will also allow access for any new workspaces that are created.

Expand All @@ -85,7 +85,7 @@ To modify the integration, navigate to the **Integrations** page for the appropr

In the list of integrations, click the gear icon next to the integration that you want to modify.

You can change the **Credentials**, **Handle Prefix** or **Advanced Settings** from the **Config** tab.
You can change the **Credentials**, **Handle Prefix**, or **Advanced Settings** from the **Config** tab.

![](/images/docs/pipes/org-integrations-gcp-settings-config.png)

Expand Down
Loading

0 comments on commit 0dfe39b

Please sign in to comment.