Configuring an Amazon S3 external storage manager

Content Manager OnDemand supports data storage in an Amazon Simple Storage Service (S3) repository. More information on Amazon S3 can be found at: https://aws.amazon.com/s3/

Updating the ARS.CFG file on AIX, Linux, or Linux on System z servers

Perform these steps to configure Amazon S3 on an AIX, Linux, or Linux on System z server.

  1. Two new entries must be added to the ARS.CFG file.

    For AIX servers:
    ARS_S3_CONFIG_FILE=/opt/IBM/ondemand/V10.1/config/ars.s3
    ARS_S3_CONFIG_DIR=/opt/IBM/ondemand/V10.1/config
    
    For Linux and Linux on System z servers:
    ARS_S3_CONFIG_FILE=/opt/ibm/ondemand/V10.1/config/ars.s3
    ARS_S3_CONFIG_DIR=/opt/ibm/ondemand/V10.1/config
    

    The ARS_S3_CONFIG_FILE entry specifies an existing Amazon S3 configuration file which the server uses by default.

    The ARS_S3_CONFIG_DIR entry specifies the directory in which any alternate configuration files are kept. This directory is used if additional Amazon S3 configuration files are defined. The names of these additional configuration files can be specified when defining storage nodes in Content Manager OnDemand. If no configuration file is specified in the storage node, the default configuration file is used.

    The configuration file name and directory path shown in the examples are the recommended values for these entries.

  2. The ARS_STORAGE_MANAGER entry in the ARS.CFG file might also need to be changed. If you specify ARS_STORAGE_MANAGER=CACHE_ONLY, this disables all storage managers supported by Content Manager OnDemand.

    To configure the Content Manager OnDemand server to use Amazon S3 as a storage manager, the value must be set to one of the following:
    ARS_STORAGE_MANAGER=TSM
    This setting will enable all external storage managers supported by Content Manager OnDemand. The Content Manager OnDemand server requires additional software to utilize TivoliĀ® Storage Manager (TSM) as a storage manager. If that additional software is not installed, the server will not start when the ARS_STORAGE_MANAGER value is set to TSM.
    ARS_STORAGE_MANAGER=NO_TSM
    This setting will enable all external storage managers supported by Content Manager OnDemand except Tivoli Storage Manager. This setting is used when the additional software to support Tivoli Storage Manager is not installed and Tivoli Storage Manager is not required as an external storage manager.

Updating an instance configuration on Windows servers

Perform these steps to configure Amazon S3 on a Windows server. Both steps use the OnDemand Configurator to create or update the configuration information.
  1. Select Amazon S3 as an external storage manager.
  2. Set the configuration entries:
    Configuration Directory
    The Configuration Directory specifies the directory in which any alternate configuration files are kept. This directory is used if additional Amazon S3 configuration files are defined. The names of these additional configuration files can be specified when defining storage nodes in Content Manager OnDemand. If no configuration file is specified in the storage node, the default configuration file is used. For example: C:\Program Files\IBM\OnDemand\V10.1\config
    Default Configuration File
    The Default Configuration File specifies an existing Amazon S3 configuration file which the server uses by default. For example: C:\Program Files\IBM\OnDemand\V10.1\config\ars.s3 A sample configuration file is included as part of the installation of Content Manager OnDemand.

Creating an Amazon S3 configuration file

An Amazon S3 configuration file for Content Manager OnDemand contains entries specific to your Amazon S3 implementation. You specify the location and name of the default configuration file in the ARS.CFG entry or via the OnDemand Configurator. Required entries must be specified. Optional entries are not required in the configuration file unless those values need to be changed.

The following list describes the entries that can be specified in an Amazon S3 configuration file.

ARS_S3_SERVER
Specifies the Amazon S3 server name. Do not include http:// or https:// in the name. This entry is required.
ARS_S3_REGION
Specifies the Amazon S3 region. This entry is required.
ARS_S3_USE_SSL
Indicates whether or not to use SSL in server communications. The possible values are:
  • 0 - SSL will not be used
  • 1 - SSL will be used
The default value is 1. This entry is optional.
ARS_S3_CONNECT_TIMEOUT
Specifies the maximum number of seconds that Content Manager OnDemand waits for a response from the storage manager. The default is 60. This entry is optional. Warning: Setting this value too low might cause connection failures.
ARS_S3_HLD
Specifies the high-level directory name. This attribute is available to group sets of Content Manager OnDemand data together which might be needed if sharing external storage among multiple Content Manager OnDemand servers. Warning: Once this value is set, it must not be changed. If it is changed, any data that is already stored will not be retrievable. There is no default value. This entry is optional.
As an example, for a URL such as https://s3-us-west-2.amazonaws.com/, the Amazon S3 configuration file contains:
ARS_S3_SERVER=s3.amazonaws.com
ARS_S3_REGION=us-west-2

Defining an Amazon S3 storage node with the Administrator client

You can define the settings for using the Amazon S3 access method on the Add a Primary Node dialog of the OnDemand Administrator client.

The Storage Node field becomes Bucket Name when the Access Method is set to Amazon S3. The bucket name must exist in your repository or access to Amazon S3 will fail.

The Logon and Password fields contain the Amazon S3 access key and password that Content Manager OnDemand needs to access your Amazon S3 repository.

The Access Method radio button is set to Amazon S3. For Content Manager OnDemand servers running on all platforms except Windows, the Configuration File Name defaults to the value specified by the ARS_S3_CONFIG_FILE parameter in the ARS.CFG file if no value is entered. Otherwise, Content Manager OnDemand looks for the configuration file in the directory defined by the ARS_S3_CONFIG_DIR parameter specified in the ARS.CFG file. For Content Manager OnDemand servers running on Windows, the server uses the Configuration File Name field and the Configuration Directory field that are specified in the OnDemand Configurator instead of using the ARS.CFG file parameters.