Skip to content

Commit

Permalink
proofead accounts/org
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Oct 25, 2024
1 parent 24f2bd6 commit b9cce47
Show file tree
Hide file tree
Showing 16 changed files with 45 additions and 49 deletions.
2 changes: 1 addition & 1 deletion docs/accounts/developer/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can filter the list of processes using a query filter. Click the **Query**
![](/images/docs/pipes/developer_process_list_filtered.png)


Click on a process to view the process detail page. The process detail page displays the status, which user initiated it, and the full detailed logs with expandable and copyable data where available.
Click on a process to view the process detail page. The process detail page displays the status, the user that initiated it, and the full detailed logs with expandable and copyable data where available.

<!--
![](/images/docs/pipes/process_detail.png)
Expand Down
6 changes: 3 additions & 3 deletions docs/accounts/org/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The **Activity** tab for your organization tab provides visibility into the even

## Audit Log

The **Audit Log** provides a log of API activity associated with your organization including _who_ did _what_ and _when_.
The **Audit Log** provides a log of API activity associated with your organization, including _who_ did _what_ and _when_.

To view the audit log for your organization, navigate to your organization and then to the **Activity** tab. From the left-hand menu, select **Audit Log**.

Expand All @@ -20,7 +20,7 @@ To view the audit log for your organization, navigate to your organization and t
## Processes


Many Turbot Pipes APIs perform tasks asynchronously. These tasks include one-time requests (install a mod into a workspace), and recurring system tasks (update the workspace container image and plugins every week). **Processes** provide visibility into these activities.
Many Turbot Pipes APIs perform tasks asynchronously. These tasks include one-time requests (install a mod into a workspace) and recurring system tasks (update the workspace container image and plugins every week). **Processes** provide visibility into these activities.

To view the processes for your organization, navigate to your organization and then to the **Activity** tab. From the left-hand menu, select **Processes**.

Expand All @@ -35,7 +35,7 @@ You can filter the list of processes using a query filter. Click the **Query**
![](/images/docs/pipes/org_process_list_filtered.png)


Click on a process to view the process detail page. The process detail page displays the status, which user initiated it, and the full detailed logs with expandable and copyable data where available.
Click on a process to view the process detail page. The process detail page displays the status, the user that initiated it, and the full detailed logs with expandable and copyable data where available.

<!--
![](/images/docs/pipes/process_detail.png)
Expand Down
12 changes: 6 additions & 6 deletions docs/accounts/org/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ To manage your organization's advanced settings, click the double arrow button f
On the **Advanced** tab for your organization, click **Org Profile** from the left-hand menu to manage your profile data. You can modify your organization's **Avatar**, **Display Name** or **Handle**.

### Updating Your Avatar
You can modify your organizations's Avatar at any time. Click the avatar image to change it. You can click **Reset** to change back to the default generated image.
You can modify your organization's Avatar at any time. Click the avatar image to change it. You can click **Reset** to change back to the default generated image.


### Changing your Display Name

You can modify display name from the **Org Profile** section. Enter your preferred name and click **Save**
You can modify the display name from the **Org Profile** section. Enter your preferred name and click **Save**


### Updating Your Org Handle
You can update your organization handle at any time. Note, however, that your workspace DNS names all contain your organization handle; changing it will result in changing the DNS name for ALL of your organization's workspaces.
You can update your organization's handle at any time. Note, however, that your workspace DNS names all contain your organization handle; changing it will result in changing the DNS name for ALL of your organization's workspaces.


## Usage
Expand All @@ -36,7 +36,7 @@ left-hand menu to view [usage information](/pipes/docs/accounts/org/usage) for y
The **Billing** page provides visibility into the current state of billing for your organization.

On the **Advanced** tab for your organization, click **Billing** from the
left-hand menu to view [billing information](/pipes/docs/accounts/org/billing) for your organization. The billing page will only available if your organization was purchased on the [Team Plan](/pipes/docs/accounts/org#team-plan).
left-hand menu to view [billing information](/pipes/docs/accounts/org/billing) for your organization. The billing page will only be available if your organization was purchased on the [Team Plan](/pipes/docs/accounts/org#team-plan).



Expand All @@ -45,11 +45,11 @@ left-hand menu to view [billing information](/pipes/docs/accounts/org/billing) f
Once users have been added to your organization, they will be able to
authenticate against it according to the permissions they were granted. They can authenticate using either temporary tokens issued via console or [CLI login](https://steampipe.io/docs/reference/cli/login#steampipe-login), or with [tokens](/pipes/docs/accounts/developer/advanced#tokens) managed via their user profile settings.

If you wish to reset authentication in your organization for any currently issued tokens, you can do so by going to the **Advanced** page for your organization, then clicking **Authentication** from the left-hand menu. Click the
If you wish to reset authentication in your organization for any currently issued tokens, you can do so by going to the **Advanced** page for your organization and then clicking **Authentication** from the left-hand menu. Click the
`Reset authentication` button to reset authentication for all existing
temporary and user tokens.

This will immediately remove console access to the organization for all users, prompting them to log in again. Any users who wish the access your organization via the API will also be required to generate a new user [token](/pipes/docs/accounts/developer/advanced#tokens).
This will immediately remove console access to the organization for all users, prompting them to log in again. Any users who wish to access your organization via the API will also be required to generate a new user [token](/pipes/docs/accounts/developer/advanced#tokens).

<img src="/images/docs/pipes/cloud-organization-reset-authentication.png" width="400pt"/>
<br />
Expand Down
24 changes: 12 additions & 12 deletions docs/accounts/org/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ sidebar_label: Billing

The **Billing** page provides visibility into the current state of billing for your organization.

To manage billing, go to the **Advanced** page for your organization and click **Billing** from the left-hand menu. The billing page will only available if your organization was purchased on the [Team Plan](/pipes/docs/accounts/org#team-plan). If your organization is part of a [tenant](/pipes/docs/accounts/tenant), you can view your bill from the [tenant billing page](/pipes/docs/accounts/tenant/billing).
To manage billing, go to the **Advanced** page for your organization and click **Billing** from the left-hand menu. The billing page will only be available if your organization was purchased on the [Team Plan](/pipes/docs/accounts/org#team-plan). If your organization is part of a [tenant](/pipes/docs/accounts/tenant), you can view your bill from the [tenant billing page](/pipes/docs/accounts/tenant/billing).

<img src="/images/docs/pipes/pipes_billing.png" width="400pt"/>


## Free Trial

When you first enroll in the [Team Plan](/pipes/docs/accounts/org#team-plan) and create an [organization](/pipes/docs/accounts/org), you will be signed up to a 14-day free trial.
When you first enroll in the [Team Plan](/pipes/docs/accounts/org#team-plan) and create an [organization](/pipes/docs/accounts/org), you will be signed up for a 14-day free trial.

During this period, you will have access to all the features of the plan, with 1/2 of the normal included monthly compute minutes.
During this period, you will have access to all the features of the plan, with 1/2 of the normal monthly compute minutes included.

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.

Expand All @@ -30,24 +30,24 @@ If you wish to pay for Pipes using a debit or credit card, you must first enter

This will create a secure connection between your browser and our payment provider. **Please note**: We *never* store your card details on our servers.

At the top of the page you will see a summary of your billing information:
At the top of the page, you will see a summary of your billing information:

- The billing [plan](/pipes/pricing) for this account.
- The dates of the current billing cycle. Billing cycles vary by organization, and may not coincide with a calendar month.
- The dates of the current billing cycle. Billing cycles vary by organization and may not coincide with a calendar month.
- The amount of the last invoice, along with its payment status
- The amount of the next invoice

### Invoices

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.
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 selecting **Download** from the popup menu.

### Cards

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.

### Manage Subscription

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.
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 canceled, all your workspaces will be suspended.

## AWS Marketplace Subscription

Expand All @@ -62,27 +62,27 @@ To do so:
- Review the pricing and terms, then click **View purchase options**.
- Click the **Subscribe** button.
- Click the **Set up your account** button.
- You will be taken to a Turbot Pipes landing page - you may be asked to sign-in again.
- From there, you will be presented with a list of tenants or organizations that you are an [owner](/pipes/docs/people) of.
- You will be taken to a Turbot Pipes landing page, and you may be asked to sign in again.
- From there, you will be presented with a list of tenants or organizations of which you are an [owner](/pipes/docs/people).
- Select the tenant or organization that you wish to subscribe to via AWS Marketplace.
- Click **Set up**.

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.

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.
Once complete, you will be taken back to your dashboard. If you were previously in a tenant or organization trial, the monthly subscription fee will be added to your AWS Marketplace subscription after a short while. 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.

All additional usage will be metered to AWS Marketplace on a daily basis and added to your monthly AWS bill.

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.

### Cancellation

If you wish to cancel your subscription: you can do so at any time by clicking the **Manage Subscription** button on the **Billing** page.
If you wish to cancel your subscription, you can do so at any time by clicking the **Manage Subscription** button on the **Billing** page.

This will take you to your AWS Marketplace subscriptions page. From there:

- Find the `Turbot Pipes - Team Plan` subscription.
- Click **Manage**
- Under `Actions`, select **Cancel Subscription**.

This will initiate the cancellation flow and close out the subscription in Pipes. Once that has completed your workspaces will be suspended.
This will initiate the cancellation flow and close out the subscription in Pipes. Once that has been completed, your workspaces will be suspended.
Loading

0 comments on commit b9cce47

Please sign in to comment.