From dd51449f92a14d180273cb422c584a972648c0a6 Mon Sep 17 00:00:00 2001 From: Shahzeb Ali <126076773+Shahzeb-DataEngineer@users.noreply.github.com> Date: Sun, 18 Oct 2026 21:16:03 +0500 Subject: [PATCH] docs: fix full stack dev container setup instructions The development environment setup guide referenced a "post-start script" that builds the server, runs database migrations, and starts the OpenMetadata services. No such script exists: the Full Stack `.devcontainer` config only defines a `postCreateCommand` (running `.devcontainer/dev/post-create.sh`), and the server, migrations, and services are started by docker compose (`openmetadata-server`, `execute-migrate-all`, `mysql`, and `elasticsearch` services in `docker/development/docker-compose.yml`). Corrects the wording in the v1.13.x, v2.0.x, and v2.1.x-SNAPSHOT guides. Related: open-metadata/OpenMetadata#27517 Signed-off-by: Shahzeb Ali <126076773+Shahzeb-DataEngineer@users.noreply.github.com> --- .../contribute/development-environment-setup.mdx | 10 +++++----- .../contribute/development-environment-setup.mdx | 10 +++++----- .../contribute/development-environment-setup.mdx | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/v1.13.x/developers/contribute/development-environment-setup.mdx b/v1.13.x/developers/contribute/development-environment-setup.mdx index 26cae629f..c8854b685 100644 --- a/v1.13.x/developers/contribute/development-environment-setup.mdx +++ b/v1.13.x/developers/contribute/development-environment-setup.mdx @@ -65,7 +65,7 @@ Both configurations automatically install all [prerequisites](/v1.13.x/developer The container will build and run the post-create setup script automatically. This installs ANTLR, frontend dependencies, creates a Python virtual environment, and runs code generation. - For the **Full Stack** configuration, the post-start script will additionally build the server, run database migrations, and start OpenMetadata services. This may take several minutes on the first run. + For the **Full Stack** configuration, docker compose additionally builds the OpenMetadata server image from the local source, runs database migrations, and starts the MySQL, Elasticsearch, and OpenMetadata Server services. This may take several minutes on the first run. Once setup completes, the integrated terminal is ready. Common commands: @@ -153,11 +153,11 @@ The post-create setup script runs automatically in all environments and handles: 5. **Code generation** — ANTLR parsers and other generated artifacts via `make generate` 6. **Prerequisite validation** — Runs `make prerequisites` to confirm everything is ready -For the **Full Stack** configuration, the post-start script additionally: +For the **Full Stack** configuration, docker compose additionally: -1. Builds the OpenMetadata server distribution (`mvn clean package -DskipTests`) -2. Runs database migrations against MySQL -3. Starts the OpenMetadata server on ports `8585`/`8586` +1. Builds the OpenMetadata server image from the local source (`docker/development/Dockerfile`) +2. Runs database migrations against MySQL (via the `execute-migrate-all` service) +3. Starts the MySQL, Elasticsearch, and OpenMetadata Server services (API on ports `8585`/`8586`) ## Next Steps diff --git a/v2.0.x/developers/contribute/development-environment-setup.mdx b/v2.0.x/developers/contribute/development-environment-setup.mdx index 71086d672..93403ab80 100644 --- a/v2.0.x/developers/contribute/development-environment-setup.mdx +++ b/v2.0.x/developers/contribute/development-environment-setup.mdx @@ -65,7 +65,7 @@ Both configurations automatically install all [prerequisites](/v2.0.x/developers The container will build and run the post-create setup script automatically. This installs ANTLR, frontend dependencies, creates a Python virtual environment, and runs code generation. - For the **Full Stack** configuration, the post-start script will additionally build the server, run database migrations, and start OpenMetadata services. This may take several minutes on the first run. + For the **Full Stack** configuration, docker compose additionally builds the OpenMetadata server image from the local source, runs database migrations, and starts the MySQL, Elasticsearch, and OpenMetadata Server services. This may take several minutes on the first run. Once setup completes, the integrated terminal is ready. Common commands: @@ -153,11 +153,11 @@ The post-create setup script runs automatically in all environments and handles: 5. **Code generation** — ANTLR parsers and other generated artifacts via `make generate` 6. **Prerequisite validation** — Runs `make prerequisites` to confirm everything is ready -For the **Full Stack** configuration, the post-start script additionally: +For the **Full Stack** configuration, docker compose additionally: -1. Builds the OpenMetadata server distribution (`mvn clean package -DskipTests`) -2. Runs database migrations against MySQL -3. Starts the OpenMetadata server on ports `8585`/`8586` +1. Builds the OpenMetadata server image from the local source (`docker/development/Dockerfile`) +2. Runs database migrations against MySQL (via the `execute-migrate-all` service) +3. Starts the MySQL, Elasticsearch, and OpenMetadata Server services (API on ports `8585`/`8586`) ## Next Steps diff --git a/v2.1.x-SNAPSHOT/developers/contribute/development-environment-setup.mdx b/v2.1.x-SNAPSHOT/developers/contribute/development-environment-setup.mdx index d445e9d77..a137e27dc 100644 --- a/v2.1.x-SNAPSHOT/developers/contribute/development-environment-setup.mdx +++ b/v2.1.x-SNAPSHOT/developers/contribute/development-environment-setup.mdx @@ -65,7 +65,7 @@ Both configurations automatically install all [prerequisites](/v2.1.x-SNAPSHOT/d The container will build and run the post-create setup script automatically. This installs ANTLR, frontend dependencies, creates a Python virtual environment, and runs code generation. - For the **Full Stack** configuration, the post-start script will additionally build the server, run database migrations, and start OpenMetadata services. This may take several minutes on the first run. + For the **Full Stack** configuration, docker compose additionally builds the OpenMetadata server image from the local source, runs database migrations, and starts the MySQL, Elasticsearch, and OpenMetadata Server services. This may take several minutes on the first run. Once setup completes, the integrated terminal is ready. Common commands: @@ -153,11 +153,11 @@ The post-create setup script runs automatically in all environments and handles: 5. **Code generation** — ANTLR parsers and other generated artifacts via `make generate` 6. **Prerequisite validation** — Runs `make prerequisites` to confirm everything is ready -For the **Full Stack** configuration, the post-start script additionally: +For the **Full Stack** configuration, docker compose additionally: -1. Builds the OpenMetadata server distribution (`mvn clean package -DskipTests`) -2. Runs database migrations against MySQL -3. Starts the OpenMetadata server on ports `8585`/`8586` +1. Builds the OpenMetadata server image from the local source (`docker/development/Dockerfile`) +2. Runs database migrations against MySQL (via the `execute-migrate-all` service) +3. Starts the MySQL, Elasticsearch, and OpenMetadata Server services (API on ports `8585`/`8586`) ## Next Steps