How to pull Collibra Edge docker images
Pull Collibra Edge docker images to perform security scans or audits. To do this, you must authenticate to the Collibra Edge docker registry and retrieve the list of images for your specific Edge site version.
Prerequisites
- You have installed the
jqcommand line tool. - You have access to your
registries.yamlfile (found in your Edge site installer).
Steps
1. Authenticate to the docker registry
Sign in to the registry to download images.
- Open the
registries.yamlfile in your Edge site installer. - Find the username and password credentials.
- Run the following command using those credentials:
docker login edge-docker-delivery.repository.collibra.io -u <username> -p <password>
2. Get the list of images
You need a list of images that match your specific Edge version and configuration. Use one of the following methods to generate this list.
By default, the command examples below use .enabledImages, which returns images used by your Edge site. You can change this parameter to return a different set of images.
| Parameter | Description |
|---|---|
.enabledImages
|
Lists images that are available for your Edge site based on the version and configurations. |
.allImages
|
Lists all possible images that can run on an Edge site, including those available and not available for your Edge site configurations. |
.filteredImages
|
Lists images that can't run on your Edge site due to license or configuration constraints. |
Tip If you're running a security scan to evaluate images before upgrading your Edge site, use .enabledImages. This returns only the images that will run on your Edge site. You don't need to cross-reference this list with .filteredImages.
Method A: Web Browser
Use this method if you have direct access to your Collibra Platform environment.
- Log in to your Collibra environment.
- Go to the following URL (replace
{collibra-url}and{site-id}with your specific values):https://{collibra-url}/edge/api/rest/v2/sites/{site-id}/images - Save the output list.
Method B: OAuth
Use this method if you need to script the process.
- Obtain your OAuth Client ID and Client Secret.
- Run the following command to get an access token:
Copy
token=$( curl -s -X POST '{collibra-url}/rest/oauth/v2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'client_id={client-id}' \
-d 'client_secret={client-secret}' \
-d 'grant_type=client_credentials' | jq -r .access_token ) - Run the following command to get the image list:
Copy
curl -s -X GET \
-H "Authorization: Bearer $token" \
"{collibra-url}/edge/api/rest/v2/sites/{site-id}/images" | \
jq -r .enabledImages
Method C: Basic Authentication
Use this method if you do not use SSO or OAuth.
- Run the following command using your Collibra username and password:
Copy
curl -s -X GET \
-u <clientId> -p <clientSecret> \
"{collibra-url}/edge/api/rest/v2/sites/{site-id}/images" | \
jq -r .enabledImagesImportant If you use SSO, you must use the credentials found in the/resources/manifests/edge-secret.yaml file instead of your Collibra username and password. Enter the username for<clientId>and enter the password for<clientSecret>.
Advanced options
Query parameters: Add these parameters to the URL in your curl command to customize the response.
- Edge version (
edgeVersion): Specifies the Edge version you want to pull images from. By default, the command uses your current Edge version. Go to the release notes for valid version numbers. - K3s Images (
k3s): Includes k3s-specific images in the list. By default, this is set tofalse.
curl -s -X GET \
-H "Authorization: Bearer $token" \
"{collibra-url}/edge/api/rest/v2/sites/{site-id}/images?edgeVersion=2025.10.42" | \
jq -r .enabledImages
curl -s -X GET \
-H "Authorization: Bearer $token" \
"{collibra-url}/edge/api/rest/v2/sites/{site-id}/images?k3s=true" | \
jq -r .enabledImages
3. Pull the images
- Review the list of images you generated in Step 2.
- Run the
pullcommand for each image in the list:docker pull <image_name>Exampledocker pull edge-docker-delivery.repository.collibra.io/capabilities/edgeharvester:1.5.0