Deploying and Undeploying Micro-Integrations in Solace Cloud
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.
Deployment States
A Micro-Integration can be in one of several deployment states depending on where it is in the creation and management process:
- Not Deployed
- When you undeploy a Micro-Integration, it transitions from Running to Undeploying, and then to Not Deployed state. A Micro-Integration starts in the Not Deployed state when it's first created. In the Not Deployed state, data does not flow between your external system and the event broker service.
- Deploying
- A transient state that indicates the Micro-Integration is in the process of being deployed. If successful, data will start to flow between the external system and the event broker service.
- Running
- When you deploy a Micro-Integration, it transitions from its current state to Deploying, and then the Running state. In the Running state, data flows between your external system and the event broker service.
- Undeploying
- A transient state that indicates that the Micro-Integration is the process of being undeployed, and the flow of data is stopping between your external system and the Solace event broker service.
- Unable to Deploy
- If an error condition occurs during the deployment of the Micro-Integration and it cannot be deployed, the state transitions from the Deploying state to the Unable to Deploy state. When you view the Micro-Integration, the reasons for the errors are displayed in the error text.
- Down
- If an error condition occurs with a Micro-Integration and recovery is not possible, the Micro-Integration moves to the Down state. When you view the Micro-Integration, the reasons for the errors are displayed in the error text.
Deploying a Micro-Integration
To deploy a Micro-Integration, perform the following steps:
-
On the navigation bar, select Micro-Integrations
. -
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.
-
Click the name of the Micro-Integration to open it.
-
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:
-
On the navigation bar, select Micro-Integrations
.
-
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.
-
Click the name of the Micro-Integration to open it.
-
On the Micro-Integration summary page, in the top-right corner, click the ellipsis (
) and select Undeploy.