Deploying Solace Cloud in a Customer-Controlled Container

You can deploy Solace Cloud to Customer-Controlled Containers in a private region in your own infrastructure. A private region using a Customer-Controlled Container allows you to deploy and manage event broker services to other Customer-Controlled Containers in that same private region while maintaining connectivity with Solace Cloud for centralized management.

Deploying Solace Cloud requires deploying the Mission Control Agent to a Customer-Controlled Container in a private region in that infrastructure.

This document explains the following:

Considerations for Deploying Solace Cloud to a Customer-Controlled Container

Before deploying a Solace Cloud to Customer-Controlled Container, ensure the following requirements are met:

  • Customer-Controlled Container-based private regions must be enabled for your account. Contact Solace to enable this feature.

  • You must have a container host with Docker Engine or a compatible container runtime installed. Docker Compose must be available for deploying the Mission Control Agent.

  • You must provide the Customer-Controlled Container with the minimum resource requirements for running the Mission Control Agent.

  • Your Customer-Controlled Container host must meet the connectivity requirements for the Mission Control Agent. For details about required ports and endpoints, see Connectivity Requirements for the Mission Control Agent in a Customer-Controlled Container.

  • Your Customer-Controlled Container must be able to connect to the Solace Container Registry (gcr.io [storage.googleapis.com]), or an image repository in your data center that mirrors it. You must download container registry credentials from the Cloud Console to pull images. For more information, see Downloading the Deployment Package.

  • You can create and manage only a standalone class event broker services in a Customer-Controlled Container.

  • Event broker services deployed to Customer-Controlled Containers cannot use or participate with the following features:

  • You are responsible for updating the Mission Control Agent when deployed to a Customer-Controlled Container. For more information, see Upgrading the Mission Control Agent.

Connectivity Requirements for the Mission Control Agent in a Customer-Controlled Container

The Customer-Controlled Container running the Mission Control Agent must have outbound connectivity to the endpoints listed in the following table:

Connection Port Description

Mission Control Agent to Solace Home Cloud

55443

Required for enrollment and configuration updates. TLS encrypted SMF traffic between the Mission Control Agent and Home Cloud. For the list of regional endpoints and IP addresses, see Connection Details for Deployment.

Insights Agent to Datadog

443

Required for monitoring metrics. TLS encrypted traffic between the Insights Agent and Datadog servers. For the list of Datadog endpoints and IP addresses, see Getting the IP Addresses for Monitoring Traffic.

Container host to Solace Container Registry

443

Required to download container images. TLS encrypted traffic to gcr.io (storage.googleapis.com). Requires container registry credentials downloaded from the Cloud Console. Not required if you mirror images to a local registry.

Mission Control Agent host to event broker service host

SEMP TLS port

Required for the Mission Control Agent to configure event broker services after deployment. The port is the SEMP TLS management port you configure when creating each service.

Creating a Private Region for a Customer-Controlled Container

Before deploying the Mission Control Agent to your Customer-Controlled Container, you must create a private region. You can create a private region for Customer-Controlled Containers using the Cloud Console or the REST API for Solace Cloud.

Creating a Private Region for Customer-Controlled Containers Using the Cloud Console

To create a Customer-Controlled Container-based private region using the Cloud Console, perform these steps:

  1. Log in to the Solace Cloud Console if you have not done so yet. The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the Solace Cloud Console.

  2. On the navigation bar, click User & Account > Account Details.

  3. On the Account Details page, select the Private Regions tab.

  4. Click Add Private Region > Add Customer-Controlled Container.

  5. On the Create New Private Region dialog, complete the required fields:

    • Name: Enter a unique name for the private region.

    • Region: Select the geographic region where your container host is physically located.

    • Image Repository: (Optional) Enter a custom container image repository URL if you are not using the default Solace Container Registry.

    • Environment: The environment for the private region. For more information, see Creating and Managing Environments.

  6. Click Create.

The region page opens with a Pending Connection indicator and shows instructions on how to deploy the Mission Control Agent. The private region remains in a pending state until you deploy the Mission Control Agent to a Customer-Controlled Container in it.

Downloading the Deployment Package

After the private region is created, you can download the deployment package. The deployment package contains everything needed to run the Mission Control Agent and its monitoring agent in your Customer-Controlled Container, including:

  • Docker Compose files

  • Environment and secrets files

  • Monitoring configuration (as a mounted file)

The deployment package references specific, pinned image versions. You must download container registry credentials from the Cloud Console to pull images from the Solace Container Registry. If you mirror images to a local registry, registry credentials are not required. When upgrading, run docker compose pull to fetch any updated images before restarting containers.

To download the deployment package, perform these steps:

  1. On the navigation bar, select User & Account > Account Details.

  2. On the Account Details page, select the Private Regions tab.

  3. Select the private region you created for your Customer-Controlled Containers to open the region page.

  4. Click Download Deployment Package.

  5. Click More Actions and select Download Container Registry Credentials.

  6. On your container host, configure Docker to use the downloaded credentials to authenticate with the Solace Container Registry.

  7. Extract the downloaded archive to a directory on your container host.

Deploying the Mission Control Agent

After downloading and extracting the deployment package, deploy the Mission Control Agent to a Customer-Controlled Container.

To deploy the Mission Control Agent, perform these steps:

  1. Navigate to the directory where you extracted the deployment package.

  2. Run the following command to start the Mission Control Agent:

    docker compose up -d
  3. Verify that the containers are running:

    docker compose ps

    You should see the Mission Control Agent and monitoring agent containers in a running state.

After the Mission Control Agent starts, it calls home to Solace Cloud and the private region enrollment process begins.

Verifying Deployment of Solace Cloud to Your Customer-Controlled Container

You can verify Solace Cloud is deployed to Customer-Controlled Container private region after you deploy the Mission Control Agent. To verify that Solace Cloud is deployed to your Customer-Controlled Container, perform these steps:

  1. Log in to the Solace Cloud Console if you have not done so yet. The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the Solace Cloud Console.

  2. On the navigation bar, select User & Account > Account Details.

  3. On the Account Details page, select the Private Regions tab.

  4. Locate your private region in the list:

    • The Status column shows an icon indicating whether the datacenter is operational.

    • The Mode column shows Ready when the Mission Control Agent has successfully connected to Solace Cloud and the private region is ready for event broker service creation, or Not Ready if the Mission Control Agent has not yet connected or enrollment is in progress.

    You can also select a Customer-Controlled Container-based private region for more information. Depending on the state of the deployment you will see a page with either a:

    • Pending Connection status and steps for completing the deployment of Solace Cloud to your Customer-Controlled Container. This page also offers Download Deployment Package link for downloading the required artifacts

    • containing General Information about the Customer-Controlled Container, its Status & Availability, Mission Control Agent Health, and Supported Service Classes.

Once the private region shows a Ready status, you can create event broker services in it. For more information, see Creating Event Broker Services in a Customer-Controlled Container.

Upgrading the Mission Control Agent

You are responsible for upgrading a Mission Control Agent hosted in a Customer-Controlled Container. Solace cannot upgrade Mission Control Agents in Customer-Controlled Containers because you control the infrastructure.

Solace recommends upgrading your Mission Control Agent as new versions become available, to ensure you have the latest features and security enhancements. You can read about updates for new Mission Control Agent versions in Mission Control Agent Releases.

To upgrade the Mission Control Agent, perform these steps:

  1. On the navigation bar, select User & Account > Account Details.

  2. On the Account Details page, select the Private Regions tab.

  3. Click More Actions for the private region containing the Customer-Controlled Container you want to update and select Upgrade Private Region.

  4. On the Upgrade the Mission Control Agent page, click Download Deployment Package.

  5. On the host of your Customer-Controlled Container, navigate to the directory where you extracted the previous deployment package.

  6. Stop the existing Mission Control Agent using the following command:

    docker compose down
  7. Extract the new deployment package, overwriting the existing files.

  8. Pull the updated images and start the Mission Control Agent with the new version using the following command:

    docker compose pull && docker compose up -d
  9. Verify the Mission Control Agent version in the Cloud Console by selecting the private region you just upgraded to open the region page and checking the version shown in Mission Control Agent Health.

Re-downloading and redeploying the deployment package upgrades the Mission Control Agent to the released version and refreshes its monitoring configuration without disturbing the Customer-Controlled Container or event broker services it manages.

Deleting a Mission Control Agent Deployed to a Customer-Controlled Container

You are responsible for removing a Mission Control Agent hosted in a Customer-Controlled Container in your private region. Solace has no access to your container infrastructure and cannot remove the Mission Control Agent for you.

Before removing the Mission Control Agent, you must delete all event broker services in the private region. The private region cannot be deleted while active event broker services exist. For more information, see Deleting Event Broker Services in a Customer-Controlled Container.

To delete a Mission Control Agent deployed to a Customer-Controlled Container, perform these steps:

  1. Delete all event broker services in the private region.

  2. On the host of your Customer-Controlled Container, navigate to the directory where you extracted the Mission Control Agent deployment package.

  3. Stop and remove the Mission Control Agent containers and volumes:

    docker compose down -v
  4. Wait approximately two minutes for the Mission Control Agent to fully disconnect from Solace Cloud.

  5. Delete the private region record from the Cloud Console:

    1. On the navigation bar, select User & Account  > Account Details.

    2. On the Account Details page, select the Private Regions tab.

    3. Click More Actions for the private region and select Delete Private Region.

    4. Type DELETE in the field and click Delete.

  6. (Optional) Delete the deployment directory to remove credentials and container images from your host.