Managing Micro-Integrations in Solace Cloud

After you have created a Micro-Integration, you can perform actions to change its state, such as moving it from Not Deployed to Running. You can also manage the Micro-Integration by modifying the configuration settings as required. When you have finished making your changes, you can redeploy the Micro-Integration.

You must create the Micro-Integration in the same environment as the event broker service that you want to connect to. For more information about environments, see Creating and Managing Environments.

To manage a Micro-Integration, you can perform the following actions:

Opening a Micro-Integration

You can open a Micro-Integration to view its information and configuration details. You can also view metrics for Micro-Integrations that are in a deployed state. For more information, see Viewing Micro-Integration Metrics .

To open a Micro-Integration, perform the following 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 Micro-Integration.

  3. If your organization uses multiple environments, on the Micro-Integrations page, select the environment where you want to create the Micro-Integration. For more information, see Selecting Environments.

  4. Click the name of the Micro-Integration.

    The Micro-Integration summary page opens.

Opening a Micro-Integration Flow

To view a Flow:

  1. Open the Micro-Integration.

  2. In the Flows pane, click the name of a flow to open it.

Viewing Micro-Integration Metrics

Metrics appear at the top of the Micro-Integration Details page and provide information about Micro-Integration performance and usage, including:

  • the state of the Micro-Integration

  • message and byte usage

  • total messages and errors

We collect metric data at a high frequency and you can see up-to-the minute data by refreshing the Cloud Console browser tab. The table below explains the metrics shown on the card:

Metric Definition
Micro-Integration State

The current status of the Micro-Integration. The status for a Micro-Integration can be:

  • Not Deployed—The Micro-Integration has not been deployed.

  • Unable to deploy—The Micro-Integration cannot be deployed. There may be configuration problems. Review the Micro-Integration.

  • Deploying—The Micro-Integration is being deployed.

  • Running—The Micro-Integration is deployed and active.

Messages Per Second The amount of messages being handled by the Micro-Integration per second.
Bytes Per Second The amount of bytes being handled by the Micro-Integration per second.
Total Messages The total amount of messages handled since the Micro-Integration was deployed.
Total Errors The total amount of errors that have occurred since the Micro-Integration was deployed.
Last Updated The time that the metrics were last updated.
Update Interval The frequency in minutes that we collect metric data.

Editing a Micro-Integration

You can change the configuration details to correct your existing Micro-Integration.

You can only edit a Micro-Integration if it is not deployed.

To edit a Micro-Integration, perform the following steps:

  1. On the navigation bar, select Micro-Integrations.

  2. If your organization uses multiple environments, on the Micro-Integrations page, select the environment where you want to create the Micro-Integration. For more information, see Selecting Environments.

  3. Click the name of the Micro-Integration to open it.

  4. On the Micro-Integration summary page, in the Overview panel, click View Details.

  5. Click Edit to change the Micro-Integration connection details.

  6. When you've finished making changes, click Save.

Editing a Micro-Integration Flow

To edit a Flow:

  1. Open the Micro-Integration.

  2. In the Flows pane, click the ellipsis beside the Flow you want to edit and select Edit.

  3. When you've finished making changes, click Save.

Deploying a Micro-Integration

You can deploy a Micro-Integration to start the movement of data between your external system and event broker service. After the Micro-Integration has been successfully deployed, you can check that it's working by observing that messages are moving between your external system and the Solace event broker service.

Your Micro-Integration must have at least one Flow to be deployable.

To deploy a Micro-Integration, perform the following steps:

  1. On the navigation bar, select Micro-Integrations.

  2. If your organization uses multiple environments, on the Micro-Integrations page, select the environment where you want to create the Micro-Integration. For more information, see Selecting Environments.

  3. Click the name of the Micro-Integration to open it.

  4. On the Micro-Integration summary page, in the top-right corner, click the ellipsis () and select Deploy.

Deploying takes a few minutes. After the Micro-Integration successfully deploys, its state shows as Running. If there are issues deploying, you may need to modify and troubleshoot your Micro-Integration. For more information, see Troubleshooting Micro-Integrations in Solace Cloud.

Undeploying a Micro-Integration

You may want to take your Micro-Integration out of service if it doesn't need to be running or you want to edit or delete it.

To undeploy a Micro-Integration, perform the following steps:

  1. On the navigation bar, select Micro-Integrations.

  2. If your organization uses multiple environments, on the Micro-Integrations page, select the environment where you want to undeploy the Micro-Integration. For more information, see Selecting Environments.

  3. Click the name of the Micro-Integration to open it.

  4. On the Micro-Integration summary page, in the top-right corner, click the ellipsis () and select Undeploy.

Deleting a Micro-Integration

You can delete a Micro-Integration that you no longer require. If you just need to delete a Flow, see Deleting a Micro-Integration Flow.

  • Deleting a Micro-Integration does not delete the event broker service it uses.

  • If an event broker service is deleted in Cluster Manager, all the Micro-Integrations that use it are deleted as well.

  • If you delete a Micro-Integration, all its Flows are deleted as well.

To delete a Micro-Integration, perform the following steps:

  1. On the navigation bar, select Micro-Integrations.

  2. If your organization uses multiple environments, on the Micro-Integrations page, select the environment where you want to create the Micro-Integration. For more information, see Selecting Environments.

  3. Click the name of the Micro-Integration to open it.

  4. On the Micro-Integration summary page, in the top-right corner, click the ellipsis () and select Delete.

  5. On the confirmation dialog, type DELETE, then click Delete.

Deleting a Micro-Integration Flow

To delete a Flow:

  1. Open the Micro-Integration that contains the Flow.

  2. In the Flows pane, click the ellipsis beside the Flow you want to delete and select Delete.

  3. On the confirmation dialog, click Delete.