docs: update cloud docs for new project creation change and regions (#24)
GitOrigin-RevId: 4ce5ada89c11828eb20a9e642d22365c8971adbd
@ -17,42 +17,57 @@ Introduction
|
||||
|
||||
You can create a new Hasura Cloud project with either a new Postgres database, or an existing Postgres database with a publicly available IP address.
|
||||
|
||||
Step 1: Project setup
|
||||
---------------------
|
||||
|
||||
To begin, navigate to the ``Projects`` page, and click the ``New Project`` link.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/create-new-project.png
|
||||
:alt: create new project button
|
||||
:width: 400
|
||||
|
||||
Creating a project with a new database
|
||||
--------------------------------------
|
||||
This opens a form on the right where you can create your new project.
|
||||
|
||||
Enter the project name, choose a pricing plan and select a region for your project in this form.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/project-setup.png
|
||||
:alt: project setup
|
||||
|
||||
Once you have completed the project setup, continue to the database setup.
|
||||
|
||||
Step 2: Database setup
|
||||
----------------------
|
||||
|
||||
New database
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Hasura Cloud does not host databases, but does provide integrations with which you can create databases on managed cloud providers like Heroku. Integrations for AWS, GCP, and Azure are coming soon.
|
||||
|
||||
To get started, click ``Try with Heroku``, and follow the prompts to authenticate with Heroku. Hasura Cloud will integrate with your Heroku account and manage the initial setup of a dev-tier Postgres instance. You can always upgrade the instance and manage options later through your Heroku account.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/create-project-heroku.png
|
||||
:alt: create new hosted project
|
||||
.. thumbnail:: /img/graphql/cloud/projects/project-new-database-setup.png
|
||||
:alt: database setup with new database
|
||||
|
||||
Creating a project with an existing database
|
||||
--------------------------------------------
|
||||
Existing database
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
To create a new Hasura Cloud project connected to an existing Postgres database, click ``Enter Database URL``, and enter your database connection string (looks like ``postgres://username:password@hostname:port/dbname``).
|
||||
To connect an existing Postgres database to your new project, click ``Enter Database URL``, and enter your database connection string (looks like ``postgres://username:password@hostname:port/dbname``).
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/new-project-hosted.png
|
||||
:alt: create new hosted project
|
||||
.. thumbnail:: /img/graphql/cloud/projects/project-existing-database-setup.png
|
||||
:alt: database setup with existing database
|
||||
|
||||
Allowing connections from Hasura Cloud IP
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
For some cloud services, like GCP, you'll need to adjust your Postgres connection settings to allow connections from the Hasura Cloud IP address. You can copy the IP address from either the copy icon in the ``Database Setup`` window, or the ``Hasura Cloud IP`` field on the project's details view. You may also need to disable SSL. Adding custom cert information to a Hasura Cloud instance is not yet available.
|
||||
For some cloud services, like GCP, you'll need to adjust your Postgres connection settings to allow connections from the Hasura Cloud IP address. You can copy the IP address from either the copy icon in the ``Database Setup`` , or the ``Hasura Cloud IP`` field on the project's details view. You may also need to disable SSL. Adding custom cert information to a Hasura Cloud instance is not yet available.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/existing-db-setup.png
|
||||
.. thumbnail:: /img/graphql/cloud/projects/project-create-hasura-cloud-ip.png
|
||||
:alt: Existing database setup
|
||||
:width: 568px
|
||||
:width: 500px
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/hasura-cloud-ip.png
|
||||
:alt: Hasura Cloud IP field
|
||||
:width: 1200px
|
||||
:width: 1000px
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/gcp-postgres-authorized-network.png
|
||||
:alt: whitelist Hasura instance IP in Postgres settings
|
||||
@ -87,3 +102,7 @@ Hasura Cloud needs the following extra permissions:
|
||||
-- make the user an owner of system schemas
|
||||
ALTER SCHEMA hdb_pro_catalog OWNER TO hasurauser;
|
||||
|
||||
More databases
|
||||
--------------
|
||||
|
||||
Support for more databases (MySQL, SQL Server etc) is coming soon.
|
||||
|
@ -51,12 +51,13 @@ If you have added custom domain(s) to your project, you must update the DNS sett
|
||||
Region
|
||||
------
|
||||
|
||||
The region field shows the project's region of deployment. The default region of deployment is ``AWS, us-east-2 (Ohio)``. You can changge the region by clicking hte edt icon next to it.
|
||||
The region field shows the project's region of deployment. The default region of deployment is ``AWS, us-east-2 (Ohio)``. You can change the region by clicking the edit icon next to it.
|
||||
Read more about switching deployment regions :ref:`here <project_regions>`.
|
||||
|
||||
Pricing Plan
|
||||
------------
|
||||
|
||||
This field shows the plan that the project is on. Read about switching pricing plans :doc:`here <pricing>`.
|
||||
This field shows the plan that the project is on. Read about switching pricing plans :ref:`here <pricing>`.
|
||||
|
||||
Hasura Cloud IP
|
||||
---------------
|
||||
|
@ -58,6 +58,7 @@ Dig deeper
|
||||
Project Domains <domains>
|
||||
Securing projects <secure>
|
||||
Switching pricing plans <pricing>
|
||||
Deployment regions <regions>
|
||||
Heroku database URL Sync <heroku-url-sync>
|
||||
Deleting projects <delete>
|
||||
|
||||
|
56
docs/graphql/cloud/projects/regions.rst
Normal file
@ -0,0 +1,56 @@
|
||||
.. meta::
|
||||
:description: Project deployment regions
|
||||
:keywords: hasura, cloud, docs, regions, project, project regions
|
||||
|
||||
.. _project_regions:
|
||||
|
||||
Deployment regions
|
||||
==================
|
||||
|
||||
.. contents:: Table of contents
|
||||
:backlinks: none
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Introduction
|
||||
------------
|
||||
|
||||
You can deploy Hasura Cloud projects in one of the supported regions (more regions are coming soon). A project's region of deployment can be selected while creating the project and it can be changed later from the project details.
|
||||
|
||||
|
||||
Selecting the region while creating a project
|
||||
---------------------------------------------
|
||||
|
||||
Click on the ``New Project`` button on the project-list page. You can select the project's region of deployment from the ``Select a region`` dropdown.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/regions-while-creation.png
|
||||
:alt: select regions while project creation
|
||||
|
||||
|
||||
Changing region of an existing project
|
||||
--------------------------------------
|
||||
|
||||
Go the the project details by clicking on the settings icon on your project card in the project list.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/getting-started/project-manage.png
|
||||
:alt: select regions while project creation
|
||||
|
||||
The ``Region`` field displays the project's current region of deployment. For switching the region, click on the edit icon in the ``Region`` field.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/region-edit-before.png
|
||||
:alt: select regions while project creation
|
||||
|
||||
Choose a region of your choice and hit ``Save``.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/region-edit-after.png
|
||||
:alt: save regions change
|
||||
|
||||
There might be a short downtime while your project is being moved to a different region. If your database allows connections only from specific IP addresses, make sure you add the Hasura Cloud IP of this new region to the list of allowed IP addresses.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/projects/region-edit-hasura-cloud-ip.png
|
||||
:alt: change region confirm box
|
||||
|
||||
|
||||
.. admonition:: Note
|
||||
|
||||
Support for deploying a project in multiple regions is coming soon.
|
Before Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 22 KiB |
After Width: | Height: | Size: 9.1 KiB |
After Width: | Height: | Size: 21 KiB |
BIN
docs/img/graphql/cloud/projects/project-new-database-setup.png
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
docs/img/graphql/cloud/projects/project-setup.png
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
docs/img/graphql/cloud/projects/region-edit-after.png
Normal file
After Width: | Height: | Size: 28 KiB |
BIN
docs/img/graphql/cloud/projects/region-edit-before.png
Normal file
After Width: | Height: | Size: 5.9 KiB |
BIN
docs/img/graphql/cloud/projects/region-edit-hasura-cloud-ip.png
Normal file
After Width: | Height: | Size: 50 KiB |
BIN
docs/img/graphql/cloud/projects/regions-while-creation.png
Normal file
After Width: | Height: | Size: 60 KiB |