mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-15 09:22:43 +03:00
docs: fix cloud db links
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7244 GitOrigin-RevId: 351b0fcd2544c7b4b018b435698499d7540a4d57
This commit is contained in:
parent
941179bfee
commit
5d4337778e
@ -19,8 +19,8 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
|
|||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This guide explains how to connect a new or existing [AWS RDS Aurora Postgres](https://aws.amazon.com/rds/aurora/)
|
This guide explains how to connect a new or existing [AWS RDS Aurora Postgres](https://aws.amazon.com/rds/aurora/)
|
||||||
database to a Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted]
|
database to a Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our
|
||||||
(/deployment/deployment-guides/index.mdx) solutions. If you're exploring AWS RDS Aurora Postgres and are interested
|
[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring AWS RDS Aurora Postgres and are interested
|
||||||
in migrating an existing Postgres database - such as from Heroku - check out their
|
in migrating an existing Postgres database - such as from Heroku - check out their
|
||||||
[docs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html) before continuing
|
[docs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html) before continuing
|
||||||
below.
|
below.
|
||||||
@ -41,14 +41,14 @@ and sign up or log in.
|
|||||||
|
|
||||||
On the Hasura Cloud dashboard, create a new project:
|
On the Hasura Cloud dashboard, create a new project:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/create-hasura-cloud-project.png' alt='Create Hasura Cloud project' width='1000px' />
|
<Thumbnail src="/img/cloud-dbs/create-hasura-cloud-project.png" alt="Create Hasura Cloud project" width="1000px" />
|
||||||
|
|
||||||
After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser.
|
After the project is initialized successfully, click on `Launch Console` to open the Hasura Console in your browser.
|
||||||
|
|
||||||
On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a
|
On the Hasura Console, navigate to the `Data` tab and choose `Connect Existing Database`. Hasura will prompt you for a
|
||||||
Postgres Database URL. We'll create this in the next step and then come back here.
|
Postgres Database URL. We'll create this in the next step and then come back here.
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/existing-db-setup.png' alt='Hasura Cloud database setup' width='700px' />
|
<Thumbnail src="/img/cloud-dbs/existing-db-setup.png" alt="Hasura Cloud database setup" width="700px" />
|
||||||
|
|
||||||
## Step 3: Create an Aurora DB on AWS RDS {#create-pg-db-aurora}
|
## Step 3: Create an Aurora DB on AWS RDS {#create-pg-db-aurora}
|
||||||
|
|
||||||
@ -62,24 +62,24 @@ Log into the [AWS console](https://console.aws.amazon.com//).
|
|||||||
|
|
||||||
On the top left, click on `Services` and type "RDS" into the search field. Then click on `RDS`:
|
On the top left, click on `Services` and type "RDS" into the search field. Then click on `RDS`:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/aws/search-for-rds.png' alt='Navigate to RDS in AWS' width='1000px' />
|
<Thumbnail src="/img/cloud-dbs/aws/search-for-rds.png" alt="Navigate to RDS in AWS" width="1000px" />
|
||||||
|
|
||||||
Click on the `Create database` button:
|
Click on the `Create database` button:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/aws/create-database.png' alt='Create database in AWS' width='1000px' />
|
<Thumbnail src="/img/cloud-dbs/aws/create-database.png" alt="Create database in AWS" width="1000px" />
|
||||||
|
|
||||||
In `Engine options`, select `Amazon Aurora` as `Engine type`. Also, select `Amazon Aurora with PostgreSQL compatibility`
|
In `Engine options`, select `Amazon Aurora` as `Engine type`. Also, select `Amazon Aurora with PostgreSQL compatibility`
|
||||||
as `Edition`:
|
as `Edition`:
|
||||||
|
|
||||||
<Thumbnail
|
<Thumbnail
|
||||||
src='/img/cloud-dbs/aws/aurora/rds-select-aurora.png'
|
src="/img/cloud-dbs/aws/aurora/rds-select-aurora.png"
|
||||||
alt='Select Aurora for RDS instance on AWS'
|
alt="Select Aurora for RDS instance on AWS"
|
||||||
width='600px'
|
width="600px"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
Scroll down to `Settings`:
|
Scroll down to `Settings`:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/aws/rds-settings.png' alt='Settings for RDS instance on AWS' width='600px' />
|
<Thumbnail src="/img/cloud-dbs/aws/rds-settings.png" alt="Settings for RDS instance on AWS" width="600px" />
|
||||||
|
|
||||||
Now you can choose a `DB instance identifier` as a name for your database. The `Master username` is `postgres` by
|
Now you can choose a `DB instance identifier` as a name for your database. The `Master username` is `postgres` by
|
||||||
default. You can change that if you have to. As for the password, you can click the checkbox for AWS to auto-generate
|
default. You can change that if you have to. As for the password, you can click the checkbox for AWS to auto-generate
|
||||||
@ -90,11 +90,11 @@ Scroll down and customize other database options such as `DB instance size` and
|
|||||||
In the `Connectivity` section, expand the `Additional connectivity configuration`. Then set `Public access` to `Yes` and
|
In the `Connectivity` section, expand the `Additional connectivity configuration`. Then set `Public access` to `Yes` and
|
||||||
choose or add a new security group:
|
choose or add a new security group:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/aws/rds-connectivity.png' alt='Connectivity for RDS instance on AWS' width='600px' />
|
<Thumbnail src="/img/cloud-dbs/aws/rds-connectivity.png" alt="Connectivity for RDS instance on AWS" width="600px" />
|
||||||
|
|
||||||
When you're done, at the bottom, click the `Create database` button:
|
When you're done, at the bottom, click the `Create database` button:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/aws/rds-click-create.png' alt='Create RDS instance on AWS' width='700px' />
|
<Thumbnail src="/img/cloud-dbs/aws/rds-click-create.png" alt="Create RDS instance on AWS" width="700px" />
|
||||||
|
|
||||||
:::info Note
|
:::info Note
|
||||||
|
|
||||||
@ -109,30 +109,30 @@ On the database dashboard, click on `Connectivity & security`. On the right, cli
|
|||||||
selected or added in [step 3](#create-pg-aws-rds-aurora).
|
selected or added in [step 3](#create-pg-aws-rds-aurora).
|
||||||
|
|
||||||
<Thumbnail
|
<Thumbnail
|
||||||
src='/img/cloud-dbs/aws/aurora/find-security-group.png'
|
src="/img/cloud-dbs/aws/aurora/find-security-group.png"
|
||||||
alt='Find the security group on AWS RDS'
|
alt="Find the security group on AWS RDS"
|
||||||
width='1000px'
|
width="1000px"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
Click on the security group:
|
Click on the security group:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/aws/select-security-group.png' alt='Click on the security group' width='1000px' />
|
<Thumbnail src="/img/cloud-dbs/aws/select-security-group.png" alt="Click on the security group" width="1000px" />
|
||||||
|
|
||||||
Click on `Edit inbound rules`:
|
Click on `Edit inbound rules`:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/aws/inbound-rules.png' alt='Edit inbound rules for AWS RDS database' width='1000px' />
|
<Thumbnail src="/img/cloud-dbs/aws/inbound-rules.png" alt="Edit inbound rules for AWS RDS database" width="1000px" />
|
||||||
|
|
||||||
Click on `Add rule`:
|
Click on `Add rule`:
|
||||||
|
|
||||||
<Thumbnail
|
<Thumbnail
|
||||||
src='/img/cloud-dbs/aws/add-inbound-rule.png'
|
src="/img/cloud-dbs/aws/add-inbound-rule.png"
|
||||||
alt='Add an inbound rule for AWS RDS database'
|
alt="Add an inbound rule for AWS RDS database"
|
||||||
width='1000px'
|
width="1000px"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address:
|
If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address:
|
||||||
|
|
||||||
<Thumbnail src='/img/projects/hasura-cloud-ip.png' alt='Hasura Cloud IP field' width='1000px' />
|
<Thumbnail src="/img/projects/hasura-cloud-ip.png" alt="Hasura Cloud IP field" width="1000px" />
|
||||||
|
|
||||||
:::info Note
|
:::info Note
|
||||||
|
|
||||||
@ -143,7 +143,7 @@ service.
|
|||||||
|
|
||||||
Add the Hasura IP address that you copied:
|
Add the Hasura IP address that you copied:
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/aws/add-hasura-ip.png' alt='Add the Hasura IP for AWS RDS database' width='1000px' />
|
<Thumbnail src="/img/cloud-dbs/aws/add-hasura-ip.png" alt="Add the Hasura IP for AWS RDS database" width="1000px" />
|
||||||
|
|
||||||
Then click `Save rules`.
|
Then click `Save rules`.
|
||||||
|
|
||||||
@ -158,9 +158,9 @@ postgresql://<user-name>:<password>@<public-ip>:<postgres-port>/<db>
|
|||||||
On the database dashboard, click on `Connectivity & security`:
|
On the database dashboard, click on `Connectivity & security`:
|
||||||
|
|
||||||
<Thumbnail
|
<Thumbnail
|
||||||
src='/img/cloud-dbs/aws/aurora/get-db-connection-string.png'
|
src="/img/cloud-dbs/aws/aurora/get-db-connection-string.png"
|
||||||
alt='Construct the database connection string for AWS RDS'
|
alt="Construct the database connection string for AWS RDS"
|
||||||
width='1000px'
|
width="1000px"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
- `user-name`: If you have a separate database user the user name will be their name. If you didn't specify a user, the
|
- `user-name`: If you have a separate database user the user name will be their name. If you didn't specify a user, the
|
||||||
@ -175,7 +175,7 @@ On the database dashboard, click on `Connectivity & security`:
|
|||||||
|
|
||||||
Back on the Hasura Console, enter the database URL that we retrieved in [step 5](#construct-db-url-aurora):
|
Back on the Hasura Console, enter the database URL that we retrieved in [step 5](#construct-db-url-aurora):
|
||||||
|
|
||||||
<Thumbnail src='/img/getting-started/connect-db-cloud.png' alt='Database setup' width='600px' />
|
<Thumbnail src="/img/getting-started/connect-db-cloud.png" alt="Database setup" width="600px" />
|
||||||
|
|
||||||
Then click `Connect Database`.
|
Then click `Connect Database`.
|
||||||
|
|
||||||
@ -188,7 +188,7 @@ vars to connect to the databases in place of the raw database URLs.
|
|||||||
|
|
||||||
Voilà. You are ready to start developing.
|
Voilà. You are ready to start developing.
|
||||||
|
|
||||||
<Thumbnail src='/img/cloud-dbs/hasura-console.png' alt='Hasura console' width='1100px' />
|
<Thumbnail src="/img/cloud-dbs/hasura-console.png" alt="Hasura console" width="1100px" />
|
||||||
|
|
||||||
## Next steps
|
## Next steps
|
||||||
|
|
||||||
@ -199,7 +199,7 @@ Voilà. You are ready to start developing.
|
|||||||
[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or
|
[collaborators](/projects/collaborators.mdx), [env vars](/projects/env-vars.mdx) or
|
||||||
[custom domains](/projects/domains.mdx)).
|
[custom domains](/projects/domains.mdx)).
|
||||||
|
|
||||||
<Thumbnail src='/img/getting-started/project-manage.png' alt='Project actions' width='860px' />
|
<Thumbnail src="/img/getting-started/project-manage.png" alt="Project actions" width="860px" />
|
||||||
|
|
||||||
:::info Note
|
:::info Note
|
||||||
|
|
||||||
|
@ -20,8 +20,8 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
|
|||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This guide explains how to connect a new or existing [ElephantSQL Postgres](https://www.elephantsql.com/) database to a
|
This guide explains how to connect a new or existing [ElephantSQL Postgres](https://www.elephantsql.com/) database to a
|
||||||
Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted]
|
Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our
|
||||||
(/deployment/deployment-guides/index.mdx) solutions.
|
[self-hosted](/deployment/deployment-guides/index.mdx) solutions.
|
||||||
|
|
||||||
:::info Note
|
:::info Note
|
||||||
|
|
||||||
|
@ -21,10 +21,10 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
|
|||||||
|
|
||||||
This guide explains how to connect a new or existing
|
This guide explains how to connect a new or existing
|
||||||
[EnterpriseDB](https://www.enterprisedb.com/products/biganimal-cloud-postgresql) (BigAnimal) Postgres database to a
|
[EnterpriseDB](https://www.enterprisedb.com/products/biganimal-cloud-postgresql) (BigAnimal) Postgres database to a
|
||||||
Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or [self-hosted]
|
Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or
|
||||||
(/deployment/deployment-guides/index.mdx). If you're exploring EnterpriseDB Postgres and are interested in migrating
|
[self-hosted](/deployment/deployment-guides/index.mdx). If you're exploring EnterpriseDB Postgres and are interested in migrating
|
||||||
an existing Postgres database - such as from Heroku - check out their [docs](https://www.enterprisedb.
|
an existing Postgres database - such as from Heroku - check out their
|
||||||
com/docs/biganimal/latest/migration/cold_migration/) before continuing below.
|
[docs](https://www.enterprisedb.com/docs/biganimal/latest/migration/cold_migration/) before continuing below.
|
||||||
|
|
||||||
:::info Note
|
:::info Note
|
||||||
|
|
||||||
|
@ -19,8 +19,8 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
|
|||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This guide explains how to connect a new or existing [Timescale Postgres](https://www.timescale.com/) database to a
|
This guide explains how to connect a new or existing [Timescale Postgres](https://www.timescale.com/) database to a
|
||||||
Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our [self-hosted]
|
Hasura instance, either on [Hasura Cloud](https://cloud.hasura.io) or via one of our
|
||||||
(/deployment/deployment-guides/index.mdx) solutions. If you're exploring Timescale Postgres and are interested in
|
[self-hosted](/deployment/deployment-guides/index.mdx) solutions. If you're exploring Timescale Postgres and are interested in
|
||||||
migrating an existing Postgres database - such as from Heroku - check out their
|
migrating an existing Postgres database - such as from Heroku - check out their
|
||||||
[docs](https://docs.timescale.com/timescaledb/latest/how-to-guides/migrate-data/) before continuing below.
|
[docs](https://docs.timescale.com/timescaledb/latest/how-to-guides/migrate-data/) before continuing below.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user