EE Trial Docs

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8432
Co-authored-by: Manas Agarwal <5352361+manasag@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com>
Co-authored-by: Rishichandra Wawhal <27274869+wawhal@users.noreply.github.com>
GitOrigin-RevId: cc03d4602057f0032abad2a4c0f915e68024f3b9
This commit is contained in:
Vaishnavi 2023-04-05 17:09:22 +05:30 committed by hasura-bot
parent d00f4ef497
commit 91c3a4ec09
15 changed files with 287 additions and 53 deletions

View File

@ -1,4 +1,4 @@
{
"label": "Getting Started",
"position": 2
"position": 3
}

View File

@ -21,16 +21,11 @@ slug: index
2. Hasura EE depends on the following software for its features. We highly recommend using managed instances from your
cloud or infrastructure provider.
- **PostgreSQL database (v10 and above)** to store your Metadata (just like Hasura CE).
- **Redis database (v5 and above)**.
- **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**.
## Installation instructions
### License key
To run Hasura EE, you will need a license key. [Please contact Hasura Sales](mailto:sales@hasura.io) if you do not
already have one.
### Installation in a container platform
Please refer to the quickstart sections which describe how to install Hasura EE in various container platforms. **Each
@ -40,3 +35,9 @@ of the below guides requires HGE versions `v2.12.0` and above.**
- [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.
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.

View File

@ -28,8 +28,6 @@ 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.
- 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).
@ -70,14 +68,10 @@ wget https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-mani
Edit `hasura-fargate-task.json` and set the right values:
```json {6,10,14,18,22}
```json {6,10,14,18}
---
{
"environment": [
{
"name": "HASURA_GRAPHQL_EE_LICENSE_KEY",
"value": "<license key>"
},
{
"name": "HASURA_GRAPHQL_METADATA_DATABASE_URL",
"value": "postgres://<username>:<password>@hostname:<port>/<dbname>"
@ -129,13 +123,50 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
:::
### Step 4: Register the Task Definition
### Step 4 (optional): Set the EE license key
If you have been provided a license key by Hasura Sales, add this as an environment variable.
Edit `hasura-fargate-task.json` and add the license key value:
```json {6}
---
{
"environment": [
{
"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",
"value": "redis://hostname:6379"
},
{
"name": "HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL",
"value": "redis://hostname:6379"
},
{
"name": "HASURA_GRAPHQL_ADMIN_SECRET",
"value": "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.
### Step 5: Register the Task Definition
```bash
aws ecs register-task-definition --cli-input-json file://hasura-fargate-task.json
```
### Step 5: List Task Definitions
### Step 6: List Task Definitions
You can list the task definitions for your account at any time with the list-task-definitions command. The output of
this command shows the `family` and `revision` values that you can use together when calling **run-task** or
@ -153,7 +184,7 @@ Output:
}
```
### Step 6: Create a Service
### Step 7: Create a Service
After you have registered a task for your account, you can create a service for the registered task in your cluster. For
this example, you create a service with one instance of the `hasura:1` task definition running in your cluster.
@ -190,7 +221,7 @@ aws ecs create-service \
The **create-service** command returns a description of the task definition after it completes its registration.
### Step 7: Describe the Running Service
### Step 8: Describe the Running Service
Describe the service using the service name retrieved earlier to get more information about the task.
@ -205,7 +236,7 @@ You may also find information on the task definition, the network configuration
section, you will find information on failures, if any, associated with the call. For troubleshooting, see
[Service Event Messages](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages.html).
### Step 8: Open the Hasura Console
### Step 9: Open the Hasura Console
Copy the task id from the previous step and describe the task in the service so that you can get the Elastic Network
Interface (ENI) for the task.

View File

@ -28,12 +28,8 @@ Enterprise Edition on your **local environment**.
### Prerequisites
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.
- You have [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/)
working on your machine.
You have [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/)
working on your machine.
### Step 1: Get the docker-compose file
@ -47,20 +43,17 @@ wget https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-mani
curl https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-manifests/enterprise/docker-compose/docker-compose.yaml -o docker-compose.yml
```
### Step 2: Set the Hasura EE license key and the admin secret
Edit the downloaded `docker-compose.yml` and set the license key and admin secret:
### Step 2: Set the admin secret
To make sure that your GraphQL endpoint and the Hasura Console are not publicly accessible, you need to configure an
admin secret key.
#### Run the Docker container with the license key and admin secret env var
Edit the downloaded `docker-compose.yml` and set the admin secret as an environment variable.
```yaml {4-5}
graphql-engine:
image: hasura/graphql-engine:v2.12.0
environment:
HASURA_GRAPHQL_EE_LICENSE_KEY: "<license key>"
HASURA_GRAPHQL_ADMIN_SECRET: myadminsecretkey
...
```
@ -73,7 +66,23 @@ information on setting up authentication.
:::
### Step 3: Run Hasura GraphQL Engine
### Step 3 (optional): Set EE License Key
If you have been provided a license key by Hasura Sales, add this as an environment variable.
```yaml {4}
graphql-engine:
image: hasura/graphql-engine:v2.12.0
environment:
HASURA_GRAPHQL_EE_LICENSE_KEY: "<license key>"
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.
### Step 4: Run Hasura GraphQL Engine
The following command will run Hasura GraphQL Engine along with a Postgres database to store its metadata.
@ -91,7 +100,7 @@ CONTAINER ID IMAGE ... CREATED STATUS PORTS ...
b0b1aac0508d postgres ... 1m ago Up 1m 5432/tcp ...
```
### Step 4 (optional): Use your PostgreSQL and Redis instances
### 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.
@ -110,7 +119,7 @@ graphql-engine:
...
```
### Step 5: Start using Hasura
### 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).

View File

@ -27,8 +27,6 @@ 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.
- 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
@ -49,12 +47,11 @@ installation manifests required to deploy Hasura anywhere. Get the Cloud Run env
wget https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-manifests/enterprise/google-cloud-run/env.yaml
```
### Step 2: Set the license key, Metadata database URL, Redis database URL and the admin secret
### Step 2: Set the Metadata database URL, Redis database URL and the admin secret
Edit `env.yaml` and set the right values:
```yaml
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'
@ -88,7 +85,22 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
:::
### Step 3: Copy the Hasura graphql-engine image to the GCR registry
### Step 3 (optional): Set the license key
Edit `env.yaml` and add the license key value:
```yaml {1}
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_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.
### 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
graphql-engine image from Dockerhub and push it to your container registry,

View File

@ -27,8 +27,6 @@ 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.
- A functioning Kubernetes cluster.
- This tutorial uses a container image hosted on the public Docker hub, so your Kubernetes cluster must have internet
access.
@ -45,15 +43,13 @@ installation manifests required to deploy Hasura anywhere. Get the Kubernetes de
wget https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-manifests/enterprise/kubernetes/deployment.yaml
```
### Step 2: Set the license key, Metadata database URL, Redis database URL and the admin secret
### Step 2: Set the Metadata database URL, Redis database URL and the admin secret
Edit `deployment.yaml` and set the right values:
```yaml {4,6,8,10,12}
```yaml {4,6,8,10}
---
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
@ -94,13 +90,37 @@ Examples of `HASURA_GRAPHQL_REDIS_URL` and `HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`
:::
### Step 3: Create the Kubernetes deployment and service
### Step 3 (optional): Set the EE license key
If you have been provided a license key by Hasura Sales, add this as an environment variable.
Edit `deployment.yaml` and add the license key value:
```yaml {4}
---
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
value: redis://redis:6379
- name: HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL
value: redis://redis:6379
- name: HASURA_GRAPHQL_ADMIN_SECRET
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.
### Step 4: Create the Kubernetes deployment and service
```bash
kubectl create -f deployment.yaml
```
### Step 4: Open the Hasura Console
### Step 5: Open the Hasura Console
The above creates a LoadBalancer type service with port 80. So you should be able to access the Console at the external
IP.
@ -116,7 +136,7 @@ kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 8m
Head to: `http://localhost` and the Console should load!
### Step 5: Start using Hasura
### 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).

View File

@ -32,7 +32,9 @@ import Enterprise from '@site/static/icons/features/enterprise.svg';
the Hasura Enterprise Edition on your own infrastructure, or on a cloud provider of your choice.
</p>
<p>
If you'd like to learn more, please <a href="mailto:sales@hasura.io">contact us</a>.
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>.
</p>
<h4>Quick Links</h4>
<ul>
@ -42,8 +44,8 @@ import Enterprise from '@site/static/icons/features/enterprise.svg';
</VersionedLink>
</li>
<li>
<VersionedLink to="/enterprise/upgrade-ce-to-ee/">
Upgrade from Hasura CE to Hasura Enterprise.
<VersionedLink to="/enterprise/try-hasura-enterprise-edition/">
Free 30 days Trial for Hasura EE.
</VersionedLink>
</li>
</ul>

View File

@ -0,0 +1,150 @@
---
sidebar_label: Try Hasura Enterprise
description: A guide to try Hasura Enterprise Edition
title: 'EE Trial: Explore Hasura Enterprise Edition for 30 days'
keywords:
- hasura
- docs
- enterprise
- ee
- trial
sidebar_position: 2
toc_max_heading_level: 2
---
import Thumbnail from '@site/src/components/Thumbnail';
# Try Hasura Enterprise Edition
<div className="badge badge--primary heading-badge">Available on: Self-hosted Enterprise</div>
## 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**!
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.
:::info Note
- 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 provided by Hasura. 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:2.23-ce`)
- Use of a Hasura Enterprise Edition Trial is only recommended for evaluation during the trial period and not for
production use.
- Supported in `v2.23.0` onwards.
:::
## Activate your EE Trial
### Step 1. Run Hasura
You can run Hasura instances in a container environment of your choice. Please follow this
[Getting Started](/enterprise/getting-started/index.mdx) guide, which describes how to install Hasura EE in various
container platforms.
:::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.
:::
### 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.
<Thumbnail src="/img/enterprise/Trials_Register_Button.png" alt="EE 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
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_Succeeded.png" alt="EE 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.
Example:
```bash
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" />
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.
<Thumbnail src="/img/enterprise/Trials_EE_Benefits.png" alt="EE Trial Benefits View" width="500px" />
The license information can also be found in the `Settings` view.
<Thumbnail src="/img/enterprise/Trials_View_State.png" alt="EE License view" width="800px" />
## Frequently Asked Questions
### I registered for the trial but I can't see the EE 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?
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?
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?
Yes, you would need to register once, and all the replicas of your Hasura backed by same metadata database will have EE
features enabled.
### I am already in an EE 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
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).
### 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.
### I use an OAuth login on Hasura Cloud; how do I register for EE 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?
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?
[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/).

View File

@ -1,12 +1,12 @@
---
sidebar_label: Upgrade from Hasura CE to Hasura Enterprise
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'
keywords:
- hasura
- docs
- enterprise
sidebar_position: 1
sidebar_position: 9
---
# Upgrading from Hasura CE to Hasura Enterprise
@ -15,6 +15,15 @@ sidebar_position: 1
## Overview
:::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).
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB