Installing the integration in the standard method doesn't always work because communication would be prevented by network boundary issues. In that case, you can configure a Remote Integration. Remote Integrations are integrations that are installed on a Security Validation Platform Actor that then communicate over a network boundary through an integrated proxy function.
Use this document to configure remote integrations using one of the following methods:
- MSI (Supported and recommended for new integration configurations)
- Legacy (Supported for existing integration configurations)
MSI Integrations
This method is the preferred approach for configuring integrations in Security Validation.
Prerequisites
Before an Actor can host a Remote Integration, a set of dependencies must be installed. You only see the button to install the dependencies if you have Actors that:
- Meet the requirements that follow for a Remote Integration
- Don't have the dependencies installed already
The Actor is required to:
- Be deployed as a Linux Network Actor OVA with the following:
- 2 processor cores
- 16 GB RAM
- At least 50 GB disk space
Only Actors installed from virtual appliances are capable of serving as a host for an integration. - Be on the same version as the Mandiant Security Validation (MSV) environment; for example, only a 4.13.0.0 Actor can work as a Remote Actor on MSV 4.13.0.0.
- Communicate with the integration on its required API port
- Connect to the Director over HTTPS protocol on port 443
- Use Pull as the communication mode
Any required updates to the integrations occur when the Actor is updated.
Change Actor Communication Mode
Once the Linux Network Actor is deployed and registered with the Director, you must change the communications mode for the Actor from “Push” to “Pull."
- From the Director, go to Environments > Actors.
- Click more next to the eligible Actor that is going to handle Remote Integrations and then select Edit.
- Change the Actor's Comm mode to Pull.
- Click Update Actor to save the changes.
Install Dependencies on Actor
- Go to Settings > Integrations.
- Scroll to Legacy Integrations and select Install Dependencies on Actor.
For Remote Actor Integrations, the product supports installing Integration dependencies on one Actor at a time. Installing Integration dependencies on multiple Actors at the same time could lead to failures and the dependencies not being installed.
- For the Actor that you set up with Remote Integrations prerequisites, click the Actor name in the drop-down to install the Remote Integration dependencies on the Actor.
Example of Remote-Eligible Actor for Remote Integrations
A status bar appears, indicating that the dependencies are being installed.
Example of status bar when remote integration dependencies are being installed
After the dependencies are installed, a check box appears next to the Actor in the drop-down.
Example of Remote Actor with Dependencies Installed
When the Integrations service is updated from the Director, the updates become available to the Actor. If an update is available, it appears in the same drop-down and you install it by clicking Update Integrations on Actor. - When you want to add an integration to MSV that is on-prem and not accessible directly by the Director, go to Settings > Integrations, and then select Add Remote Integration. When MSV queries that integration, the queries go through the Actor instead of the Director.
Legacy Integrations
This document applies to Classic/Legacy Integrations. You may continue to use these integration configurations. While no active development is happening for these integrations, we continue to provide Classic/Legacy Integrations in the product. You do not have to move to MSI Integrations. If your support engineer or TSC recommends or you choose to move to MSI Integrations, you can take advantage of the latest features and functionality. For more information, see the MSI Integration documentation in the Integrations Overview.
Prerequisites
Before an Actor can host a Remote Integration, a set of dependencies must be installed. You only see the button to install the dependencies if you have Actors that:
- Meet the requirements that follow for a Remote Integration
- Don't have the dependencies installed already
Only Actors installed from virtual appliances are capable of serving as a host for an integration. The Actor is required to:
- Be deployed as a Linux Network Actor OVA that has 2 processor cores, 8 GB RAM, and at least 50 GB disk space
- Communicate with the integration on its required API port
- Connect to the Director over HTTPS / 443
- Use Pull as the communication mode
Any required updates to the integrations occur when the Actor is updated.
Change Actor Communication Mode
Once the Linux Network Actor is deployed and registered with the Director, you must change the communications mode for the Actor from “Push” to “Pull."
- From the Director, go to Environments > Actors.
- Click more next to the Actor that is going to be a Remote Integration Actor and select Edit.
- Change the Actor's Comm mode to Pull.
- Click Update Actor to save the changes.
Install Dependencies on Actor
- Go to Settings > Integrations.
- Scroll to the Legacy Integrations table, and select Install Dependencies on Actor.
- Select the Actor that you set up in the previous procedure and wait for the installation process to complete.
- When you want to add an integration to MSV that is on-prem and not accessible directly by the Director, go to Settings > Integrations, and then select Add Remote Integration. When MSV queries that integration, the queries go through the Actor instead of the Director.