Creating and Managing Environments

Environments in PubSub+ Cloud represent the operational environments within your organization. Every organization is provided with an environment, named Default. The Default environment is set as the default environment for activities such as event broker service creation. You can change the name of the Default environment, move its default status to another environment, and even delete the environment named Default after moving the default status to another environment. You may choose to use only the Default environment, or you may decide to have multiple environments, such as a development environment, a testing environment, a staging environment, and a production environment. You should be aware of the following considerations when using environments:

  • You create environments at the PubSub+ Cloud account level.

  • You must have the Administrator role to create, modify, set a default, or delete environments.

  • Each PubSub+ Cloud account must have one environment set as the default, and can have up to 50 environments.

  • Each environment must have a unique name.

  • For each environment, you can turn on runtime configuration to enable Event Portal to push configuration details in applications to the operational Solace event brokers represented in the modeled event meshes in the environment. For more information about setting up runtime configuration, see Configuring Event Brokers in Event Portal.

  • In each environment, you can require Event Portal applications to use templates when developers set Solace queue configurations or client profile names. If a template is required for the environment, you must use an allowed template or you can't add the application to a modeled event mesh in the environment. For more information about associating templates in Event Portal with environments, see Runtime Configuration Templates.

You can perform the following tasks for environments:

Creating an Environment

You must be an Administrator to create environments. To create an environment, perform these steps:

  1. Log in to the PubSub+ Cloud Console . The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the PubSub+ Cloud Console.
  2. On the navigation bar, select User & Account > Environments.
  3. Click Create Environment.
  4. In the Create Environment dialog box, enter an Environment Name.
  5. (Optional) Enter a Description for the environment.
  6. (Optional) Select the Set as default environment check box to make the environment the default environment. You can only have one default environment. Creating an event broker service by API without indicating an environment creates it in the default environment.
  7. Select one of the Environment Type radio buttons.
  8. (Optional) In the Appearance section:
    1. Click the Color menu to open the color picker where you can select colors for the environment badge.
    2. Click the Icon menu to open the icon picker where you can select the icon to represent the environment.
  9. Click Create.

    10. You can now assign resources to the environment. You assign datacenters to an environment using the Private Regions tab of the Cloud Console. For more information, see Private Regions.

Setting an Environment as Default

You must have an environment set as the default environment. Users with the administrator role can set any environment as the default in the Cloud Console.

If you create an event broker service using the REST API in a public region without specifying the environment, you create it in the environment set as the default.

To set an environment as default, perform these steps:

  1. Log in to the PubSub+ Cloud Console . The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the PubSub+ Cloud Console.
  2. On the navigation bar, select User & Account > Environments.
  3. In the list of environments, click More Actions for the environment that you want to set as the default and select Set As Default.

    The Default indicator appears beside the name of the environment.

Updating Environment Settings

Users with the Administrator role can change the name, description, color, and icons of any environment. They can also enable runtime configuration for environments to allow the configuration of Solace event brokers from Event Portal and require developers to use configuration templates for applications in an environment.

For more information about adding and updating modeled event meshes in an environment, see Designing Modeled Event Meshes.

Moving the datacenters associated with an environment is performed on the Private Regions tab. For more information, see Private Regions.

To update an environment, perform these steps:

  1. On the navigation bar, select User & Account > Environments.
  2. To change the environment name, description, or appearance:
    1. In the list of environments, click More Actions for the environment you want to update, and select Edit.
    2. Change the Environment Name, Description, or Appearance and click Save.
  3. To allow application configuration details to be pushed to runtime event broker services connected to the environment:
    1. In the list of environments, click More Actions for the environment you want to update, and select Enable Runtime Configuration.
    2. Click Enable.
  4. To stop allowing application configuration details to be pushed to runtime event broker services connected to the environment:
    1. In the list of environments, click More Actions for the environment you want to update, and select Disable Runtime Configuration.
    2. Click Disable.
  5. To specify whether developers must use configuration templates for applications in the environment:
    1. In the list of environments, click More Actions for the environment you want to update, and select Manage Configuration Templates.
    2. Select the types of templates required for the environment or clear the option for template types that you no longer want to require.
    3. Click Apply.

Setting User Access to Environments

The level of access you have to the resources in an environment depends on the role you're assigned in your PubSub+ Cloud account, the permissions granted to that role, and the component of the Cloud Console you access. Roles can be assigned directly to users or, if your organization has SSO enabled, through user groups. For more information, see Managing Users, Groups, Roles, and Permissions.

For more information, see:

Access to Resources in Environments in Cluster Manager

Mission Control users always have access to all environments and can see resources in environments in Cluster Manager that they have permissions to view.

Access to Resources in Environments in Event Portal

Users with the Administrator and Event Portal Manager roles have access to all modeled event meshes in all environments in Runtime Event Manager. Users with the Event Portal User role have limited viewing and editing capabilities. They can't view a modeled event mesh unless they are granted access to the environment containing the modeled event mesh by a user with Administrator or Event Portal Manager role.

The following access levels can be granted to Event Portal Users:

EP Runtime Viewer
Event Portal Users with Viewer access to an environment can view the objects in modeled event meshes that are part of the environment in Runtime Event Manager. To open objects in the modeled event mesh, users must also have Application Domain Viewer access for the application domain that the objects are contained in.
EP Runtime Editor
Event Portal Users with Editor access to an environment can perform the same functions as users with Viewer access. They can also perform these functions:
  • add and remove applications in a modeled event mesh if they also have at least Editor level access to the application domain containing the applications
  • rearrange the graph layout for the modeled event mesh

For more information about the permissions associated with the Viewer and Editor access levels, see Managing User Access to Event Portal.

Providing Event Portal Users Access to an Environment

Administrators and Event Portal Managers can give Event Portal Users access to environments. To give Event Portal Users access, perform these steps:

  1. On the navigation bar, select User & Account > Environments.
  2. In the list of environments, click More Actions for the environment that you want to update and select Set User Access.
  3. Perform one of the following actions:

    • If your organization doesn't have user groups enabled, click Add User.

      Screenshot showing the settings described in the surrounding steps.

    • If your organization has user groups enabled, click Add and select either Add User Group or Add User.
  4. In the Name list, type or select the name of the user or user group you want to give access to. Only users and user groups with the Event Portal User role whom you have not already set an access level for appear in the list.
  5. In the Access Level list, select either Viewer or Editor to give access to the user or user group.
  6. Repeat steps 3-5 to give access to another user or user group.
  7. To remove access, click Remove in the row for the user or user group.
  8. Click Save.

Selecting Environments

If your organization has multiple environments, the first time that you access either Cluster Manager or Runtime Event Manager in the Cloud Console, you are asked to select the environment you want to work in for this and future Cloud Console sessions. You can change to another environment at any time using the Environment button in the top-left of Cluster Manager or Runtime Event Manager.

If you are creating event broker services in Cluster Manager and modeling those services in a modeled event mesh in Event Portal, Solace recommends creating the services and the modeled event mesh in the same environment.

Selecting an Environment for the First Time

If you are working in Cluster Manager or Runtime Event Manager, you must have an environment selected. If the Cloud Console can't determine the environment selected in your last session, you are prompted to select an environment when you open Cluster Manager or Runtime Event Manager. This becomes your selected environment for future Cloud Console sessions.

To select an environment for the first time, perform these steps:

  1. Log in to the PubSub+ 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 PubSub+ Cloud Console.
  2. On the navigation bas, select Cluster Manager or Runtime Event Manager .
  3. In the Environments dialog that opens, choose your starting environment and click Select.

Changing Environments

You can change environments as required. To change environments, perform these steps:

  1. Log in to the PubSub+ 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 PubSub+ Cloud Console.
  2. On the navigation bas, select Cluster Manager or Runtime Event Manager .
  3. Click on the Environment button in the top-left corner of the Cloud Console and select an environment from the menu.

  4. (Optional) Click Show resources in all environments if you want to see all event broker services and modeled event meshes in all environments.

    Screenshot showing the options described in the surrounding text.

    5. All environment labels in the user interface change to those of the selected environment. The displayed list of available event broker services and modeled event meshes shows only the resources that are part of the environment unless you selected Show resources in all environments.

Disabling Event Broker Service Creation in Public Regions for an Environment

By default, users can create event broker services in Public Regions. Users with the Administrator role can disable the ability to create event broker services in Public Regions for specific environments.

To disable event broker service creation in Public Regions, perform these steps:

  1. On the navigation bar, select User & Account > Environments.
  2. In the list of environments, click More Actions for the environment that you want to disallow creation of event broker services in Public Regions and select Advanced Options.
  3. On the Advanced Settings dialog, select Allow service creation in all public regions and then click Save.

Deleting an Environment

Deleting an environment can fail if:

  • You recently deleted an event broker service. Deleting an event broker service takes time. If the deletion of the event broker service has not completed, you can't delete the environment.

  • The environment contains an event broker service that failed deletion.

Attempt to delete the environment again at a later time. If you can’t delete the environment, contact Solace .

Users with the Administrator role can delete environments if they do not contain datacenters or event broker services and they are not set as the default environment. When you delete an environment, you also delete all of the modeled event meshes in the environment. However, application versions and associated objects in the modeled event mesh are not deleted from their application domains in Event Portal.

To delete an environment, perform these steps:

  1. On the navigation bar, select User & Account > Environments.
  2. In the list of environments, click More Actions for the environment that you want to delete and select Delete.
  3. Confirm that you want to delete the environment and all of the modeled event meshes it contains.
  4. Click Delete.