-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[DX-2749] don't use mutable tags for Chip images in the local CRE #21010
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
Conversation
…ected images exist before starting ChIP stack
|
I see you updated files related to
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the Docker image configuration for ChIP (Chip Ingress and Chip Config) services in the local CRE environment by replacing mutable tags (local-cre) with immutable commit-based tags. It also adds pre-startup validation to ensure required images exist before starting the ChIP stack.
Changes:
- Replace mutable
local-creimage tags with commit hash-based tags for chip-ingress and chip-config - Add image existence validation before starting Beholder/ChIP stack with auto-build/pull capabilities
- Export configuration types and ReadSetupConfig function to enable image validation
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| system-tests/tests/test-helpers/t_helpers.go | Remove extraneous blank line |
| core/scripts/go.mod | Bump dockercompose dependency version |
| core/scripts/cre/environment/environment/setup.go | Export configuration types and ReadSetupConfig function, add documentation |
| core/scripts/cre/environment/environment/environment.go | Update function call to use exported ReadSetupConfig |
| core/scripts/cre/environment/environment/beholder.go | Add image validation logic with auto-build/pull fallback and environment variable configuration |
| core/scripts/cre/environment/configs/setup.toml | Replace mutable tags with commit-specific tags for chip images |
| core/scripts/cre/environment/README.md | Update documentation to reflect new image versioning approach and requirements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.





Summary
This PR fixes a versioning issue with Beholder Docker images (chip-ingress, chip-config) by replacing mutable local-cre tags with immutable commit-based tags. This prevents hard-to-debug issues caused by version mismatches when images are built from source or pulled images are removed.
Problem
Previously, images used a mutable local-cre tag that could point to any version. There was no way to verify if the locally available image matched what was defined in setup.toml, causing subtle bugs when:
Solution
Commit-based image tags: Images now use commit hashes as tags (e.g., chip-ingress:da84cb72d3a160e02896247d46ab4b9806ebee2f)
Auto-build/pull on beholder start: When starting Beholder, the system checks if required images exist with correct versions:
(CI=true): Skips checks (docker-compose pulls at runtime)AWS_ECRset: Auto-pulls from ECRAWS_ECR: Fails with helpful instructionsEnvironment variables for docker-compose: Sets
CHIP_INGRESS_IMAGEandCHIP_CONFIG_IMAGEenv vars for docker-compose to useChanges
configs/setup.toml: Use commit-based tags instead of local-creenvironment/setup.go: Export config types for shared useenvironment/beholder.go: Add image verification, auto-build/pull logicREADME.md: Document new image handling behavior