Skip to content

Commit

Permalink
add docs for new integrations, tenant and org level connections and f…
Browse files Browse the repository at this point in the history
…olders (WIP)
  • Loading branch information
johnsmyth committed Jul 18, 2024
1 parent 848e11b commit af81691
Show file tree
Hide file tree
Showing 9 changed files with 501 additions and 28 deletions.
45 changes: 36 additions & 9 deletions docs/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,52 @@ sidebar_label: Connections

# Connections

A **[Connection](https://steampipe.io/docs/managing/connections)** represents a set of tables for a **single data source**. In order to query data, you'll need at least one connection, as the other connection types depend on connections to provide credentials and other configuration information. Connections are defined at the identity (developer account or organization) level and then attached to workspaces - they can be shared by multiple workspaces within the account or organization.
A **[Connection](https://steampipe.io/docs/managing/connections)** represents a set of tables for a **single data source**. To query data, you'll need at least one connection, as the other schema types depend on connections to provide credentials and other configuration information.

You can organize connections in **Connection Folders**. This makes it easier to share groups of connections across workspaces in your tenant or organization.

Connections and connection folders may be created at any level of the hierarchy:
- [Tenant-level connections and folders](/pipes/docs/tenants/connections.md) may be shared with any organizations or workspaces in the tenant.
- [Organization-level connections and folders](/pipes/docs/org-connections.md) may be shared with any workspaces in the organization.
- Workspace-level connections and folders may only be used within the workspace in which they are defined; they cannot be shared.



## Managing Connections

You can manage your workspace's connections from the **Advanced** tab. Navigate to your workspace, go to the **Advanced** tab, then click **Connections** from the menu on the left to see a list of the connections that are currently available to the workspace. This list 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.


## Creating Connections

Connections can be created or deleted from the **Connections** tab for your developer account or organization. To add a connection, click **New Connection**, then choose one of the plugins from the list. Enter the required settings for the plugin. Use the **Test Connection** button to verify your credentials, then click **Create**.
You can create workspace-level connections and folders from the **Advanced/Connections** page for your workspace.

After the connection is created, you may associate it with a workspace. Click **Add to Workspace** if you wish to add it to a workspace now, or **Skip** if you don't want to add it to a workspace at this time. Note that the wizard only prompts to add it to a single workspace, but you can attach your connection to additional workspaces at any time.
To create a workspace-level connection, ....
To create a workspace-level connection folder, ....

Worskpace-level connections are confined to the workspace in which they are defined, and they cannot be shared. If you wish to re-use a connection across workspaces, you can create [tenant-level](/pipes/docs/tenants/connections.md) or[organization-level](/pipes/docs/org-connections.md) connections and folders instead, and assign permissions to share them with specific organizations or workspaces. Tenant and organization connections can be created or deleted from the **Connections** tab for your tenant or organization.


## Deleting Connections
You can create connections and folders manually, but they may also be created by [integrations](/pipes/docs/integrations/). For example, the [AWS](/pipes/docs/integrations/aws), [Azure](/pipes/docs/integrations/azure), and [GCP](/pipes/docs/integrations/gcp) integrations create and manage folders and connections automatically to mirror the organizational structure of your cloud provider. You can manage permissions to share these connections and folders just like the ones you create manually, but note that folders that are created by integrations are only managed by the integration; you cannot add or remove sub-folders or connections from them.


## Adding Schemas

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 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 **Advanced/Connections** page for your workspace.

To permanently delete a connection, navigate to the the **Connections** tab for your developer account or organization. From the list, click the connection that you wish to delete. From the properties page for the connection, go to the **Settings** tab and click **Delete Connection**. You will be prompted to confirm deletion; enter the connection name and click **Delete**
To attach an individual connection, ...

Instead of attaching connections individually, you may attach a connection folder. Doing so 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 attach a folder...

## Adding Connections to Workspaces

Once a connection is created, you must add it to any workspaces that you wish to use the connection.

You can add and remove connections from the **Settings** tab for your workspace. Navigate to your workspace, go to the **Settings** tab, then click **Connections** from the menu on the left to see a list the connections that are currently attached to the workspace. Click the **Add Connection** button to add a connection to your workspace. To remove the connection from a workspace, click the options menu ('three dots' button) to the right of the connection, select **Remove** from the menu.
## Removing Schemas
You can remove connection schemas from the **Advanced/Connections** page for your workspace. Simply find the connection or folder in the list and then .......

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
You can delete workspace-level connections from the **Advanced/Connections** page for your workspace. From the list, click the connection that you wish to delete. ...... You will be prompted to confirm deletion; enter the connection name and click **Delete**.

Alternatively, you can attach connections to your workspace from the **Connections** tab for your developer account or organization. Navigate to your developer account or organization, and click **Connections**. You will see a list of connections. Click on a connection in the list to view it. The **Workspaces** tab will list the workspaces that are currently using the connection. You can attach the connection to another workspace with the **Add to Workspace** button. To remove the connection from a workspace, click the options menu ('three dots' button) to the right of the workspace, select **Remove** from the menu.
Tenant and organization connections can be deleted from the **Connections** tab for the corresponding tenant or organization.
2 changes: 1 addition & 1 deletion docs/da-connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ sidebar_label: Connections

A **[Connection](/pipes/docs/connections)** represents a set of tables for a **single data source**. In order to query data, you'll need at least one connection to provide credentials and other configuration information.

You can define connections for your developer account and then attach them to any workspace in the account - they can be shared by multiple workspaces within the account.
Developer accounts are limited to workspace-level connections and folders, which may only be used within the workspace in which they are defined; they cannot be shared. You can [manage your workspace's connections](/pipes/docs/connections#managing-connections) from the **Advanced** tab for your workspace. Navigate to your workspace, go to the **Advanced** tab, then click **Connections** from the menu on the left to see a list of the connections that are currently available to the workspace.
Loading

0 comments on commit af81691

Please sign in to comment.