hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-09-11 10:46:25 +03:00
Code Issues Projects Releases Wiki Activity

docs: add information to configure Dockerfile for CLI Migrations

Browse Source 
[DOCS-1027]: https://hasurahq.atlassian.net/browse/DOCS-1027?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9600
GitOrigin-RevId: 95f55a650eff05dfe6ad2998ab37c2b879126ba2
This commit is contained in:
Rob Dominguez 2023-06-23 09:19:48 -05:00 committed by hasura-bot
parent 4cf6f01bd9
commit 017d3a6ec3
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/docs/migrations-metadata-seeds/auto-apply-migrations.mdx
View File

@ -15,29 +15,46 @@ keywords:
## Introduction
Hasura ships a special `cli-migrations` Docker image which can be used to automatically apply Migrations and Metadata
when the server starts:
when the server starts.
This Docker image provides a method to implement Migrations and Metadata at the Docker entrypoint automatically. A temporary server is booted,
with the Migrations API allowed, securely through localhost. Once Migrations and Metadata have been applied, the server
will reboot in a secure mode for inbound graphql usage.
You can use this image in your CI/CD workflows to automatically apply Migrations and Metadata to a Hasura GraphQL Engine
instance like this in a Dockerfile:
```bash
hasura/graphql-engine:<version>.cli-migrations-v3
FROM hasura/graphql-engine:<version>.cli-migrations-v3
CMD graphql-engine \
--metadata-database-url $METADATA_DATABASE_URL \
serve \
--server-port $PORT \
--enable-console
```
You can find the image on [DockerHub for various platforms here](https://hub.docker.com/r/hasura/graphql-engine/tags?page=1&name=cli-migrations-v3).
You can find more information about configuring the `cli-migrations` image
[here](https://github.com/hasura/graphql-engine/blob/master/packaging/cli-migrations/v3/README.md#metadata-directory-optional)
and find the image on
[DockerHub for various platforms here](https://hub.docker.com/r/hasura/graphql-engine/tags?page=1&name=cli-migrations-v3).
This container image also includes the Hasura CLI at `/bin/hasura-cli` and can be used for running any other CI/CD
scripts in your workflow too.
:::info Note
For `config v2`, see [Auto-apply Migrations/Metadata when the server starts (config v2)](/migrations-metadata-seeds/legacy-configs/config-v2/advanced/auto-apply-migrations.mdx).
For `config v2`, see
[Auto-apply Migrations/Metadata when the server starts (config v2)](/migrations-metadata-seeds/legacy-configs/config-v2/advanced/auto-apply-migrations.mdx).
:::
## Applying Migrations
The `migrations` and `metadata` directories created by the Hasura CLI in a Hasura Project can be mounted at the
`/hasura-migrations` and `/hasura-metadata` paths of this Docker container and the container's entrypoint script
will automatically apply the Migrations and Metadata before starting the server. If no directory is mounted at the
designated paths, the server will start and ignore the Migrations and/or Metadata.
`/hasura-migrations` and `/hasura-metadata` paths of this Docker container and the container's entrypoint script will
automatically apply the Migrations and Metadata before starting the server. If no directory is mounted at the designated
paths, the server will start and ignore the Migrations and/or Metadata.
You can also mount the Migrations/Metadata directories at some location other than the above by setting the following
environment variables: