Installing the Event Orchestration runbook
A runbook is a collection of pre-built workflows using a set of adapters and modules that enable you to implement end-to-end use cases.
When you install the runbook, you can choose to configure adapters and modules required for the out-of-the-box Service Down and Host Down use cases. The runbook is designed to allow addition of new custom use cases in a pluggable manner.
Use these sections to install the runbook.
Preparing to install the runbook
- Download the TrueSight Orchestration Content installation files.
See, Downloading the installation files. - Install a compatible version of TrueSight Orchestration Platform.
For instructions, see Installing – Classic mode . After installing the CDP, ensure that you provide administrator permissions to the CDP.
Event Orchestration runbook is compatible with the following product versions:
Product Supported version TrueSight Presentation Server 11.3.02 BMC Remedy AR System 9.1.03 TrueSight Orchestration Platform 8.2.00
Installing the runbook by using the wizard
- Navigate to the folder where you have downloaded the installation files and start the installation program.
- Windows: setup.cmd
- Linux or Solaris: setup.sh
- On the Welcome to TrueSight Orchestration panel, review the information, and on the next page, agree with the License Agreements, and click Next.
- On the Directory Selection panel, accept the default location, or click Browse to select a different location.
On the Repository Communications Settings panel, enter the repository settings:
- Web Server Protocol: Select https or http
- Host Name or IP Address: Enter the fully qualified domain name of the repository server.
- Web Server Port Number: Enter the port number where the repository is installed.
Repository User: Enter the user name of the account created in Remedy Single Sign-On that you use to log on to the repository.
Warning
Ensure that the repository user is not the same as the default Remedy Single Sign-On user.
- Repository Password: Enter the password that matches the specified user account.
- On the Installation Type panel, select BSM Solutions and click Next.
- On the Solution feature selection panel, select Event Orchestration and click Next.
- On the Adapter feature selection pane, the adapters required for the out-of-the-box use cases are already selected.
(Optional) To configure and enable the adapters on the grid directly from the installer, select the Configure Adapters check box and click Next.
Note
You can choose to not configure content from the installer, however, in that case, you must configure and enable the adapters after the installation is complete. If selected, the Solution Configuration panel is displayed in the installer where you can provide the configuration details.
- On the Module feature selection pane, the modules required for the out-of-the-box use cases are already selected.
(Optional) To activate and configure the modules on the grid directly from the installer, select the Configure Modules check box that ensures that the modules selected here are activated and on your grid and click Next.
Note
You can choose to not configure content from the installer, however, in that case, you must configure and enable the adapters after the installation is complete. If selected, the Solution Configuration panel is displayed in the installer where you can provide the configuration details.
On the Solution Configuration panel, provide the configuration details for the Event Orchestration runbook:
Note
The Solution Configuration panel is displayed only if you select the Configure Adapters or Configure Modules check box in the previous panel.
On the ITSM tab, provide the following details:
Field name Description and values AR Server host name Specify the name or the IP address of the computer running the BMC Remedy AR System server. AR Server port Select Port mapper or assign a specific port of the computer running the BMC Remedy AR System (if known).
If the BMC Remedy AR System server is configured to use a port mapper, set the port number to 0.
If the BMC Remedy AR System server is configured to use a specific port to receive requests, assign that specific port number.User name Specify the user required to access the BMC Remedy AR Server Password Specify the password that matches the specified user name. Click the CDP tab and provide the following details:
Field name Description and values Web Server Protocol Select https
Host Name or IP Address Specify the fully qualified domain name where the CDP is installed. Web Server Port Number Specify the port number of the CDP.
Default value: 38080
CDPUser Specify the username required to log on to the grid. CDP Password Specify the password that matches the specified user name. Click the Applications tab and provide the following details and click Next:
Field name Description and values Presentation Server URL Specify the URL for the TrueSight Presentation Server Presentation Server username Specify the username required to log on to the TrueSight Presentation Server
Note
Use must have super admin privileges
Mid-tier URL Specify the URL required to log on to the BMC Remedy AR System mid-tier server Mid-tier user Type the user name required to log on to the BMC Remedy AR System mid-tier server
- On the Installation preview panel, review the features to be installed, and then click Install.
- When the installation finishes, click Done.
The Event Orchestration run book is installed successfully and you can view the install log at the location displayed on the installer.
Installing the runbook silently
In a silent installation, you run the installation program from a command line. To execute a silent installation, you specify an options file to feed the installation settings to the program. The options file is a text file that defines all the required installation properties.
Content artifacts installed with the runbook
When you install the runbook, the adapters, modules, and workflows that constitute the runbook framework and logic for the out-of-the-box use cases are installed in the repository and available in the Grid Manager. These adapters and modules are configured with basic configuration and enabled on the grid.
The following table lists the adapters and modules installed with the runbook.
Content type | Name | Type | Adapter name on the grid |
---|---|---|---|
Adapters | BMC Remedy AR System | ro-adapter-remedy-actor | ARSAdapter_EO |
Command Line | ro-adapter-command-line | Command Line_EO | |
SSH | ro-adapter-ssh | SSHAdapter_EO | |
REST | ro-adapter-rest | RESTAdapter_EO | |
Web Services | ro-adapter-ws | SOAPAdapter_EO | |
Windows Command | ro-adapter-windows-command | WindowsCommandAdapter_EO | |
Modules |
| NA | NA |
Complete the post-installation tasks
Perform these tasks if you have chosen to configure and activate the adapters and modules from the installer.
Note
If you have just installed the runbook without configuring and enabling content from the installer, you must perform additional configuration steps before you can start using/implementing the solution. For more information, see the Where to go from here section in this topic.
Configure the SSH adapter
SSH adapter is used to run commands on a remote host using the SSH protocol. SSH adapter is enabled on your grid, but you must provide the remote host details in the adapter configuration.
Update BMC-SA-Event_Orchestration_Configuration module configuration
When you configure content from the installer, modules with connection details for BMC Remedy ITSM and TrueSight Presentation Server are configured and activated on the grid. Installer does not provide the option to specify passwords for the target connections. You must specify the password for connecting to BMC Remedy ITSM and TrueSight Presentation Server environments.
Update Credentials Store module configuration
The Credentials Store module contains encrypted passwords for all target servers. Credentials for TrueSight Orchestration, TrueSight Presentation Server, and BMC Remedy IT Service Management are stored in the BMC-SA-Event_Orchestration_Configuration module. Assuming that in an organization, each component type (OS type) can have its own set of credentials, definitions for storing UNIX and Windows Credentials are provided in the module out-of-the-box.
Where to go from here
Choose one of the following options:
- Orchestration actions – Restart Service and Check Host Connection are now available in TrueSight Presentation Server for the out-of-the box use cases, Service Down and Host Down respectively. For more information about using the Orchestration actions for your remediation solutions, see "Using Orchestration actions to enable triage and remediation of events
- If you have installed the runbook without configuring and enabling content from the installer, you must perform additional configuration steps before you can start using/implementing the solution. For instructions, see Configuring content in the Event Orchestration runbook.
- If you want to start adding new Orchestration actions for custom use cases, see Adding a custom use case to enable Orchestration actions.
Comments
Log in or register to comment.