Configuring the Amazon S3 adapter

You configure an adapter in Grid Manager. The configuration specifies how the adapter interacts with Amazon S3. While each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.

The form view in Grid Manager provides an easy-to-use interface for configuring adapters. The form view prevents human errors that might occur as a result of copying the configuration XML from the XML sample into the UI when you configure an adapter. You can switch to the XML view to configure those elements and attributes that are not available as form fields or to configure all the elements and attributes using XML only. However, after you switch to the XML view and save the configuration in the XML from that view, you cannot thereafter use the form view for modifying that configuration.

The default name for the actor adapter is AmazonS3ActorAdapter.

To configure the actor adapter

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

  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 adapter-bmc-amazon s3-actor check box to configure the 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 skip to step 7 to configure the adapter using the XML view:
    1. Enter a name for the adapter.

      The Name field does not support single-quote (') and ampersand (&) characters.

    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 description for the adapter.
    2. Click Switch to XML View.
    3. On the Warning message that appears, click Switch View.
    4. Copy the configuration elements and attributes from the XML sample into the Properties text box, and then click OK.
    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 node elements required for configuring the actor adapter:

UI label

Element

Description

Required?

WSDL Location

<wsdl-location>

Specifies the target WSDL URL for Amazon S3

Example: http://s3.amazonaws.com/doc/2006-03-01/AmazonS3.wsdl

Conditional; required if not specified in the request

Endpoint Address

<endpoint-address>

Specifies the web service endpoint to use for performing operations on
Amazon S3 buckets across different regions

Default: https://s3.amazonaws.com/soap: Endpoint in the US Standard region

Values for regions:

No

AWS Access Key ID

<aws-access-key-id>

Specifies the 20-character public Access Key ID that is included in an Amazon Web Service (AWS) service request to identify the user

AWS uses the Access Key ID to look up an account's Secret Access Key. Amazon.com then calculates a digital signature with the key. If they match, the user is considered authentic; otherwise, the authentication fails and the request is not processed.

Conditional; required if not specified in the request

Secret Access Key

<secret-access-key>

Specifies the 40-character private identifier that is associated with the Access Key ID

If you do not use the SOAP protocol with Web Service Security, a digital signature is calculated, using the Secret Access Key that you include in the request.

Conditional; required if not specified in the request

Adapter configuration properties

This section describes some common configuration properties that you can add to the 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.

Note

You must be using BMC Atrium Orchestrator Platform version 7.8 or later to use this encryption attribute.

For example, to encrypt the secret-access-key format used by the Amazon S3 adapter, the XML would look similar to the following:

<secret-access-key secure="true">AKIA****************</secret-access-key>

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.

Note

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:

    Logging level

    Description

    DEBUG

    The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    INFO

    (default)

    Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    WARN

    Logs recoverable erroneous conditions and unrecoverable erroneous conditions

    ERROR

    The least detailed logging level; logs only error conditions that are not usually recoverable

The following figure shows an XML sample for configuring the actor adapter without any configuration elements:

<config/>

The following figure shows an XML sample for configuring the actor adapter:

<config>
  <wsdl-location>http://s3.amazonaws.com/doc/2006-03-01/AmazonS3.wsdl
</wsdl-location>
  <endpoint-address>https://s3.amazonaws.com/soap</endpoint-address>
  <aws-access-key-id>SAMPLE_KEY</aws-access-key-id>
  <secret-access-key>SAMPLE_SECRET_KEY</secret-access-key>
</config>
Was this page helpful? Yes No Submitting... Thank you

Comments