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

docs: improve documentation for Hasura Enterprise

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8902
GitOrigin-RevId: 708d90f07a866891411d9e99799367880b4e9b1b
This commit is contained in:
Rishichandra Wawhal 2023-04-26 17:33:01 +05:30 committed by hasura-bot
parent 107db24caf
commit a3b5cfc8d4
6 changed files with 50 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -65,7 +65,7 @@ installation manifests required to deploy Hasura anywhere. Get the ECS task defi
wget https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-manifests/enterprise/aws-ecs/hasura-fargate-task.json
```
### Step 3: Set the license key, Metadata database URL, Redis database URL and the admin secret
### Step 3: Set the Metadata database URL, Redis database URL and the admin secret
Edit `hasura-fargate-task.json` and set the right values:
@ -124,20 +124,17 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
:::
### 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.
### Step 4: Set up a license key
Edit `hasura-fargate-task.json` and add the license key value:
If you don't have a license key, you can skip this step and proceed with this guide to set up Hasura. Once you have the Hasura up and running, you can sign up for a [free 30 day Enterprise Edition trial](/enterprise/try-hasura-enterprise-edition.mdx) from the Hasura console.
```json {6}
If you have been provided a license key by the Hasura team, add it as an environment variable to Hasura. Edit `hasura-fargate-task.json` and set the license key as the value for HASURA_GRAPHQL_EE_LICENSE_KEY environment variable.
```json {20-23}
---
{
"environment": [
{
"name": "HASURA_GRAPHQL_EE_LICENSE_KEY",
"value": "<license key>"
},
{
"name": "HASURA_GRAPHQL_METADATA_DATABASE_URL",
"value": "postgres://<username>:<password>@hostname:<port>/<dbname>"
@ -153,14 +150,15 @@ Edit `hasura-fargate-task.json` and add the license key value:
{
"name": "HASURA_GRAPHQL_ADMIN_SECRET",
"value": "myadminsecretkey"
},
{
"name": "HASURA_GRAPHQL_EE_LICENSE_KEY",
"value": "<license key>"
}
]
}
```
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
```bash

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

@ -51,10 +51,11 @@ admin secret key.
Edit the downloaded `docker-compose.yml` and set the admin secret as an environment variable.
```yaml {4-5}
```yaml {5}
graphql-engine:
image: hasura/graphql-engine:v2.12.0
environment:
HASURA_GRAPHQL_METADATA_DATABASE_URL: postgres://postgres:postgrespassword@postgres:5432/postgres
HASURA_GRAPHQL_ADMIN_SECRET: myadminsecretkey
...
```
@ -67,22 +68,22 @@ information on setting up authentication.
:::
### Step 3 (optional): Set Enterprise Edition License Key
### Step 3: Set up a license key
If you have been provided a license key by Hasura Sales, add this as an environment variable.
If you don't have a license key, you can skip this step and proceed with this guide to set up Hasura. Once you have Hasura up and running, you can sign up for a [free 30 day Enterprise Edition trial](/enterprise/try-hasura-enterprise-edition.mdx) from the Hasura console.
```yaml {4}
If you have been provided a license key by the Hasura team, add it as an environment variable to Hasura. Edit the `docker-compose.yaml` to set the license key as the value for the `HASURA_GRAPHQL_EE_LICENSE_KEY` environment variable.
```yaml {6}
graphql-engine:
image: hasura/graphql-engine:v2.12.0
environment:
HASURA_GRAPHQL_EE_LICENSE_KEY: "<license key>"
HASURA_GRAPHQL_METADATA_DATABASE_URL: postgres://postgres:postgrespassword@postgres:5432/postgres
HASURA_GRAPHQL_ADMIN_SECRET: myadminsecretkey
HASURA_GRAPHQL_EE_LICENSE_KEY: '<license key>'
...
```
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
The following command will run Hasura GraphQL Engine along with a Postgres database to store its metadata.

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

@ -86,21 +86,20 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
:::
### Step 3 (optional): Set the license key
### Step 3: Set up a license key
Edit `env.yaml` and add the license key value:
If you don't have a license key, you can skip this step and proceed with this guide to set up Hasura. Once you have Hasura up and running, you can sign up for a [free 30 day Enterprise Edition trial](/enterprise/try-hasura-enterprise-edition.mdx) from the Hasura console.
```yaml {1}
HASURA_GRAPHQL_EE_LICENSE_KEY: '<license key>'
If you have been provided a license key by the Hasura team, add it as an environment variable to Hasura. Edit `env.yaml` to set the license key as the value for the `HASURA_GRAPHQL_EE_LICENSE_KEY` environment variable.
```yaml {5}
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_ADMIN_SECRET: myadminsecretkey
HASURA_GRAPHQL_EE_LICENSE_KEY: '<license key>'
```
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
Cloud Run does not allow using images from Dockerhub. Due to this limitation it's necessary to pull the Hasura

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

@ -91,17 +91,15 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
:::
### Step 3 (optional): Set the Enterprise Edition license key
### Step 3: Set up a license key
If you have been provided a license key by Hasura Sales, add this as an environment variable.
If you don't have a license key, you can skip this step and proceed with this guide to set up Hasura. Once you have the Hasura up and running, you can sign up for a [free 30 day Enterprise Edition trial](/enterprise/try-hasura-enterprise-edition.mdx) from the Hasura console.
Edit `deployment.yaml` and add the license key value:
If you have been provided a license key by the Hasura team, add it as an environment variable to Hasura. Edit `deployment.yaml` and set the license key as the value for the `HASURA_GRAPHQL_EE_LICENSE_KEY` environment variable.
```yaml {4}
```yaml {11,12}
---
env:
- name: HASURA_GRAPHQL_EE_LICENSE_KEY
value: '<license key>'
- name: HASURA_GRAPHQL_METADATA_DATABASE_URL
value: postgres://<username>:<password>@hostname:<port>/<dbname>
- name: HASURA_GRAPHQL_REDIS_URL
@ -110,11 +108,10 @@ env:
value: redis://redis:6379
- name: HASURA_GRAPHQL_ADMIN_SECRET
value: adminsecret
- name: HASURA_GRAPHQL_EE_LICENSE_KEY
value: '<license key>'
```
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
```bash

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

@ -42,6 +42,8 @@ help you successfully evaluate Hasura Enterprise for your use case.
- Supported in `v2.23.0` onwards.
- Your Hasura instance must be connected to the internet to use the Hasura Enterprise Edition Trial. If you are running Hasura in an airgap environment, please [contact Hasura Sales](mailto:sales@hasura.io) to get a license key for trying Hasura Enterprise.
:::
## Activate your Enterprise Edition Trial
@ -49,15 +51,13 @@ help you successfully evaluate Hasura Enterprise for your use case.
### Step 1. Run Hasura
You can run Hasura instances in a container environment of your choice. Please follow this
[Getting Started](/getting-started/docker-simple.mdx) guide, which describes how to install Hasura GraphQL Engine using
[guide for getting started](getting-started/quickstart-docker.mdx), which describes how to install Hasura GraphQL Engine using
Docker.
:::tip Already running Hasura in a Docker container?
If you are already running Hasura inside a Docker container with open-source features, then you just need to change the
Docker container tag to `v2.23.0` or above and then redeploy the container.
:::
> Please make sure that your `docker-compose.yaml` does not have the `HASURA_GRAPHQL_EE_LICENSE_KEY` environment variable set. If you already have a license key, you can try Hasura Enterprise directly by following instructions [here](upgrade-ce-to-ee.mdx).
### Step 2. Register for your 30-day free Trial

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

@ -17,31 +17,27 @@ import ProductBadge from '@site/src/components/ProductBadge';
## Overview
Starting from Hasura GraphQL Engine version `v2.12.0`, we have included both open-source and commercial components in
the `hasura/graphql-engine` container image. The open-source portions are licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). The proprietary components include features for Hasura Enterprise and they can be enabled through a free trial or with a license key provided by the Hasura team.
:::info Note
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`
:::
Starting from Hasura GraphQL Engine version `v2.12.0`, we have included both open-source and commercial components in
the `hasura/graphql-engine` container image.
The `hasura/graphql-engine` image includes both open-source and proprietary components. The open-source portions are
licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). The proprietary
components include features for Hasura Enterprise and are enabled with a license key provided by Hasura. If you would
If you would
like to use an image with only the open source components, please use Docker images on
[this page](https://hub.docker.com/r/hasura/graphql-engine/tags?page=1&name=-ce) that contain `-ce`. (example:
`hasura/graphql-engine:<VERSION>-ce`)
:::
If you are already running Hasura CE and would like to upgrade to Hasura Enterprise, please follow these instructions:
1. [Please contact Hasura Sales](mailto:sales@hasura.io) to obtain a license key.
2. Create an environment variable called `HASURA_GRAPHQL_EE_LICENSE_KEY` in your container platform environment and set
it to the license key from the previous step.
#### Hasura Enterprise trial
E.g. if the license key sent by Sales is `ABC1234`, you will set `HASURA_GRAPHQL_EE_LICENSE_KEY=”ABC1234”`.
If you're running Hasura version `v2.23.0` or greater, you can instantly try Hasura Enterprise on your existing Hasura setup by signing up for a [free 30-day Hasura Enterprise trial](/enterprise/try-hasura-enterprise-edition.mdx).
#### Hasura Enterprise Edition license key
If you have been provided a license key by the Hasura team, set it as the value for the `HASURA_GRAPHQL_EE_LICENSE_KEY` environment variable in your Hasura container.
E.g. if the license key sent by the Hasura team is `ABC1234`, you will set `HASURA_GRAPHQL_EE_LICENSE_KEY=”ABC1234”`.
Restart Hasura to start using the enteprise features.
3. Restart Hasura.