Additional Options for Deploy Anywhere Integrations
The following options are added in Flow Editor for deploy anywhere integrations apart from the existing options,
- Search Runtime
- Package Services
- Sync
Search Runtime
You can choose a runtime from the Search Runtime option while creating a deploy anywhere integrations.
- In flow services using packages, the Search Runtime option appears on the flow step after you choose a package.
- In deploy anywhere flow services, the Search Runtime option appears on the Flow Editor's menu bar.
- In workflows, the Select Integration Runtime option appears on the Settings page after you add a package to the workflow.
Package Services
The package services are the services available in a package that is imported to your project. All the services available in a package are grouped and displayed as Package Services category in integrations. You can reuse these services in your current integration and save time by building on existing services rather than creating from scratch. For more information, see Package Services.
Sync
The Sync option synchronizes all assets in a project with the selected runtime and all instances that are connected with a runtime.
By default, any deploy anywhere integration you create is initially saved in cloud designtime, even if you chose a different runtime. Choosing a target does not attach your service to a particular runtime environment. As a result, after saving the service, if you go to the associated runtime in the Projects tab, you do not find the service. Only after you do a synchronization operation, the service is linked to the appropriate runtime instances. Therefore, it is advisable to do a synchronization operation before you run a service to prevent potential errors.
The behavior of sync process in pictorial representation is as follows.
If you run a deploy anywhere integration when synchronization fails, the outcome might not meet your expectations. This can happen because the previously saved deploy anywhere integration must have run without including the latest updates.
- In production environments, you can do a sync operation, however this mechanism is not designed for use in a production environment and must be avoided.
- At times, you might encounter unknown package issues while running an integration even if synchronization is successful. In such scenarios, restart the Cloud Designtime, synchronize, and run the integration.
- In flow services using packages, the Sync option appears on the flow step after you choose a package and runtime.
- In deploy anywhere flow services, the Sync option appears on the Flow Editor's menu bar as follows:In deploy anywhere flow services, the Sync option appears on the Flow Editor's menu bar as follows.
- In workflows, the Sync option appears on the Test this action page after you add a package to the workflow.
An orange dot appears on the Run and Sync buttons when user actions are required.
You can resolve the Run and Sync buttons operations as follows:
| Scenario | Action |
|---|---|
| If the selected runtime status is Running, but the most recent copy of the package does not match the runtime. | Synchronize the most recent changes before running the deploy anywhere integration. |
| If the selected runtime state is disabled or offline. | Set the selected runtime to Running status and complete the sync or run operation. |
| If the selected runtime is deregistered (indicated with a strikethrough in the Search runtime drop-down list), | Select a different running runtime to complete sync and run operations, since the selected runtime no longer exists. |
| If there is any infra issue, such as server outages, network connectivity issues, or insufficient system resources, then a pop-up message appears if the runtime validation takes a longer time. | Sync after the environment stabilizes. |
| If the selected runtime status is Running, but the deploy anywhere integration did not sync. | The result might not be as expected since the old deploy anywhere integration was used. Resync and run the deploy anywhere integration. |
- The deploy anywhere integrations must always be synced before running the service on any runtime. This ensures that you are running the latest version of the service.
- The Sync option becomes enabled for registered edge runtimes after saving them.
- The Sync option is not available for cloud runtime because the cloud system automatically maintains all assets and the artifacts are up to date.
- If two different users attempt to sync the runtime at the same time for two different deploy anywhere integrations, the system generates an error message stating, Unable to perform sync action as <Edge_Runtime_name> is currently syncing.
- The runtime status transitions to Running after the successful synchronization of all runtime instances.
- The runtime status remains as Running even if the instances do not sync during the sync process.
You can view the most recent synchronization details for a specific runtime that is in the Running state using the Sync report option.
Sync report access depends on the runtime type.
- For public runtime, the sync reports can be generated and accessed by all users.
- For private runtime, the sync reports can be generated and accessed by their respective owners. Administrators can manage access but cannot generate reports.
- In the Integration Runtime page, identify the runtime for which you want to download the sync report. Make sure that the runtime status is Running.
- Click the Vertical Ellipsis button and select Sync report. The
report is downloaded as a JSON file to your default downloads folder.
The sync report includes the date and time of the last synchronization, and the list of packages synchronized to the runtime.
Note:- A sync report cannot be downloaded for Cloud Runtime and Cloud Designtime.
- For multiple instances edge runtime, you can download the sync report by clicking the Sync report button on the Instance Listing page.