Private Regions

The Private Regions tab provides a central location where you can view and manage your private regions, as well as make requests for additional private regions. You can also use the Private Regions tab to:

As a controlled availability feature, you can also deploy your own self-serve Private Regions. For more information, see Self-Serve Private Regions.

Deployments in Customer-Controlled Clusters and Dedicated Clusters can assign their private regions to environments. Assigning private regions to environments allows you to separate the infrastructure you deploy event broker services to. Environments can be used to separate infrastructure based on use case, for example a private region for staging, and another for production. For more information about deploying Solace Cloud with environments in private regions, see Environment Architecture for Dedicated Cluster and Customer-Controlled Cluster Deployments.

You can perform the following tasks for environments:

Considerations for Using the Private Regions Tab

Be aware of the following considerations when using the Private Regions tab:

  • You must have the Administrator role to see the Private Regions tab in the Cloud Console and to access the associated Private Regions page.

Viewing Your Private Region Details

To view the details of your private regions, 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.

If you don't have any Private Regions, you see a screen stating that no private regions are available.

On this screen you can click Request New Private Region to make a request that a private region be added. The request is sent to your account team, who will contact you about the request.

When private regions exist, the Private Regions tab displays information about your private regions.

You can filter the list of private regions using the Search field, and sort the table by column in ascending or descending order. You can click Add Private Region in the top-right corner of the screen to request new private regions.

The tab displays the following information about your private regions:

  • Name—The name of the private region as shown in the console user interface.
  • Status—The status of the private region, which can either be not yet deployed (a yellow icon), or ready to be used (a green icon).
  • Mode—The Mode column can contain one of three states for the private region:
    • Ready—The private region is ready for the creation of new services.
    • Not Ready—The private region is not ready for the creation of new services.
    • In Maintenance—The private region is available, but services cannot currently be created in it due to other ongoing activity.
  • Location—The continent where the private region is located.
  • ID—The unique identifier for the private region in the private region.
  • Type—The type of private region, either a Kubernetes-based type (Customer-Controlled Cluster or Dedicated Cluster) or a Customer-Controlled Container.
  • Event Portal Connections—The status of the connection to Event Portal can either be Enabled or Disabled. For more information, see Enabling an Event Portal Connection.
  • Environment—The environment the private region is part of. For more information, see Creating and Managing Environments.
  • End of Support Date—The date in this column represents the day that support ends for the Kubernetes version in the private region. Customers using Dedicated Cluster must schedule a cluster upgrade for the Kubernetes version before this date. For more information, see Viewing and Scheduling Kubernetes Version Upgrades in Dedicated Clusters.
  • Configuration Last Updated—The date in this column represents the last time the <datacenter-name>-values.yaml file for Helm chart for this private region was updated. An entry of Not Configured in this column indicates that the <datacenter-name>-values.yaml file for Helm chart is not ready to be downloaded.
  • Untitled column—Contains an ellipse which can be clicked on to access a menu where the Helm values, image pull secret, and validation tool manifest files can be downloaded.

Downloading the Helm Charts for the Mission Control Agent for Kubernetes Clusters

To download the Helm chart for the Mission Control Agent, perform these steps:

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

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

  3. Click the More Actions  for a listed Region.

  4. From the menu that opens, select Download Helm Values.

    The <datacenter-name>-values.yaml file for the Helm chart for the Datacenter is downloaded securely to your local storage drive via TLS. You can use the <datacenter-name>-values.yaml file for Helm chart to deploy the Mission Control Agent into your Kubernetes cluster, see Kubernetes Cluster Installation.

Downloading Registry Credentials for Kubernetes Clusters

You can download the registry credentials you need to access the Solace Container Registry (gcr.io) where Solace images are stored, from the Private Regions tab. Information about the Solace Container Registry is available in Connectivity Model for Kubernetes Deployments.

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

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

  3. Click the More Actions  for a listed Region.

  4. The menu that opens presents one of two options based on your Kubernetes configuration:

    • Download Image Pull Secret securely downloads a <datacenter-id>-pull-secret.yaml file containing a manifest for Kubernetes to your local storage drive via TLS.
    • Download Registry Credentials securely downloads a <datacenter-id>-registry-credentials.json registry credentials file for Kubernetes to your local storage drive via TLS.

    You can use the contents of either of these files as an authorization token to access the Solace Container Registry (gcr.io) where the Solace container images are stored. For more about deploying the Mission Control Agent into your Kubernetes cluster, see Kubernetes Cluster Installation.

Downloading the Validation Tool Manifest for Kubernetes Clusters

You can download the validation tool manifest that is required by the cluster validation tool when validating your Kubernetes cluster with help from Solace. The validation tool requires access to certain images from the Solace Container Registry. For more information, see Downloading the Validation Tool Manifest.

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

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

  3. Click the More Actions  for a listed Region.

  4. From the menu that opens, select Download Validation Tool Manifest.
  5. A <datacenterid>.yaml file where datacenterid is the name listed in the Datacenter ID column of the Private Regions table is downloaded securely to your local storage drive via TLS. You can use the <datacenterid>.yaml file to validate your Kubernetes cluster with help from Solace, see Kubernetes Cluster Validation.

Deploying Solace Cloud in a Customer-Controlled Container

You can deploy a standalone class event broker service to a Customer-Controlled Container. To do so, you must request a private region for your Customer-Controlled Containers, and then download the artifacts required to deploy Solace Cloud to the Customer-Controlled Containers in your own infrastructure.

For more information, see Deploying Solace Cloud in a Customer-Controlled Container

Moving a Private Region to a Different Environment

You can move your private regions to different environments using the Private Regions tab. For more information about managing environments, see Creating and Managing Environments.

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

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

  3. Click the More Actions  for a listed Region.

  4. From the menu that opens, select Move to Another Environment.
  5. On the Move to Another Environment dialog, in the Destination Environment list select the environment to move the private region to.
  6. Click Move.

Enabling an Event Portal Connection

You can enable an Event Portal connection using the Private Regions tab. The connection enables both runtime configuration from Event Portal and discovering runtime data from your event broker services.

  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   and then select Account Details.

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

  4. Click the More Actions  for a listed Region.

  5. From the menu that opens, select Enable Event Portal Connection.
  6. In the Enable Event Portal Connection dialog, select Enable.