hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-15 17:31:56 +03:00
Code Issues Projects Releases Wiki Activity

docs: update pricing and badges

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7719
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
GitOrigin-RevId: 60a8358fdfa08670f636c0a760eb13da7ecf0546
This commit is contained in:
Rob Dominguez 2023-01-31 17:11:48 -06:00 committed by hasura-bot
parent 2508b35c90
commit f61e1f988f
66 changed files with 567 additions and 475 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/docs/account-management/billing/billing-owner.mdx
View File

@ -1,6 +1,6 @@
---
description: Billing owner on Hasura Cloud
title: 'Cloud: Billing owner'
title: "Cloud: Billing owner"
sidebar_label: Billing owner
keywords:
- hasura
@ -12,12 +12,12 @@ keywords:
sidebar_position: 1
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Billing Owner
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise (Cloud)</div>
## Introduction
@ -31,14 +31,14 @@ responsibility.
Click `Invite a Collaborator` to invite a new collaborator as a billing owner by their email.
<Thumbnail src='/img/account-management/billing/collab-view.png' alt='Collaborators tab' width='1200px' />
<Thumbnail src="/img/account-management/billing/collab-view.png" alt="Collaborators tab" width="1200px" />
Under the `User` collaborator type, select the `Billing Owner` privilege.
<Thumbnail
src='/img/account-management/billing/invite-bm-collab.png'
alt='User Collaborator with Billing Owner Privilege'
width='450px'
src="/img/account-management/billing/invite-bm-collab.png"
alt="User Collaborator with Billing Owner Privilege"
width="450px"
/>
:::info Note
@ -54,7 +54,7 @@ Click on the collaborator you want to invite as a billing owner.
Under the user's existing collaborator type, check the `Billing Owner` privilege and click `Update`.
<Thumbnail src='/img/account-management/billing/add-bm-privilege.png' alt='Add Billing Owner Privilege' width='450px' />
<Thumbnail src="/img/account-management/billing/add-bm-privilege.png" alt="Add Billing Owner Privilege" width="450px" />
## Accept / reject billing owner invitation
@ -62,9 +62,9 @@ You can see the projects that you have been invited to handle billing for on the
either accept or reject them.
<Thumbnail
src='/img/account-management/billing/project-bm-invitation.png'
alt='Projects invited to handle billing for'
width='900px'
src="/img/account-management/billing/project-bm-invitation.png"
alt="Projects invited to handle billing for"
width="900px"
/>
## Remove a billing owner
@ -76,7 +76,7 @@ billing for their project.
To remove a billing owner, click on the billing owner collaborator and then click on the remove icon on the top right:
<Thumbnail src='/img/account-management/billing/remove-bm.png' alt='Remove billing owner collaborator' width='450px' />
<Thumbnail src="/img/account-management/billing/remove-bm.png" alt="Remove billing owner collaborator" width="450px" />
:::info Note
@ -94,17 +94,17 @@ billing for their project.
To remove a collaborator's `Billing Owner` privilege, click on the billing owner collaborator.
<Thumbnail
src='/img/account-management/billing/click-bm-collab.png'
alt='Click billing owner collaborator'
width='1000px'
src="/img/account-management/billing/click-bm-collab.png"
alt="Click billing owner collaborator"
width="1000px"
/>
Remove the `Billing Owner` privilege for that user and click `Update`.
<Thumbnail
src='/img/account-management/billing/remove-bm-privilege.png'
alt='Remove billing owner privilege'
width='450px'
src="/img/account-management/billing/remove-bm-privilege.png"
alt="Remove billing owner privilege"
width="450px"
/>
## Resend billing owner invitation
@ -112,7 +112,7 @@ Remove the `Billing Owner` privilege for that user and click `Update`.
If you have invited a billing owner, you can click on the `Invited` button to resend the invitation.
<Thumbnail
src='/img/account-management/billing/resend-bm-invitation.png'
alt='Resend billing owner invitation'
width='1000px'
src="/img/account-management/billing/resend-bm-invitation.png"
alt="Resend billing owner invitation"
width="1000px"
/>

12
docs/docs/account-management/billing/credits.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura Cloud coupon and credits
title: 'Cloud: Coupons and credits'
title: "Cloud: Coupons and credits"
keywords:
- hasura
- docs
@ -11,12 +11,12 @@ sidebar_position: 3
sidebar_label: Hasura Cloud credits
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Coupons and Credits
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise (Cloud)</div>
## Introduction
@ -34,9 +34,9 @@ Note If there is an active coupon and another coupon is applied, then the later
:::
<Thumbnail src='/img/account-management/billing/coupon_redemption.png' alt='Coupons and Credits' />
<Thumbnail src="/img/account-management/billing/coupon_redemption.png" alt="Coupons and Credits" />
<Thumbnail src='/img/account-management/billing/applied_coupon.png' alt='Applied coupon' />
<Thumbnail src="/img/account-management/billing/applied_coupon.png" alt="Applied coupon" />
## View applied coupon

12
docs/docs/account-management/billing/index.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura Cloud billing
title: 'Cloud: Billing'
title: "Cloud: Billing"
sidebar_label: Hasura Cloud billing
keywords:
- hasura
@ -12,18 +12,18 @@ keywords:
slug: index
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Billing
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise (Cloud)</div>
## Introduction
All Hasura Cloud billing related details can be found under the `Billing` tab in the Hasura Cloud dashboard
<Thumbnail src='/img/account-management/billing/billing.png' alt='Billing' />
<Thumbnail src="/img/account-management/billing/billing.png" alt="Billing" />
## Details
@ -31,4 +31,4 @@ All Hasura Cloud billing related details can be found under the `Billing` tab in
- [Manage payment methods](/account-management/billing/payment-methods.mdx)
- [Coupons and credits](/account-management/billing/credits.mdx)
- [Receipts](/account-management/billing/receipts.mdx)
- [Data usage calculation for billing](/account-management/billing/billing-data-calculation.mdx)
- [Data usage calculation for billing](/account-management/billing/billing-data-calculation.mdx)

26
docs/docs/account-management/billing/payment-methods.mdx
View File

@ -1,6 +1,6 @@
---
description: Manage payment methods
title: 'Cloud: Manage payment methods'
title: "Cloud: Manage payment methods"
sidebar_label: Manage payment methods
keywords:
- hasura
@ -14,12 +14,12 @@ keywords:
sidebar_position: 2
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Manage Payment Methods
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional</div>
## Introduction
@ -29,11 +29,11 @@ You can add one or more cards as a payment method for the upcoming billing cycle
Go to the billing section, and click on `View Cards`.
<Thumbnail src='/img/account-management/billing/manage_cards.png' alt='view saved cards' />
<Thumbnail src="/img/account-management/billing/manage_cards.png" alt="view saved cards" />
Click the `+` sign to add a new card.
<Thumbnail src='/img/account-management/billing/add_new_card.png' alt='add a new card' width='437px' />
<Thumbnail src="/img/account-management/billing/add_new_card.png" alt="add a new card" width="437px" />
After adding appropriate values, click `Save`.
@ -45,22 +45,22 @@ Select the card you want to set as the default payment method or add a new card,
and click `Save`.
<Thumbnail
src='/img/account-management/billing/set_existing_default.png'
alt='set an exiting card as the default card'
width='437px'
src="/img/account-management/billing/set_existing_default.png"
alt="set an exiting card as the default card"
width="437px"
/>
<Thumbnail
src='/img/account-management/billing/set_new_default.png'
alt='Add a new card as the default card'
width='437px'
src="/img/account-management/billing/set_new_default.png"
alt="Add a new card as the default card"
width="437px"
/>
## Delete a card
Select the card you want to delete and click the `Remove Card` option.
<Thumbnail src='/img/account-management/billing/delete_card.png' alt='Delete card' width='437px' />
<Thumbnail src="/img/account-management/billing/delete_card.png" alt="Delete card" width="437px" />
:::info Note

20
docs/docs/account-management/billing/receipts.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura Cloud receipts
title: 'Cloud: Receipts'
title: "Cloud: Receipts"
sidebar_label: Hasura Cloud receipts
keywords:
- hasura
@ -11,12 +11,12 @@ keywords:
sidebar_position: 4
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Receipts
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional</div>
## Introduction
@ -30,14 +30,14 @@ billing email.
Go to the billing section and click on `Invoice Settings`.
<Thumbnail src='/img/account-management/billing/invoice_settings.png' alt='invoice settings' />
<Thumbnail src="/img/account-management/billing/invoice_settings.png" alt="invoice settings" />
Click on `Billing Email` and enter the email you want to receive receipts on.
<Thumbnail
src='/img/account-management/billing/configure_billing_email.png'
alt='configure billing email'
width='437px'
src="/img/account-management/billing/configure_billing_email.png"
alt="configure billing email"
width="437px"
/>
Click `Save`.
@ -48,8 +48,8 @@ For all payments made, receipt will also be mailed to the billing email in addit
Go to the billing section and click on `Invoice Settings`.
<Thumbnail src='/img/account-management/billing/invoice_settings.png' alt='invoice settings' />
<Thumbnail src="/img/account-management/billing/invoice_settings.png" alt="invoice settings" />
Click on `Billing Email` and click `Remove billing email`.
<Thumbnail src='/img/account-management/billing/delete_billing_email.png' alt='delete billing email' width='437px' />
<Thumbnail src="/img/account-management/billing/delete_billing_email.png" alt="delete billing email" width="437px" />

14
docs/docs/account-management/email-change.mdx
View File

@ -1,6 +1,6 @@
---
sidebar_label: Change email
title: 'Cloud: Change email address'
title: "Cloud: Change email address"
description: Hasura Cloud email change
keywords:
- hasura
@ -10,12 +10,12 @@ keywords:
sidebar_position: 10
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Change Email Address
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## Introduction
@ -26,11 +26,11 @@ You can edit the email address on your Hasura Cloud account to another email fro
[Sign in](https://cloud.hasura.io/login?redirect_url=/) to your Hasura Cloud account using email and click `My Account`.
On the `Account Settings` page, select the `Edit` button.
<Thumbnail src='/img/account-management/account-settings-tab.png' alt='Account Management' width='1100px' />
<Thumbnail src="/img/account-management/account-settings-tab.png" alt="Account Management" width="1100px" />
Enter the email you want to transfer the account to and click the `Change` button to send a transfer request.
<Thumbnail src='/img/account-management/edit-email-input.png' alt='edit email section' width='800px' />
<Thumbnail src="/img/account-management/edit-email-input.png" alt="edit email section" width="800px" />
The invitee receives an email verification mail. Once the invitee clicks the link, it logs out the existing user and
redirects the invitee to the Hasura Cloud login page.
@ -42,7 +42,7 @@ The user can now log in to Hasura Cloud using the new email and the password for
If you logged in to Hasura Cloud with your social login, you must reset your password to initiate the email change
process. On the [Sign in](https://cloud.hasura.io/login?redirect_url=/) page, select `Forgot?`.
<Thumbnail src='/img/account-management/forgot-password.png' alt='Forgot password' width='450px' />
<Thumbnail src="/img/account-management/forgot-password.png" alt="Forgot password" width="450px" />
Next, enter the new email id and click **Recover Password**. Set a new password by clicking on the reset password link
sent to your email address.

4
docs/docs/account-management/marketplaces.mdx
View File

@ -1,5 +1,5 @@
---
title: 'Cloud: Marketplaces'
title: "Cloud: Marketplaces"
description: Hasura Cloud Marketplaces
keywords:
- hasura
@ -15,7 +15,7 @@ sidebar_label: Marketplaces
# Marketplaces
<div className="badge badge--primary heading-badge">Available on: Cloud Enterprise</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Cloud)</div>
## Overview

4
docs/docs/actions/open-api.mdx
View File

@ -11,11 +11,11 @@ keywords:
sidebar_class_name: cloud-and-enterprise-icon
---
import Thumbnail from '@site/src/components/Thumbnail';
import Thumbnail from "@site/src/components/Thumbnail";
# Import Action from OpenAPI Spec
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Overview

40
docs/docs/api-reference/metadata-api/api-limits.mdx
View File

@ -3,21 +3,21 @@ sidebar_label: API Limits
sidebar_position: 20
description: Manage API limits configuration with the Hasura metadata API
keywords:
- hasura
- docs
- metadata API
- API reference
- security options
- API limits
- Rate limits
- limits
- enterprise
- ee
- hasura
- docs
- metadata API
- API reference
- security options
- API limits
- Rate limits
- limits
- enterprise
- ee
---
# Metadata API Reference: API Limits
<div className='badge badge--primary heading-badge'>Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Introduction
@ -78,14 +78,14 @@ X-Hasura-Role: admin
### Args syntax {#set-api-limits-syntax}
| Key | Required | Schema | Description |
|-------------|----------|-------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| disabled | false | boolean | Default value is false (Limits are enabled by default) |
| depth_limit | false | [APILimitOption](/api-reference/syntax-defs.mdx#apilimitoption) | Restriction based on its depth, preventing deeply nested queries |
| node_limit | false | [APILimitOption](/api-reference/syntax-defs.mdx#apilimitoption) | Restriction based on the number of nodes in GraphQL operation response |
| time_limit | false | [APILimitOption](/api-reference/syntax-defs.mdx#apilimitoption) | Restricts the time that a GraphQL operation is allowed to take. The duration is specified in seconds |
| batch_limit | false | [APILimitOption](/api-reference/syntax-defs.mdx#apilimitoption) | Restricts the number of GraphQL operations in a batched request |
| rate_limit | false | [RateLimitOption](/api-reference/syntax-defs.mdx#ratelimitoption) | Restricts number of GraphQL operations per minute |
| Key | Required | Schema | Description |
| ----------- | -------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| disabled | false | boolean | Default value is false (Limits are enabled by default) |
| depth_limit | false | [APILimitOption](/api-reference/syntax-defs.mdx#apilimitoption) | Restriction based on its depth, preventing deeply nested queries |
| node_limit | false | [APILimitOption](/api-reference/syntax-defs.mdx#apilimitoption) | Restriction based on the number of nodes in GraphQL operation response |
| time_limit | false | [APILimitOption](/api-reference/syntax-defs.mdx#apilimitoption) | Restricts the time that a GraphQL operation is allowed to take. The duration is specified in seconds |
| batch_limit | false | [APILimitOption](/api-reference/syntax-defs.mdx#apilimitoption) | Restricts the number of GraphQL operations in a batched request |
| rate_limit | false | [RateLimitOption](/api-reference/syntax-defs.mdx#ratelimitoption) | Restricts number of GraphQL operations per minute |
In the above metadata spec:
@ -109,4 +109,4 @@ X-Hasura-Role: admin
{
"type": "remove_api_limit"
}
```
```

48
docs/docs/api-reference/metadata-api/event-triggers.mdx
View File

@ -14,20 +14,18 @@ keywords:
## Introduction
Event Triggers are used to capture database changes and send them to a
configured webhook.
Event Triggers are used to capture database changes and send them to a configured webhook.
:::tip Supported from
The Metadata API is supported for versions `v2.0.0` and above and
replaces the older [schema/Metadata API](/api-reference/schema-metadata-api/index.mdx).
The Metadata API is supported for versions `v2.0.0` and above and replaces the older
[schema/Metadata API](/api-reference/schema-metadata-api/index.mdx).
:::
## pg_create_event_trigger {#metadata-pg-create-event-trigger}
`pg_create_event_trigger` is used to create a new Event Trigger or
replace an existing Event Trigger.
`pg_create_event_trigger` is used to create a new Event Trigger or replace an existing Event Trigger.
```http
POST /v1/metadata HTTP/1.1
@ -135,11 +133,9 @@ X-Hasura-Role: admin
## pg_redeliver_event {#metadata-pg-redeliver-event}
`redeliver_event` is used to redeliver an existing event. For example,
if an event is marked as error ( say it did not succeed after retries),
you can redeliver it using this API. Note that this will reset the count
of retries so far. If the event fails to deliver, it will be retried
automatically according to its `retry_conf`.
`redeliver_event` is used to redeliver an existing event. For example, if an event is marked as error ( say it did not
succeed after retries), you can redeliver it using this API. Note that this will reset the count of retries so far. If
the event fails to deliver, it will be retried automatically according to its `retry_conf`.
```http
POST /v1/metadata HTTP/1.1
@ -191,8 +187,7 @@ X-Hasura-Role: admin
## mssql_create_event_trigger {#metadata-mssql-create-event-trigger}
`mssql_create_event_trigger` is used to create a new Event Trigger or
replace an existing Event Trigger.
`mssql_create_event_trigger` is used to create a new Event Trigger or replace an existing Event Trigger.
```http
POST /v1/metadata HTTP/1.1
@ -293,18 +288,16 @@ X-Hasura-Role: admin
### Args syntax {#metadata-mssql-delete-event-trigger-syntax}
| Key | Required | Schema | Description |
| ------ | -------- | --------------------------------------------------------- | --------------------------------------------------------------- |
| name | true | [TriggerName](/api-reference/syntax-defs.mdx#triggername) | Name of the Event Trigger |
| Key | Required | Schema | Description |
| ------ | -------- | --------------------------------------------------------- | --------------------------------------------------------------------- |
| name | true | [TriggerName](/api-reference/syntax-defs.mdx#triggername) | Name of the Event Trigger |
| source | false | [SourceName](/api-reference/syntax-defs.mdx#sourcename) | Name of the source database of the Event Trigger (default: `default`) |
## mssql_redeliver_event {#metadata-mssql-redeliver-event}
`mssql_redeliver_event` is used to redeliver an existing event. For example,
if an event is marked as error (say it did not succeed after retries),
you can redeliver it using this API. Note that this will reset the count
of retries so far. If the event fails to deliver, it will be retried
automatically according to its `retry_conf`.
`mssql_redeliver_event` is used to redeliver an existing event. For example, if an event is marked as error (say it did
not succeed after retries), you can redeliver it using this API. Note that this will reset the count of retries so far.
If the event fails to deliver, it will be retried automatically according to its `retry_conf`.
```http
POST /v1/metadata HTTP/1.1
@ -354,7 +347,7 @@ X-Hasura-Role: admin
## cleanup_event_trigger_logs {#metadata-cleanup-event-trigger-logs}
<div className="badge badge--primary heading-badge">Available on: Enterprise Edition/Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
`cleanup_event_trigger_logs` is used to manually delete the event logs for a given Event Trigger.
@ -388,7 +381,7 @@ X-Hasura-Role: admin
## resume_event_trigger_cleanups {#metadata-resume-event-trigger-cleanups}
<div className="badge badge--primary heading-badge">Available on: Enterprise Edition/Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise</div>
`resume_event_trigger_cleanups` is used to resume the paused log cleaner for Event Triggers.
@ -418,10 +411,10 @@ X-Hasura-Role: admin
## pause_event_trigger_cleanups {#metadata-pause-event-trigger-cleanups}
<div className="badge badge--primary heading-badge">Available on: Enterprise Edition/Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise</div>
- `pause_event_trigger_cleanups` is used to pause the log cleaner for event
triggers which already have a cleaner installed.
- `pause_event_trigger_cleanups` is used to pause the log cleaner for event triggers which already have a cleaner
installed.
```http
POST /v1/metadata HTTP/1.1
@ -449,6 +442,7 @@ X-Hasura-Role: admin
:::info Note
The start and pause APIs for Event Trigger cleanup work only for Event Triggers that have a cleanup configuration defined.
The start and pause APIs for Event Trigger cleanup work only for Event Triggers that have a cleanup configuration
defined.
:::

11
docs/docs/api-reference/metadata-api/observability.mdx
View File

@ -20,6 +20,8 @@ keywords:
# Metadata API Reference: Observability Options
<div className="badge badge--primary heading-badge">Available on: Community, Cloud, Enterprise</div>
## Introduction
The API to manage `Observability` related metadata configurations.
@ -41,21 +43,20 @@ X-Hasura-Role: admin
{
"type": "set_metrics_config",
"args": {
"analyze_query_variables": false
"analyze_query_variables": false
}
}
```
### Args syntax {#set-metrics-config-syntax}
| Key | Required | Schema | Description |
|-------------------------|----------|-----------|-----------------------------------------------------------------------------------------------------|
| analyze_query_variables | false | boolean | Enables logging of the values of the query variables provided for each request. Default is `false`. |
| Key | Required | Schema | Description |
| ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| analyze_query_variables | false | boolean | Enables logging of the values of the query variables provided for each request. Default is `false`. |
Please see the corresponding
[feature documentation for the usage of these configurations](/observability/operations.mdx#capture-query-variables).
## remove_metrics_config {#metadata-remove-metrics-config}
`remove_metrics_config` is used to remove all metrics configurations.

12
docs/docs/api-reference/metadata-api/table-view.mdx
View File

@ -274,7 +274,7 @@ Setting `apollo_federation_config` to `null` will disable Apollo Federation supp
## pg_test_connection_template {#metadata-pg-test-connection-template}
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
`pg_test_connection_template` allows you to test the connection template set for a source.
@ -308,14 +308,14 @@ X-Hasura-Role: admin
### Args syntax {#metadata-pg-test-connection-template-syntax}
| Key | Required | Schema | Description |
|--------------------------|----------|---------------------------------------------------------------------------------|---------------------------------------------------------------|
| source_name | false | [SourceName](/api-reference/syntax-defs.mdx#sourcename) | Name of the source database of the table (default: `default`) |
| request_context | true | [RequestContext](/api-reference/syntax-defs.mdx#requestcontext) | Request context |
| Key | Required | Schema | Description |
| --------------- | -------- | --------------------------------------------------------------- | ------------------------------------------------------------- |
| source_name | false | [SourceName](/api-reference/syntax-defs.mdx#sourcename) | Name of the source database of the table (default: `default`) |
| request_context | true | [RequestContext](/api-reference/syntax-defs.mdx#requestcontext) | Request context |
:::info Enterprise only
Connection template feature is an enterprise edition only feature.
Connection template feature is an enterprise edition only feature.
:::

2
docs/docs/api-reference/source-health.mdx
View File

@ -14,7 +14,7 @@ sidebar_class_name: cloud-icon
# Source Health Check API Reference
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Introduction

25
docs/docs/databases/connect-db/cloud-connection-pooling.mdx
View File

@ -1,6 +1,6 @@
---
description: Managing connection pools in Hasura Cloud
title: 'Cloud: Elastic connection pools'
title: "Cloud: Elastic connection pools"
keywords:
- hasura
- docs
@ -14,13 +14,13 @@ sidebar_position: 2
sidebar_class_name: cloud-icon
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Thumbnail from "@site/src/components/Thumbnail";
# Elastic Connection Pools
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise (Cloud)</div>
## Introduction
@ -56,7 +56,8 @@ project can be calculated as `number of server instances * max_connections`
<TabItem value="console" label="Console">
While adding a new database, under `Connection Settings`, set the desired `Total Max Connections` for primary and read
replica pools. To set or update `total_max_connections` for existing sources, head to the `Data > Databases > Manage > [database-name] > Edit` page and scroll down to the `Connection Settings` section.
replica pools. To set or update `total_max_connections` for existing sources, head to the
`Data > Databases > Manage > [database-name] > Edit` page and scroll down to the `Connection Settings` section.
<Thumbnail src="/img/databases/total-max-connections.png" alt="Total max connections" max-width="543px" />
@ -78,7 +79,7 @@ directory as per this example:
isolation_level: read-committed
pool_settings:
total_max_connections: 60
tables: '!include default/tables/tables.yaml'
tables: "!include default/tables/tables.yaml"
```
Apply the Metadata using the CLI by running:
@ -158,13 +159,13 @@ X-Hasura-Role: admin
## How connection pooling works
A connection pool starts off empty and as new requests arrive, a connection to the database is established. This connection
stays warm in the pool to be reused by any other waiting request. This ensures that subsequent requests do not have to
reestablish a database connection hence saving time and resources.
A connection pool starts off empty and as new requests arrive, a connection to the database is established. This
connection stays warm in the pool to be reused by any other waiting request. This ensures that subsequent requests do
not have to reestablish a database connection hence saving time and resources.
After a certain period of connection idleness (specified by `idle_timeout`) or connection lifetime (specified by
`connection_lifetime`), the connection is released from the pool. This ensures that Hasura is not holding
connections which are not required.
`connection_lifetime`), the connection is released from the pool. This ensures that Hasura is not holding connections
which are not required.
If the connection pool is saturated, then any new request waits for the pool to provide a connection. This ensures that
your database is not bombarded with more connections than it can handle. You can also specify a `pool_timeout` to

12
docs/docs/databases/connect-db/read-replicas.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura Cloud and Hasura Enterprise read replicas
title: 'Cloud and EE: Read replicas on Hasura Cloud'
title: "Cloud and EE: Read replicas on Hasura Cloud"
keywords:
- hasura
- docs
@ -14,14 +14,14 @@ sidebar_position: 1
sidebar_class_name: cloud-and-enterprise-icon
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Read Replicas
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise</div>
## Introduction

8
docs/docs/deployment/hasura-cloud/ci-cd/github-integration.mdx
View File

@ -1,6 +1,6 @@
---
description: GitHub deployment
title: 'Cloud: GitHub Deployment'
title: "Cloud: GitHub Deployment"
keywords:
- hasura
- docs
@ -13,12 +13,12 @@ sidebar_position: 20
sidebar_class_name: cloud-and-enterprise-icon
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# GitHub Deployment
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Introduction

4
docs/docs/deployment/hasura-cloud/ci-cd/index.mdx
View File

@ -10,11 +10,11 @@ slug: index
sidebar_class_name: cloud-and-enterprise-icon
---
import Thumbnail from '@site/src/components/Thumbnail';
import Thumbnail from "@site/src/components/Thumbnail";
# Continuous Integration and Continuous Deployment with Hasura Cloud
<div className='badge badge--primary heading-badge'>Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## Introduction

10
docs/docs/deployment/hasura-cloud/ci-cd/preview-apps.mdx
View File

@ -15,11 +15,11 @@ sidebar_position: 10
sidebar_class_name: cloud-and-enterprise-icon
---
import Thumbnail from '@site/src/components/Thumbnail';
import Thumbnail from "@site/src/components/Thumbnail";
# Preview Apps
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## TL;DR
@ -213,7 +213,7 @@ more information.
A sample file would look like this:
```yaml
name: 'preview-apps'
name: "preview-apps"
on: # rebuild any PRs and main branch changes
pull_request:
push:
@ -226,7 +226,7 @@ jobs:
- uses: actions/checkout@v2
- uses: hasura/hasura-cloud-preview-apps@v0.1.7
with:
name: 'preview-repo-name-${{github.env.GITHUB_HEAD_REF}}${{github.event.number}}'
name: "preview-repo-name-${{github.env.GITHUB_HEAD_REF}}${{github.event.number}}"
postgresDBConfig: |
POSTGRES_SERVER_CONNECTION_URI=${{secrets.POSTGRES_SERVER_CONNECTION_URI}}
PG_ENV_VARS_FOR_HASURA=PG_DB_URL_1,PG_DB_URL_2,PG_DB_URL3
@ -270,7 +270,7 @@ jobs:
- name: Hasura Cloud Preview Apps
uses: hasura/hasura-cloud-preview-apps@v0.1.5
with:
name: 'repo-name-${{github.env.GITHUB_HEAD_REF}}${{github.event.number}}'
name: "repo-name-${{github.env.GITHUB_HEAD_REF}}${{github.event.number}}"
postgresDBConfig: |
POSTGRES_SERVER_CONNECTION_URI=${{secrets.POSTGRES_SERVER_CONNECTION_URI}}
PG_ENV_VARS_FOR_HASURA=PG_DB_URL_1,PG_DB_URL_2,PG_DB_URL3

20
docs/docs/deployment/hasura-cloud/dedicated-vpc.mdx
View File

@ -1,6 +1,6 @@
---
description: Dedicated VPC with VPC peering and private network access
title: 'Cloud: Dedicated VPC'
title: "Cloud: Dedicated VPC"
keywords:
- hasura
- cloud
@ -12,12 +12,12 @@ sidebar_position: 40
sidebar_class_name: cloud-and-enterprise-icon
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Dedicated VPC
<div className="badge badge--primary heading-badge">Available on: Cloud Enterprise</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Cloud)</div>
## Introduction
@ -45,8 +45,8 @@ Enter the following details:
- **Region**: region where the VPC should be provisioned (note that projects will also be created in this region
- **VPC Name**: A display name for Hasura Dashboard
- **VPC CIDR**: A valid private IPV4 address range (/16) that should be used with this VPC. For example `172.16.0.0/16`,
`10.10.0.0/16` etc. (it cannot be `10.2.0.0/16`, also it cannot conflict with the VPCs that you intend to peer with this
VPC)
`10.10.0.0/16` etc. (it cannot be `10.2.0.0/16`, also it cannot conflict with the VPCs that you intend to peer with
this VPC)
Once you submit the request, the VPC will appear as **Pending**. It will take about 10-20 minutes for your VPC to be
provisioned. Once it is provisioned, you will be able to see the VPC's details and create peering and projects.
@ -72,8 +72,8 @@ All projects within a VPC is listed under **Projects**.
### AWS
Your Dedicated VPC can be peered with other networks that you own on AWS or managed services like Aiven or Timescale
Cloud that run on AWS. It will enable private connectivity to your databases and other APIs from Hasura Cloud and
you will not have to expose them publicly.
Cloud that run on AWS. It will enable private connectivity to your databases and other APIs from Hasura Cloud and you
will not have to expose them publicly.
You can view all the requests and active peerings in the **Peerings** tab.
@ -147,8 +147,8 @@ Hasura Cloud.
:::
Once you enter and initiate the peering request, you will see the peering as **Request Pending** on the dashboard.
Once Hasura accepts the request, you will see that the peering is **Active**. It will take about 5-10 minutes.
Once you enter and initiate the peering request, you will see the peering as **Request Pending** on the dashboard. Once
Hasura accepts the request, you will see that the peering is **Active**. It will take about 5-10 minutes.
Now you should be able to use private IP addresses and private DNS names as Database URLs or Webhook URLs.

2
docs/docs/deployment/hasura-cloud/disaster-recovery.mdx
View File

@ -12,7 +12,7 @@ sidebar_class_name: cloud-icon
# Disaster Recovery and Passive Standby Config for Hasura Cloud
<div className='badge badge--primary heading-badge'>Available on: Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise</div>
## Overview

10
docs/docs/deployment/hasura-cloud/high-availability.mdx
View File

@ -11,15 +11,15 @@ sidebar_class_name: cloud-and-enterprise-icon
# High-Availability Configuration
<div className="badge badge--primary heading-badge">Available on: Cloud Standard, Cloud Enterprise</div>
<div className="badge badge--primary heading-badge">Available on: Standard, Enterprise (Cloud)</div>
## Overview
Hasura Cloud supports high-availability (HA) configurations for Cloud Standard and Cloud Enterprise projects.
Hasura Cloud supports high-availability (HA) configurations for Cloud Enterprise projects.
We configure each Cloud Standard and Cloud Enterprise project across different Availability Zones (AZs). In the event of
an incident, our global gateway will ensure traffic is not routed to the affected compute instances while the systems
are auto-recovering.
We configure each Cloud Enterprise project across different Availability Zones (AZs). In the event of an incident, our
global gateway will ensure traffic is not routed to the affected compute instances while the systems are
auto-recovering.
This redundancy and ability to identify problematic instances provides you with protection against data center power
outages, natural disasters, and other incidents while ensuring your project is performant, handles scaling, and, most

96
docs/docs/deployment/hasura-cloud/plans.mdx Normal file
View File

@ -0,0 +1,96 @@
---
description: Billing and pricing breakdown for Hasura Cloud
keywords:
- hasura
- cloud
- tiers
- billing
- pricing
sidebar_class_name: cloud-and-enterprise-icon
sidebar_position: 2
---
# Plans and Pricing
## Overview
[Hasura Cloud](https://cloud.hasura.io) offers three plans: Hasura Cloud Free, Hasura Cloud Professional, and Hasura
Cloud Enterprise.
Hasura Cloud billing is based on the consumption of resources. For paid plans, you can either pay as you go monthly in
arrears or make an annual commitment with an upfront payment for the usage. Below, you'll find an overview of each plan
and details on how we calculate billing. Check out our [pricing FAQ](https://hasura.io/pricing#faq) for common
questions.
## Hasura Cloud Plans
### Hasura Cloud Free
The Hasura Cloud Free plan is - as it's named - free to use. You can create up to **three** Projects under the plan to
try out the Hasura fully-managed GraphQL APIs.
Each Project can use up to **two data connectors** with **100 MB of data passthrough per month**, and up to **1 million
API requests per month**. You can get higher entitlements after upgrading to the Hasura Cloud Professional plan.
### Hasura Cloud Professional
Hasura Cloud Professional is a pay-as-you-go monthly subscription plan. You only pay for your consumption every month.
We calculate billing, using the following categories, per Project:
- Types of databases connected to the Project
- Data passthrough
Hasura Cloud Professional is billed for the number of hours each Project runs and the amount of data passthrough. The
price depends on the type(s) of database(s) connected to the Project. If a Project uses a generic Postgres database and
a premium database, **you are only billed for the premium database at $3.00 /hr**.
| Database Type | Rate |
| ------------------ | -------- |
| Generic Postgres | $1.50/hr |
| Snowflake | $3.00/hr |
| BigQuery | $3.00/hr |
| Athena | $3.00/hr |
| MSSQL | $3.00/hr |
| CockroachDB | $3.00/hr |
| Google AlloyDB | $3.00/hr |
| Citus / Hyperscale | $3.00/hr |
:::info Projects without databases
A Project without a connected database is billed at $1.50/hr.
:::
#### Data passthrough
Hasura Cloud meters data passing through it to external services, including request data that is sent to upstream
services (e.g., databases) and response data sent to downstream services (e.g., web apps) at a rate of $0.13/GB.
You will be billed based on this volume of data that passes through Hasura every month.
#### Example Calculation
Assuming thirty days in the month, you start with one Project with a Postgres data connector for the first twenty-one
days of the Project:
`21 days * 24 hrs/day * $1.50/hr = $756`
On the twenty-second day, you decide to add the Snowflake data connector and leave it connected until the end of the
month:
`9 days * 24hrs/day * $3.00/hr = $648`
Let's assume the data passthrough for the entire month is 1000 GB:
`1000 GB * $0.13/GB = $130 Total`
The total cost for the month is $1534.
### Hasura Cloud Enterprise
The Hasura Cloud Enterprise plan offers the ability to commit to a minimum spending amount over a minimum 12-month
commitment period. You can view the total amount of accrued usage during the commitment term and the amount of committed
spending left in your account. You can renew your commitment if your commitment is depleted before the expiry of the
commitment period.
Talk to a Hasura [sales representative](mailto:sales@hasura.io) to discuss your specific use case and the pricing.

4
docs/docs/deployment/hasura-cloud/regression-tests.mdx
View File

@ -12,11 +12,11 @@ sidebar_position: 30
sidebar_class_name: cloud-icon
---
import Thumbnail from '@site/src/components/Thumbnail';
import Thumbnail from "@site/src/components/Thumbnail";
# Regression Tests
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Introduction

35
docs/docs/deployment/hasura-cloud/sso.mdx
View File

@ -1,8 +1,8 @@
---
sidebar_position: 60
sidebar_label: 'SSO'
description: 'Enable single sign-on (SSO) for Hasura Enterprise through the SAML 2.0 protocol'
title: 'EE: Enable SSO through SAML'
sidebar_label: "SSO"
description: "Enable single sign-on (SSO) for Hasura Enterprise through the SAML 2.0 protocol"
title: "EE: Enable SSO through SAML"
keywords:
- hasura
- docs
@ -13,24 +13,25 @@ keywords:
sidebar_class_name: cloud-and-enterprise-icon
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# SSO Through SAML
<div className='badge badge--primary heading-badge'>Available on: Cloud Enterprise</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise</div>
## Introduction
You can enable SSO (Single Sign-On) with your identity management system through the
[SAML 2.0](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) protocol. Hasura is a
SAML 2.0 compliant service provider.
[SAML 2.0](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) protocol. Hasura is a SAML
2.0 compliant service provider.
<Thumbnail src={'/img/enterprise/SSO_Login_demo.gif'} alt={'Single Sign-On Login Demo'}/>
<Thumbnail src={"/img/enterprise/SSO_Login_demo.gif"} alt={"Single Sign-On Login Demo"} />
## Configuration
### Configuring the identity provider
Create a new service provider on your SAML identity provider with the following configuration:
1. Configure the ACS URL, Entity ID, Audience and Recipient to be `https://auth.pro.hasura.io/saml/callback`.
@ -43,19 +44,19 @@ Once created, note the IdP metadata in XML format. Dynamic metadata through an I
Provide the following details to [support](https://cloud.hasura.io/support/create-ticket) to configure SAML SSO:
- Domain Name(s): Domain tied to the email address of the users using SSO. If the emails of the users are tied to more than
one domain, provide all the domains.
- IdP Metadata: Metadata of your identity provider in XML format. If you want to configure the metadata through
a dynamic URL, you can instead provide the IdP Metadata URL.
- Domain Name(s): Domain tied to the email address of the users using SSO. If the emails of the users are tied to more
than one domain, provide all the domains.
- IdP Metadata: Metadata of your identity provider in XML format. If you want to configure the metadata through a
dynamic URL, you can instead provide the IdP Metadata URL.
- Provider: The name of this identity provider.
- Request Signing: Specify if you want the SAML assertion request to signed or un-signed.
- Request Signing: Specify if you want the SAML assertion request to signed or un-signed.
## Caveats and limitations
1. Only a SP initiated flow is supported i.e. you can’t have a Launch button in your IdP dashboard to launch the project
dashboard.
dashboard.
2. Session expiry time is currently not configurable.
3. Single logout is currently not supported.
4. Once SSO is enabled for an org, it is enforced for that org. This means, if an org is enabled for SSO, the emails
from that org cannot use any other login mechanism such as Google, GitHub, or email.
5. Currently, only SAML with HTTP POST binding is supported.
from that org cannot use any other login mechanism such as Google, GitHub, or email.
5. Currently, only SAML with HTTP POST binding is supported.

18
docs/docs/deployment/health-checks/source-health-check.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura database source Health Check
title: 'Cloud: Source Health Check'
title: "Cloud: Source Health Check"
keywords:
- hasura
- cloud
@ -12,13 +12,13 @@ sidebar_position: 20
sidebar_class_name: cloud-icon
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Source Health Check
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Overview
@ -114,10 +114,10 @@ X-Hasura-Role: admin
### API
Health Check reports of sources can be obtained through a `GET` request from the
`/healthz/sources` API, on demand. Learn more about the API [here](/api-reference/source-health.mdx).
Health Check reports of sources can be obtained through a `GET` request from the `/healthz/sources` API, on demand.
Learn more about the API [here](/api-reference/source-health.mdx).
### Logging
Hasura logs the Health Check status and other information via `health-check-log` type when enabled.
Learn more about the Health Checks logs [here](/deployment/logging.mdx#health-check-log-structure).
Hasura logs the Health Check status and other information via `health-check-log` type when enabled. Learn more about the
Health Checks logs [here](/deployment/logging.mdx#health-check-log-structure).

6
docs/docs/enterprise/caching.mdx
View File

@ -2,7 +2,7 @@
sidebar_label: Enable caching
sidebar_position: 5
description: Hasura EE caching
title: 'EE: Enable GraphQL caching'
title: "EE: Enable GraphQL caching"
keywords:
- hasura
- docs
@ -12,11 +12,11 @@ keywords:
- caching
---
import HeadingIcon from '@site/src/components/HeadingIcon';
import HeadingIcon from "@site/src/components/HeadingIcon";
# Enable GraphQL Caching
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise</div>
## Introduction

4
docs/docs/enterprise/getting-started/index.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Get started
description: Gett started for the Hasura Enterprise Edition
title: 'EE: Get started'
title: "EE: Get started"
keywords:
- hasura
- docs
@ -11,7 +11,7 @@ slug: index
# Get Started
<div className="badge badge--primary heading-badge">Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Prerequisites

10
docs/docs/enterprise/getting-started/quickstart-aws-ecs.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Quickstart with AWS ECS
description: Quickstart with AWS ECS for Hasura Enterprise Edition
title: 'EE: Quickstart with AWS ECS'
title: "EE: Quickstart with AWS ECS"
keywords:
- hasura
- docs
@ -9,11 +9,11 @@ keywords:
sidebar_position: 2
---
import LatestRelease from '@site/src/components/LatestRelease';
import LatestRelease from "@site/src/components/LatestRelease";
# Quickstart with AWS ECS
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Introduction
@ -28,8 +28,8 @@ Fargate task, and perform other common tasks in Amazon ECS with the AWS CLI.
This tutorial assumes that the following prerequisites have been met:
- To deploy Hasura EE, you will need a license key. [Please contact Hasura Sales](mailto:sales@hasura.io) if you do not already
have one.
- To deploy Hasura EE, you will need a license key. [Please contact Hasura Sales](mailto:sales@hasura.io) if you do not
already have one.
- The latest version of the AWS CLI is installed and configured. For more information about installing or upgrading your
AWS CLI, see
[Installing the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).

10
docs/docs/enterprise/getting-started/quickstart-docker.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Quickstart with Docker
description: Quickstart with Docker for Hasura Enterprise Edition
title: 'EE: Quickstart with Docker'
title: "EE: Quickstart with Docker"
keywords:
- hasura
- docs
@ -9,12 +9,12 @@ keywords:
sidebar_position: 1
---
import Thumbnail from '@site/src/components/Thumbnail';
import LatestRelease from '@site/src/components/LatestRelease';
import Thumbnail from "@site/src/components/Thumbnail";
import LatestRelease from "@site/src/components/LatestRelease";
# Quickstart with Docker
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Introduction
@ -172,7 +172,7 @@ you should change it to:
<code>
graphql-engine:
<br />
{' '}image: hasura/graphql-engine:
{" "}image: hasura/graphql-engine:
<LatestRelease />
</code>
</pre>

16
docs/docs/enterprise/getting-started/quickstart-google-cloud-run.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Quickstart with Google Cloud Run
description: Quickstart with Google Cloud Run for Hasura Enterprise Edition
title: 'EE: Quickstart with Google Cloud Run'
title: "EE: Quickstart with Google Cloud Run"
keywords:
- hasura
- docs
@ -9,11 +9,11 @@ keywords:
sidebar_position: 4
---
import LatestRelease from '@site/src/components/LatestRelease';
import LatestRelease from "@site/src/components/LatestRelease";
# Quickstart with Google Cloud Run
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Introduction
@ -27,8 +27,8 @@ This tutorial will help you run Hasura Enterprise Edition as a Google Cloud Run
This tutorial assumes that the following prerequisites have been met:
- To deploy Hasura EE, you will need a license key. [Please contact Hasura Sales](mailto:sales@hasura.io) if you do not already
have one.
- To deploy Hasura EE, you will need a license key. [Please contact Hasura Sales](mailto:sales@hasura.io) if you do not
already have one.
- The latest version of the `gcloud` CLI is installed and configured. For more information about installing or upgrading
your gcloud CLI, see [Installing the gcloud CLI](https://cloud.google.com/sdk/docs/install).
- Your `gcloud` user has the
@ -54,10 +54,10 @@ wget https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-mani
Edit `env.yaml` and set the right values:
```yaml
HASURA_GRAPHQL_EE_LICENSE_KEY: '<license key>'
HASURA_GRAPHQL_EE_LICENSE_KEY: "<license key>"
HASURA_GRAPHQL_METADATA_DATABASE_URL: postgres://postgres:postgrespassword@postgres:5432/postgres
HASURA_GRAPHQL_REDIS_URL: 'redis://redis:6379'
HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL: 'redis://redis:6379'
HASURA_GRAPHQL_REDIS_URL: "redis://redis:6379"
HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL: "redis://redis:6379"
HASURA_GRAPHQL_ADMIN_SECRET: myadminsecretkey
```

14
docs/docs/enterprise/getting-started/quickstart-kubernetes.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Quickstart with Kubernetes
description: Quickstart with Kubernetes for Hasura Enterprise Edition
title: 'EE: Quickstart with Kubernetes'
title: "EE: Quickstart with Kubernetes"
keywords:
- hasura
- docs
@ -9,11 +9,11 @@ keywords:
sidebar_position: 3
---
import LatestRelease from '@site/src/components/LatestRelease';
import LatestRelease from "@site/src/components/LatestRelease";
# Quickstart with Kubernetes
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Introduction
@ -27,8 +27,8 @@ This tutorial helps you set up Hasura Enterprise Edition on Kubernetes and conne
This tutorial assumes that the following prerequisites have been met:
- To deploy Hasura EE, you will need a license key. [Please contact Hasura Sales](mailto:sales@hasura.io) if you do not already
have one.
- To deploy Hasura EE, you will need a license key. [Please contact Hasura Sales](mailto:sales@hasura.io) if you do not
already have one.
- A functioning Kubernetes cluster.
- This tutorial uses a container image hosted on the public Docker hub, so your Kubernetes cluster must have internet
access.
@ -53,7 +53,7 @@ Edit `deployment.yaml` and set the right values:
---
env:
- name: HASURA_GRAPHQL_EE_LICENSE_KEY
value: '<license key>'
value: "<license key>"
- name: HASURA_GRAPHQL_METADATA_DATABASE_URL
value: postgres://<username>:<password>@hostname:<port>/<dbname>
- name: HASURA_GRAPHQL_REDIS_URL
@ -172,7 +172,7 @@ you should change it to:
<code>
containers:
<br />
{' '}- image: hasura/graphql-engine:
{" "}- image: hasura/graphql-engine:
<LatestRelease />
</code>
</pre>

4
docs/docs/enterprise/getting-started/start-using-hasura-ee.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Start using Hasura EE
description: Start using Hasura EE
title: 'EE: Start Using Hasura EE'
title: "EE: Start Using Hasura EE"
keywords:
- hasura
- docs
@ -11,7 +11,7 @@ sidebar_position: 5
# Start Using Hasura EE
<div className="badge badge--primary heading-badge">Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Instructions

6
docs/docs/enterprise/index.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Hasura Enterprise (EE)
description: Documentation for the Hasura Enterprise edition
title: 'EE: Hasura Enterprise'
title: "EE: Hasura Enterprise"
keywords:
- hasura
- docs
@ -9,11 +9,11 @@ keywords:
slug: index
---
import Enterprise from '@site/static/icons/features/enterprise.svg';
import Enterprise from "@site/static/icons/features/enterprise.svg";
# <Enterprise /> Hasura Enterprise
<div className="badge badge--primary heading-badge">Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Introduction

7
docs/docs/enterprise/metrics.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Metrics via Prometheus
description: Metrics via Prometheus for Hasura Enterprise Edition
title: 'EE: Metrics via Prometheus'
title: "EE: Metrics via Prometheus"
keywords:
- hasura
- docs
@ -11,7 +11,7 @@ sidebar_position: 4
# Metrics via Prometheus
<div className="badge badge--primary heading-badge">Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Enable metrics endpoint
@ -34,8 +34,7 @@ curl 'http://127.0.0.1:8080/v1/metrics' -H 'Authorization: Bearer <secret>'
:::note Note
- The metrics endpoint should be configured with a secret to prevent misuse and should not be exposed over the
internet.
- The metrics endpoint should be configured with a secret to prevent misuse and should not be exposed over the internet.
:::

9
docs/docs/enterprise/release-notes.mdx
View File

@ -2,7 +2,7 @@
sidebar_label: Release notes
sidebar_position: 6
description: Release notes for Hasura EE
title: 'EE: Release notes'
title: "EE: Release notes"
date: 2022-08-08T16:30:59+05:30
keywords:
- hasura
@ -15,9 +15,8 @@ keywords:
# Release Notes
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition</div>
<br/>
<br/>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
<br />
<br />
See [Changelog](https://hasura.io/changelog/enterprise-edition).

4
docs/docs/enterprise/upgrade-ce-to-ee.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Upgrade from Hasura CE to Hasura Enterprise
description: A guide to upgrade from Hasura CE to Hasura Enterprise
title: 'EE: Upgrade from Hasura CE to Hasura Enterprise'
title: "EE: Upgrade from Hasura CE to Hasura Enterprise"
keywords:
- hasura
- docs
@ -11,7 +11,7 @@ sidebar_position: 1
# Upgrading from Hasura CE to Hasura Enterprise
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise (Self-hosted)</div>
## Overview

27
docs/docs/event-triggers/clean-up/auto-cleanup.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Auto cleanup
description: Cleanup Event Trigger logs for Hasura Cloud/Enterprise Edition
title: 'Auto cleanup of Event Trigger logs'
title: "Auto cleanup of Event Trigger logs"
keywords:
- hasura
- docs
@ -14,13 +14,13 @@ sidebar_position: 2
sidebar_class_name: cloud-and-enterprise-icon
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Thumbnail from "@site/src/components/Thumbnail";
# Auto Cleanup of Event Trigger Logs
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Enterprise</div>
:::note Supported from
@ -50,7 +50,8 @@ provided config.
<Tabs groupId="user-preference" className="api-tabs">
<TabItem value="console" label="Console">
For an existing Event Trigger, head to the `Modify` tab of the Event Trigger and scroll down to the `Auto-cleanup Event Logs` section.
For an existing Event Trigger, head to the `Modify` tab of the Event Trigger and scroll down to the
`Auto-cleanup Event Logs` section.
<Thumbnail src="/img/event-triggers/auto-cleanup.png" alt="Auto cleanup" max-width="543px" />
@ -70,7 +71,7 @@ event_triggers:
definition:
enable_manual: true
insert:
columns: '*'
columns: "*"
retry_conf:
interval_sec: 10
num_retries: 0
@ -81,7 +82,7 @@ event_triggers:
clean_invocation_logs: true
clear_older_than: 168
paused: false
schedule: '0 0 * * *'
schedule: "0 0 * * *"
timeout: 60
```
@ -127,8 +128,8 @@ X-Hasura-Role: admin
:::caution Warning
If you initially choose not to delete `invocation_logs`, but later they need to be deleted, you will need to delete
the retained logs manually.
If you initially choose not to delete `invocation_logs`, but later they need to be deleted, you will need to delete the
retained logs manually.
:::
@ -171,8 +172,7 @@ X-Hasura-Role: admin
}
```
- Activate the cleaners on all the triggers defined on the sources: `source_1`,
`source_2`
- Activate the cleaners on all the triggers defined on the sources: `source_1`, `source_2`
```json
POST /v1/metadata HTTP/1.1
@ -189,8 +189,7 @@ X-Hasura-Role: admin
}
```
- Activate the cleaners on triggers: `sample_trigger_1`, `sample_trigger_2`
defined on source `default`
- Activate the cleaners on triggers: `sample_trigger_1`, `sample_trigger_2` defined on source `default`
```json
POST /v1/metadata HTTP/1.1

8
docs/docs/graphql-api-explorer.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura GraphQL API Explorer
title: 'Cloud: Hasura GraphQL API Explorer'
title: "Cloud: Hasura GraphQL API Explorer"
keywords:
- hasura
- cloud
@ -17,12 +17,12 @@ sidebar_class_name: cloud-icon
slug: graphql-api-explorer/index
---
import Thumbnail from '@site/src/components/Thumbnail';
import Explorer from '@site/static/icons/features/graphql_api_explorer_2.svg';
import Thumbnail from "@site/src/components/Thumbnail";
import Explorer from "@site/static/icons/features/graphql_api_explorer_2.svg";
# <Explorer /> Hasura GraphQL API Explorer
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Community, Enterprise</div>
## TL;DR

12
docs/docs/observability/errors.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_position: 3
sidebar_label: Errors
title: 'Cloud: Errors'
title: "Cloud: Errors"
description: Hasura Cloud error analysis
keywords:
- hasura
@ -11,21 +11,21 @@ keywords:
- errors
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Errors
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## Overview
Troubleshoot errors quickly with powerful analytical tools and filters:
<Thumbnail src='/img/observability/pro-tab-errors.png' alt='Hasura Cloud Console errors tab' />
<Thumbnail src="/img/observability/pro-tab-errors.png" alt="Hasura Cloud Console errors tab" />
Drill into a specific operation via the magnifying-glass icon next to the operation summary in the 'Frequent errors'
table. You'll be taken to a list of the failed operations, and can choose one to inspect the specific operation content,
metadata, and error generated:
<Thumbnail src='/img/observability/inspect-error.png' alt='Hasura Cloud Console inspect a failed operation' />
<Thumbnail src="/img/observability/inspect-error.png" alt="Hasura Cloud Console inspect a failed operation" />

10
docs/docs/observability/index.mdx
View File

@ -2,7 +2,7 @@
sidebar_label: Observability
sidebar_position: 1
slug: index
title: 'Cloud: Observability'
title: "Cloud: Observability"
description: Hasura Cloud observability
keywords:
- hasura
@ -12,13 +12,13 @@ keywords:
- observability
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Observability from '@site/static/icons/features/observability.svg';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
import Observability from "@site/static/icons/features/observability.svg";
# <Observability /> Observability
<div className="badge badge--primary heading-badge">Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## Overview

82
docs/docs/observability/integrations/azure-monitor.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_position: 3
description: Azure monitor Integration on Hasura Cloud
title: 'Cloud: Azure Monitor Integration'
title: "Cloud: Azure Monitor Integration"
keywords:
- hasura
- docs
@ -13,12 +13,12 @@ keywords:
sidebar_label: Azure Monitor
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Azure Monitor Integration
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise</div>
## Introduction
@ -44,16 +44,16 @@ above.
this context)
<Thumbnail
src='/img/observability/service-principal-properties.png'
alt='Service Principal Properties'
width='1146px'
src="/img/observability/service-principal-properties.png"
alt="Service Principal Properties"
width="1146px"
/>
- From the `Certificates & secrets` tab of the created service principal, Create a client secret by clicking
`New client secret`. Add a suitable description and expiry period for the secret and click `Add`. Copy the value of
the created secret (Referred to as `Active Directory Client Secret` in this context)
<Thumbnail src='/img/observability/service-principal-secret.png' alt='Service Principal Secret' width='1146px' />
<Thumbnail src="/img/observability/service-principal-secret.png" alt="Service Principal Secret" width="1146px" />
- Create a [Log Analytics Workspace](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/quick-create-workspace)
in Azure.
@ -62,22 +62,22 @@ above.
(Referred as `Shared Key` in this context).
<Thumbnail
src='/img/observability/log-analytics-workspace-config.png'
alt='Log Analytics workspace config parameters'
width='1146px'
src="/img/observability/log-analytics-workspace-config.png"
alt="Log Analytics workspace config parameters"
width="1146px"
/>
- From the `Properties` tab of the created log analytics workspace, retrieve `Resource ID` and `Location` (Referred to
as `Region` in this context)
<Thumbnail src='/img/observability/log-analytics-properties.png' alt='Log Analytics Properties' width='1146px' />
<Thumbnail src="/img/observability/log-analytics-properties.png" alt="Log Analytics Properties" width="1146px" />
- Assign the Role `Monitoring Metrics Publisher` to the Service principal against the Log analytics workspace. From the
`Access control (IAM)` tab of the created log analytics workspace, Click on `Add` and select `Add role assignment`. In
the Add role assignment panel, Select the Role as `Monitoring Metrics Publisher` and select the created service
principal for role assignment and click `Save`.
<Thumbnail src='/img/observability/service-principal-role.png' alt='Service Principal Role' width='1146px' />
<Thumbnail src="/img/observability/service-principal-role.png" alt="Service Principal Role" width="1146px" />
- Create an
[Application Insights resource](https://docs.microsoft.com/en-us/azure/azure-monitor/app/create-new-resource>) in
@ -85,16 +85,16 @@ above.
- From the `Overview` tab of the created Application Insights resource, retrieve `Instrumentation Key`
<Thumbnail src='/img/observability/azure-instrumentation-key.png' alt='Instrumentation Key' width='1146px' />
<Thumbnail src="/img/observability/azure-instrumentation-key.png" alt="Instrumentation Key" width="1146px" />
## Configure Azure Monitor integration
On the Project settings page, navigate to **Integrations > Azure Monitor**.
<Thumbnail
src='/img/observability/integrate-azure-monitor.png'
alt='Configure Azure Monitor Integration'
width='1146px'
src="/img/observability/integrate-azure-monitor.png"
alt="Configure Azure Monitor Integration"
width="1146px"
/>
Enter the values of config parameters obtained from the steps in pre-requisites in the Azure monitor integration form.
@ -115,18 +115,18 @@ signifies successful exporting of the telemetry to Azure monitor. `Last Exported
the timestamp of the last telemetry (log, metric, trace) successfully exported to your Azure monitor dashboard.
<Thumbnail
src='/img/observability/configure-azure-monitor-done.png'
alt='Azure monitor Integration successfully configured'
width='1146px'
src="/img/observability/configure-azure-monitor-done.png"
alt="Azure monitor Integration successfully configured"
width="1146px"
/>
In case of error while exporting any of telemetries(logs, metrics, traces) to Azure monitor, the dot becomes red and the
error messages/instructions are displayed. Click `Update Settings` button to update the config parameters.
<Thumbnail
src='/img/observability/configure-azure-monitor-fail.png'
alt='Azure monitor Integration unable to push logs'
width='1146px'
src="/img/observability/configure-azure-monitor-fail.png"
alt="Azure monitor Integration unable to push logs"
width="1146px"
/>
## View metrics
@ -148,18 +148,18 @@ To navigate to
,click `View Metrics`.
<Thumbnail
src='/img/observability/azure-monitor-view-metrics.png'
alt='Azure monitor Integration successfully configured'
width='1146px'
src="/img/observability/azure-monitor-view-metrics.png"
alt="Azure monitor Integration successfully configured"
width="1146px"
/>
From the `Select a scope` panel, expand the resource group which contains the `Log analytics workspace` and select it
and click `Apply`. In the filter menu, select the correct namespace and `Add filter` to view the individual metric.
<Thumbnail
src='/img/observability/azure-monitor-metrics.png'
alt='Metrics successfully exported to Azure monitor'
width='1146px'
src="/img/observability/azure-monitor-metrics.png"
alt="Metrics successfully exported to Azure monitor"
width="1146px"
/>
## View logs
@ -169,9 +169,9 @@ To navigate to
click `View Logs`.
<Thumbnail
src='/img/observability/azure-monitor-view-logs.png'
alt='Azure monitor Integration successfully configured'
width='1146px'
src="/img/observability/azure-monitor-view-logs.png"
alt="Azure monitor Integration successfully configured"
width="1146px"
/>
From the `Select a scope` panel, expand the resource group which contains the `Log analytics workspace` and select it
@ -179,9 +179,9 @@ and click `Apply`. The logs can be filtered using `Log type`. Use `{YOUR_LOG_TYP
logs. Custom log types are displayed in the left of the Query panel.
<Thumbnail
src='/img/observability/azure-monitor-logs.png'
alt='Logs successfully exported to Azure monitor'
width='1146px'
src="/img/observability/azure-monitor-logs.png"
alt="Logs successfully exported to Azure monitor"
width="1146px"
/>
## View traces
@ -191,9 +191,9 @@ To navigate to
click `View traces`.
<Thumbnail
src='/img/observability/azure-monitor-view-traces.png'
alt='Application Insights Instrumentation Key'
width='1146px'
src="/img/observability/azure-monitor-view-traces.png"
alt="Application Insights Instrumentation Key"
width="1146px"
/>
Select the appropriate `Application Insights` and click `Transaction search`. The traces can be filtered using `Trace`
@ -201,7 +201,7 @@ and `Dependency` Event types. Clicking any of the `Dependency` result shows the
corresponding trace.
<Thumbnail
src='/img/observability/azure-monitor-trace-flame-graph.png'
alt='Traces successfully exported to Azure monitor'
width='1146px'
src="/img/observability/azure-monitor-trace-flame-graph.png"
alt="Traces successfully exported to Azure monitor"
width="1146px"
/>

46
docs/docs/observability/integrations/datadog.mdx
View File

@ -2,7 +2,7 @@
sidebar_label: Datadog
sidebar_position: 2
description: Datadog Integration on Hasura Cloud
title: 'Cloud: Datadog Integration'
title: "Cloud: Datadog Integration"
keywords:
- hasura
- docs
@ -13,12 +13,12 @@ keywords:
- datadog
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Datadog Integration
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise</div>
## Introduction
@ -35,7 +35,7 @@ For Hasura Cloud projects, the Datadog Integration is only available on the `Sta
Navigate to the integrations tab on project settings page to find Datadog integration.
<Thumbnail src='/img/observability/integrate-datadog.png' alt='Configure Datadog Integration' width='1146px' />
<Thumbnail src="/img/observability/integrate-datadog.png" alt="Configure Datadog Integration" width="1146px" />
Select the Datadog API region and enter the Datadog API key (can be retrieved by navigating to Datadog's settings page
by clicking the `Get API Key` link), host, service name and tags to associate with exported logs, metrics and traces.
@ -48,7 +48,7 @@ by clicking the `Get API Key` link), host, service name and tags to associate wi
| Tags | Tags associated with your logs and metrics. Default tags `project_id` and `project_name` are exported with all logs and metrics. A source tag `hasura-cloud-metrics` is added to all exported logs. |
| Service Name | The name of the application or service generating the log events. |
<Thumbnail src='/img/observability/configure-datadog.png' alt='Configure Datadog Integration' width='500px' />
<Thumbnail src="/img/observability/configure-datadog.png" alt="Configure Datadog Integration" width="500px" />
After adding appropriate values, click `Save`.
@ -59,18 +59,18 @@ logs are successfully exported, `Last Exported` is continuously updated, indicat
successfully exported to your Datadog dashboard.
<Thumbnail
src='/img/observability/configure-datadog-done.png'
alt='Datadog Integration successfully configured'
width='1146px'
src="/img/observability/configure-datadog-done.png"
alt="Datadog Integration successfully configured"
width="1146px"
/>
In case there is an error while exporting logs to datadog, the dot is red and the HTTP status code of the error is
displayed right below it.
<Thumbnail
src='/img/observability/configure-datadog-fail.png'
alt='Datadog Integration successfully configured'
width='1146px'
src="/img/observability/configure-datadog-fail.png"
alt="Datadog Integration successfully configured"
width="1146px"
/>
## View logs
@ -78,12 +78,12 @@ displayed right below it.
The logs can be viewed in your Datadog dashboard, under the `Logs` tab. To navigate to the same, click `View Logs`.
<Thumbnail
src='/img/observability/datadog-view-logs.png'
alt='Datadog Integration successfully configured'
width='1146px'
src="/img/observability/datadog-view-logs.png"
alt="Datadog Integration successfully configured"
width="1146px"
/>
<Thumbnail src='/img/observability/datadog-logs.png' alt='Logs successfully exported to Datadog' width='1146px' />
<Thumbnail src="/img/observability/datadog-logs.png" alt="Logs successfully exported to Datadog" width="1146px" />
To view only logs exported by Hasura Cloud, filter your logs using `host` and/or `tags` you configured with this
integration.
@ -114,15 +114,15 @@ Graphs for all the above metrics can be viewed in your Datadog dashboard, under
same, click `View Metrics`.
<Thumbnail
src='/img/observability/datadog-view-metrics.png'
alt='Datadog Integration successfully configured'
width='1146px'
src="/img/observability/datadog-view-metrics.png"
alt="Datadog Integration successfully configured"
width="1146px"
/>
Select the graphs you want to view from the metrics explorer. Alternatively, select the `host` you configured with this
integration to see all the graphs corresponding to metrics exported by Hasura Cloud.
<Thumbnail src='/img/observability/datadog-metrics.png' alt='Metrics successfully exported to Datadog' width='1146px' />
<Thumbnail src="/img/observability/datadog-metrics.png" alt="Metrics successfully exported to Datadog" width="1146px" />
## View traces
@ -135,7 +135,7 @@ visual representation of where the operation spent its execution over time. For
milliseconds in total, of which 758 microseconds was the actual Postgres database processing the query.
<Thumbnail
src='/img/observability/datadog-trace-flame-graph.png'
alt='Flame graph for a trace entry in Datadog'
width='1146px'
src="/img/observability/datadog-trace-flame-graph.png"
alt="Flame graph for a trace entry in Datadog"
width="1146px"
/>

6
docs/docs/observability/integrations/index.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_position: 1
slug: index
title: 'Cloud: Integrations with external services'
title: "Cloud: Integrations with external services"
description: Configure integrations with Hasura Cloud
keywords:
- hasura
@ -15,11 +15,11 @@ keywords:
- monitoring framework
---
import HeadingIcon from '@site/src/components/HeadingIcon';
import HeadingIcon from "@site/src/components/HeadingIcon";
# Integrations with External Services
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise</div>
## Overview

8
docs/docs/observability/integrations/newrelic.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_position: 2
description: New Relic Integration on Hasura Cloud
title: 'Cloud: New Relic Integration'
title: "Cloud: New Relic Integration"
keywords:
- hasura
- docs
@ -14,12 +14,12 @@ keywords:
sidebar_label: New Relic
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# New Relic Integration
<div className="badge badge--primary heading-badge">Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise</div>
## Introduction

34
docs/docs/observability/integrations/opentelemetry.mdx
View File

@ -2,7 +2,7 @@
sidebar_label: OpenTelemetry
sidebar_position: 5
description: OpenTelemetry Integration on Hasura Cloud
title: 'Cloud: OpenTelemetry Integration'
title: "Cloud: OpenTelemetry Integration"
keywords:
- hasura
- docs
@ -14,12 +14,12 @@ keywords:
- open telemetry
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# OpenTelemetry Integration
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise</div>
## Introduction
@ -44,7 +44,7 @@ OpenTelemetry spec reaches [stability](https://opentelemetry.io/status/#current-
Navigate to the `Integrations` tab on the project settings page to find the OpenTelemetry integration.
<Thumbnail src='/img/observability/integrate-opentelemetry.png' alt='Select OpenTelemetry Integration' width='1146px' />
<Thumbnail src="/img/observability/integrate-opentelemetry.png" alt="Select OpenTelemetry Integration" width="1146px" />
The following config parameters are needed to set up the integration with the APM receiver:
@ -85,9 +85,9 @@ documentation for the request header formats. Headers should be added here as a
After adding appropriate values in the OpenTelemetry Integration panel, click <em>Connect Integration</em>.
<Thumbnail
src='/img/observability/configure-opentelemetry.png'
alt='Configure OpenTelemetry Integration'
width='437px'
src="/img/observability/configure-opentelemetry.png"
alt="Configure OpenTelemetry Integration"
width="437px"
/>
## Checking the status of the integration
@ -98,18 +98,18 @@ data that was successfully exported. The orange dot reading `Not exported yet` m
GraphQL API after configuring the integration.
<Thumbnail
src='/img/observability/configure-opentelemetry-done.png'
alt='OpenTelemetry Integration successfully configured'
width='1146px'
src="/img/observability/configure-opentelemetry-done.png"
alt="OpenTelemetry Integration successfully configured"
width="1146px"
/>
In case of errors while exporting telemetry data to the APM receiver, the dot becomes red and the error
messages/instructions are displayed. Click the `Update Settings` button to update the config parameters.
<Thumbnail
src='/img/observability/configure-opentelemetry-fail.png'
alt='Opentelemetry Integration unable to push data'
width='1146px'
src="/img/observability/configure-opentelemetry-fail.png"
alt="Opentelemetry Integration unable to push data"
width="1146px"
/>
## View traces
@ -121,9 +121,9 @@ flame graph in `Jaeger` where a query took 5.64 milliseconds in total, of which
Postgres database processing the query.
<Thumbnail
src='/img/observability/jaeger-trace-flame-graph.png'
alt='Flame graph for a trace entry in Jaeger'
width='1146px'
src="/img/observability/jaeger-trace-flame-graph.png"
alt="Flame graph for a trace entry in Jaeger"
width="1146px"
/>
## OpenTelemetry collector

50
docs/docs/observability/integrations/prometheus.mdx
View File

@ -2,7 +2,7 @@
sidebar_label: Prometheus
sidebar_position: 4
description: Prometheus Integration on Hasura Cloud
title: 'Cloud: Prometheus Integration'
title: "Cloud: Prometheus Integration"
keywords:
- hasura
- docs
@ -14,12 +14,12 @@ keywords:
- grafana
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Prometheus Integration
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Professional, Enterprise</div>
## Introduction
@ -37,7 +37,7 @@ above.
Navigate to the integrations tab on project settings page to find Prometheus integration.
<Thumbnail src='/img/observability/integrate-prometheus.png' alt='Configure Prometheus Integration' width='1146px' />
<Thumbnail src="/img/observability/integrate-prometheus.png" alt="Configure Prometheus Integration" width="1146px" />
Enter the Namespace and label values to be associated to the exported metrics and click on <em>Connect Integration</em>.
@ -46,7 +46,7 @@ Enter the Namespace and label values to be associated to the exported metrics an
| Namespace (Optional) | The single word prefix relevant to the domain the metrics belong to. [Read more about namespace on Prometheus docs.](https://prometheus.io/docs/practices/naming/#metric-names) |
| Labels (Optional) | [Labels](https://prometheus.io/docs/practices/naming/#labels) are key-value pairs associated with your metrics used to differentiate the characteristics of the metric that is being measured. |
<Thumbnail src='/img/observability/configure-prometheus.png' alt='Configure Prometheus Integration' width='437px' />
<Thumbnail src="/img/observability/configure-prometheus.png" alt="Configure Prometheus Integration" width="437px" />
## Prometheus instance configuration
@ -58,15 +58,15 @@ Access token as Password. The Connection URL is needed to configure the Scrape T
The Access Token is generated once the Integration is created. The token is showed only once and cannot be retrieved
again. Access token is used as the password for Basic Authentication by the Prometheus Agent.
<Thumbnail src='/img/observability/prometheus-access-token.png' alt='Prometheus Access Token' width='1146px' />
<Thumbnail src="/img/observability/prometheus-access-token.png" alt="Prometheus Access Token" width="1146px" />
The token can be re-generated from the Configuration Panel of the Integration. This action is permanent and cannot be
reversed.
<Thumbnail
src='/img/observability/prometheus-regenerate-token.png'
alt='Prometheus Access Token Regeneration'
width='1146px'
src="/img/observability/prometheus-regenerate-token.png"
alt="Prometheus Access Token Regeneration"
width="1146px"
/>
### Connection URL
@ -76,13 +76,13 @@ namely scheme, host name and metrics_path. For example, if the connection URL is
`https://prometheus-exporter.pro.hasura.io/metrics`, then the scheme is `https`, host name (This includes sub-domains as
well) is `prometheus-exporter.pro.hasura.io` and metrics_path is `/metrics`.
<Thumbnail src='/img/observability/prometheus-connection-url.png' alt='Prometheus Connection URL' width='1146px' />
<Thumbnail src="/img/observability/prometheus-connection-url.png" alt="Prometheus Connection URL" width="1146px" />
### Project ID
The Project ID is used as the Username for the Basic Authentication by the Prometheus agent.
<Thumbnail src='/img/observability/prometheus-project-id-copy.png' alt='Prometheus Copy Project ID' width='1146px' />
<Thumbnail src="/img/observability/prometheus-project-id-copy.png" alt="Prometheus Copy Project ID" width="1146px" />
The following YAML template can be used as the
[config file](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) to establish connectivity with
@ -92,15 +92,15 @@ the exposed Integration.
global:
scrape_interval: 60s
scrape_configs:
- job_name: 'hasura_prometheus_exporter'
- job_name: "hasura_prometheus_exporter"
scrape_interval: 60s ## Recommended scrape interval is 60s
metrics_path: '/metrics' ## Replace with metrics Path of the connection URL
scheme: 'https' ## Replace with the scheme of the connection URL
metrics_path: "/metrics" ## Replace with metrics Path of the connection URL
scheme: "https" ## Replace with the scheme of the connection URL
basic_auth:
username: 'd01c60e1-1b11-564d-bb09-0a39e3e41b05' ## Replace with project ID
password: 'IrhO3GlR8oXTfsdfdsNs8Nj' ## Replace with Access Token
username: "d01c60e1-1b11-564d-bb09-0a39e3e41b05" ## Replace with project ID
password: "IrhO3GlR8oXTfsdfdsNs8Nj" ## Replace with Access Token
static_configs:
- targets: ['prometheus-exporter.pro.hasura.io'] ## Replace with the host name of the connection URL
- targets: ["prometheus-exporter.pro.hasura.io"] ## Replace with the host name of the connection URL
```
## Checking the status of the integration
@ -110,18 +110,18 @@ Prometheus. When metrics are successfully exported, `Last Exported` is continuou
the last metric successfully exported to your Prometheus Instance.
<Thumbnail
src='/img/observability/prometheus-configure-done.png'
alt='Prometheus Integration successfully configured'
width='1146px'
src="/img/observability/prometheus-configure-done.png"
alt="Prometheus Integration successfully configured"
width="1146px"
/>
In case there is an error while exporting metrics to Prometheus, the dot is red and the error message is displayed right
below it.
<Thumbnail
src='/img/observability/prometheus-configure-fail.png'
alt='Prometheus integration Pull failed'
width='1146px'
src="/img/observability/prometheus-configure-fail.png"
alt="Prometheus integration Pull failed"
width="1146px"
/>
## Metrics details
@ -155,4 +155,4 @@ If `Namespace` and `Labels` are configured (Optional), the format of the metric
The metrics can be queried from the Prometheus Dashboard (or using tools like
[Grafana](https://prometheus.io/docs/visualization/grafana/))
<Thumbnail src='/img/observability/prometheus-view-metrics.png' alt='Prometheus view Metrics' width='1200px' />
<Thumbnail src="/img/observability/prometheus-view-metrics.png" alt="Prometheus view Metrics" width="1200px" />

14
docs/docs/observability/operations.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_position: 5
sidebar_label: Operations
title: 'Cloud: Operations'
title: "Cloud: Operations"
description: Hasura Cloud operation analysis
keywords:
- hasura
@ -10,17 +10,17 @@ keywords:
- operations
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Operations
<div className="badge badge--primary heading-badge">Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## Introduction
The Operations tab will present a processed real-time log of all requests to the GraphQL Engine. Here you
can also inspect individual operations.
The Operations tab will present a processed real-time log of all requests to the GraphQL Engine. Here you can also
inspect individual operations.
<Thumbnail src="/img/observability/operations_overview_2.16.0.png" alt="Hasura Cloud Console list operations" />
@ -34,7 +34,7 @@ variables" which is disabled by default.
<Thumbnail
src="/img/observability/operations_enable-extra-features_2.16.0.png"
alt="Hasura Cloud Console enable extra Operations features"
width={'600px'}
width={"600px"}
/>
When "Capture query variables" is enabled, you are able to inspect the query variables provided for each request.

8
docs/docs/observability/overview.mdx
View File

@ -2,7 +2,7 @@
sidebar_label: Stats Overview
sidebar_position: 2
description: Hasura Cloud stats overview
title: 'Cloud: Stats Overview'
title: "Cloud: Stats Overview"
keywords:
- hasura
- docs
@ -10,12 +10,12 @@ keywords:
- overview
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Stats Overview
<div className="badge badge--primary heading-badge">Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## Overview

12
docs/docs/observability/query-tags.mdx
View File

@ -1,7 +1,7 @@
---
description: Hasura Cloud Query tags
sidebar_label: Query Tags
title: 'Cloud Standard & EE: Query Tags'
title: 'Cloud & Enterprise: Query Tags'
keywords:
- hasura
- docs
@ -15,7 +15,7 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
# Query Tags
<div className="badge badge--primary heading-badge">Available on: Cloud Standard, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Standard, Professional, Enterprise</div>
## Introduction
@ -110,16 +110,16 @@ In the above Metadata spec:
tags is enabled for the source and the format used is <em>standard</em>.
2. To disable query tags for any source, set the value of <em>disabled</em> field to <em>true</em>.
3. To override the default format (<em>Standard</em>) for query tags, use the <em>format</em> field.
4. To omit the `request_id` part of the query tags for any source, set the value of <em>omit_request_id</em> field to <em>true</em>.
4. To omit the `request_id` part of the query tags for any source, set the value of <em>omit_request_id</em> field to
<em>true</em>.
:::info
When the `use_prepared_statements` flag for a Postgres source is enabled,
omitting the `request_id` part of the query tags is recommended.
When the `use_prepared_statements` flag for a Postgres source is enabled, omitting the `request_id` part of the query
tags is recommended.
:::
## Example Metadata Specification
```yaml

12
docs/docs/observability/subscription-workers.mdx
View File

@ -2,7 +2,7 @@
sidebar_position: 7
sidebar_label: Subscription workers
description: Hasura Cloud subscription workers
title: 'Cloud: Subscription workers'
title: "Cloud: Subscription workers"
keywords:
- hasura
- docs
@ -10,18 +10,18 @@ keywords:
- subscription-workers
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Subscription Workers
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## Overview
Subscription workers offer a subscription-worker-specific version of usage statistics:
<Thumbnail
src='/img/observability/pro-tab-subscription-workers.png'
alt='Hasura Cloud Console subscription workers tab'
src="/img/observability/pro-tab-subscription-workers.png"
alt="Hasura Cloud Console subscription workers tab"
/>

8
docs/docs/observability/tracing.mdx
View File

@ -1,7 +1,7 @@
---
description: Distributed tracing with Hasura Cloud
sidebar_label: Distributed tracing
title: 'Cloud: Distributed tracing'
title: "Cloud: Distributed tracing"
keywords:
- hasura
- docs
@ -10,12 +10,12 @@ keywords:
sidebar_position: 8
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Distributed Tracing
<div className='badge badge--primary heading-badge'>Available on: Enterprise Edition, Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Standard, Professional, Enterprise</div>
## Introduction

12
docs/docs/observability/usage.mdx
View File

@ -2,7 +2,7 @@
sidebar_position: 4
sidebar_label: Usage summaries
description: Hasura Cloud usage analysis
title: 'Cloud: Usage summaries'
title: "Cloud: Usage summaries"
keywords:
- hasura
- docs
@ -11,20 +11,20 @@ keywords:
- usage
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Usage Summaries
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
## Overview
Learn about usage with aggregate summaries and filtering tools:
<Thumbnail src='/img/observability/pro-tab-usage.png' alt='Hasura Cloud Console usage tab' />
<Thumbnail src="/img/observability/pro-tab-usage.png" alt="Hasura Cloud Console usage tab" />
Drill into an operation via its magnifying-glass icon in the 'Query List' table. You'll be taken to a list of similar
operations, and can choose one to inspect for content, metadata, and error generated:
<Thumbnail alt='Hasura Cloud Console inspect an operation' src='/img/observability/pro-tab-operations-inspect.png' />
<Thumbnail alt="Hasura Cloud Console inspect an operation" src="/img/observability/pro-tab-operations-inspect.png" />

10
docs/docs/observability/websockets.mdx
View File

@ -2,7 +2,7 @@
sidebar_position: 6
sidebar_label: Websockets
description: Hasura Cloud websockets analysis
title: 'Cloud: Websockets'
title: "Cloud: Websockets"
keywords:
- hasura
- docs
@ -10,15 +10,15 @@ keywords:
- websockets
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Websockets
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise (Self-hosted)</div>
## Overview
Websockets is a ws-specific version of usage statistics:
<Thumbnail src='/img/observability/pro-tab-websockets.png' alt='Hasura Cloud Console websockets tab' />
<Thumbnail src="/img/observability/pro-tab-websockets.png" alt="Hasura Cloud Console websockets tab" />

6
docs/docs/policies/sla.mdx
View File

@ -1,5 +1,5 @@
---
title: 'Cloud Standard & EE: Hasura Service Level Agreement'
title: 'Cloud Standard, Professional, & EE: Hasura Service Level Agreement'
description: Hasura Service Level Agreement for Hasura Cloud
sidebar_label: Hasura SLA
sidebar_position: 0
@ -12,7 +12,7 @@ sidebar_class_name: cloud-and-enterprise-icon
# Hasura Cloud Service Level Agreement (SLA)
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard, Cloud Enterprise</div>
<div className="badge badge--primary heading-badge">Available on: Standard, Professional, Enterprise (Cloud)</div>
## Overview
@ -24,7 +24,7 @@ applies to paid tiers in Hasura Cloud.
We calculate SLA uptime monthly and measure uptime with an HTTP request to the `/v1/version` endpoint on a project at a
regular interval.
Cloud Standard users can find more detail regarding uptime in our
Cloud Standard and Cloud Professional users can find more detail regarding uptime in our
[terms of service](https://hasura.io/legal/hasura-cloud-terms-of-service/). Cloud Enterprise users should reference
their contracts for details.

8
docs/docs/projects/collaborators.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Project collaborators
description: Managing collaborators on Hasura Cloud
title: 'Cloud: Project Collaborators'
title: "Cloud: Project Collaborators"
keywords:
- hasura
- docs
@ -11,12 +11,12 @@ keywords:
sidebar_position: 3
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Project Collaborators
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise (Self-hosted)</div>
## Introduction

4
docs/docs/projects/ownership.mdx
View File

@ -25,7 +25,7 @@ original owner will lose all access to the project.
:::info Note
If the project is on the `Standard` (pay-as-you-go) tier, the new owner will pay for the entire data usage for the month
If the project is on the `Standard` or `Professional` (pay-as-you-go) tier, the new owner will pay for the entire data usage for the month
in which the ownership is transferred.
:::
@ -59,7 +59,7 @@ You can accept an invitation by clicking on the `Accept` button.
:::info Note
If the project is on the `Standard` (pay-as-you-go) tier, the new owner must have an active card associated with their
If the project is on the `Standard` or `Professional` (pay-as-you-go) tier, the new owner must have an active card associated with their
Hasura Cloud account to accept the invitation.
:::

22
docs/docs/projects/pricing.mdx
View File

@ -1,6 +1,6 @@
---
description: Switch pricing plans
title: 'Cloud: Switch pricing plans'
title: "Cloud: Switch pricing plans"
keywords:
- hasura
- docs
@ -10,8 +10,8 @@ sidebar_position: 8
sidebar_label: Switch pricing plans
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Switch Pricing Plans
@ -27,7 +27,7 @@ between these plans.
There are three different pricing plans that you can chose from:
- Free
- Standard (Pay-as-you-go)
- Professional (Pay-as-you-go)
- Enterprise
:::info Note
@ -45,20 +45,20 @@ By clicking on the `Projects` tab, you can see all your projects and what plan t
## Switching pricing plans
### Switch from **Free** to **Standard** tier
### Switch from **Free** to **Professional** tier
Once the `Free` tier data limit is exhausted, the project becomes inactive. In order to keep it active, you can switch
to the `Standard` plan.
to the `Professional` plan.
Go to `Projects` and click on the project you'd like to change.
Now click on the `Usage tab`. To upgrade to the `Standard` plan, click on the `Upgrade` button:
Now click on the `Usage tab`. To upgrade to the `Professional` plan, click on the `Upgrade` button:
<Thumbnail src="/img/projects/upgrade-to-paid-plan.png" alt="Upgrade to the Standard plan" width="1200px" />
Your project is now running on the `Standard` plan.
Your project is now running on the `Professional` plan.
### Switch from **Standard** to **Free** tier
### Switch from **Professional** to **Free** tier
Go to `Projects` and click on the project you'd like to change.
@ -66,8 +66,8 @@ Under the `General` tab, find the `Pricing tier` section and click on the edit i
<Thumbnail src="/img/projects/switch-to-free-plan.png" alt="Switch from Standard to Free tier" width="1200px" />
You'll be charged as per the `Standard` plan until the end of the day. From the next day onwards, the project will be on
the `Free` tier. If the `Free` tier limit is exhausted, the project might become inactive.
You'll be charged as per the `Professional` plan until the end of the day. From the next day onwards, the project will
be on the `Free` tier. If the `Free` tier limit is exhausted, the project might become inactive.
### Switch to and from **Enterprise** tier

6
docs/docs/queries/response-caching.mdx
View File

@ -1,7 +1,7 @@
---
description: Query response caching in Hasura Cloud
sidebar_label: Response Caching
title: 'Cloud: Query response caching'
title: "Cloud: Query response caching"
keywords:
- hasura
- docs
@ -12,11 +12,11 @@ sidebar_position: 3
sidebar_class_name: cloud-and-enterprise-icon
---
import HeadingIcon from '@site/src/components/HeadingIcon';
import HeadingIcon from "@site/src/components/HeadingIcon";
# Query Response Caching
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Introduction

10
docs/docs/security/allow-list.mdx
View File

@ -9,10 +9,10 @@ keywords:
sidebar_position: 8
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
# Allow List of Operations
@ -147,7 +147,7 @@ query ($id: Int!) {
## Role-based Allow List
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
A role-based Allow List is useful when you would like a query collection(s) to be accessible to only certain roles.

9
docs/docs/security/api-limits.mdx
View File

@ -1,5 +1,5 @@
---
description: Hasura Cloud Standard and Hasura Enterprise API limits
description: Hasura Cloud Standard, Professional, and Hasura Enterprise API limits
keywords:
- hasura
- docs
@ -10,7 +10,7 @@ keywords:
sidebar_position: 2
sidebar_label: API limits
sidebar_class_name: cloud-and-enterprise-icon
title: 'Cloud Standard & EE: API Limits'
title: 'Cloud & EE: API Limits'
---
import Thumbnail from '@site/src/components/Thumbnail';
@ -18,7 +18,7 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
# API Limits
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Standard, Professional, Enterprise</div>
## Introduction
@ -200,4 +200,5 @@ All API limits are **not** applied for the admin role, and depth limits are **NO
## Metadata specification
This [API Reference Documentation](/api-reference/metadata-api/api-limits.mdx) describes the metadata API structure to manage API limits.
This [API Reference Documentation](/api-reference/metadata-api/api-limits.mdx) describes the metadata API structure to
manage API limits.

13
docs/docs/security/container-images.mdx
View File

@ -1,11 +1,11 @@
---
title: 'Cloud: Marketplaces'
title: "Cloud: Marketplaces"
description: Hasura Cloud Marketplaces
keywords:
- hasura
- Vulnerability
- scanning
- container
- container
- images
- security
- cloud
@ -13,10 +13,11 @@ sidebar_label: Proactive vulnerability scanning
sidebar_class_name: cloud-and-enterprise-icon
---
# Proactive Vulnerability Scanning of Container Images
# Proactive Vulnerability Scanning of Container Images
<div className='badge badge--primary heading-badge'>Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Overview
Hasura regularly scans all container images used in Hasura Cloud and Hasura Enterprise for vulnerabilities with leading container scanning tools. Those marked “Critical” or “High” are remediated before the next release.
Hasura regularly scans all container images used in Hasura Cloud and Hasura Enterprise for vulnerabilities with leading
container scanning tools. Those marked “Critical” or “High” are remediated before the next release.

4
docs/docs/security/disable-graphql-introspection.mdx
View File

@ -1,5 +1,5 @@
---
description: Hasura Cloud Standard and Hasura Enterprise disable GraphQL introspection
description: Hasura Cloud and EE disable GraphQL introspection
title: 'Cloud Standard & EE: Disable GraphQL introspection'
keywords:
- hasura
@ -20,7 +20,7 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
# Disable GraphQL Introspection
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Introduction

10
docs/docs/security/index.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura Cloud Standard and Hasura Enterprise API Security
title: 'Cloud & EE: API Security'
title: "Cloud & EE: API Security"
keywords:
- hasura
- docs
@ -13,13 +13,13 @@ slug: index
sidebar_label: API security
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import Security from '@site/static/icons/features/security.svg';
import Thumbnail from "@site/src/components/Thumbnail";
import HeadingIcon from "@site/src/components/HeadingIcon";
import Security from "@site/static/icons/features/security.svg";
# <Security /> API Security
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise</div>
## Introduction

4
docs/docs/security/multiple-admin-secrets.mdx
View File

@ -1,5 +1,5 @@
---
description: Hasura Cloud Standard and Hasura Enterprise multiple admin secrets
description: Hasura Cloud and Hasura Enterprise multiple admin secrets
title: 'Cloud Standard & EE: Multiple Admin Secrets'
keywords:
- hasura
@ -21,7 +21,7 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
# Multiple Admin Secrets
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Standard, Professional, Enterprise</div>
## Introduction

4
docs/docs/security/multiple-jwt-secrets.mdx
View File

@ -1,5 +1,5 @@
---
description: Hasura Cloud Standard and Hasura Enterprise multiple JWT Secrets
description: Hasura Cloud and Hasura Enterprise multiple JWT Secrets
title: 'Cloud Standard & EE: Multiple JWT Secrets'
keywords:
- hasura
@ -20,7 +20,7 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
# Multiple JWT Secrets
<div className='badge badge--primary heading-badge'>Available on: Cloud, Enterprise Edition</div>
<div className="badge badge--primary heading-badge">Available on: Standard, Professional, Enterprise</div>
## Introduction

BIN
docs/static/img/projects/project-pricing-plans.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 54 KiB