-
Notifications
You must be signed in to change notification settings - Fork 28
Add container registry configuration docs and simplify build plane setup #240
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
Merged
isala404
merged 2 commits into
openchoreo:main
from
isala404:docs/container-registry-configuration
Jan 23, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| title: Container Registry Configuration | ||
| description: Configure the Build Plane to push images to your container registry. | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # Container Registry Configuration | ||
|
|
||
| The Build Plane requires a container registry to store built images. Both build pods (for pushing) and kubelets on the Data Plane (for pulling) need access to the registry. | ||
|
|
||
| ## Configuration Parameters | ||
|
|
||
| | Parameter | Description | Required | | ||
| |-----------|-------------|----------| | ||
| | `global.defaultResources.registry.host` | Registry hostname | Yes | | ||
| | `global.defaultResources.registry.repoPath` | Path prefix for images | No | | ||
| | `global.defaultResources.registry.tlsVerify` | Verify TLS certificates | No (default: `false`) | | ||
|
|
||
| ## Registry Providers | ||
|
|
||
| ### Amazon ECR | ||
|
|
||
| See [Amazon ECR documentation](https://docs.aws.amazon.com/AmazonECR/latest/userguide/getting-started-cli.html) for repository setup and IAM configuration. | ||
|
|
||
| ```bash | ||
| helm upgrade --install openchoreo-build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \ | ||
| --namespace openchoreo-build-plane \ | ||
| --set global.defaultResources.registry.host=123456789.dkr.ecr.us-east-1.amazonaws.com \ | ||
| --set global.defaultResources.registry.repoPath=openchoreo-builds \ | ||
| --set global.defaultResources.registry.tlsVerify=true | ||
| ``` | ||
|
|
||
| ### Google Artifact Registry | ||
|
|
||
| See [Artifact Registry documentation](https://cloud.google.com/artifact-registry/docs/docker/store-docker-container-images) for repository setup and authentication. | ||
|
|
||
| ```bash | ||
| helm upgrade --install openchoreo-build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \ | ||
| --namespace openchoreo-build-plane \ | ||
| --set global.defaultResources.registry.host=us-central1-docker.pkg.dev/my-project/openchoreo-builds \ | ||
| --set global.defaultResources.registry.tlsVerify=true | ||
| ``` | ||
|
|
||
| ### Azure Container Registry | ||
|
|
||
| See [ACR documentation](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-get-started-azure-cli) for registry setup and AKS integration. | ||
|
|
||
| ```bash | ||
| helm upgrade --install openchoreo-build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \ | ||
| --namespace openchoreo-build-plane \ | ||
| --set global.defaultResources.registry.host=myregistry.azurecr.io \ | ||
| --set global.defaultResources.registry.tlsVerify=true | ||
| ``` | ||
|
|
||
| ### GitHub Container Registry | ||
|
|
||
| See [GHCR documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) for authentication setup. | ||
|
|
||
| ```bash | ||
| helm upgrade --install openchoreo-build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \ | ||
| --namespace openchoreo-build-plane \ | ||
| --set global.defaultResources.registry.host=ghcr.io \ | ||
| --set global.defaultResources.registry.repoPath=my-org/openchoreo \ | ||
| --set global.defaultResources.registry.tlsVerify=true | ||
| ``` | ||
|
|
||
| ### Docker Hub | ||
|
|
||
| See [Docker Hub documentation](https://docs.docker.com/docker-hub/repos/create/) for repository setup. Note the [rate limits](https://docs.docker.com/docker-hub/download-rate-limit/) for free accounts. | ||
|
|
||
| ```bash | ||
| helm upgrade --install openchoreo-build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \ | ||
| --namespace openchoreo-build-plane \ | ||
| --set global.defaultResources.registry.host=docker.io \ | ||
| --set global.defaultResources.registry.repoPath=your-username \ | ||
| --set global.defaultResources.registry.tlsVerify=true | ||
| ``` | ||
|
|
||
| ## Authentication | ||
|
|
||
| ### Push Secret (Build Plane) | ||
|
|
||
| For registries requiring authentication, create a secret in the build plane namespace: | ||
|
|
||
| ```bash | ||
| kubectl create secret docker-registry registry-push-secret \ | ||
| --namespace openchoreo-build-plane \ | ||
| --docker-server=REGISTRY_HOST \ | ||
| --docker-username=USERNAME \ | ||
| --docker-password=PASSWORD | ||
| ``` | ||
|
|
||
| ### Pull Secret (Data Plane) | ||
|
|
||
| For pulling images from private registries, see [Deploy from a Private Registry](../use-cases/deploy-prebuilt-image.mdx#deploy-from-a-private-registry). | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| | Symptom | Check | | ||
| |---------|-------| | ||
| | "unauthorized" error | Verify `registry-push-secret` exists and credentials are valid | | ||
| | `ImagePullBackOff` | Verify image exists and ImagePullSecret is configured | | ||
| | "x509: certificate signed by unknown authority" | Set `tlsVerify=false` or configure CA certificate | | ||
| | "connection refused" | Check network connectivity and firewall rules | | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The troubleshooting advice for the
"x509: certificate signed by unknown authority"error suggests settingtlsVerify=false, which disables TLS certificate verification for registry access. Using this workaround with external registries on untrusted networks allows man-in-the-middle attackers to impersonate the registry and serve malicious images that the platform will build and deploy. Prefer guidance that keepstlsVerify=trueand instructs operators to fix the certificate chain or configure the appropriate CA trust, reservingtlsVerify=falsestrictly for ephemeral local development.