Why Use the Registry Proxy?
- Centralized credentials - Add your GitHub PAT or registry password once, use it across all clusters
- Your credentials stay safe - Upstream registry passwords and tokens never leave CNAP
- Instant revocation - Disable access immediately without rotating credentials everywhere
- Audit trail - See which deployments pulled which images and when
For Marketplace Products
When selling products with private images, the proxy is especially valuable:- Keep credentials private - Customers can pull your images without knowing your PAT
- Per-customer control - Revoke a customer’s access without affecting others
- No credential sharing - Your GitHub PAT gives access to all your repos, but customers only get access to what they purchased
How It Works
CNAP runs a registry proxy atoci.cnap.tech. When clusters pull images through this proxy, CNAP:
- Validates the request using install-scoped credentials
- Looks up your workspace’s upstream registry credentials
- Forwards the request to the upstream registry with your credentials
- Streams the response back to the cluster
Using the Proxy in Your Images
To pull images through CNAP’s proxy, prefix your image references withoci.cnap.tech/:
oci.cnap.tech/{upstream-registry}/{repository}:{tag}
Marketplace Products
When building products for the marketplace, reference your private images through the proxy in your Helm chart’svalues.yaml:
GitHub Repository Deployments
When deploying from GitHub repositories, your workflow pushes to GHCR normally—CNAP handles the proxy routing automatically. Configure workspace credentials in Settings → Registries with a PAT that hasread:packages scope, and CNAP will detect image references in your Helm values and rewrite them to use the proxy at install time.
GitHub Actions Workflows
See how to set up automated builds that push to GHCR and notify CNAP
Setting Up Registry Credentials
1
Open Registry Settings
Navigate to Settings → Registries in your workspace. This is where you manage all registry credentials for the workspace.
2
Add a Registry
Click Add Registry and enter:
- Name - A friendly name to identify this registry (e.g., “Production Docker Hub”)
- Registry URL - The registry hostname (e.g.,
docker.io,ghcr.io,123456789.dkr.ecr.us-east-1.amazonaws.com) - Authentication type - Choose based on your registry’s requirements
3
Configure Authentication
Enter your credentials based on the authentication type:
- Username & Password
- Token
- OAuth
Standard authentication used by most registries:
- Username - Your registry username
- Password - Your registry password or access token
4
Test and Save
CNAP validates your credentials before saving. If validation fails, check that your credentials have pull access to the registry.
Supported Registries
CNAP has built-in support for popular registries:| Registry | URL | Auth Type | Notes |
|---|---|---|---|
| Docker Hub | docker.io | Username/Password | Use access token instead of password for better security |
| GitHub Container Registry | ghcr.io | Token | Use a PAT with read:packages scope |
| Amazon ECR | <account>.dkr.ecr.<region>.amazonaws.com | AWS Credentials | Access Key ID, Secret Access Key, and Region |
| Google Container Registry | gcr.io | Service Account | Username _json_key, password is service account JSON |
| Azure Container Registry | <name>.azurecr.io | Username/Password | Use service principal or admin credentials |
| GitLab Container Registry | registry.gitlab.com | Token | Use a PAT or deploy token with read_registry scope |
| Quay.io | quay.io | Token | Use robot accounts for automation |
Managing Access
Workspace-Level Credentials
Registry credentials are configured at the workspace level:- All deployments in the workspace can access images from configured registries
- Different workspaces can have different registry configurations
- Credential updates automatically apply to all deployments in the workspace
Syncing Credentials to Existing Deployments
When you add or update registry credentials, existing deployments need to be synced to use them. You can:- Sync all deployments - In Settings → Registries, click “Sync All” to push credentials to all active deployments
- Sync individual deployments - On a deployment’s detail page, click “Re-sync Registry Access” to update that specific deployment
Revoking Access
To revoke access to private images:- Disable a credential - Toggle the credential to disabled in Settings → Registries. This immediately invalidates all install tokens using that credential. Pods will fail to pull images until the credential is re-enabled.
- Delete a credential - Permanently removes the credential. Existing install tokens become invalid immediately.
Per-Install Tokens
Each deployment (install) receives a unique token for authenticating with the registry proxy. This means:- Revoking one deployment’s access doesn’t affect others
- You can track which deployment is pulling which images
- Deleting a deployment automatically revokes its registry token
Security
CNAP’s registry proxy provides several security advantages over distributing credentials directly:Credentials Never Leave CNAP
Credentials Never Leave CNAP
Your upstream registry credentials (GitHub PAT, Docker Hub token, etc.) are stored in CNAP and never sent to clusters. Clusters receive install-scoped tokens that only work with CNAP’s proxy—they can’t be used directly against upstream registries.
Install-Scoped Tokens
Install-Scoped Tokens
Each deployment receives a unique token. If a cluster is compromised, you can revoke just that deployment’s token without affecting others.
Instant Revocation
Instant Revocation
Disable a workspace credential to immediately block all image pulls. No need to rotate tokens across multiple clusters or wait for caches to expire.
Access Control
Access Control
Only workspace members can view or modify registry configurations. Credentials are never displayed after saving—only the registry name and URL are visible.
Audit Logging
Audit Logging
CNAP logs all image pull operations, giving you visibility into which images are being accessed, by which deployment, and when.
Troubleshooting
Images fail to pull
Images fail to pull
Common causes:
- Credentials don’t have pull access to the repository
- Registry URL doesn’t match the image reference in your manifest
- Token or password has expired
- Image URL not using the proxy format (
oci.cnap.tech/...)
- Verify your credentials work by testing them locally with
docker login - Check that your image references use the proxy format:
oci.cnap.tech/{upstream}/{repo}:{tag} - Update credentials in CNAP if they’ve expired
Deployment not synced
Deployment not synced
Symptoms: Newly added credentials aren’t working for existing deployments.Solution: Existing deployments need to be synced after adding credentials. Go to the deployment’s detail page and click “Re-sync Registry Access”, or use “Sync All” in Settings → Registries.
Authentication errors
Authentication errors
Common causes:
- Incorrect username format (some registries require specific formats)
- Token missing required scopes
- OAuth client misconfiguration
read:packages scope.Rate limiting
Rate limiting
Common causes:
- Registry-specific rate limits on your credentials
- Docker Hub rate limits for authenticated users
Related Topics
- GitHub Actions Workflows → - Automate builds and deploy from GitHub
- Workspaces → - Understand how workspaces organize your resources
- Application Deployments → - Learn how applications are installed
- App Sources → - Configure where your applications come from