-
Notifications
You must be signed in to change notification settings - Fork 16
feat: add docker directory with several docker composes #1965
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
5f04572
f0f4d12
b38f2bd
9acbcf8
de8b85d
f5ff446
ed64029
b858d4d
3a93925
c74d431
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "@ensnode/integration-test-env": patch | ||
| "@docs/ensnode": patch | ||
| --- | ||
|
|
||
| Moved docker-compose.yml file to separate `docker` directory, updates docs and cicd-tests |
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Docker Compose | ||
|
|
||
| All commands are run from the **monorepo root**. | ||
|
|
||
| ## Files | ||
|
|
||
| | File | Purpose | | ||
| | ---------------------------------------- | -------------------------------------------------------------------------------------- | | ||
| | `docker/docker-compose.yml` | Base stack — ensindexer, ensapi, ensrainbow, ensadmin, postgres. For mainnet/sepolia. | | ||
| | `docker/docker-compose.devnet.yml` | Full stack against local devnet (`ens-test-env`). Includes all base services + devnet. | | ||
| | `docker/docker-compose.orchestrator.yml` | Minimal infra for CI — devnet + postgres only. Used by `orchestrator.ts`. | | ||
| | `docker/services/*.yml` | Individual service definitions. Extended by the compose files above. | | ||
| | `docker/envs/.env.docker.common` | Shared env defaults (postgres credentials, internal service URLs). Committed. | | ||
| | `docker/envs/.env.docker.devnet` | Devnet defaults (PLUGINS, etc.). Committed. Works out of the box. | | ||
| | `docker/envs/.env.docker.example` | Example for user-specific config. Copy to `.env.docker.local` for mainnet/sepolia. | | ||
| | `docker/envs/.env.docker.local` | User config (gitignored). Required for base stack, optional for devnet overrides. | | ||
|
|
||
| > To inspect the fully resolved config for any compose file (resolves all `extends`): | ||
| > | ||
| > ``` | ||
| > docker compose -f docker/docker-compose.yml config | ||
| > ``` | ||
|
|
||
| ## Use cases | ||
|
|
||
| ### Mainnet / Sepolia | ||
|
|
||
| **1. Configure environment** (one-time setup): | ||
|
|
||
| ```bash | ||
| cp docker/envs/.env.docker.example docker/envs/.env.docker.local | ||
| ``` | ||
|
|
||
| Edit `docker/envs/.env.docker.local` and set `NAMESPACE`, `PLUGINS`, and your RPC endpoints (e.g. `ALCHEMY_API_KEY` or `RPC_URL_1`). | ||
|
|
||
| **2. Start/stop the stack:** | ||
|
|
||
| ```bash | ||
| # Start full stack in background | ||
| docker compose -f docker/docker-compose.yml up -d | ||
|
|
||
| # Stop | ||
| docker compose -f docker/docker-compose.yml down | ||
|
|
||
| # Stop and remove volumes | ||
| docker compose -f docker/docker-compose.yml down -v | ||
| ``` | ||
|
|
||
| ### Local devnet (for developers) | ||
|
|
||
| No setup required — devnet defaults are committed in `docker/envs/.env.docker.devnet`. | ||
|
|
||
| To override defaults (e.g. change `PLUGINS`), create `docker/envs/.env.docker.local` with your values. | ||
|
|
||
| ```bash | ||
| # Start full stack against devnet | ||
| docker compose -f docker/docker-compose.devnet.yml up -d | ||
|
|
||
| # Start only devnet + core services (no ensadmin) | ||
| docker compose -f docker/docker-compose.devnet.yml up -d devnet postgres ensrainbow ensindexer ensapi | ||
|
|
||
| # Start only devnet (quick local EVM node, also shows data information about devnet) | ||
| docker compose -f docker/docker-compose.devnet.yml up devnet | ||
| # or | ||
| pnpm devnet | ||
|
|
||
| # Stop | ||
| docker compose -f docker/docker-compose.devnet.yml down | ||
| ``` | ||
|
|
||
| ### Build images locally | ||
|
|
||
| ```bash | ||
| # Build all images | ||
| pnpm docker:build:ensnode | ||
|
|
||
| # Build a specific image | ||
| pnpm docker:build:ensindexer | ||
| pnpm docker:build:ensapi | ||
| pnpm docker:build:ensrainbow | ||
| pnpm docker:build:ensadmin | ||
| ``` | ||
|
|
||
| ### CI / integration tests | ||
|
|
||
| Used internally by `orchestrator.ts` via testcontainers. Starts devnet + postgres only. | ||
|
|
||
| ```bash | ||
| pnpm test:integration:ci | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| services: | ||
| ensindexer: | ||
| extends: | ||
| file: services/ensindexer.yml | ||
| service: ensindexer | ||
| environment: | ||
| # TODO: in future we will migrate devnet to chain_id=1 | ||
| # need to update this line in that case | ||
| RPC_URL_15658733: http://devnet:8545 | ||
| ENSINDEXER_SCHEMA_NAME: docker_devnet_v1 | ||
| LABEL_SET_ID: ens-test-env | ||
| NAMESPACE: ens-test-env | ||
| env_file: | ||
| - path: envs/.env.docker.common | ||
| required: true | ||
| - path: envs/.env.docker.devnet | ||
| required: true | ||
| - path: envs/.env.docker.local | ||
| required: false | ||
| depends_on: | ||
| ensrainbow: | ||
| condition: service_healthy | ||
| postgres: | ||
| condition: service_healthy | ||
| devnet: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. well, you are right, we can skip them. but after your comment I decided that it's better to move |
||
| condition: service_healthy | ||
|
|
||
| ensapi: | ||
| extends: | ||
| file: services/ensapi.yml | ||
| service: ensapi | ||
| environment: | ||
| # TODO: in future we will migrate devnet to chain_id=1 | ||
| # need to update this line in that case | ||
| RPC_URL_15658733: http://devnet:8545 | ||
| ENSINDEXER_SCHEMA_NAME: docker_devnet_v1 | ||
| depends_on: | ||
| postgres: | ||
| condition: service_healthy | ||
| env_file: | ||
| - path: envs/.env.docker.common | ||
| required: true | ||
| - path: envs/.env.docker.devnet | ||
| required: true | ||
| - path: envs/.env.docker.local | ||
| required: false | ||
|
|
||
| ensrainbow: | ||
| extends: | ||
| file: services/ensrainbow.yml | ||
| service: ensrainbow | ||
| environment: | ||
| LABEL_SET_ID: ens-test-env | ||
| env_file: | ||
| - path: envs/.env.docker.common | ||
| required: true | ||
| - path: envs/.env.docker.devnet | ||
| required: true | ||
| - path: envs/.env.docker.local | ||
| required: false | ||
|
|
||
| ensadmin: | ||
| extends: | ||
| file: services/ensadmin.yml | ||
| service: ensadmin | ||
| depends_on: | ||
| ensapi: | ||
| condition: service_started | ||
| env_file: | ||
| - path: envs/.env.docker.common | ||
| required: true | ||
| - path: envs/.env.docker.devnet | ||
| required: true | ||
| - path: envs/.env.docker.local | ||
| required: false | ||
|
|
||
| postgres: | ||
| extends: | ||
| file: services/postgres.yml | ||
| service: postgres | ||
| env_file: | ||
| - path: ./envs/.env.docker.common | ||
| required: true | ||
|
|
||
| devnet: | ||
| extends: | ||
| file: services/devnet.yml | ||
| service: devnet | ||
|
|
||
| volumes: | ||
| # Docker Compose requires volumes used by services to be declared in each | ||
| # compose file that references them — they cannot be inherited via `extends`. | ||
| # Explicit `name:` prevents collision with the base stack's volumes when both | ||
| # are run from the same directory (same project name). | ||
| postgres_data: | ||
| name: ensnode_devnet_postgres_data | ||
| driver: local | ||
| ensrainbow_data: | ||
| name: ensnode_devnet_ensrainbow_data | ||
| driver: local | ||
|
sevenzing marked this conversation as resolved.
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Minimal compose for CI integration tests. | ||
| # Provides only the infrastructure services needed by orchestrator.ts: | ||
| # devnet (local EVM) and postgres (database). | ||
| services: | ||
| devnet: | ||
| extends: | ||
| file: services/devnet.yml | ||
| service: devnet | ||
|
|
||
| postgres: | ||
| extends: | ||
| file: services/postgres.yml | ||
| service: postgres | ||
|
sevenzing marked this conversation as resolved.
|
||
| env_file: | ||
| - path: ./envs/.env.docker.common | ||
| required: true | ||
|
|
||
| volumes: | ||
| # Docker Compose requires volumes used by services to be declared in each | ||
| # compose file that references them — they cannot be inherited via `extends`. | ||
| postgres_data: | ||
| driver: local | ||
Uh oh!
There was an error while loading. Please reload this page.