Merge pull request #1162 from MinaProtocol/dkijania/fix_invalid_dockers

dannywillems · web-flow · commit 2e6e144c3d99 · 2026-01-22T10:59:08.000-03:00
add script for validating existence for docker images in main docker
diff --git a/.github/workflows/validate-docker-images.yml b/.github/workflows/validate-docker-images.yml
@@ -0,0 +1,34 @@
+name: Validate Docker Images
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**/*.mdx'
+      - 'docs/**/*.md'
+      - 'scripts/validate-docker-images.js'
+      - '.github/workflows/validate-docker-images.yml'
+  workflow_dispatch: {}
+
+jobs:
+  validate-docker-images:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Validate Docker images in documentation
+        run: npm run validate-docker-images
diff --git a/docs/berkeley-upgrade/archive-migration/docker-example.mdx b/docs/berkeley-upgrade/archive-migration/docker-example.mdx
@@ -57,7 +57,7 @@ psql mainnet_really_migrated -f create_schema.sql
 # Start migration
 docker create --name mainnet-db-migration \
        -v $(pwd)/mainnet-migration:/data \
-       --network mainnet gcr.io/o1labs-192920/mina-archive-migration:3.0.1-e848ecb-bullseye -- bash -c '
+       --network mainnet minaprotocol/mina-archive-migration:3.0.1-e848ecb-bullseye -- bash -c '
         wget http://673156464838-mina-genesis-ledgers.s3-website-us-west-2.amazonaws.com/mainnet/genesis_ledger.json; mina-berkeley-migration-script initial \
           --genesis-ledger genesis_ledger.json \
           --source-db postgres://mina:minamina@postgres:5432/mainnet_balances_migrated \
diff --git a/docs/berkeley-upgrade/archive-migration/mainnet-database-maintenance.mdx b/docs/berkeley-upgrade/archive-migration/mainnet-database-maintenance.mdx
@@ -76,7 +76,7 @@ apt-get install --allow-downgrades -y "mina-archive-maintenance=$VERSION"
 To get the Docker image:
 
 ```sh
-docker pull gcr.io/o1labs-192920/mina-archive-maintenance:1.4.1
+docker pull minaprotocol/mina-archive-maintenance:1.4.1-060f0a5-bullseye
 ```
 
 ## Usage for missing or invalid nonces
diff --git a/docs/mesa-upgrade/archive-upgrade.mdx b/docs/mesa-upgrade/archive-upgrade.mdx
@@ -48,7 +48,7 @@ curl -O https://raw.githubusercontent.com/MinaProtocol/mina/refs/heads/mesa/src/
 We also ship the script in the Mina archive Docker image and Debian package.
 
 ```bash
-docker run --rm gcr.io/o1labs-192920/mina-archive-mesa:4.0.0-preflight1-b649c79-bookworm-mesa cat /etc/mina/archive/upgrade-to-mesa.sql > upgrade-to-mesa.sql
+docker run --rm gcr.io/o1labs-192920/mina-archive:4.0.0-preflight1-b649c79-bookworm-mesa cat /etc/mina/archive/upgrade-to-mesa.sql > upgrade-to-mesa.sql
 ```
 
 ```bash
diff --git a/docs/mesa-upgrade/preflight-network.mdx b/docs/mesa-upgrade/preflight-network.mdx
@@ -32,8 +32,8 @@ The Mesa preflight network uses the following build versions:
 Docker images are available for both `amd64` and `arm64` architectures:
 
 - **Mina Daemon:** `gcr.io/o1labs-192920/mina-daemon:4.0.0-preflight1-b649c79-bookworm-mesa`
-- **Archive Node:** `gcr.io/o1labs-192920/mina-archive-mesa:4.0.0-preflight1-b649c79-bookworm-mesa`
-- **Rosetta:** `gcr.io/o1labs-192920/mina-rosetta-mesa:4.0.0-preflight1-b649c79-bookworm-mesa`
+- **Archive Node:** `gcr.io/o1labs-192920/mina-archive:4.0.0-preflight1-b649c79-bookworm-mesa`
+- **Rosetta:** `gcr.io/o1labs-192920/mina-rosetta:4.0.0-preflight1-b649c79-bookworm-mesa`
 
 Images are available for both **bookworm** and **noble** distributions.
 
@@ -174,7 +174,7 @@ mina-archive run \
 docker run --name mina-archive-mesa -d \
   -p 3086:3086 \
   --restart=always \
-  gcr.io/o1labs-192920/mina-archive-mesa:4.0.0-preflight1-b649c79-bookworm-mesa \
+  gcr.io/o1labs-192920/mina-archive:4.0.0-preflight1-b649c79-bookworm-mesa \
   mina-archive run \
   --postgres-uri postgresql://archive_user:your-secure-password@postgres-host:5432/archive \
   --server-port 3086
@@ -226,7 +226,7 @@ mina-rosetta \
 docker run --name mina-rosetta-mesa -d \
   -p 3087:3087 \
   --restart=always \
-  gcr.io/o1labs-192920/mina-rosetta-mesa:4.0.0-preflight1-b649c79-bookworm-mesa \
+  gcr.io/o1labs-192920/mina-rosetta:4.0.0-preflight1-b649c79-bookworm-mesa \
   --port 3087 \
   --archive-uri http://archive-host:3086/graphql \
   --graphql-uri http://mina-daemon-host:3085/graphql
diff --git a/docs/node-operators/archive-node/docker-compose.mdx b/docs/node-operators/archive-node/docker-compose.mdx
@@ -33,7 +33,7 @@ services:
       - '5432:5432'
   bootstrap_db:
     image: 'minaprotocol/mina-archive:3.1.0-ae112d3-bullseye'
-    # image: 'gcr.io/o1labs-192920/mina-archive:3.1.0-alpha1-56cdb61-bullseye' # Use this image for Devnet
+    # image: 'minaprotocol/mina-archive:3.1.0-alpha1-56cdb61-bullseye' # Use this image for Devnet
     command: >
       bash -c '
       curl -O https://storage.googleapis.com/mina-archive-dumps/mainnet-archive-dump-$(date +%F_0000).sql.tar.gz;
@@ -52,7 +52,7 @@ services:
         condition: service_healthy
   missing_blocks_guardian:
     image: 'minaprotocol/mina-archive:3.1.0-ae112d3-bullseye'
-    # image: 'gcr.io/o1labs-192920/mina-archive:3.1.0-alpha1-56cdb61-bullseye' # Use this image for Devnet
+    # image: 'minaprotocol/mina-archive:3.1.0-alpha1-56cdb61-bullseye' # Use this image for Devnet
     command: >
       bash -c '
       curl -O https://raw.githubusercontent.com/MinaFoundation/helm-charts/main/mina-archive/scripts/missing-blocks-guardian-command.sh;
@@ -82,7 +82,7 @@ services:
         condition: service_completed_successfully
   mina_node:
     image: 'minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet'
-    # image: 'gcr.io/o1labs-192920/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
+    # image: 'minaprotocol/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
     restart: always
     entrypoint: []
     command: >
diff --git a/docs/node-operators/block-producer-node/connecting-to-devnet.mdx b/docs/node-operators/block-producer-node/connecting-to-devnet.mdx
@@ -126,7 +126,7 @@ docker run --name mina -d \
        --restart=always \
        -v $(pwd)/.mina-config:/data/.mina-config \
        -v $(pwd)/.mina-env:/entrypoint.d/mina-env \
-       gcr.io/o1labs-192920/mina-daemon:3.1.0-ae112d3-bullseye-devnet \
+       minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-devnet \
        daemon
 ```
 
diff --git a/docs/node-operators/block-producer-node/docker-compose.mdx b/docs/node-operators/block-producer-node/docker-compose.mdx
@@ -18,7 +18,7 @@ Copy and paste the provided configuration into a `docker-compose.yml` file. Then
 services:
   generate_wallet_key:
     image: 'minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet'
-    # image: 'gcr.io/o1labs-192920/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
+    # image: 'minaprotocol/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
     environment:
       MINA_PRIVKEY_PASS: PssW0rD
     entrypoint: []
@@ -32,7 +32,7 @@ services:
       - './node/mina-config:/data/.mina-config'
   mina_block_producer:
     image: 'minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet'
-    # image: 'gcr.io/o1labs-192920/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
+    # image: 'minaprotocol/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
     restart: always
     environment:
       MINA_PRIVKEY_PASS: PssW0rD
diff --git a/docs/node-operators/seed-peers/docker-compose.mdx b/docs/node-operators/seed-peers/docker-compose.mdx
@@ -30,7 +30,7 @@ services:
       - './node/mina-config:/data/.mina-config'
   mina_node:
     image: 'minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet'
-    # image: 'gcr.io/o1labs-192920/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
+    # image: 'minaprotocol/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
     restart: always
     environment:
       MINA_LIBP2P_PASS: PssW0rD
diff --git a/docs/node-operators/snark-workers/docker-compose.mdx b/docs/node-operators/snark-workers/docker-compose.mdx
@@ -18,7 +18,7 @@ Copy and paste the provided configuration into a `docker-compose.yml` file. Then
 services:
   generate_wallet_key:
     image: 'minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet'
-    # image: 'gcr.io/o1labs-192920/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
+    # image: 'minaprotocol/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
     environment:
       MINA_PRIVKEY_PASS: PssW0rD
     entrypoint: []
@@ -32,7 +32,7 @@ services:
       - './node/mina-config:/data/.mina-config'
   mina_snark_coordinator:
     image: 'minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet'
-    # image: 'gcr.io/o1labs-192920/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
+    # image: 'minaprotocol/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
     restart: always
     environment:
       MINA_PRIVKEY_PASS: PssW0rD
@@ -61,7 +61,7 @@ services:
         condition: service_completed_successfully
   mina_snark_worker:
     image: 'minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet'
-    # image: 'gcr.io/o1labs-192920/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
+    # image: 'minaprotocol/mina-daemon:3.1.0-alpha1-56cdb61-bullseye-devnet' # Use this image for Devnet
     restart: always
     entrypoint: []
     command: >
diff --git a/package.json b/package.json
@@ -15,7 +15,8 @@
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
     "typecheck": "tsc",
-    "update-sidebar": "node scripts/update-sidebars-o1js-api.js && npx prettier --config .prettierrc --write sidebars.js"
+    "update-sidebar": "node scripts/update-sidebars-o1js-api.js && npx prettier --config .prettierrc --write sidebars.js",
+    "validate-docker-images": "node scripts/validate-docker-images.js"
   },
   "dependencies": {
     "@docusaurus/core": "^3.8.0",
diff --git a/scripts/README.md b/scripts/README.md
@@ -0,0 +1,146 @@
+# Docker Image Validation Script
+
+This script validates Docker images referenced in MDX documentation files to ensure they exist on their respective registries.
+
+## Features
+
+- **Automatic Discovery**: Scans all MDX files in the `docs/` directory
+- **Multi-Registry Support**: Validates images on both Docker Hub and Google Container Registry (GCR)
+- **Pattern Matching**: Detects various Docker image reference formats:
+  - Direct image references: `minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet`
+  - YAML image fields: `image: 'minaprotocol/...'`
+  - Docker commands: `docker pull minaprotocol/...`
+  - GCR images: `gcr.io/project/image:tag`
+- **Detailed Reporting**: Shows which files reference each image and validation status
+- **Location Tracking**: Tracks all locations where each image is used
+
+## Usage
+
+### Using npm script (recommended):
+
+```bash
+npm run validate-docker-images
+```
+
+### Direct execution:
+
+```bash
+node scripts/validate-docker-images.js
+```
+
+Or make it executable:
+
+```bash
+chmod +x scripts/validate-docker-images.js
+./scripts/validate-docker-images.js
+```
+
+## Output
+
+The script provides:
+
+1. **Discovery Phase**: Lists all found Docker images and their locations
+2. **Validation Phase**: Checks each image against its registry
+3. **Summary**: Shows counts of valid, invalid, and error cases
+4. **Detailed Report**: Lists invalid images with their locations
+
+### Example Output:
+
+```
+🔍 Scanning MDX files for Docker images...
+
+Found 364 MDX/MD files
+
+Found 17 unique Docker images
+
+================================================================================
+
+📋 Docker Images Found:
+
+• minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet
+  Found in 23 file(s):
+    - exchange-operators/rosetta/docker-compose.mdx
+    - node-developers/sandbox-node.mdx
+    - node-operators/generating-a-keypair.mdx
+    ... and 20 more
+
+================================================================================
+
+🔍 Validating images...
+
+Checking minaprotocol/mina-daemon:3.1.0-ae112d3-bullseye-mainnet... ✅ EXISTS
+
+================================================================================
+
+📊 SUMMARY:
+
+Total images found: 17
+✅ Valid images: 6
+❌ Invalid images: 11
+⚠️  Errors: 0
+```
+
+## Exit Codes
+
+- **0**: All images validated successfully
+- **1**: One or more images failed validation
+
+## Supported Registries
+
+### Docker Hub
+- Public images from `minaprotocol/*` namespace
+- Uses Docker Hub API v2: `https://hub.docker.com/v2/repositories`
+- No authentication required for public images
+
+### Google Container Registry (GCR)
+- Images from `gcr.io/o1labs-192920/*`
+- Uses Docker Registry HTTP API V2
+
+## Limitations
+
+1. **Rate Limiting**: The script includes a 100ms delay between requests to avoid rate limiting, but excessive runs may still hit API limits.
+
+2. **Private Registries**: Only public Docker Hub and GCR registries are supported.
+
+## Integration with CI/CD
+
+You can add this script to your CI pipeline to catch broken image references:
+
+```yaml
+# GitHub Actions example
+- name: Validate Docker Images
+  run: npm run validate-docker-images
+```
+
+```yaml
+# GitLab CI example
+validate-docker-images:
+  script:
+    - npm run validate-docker-images
+```
+
+## Troubleshooting
+
+### Timeout errors
+- Check your internet connection
+- Verify the registry URLs are accessible
+- Consider increasing the timeout in the script (line 108)
+
+### False positives
+- Some registries may temporarily be unavailable
+- Rate limiting may cause temporary failures
+- Re-run the script to confirm persistent issues
+
+## Contributing
+
+To modify the script:
+
+1. **Add new registries**: Update the validation functions in `validate-docker-images.js`
+2. **Adjust patterns**: Modify `DOCKER_IMAGE_PATTERNS` array to match new formats
+3. **Change timeout**: Adjust the timeout value in `httpsRequest()` function
+
+## Related Documentation
+
+- [Docker Hub API](https://docs.docker.com/docker-hub/api/latest/)
+- [Docker Registry HTTP API V2](https://docs.docker.com/registry/spec/api/)
+- [Google Container Registry](https://cloud.google.com/container-registry/docs)
diff --git a/scripts/validate-docker-images.js b/scripts/validate-docker-images.js
