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. 

Note

Before creating an adapter configuration, ensure that you have completed all the Prerequisites-for-the-Amazon-EC2-REST-adapter.

To configure the actor adapter

  1. Log on to the BMC Atrium Orchestrator Grid Manager.
  2. Access the adapters page by clicking the Manage tab; then click the Adapters tab.
  3. In the Adapters in Repository list select the bmc-ao-adapter-amazon-ec2-rest-actor check box to configure an actor adapter.
  4. Click Add to Grid to include the adapter in the Adapters on Grid list.
  5.  Click Configure corresponding to the newly added adapter.
  6. 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:

    1. Enter a name for the adapter.

      Note

      The default name for the Amazon EC2 REST adapter is AmazonEC2RESTActorAdapter.

    2. Enter a description for the adapter.
    3. Under Properties, enter or select values for the configuration elements. 
      Include all required elements indicated with an asterisk (*).
  7. (Optional) Configure the adapter in the XML view using the following substeps:
    1. Enter a name and a descripktion for the adapter.
    2. Click Switch to XML View to specify elements and attributes that are not in the form view, starting with step.
    3. On the Warning message that appears, click Switch View.

    4. Copy the configuration elements and attributes into the Properties text box, and then click OK.

      Note

      If the default value for an optional element is acceptable, omit the element. Do not include empty elements.

    5. 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

UI Label

Element

Description

Required

Access Key

<access-key>

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.

Conditional;

  • You must specify the Access Key and the Secret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Access Key is specified, the adapter ignores the value.

Secret Key

<secret-key>

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.

Conditional;

  • You must specify the Access Key and the Secret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Secret Access Key is specified, the adapter ignores the value.

Region

<region>

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.

Valid values:

  • us-east-1
  • us-west-2 (default)
  • us-west-1
  • eu-west-1
  • ap-southeast-1
  • ap-northeast-1
  • ap-southeast-2
  • sa-east-1
     

No

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>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*