Skip to content

Commit 1fb28f3

Browse files
karanpopatkaranpopat
authored
add initial docs and images (#1)
1 parent a77f8f7 commit 1fb28f3

File tree

286 files changed

+6974
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

286 files changed

+6974
-0
lines changed

‎.github/workflows/deploy.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Trigger Vercel deploy (prod)
2+
3+
on:
4+
# push:
5+
# branches:
6+
# - main
7+
workflow_dispatch:
8+
jobs:
9+
trigger-vercel-deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Trigger Vercel deploy
13+
run: |
14+
curl -X POST ${{ secrets.VERCEL_DEPLOY_LINK_PROD }}

‎.github/workflows/trigger-turbot-com.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Trigger the pipes preview build in turbot.com
2+
3+
on:
4+
workflow_dispatch:
5+
6+
# push:
7+
# branches-ignore:
8+
# - "main"
9+
10+
# pull_request:
11+
# types: [opened]
12+
13+
env:
14+
PREVIEW_LINK: turbot-com-git-docs-pipes
15+
PREVIEW_DOMAIN: turbot.vercel.app
16+
17+
jobs:
18+
update:
19+
runs-on: ubuntu-latest
20+
if: ${{ github.event_name == 'push' }}
21+
steps:
22+
- name: Repository Dispatch
23+
uses: peter-evans/repository-dispatch@v2
24+
with:
25+
token: ${{ secrets.GH_PAT }}
26+
repository: turbot/turbot.com
27+
event-type: build-pipes-docs-preview
28+
client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}", "ref_name": "${{ github.ref_name }}"}'
29+
30+
comment-link:
31+
runs-on: ubuntu-latest
32+
timeout-minutes: 5
33+
if: ${{ github.event_name == 'pull_request' && github.event.action == 'opened' }}
34+
steps:
35+
36+
- name: Convert head branch special characters to hyphens
37+
id: sanitize_branch
38+
run: |
39+
sanitized_branch=$(echo "${{ github.event.pull_request.head.ref }}" | sed 's/[^a-zA-Z0-9]/-/g')
40+
echo "Sanitized head branch: $sanitized_branch"
41+
echo "::set-output name=sanitized_branch::$sanitized_branch"
42+
43+
- uses: actions/github-script@v7
44+
with:
45+
script: |
46+
github.rest.issues.createComment({
47+
issue_number: context.issue.number,
48+
owner: context.repo.owner,
49+
repo: context.repo.repo,
50+
body: 'Preview link: [https://${{ env.PREVIEW_LINK }}-${{ steps.sanitize_branch.outputs.sanitized_branch }}-${{ env.PREVIEW_DOMAIN }}](https://${{ env.PREVIEW_LINK }}-${{ steps.sanitize_branch.outputs.sanitized_branch }}-${{ env.PREVIEW_DOMAIN }}/)'
51+
})

‎LICENSE

+402
Large diffs are not rendered by default.

‎docs/activity.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Activity
3+
sidebar_label: Activity
4+
---
5+
6+
# Activity
7+
8+
The **Activity** tab provides visibility into the events that occur in your
9+
Turbot Pipes environment.
10+
11+
## Audit Log
12+
13+
The **Audit Log** provides a log of API activity associated with your user,
14+
organization, or workspace, including _who_ did _what_ and _when_.
15+
16+
- To view the audit log for your workspace, click **Audit Log** on the
17+
**Activity** page for the workspace.
18+
- To view the audit log for your user or organization, click **Audit Log** on
19+
the **Settings** page for the user or organization.
20+
21+
<img src="/images/docs/pipes/cloud_audit_log.png" width="400pt"/>
22+
<br />
23+
24+
## DB Logs
25+
26+
Turbot Pipes provides a log of the queries that have been run against your
27+
workspace. To view the query logs, go to the **Activity** tab for your
28+
workspace, then select **DB Log** from the menu on the left.
29+
30+
<img src="/images/docs/pipes/cloud_db_log.png" width="400pt"/>
31+
<br />
32+
33+
## Processes
34+
35+
Many Turbot Pipes APIs perform tasks asynchronously. These tasks include
36+
one-time requests (install a mod into a workspace), recurring system tasks
37+
(update the workspace container image and plugins every week), and
38+
user-scheduled activities (create a snapshot of the AWS CIS v1.5.0 Benchmark
39+
every day). Steampipe **Processes** provide visibility into these activities.
40+
41+
To view your processes, navigate to either your own identity or workspace
42+
**Activity** tab and then to the **Processes** left-nav. Here you'll find a list
43+
of processes with a link to the detail for each.
44+
45+
<img src="/images/docs/pipes/cloud-processes.png" width="400pt"/>
46+
<br />
47+
48+
If you click into a process in the list, you'll see the status, which user
49+
initiated it and where applicable, a link to the pipeline for it.
50+
51+
<img src="/images/docs/pipes/cloud-process-detail.png" width="400pt"/>
52+
<br />
53+
54+
You'll also see detailed logs, with expandable and copyable data where
55+
available.
56+
57+
<img src="/images/docs/pipes/cloud-process-logs.png" width="400pt"/>
58+
<br />

‎docs/aggregators.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Aggregators
3+
sidebar_label: Aggregators
4+
---
5+
6+
7+
# Aggregators
8+
An **[Aggregator](https://steampipe.io/docs/managing/connections#using-aggregators)** allows you to query data from *multiple* connections as if they are a single connection. For example, using aggregators, you can query multiple AWS accounts from a single table. Unlike connections, aggregators cannot be defined at the identity level or shared across workspaces - they can only be created at the workspace level.
9+
10+
When you add a connection to a workspace in Pipes, you will be prompted to create an aggregator if you have 2 or more connections of the plugin type and you don't already have an aggregator.
11+
12+
In the below screenshot we're adding a second `Net` connection to the workspace named `all_net`. By default Pipes will suggest creating an aggregator that targets all `Net` connections in the workspace.
13+
14+
This will mean that as more `Net` connections are added to the workspace, they will automatically be included in the `all_net` aggregator.
15+
16+
<img src="/images/docs/pipes/cloud-connections-create-aggregator.png" width="400pt"/>
17+
<br />
18+
19+
If you don't want to include all connections, you can match using wildcards. In the below screenshot we've added `net*`, which will match all connections that start with `net`. We also allow you to choose from the existing connections in the workspace to target specific ones.
20+
21+
<img src="/images/docs/pipes/cloud-connections-match-aggregator.png" width="400pt"/>
22+
<br />
23+
24+
To access the aggregators, navigate to your workspace and go to **Settings** > **Connections**. You will see a list of connections and aggregators for the workspace. Click on an aggregator to view it. The **Connections** tab will list the connections that are currently included in the aggregator. You can change the matching rules of the aggregator by clicking **Manage connections** and entering your desired connections. We will give you an indication of how many connections have been matched by the proposed config. Once happy, click **Update**.
25+
26+
<img src="/images/docs/pipes/cloud-connections-edit-aggregator.png" width="400pt"/>
27+
<br />
28+
29+
30+
## Adding & Removing Aggregators
31+
32+
33+
You can add and remove connections from the **Settings** tab for your workspace.
34+
Navigate to your workspace, go to the **Settings** tab, then click
35+
**Connections** from the menu on the left to see a list the connections that are
36+
currently attached to the workspace. Click the **Add Connection** button to add
37+
a connection to your workspace. To remove the connection from a workspace, click
38+
the options menu ('three dots' button) to
39+
the right of the connection, select **Remove** from the menu.
40+
41+
Alternatively, you can attach connections to your workspace from the
42+
**Connections** tab for your developer account or organization. Navigate to your user
43+
account or organization, and click **Connections**. You will see a list of
44+
connections. Click on a connection in the list to view it. The **Workspaces**
45+
tab will list the workspaces that are currently using the connection. You can
46+
attach the connection to another workspace with the **Add to Workspace** button.
47+
To remove the connection from a workspace, click the options menu ('three dots' button) to the right of the workspace,
48+
select **Remove** from the menu.
49+
50+

‎docs/billing.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: Billing
3+
sidebar_label: Billing
4+
---
5+
6+
# Billing
7+
8+
The **Billing** page provides visibility into the current state of billing for your identity.
9+
10+
For developers, this will always be free (subject to plan inclusions) with the option to upgrade to a [paid plan](/pipes/docs/billing#developers) to unlock additional usage.
11+
12+
For tenants and organizations, the billing options available to you are:
13+
14+
- [Free trial](/pipes/docs/billing#free-trial)
15+
- [Debit / Credit Card Payment](/pipes/docs/billing#debit--credit-card-payment)
16+
- [AWS Marketplace](/pipes/docs/billing#aws-marketplace-subscription)
17+
18+
To manage billing, go to the **Settings** page for your tenant, organization or developer account and click **Billing** from the left
19+
hand menu.
20+
21+
<img src="/images/docs/pipes/pipes_billing.png" width="400pt"/>
22+
23+
## Developers
24+
25+
For developers, you have the option to upgrade to a paid plan. This will allow you to unlock additional usage, which you will be billed for in arrears on a monthly basis. For more information please see our [pricing FAQs](/pipes/pricing).
26+
27+
To upgrade to a paid plan, first [add a payment card](#debit--credit-card-payment), then click the **Create Subscription** button. You are free to cancel this at any stage by clicking the **Cancel Subscription** button, which will produce a final invoice for the subscription and return you back to the included usage limits.
28+
29+
## Free Trial
30+
31+
When you first create a [tenant](/pipes/docs/enterprise#creating-tenants) or [organization](/pipes/docs/organizations#creating-organizations), you will be signed up to a 14-day free trial.
32+
33+
During this period, you will have access to all the features of the [Enterprise or Team Plan](/pipes/pricing), with 1/2 of the normal included monthly compute minutes.
34+
35+
After or during the trial period, you will need to upgrade to a paid plan to continue using the service. Failure to do so will result in your workspaces being suspended.
36+
37+
After you have added a card, you will automatically be converted to a paid subscription at the end of the trial.
38+
39+
## Debit / Credit Card Payment
40+
41+
If you wish to pay for Pipes using a debit or credit card, you must first enter your card details. To do so, click the **Add Card** button.
42+
43+
<img src="/images/docs/pipes/pipes_billing_add_card.png" width="400pt"/>
44+
45+
This will create a secure connection between your browser and our payment provider. **Please note**: We *never* store your card details on our servers.
46+
47+
At the top of the page you will see a summary of your billing information:
48+
49+
- The billing [plan](/pipes/pricing) for this account.
50+
- The dates of the current billing cycle. Billing cycles vary by tenant/organization/developer, and may not coincide with a calendar month.
51+
- The amount of the last invoice, along with its payment status
52+
- The amount of the next invoice
53+
54+
### Invoices
55+
56+
The invoices table provides a list of previous invoices, including the invoice date, the amount, and the payment status. You can download any of these invoices by clicking the options menu (three vertical dots) at the end of the line and selection **Download** from the popup menu.
57+
58+
### Cards
59+
60+
The cards section lists your active debit/credit cards. One of these cards must be selected as the **default**. The default card is the card that will be billed when subscribed via debit/credit card. Only a non-default card can be removed.
61+
62+
### Manage Subscription
63+
64+
You can cancel the subscription by clicking the **Cancel Subscription** button. The cancellation will occur at the end of the free trial, or the current billing period. Once cancelled this will result in the suspension of all your workspaces.
65+
66+
## AWS Marketplace Subscription
67+
68+
As an alternative to direct card payment, you can choose to pay for your tenant or organization subscription via [AWS Marketplace](https://aws.amazon.com/marketplace).
69+
70+
### Setup
71+
72+
To do so:
73+
74+
- Ensure you are logged into the AWS account that you wish to use to pay for your subscription.
75+
- Navigate to either the [Turbot Pipes - Enterprise Plan](https://aws.amazon.com/marketplace/pp/prodview-oysayoazz5dds) or [Turbot Pipes - Team Plan](https://aws.amazon.com/marketplace/pp/prodview-b3dfz5hxhcn3a) product page.
76+
- Review the pricing and terms, then click **View purchase options**.
77+
- Click the **Subscribe** button.
78+
- Click the **Set up your account** button.
79+
- You will be taken to a Turbot Pipes landing page - you may be asked to sign-in again.
80+
- From there, you will be presented with a list of tenants or organizations that you are an [owner](/pipes/docs/people) of.
81+
- Select the tenant or organization that you wish to subscribe to via AWS Marketplace.
82+
- Click **Set up**.
83+
84+
This will close out any existing debit/credit card subscription you have and generate a final invoice based on additional usage in the current billing cycle.
85+
86+
Once complete you will be taken back to your dashboard. If you were previously in a tenant or organization trial, after a short while the monthly subscription fee will be added to your AWS Marketplace subscription. If you were already on a paid plan you will not be metered for the AWS Marketplace subscription until the date at which your existing debit/credit card plan would have rolled to the next billing cycle.
87+
88+
All additional usage will be metered to AWS Marketplace on a daily basis and added to your monthly AWS bill.
89+
90+
When subscribed via AWS Marketplace, Pipes has no access to the invoices or payment cards associated with your subscription, as these are managed within your subscribing AWS account.
91+
92+
### Cancellation
93+
94+
If you wish to cancel your subscription: you can do so at any time by clicking the **Manage Subscription** button on the **Billing** page.
95+
96+
This will take you to your AWS Marketplace subscriptions page. From there:
97+
98+
- Find the `Turbot Pipes - Team Plan` subscription.
99+
- Click **Manage**
100+
- Under `Actions`, select **Cancel Subscription**.
101+
102+
This will initiate the cancellation flow and close out the subscription in Pipes. Once that has completed your workspaces will be suspended.

‎docs/cloud.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Turbot Pipes
3+
sidebar_label: Pipes
4+
slug: /
5+
---
6+
7+
# Turbot Pipes
8+
9+
## Overview
10+
11+
Turbot Pipes is a fully managed SaaS platform for hosting Steampipe instances.
12+
13+
[Steampipe](https://steampipe.io/) is an open-source cloud intelligence & security platform for DevOps teams that lets you query your cloud services with SQL and create security benchmarks & insight dashboards with HCL.
14+
15+
[Turbot Pipes](https://pipes.turbot.com/) provides a hosted platform for
16+
Steampipe, simplifying setup and operation, accelerating integration, and
17+
providing solutions for collaborating and sharing insights.
18+
19+
- **[Sign Up →](https://pipes.turbot.com/signup)**
20+
- **[Get Started →](/pipes/docs/getting-started)**

0 commit comments

Comments
 (0)