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

Docs: EE to Enterprise Edition replace

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8766
GitOrigin-RevId: 464088adc707c45e1ca17fedaaeb2de4b65f367b
This commit is contained in:
Sean Park-Ross 2023-04-13 14:53:18 +02:00 committed by hasura-bot
parent 48945b21b2
commit dc75c77b95
37 changed files with 283 additions and 277 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -94,7 +94,7 @@ X-Hasura-Role: admin
| enable_manual | false | Boolean | If set to true, the Event Trigger can be invoked manually |
| request_transform | false | [RequestTransformation](/api-reference/syntax-defs.mdx#requesttransformation) | Attaches a Request Transformation to the Event Trigger. |
| response_transform | false | [ResponseTransformation](/api-reference/syntax-defs.mdx#responsetransformation) | Attaches a Request Transformation to the Event Trigger. |
| cleanup_config | false | [AutoEventTriggerCleanupConfig](/api-reference/syntax-defs.mdx#autoeventtriggercleanupconfig) | Cleanup config for the auto cleanup process (EE/Cloud only). |
| cleanup_config | false | [AutoEventTriggerCleanupConfig](/api-reference/syntax-defs.mdx#autoeventtriggercleanupconfig) | Cleanup config for the auto cleanup process (Enterprise Edition/Cloud only). |
| trigger_on_replication | false | Boolean | Specification for enabling/disabling the Event Trigger during logical replication |
(\*) Either `webhook` or `webhook_from_env` are required.
@ -256,7 +256,7 @@ X-Hasura-Role: admin
| enable_manual | false | Boolean | If set to true, the Event Trigger can be invoked manually |
| request_transform | false | [RequestTransformation](/api-reference/syntax-defs.mdx#requesttransformation) | Attaches a Request Transformation to the Event Trigger. |
| response_transform | false | [ResponseTransformation](/api-reference/syntax-defs.mdx#responsetransformation) | Attaches a Request Transformation to the Event Trigger. |
| cleanup_config | false | [AutoEventTriggerCleanupConfig](/api-reference/syntax-defs.mdx#autoeventtriggercleanupconfig) | Cleanup config for the auto cleanup process (EE/Cloud only). |
| cleanup_config | false | [AutoEventTriggerCleanupConfig](/api-reference/syntax-defs.mdx#autoeventtriggercleanupconfig) | Cleanup config for the auto cleanup process (Enterprise Edition/Cloud only). |
| trigger_on_replication | false | Boolean | Specification for enabling/disabling the Event Trigger during logical replication |
(\*) Either `webhook` or `webhook_from_env` are required.

2
docs/docs/caching/overview.mdx
View File

@ -1,5 +1,5 @@
---
description: Caching in Hasura Cloud and EE
description: Caching in Hasura Cloud and Enterprise Edition
sidebar_label: Overview
title: 'Hasura Caching'
keywords:

4
docs/docs/databases/athena/getting-started/index.mdx
View File

@ -14,8 +14,8 @@ keywords:
:::caution Athena Beta Availability
The Hasura Amazon Athena connector is currently available in beta for all Hasura Cloud offerings and for Hasura
Enterprise Edition (EE) customers. Once the Athena connector is generally available (GA), it will be available only for
Hasura Cloud Enterprise and EE customers.
Enterprise Edition customers. Once the Athena connector is generally available (GA), it will be available only for
Hasura Cloud Enterprise and Enterprise Edition customers.
:::

4
docs/docs/databases/athena/index.mdx
View File

@ -14,8 +14,8 @@ keywords:
:::caution Athena Beta Availability
The Hasura Amazon Athena connector is currently available in `beta` for all Hasura Cloud offerings and for Hasura
Enterprise Edition (EE) customers. Once the Athena connector is generally available (GA), it will be available only for
Hasura Cloud Enterprise and EE customers.
Enterprise Edition customers. Once the Athena connector is generally available (GA), it will be available only for
Hasura Cloud Enterprise and Enterprise Edition customers.
:::

2
docs/docs/databases/database-config/dynamic-db-connection.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura Cloud and Hasura Enterprise dynamic database connection routing
title: 'Cloud and EE: Dynamic database connection routing'
title: 'Cloud and Enterprise Edition: Dynamic database connection routing'
keywords:
- hasura
- docs

2
docs/docs/databases/database-config/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 Enterprise Edition: Read replicas on Hasura Cloud'
keywords:
- hasura
- docs

6
docs/docs/databases/mariadb/docker.mdx
View File

@ -50,7 +50,7 @@ modify the schema.
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
- To deploy Hasura Enterprise Edition, you will need a license key. Please [contact Hasura Sales](mailto:sales@hasura.io) if you do not
already have one.
- You have [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/)
working on your machine.
@ -69,7 +69,7 @@ wget https://raw.githubusercontent.com/hasura/graphql-engine/master/install-mani
curl https://raw.githubusercontent.com/hasura/graphql-engine/master/install-manifests/enterprise/mariadb/docker-compose.yaml -o docker-compose.yaml
```
### Step 2: Set the Hasura EE license key and the admin secret
### Step 2: Set the Hasura Enterprise Edition license key and the admin secret
Edit the downloaded `docker-compose.yaml` and set the license key and admin secret.
@ -155,7 +155,7 @@ automatically build a full-featured GraphQL API for it.
### Step 7 (optional): Use managed PostgreSQL and Redis instances
The Hasura EE Docker compose files come with containerized open-source versions of PostgreSQL and Redis.
The Hasura Enterprise Edition Docker compose files come with containerized open-source versions of PostgreSQL and Redis.
We highly recommend using managed PostgreSQL and Redis instances especially when running in production.

8
docs/docs/databases/mysql/docker.mdx
View File

@ -52,8 +52,8 @@ modify the schema.
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 Enterprise Edition, you will need a license key. Please
[contact Hasura Sales](mailto:sales@hasura.io) if you do not already have one.
- You have [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/)
working on your machine.
- You have access to a MySQL database for which you would like to create an API.
@ -71,7 +71,7 @@ wget https://raw.githubusercontent.com/hasura/graphql-engine/master/install-mani
curl https://raw.githubusercontent.com/hasura/graphql-engine/master/install-manifests/enterprise/mysql/docker-compose.yaml -o docker-compose.yaml
```
### Step 2: Set the Hasura EE license key and the admin secret
### Step 2: Set the Hasura Enterprise Edition license key and the admin secret
Edit the downloaded `docker-compose.yaml` and set the license key and admin secret.
@ -157,7 +157,7 @@ automatically build a full-featured GraphQL API for it.
### Step 8 (optional): Use managed PostgreSQL and Redis instances
The Hasura EE Docker compose files come with containerized open-source versions of PostgreSQL and Redis.
The Hasura Enterprise Edition Docker compose files come with containerized open-source versions of PostgreSQL and Redis.
We highly recommend using managed PostgreSQL and Redis instances especially when running in production.

8
docs/docs/databases/oracle/docker.mdx
View File

@ -50,8 +50,8 @@ modify the schema.
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 Enterprise Edition, you will need a license key. Please
[contact Hasura Sales](mailto:sales@hasura.io) if you do not already have one.
- You have [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/)
working on your machine.
- You have access to a Oracle database for which you would like to create an API.
@ -70,7 +70,7 @@ wget https://raw.githubusercontent.com/hasura/graphql-engine/master/install-mani
curl https://raw.githubusercontent.com/hasura/graphql-engine/master/install-manifests/enterprise/oracle/docker-compose.yaml
```
### Step 2: Set the Hasura EE license key and the admin secret
### Step 2: Set the Hasura Enterprise Edition license key and the admin secret
Edit the downloaded `docker-compose.yaml` and set the license key and admin secret.
@ -153,7 +153,7 @@ automatically build a full-featured GraphQL API for it.
### Step 8 (optional): Use managed PostgreSQL and Redis instances
The Hasura EE Docker compose files come with containerized open-source versions of PostgreSQL and Redis.
The Hasura Enterprise Edition Docker compose files come with containerized open-source versions of PostgreSQL and Redis.
We highly recommend using managed PostgreSQL and Redis instances especially when running in production.

4
docs/docs/databases/snowflake/getting-started/index.mdx
View File

@ -13,8 +13,8 @@ keywords:
:::caution Snowflake Beta Availability
The Hasura Snowflake connector is currently available in `beta` for all Hasura Cloud offerings and for Hasura
Enterprise Edition (EE) customers. Once the Snowflake connector is generally available (GA), it will be available only for
Hasura Cloud Enterprise and EE customers.
Enterprise Edition customers. Once the Snowflake connector is generally available (GA), it will be available only for
Hasura Cloud Enterprise and Enterprise Edition customers.
:::

4
docs/docs/databases/snowflake/index.mdx
View File

@ -15,8 +15,8 @@ keywords:
:::caution Snowflake Beta Availability
The Hasura Snowflake connector is currently available in `beta` for all Hasura Cloud offerings and for Hasura
Enterprise Edition (EE) customers. Once the Snowflake connector is generally available (GA), it will be available only for
Hasura Cloud Enterprise and EE customers.
Enterprise Edition customers. Once the Snowflake connector is generally available (GA), it will be available only for
Hasura Cloud Enterprise and Enterprise Edition customers.
:::

8
docs/docs/deployment/best-practices/metadata.mdx
View File

@ -75,7 +75,7 @@ include the configurations in the exported Metadata.
operates. Queries you structure differently may return unexpected results. You could modify security policies such as
RBAC permissions or allowed queries via Metadata changes that cause unexpected behavior.
- Don't apply Metadata generated from the Community Edition to an Enterprise Edition system that has EE features
configured (e.g., read-replicas). Hasura stores these configurations in the Metadata, and the Community Edition cannot
configure these features. The resulting exported Metadata will not contain these values, and this Metadata would
overwrite the Enterprise Edition configurations if you applied it.
- Don't apply Metadata generated from the Community Edition to an Enterprise Edition system that has Enterprise Edition
features configured (e.g., read-replicas). Hasura stores these configurations in the Metadata, and the Community
Edition cannot configure these features. The resulting exported Metadata will not contain these values, and this
Metadata would overwrite the Enterprise Edition configurations if you applied it.

156
docs/docs/deployment/graphql-engine-flags/reference.mdx
View File

@ -40,7 +40,7 @@ the list of connected data sources.
| **Accepted values** | String (PostgreSQL DB connection string) |
| **Example** | `postgres://<user>:<password>@<host>:<port>/<db-name>` |
| **Default** | `null` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
:::info Note
@ -55,13 +55,13 @@ This Postgres database URL is used to store Hasura's Metadata. By default, the d
`HASURA_GRAPHQL_DATABASE_URL` / `--database_url` will be used to store the Metadata.
| | |
| ------------------- | ----------------------------------------------------------- |
| ------------------- | --------------------------------------------------------------------------- |
| **Flag** | `--metadata-database-url <METADATA_DATABASE_URL>` |
| **Env var** | `HASURA_GRAPHQL_METADATA_DATABASE_URL` |
| **Accepted values** | String (PostgreSQL DB connection string) |
| **Example** | `postgres://<user>:<password>@<host>:<port>/<db-name>` |
| **Default** | **CE, EE**: `null` <br />**Cloud**: managed by Hasura Cloud |
| **Supported in** | CE, EE |
| **Default** | **CE, Enterprise Edition**: `null` <br />**Cloud**: managed by Hasura Cloud |
| **Supported in** | CE, Enterprise Edition |
:::info Note
@ -91,19 +91,19 @@ Internal information is included in an error response for requests made by an ad
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `true` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Admin Secret Key
A [secret key](/deployment/securing-graphql-endpoint.mdx) required to access the Hasura instance.
| | |
| ------------------- | ------------------------------------------------------ |
| ------------------- | ---------------------------------------------------------------------- |
| **Flag** | `--admin-secret <ADMIN_SECRET_KEY>` |
| **Env var** | `HASURA_GRAPHQL_ADMIN_SECRET` |
| **Accepted values** | String |
| **Default** | **CE, EE**: null <br />**Cloud**: generated by default |
| **Supported in** | CE, EE, Cloud |
| **Default** | **CE, Enterprise Edition**: null <br />**Cloud**: generated by default |
| **Supported in** | CE, Enterprise Edition, Cloud |
:::info Note
@ -123,7 +123,7 @@ Hasura instance.
| **Accepted values** | Array (of strings) |
| **Default** | `null` |
| **Example** | `'["secret1", "secret2"]'` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
:::info Note
@ -143,19 +143,19 @@ actions from the storage.
| **Env var** | `HASURA_GRAPHQL_ASYNC_ACTIONS_FETCH_INTERVAL` |
| **Accepted values** | Integer (Representing an interval in milliseconds) |
| **Default** | `null` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Auth Hook
The URL required to authorize requests when utilizing [authentication webhooks](/auth/authentication/webhook.mdx).
| | |
| ------------------- | --------------------------- |
| ------------------- | ----------------------------- |
| **Flag** | `--auth-hook <WEBHOOK_URL>` |
| **Env var** | `HASURA_GRAPHQL_AUTH_HOOK` |
| **Accepted values** | String (URL) |
| **Default** | `null` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
:::info Note
@ -175,7 +175,7 @@ requests.
| **Accepted values** | String (HTTP method) |
| **Options** | `GET` or `POST` |
| **Default** | `GET` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Send Request Body to Auth Hook
@ -188,13 +188,13 @@ Whether or not to send the request body (graphql request/variables) to the auth
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `true` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### BigQuery String Numeric Input
Stringify certain
[BigQuery numeric types](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#numeric_types),
specifically `bignumeric`, `float64`, `int64`, `numeric` and aliases thereof, as they don't fit into the `IEEE 754` spec
specifically `bignumeric`, `float64`, `int64`, `numeric` and aliases thereof, as they don't fit into the `IEnterprise EditionE 754` spec
for JSON encoding-decoding.
| | |
@ -204,7 +204,7 @@ for JSON encoding-decoding.
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Connections per Read-Replica
@ -218,7 +218,7 @@ capacity in other stripes.
| **Env var** | `HASURA_GRAPHQL_CONNECTIONS_PER_READ_REPLICA` |
| **Accepted values** | Integer |
| **Default** | `50` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
### Console Assets Directory
@ -233,7 +233,7 @@ instead of the CDN, set the value to `/srv/console-assets`.
| **Accepted values** | String |
| **Options** | `"/srv/console-assets"` |
| **Default** | `null` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### CORS Domain
@ -246,9 +246,9 @@ value will block requests from all other domains**.
| **Flag** | `--cors-domain <DOMAINS>` |
| **Env var** | `HASURA_GRAPHQL_CORS_DOMAIN` |
| **Accepted values** | String (comma separated list of domains) |
| **Default** | **CE**, **EE**: `null` <br />**Cloud**: `*` |
| **Default** | **CE**, **Enterprise Edition**: `null` <br />**Cloud**: `*` |
| **Example** | "https://\*.foo.bar.com:8080, http://\*.localhost, http://localhost:3000, http://example.com" |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
:::info Note
@ -263,13 +263,13 @@ Sets [dev mode](deployment/graphql-engine-flags/config-examples.mdx#dev-mode) fo
errors, includes an `internal` key in the errors extensions of the response.
| | |
| ------------------- | ------------------------- |
| ------------------- | ----------------------------- |
| **Flag** | `--dev-mode` |
| **Env var** | `HASURA_GRAPHQL_DEV_MODE` |
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Default Naming Convention
@ -282,7 +282,7 @@ Used to set the default [naming convention](/schema/postgres/naming-convention.m
| **Accepted values** | String |
| **Options** | `hasura-default` or `graphql-default` |
| **Default** | `hasura-default` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Disable CORS
@ -296,7 +296,7 @@ headers on any request.
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Enable Allow List
@ -310,7 +310,7 @@ Restrict requests allowed to be executed by the GraphQL Engine to those that are
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Enable Apollo Federation
@ -324,20 +324,20 @@ subgraph in an Apollo supergraph.
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Enable Console
Enable the Hasura Console (served by the server on `/` and `/console`).
| | |
| ------------------- | ------------------------------------------------------------------ |
| ------------------- | ---------------------------------------------------------------------------------- |
| **Flag** | `--enable-console <true-or-false>` |
| **Env var** | `HASURA_GRAPHQL_ENABLE_CONSOLE` |
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | **CE**, **EE**: `false` <br />**Cloud**: Console is always enabled |
| **Supported in** | CE, EE |
| **Default** | **CE**, **Enterprise Edition**: `false` <br />**Cloud**: Console is always enabled |
| **Supported in** | CE, Enterprise Edition |
### Enable Log Compression
@ -350,7 +350,7 @@ Enable sending compressed logs to [metrics server](/enterprise/metrics.mdx).
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | EE |
| **Supported in** | Enterprise Edition |
### Enable Maintenance Mode
@ -363,7 +363,7 @@ Enabling [maintenance mode](/hasura-cloud/projects/maintenance-mode.mdx) disable
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Enable Metadata Query Logging
@ -377,7 +377,7 @@ queries.
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Enable Remote Schema Permissions
@ -390,7 +390,7 @@ Enable [RBAC for Remote Schemas](/remote-schemas/auth/remote-schema-permissions.
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Enable Telemetry
@ -403,7 +403,7 @@ Setting this enables or disables [anonymous telemetry](/policies/telemetry.mdx).
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `true` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Enabled APIs
@ -416,7 +416,7 @@ List of [APIs](/api-reference/overview.mdx) to be enabled on a Hasura GraphQL En
| **Accepted values** | String (Comma-separated) |
| **Options** | `metadata`, `graphql`, `pgdump`, `config`, `metrics` |
| **Default** | `metadata, graphql, pgdump, config` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Enabled Log Types
@ -429,7 +429,7 @@ List of [log types](/deployment/logging.mdx#log-types) to enable.
| **Accepted values** | String (Comma-separated) |
| **Options** | `startup`, `http-log`, `webhook-log`, `websocket-log` |
| **Default** | `startup, http-log, webhook-log, websocket-log` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Events HTTP Pool Size
@ -441,7 +441,7 @@ Maximum number of concurrent HTTP workers for event delivery.
| **Env var** | `HASURA_GRAPHQL_EVENTS_HTTP_POOL_SIZE` |
| **Accepted values** | Integer |
| **Default** | `100` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Events Fetch Batch Size
@ -453,7 +453,7 @@ The maximum number of events to be fetched from the DB in a single batch.
| **Env var** | `HASURA_GRAPHQL_EVENTS_FETCH_BATCH_SIZE` |
| **Accepted values** | Integer |
| **Default** | `100` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Events Fetch Interval
@ -466,7 +466,7 @@ Postgres.
| **Env var** | `HASURA_GRAPHQL_EVENTS_FETCH_INTERVAL` |
| **Accepted values** | Integer |
| **Default** | `null` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Experimental Features
@ -479,7 +479,7 @@ List of experimental features to be enabled.
| **Accepted values** | String (Comma-separated list) |
| **Options** | `inherited_roles`, `optimise_permission_filters`, `naming_convention`, `streaming_subscriptions`, `apollo_federation`, `hide_update_many_fields`, `bigquery_string_numeric_input`, `hide_aggregation_predicates`, `hide_stream_fields` |
| **Default** | `null` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Graceful Shutdown Timeout
@ -493,7 +493,7 @@ completely. If the in-flight events are not completed within the timeout, those
| **Env var** | `HASURA_GRAPHQL_GRACEFUL_SHUTDOWN_TIMEOUT` |
| **Accepted values** | Integer (Representing an interval measured in seconds) |
| **Default** | `60` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Infer Function Permissions
@ -514,7 +514,7 @@ details.
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `true` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### JWT Secret
@ -528,7 +528,7 @@ and the JWK (`key`) used for verifying a JWT. See the [JWT docs](/auth/authentic
| **Accepted values** | JSON |
| **Example** | `{"type": "HS256", "key": "3bd561c37d214b4496d09049fadc542c"}` |
| **Default** | `null` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
:::info Note
@ -547,7 +547,7 @@ List of [JWT secrets](/security/multiple-jwt-secrets.mdx) to authenticate with d
| **Accepted values** | JSON array of objects (containing type and the JWK used for verification) |
| **Default** | `null` |
| **Example** | `[{\"type\": \"HS256\", \"key\": \"<your-hmac-shared-secret>\", \"claims_namespace\": \"<optional-custom-claims-key-name>\"}, {\"type\": \"RS256\", \"issuer\": \"my-issuer\", \"key\": \"<your-PEM-RSA-public-key>\", \"claims_namespace\": \"<optional-custom-claims-key-name>\"}]` |
| **Supported in** | EE, Cloud |
| **Supported in** | Enterprise Edition, Cloud |
:::info Note
@ -567,20 +567,20 @@ milliseconds - for any
| **Env var** | `HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_REFETCH_INTERVAL` |
| **Accepted values** | Integer (Representing an interval measured in milliseconds) |
| **Default** | `1000` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Log Level
This variable sets the level for [Hasura's logs](/deployment/logging.mdx#logging-levels).
| | |
| ------------------- | ------------------------------------------------------- |
| ------------------- | ----------------------------------------------------------------------- |
| **Flag** | `--log-level <LEVEL>` |
| **Env var** | `HASURA_GRAPHQL_LOG_LEVEL` |
| **Accepted values** | String |
| **Options** | `debug`, `info`, `warn`, `error` |
| **Default** | `info` |
| **Supported in** | **CE**, **EE**<br/>**Cloud**: can only be set to `info` |
| **Supported in** | **CE**, **Enterprise Edition**<br/>**Cloud**: can only be set to `info` |
### Max Cache Size
@ -592,7 +592,7 @@ The [maximum cache size](/enterprise/caching.mdx), measured in MB, for queries.
| **Env var** | `HASURA_GRAPHQL_MAX_CACHE_SIZE` |
| **Accepted values** | Integer (Representing cache size measured in MB) |
| **Default** | `1` |
| **Supported in** | **EE**, **Cloud**: Standard / Professional tier is set to `100` MB as the default |
| **Supported in** | **Enterprise Edition**, **Cloud**: Standard / Professional tier is set to `100` MB as the default |
### Metadata Database Extension Schema
@ -604,7 +604,7 @@ The schema in which Hasura can install extensions in the Metadata database.
| **Env var** | `HASURA_GRAPHQL_METADATA_DATABASE_EXTENSIONS_SCHEMA` |
| **Accepted values** | String |
| **Default** | `public` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Multiplexed Batch Size
@ -617,7 +617,7 @@ Multiplexed live queries are split into
| **Env var** | `HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_BATCH_SIZE` |
| **Accepted values** | Integer |
| **Default** | `100` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Number of Retries
@ -654,7 +654,7 @@ stripe pseudo-randomly.
| **Env var** | `HASURA_GRAPHQL_PG_STRIPES` |
| **Accepted values** | Integer |
| **Default** | `1` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### PG Connections
@ -723,7 +723,7 @@ The path for storage of Postgres SSL certificates when set via environment varia
| **Env var** | `HASURA_GRAPHQL_PG_SSL_CERTIFICATE_PATH` |
| **Accepted values** | String (Representing a file path) |
| **Default** | `null` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
### Postgres Timeout
@ -772,7 +772,7 @@ The hostname to use for SNI when connecting to a rate-limiting [Redis instance o
| **Env var** | `HASURA_GRAPHQL_RATE_LIMIT_REDIS_TLS_HOSTNAME` |
| **Accepted values** | String |
| **Default** | `null` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
### Rate-Limit Redis URL
@ -785,7 +785,7 @@ The [Redis URL](/enterprise/caching.mdx) to use for rate limiting.
| **Accepted values** | String |
| **Example** | `redis://username:password@host:port/db` |
| **Default** | `null` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
### Rate-Limit Redis Use TLS
@ -798,7 +798,7 @@ Whether to use TLS to connect to a caching [Redis instance](/enterprise/caching.
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
### Read Replica URL
@ -828,7 +828,7 @@ The hostname to use for SNI when connecting to a [caching Redis instance over TL
| **Env var** | `HASURA_GRAPHQL_REDIS_TLS_HOSTNAME` |
| **Accepted values** | String |
| **Default** | `null` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
### Redis TLS Shared CA Store Path
@ -841,7 +841,7 @@ The path to a shared CA store to use to connect to both (caching and rate-limiti
| **Env var** | `HASURA_GRAPHQL_REDIS_TLS_SHARED_CA_STORE_PATH` |
| **Accepted values** | String |
| **Default** | `null` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
### Redis URL
@ -854,7 +854,7 @@ The Redis URL to use for [query caching](/enterprise/caching.mdx).
| **Accepted values** | String |
| **Default** | `null` |
| **Example** | `redis://username:password@host:port/db` |
| **Supported in** | EE only |
| **Supported in** | Enterprise Edition only |
### Schema Sync Poll Interval
@ -866,31 +866,31 @@ The interval, in milliseconds, to poll Metadata storage for updates. To disable,
| **Env var** | `HASURA_GRAPHQL_SCHEMA_SYNC_POLL_INTERVAL` |
| **Accepted values** | Integer (Representing an interval in milliseconds) |
| **Default** | `1000` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Server Host
The host on which `graphql-engine` will listen. The default is `*`.
| | |
| ------------------- | -------------------------------------------------------- |
| ------------------- | ------------------------------------------------------------------------ |
| **Flag** | `--server-host <HOST>` |
| **Env var** | `HASURA_GRAPHQL_SERVER_HOST` |
| **Accepted values** | String |
| **Default** | **CE, EE**: `*` <br />**Cloud**: managed by Hasura Cloud |
| **Supported in** | CE, EE |
| **Default** | **CE, Enterprise Edition**: `*` <br />**Cloud**: managed by Hasura Cloud |
| **Supported in** | CE, Enterprise Edition |
### Server Port
The port on which `graphql-engine` should be served.
| | |
| ------------------- | ----------------------------------------------------------- |
| ------------------- | --------------------------------------------------------------------------- |
| **Flag** | `--server-host <PORT>` |
| **Env var** | `HASURA_GRAPHQL_SERVER_PORT` |
| **Accepted values** | Integer |
| **Default** | **CE, EE**: `8080` <br />**Cloud**: managed by Hasura Cloud |
| **Supported in** | CE, EE |
| **Default** | **CE, Enterprise Edition**: `8080` <br />**Cloud**: managed by Hasura Cloud |
| **Supported in** | CE, Enterprise Edition |
### Streaming Queries Multiplexed Batch Size
@ -898,12 +898,12 @@ Multiplexed [streaming queries](/subscriptions/postgres/streaming/index.mdx) are
size.
| | |
| ------------------- | --------------------------------------------------------- |
| ------------------- | ------------------------------------------------------------------------- |
| **Flag** | `--streaming-queries-multiplexed-batch-size <SIZE>` |
| **Env var** | `HASURA_GRAPHQL_STREAMING_QUERIES_MULTIPLEXED_BATCH_SIZE` |
| **Accepted values** | Integer |
| **Default** | `100` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Streaming Queries Multiplexed Refetch Interval
@ -916,12 +916,12 @@ any - will be sent, at most, once during this interval.
| **Env var** | `HASURA_GRAPHQL_STREAMING_QUERIES_MULTIPLEXED_REFETCH_INTERVAL` |
| **Accepted values** | Integer (Representing an interval in milliseconds) |
| **Default** | `1000` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Stringify Numeric Types
Stringify certain [Postgres numeric types](/schema/postgres/postgresql-types.mdx), specifically `bigint` ,`numeric`
,`decimal` and `double precision` as they don't fit into the `IEEE-754` spec for JSON encoding-decoding.
,`decimal` and `double precision` as they don't fit into the `IEnterprise EditionE-754` spec for JSON encoding-decoding.
| | |
| ------------------- | ---------------------------------------- |
@ -930,7 +930,7 @@ Stringify certain [Postgres numeric types](/schema/postgres/postgresql-types.mdx
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Stripes per Read Replica
@ -981,7 +981,7 @@ This identifies an [unauthorized role](/auth/authentication/unauthenticated-acce
| **Accepted values** | String |
| **Example** | Setting this value to `anonymous`, whenever the `Authorization` header is absent, the request's role will default to `anonymous`. |
| **Default** | `null` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Use Prepared Statements
@ -1014,7 +1014,7 @@ Evaluate `null` values in `where` input object to `True` instead of `error`. Lea
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE, Cloud |
| **Supported in** | CE, Enterprise Edition, Cloud |
### Websocket Compression
@ -1027,7 +1027,7 @@ Enable WebSocket `permessage-deflate` compression.
| **Accepted values** | Boolean |
| **Options** | `true` or `false` |
| **Default** | `false` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Websocket Connection Init Timeout
@ -1040,7 +1040,7 @@ Used to set the connection initialization timeout for `graphql-ws` clients. This
| **Env var** | `HASURA_GRAPHQL_WEBSOCKET_CONNECTION_INIT_TIMEOUT` |
| **Accepted values** | Integer (Representing a timeout in milliseconds) |
| **Default** | `3` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### Websocket Keepalive
@ -1048,12 +1048,12 @@ Used to set the `Keep Alive` delay for clients that use the `subscription-transp
`graphql-ws` clients, the `graphql-engine` sends `PING` messages instead.
| | |
| ------------------- | ----------------------------------------- |
| ------------------- | ---------------------------------------------------- |
| **Flag** | `--websocket-keepalive <TIME_IN_SECONDS>` |
| **Env var** | `HASURA_GRAPHQL_WEBSOCKET_KEEPALIVE` |
| **Env var** | `HASURA_GRAPHQL_WEBSOCKET_KEnterprise EditionPALIVE` |
| **Accepted values** | Integer (Representing a delay in seconds) |
| **Default** | `5` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
### WS Read Cookie
@ -1067,6 +1067,6 @@ disabled. **This can be a potential security flaw!** This configuration is only
| **Accepted values** | Boolean |
| **Default** | `false` |
| **Options** | `true` or `false` |
| **Supported in** | CE, EE |
| **Supported in** | CE, Enterprise Edition |
</div>

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

@ -1,8 +1,8 @@
---
sidebar_label: Enable caching
sidebar_position: 5
description: Hasura EE caching
title: 'EE: Enable GraphQL caching'
description: Hasura Enterprise Edition caching
title: 'Enterprise Edition: Enable GraphQL caching'
keywords:
- hasura
- docs
@ -22,8 +22,8 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
## Introduction
To start using [Hasura Caching](/caching/overview.mdx) with your Hasura EE GraphQL Engine you will need a Redis instance
that is co-located with the Hasura GraphQL containers.
To start using [Hasura Caching](/caching/overview.mdx) with your Hasura Enterprise Edition GraphQL Engine you will need
a Redis instance that is co-located with the Hasura GraphQL containers.
Once you provision a Redis instance, provide the URL to the Hasura GraphQL Engine docker configuration using the
following environment variable:

2
docs/docs/enterprise/dependencies.mdx
View File

@ -2,7 +2,7 @@
sidebar_label: Licenses and library dependencies
sidebar_position: 8
description: Licenses and dependencies for the Hasura Enterprise Edition data plane
title: 'EE: Licenses and Dependencies'
title: 'Enterprise Edition: Licenses and Dependencies'
keywords:
- hasura
- docs

22
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: 'Enterprise Edition: Get started'
keywords:
- hasura
- docs
@ -15,11 +15,11 @@ slug: index
## Prerequisites
1. Hasura EE can be deployed as a single Docker container and so to install and use this product, you will need a
container platform (e.g. Docker, Kubernetes, AWS ECS, Google CloudRun, Azure Containers).
1. Hasura Enterprise Edition can be deployed as a single Docker container and so to install and use this product, you
will need a container platform (e.g. Docker, Kubernetes, AWS ECS, Google CloudRun, Azure Containers).
2. Hasura EE depends on the following software for its features. We highly recommend using managed instances from your
cloud or infrastructure provider.
2. Hasura Enterprise Edition depends on the following software for its features. We highly recommend using managed
instances from your cloud or infrastructure provider.
- **PostgreSQL database (v10 or above)** to store your Metadata (just like Hasura CE).
- **(Optional) Redis database (v5 or above) for setting up query response caching**.
@ -28,16 +28,18 @@ slug: index
### Installation in a container platform
Please refer to the quickstart sections which describe how to install Hasura EE in various container platforms. **Each
of the below guides requires HGE versions `v2.12.0` and above.**
Please refer to the quickstart sections which describe how to install Hasura Enterprise Edition in various container
platforms. **Each of the below guides requires HGE versions `v2.12.0` and above.**
- [Quickstart with Docker](/enterprise/getting-started/quickstart-docker.mdx)
- [Quickstart with AWS ECS](/enterprise/getting-started/quickstart-aws-ecs.mdx)
- [Quickstart with Kubernetes](/enterprise/getting-started/quickstart-kubernetes.mdx)
- [Quickstart with Google Cloud Run](/enterprise/getting-started/quickstart-google-cloud-run.mdx)
### Enable EE features
You can register for a 30 days free [EE Trials](/enterprise/try-hasura-enterprise-edition.mdx) and enable EE features right away.
### Enable Enterprise Edition features
You can register for a 30 days free [Enterprise Edition Trials](/enterprise/try-hasura-enterprise-edition.mdx) and
enable Enterprise Edition features right away.
If you already have an EE license key provided by Hasura Sales, please follow [these steps](/enterprise/upgrade-ce-to-ee.mdx) to apply the license to your Hasura container.
If you already have an Enterprise Edition license key provided by Hasura Sales, please follow
[these steps](/enterprise/upgrade-ce-to-ee.mdx) to apply the license to your Hasura container.

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: 'Enterprise Edition: Quickstart with AWS ECS'
keywords:
- hasura
- docs
@ -22,7 +22,7 @@ Fargate task, and perform other common tasks in Amazon ECS with the AWS CLI.
**This guide requires HGE versions `v2.12.0` and above.** Installation instructions are below.
## Deploying Hasura EE on ECS
## Deploying Hasura Enterprise Edition on ECS
### Prerequisites
@ -123,7 +123,7 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
:::
### Step 4 (optional): Set the EE license key
### Step 4 (optional): Set the Enterprise Edition license key
If you have been provided a license key by Hasura Sales, add this as an environment variable.
@ -157,8 +157,8 @@ Edit `hasura-fargate-task.json` and add the license key value:
}
```
This is not a required step. You can also enable EE features just by registering for
[EE Trial](/enterprise/try-hasura-enterprise-edition.mdx) in the Hasura Console.
This is not a required step. You can also enable Enterprise Edition features just by registering for
[Enterprise Edition Trial](/enterprise/try-hasura-enterprise-edition.mdx) in the Hasura Console.
### Step 5: Register the Task Definition

18
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: 'Enterprise Edition: Quickstart with Docker'
keywords:
- hasura
- docs
@ -24,7 +24,7 @@ Enterprise Edition on your **local environment**.
**This guide requires HGE versions `v2.12.0` and above.** Installation instructions are below.
## Deploying Hasura EE using Docker
## Deploying Hasura Enterprise Edition using Docker
### Prerequisites
@ -66,7 +66,7 @@ information on setting up authentication.
:::
### Step 3 (optional): Set EE License Key
### Step 3 (optional): Set Enterprise Edition License Key
If you have been provided a license key by Hasura Sales, add this as an environment variable.
@ -79,8 +79,8 @@ graphql-engine:
...
```
This is not a required step. You can also enable EE features just by registering for
[EE Trial](/enterprise/try-hasura-enterprise-edition.mdx) in the Hasura Console.
This is not a required step. You can also enable Enterprise Edition features just by registering for
[Enterprise Edition Trial](/enterprise/try-hasura-enterprise-edition.mdx) in the Hasura Console.
### Step 4: Run Hasura GraphQL Engine
@ -102,8 +102,8 @@ b0b1aac0508d postgres ... 1m ago Up 1m 5432/tcp ...
### Step 5 (optional): Use your PostgreSQL and Redis instances
The Hasura EE Docker compose files come with containerized open-source versions of PostgreSQL and Redis. Note that these
are not managed by Hasura.
The Hasura Enterprise Edition Docker compose files come with containerized open-source versions of PostgreSQL and Redis.
Note that these are not managed by Hasura.
We highly recommend using managed PostgreSQL and Redis instances in production.
@ -121,8 +121,8 @@ graphql-engine:
### Step 6: Start using Hasura
Congratulations! You have successfully set up Hasura EE on Docker.
[Start using Hasura EE now](/enterprise/getting-started/start-using-hasura-ee.mdx).
Congratulations! You have successfully set up Hasura Enterprise Edition on Docker.
[Start using Hasura Enterprise Edition now](/enterprise/getting-started/start-using-hasura-ee.mdx).
## Hasura GraphQL Engine server logs {#docker-logs}

8
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: 'Enterprise Edition: Quickstart with Google Cloud Run'
keywords:
- hasura
- docs
@ -21,7 +21,7 @@ This tutorial will help you run Hasura Enterprise Edition as a Google Cloud Run
**This guide requires HGE versions `v2.12.0` and above.** Installation instructions are below.
## Deploying Hasura EE on Cloud Run
## Deploying Hasura Enterprise Edition on Cloud Run
### Prerequisites
@ -97,8 +97,8 @@ HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL: 'redis://redis:6379'
HASURA_GRAPHQL_ADMIN_SECRET: myadminsecretkey
```
This is not a required step. You can also enable EE features just by registering for
[EE Trial](/enterprise/try-hasura-enterprise-edition.mdx) in the Hasura Console.
This is not a required step. You can also enable Enterprise Edition features just by registering for
[Enterprise Edition Trial](/enterprise/try-hasura-enterprise-edition.mdx) in the Hasura Console.
### Step 4: Copy the Hasura graphql-engine image to the GCR registry

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: 'Enterprise Edition: Quickstart with Kubernetes'
keywords:
- hasura
- docs
@ -21,7 +21,7 @@ This tutorial helps you set up Hasura Enterprise Edition on Kubernetes and conne
**This guide requires HGE versions `v2.12.0` and above.** Installation instructions are below.
## Deploying Hasura EE on Kubernetes
## Deploying Hasura Enterprise Edition on Kubernetes
### Prerequisites
@ -90,7 +90,7 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
:::
### Step 3 (optional): Set the EE license key
### Step 3 (optional): Set the Enterprise Edition license key
If you have been provided a license key by Hasura Sales, add this as an environment variable.
@ -111,8 +111,8 @@ env:
value: adminsecret
```
This is not a required step. You can also enable EE features just by registering for
[EE Trial](/enterprise/try-hasura-enterprise-edition.mdx) in the Hasura Console.
This is not a required step. You can also enable Enterprise Edition features just by registering for
[Enterprise Edition Trial](/enterprise/try-hasura-enterprise-edition.mdx) in the Hasura Console.
### Step 4: Create the Kubernetes deployment and service
@ -138,8 +138,8 @@ Head to: `http://localhost` and the Console should load!
### Step 6: Start using Hasura
Congratulations! You have successfully set up Hasura EE on Docker.
[Start using Hasura EE now](/enterprise/getting-started/start-using-hasura-ee.mdx).
Congratulations! You have successfully set up Hasura Enterprise Edition on Docker.
[Start using Hasura Enterprise Edition now](/enterprise/getting-started/start-using-hasura-ee.mdx).
## Hasura GraphQL Engine server logs {#kubernetes-logs}

8
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'
sidebar_label: Start using Hasura Enterprise Edition
description: Start using Hasura Enterprise Edition
title: 'Start Using Hasura Enterprise Edition'
keywords:
- hasura
- docs
@ -15,7 +15,7 @@ sidebar_position: 5
## Instructions
After following one of the Hasura EE get started guides:
After following one of the Hasura Enterprise Edition get started guides:
- Head to `http://localhost:8080/console` to open the Hasura Console.
- Log in using the admin secret key that you set.

2
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: 'Enterprise Edition: Metrics via Prometheus'
keywords:
- hasura
- docs

12
docs/docs/enterprise/overview.mdx
View File

@ -1,6 +1,6 @@
---
description: Documentation for Hasura Enterprise Edition
title: 'EE: Hasura Enterprise'
title: 'Enterprise Edition: Hasura Enterprise'
keywords:
- hasura
- docs
@ -23,7 +23,7 @@ import Enterprise from '@site/static/icons/features/enterprise.svg';
<div className="overview-header">
<div className="overview-text">
<p>
The open-source version of Hasura is highly capable, but Hasura Enterprise Edition (EE) has additional built-in
The open-source version of Hasura is highly capable, but Hasura Enterprise Edition has additional built-in
features for running Hasura in production on your own infrastructure. These features have key capabilities for observability, security,
and performance.
</p>
@ -33,8 +33,8 @@ import Enterprise from '@site/static/icons/features/enterprise.svg';
</p>
<p>
Sign up for our <b>30-day free <VersionedLink to="/enterprise/try-hasura-enterprise-edition/">
EE Trial
</VersionedLink></b> and evaluate EE features right away. If you have more questions, please <a href="mailto:sales@hasura.io">contact us</a>.
Enterprise Edition Trial
</VersionedLink></b> and evaluate Enterprise Edition features right away. If you have more questions, please <a href="mailto:sales@hasura.io">contact us</a>.
</p>
<h4>Quick Links</h4>
<ul>
@ -45,7 +45,7 @@ import Enterprise from '@site/static/icons/features/enterprise.svg';
</li>
<li>
<VersionedLink to="/enterprise/try-hasura-enterprise-edition/">
Free 30 days Trial for Hasura EE.
Free 30 days Trial for Hasura Enterprise Edition.
</VersionedLink>
</li>
</ul>
@ -61,7 +61,7 @@ import Enterprise from '@site/static/icons/features/enterprise.svg';
## Hasura Enterprise Edition Features
<p>Hasura EE capabilities include all the features of the Hasura Open Source Community Edition plus:</p>
<p>Hasura Enterprise Edition capabilities include all the features of the Hasura Open Source Community Edition plus:</p>
<div className="overview-gallery">
<h2 style={{ gridColumn: `1 / -1`, marginTop: `1.2rem`, marginBottom: `.3rem`, justifySelf: `start`, fontSize: `1.8rem` }}>Databases</h2>
<VersionedLink to="/databases/snowflake/index/">

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

@ -1,8 +1,8 @@
---
sidebar_label: Release notes
sidebar_position: 6
description: Release notes for Hasura EE
title: 'EE: Release notes'
description: Release notes for Hasura Enterprise Edition
title: 'Enterprise Edition: Release notes'
date: 2022-08-08T16:30:59+05:30
keywords:
- hasura

58
docs/docs/enterprise/try-hasura-enterprise-edition.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: Try Hasura Enterprise
description: A guide to try Hasura Enterprise Edition
title: 'EE Trial: Explore Hasura Enterprise Edition for 30 days'
title: 'Enterprise Edition Trial: Explore Hasura Enterprise Edition for 30 days'
keywords:
- hasura
- docs
@ -21,10 +21,11 @@ import Thumbnail from '@site/src/components/Thumbnail';
## Overview
Trying and evaluating Hasura Enterprise features with your current Hasura setup is now easier and self-serve. Starting
with Hasura GraphQL Engine version `v2.23.0`, you can get started with your 30-day EE Trial in **under a minute**!
with Hasura GraphQL Engine version `v2.23.0`, you can get started with your 30-day Enterprise Edition Trial in
**under a minute**!
During your trial period you will have access to all the [EE features](/enterprise/overview.mdx) to help you
successfully evaluate Hasura Enterprise for your use case.
During your trial period you will have access to all the [Enterprise Edition features](/enterprise/overview.mdx) to
help you successfully evaluate Hasura Enterprise for your use case.
:::info Note
@ -42,7 +43,7 @@ successfully evaluate Hasura Enterprise for your use case.
:::
## Activate your EE Trial
## Activate your Enterprise Edition Trial
### Step 1. Run Hasura
@ -59,10 +60,10 @@ Docker container tag to `v2.23.0` or above and then redeploy the container.
### Step 2. Register for your 30-day free Trial
Once Hasura is running, you can register for an EE Trial using the Hasura Console. In the Hasura Console, click on the
`Enterprise` button in the top right and fill out the registration form.
Once Hasura is running, you can register for an Enterprise Edition Trial using the Hasura Console. In the Hasura
Console, click on the `Enterprise` button in the top right and fill out the registration form.
<Thumbnail src="/img/enterprise/Trials_Register_Button.png" alt="EE Trial register button" width="1146px" />
<Thumbnail src="/img/enterprise/Trials_Register_Button.png" alt="Enterprise Edition Trial register button" width="1146px" />
Filling out this form will automatically create a Hasura Cloud account. **If you already have an existing Hasura Cloud
account, please use the same credentials in the form**. You can use the same Hasura Cloud account to centrally manage
@ -70,13 +71,14 @@ all your enterprise licenses (this feature to be added soon).
Please see the [FAQ](#frequently-asked-questions) section in case you are facing issues with registration.
<Thumbnail src="/img/enterprise/Trials_Registration_form.png" alt="EE Trial Registration Form" width="600px" />
<Thumbnail src="/img/enterprise/Trials_Registration_form.png" alt="Enterprise Edition Trial Registration Form" width="600px" />
<Thumbnail src="/img/enterprise/Trials_Succeeded.png" alt="EE Trial Success" width="600px" />
<Thumbnail src="/img/enterprise/Trials_Succeeded.png" alt="Enterprise Edition Trial Success" width="600px" />
### Step 3. Restart your container
Once you have registered for the EE Trial, restart your Hasura GraphQL Engine instance. This is required only once.
Once you have registered for the Enterprise Edition Trial, restart your Hasura GraphQL Engine instance. This is
required only once.
Example:
@ -86,10 +88,10 @@ docker-compose restart graphql-engine
Now, refresh the Hasura Console and you're all set to explore Hasura Enterprise Edition 🎉
<Thumbnail src="/img/enterprise/Trials_Activated.png" alt="EE Trial Activated view" width="1000px" />
<Thumbnail src="/img/enterprise/Trials_Activated.png" alt="Enterprise Edition Trial Activated view" width="1000px" />
To view all EE features you've just enabled, click the `EE` button in the navigation bar. Conveniently, this also
displays the number of days remaining in your trial period.
To view all Enterprise Edition features you've just enabled, click the `EE` button in the navigation bar.
Conveniently, this also displays the number of days remaining in your trial period.
<Thumbnail src="/img/enterprise/Trials_EE_Benefits.png" alt="EE Trial Benefits View" width="500px" />
@ -99,26 +101,27 @@ The license information can also be found in the `Settings` view.
## Frequently Asked Questions
### I registered for the trial but I can't see the EE features. Where are they?
### I registered for the trial but I can't see the Enterprise Edition features. Where are they?
If you have already registered, please restart your Docker container once.
### I restarted my Hasura Docker container but I still can't see EE features. What should I do?
### I restarted my Hasura Docker container but I still can't see Enterprise Edition features. What should I do?
Please try registering for the trial again by filling out the registration form, in case previous registration attempt
failed due to some reason. If the issue persists, please [contact us](https://hasura.io/contact-us-eetrial) and we'll be
happy to help you.
### I need some more time to explore EE; how can I extend my Trial license?
### I need some more time to explore Enterprise Edition; how can I extend my Trial license?
Please [contact us](https://hasura.io/contact-us-eetrial) and our team will assist you.
### Will the EE Trial work for a multiple-replica setup of Hasura?
### Will the Enterprise Edition Trial work for a multiple-replica setup of Hasura?
Yes, you would need to register once, and all the replicas of your Hasura backed by same metadata database will have EE
features enabled.
Yes, you would need to register once, and all the replicas of your Hasura backed by same metadata database will have
Enterprise Edition features enabled.
### I am already in an EE evaluation period; how can I continue evaluation with a different Hasura environment?
### I am already in an Enterprise Edition evaluation period; how can I continue evaluation with a different Hasura
environment?
In your new Hasura instance, open the Console and click on `Enterprise`. Then, select `Activate Existing License`.
Please enter the same credentials you used for the initial Trial registration. Restart Hasura and now the same Trial
@ -126,25 +129,26 @@ license will be applied to this new instance too.
### Why do I need to enter a password to register for a Trial?
As you register for the EE Trial, we use the email and password to create a Hasura Cloud account. This will be used for
verification and also help manage your Enterprise licenses in the future (this feature to be added soon).
As you register for the Enterprise Edition Trial, we use the email and password to create a Hasura Cloud account. This
will be used for verification and also help manage your Enterprise licenses in the future (this feature to be added
soon).
### I forgot the password with which I registered; how do I enable the Trial now?
Please head to [Hasura Cloud](https://cloud.hasura.io/login) and click on 'Forgot?' to recover your password. Please use
the updated password to register for the EE Trial.
the updated password to register for the Enterprise Edition Trial.
### I use an OAuth login on Hasura Cloud; how do I register for EE Trial?
### I use an OAuth login on Hasura Cloud; how do I register for an Enterprise Edition Trial?
You can register for a Trial with same email, but a new password. Your Hasura Cloud account will be updated with the new
password.
### I use SSO on Hasura Cloud to login; how do I enable an EE Trial?
### I use SSO on Hasura Cloud to login; how do I enable an Enterprise Edition Trial?
Please register with a different email or [contact us](https://hasura.io/contact-us-eetrial) if you want to continue
with the same email. We will add support for SSO users in future.
### What kind of data does Hasura collect during an EE Trial?
### What kind of data does Hasura collect during an Enterprise Edition Trial?
[This guide](/policies/telemetry.mdx) elaborates on the data collected by Hasura in line with the
[Hasura privacy policy](https://hasura.io/legal/hasura-privacy-policy/).

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

@ -1,7 +1,7 @@
---
sidebar_label: Upgrade from CE to Enterprise
description: A guide to upgrade from Hasura CE to Hasura Enterprise
title: 'EE: Upgrade from Hasura CE to Hasura Enterprise'
title: 'Enterprise Edition: Upgrade from Hasura CE to Hasura Enterprise'
keywords:
- hasura
- docs
@ -17,8 +17,8 @@ sidebar_position: 9
:::info Note
There's now a much quicker and self-serve manner to enable EE features using
[EE Trials](/enterprise/try-hasura-enterprise-edition.mdx).
There's now a much quicker and self-serve manner to enable Enterprise Edition features using
[Enterprise Edition Trials](/enterprise/try-hasura-enterprise-edition.mdx).
The documentation below still applies for Hasura versions before `v2.23.0`

4
docs/docs/faq.mdx
View File

@ -209,8 +209,8 @@ have guides for some of the popular authentication providers. Read more [here.](
## Does Hasura also automatically cache queries or data to improve performance? {#faq-hasura-query-caching}
Query response caching (available on Hasura Cloud & Hasura EE) can be enabled by specifying which query to cache using
the @cached directive. Read more about caching
Query response caching (available on Hasura Cloud & Hasura Enterprise Edition) can be enabled by specifying which query
to cache using the @cached directive. Read more about caching
[here.](https://hasura.io/learn/graphql/hasura-advanced/performance/1-caching/)
## How do I limit what data my users can see? {#faq-authorization}

4
docs/docs/glossary.mdx
View File

@ -116,9 +116,9 @@ be used only from Console.
For accessing the API from other clients, use the admin secret or create a Personal Access Token.
## Hasura EE (Enterprise Edition)
## Hasura Enterprise Edition
Hasura Enterprise edition that includes a self-hosted control plane.
A self-hosted version of Hasura that includes enterprise specific features for observability, security and more.
## Lux _or_ Control Plane (Enterprise Edition)

4
docs/docs/hasura-cli/config-reference.mdx
View File

@ -122,11 +122,11 @@ The following environment variables can be utilized to configure different value
the CLI:
| Environment variable | Config file key | Description |
| ------------------------------------------------ | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------------------------------------ | --------------------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `HASURA_GRAPHQL_VERSION` | `version` | Config version to be used. |
| `HASURA_GRAPHQL_ENDPOINT` | `endpoint` | http(s) endpoint for Hasura GraphQL Engine. |
| `HASURA_GRAPHQL_ADMIN_SECRET` | `admin_secret` | Admin secret for Hasura GraphQL Engine. |
| `HASURA_GRAPHQL_ADMIN_SECRETS` | `admin_secrets` | [Admin secrets](/security/multiple-admin-secrets.mdx) for Hasura GraphQL Engine _(Cloud/EE only)_. eg: `HASURA_GRAPHQL_ADMIN_SECRETS='["foo", "bar", "baz"]'` |
| `HASURA_GRAPHQL_ADMIN_SECRETS` | `admin_secrets` | [Admin secrets](/security/multiple-admin-secrets.mdx) for Hasura GraphQL Engine _(Cloud/Enterprise Edition only)_. eg: `HASURA_GRAPHQL_ADMIN_SECRETS='["foo", "bar", "baz"]'` |
| `HASURA_GRAPHQL_ACCESS_KEY` | `access_key` | Access key for Hasura GraphQL Engine. Note: Deprecated. Use admin secret instead. |
| `HASURA_GRAPHQL_INSECURE_SKIP_TLS_VERIFY` | `insecure_skip_tls_verify` | Skip verifying SSL certificate for the Hasura endpoint. Useful if you have a self-singed certificate and don't have access to the CA cert. |
| `HASURA_GRAPHQL_CERTIFICATE_AUTHORITY` | `certificate_authority` | Path to the CA certificate for validating the self-signed certificate for the Hasura endpoint. |

2
docs/docs/hasura-cloud/sso.mdx
View File

@ -1,7 +1,7 @@
---
sidebar_label: 'SSO'
description: 'Enable single sign-on (SSO) for Hasura Enterprise through the SAML 2.0 protocol'
title: 'EE: Enable SSO through SAML'
title: 'Enterprise Edition: Enable SSO through SAML'
keywords:
- hasura
- docs

2
docs/docs/index.mdx
View File

@ -48,7 +48,7 @@ import Testing from '@site/static/icons/features/testing.svg';
<br />
<br />
<VersionedLink to="/enterprise/overview">
<b>Hasura Enterprise Edition (EE)</b>
<b>Hasura Enterprise Edition</b>
</VersionedLink>{' '}
builds on all the features of the Hasura GraphQL Engine while giving you an enterprise-ready solution - complete
with key features like observability, security, and performance - deployable in minutes.

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

@ -1,5 +1,5 @@
---
title: 'Cloud Standard, Professional, & EE: Hasura Service Level Agreement'
title: 'Cloud Standard, Professional, & Enterprise Edition: Hasura Service Level Agreement'
description: Hasura Service Level Agreement for Hasura Cloud
sidebar_label: Hasura SLA
sidebar_position: 2

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

@ -10,7 +10,7 @@ keywords:
sidebar_position: 2
sidebar_label: API limits
sidebar_class_name: cloud-and-enterprise-icon
title: 'Cloud & EE: API Limits'
title: 'Cloud & Enterprise Edition: API Limits'
---
import Thumbnail from '@site/src/components/Thumbnail';

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

@ -1,6 +1,6 @@
---
description: Hasura Cloud and EE disable GraphQL introspection
title: 'Cloud Standard & EE: Disable GraphQL introspection'
description: Hasura Cloud and Enterprise Edition disable GraphQL introspection
title: 'Cloud Standard & Enterprise Edition: Disable GraphQL introspection'
keywords:
- hasura
- docs

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

@ -1,6 +1,6 @@
---
description: Hasura Cloud and Hasura Enterprise multiple admin secrets
title: 'Cloud Standard & EE: Multiple Admin Secrets'
title: 'Cloud Standard & Enterprise Edition: Multiple Admin Secrets'
keywords:
- hasura
- docs
@ -43,9 +43,9 @@ For example:
["secret-1", "secret-2"]
```
When you launch the Console from the Hasura Cloud or the Hasura EE Control Plane dashboard, you can use any secret from
the admin secrets list to authenticate yourself as an admin. If you want to make API calls as an admin from outside the
console, you need to pass any one of the admin secrets as the `x-hasura-admin-secret` request header.
When you launch the Console from the Hasura Cloud or the Hasura Enterprise Edition Control Plane dashboard, you can use
any secret from the admin secrets list to authenticate yourself as an admin. If you want to make API calls as an admin
from outside the console, you need to pass any one of the admin secrets as the `x-hasura-admin-secret` request header.
:::info Note
@ -56,8 +56,8 @@ If both `HASURA_GRAPHQL_ADMIN_SECRET` and `HASURA_GRAPHQL_ADMIN_SECRETS` are set
## Rotating admin secrets (self-hosted environments)
When you have a self-hosted Hasura EE setup, you can use this feature to implement a secret rotation mechanism without
downtime as outlined below:
When you have a self-hosted Hasura Enterprise Edition setup, you can use this feature to implement a secret rotation
mechanism without downtime as outlined below:
1. Add a new secret to the list of admin secrets (and perform a rolling deploy)
2. Update applications/services using the old admin secret to use the new secret

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

@ -1,6 +1,6 @@
---
description: Hasura Cloud and Hasura Enterprise multiple JWT Secrets
title: 'Cloud Standard & EE: Multiple JWT Secrets'
title: 'Cloud Standard & Enterprise Edition: Multiple JWT Secrets'
keywords:
- hasura
- docs

2
docs/docs/security/overview.mdx
View File

@ -1,6 +1,6 @@
---
description: Hasura Cloud Standard and Hasura Enterprise API Security
title: 'Cloud & EE: API Security'
title: 'Cloud & Enterprise Edition: API Security'
keywords:
- hasura
- docs