Configuring the Amazon EC2 REST adapter
You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with the Amazon EC2 application. While each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.
Before creating an adapter configuration, ensure that you have completed all the Prerequisites for the Amazon EC2 REST adapter.
This topic describes the properties to configure the Amazon EC2 REST Actor Adapter.
To configure the actor adapter
- Log on to the BMC Atrium Orchestrator Grid Manager.
- Access the adapters page by clicking the Manage tab; then click the Adapters tab.
- In the Adapters in Repository list select the bmc-ao-adapter-amazon-ec2-rest-actor check box to configure an actor adapter.
- Click Add to Grid to include the adapter in the Adapters on Grid list.
- Click Configure corresponding to the newly added adapter.
- On the Add an Adapter Configuration page, perform the following substeps to configure the adapter using the form view or jump to step 7to configure the adapter using the XML view:
Enter a name for the adapter.
The default name for the Amazon EC2 REST adapter is AmazonEC2RESTActorAdapter.
- Enter a description for the adapter.
- Under Properties, enter or select values for the configuration elements.
Include all required elements indicated with an asterisk (*).
- (Optional) Configure the adapter in the XML view using the following substeps:
- Enter a name and a descripktion for the adapter.
- Click Switch to XML View to specify elements and attributes that are not in the form view, starting with step.
- On the Warning message that appears, click Switch View.
Copy the configuration elements and attributes into the Properties text box, and then click OK.
If the default value for an optional element is acceptable, omit the element. Do not include empty elements.
- On the Warning message that appears, click Save.
This action saves the adapter configuration with settings in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.
The following table describes the elements of an actor adapter configuration that you can specify using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the "UI label" column. To configure such elements and attributes, you have to switch to XML view.
Node elements for configuring the actor adapter
Specifies the Amazon Web Services (AWS) access key
You need to generate the AWS access key by going to the Security Credentials tab in the AWS console.
Specifies the AWS secret access key
You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console.
Specifies the region with which you want the adapter to communicate
Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions.
XML sample for configuring the actor adapter
<config> <access-key>AKIA****************</access-key> <secret-key>7Z8w**********/2ncX*********************</secret-key> <region>us-west-2</region> </config>
Adapter configuration properties
This section describes some common configuration properties than you can add Properties section of the Adapter Configuration page.
Encrypting an element's contents
You can add the attribute
secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.
You must be using BMC Atrium Orchestrator Platform version 7.8 or later to use this encryption attribute.
For example, to encrypt the access-key format used by the Amazon EC2 REST adapter, the XML would look similar to the following:
Enabling custom logging
To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.
You must be using BMC Atrium Orchestrator Platform version 7.8 or later to use the custom logging feature. These parameters will be ignored in earlier versions of BMC Atrium Orchestrator Platform.
These parameters are available with supported adapter versions. See your adapter documentation for details.
- Log File Name: Provide a name for the log file.
This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
- Log File Size: Specify a size limit for the log file.
If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
- Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
- Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.
Log Level: Enter the logging level using one of the following choices:
The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions
Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions
Logs recoverable erroneous conditions and unrecoverable erroneous conditions
The least detailed logging level; logs only error conditions that are not usually recoverable