32 Oracle Secure Backup Cloud Module for Amazon S3
The Oracle Secure Backup (OSB) Cloud Module enables you to take advantage of internet-based data storage services offered by Amazon Simple Storage Service (S3) for RMAN backup and recovery tasks.
32.1 About Backup on the Cloud Using Oracle Secure Backup Cloud Module
The Oracle Secure Backup Cloud Module is part of the Oracle Secure Backup product family and provides the flexibility to back up your Oracle Database to the Amazon S3 Cloud and to tape. With this cloud offering, local disk backups are sent directly to Amazon S3 for offsite storage and are fully integrated with Recovery Manager (RMAN) features.
The Oracle Secure Backup Cloud Module efficiently handles the backing up of Oracle Databases to S3 storage. In addition, Oracle Secure Backup Cloud Module backups work with tools like Oracle Enterprise Manager and your customized RMAN scripts. The Oracle Secure Backup Cloud Module does not back up operating system files.
The Oracle Secure Backup Cloud Module uses the RMAN SBT (System Backup to Tape) interface to extend the Amazon S3 functionality for Oracle backup operations. The Oracle Secure Backup Cloud Module offers an easy-to-manage, cost efficient, and scalable alternative to maintaining in-house data storage and managing a local, fully configured backup infrastructure.
The Oracle Secure Backup Cloud Module has several advantages over traditional tape-based offsite backups:
-
Continuous Accessibility
Oracle Secure Backup Cloud Module backups stored on Amazon S3 storage are always accessible. The cloud storage services availability and access model helps an organization to streamline recovery operations. For example, there is no need to ship or load tapes before a restore can be performed. You can still use familiar and standard tools like Enterprise Manager and your organization's current scripts continue to execute backup and restore tasks. With the ability to continually and easily access backups, the time spent restoring backups may be substantially reduced.
-
Improved Reliability
Because S3 storage is disk based, it is inherently more reliable than tape media. Internet storage service providers keep multiple, redundant copies of your data for availability and scalability purposes and the benefit of this practice to your organization and your data is increased reliability.
Note:
For Frequently Asked Questions (FAQs) about the Oracle Secure Backup Cloud Module, see My Oracle Support Note 740226.1.32.2 Sign-up for an Amazon S3 - AWS Account
Before you can use the Oracle Secure Backup Cloud Backup Module and access Amazon S3, you must create an AWS account. The account requires that you provide a means of payment for Amazon to charge for your AWS S3 usage.
32.3 Installing the Oracle Secure Backup Cloud Module
Before you backup to Amazon S3 Cloud, you need to install the Oracle Secure
Backup (OSB) Cloud Module on the target database server. The backup module installer file
osbws_installer.zip
is available in the Oracle home directory after
you install the Oracle Database.
Table 32-1 File Name and Location of the OSB Cloud Module Installer
OSB Cloud Module Installer File Name | Location on UNIX and Linux Systems | Location on Windows Systems |
---|---|---|
|
|
|
32.3.1 Prerequisites for Oracle Secure Backup Cloud Module
You can backup Oracle Database 9i Release 2 and higher to Amazon S3 Cloud.
The following table lists the supported database versions, operating systems, and prerequisites for using the Oracle Secure Backup Cloud Module.
Table 32-2 Software Prerequisites for the Oracle Secure Backup Cloud Module
Hardware/Software | Version |
---|---|
Java SE Development Kit (JDK) |
Default JDK version supported by the target Oracle Database release. |
Oracle Database |
You can backup databases starting with Oracle Database 9 Note: Operating system files cannot be backed up with RMAN or the RMAN SBT interface. |
S3 Backup Installer File |
The installer creates the configuration file and the Oracle wallet to store the AWS credentials. After you install Oracle Database 23ai, you
can access the OSB Cloud Module installer file
However, if you are using Oracle provided Amazon Machine Images (AMIs) to run the
Oracle Database on Amazon's Elastic Compute Cloud (EC2), then the
installer can be found in the Oracle recommends that users include any of the command-line options in a file and secure the file with appropriate operating system permissions. The S3 Backup Installer can then read the file, invoke the options, and prohibit unauthorized users from reading the file. |
Oracle Wallet Directory |
The Oracle Wallet Directory stores your AWS identifiers and must exist before you can run the S3 Backup installer. If you have not set up a wallet directory then you must create one. Here are the suggested platform-specific locations for the wallet directory:
|
System Time |
The authentication method used by Amazon S3 relies on the client system time being similar to the Amazon S3 time. In this case, the client is the computer where you run the OSB Cloud Module. S3 time is Coordinated Universal Time (UTC), so you must ensure that the system time on your client is within a few minutes of UTC. |
32.3.2 Parameters for Installing the Oracle Secure Backup Cloud Module
Review the mandatory parameters and compile their values before installing the Oracle Secure Backup Cloud Module.
After you install the Oracle Database, the OSB Cloud Module installer zip
file osbws_installer.zip
is available in the Oracle home
directory (see Table 32-1).
Extract the osbws_installer.zip
file to a subdirectory of your
choice and preview the installation parameters.
Example 32-1 Extracting the OSB Cloud Module Installer Files and Previewing the Installation Parameters (on UNIX and Linux Systems)
In this example, you extract the contents of the
osbws_installer.zip
file to a subdirectory of your
choice.
$ mkdir -p $ORACLE_HOME/lib/osbws_1
$ cd $ORACLE_HOME/lib/osbws_1
unzip -q $ORACLE_HOME/lib/osbws_installer.zip
To preview the installation parameters, run this command from the subdirectory that contains the extracted installer files.
% java -jar osbws_install.jar
Table 32-3 Parameters Used when Installing the OSB Cloud Module Library
Parameter Name | Description | Mandatory? |
---|---|---|
AWSID |
Access Key ID for the Amazon Web Services account that is used to store RMAN backups. |
Yes, if you use AWS identifiers to authenticate with Amazon S3. |
AWSKey |
Secret access key for the Amazon Web Services account
specified in Note: To authenticate with Amazon S3, you must provide one of the following values:
|
Yes, if you use AWS identifiers to authenticate with Amazon S3. |
IAMRole |
AWS IAM (Identity and Access Management) role name that contains the temporary credentials that RMAN will use for backup and recovery operations. This role must be assigned the appropriate privilege to access your S3 account. Note: To authenticate with Amazon S3, you must provide one of the following:
The OSB Cloud Module uses the Instance Metadata Service
(IMDS) to access the instance metadata from an Amazon EC2 instance.
IMDS is available in two versions: See IAM roles for Amazon EC2 for more information. |
Yes, if you use IAM roles to authenticate with Amazon S3. |
IAMRoleMetaURI |
Metadata URI where temporary credentials for the specified IAM role are stored. For Amazon EC2 users, specifying the metadata URI is optional. If this parameter is omitted, the temporary credentials are retrieved from the instance metadata. |
No |
awsEndpoint |
Host name to which backups must be sent. If this parameter is omitted, backups will be stored on the default host. |
No |
awsPort |
Non-default HTTP/HTTPS connection port number. The default port number for HTTP is 80 and HTTPS is 443. |
No |
location |
Amazon S3 location where the RMAN backups must be
stored. If specified, the value must match the location of the value
of Refer to the Amazon S3 documentation for a list of valid locations.. |
No |
walletDir |
Location that stores the Oracle wallet that contains S3 credentials and proxy information. The Oracle wallet directory must exist before running the S3 Backup installer. Consult Prerequisites for Oracle Secure Backup Cloud Module for more information. |
Yes |
configFile |
Name, with the complete path, of the configuration file that will be created by the installer. The parameters that are used while running RMAN jobs are obtained from this configuration file. If this parameter is omitted, the installer creates the configuration file and places it in a default system-dependent location. Default Linux location:
Default Windows location:
|
No |
proxyHost |
Name of the HTTP proxy server, if required. |
No |
proxyPort |
Port number of the HTTP proxy server. |
No |
proxyID |
User name for the HTTP proxy server. |
No |
proxyPass |
Password for the HTTP proxy server user |
No |
trustedCerts |
List of SSL certificate to be imported into the Oracle wallet. |
No |
argFile |
Name of the file from which arguments must be read during installation. To read arguments from the standard input, specify “-”. |
No |
useHttps |
Sets up an HTTPS connection. If omitted, HTTP connection is used. |
No |
useSigV2 |
Sets up an authentication scheme. If this parameter is specified, Signature Version 2 authentication is set up; else Signature Version 4 is set up. The recommended scheme is Signature Version 4. |
No |
32.3.3 Running the OSB Cloud Module Installer
Oracle recommends that you run the Oracle Secure Backup installer in a secure mode, and avoid running the installer directly from the command line.
32.4 Configuration Parameters for the Oracle Secure Backup Cloud Module
Use configuration parameters to specify the settings that are used when performing backups with the Oracle Secure Backup Cloud Module.
Configuration parameters can be set in one of the following locations:
-
Configuration file for the Oracle Secure Backup Cloud Module
The name of the configuration file is specified in the
OSB_WS_PFILE
parameter -
ENV
variable when configuring SBT channelsNote:
On Windows, Oracle recommends that you use theSBT_PARMS
parameter to specify the environment variables, instead of theENV
parameter.
The following table describes the configuration parameters that can be set when using the Oracle Secure Backup Cloud Module.
Parameter Name | Mandatory? | Description |
---|---|---|
OSB_WS_PFILE |
No |
Indicates the configuration file for the SBT library. The default location for the configuration file is: Linux:
Windows:
|
OSB_WS_HOST |
Yes |
Specifies the name of the host to which the backups are sent. |
OSB_WS_PROXY |
No |
Specifies the proxy server and port when the target database is behind a firewall. It is specified in the <host>:<port> format. |
OSB_WS_BUCKET |
No |
Specifies the bucket in which the SBT library stores backups. If this parameter is not specified, then the SBT library first attempts to find an existing bucket whose location matches the specified location from buckets whose names are prefixed with |
OSB_WS_LOCATION |
No |
Specifies the Amazon S3 location where the backups must be stored. This value must match the location of the specified Refer to the Amazon S3 documentation for a list of valid pairs of endpoints and locations. |
OSB_WS_CHUNK_SIZE |
No |
Specifies the object size, in bytes, that will used when storing backups to Amazon S3. The default size is 100MB. |
OSB_WS_WALLET |
Yes |
Defines the wallet location, alias, and proxy authentication alias through which the SBT library reads credentials. The format of this parameter is:
|
OSB_WS_VIRTUAL_HOST |
No |
Specifies the format of the host. The default value is TRUE. When set to TRUE, the format is http[s]://<bucket>.<host>. When set to FALSE, the format is http[s]://<host>/<bucket>. Use FALSE when the storage provider is not Amazon S3, but is compatible with S3. |
OSB_WS_IAM_ROLE |
Yes, when using the metadata service. |
Specifies the name of the IAM role that can be used to back up to Amazon S3. The Amazon Elastic Cloud Compute (EC2) instance must be configured with the specified IAM role. The OSB Cloud Module uses the Instance Metadata Service (IMDS) to access the instance metadata from an Amazon EC2 instance. IMDS is available in two versions: By default, the OSB Cloud Module uses See IAM roles for Amazon EC2 for more information. |
OSB_WS_IAM_ROLE_META_URI |
No |
Specifies the name of the metadata URI where temporary credentials for the IAM role are stored. |
32.5 Configuring SBT Channel for Amazon S3
Configure an RMAN automatic SBT (tape) channel and specify the path to the SBT library that corresponds to Amazon Web Services. You can optionally configure the SBT channel as the default channel so that RMAN can directly make all backups to Amazon S3 storage.
32.6 Backup and Recover with Amazon S3 Cloud
Connect RMAN to your target database and perform backup and restores with Amazon S3 Cloud.
32.7 Troubleshooting the OSB Cloud Module
This section lists potential issues that may affect the installation or the operation of the Oracle Secure Backup Cloud Module.
Symptoms | Error Messages | Resolution |
---|---|---|
The S3 Backup installation cannot create the license file on Amazon S3. |
|
The first time you run the S3 Backup installer for a set of AWS identifiers, the installer creates a license file on Amazon S3. If there are problems preventing its creation the time-out error message is displayed in the installation output. Contact Oracle support to resolve the issue. |