Multi-environment orchestration allows ThreatConnect® users that have an Environment Server behind a firewall to use their instance to communicate with that server and run applications inside their firewall.
NOTE: System Administrators should refer to the “Multi-Environment Orchestration” section of the ThreatConnect System Administration Guide for instructions on how to create an environment in a ThreatConnect instance, download that environment for configuration in an Environment Server, and enable remote execution for Apps. See the ThreatConnect Environment Server Installation Guide for instructions on how to install an Environment Server. See the ThreatConnect Environment Server Administration Guide for instructions on how to import an Environment Server configuration to enable an Environment Server to communicate with a ThreatConnect instance. See Multi-Environment Orchestration: Executing Playbook Apps Through a Firewall for information about how users can execute Playbook Apps remotely.
- Log into an Organization Administrator account. From the top navigation bar (Figure 1), hover the cursor over PLAYBOOKS and then choose ENVIRONMENTS from the dropdown menu (Figure 2).
- The Environments screen will appear, displaying all available environments for the Organization (Figure 3). The light to the left of an environment will be green if the environment is active and configured to an Environment Server; yellow if the environment is active, but not configured to an Environment Server; and gray if the environment is inactive.
NOTE: Active and configured environments will initially display with a yellow light. The light will turn green as the ThreatConnect instance communicates with the Environment Server and recognizes the environment as configured. Depending on how quickly that communication occurs, there may be a bit of a delay before the light turns green.
- Click the button at the bottom right of an environment to toggle it between active and inactive. Click the Download button at the bottom left to download the configuration for an environment.
- Click on the name of the environment to view the administration page for that environment, which provides information about the environment in real time (Figure 4).
- To view a list of all Playbooks using the environment, click on the number next to Playbook References in the Environment Details section. The Playbooks using <Environment Name> screen will appear with a list of all Playbooks using the environment and each Playbook’s status (Figure 5). The name of each Playbook is a link to the Playbook.
- In the Environment Servers section, the number of Consumers indicates the number of Apps that can be executed remotely at one time. To change this number, click on the pencil icon at the top right of the number. The Change Consumers pop-up screen will appear (Figure 6). Toggle the number up or down, and then click on the OK button to save the changes.
- When the number of Apps that are being remotely executed is larger than the number of available consumers, the remaining Apps are put into a queue. The environment administration page shows queue wait time and other statistics. The queue can be paused or flushed (reset) by clicking the PAUSE and FLUSH buttons, respectively, at the upper right-hand corner of the screen.
- The bottom left of the screen has three buttons. The SHUTDOWN button remotely shuts down the Environment Server. The RESTART button remotely restarts the Environment Server. The DELETE button removes the information for the server in the Environment Servers section from the environment administration page.
- Click the gear wheel at the top right of the screen to view the Environment Settings box (Figure 7). Click the DOWNLOAD CONFIGURATION button to download the configuration file for the environment. Click the ADD VARIABLE button, and the Create Remote Variable pop-up screen will appear (Figure 8). Enter the Name of a keychain variable that is defined in the Variables tab of the System Settings screen of the Environment Server, and then click the SAVE button. The variable will then appear in the corresponding keychain list for Playbook Apps running on the environment.