Pull images from a private image registry

Pull private registry images for Cortex XSOAR 8 SaaS.

Pulling images from a private image registry enables securely accessing and deploying Cortex XSOAR content, for example, custom integrations containing scripts and code packaged into Docker images. You can then run the integrations and scripts in Cortex XSOAR.

Before you begin

• Before pulling a custom image ensure the image does not infringe any licenses.
• If using an engine, connect the engine to the private image registry using Docker or Podman. See Connect Your Engine to an Image Registry.

Note

(Multi-tenant) This feature is not supported on the Main Account.

1. Go to Settings & Info → Settings → Advanced → Image Registry.
2. Set Use Additional Private Image Registry to On.
3. Configure access to the private image registry and the images to pull.

   • Select the Connection to either Direct or Using Engine.

     For Using Engine:

     • Select the Engine to use. Authentication is set on the engine machine, not in the Cortex XSOAR tenant. For an example, see Connect Your Engine to an Image Registry.

     For Direct:

     • Set the Username and Password/Access Token.
   • Define the Registry URL.

     Note

     The registry URL needs to be set to the hostname of your organization registry service, for example us-central1-docker.pkg.dev.
   • Click Test the connection to make sure the connection to the registry works.
   • Define the Import images in name:tag format, for example for example myimage:2.7.18.24398.

     You can add, edit, or remove images. If you don't specify a tag, the default tag latest will be added automatically, specifying the latest version of the image.

     Note

     • If you use folders to store your images, the image name needs to include the folder path, for example myorg/python:latest. Currently, only one folder is supported, and no subfolders.
     • The demisto/ prefix cannot be used for custom registry images.
4. Click Save to persist the configuration and initiate synchronization.

Image synchronization

When you click Save or Update Docker Images, Cortex XSOAR performs synchronization, which involves:

• Pulling the images from the external registry.
• Copying and storing the images on the platform.
• Updating the engines with the new images.

Note

The synchronization process may take time. The Image Registry page displays synchronization status (for example in progress, complete, failure).

If the engine fails to synchronize, it may be offline. When it goes back online, it will pull any new images when running scripts or integrations that use them.