Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/update on prem checklist #312

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions website/docs/docs/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,23 @@ id: billing
title: Billing and Subscription Management
---

:::info
PactFlow is in the process of migrating customers to the SmartBear Admin system. To determine if you are on the previous system and to find the applicable documentation, consult the following table.
:::

| SmartBear Admin | PactFlow Legacy |
|:---:|:--------------:|
| <img border="1" width="250" src="/ui/plan-widget.png" description="SmartBear Admin Plan Widget" /> | - |
| If you see this item in your top navigation bar, [SmartBear Admin](https://support.smartbear.com/administration/docs/en/administration.html) is enabled on your account. To Administer your account, consult the SmartBear Admin [docs](https://support.smartbear.com/administration/docs/en/administration.html). | You are on PactFlow's legacy subscription management, and this guide applies. |

### Subscription Management

:::note enterprise customers
In case of an enterprise trial upgrade, plan change or other billing related enquiries, contact your Account Manager.

To make changes to your account, provide your **subscription ID** which can be found on the billing page of your account, and the URL you use to access your PactFlow account (for example, **foo.pactflow.io**).
:::

### Subscription Management

PactFlow uses [Chargebee](https://www.chargebee.com/) for subscription and billing management.

You can access our billing dashboard via the "Subscription" menu in the Settings page or directly at https://pactflow.chargebeeportal.com/.
Expand Down
10 changes: 9 additions & 1 deletion website/docs/docs/on-premises/installation/checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,12 @@ Configure the PactFlow On-Premises application in your identity provider. See th
* Ensure the [network](/docs/on-premises/network-configuration) is configured appropriately.
* Ensure the [logs](/docs/on-premises/logging) are forwarded to a log aggregation service.
* Make sure the [license file](/docs/on-premises/license) is mounted into the running containers.
* Ensure you have [load tested](load-testing) the system and have confidence the system can handle your baseline load, and can scale with increased demand
* Ensure you have [load tested](load-testing) the system and have confidence the system can handle your baseline load, and can scale with increased demand.

## 6. Setup database cleaning

Setup [database cleaning](/docs/on-premises/maintenance/database) to ensure optimal PactFlow performance and reliability.

:::warning this step is not optional
Failure to enable database cleaning is likely to result in a gradual decline in system performance and, eventually, query timeouts and system failure.
:::
14 changes: 10 additions & 4 deletions website/docs/docs/user-interface/settings/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,23 @@ To remove a user from PactFlow who will remain in the SSO organization it is rec

## Invite users

_NOTE: You do not need to invite users if your account is setup to authenticate via Google, GitHub or SAML2.0_
:::info Note
Customers on the SmartBear Admin platform must invite users from the SmartBear Admin console (via the "Manage users" button shown here). Consult the [SmartBear Admin docs](https://support.smartbear.com/administration/docs/en/administration.html) for more. For customers not on SmartBear Admin, the following guide applies.

<img src="/ui/clarity/manage-users.png" description="Manage Users" />
:::

Administrators can invite one or more users from the following dialog:

![Invite Users Dialog](/ui/clarity/settings-users-invite.png)

After a successful invitation, the user will receive an email with a temporary password. They will need to login to your account to set a new password before they can login.

This option will create a local user account in the system - it will not create accounts in federated Identity Providers.

_NOTE_: If the user being invited (as identified by their email address) already exists in PactFlow, they **will not** receive another email and can login to your account with their existing credentials.
:::note Considerations:
1. This option will only create a local user account in the system - it will not create accounts in federated Identity Providers.
2. You do not need to invite users if your account is setup to authenticate via Google, GitHub or SAML2.0_
3. If the user being invited (as identified by their email address) already exists in PactFlow, they **will not** receive another email and can login to your account with their existing credentials.
:::

## User roles

Expand Down
Binary file added website/static/ui/clarity/manage-users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/static/ui/plan-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.