Upgrade or update the Splunk SOAR Automation Broker

Splunk SOAR (Cloud) or Splunk SOAR (On-premises) displays a banner notification when a new release of the Splunk SOAR Automation Broker is available for upgrade.

Watchtower is only supported on Docker hosts. Podman hosts must manually upgrade the Splunk SOAR Automation Broker container for new releases.

Locate the appropriate section in this article, based on your deployment type.

If you have multiple Automation Brokers, be sure to read Considerations for multiple Automation Brokers later in this article.

To manually install a Splunk SOAR Automation Broker instance, see Install Splunk Automation Broker when you cannot use DockerHub.

Upgrade using Watchtower with Docker deployments

No user intervention is required when using Watchtower.

The Splunk SOAR Automation Broker runs a process named Watchtower that polls to see if a new Automation Broker version is available. When a new version is released, Watchtower updates the Automation Broker automatically.

The docker-compose.yaml file configures the Automation Broker. The image line contains a URL that redirects to Docker Hub to get the latest image.

CODE 
services:
     automation broker:
          image: <SOAR_URL>/phantomsaas/automation_broker

Upgrade manually using Docker deployments, without Watchtower

In Docker deployments without Watchtower, you must set the location manually.

To upgrade in a Docker deployment, follow these steps:

  1. Set the image: entry in docker-compose.yaml file to

    CODE 
    image: phantomsaas/automation_broker:<version>

  2. In the same location as the docker-compose.yaml file, run the following command.

    CODE 
    docker compose pull && docker compose up -d

Upgrade manually using Podman deployments

In Podman deployments, you must set the location manually. Unlike Docker deployments with Watchtower, Podman deployments do not support redirection.

To upgrade in a Podman deployment, follow these steps:

  1. Set the image: entry in docker-compose.yaml file to

    CODE 
    image: docker.io/phantomsaas/automation_broker:<version>

  2. In the same location as the docker-compose.yaml file, run the following command.

    CODE 
    podman compose pull && podman compose up -d

Considerations for multiple Automation Brokers

If you have multiple Automation Brokers, you will have multiple docker-compose.yaml files.

Be sure to follow these guidelines when updating multiple Automation Brokers:

  • Specify the name of the relevant docker-compose.yaml file in your command with the -f [filename] argument. For example,

    CODE 
    podman compose -f broker1-compose.yaml pull && podman compose up -d

  • Run your commands in the same location as the relevant docker-compose.yaml file.

Docker automatically supports several names of the docker-compose.yaml file. For details, see The Compose file in the Docker documentation.