This chapter covers the following topics:
You can use automated tools to create a backup of an on-premises source Oracle E-Business Suite environment on Oracle Cloud Infrastructure Object Storage, and to provision an environment on Oracle Cloud Infrastructure from that backup. We call this procedure a "traditional lift and shift".
This chapter describes how to begin this "traditional lift and shift" by using the Oracle E-Business Suite Cloud Backup Module to create the backup of your source environment on Oracle Cloud Infrastructure Object Storage. After you have created the backup of the source environment, you subsequently complete the lift and shift by using Oracle E-Business Suite Cloud Manager Advanced Provisioning to provision an environment on Oracle Cloud Infrastructure from the backup. See Advanced Provisioning.
Note: Although this process is intended primarily for on-premises source environments, you can also run the Oracle E-Business Suite Cloud Backup Module as part of a lift and shift in certain cases when the source environment is already in Oracle Cloud Infrastructure with optional database services. These cases include the following:
You initially used a manual procedure, such as a platform migration, to migrate an environment to Oracle Cloud Infrastructure, and now would like to leverage Oracle E-Business Suite Cloud Manager to manage that environment going forward.
You want to migrate your environment from one tenancy to another. The lift and shift procedure can be used for this purpose whether or not you are currently using Oracle E-Business Suite Cloud Manager.
Use the backup feature within Oracle E-Business Suite Cloud Manager to back up environments on Oracle Cloud Infrastructure that you previously provisioned through Oracle E-Business Suite Cloud Manager. See Create a Backup of a Cloud-Based Oracle E-Business Suite Environment.
As an alternative to a traditional lift and shift, consider performing a "reduced downtime lift and shift" for your on-premises environment by creating a standby environment in Oracle Cloud Infrastructure and then promoting that standby environment. For more information and prerequisites, see Create a Standby Environment for Oracle Cloud Infrastructure from an On-Premises Environment.
Perform the following tasks to create a backup of an on-premises Oracle E-Business Suite environment on Oracle Cloud Infrastructure using the Oracle E-Business Suite Cloud Backup Module:
Create an advanced configuration parameters file (optional).
Create a backup with the Oracle E-Business Suite Cloud Backup Module.
Related Topics
Backing Up a Database to Object Storage Using RMAN
Oracle Database Backup and Recovery User's Guide 19c
Oracle Database Backup and Recovery User's Guide 12c Release 1 (12.1)
Oracle Database Backup and Recovery User's Guide 11g Release 2 (11.2)
You must have the following prerequisites to create a backup with the Oracle E-Business Suite Cloud Backup Module as part of a traditional lift and shift procedure:
An Oracle E-Business Suite Cloud Manager instance set up as described in Deploy Oracle E-Business Suite Cloud Manager on Oracle Cloud Infrastructure .
A source Oracle E-Business Suite environment that meets all prerequisites for the lift and shift automation including certified Oracle E-Business Suite and Oracle Database release versions as well as required patches based on the target database location. See Source Environment Requirements.
A Linux server on which to run the Oracle E-Business Suite Cloud Backup Module. This server, which will be referred to in this section as the backup module server, can be located either on-premises or in OCI Compute. It can be a separate server that resides on your intranet, or can be one of the Oracle E-Business Suite nodes. Check with your network administrator and system administrator to see what is the most appropriate option for your organization. The backup module server must have at least 500 MB of free space, must have the wget libraries installed, and must have Perl 5.14 or later with the JSON module, either as the default Perl installation or through the Perl binary provided in the Oracle E-Business Suite Cloud Backup Module patch.
Cloud resources that match or exceed the minimum recommendations specified in Cloud Services Minimum Resource Recommendations.
An Oracle Cloud user who is a member of the Oracle E-Business Suite administrators group that you defined according to Create and Map Groups in Oracle Cloud Infrastructure Identity and Access Management and Oracle Identity Cloud Service or Create the Oracle E-Business Suite Administrators Group and Assign Policies.
The user OCID for that user and your tenancy OCID. See Where to Get the Tenancy's OCID and User's OCID. Copy and paste the user OCID and tenancy OCID to a file that you can reference when instructed to enter them later in these steps.
An RSA key pair in PEM format, which must not be a passphrase protected key, uploaded to your user settings in the Oracle Cloud Infrastructure Console. You will also need the fingerprint for the key. Ensure that you generate the key for your local Oracle Cloud Infrastructure user created in Oracle Cloud Infrastructure Identity and Access Management (IAM), not for an Oracle Identity Cloud Service user. See:
"To Upload an API Signing Key" in Using the Console
Copy and paste the PEM file location and the fingerprint to a file that you can reference when instructed to enter them later in these steps.
The source environment for a backup must be at a certified Oracle E-Business Suite release version as well as a certified Oracle Database release version, and must have the appropriate required patches applied. For a list of the certified Oracle E-Business Suite releases, certified Oracle Database releases, and required patches, refer to My Oracle Support Knowledge Document 2517025.1, Getting Started with Oracle E-Business Suite on Oracle Cloud Infrastructure, Section 4.2: Capabilities of Oracle E-Business Suite Cloud Automation Tools. These requirements vary depending on the target database tier location.
Additionally, the following are mandatory requirements for the on-premises systems which host your Oracle E-Business Suite source environment. These requirements must be met before you can create a backup of the source environment onto object storage as part of the lift and shift:
You must have an NTP service configured on the on-premises application and database servers from which the backup will be taken. For Oracle Linux Release 7, see: Configuring the ntpd Service in Oracle Linux 7: Setting Up Networking. For Oracle Linux Release 6, see Configuring the ntpd Service in the Oracle Linux Administrator's Guide for Release 6.
You must have the wget
library installed on the on-premises server where you plan to run the Oracle E-Business Suite Cloud Backup Module.
The source database must be in ARCHIVELOG mode in order to perform a hot backup.
If Transparent Data Encryption (TDE) is enabled for the source environment, then you should verify that all the pluggable databases (PDBs) pdbs are in an open state with an appropriate wallet type (autologin or password).
If Transparent Data Encryption (TDE) is enabled for the source environment, then the TDE wallet must be located on your regular file system. The Oracle E-Business Suite Cloud Backup Module and Oracle E-Business Suite Cloud Manager do not support wallets located on an Oracle Automatic Storage Management (ASM) disk.
If you plan to enable TLS for the target environment automatically - that is, if you plan to select the HTTPS protocol for the target environment's web entry point during provisioning - then you must apply the required updates and patches for TLS to the source environment before you create the backup.
For Oracle E-Business Suite Release 12.2, see My Oracle Support Knowledge Document 1367293.1, Enabling TLS in Oracle E-Business Suite Release 12.2, Section 5.1: Apply Required Updates and Patches.
For Oracle E-Business Suite Release 12.1, see My Oracle Support Knowledge Document 376700.1, Enabling TLS in Oracle E-Business Suite Release 12.1, Section 5.1: Apply Required Updates and Patches.
For creating a backup with the target database tier on Oracle Cloud Infrastructure Compute VM, note that Compute supports only single-node databases. It does not support Oracle RAC databases.
For creating a backup with a target database tier on a Base Database Service 1-Node or 2-Node DB System, you can choose from the following database edition options:
Base Database Service 1-Node DB System (Single Instance):
Enterprise Edition
Enterprise Edition High Performance
Enterprise Edition Extreme Performance
Base Database Service 2-Node DB System (Oracle RAC)
Enterprise Edition Extreme Performance
For creating a backup with the target database tier on Exadata Database Service Dedicated: Exadata Database Service Dedicated provides Oracle RAC support.
The automated tools support lift and shift for a Linux source system to an Oracle Linux target system. If your environment is not currently running on Linux, see the question "Can I migrate my Oracle E-Business Suite instances on any operating system to Oracle Cloud?" in My Oracle Support Knowledge Document 2517025.1, Getting Started with Oracle E-Business Suite on Oracle Cloud Infrastructure. Also refer to Create a Backup of an On-Premises Oracle E-Business Suite Environment on Oracle Cloud Infrastructure.
The Oracle E-Business Suite Cloud Backup Module creates a backup of your primary application tier.
Refer to About Oracle Base Database Service to determine the maximum database size supported by this procedure.
For adequately low latency between the application and database tiers, your Oracle Cloud Infrastructure Compute and Oracle Database Cloud Service should be co-located in the same availability domain.
You must provision the same database options in Base Database Service or Exadata Database Service Dedicated as on your source database, and the versions of the database options must be at the same level. Also, you should not provision any additional database options on the target database tier. The Oracle E-Business Suite Cloud Backup Module validates whether the database options in the source environment and in the target database tier meet these requirements, and reports any mismatches.
Cloning or deleting multiple databases on the same Exadata Database Service Dedicated resource simultaneously is currently not recommended.
You can download the E-Business Suite Technology Codelevel Checker tool, or ETCC, for Release 12.2 from My Oracle Support as Patch 17537119. Unzip this patch in the database Oracle home under $ORACLE_HOME/appsutil/etcc
. You must run ETCC before running the Oracle E-Business Suite Cloud Backup Module to determine whether there are any important database fixes required by Oracle E-Business Suite to function properly.
When you provision an environment on Oracle Cloud Infrastructure from a backup of a source environment, the storage type used depends on the database version, as follows:
Oracle Database Release 12.1.0.2 and Oracle Database Release 19c use Automatic Storage Management (ASM).
Oracle Database Release 11.2.0.4 uses ASM Cluster File System (ACFS).
To provision an environment from backup, we recommend that you have cloud service resources that match or exceed those specified in the following table.
For information regarding Virtual Private Network (VPN) options, see the Oracle Cloud Infrastructure Networking website at https://www.oracle.com/cloud/networking/
Description | Machine Type | Number of Nodes | OCPUs Allocated | Memory | Storage | External IPs |
---|---|---|---|---|---|---|
Oracle Cloud Infrastructure Backup Service | Not applicable | Not applicable | Not applicable | Not applicable | Size of application tier backup + database backup (object) | Not applicable |
Oracle E-Business Suite Cloud Manager | VM | 1 | 1 | 7 GB | Required: 55 GB (block) | 1 |
A load balancer (You can use your own load balancer or Load Balancer as a Service [LBaaS]) | Not applicable | Not applicable | Not applicable | Not applicable | Not applicable | 1 |
Application tier | VM | n (where 'n' is the number of application tier nodes in the target environment) | n*m (where 'm' is the number of OCPUs in the shape selected for the application tier; the minimum for 'm' is 1) | Release 12.2 = 14 GB per VM Release 12.1 = 7 GB per VM |
Strictly dependent on your on-premises environment. The minimum requirements are as follows: Shared application tier: 170 GB + 40 GB for each additional application tier (block) Non-shared application tier: 170 GB x n (block) Per language: 16 GB (block) |
n |
Database tier on Oracle Cloud Infrastructure Compute | VM | 1 | 2 | 14 GB | Vision demo: 300 GB | 1 |
Database tier on Base Database Service 1-Node DB System (Single Instance) | VM | 1 | 1 | 15 GB | Vision demo: 256 GB Total storage: 712 GB [1] |
1 |
Database tier on Base Database Service 2-Node DB System (Oracle RAC) | VM | 2 | 2 per VM | 30 GB per VM | Vision demo: 256 GB Total storage: 912 GB [1] |
2 |
Database tier on Exadata Database Service Dedicated (Oracle RAC) [2] | See footnote [2] | See footnote [2] | See footnote [2] | See footnote [2] | See footnote [2] | See footnote [2] |
Footnotes for Table 5-4:
The Available Storage Size and Total Storage Size are different. For more information, see About Oracle Base Database Service.
For a database tier on Exadata Database Service Dedicated, the minimum requirement is an Exadata X9M, X8M, X7 or X6 base model with a 2-node Oracle RAC.
Copy the API signing key files to both the application tier primary node and the database tier for the source Oracle E-Business Suite environment. If you plan to run the Oracle E-Business Suite Cloud Backup Module on a separate server, copy the key files to that server as well. The key files must be placed in a directory with the same name and path on each server, in a location where they can be referenced by the Oracle E-Business Suite Cloud Backup Module. For example: /u01/install/APPS/.oci/
Create a stage area directory on the source application tier. This directory will hold temporary files used during the application tier backup process as well as the application tier backup file in zip or tar format that is created locally before it is uploaded to Oracle Cloud Infrastructure Object Storage. Ensure that the application tier has free space equal to 30% of the size of the application tier file system or greater. More space may be required in the following cases:
The database tier and the application tier are on the same host.
You specify a large number of threads for the upload in the Backup Thread Count parameter of the Oracle E-Business Suite Cloud Backup Module.
You set the Backup Archive Type parameter of the Oracle E-Business Suite Cloud Backup Module to tar
, which does not compress the backup files, instead of tgz
.
The method you use to calculate the size of the application tier file system varies according to your release.
For Oracle E-Business Suite Release 12.2, obtain the size of the run file system as shown in this example.
$ cd /u02/ebs122 $ . EBSapps.env run $ cd $RUN_BASE $ du -sh 40G .
In this example, the size of the run file system on the application tier is 40 GB. Therefore, the minimum space required for the stage area on the application tier is 30% of 40 GB, or 12 GB.
For Oracle E-Business Suite Release 12.1.3, the size of the application tier file system is the sum of the size of the following directories: $APPL_TOP
, $COMMON_TOP
, $ORACLE_HOME
, and $IAS_ORACLE_HOME
. As an example, if that sum total is 30 GB, then the minimum space required for the stage area on the application tier is 30% of 30 GB, or 9 GB.
If you have not allocated enough free space, then the Oracle E-Business Suite Cloud Backup Module will exit with a message indicating how much is required.
Create a stage area directory on the source database tier. This directory will hold the backup utilities and the temporary files used to process the backup. Ensure that it has at least 20 GB of free space.
Verify the following to ensure that the Oracle E-Business Suite Cloud Backup Module can connect to all required nodes:
All nodes must have SSH enabled.
SSH equivalence must be set up between the backup module server and the primary application tier node, and between the backup module server and the database tier node, if you plan to run the Oracle E-Business Suite Cloud Backup Module on a separate server.
On the application tier server and the database tier server, the SSH configuration files (~/.ssh/config
) must have the entry "ServerAliveInterval 100". Additionally, if you plan to run the Oracle E-Business Suite Cloud Backup Module on a separate server, then the same entry must be set in the SSH configuration file for that server.
The Oracle Cloud Infrastructure Backup Service must be reachable either directly from the source database server and primary application tier server or through a proxy server.
If you have not already done so, deploy Oracle E-Business Suite Cloud Manager as described in Deploy Oracle E-Business Suite Cloud Manager on Oracle Cloud Infrastructure .
This section describes how to install the Oracle E-Business Suite Cloud Backup Module on the Linux server that you have chosen to use as the backup module server, which can be located either on-premises or in OCI Compute. It can be one of the Oracle E-Business Suite nodes or another server that resides in your intranet. The backup module server must have at least 500 MB of free space and must have the wget libraries installed.
The Oracle E-Business Suite Cloud Backup Module requires Perl version 5.14 or later with the JSON module installed. You must either ensure that the default Perl installation on the backup module server meets these requirements, or run the Oracle E-Business Suite Cloud Backup Module using the Perl binary provided in the patch.
Download Patch 36331515 from My Oracle Support to the backup module server.
Using the following commands, change to the directory where you downloaded the patch file and extract the downloaded patch.
$ cd <download_folder> $ unzip p36331515_R12_GENERIC.zip
Unzipping the patch zip file creates a directory named 36331515/RemoteClone
.
Change to the RemoteClone
directory and change the permission to "execute" for all the downloaded scripts.
$ cd 36331515/RemoteClone $ chmod +x *.pl $ chmod +x lib/*.sh
Before running the Oracle E-Business Suite Cloud Backup Module, you can optionally create a file to specify advanced configuration parameters to address special situations. If you do not need to specify these parameters, you can skip this section.
If you create an advanced configuration parameter file, then ensure that you specify the location of the file when you run the Oracle E-Business Suite Cloud Backup Module, as described in the next section.
Make a copy of the advanced-config-param.template
file in the RemoteClone/EBS-METADATA/template
directory. Place the new file in a directory location where it can be accessed by the Oracle E-Business Suite Cloud Backup Module.
Open your new advanced configuration parameter file in a text editor and specify values for the parameters you want to use, as described in the following steps.
In the RMAN_CHANNEL_COUNT parameter, specify the number of Recovery Manager (RMAN) staging channels to allocate for creating the backup. The default value used by RMAN is 75% of the number of CPUs. The minimum value is one channel. The maximum value is 255 channels.
In the RMAN_COMPRESSION_ALGORITHM parameter, specify the binary compression algorithm to use for RMAN backup. The values you can specify are BASIC
, LOW
, MEDIUM
, and HIGH
. The default value is BASIC
. Note that the LOW
, MEDIUM
, and HIGH
compression algorithms fall under Advanced Compression. You must have or acquire a license for the Advanced Compression option to use these compression algorithms. The Advanced Compression option is included in all Exadata Database Service Dedicated subscriptions, and in Base Database Service subscriptions with Enterprise Edition High Performance and Extreme Performance options.
In the RMAN_SECTION_SIZE parameter, specify the section size for multisection backups. The default value is 4G
. Valid values are 2G
, 4G
, 8G
, 16G
, 32G
, 64G
, 128G
, or 256G
.
As part of RMAN backup, in the copy phase database blocks will be validated implicitly, and any corruption or missing object will be reported at that time. If you want to enforce the database validation before the RMAN backup, then set the RMAN_VALIDATE_DATABASE parameter to true
. The default value is false
.
The following parameters are set automatically to default values by RMAN unless you enter specific values for them here. You should only set values for these parameters if you fully understand their effects, as inappropriate settings can reduce backup performance.
In the RMAN_FILESPERSET parameter, specify the maximum number of data files to place in each backup set. The default value is 64. To determine the number of data files in each backup set, RMAN uses either the value you specify in this parameter or the number of files read by each channel, whichever is lower. If you allocate only one channel, then you can use this parameter to make RMAN create multiple backup sets.
In the RMAN_MAXOPENFILES parameter, specify the maximum number of input files that a backup or copy can have open at a given time. The default value used by RMAN is 8.
In the RMAN_RATE parameter, specify the rate of bytes per second that RMAN can read on this channel. Use this parameter to set an upper limit for bytes to read so that RMAN does not consume excessive disk bandwidth and degrade online performance. Specify the rate as an integer followed by the abbreviation for the unit of measurement: <rate_as_integer>[K | M | G]
It is not recommended to use the RMAN_DATAFILE_ID_ALLOWED_MAXCORRUPT parameter for normal processing. However, if necessary, you can set this parameter to specify the maximum number of corruptions permitted in a data file during the backup job. Specify the parameter value as a list showing each data file ID and the maximum number of corruptions for that data file, in the following format: <DATA_FILE_ID_1>:<MAX_CORRUPTIONS_1>, <DATA_FILE_ID_2>:<MAX_CORRUPTIONS_2>, ...
Use the following parameter only if you have already run the Oracle E-Business Suite Cloud Backup Module and it has returned any Oracle WebLogic Server validation warnings. The Oracle E-Business Suite Cloud Backup Module validates the Oracle WebLogic Server domain size and the number of Oracle WebLogic Server backup configuration files and exits with a warning if the default threshold values are exceeded. You should review these warnings as described in Review Oracle WebLogic Server Validation Warnings. If you have determined that you can safely ignore these warnings, then you can specify that you want to skip the Oracle WebLogic Server validation when you rerun the Oracle E-Business Suite Cloud Backup Module by setting the SKIP_WLS_DOMAIN_VALIDATION_THRESHOLD parameter to true
. The default value is false
.
If you need to skip any files or directories during database tier upload, then specify a list of the absolute file or directory paths in the EXCLUDE_FILE_OR_DIR_FOR_UPLOAD.DB parameter, separated by commas. For example, you might want to exclude custom log locations if you are certain that the directory does not need to be included in the backup.
If you need to skip any files or directories during application tier upload, then specify a list of the absolute file or directory paths in the EXCLUDE_FILE_OR_DIR_FOR_UPLOAD.APPS parameter, separated by commas.
Save the updated advanced configuration parameter file.
In this section, you will run the Oracle E-Business Suite Cloud Backup Module, EBSCloudBackup.pl
, to create a backup of your source Oracle E-Business Suite environment on Oracle Cloud Infrastructure Backup Service.
Ensure that your environment and resources meet all the requirements and that you have performed all the required actions listed in Verify Prerequisites for Traditional Lift and Shift.. The EBSCloudBackup.pl
script validates key requirements before beginning the actual backup, including checking the available space, checking connections, verifying that archive logging is enabled, and verifying that mandatory patches have been applied. Check that these requirements are in place before you start running the script, so that the script can proceed with creating the backup after performing the validations.
Additionally, if Transparent Data Encryption (TDE) is enabled for the source environment, then you should verify that all the pluggable databases (PDBs) are in an open state with an appropriate wallet type (autologin or password).
To ensure a successful backup, avoid activities that could interfere with the backup process while EBSCloudBackup.pl
is running.
Do not apply patches. Note that this restriction applies not only to Oracle E-Business Suite patches, but to application technology stack and database patches as well. If you are running Oracle E-Business Suite Release 12.2, you must complete any active patching cycle before you begin the backup process.
Do not remove or move archive logs.
Do not shut down application tier or database tier services.
Do not perform configuration updates.
Note that if the EBSCloudBackup.pl
script fails, you can rerun the script and it will restart and continue from the point of failure. However, if you interrupt the script's processing with Ctrl-C, the restart capability may not function as expected.
Before you start running EBSCloudBackup.pl
, inform users that a backup is being taken, and request that they do not perform any destructive operation on the file system, such as removing directories, until the backup is complete.
Temporarily stop any application tier or database backup cron jobs that are scheduled.
If you have not already done so, change to the RemoteClone
directory on the backup module server.
Run the EBSCloudBackup.pl
script using the following command.
$ perl EBSCloudBackup.pl
As an alternative, if the backup module server does not already have the required Perl version with the JSON module installed, you can run the script using the Perl binary provided in the Oracle E-Business Suite Cloud Backup Module patch files, with the following command.
$ 3pt/perl/bin/perl EBSCloudBackup.pl
If you are using an Oracle E-Business Suite application tier node or database tier node as the backup module server, note that you should not source the Oracle E-Business Suite environment before running the Oracle E-Business Suite Cloud Backup Module.
On the first screen, choose option 1, Create E-Business Suite Backup and Upload to Oracle Cloud Infrastructure
.
============================================== Migrate Oracle E-Business Suite - Options ============================================== Migrate Oracle E-Business Suite - Enter Selection: 1: Create E-Business Suite Backup and Upload to Oracle Cloud Infrastructure 2: Exit Enter your choice from above list: 1
Next, indicate whether communication between the source database server and Oracle Cloud Infrastructure Object Storage takes place through a proxy and you need to specify the proxy details.
=========================================== Enter Source Database Tier - Proxy Details =========================================== [Ctrl-B: Back, Ctrl-H: Main Menu] 1: Yes 2: No Enter your choice from above list: 1
If you enter option 1, then in the following screen, specify the proxy details used to establish communication between the source database server and Oracle Cloud Infrastructure Object Storage.
========================================== Enter Source Database Tier - Proxy Details ========================================== [Ctrl-B: Back, Ctrl-H: Main Menu] Proxy Protocol : https Proxy Host : www-proxy.example.com Proxy Port : 443 Proxy User Name : Proxy User Password :
Enter the details for the database tier of the source Oracle E-Business Suite environment.
When entering the host name for the source database server, ensure that you enter the fully qualified domain name.
You must specify an operating system user name with which to connect to the source database server using SSH. You can choose to authenticate the OS user with either a password, a custom private SSH key and passphrase, or the default SSH key ($HOME/.ssh/id_rsa
) on the backup module server. The prompts for the custom private key and passphrase appear only if you do not enter an OS user password. If you do not enter either a password or a custom private key, then the script indicates that the default SSH key will be used and prompts you to confirm that you want to continue with the SSH key at the indicated location.
Enter the location of the context file on the database tier, including the complete file path.
Optionally enter the operating system time zone for the source database server. This time zone value is used to help determine the default time zone for environments provisioned from this backup if the Server Timezone profile option is not set within the source environment. For more information, see Advanced Provisioning.
Specify the operating system time zone in the named region format as follows: <time_region>/<time_zone_city>
For example: America/Los_Angeles
For instructions on checking the time zone set for the source database server, refer to the documentation for your on-premises Linux installation. For example, on Oracle Linux, use the timedatectl
command as described in Check the current configuration in the Oracle Linux documentation.
Specify whether Transparent Data Encryption (TDE) is enabled for the source database. If TDE is enabled, then you must also enter the password for the TDE wallet.
Finally, specify the location of the stage area directory you prepared to hold the temporary files that will be created on the database tier during the backup creation process.
===================================================================== Migrate Oracle E-Business Suite - Enter Source Database Tier Details ===================================================================== [Ctrl-B: Back, Ctrl-H: Main Menu] Enter Fully Qualified Hostname : demo.example.com OS User Name : oracle OS User Password [skip if not applicable] : OS User Custom Private Key [skip if not applicable] : OS User Passphrase [skip if not applicable] : Context File : /u01/install/APPS/12.1.0/appsutil/EBSDB_apps.xml OS Time Zone : America/Los_Angeles Database Transparent Data Encrypted ( TDE ): ( Yes | No ) yes Wallet Password :password You have not entered Password or Custom Private Key location We will be using default SSH key at /home/oracle/.ssh/id_rsa Do you want to continue (Yes | No) : yes Validating the details... Stage Directory : /u01/install/stage/dbStage
Next, indicate whether communication between the source application tier and Oracle Cloud Infrastructure Object Storage takes place through a proxy and you need to specify the proxy details.
=========================================== Enter Source Application Tier Proxy Details =========================================== [Ctrl-B: Back, Ctrl-H: Main Menu] 1: Yes 2: No Enter your choice from above list: 1
If you enter option 1, then in the following screen, specify the proxy details used to establish communication between the source application tier and Oracle Cloud Infrastructure Object Storage.
=========================================== Enter Source Application Tier Proxy Details =========================================== [Ctrl-B: Back, Ctrl-H: Main Menu] Proxy Protocol : https Proxy Host : www-proxy.example.com Proxy Port : 443 Proxy User Name : Proxy User Password :
Enter the details for the application tier of the source Oracle E-Business Suite environment.
When entering the host name for the source application tier server, ensure that you enter the fully qualified domain name.
You must specify an operating system user name with which to connect to the source application tier server using SSH. You can choose to authenticate the OS user with either a password, a custom private SSH key and passphrase, or the default SSH key ($HOME/.ssh/id_rsa
) on the backup module server. The prompts for the custom private key and passphrase appear only if you do not enter an OS user password. If you do not enter either a password or a custom private key, then the script indicates that the default SSH key will be used and prompts you to confirm that you want to continue with the SSH key at the indicated location.
Additionally, specify the location of the context file on the application tier, including the complete file path, the password for the Oracle E-Business Suite APPS
schema, and the location of the stage area directory you created to hold the temporary files created on the application tier during the backup creation process.
For Oracle E-Business Suite Release 12.2 only, you must also specify the Oracle WebLogic Server administrator password for the source environment.
If Oracle E-Business Suite System Schema Migration has been completed on the source environment, then enter the EBS_SYSTEM password. For more information, see My Oracle Support Knowledge Document 2755875.1, Oracle E-Business Suite Release 12.2 System Schema Migration.
======================================================================== Migrate Oracle E-Business Suite - Enter Source Application Tier Details ======================================================================== [Ctrl-B: Back, Ctrl-H: Main Menu] Enter Fully Qualified Hostname : demo.example.com OS User Name : oracle OS User Password [skip if not applicable] : OS User Custom Private Key [skip if not applicable] : OS User Passphrase [skip if not applicable] : Context File : /u01/install/APPS/fs1/inst/apps/EBSDB_apps/appl/admin/EBSDB_apps.xml APPS Password : password You have not entered Password or Custom Private Key location We will be using default SSH key at /home/oracle/.ssh/id_rsa Do you want to continue (Yes | No) : yes Validating the details... Stage Directory : /u01/install/stage/appsStage WebLogic Server Admin Password : password EBS System Password : password
Enter details to specify how you want to create the backup on Oracle Cloud Infrastructure Object Storage.
Backup Identifier Tag - Enter a name to uniquely identify your backup. The script adds this tag as a prefix when creating the containers to store objects in a compartment within an Oracle Cloud Infrastructure Object Storage namespace, known as buckets. The generic bucket for the application tier and database tier Oracle home backup is named <Backup_Identifier_Tag>Generic
. The database bucket for the database RMAN backup is named <Backup_Identifier_Tag>DB
.
Backup Thread Count - Specify the number of threads used to upload the application tier and database tier file system backups. The default value is 1. If your CPU count is less than 8, then the maximum value for the backup thread count is 2 times the CPU count. If your CPU count is 8 or more, then the maximum value for the backup thread count is 1.5 times the CPU count.
Backup Archive Type - Specify tgz to compress the backups before the upload, or tar if you do not want to compress the backups. We recommend that you specify tgz.
RMAN Advanced Configuration Parameter File Path - If you created an advanced configuration parameter file in Create an Advanced Configuration Parameters File, then specify the directory path and file name for the file in this parameter. Otherwise, leave this parameter blank.
Backup Encryption Password - Specify a password to encrypt the application tier file system and database tier file system. If Transparent Data Encryption (TDE) is not enabled in the source database, then this password is also used to encrypt the database RMAN backup.
Confirm Backup Encryption Password - Re-enter the same backup encryption password to confirm it.
=========================== Enter OSS - Backup Details =========================== [Ctrl-B: Back, Ctrl-H: Main Menu] Backup Identifier Tag : EBS122EXAMPLE Backup Thread Count : 4 Backup Archive Type ( tar | tgz ) : tgz RMAN Advanced Configuration Parameter File Path : /u01/install/APPS/RC06/RemoteClone/EBS-METADATA/template/advanced-config-param.txt Backup Encryption Password : password Confirm Backup Encryption Password : password
Next, indicate whether you access the cloud service through a proxy and need to specify the proxy details.
================================================ Enter Oracle Cloud Infrastructure Proxy Details ================================================ [Ctrl-B: Back, Ctrl-H: Main Menu] 1: Yes 2: No Enter your choice from above list: 1
If you enter option 1, then in the following screen, specify the proxy details used to establish communication between the backup module server and the cloud service.
================================================ Enter Oracle Cloud Infrastructure Proxy Details ================================================ [Ctrl-B: Back, Ctrl-H: Main Menu] Proxy Protocol : https Proxy Host : www-proxy.example.com Proxy Port : 443 Proxy User Name : Proxy User Password :
Enter your Oracle Cloud Infrastructure details.
The user who performs the backup must be a member of the Oracle E-Business Suite administrators group defined according to Create and Map Groups in Oracle Cloud Infrastructure Identity and Access Management and Oracle Identity Cloud Service or Create the Oracle E-Business Suite Administrators Group and Assign Policies. For this user, enter your user OCID, the fingerprint for your Oracle Cloud Infrastructure API signing key, the location for your PEM key file on the database tier, and the location for your PEM key file on the application tier.
Enter the OCID for your tenancy, the region identifier of the region where you plan to provision an environment from this backup, your tenancy name, and the OCID of the compartment where the backup buckets should be created.
For environments with Oracle Database Release 12.1.0.2 or Release 19c, you must also specify the Cloud database service on which you plan to provision the target environment based on this backup.
For a Compute VM, enter Compute.
For Base Database Service 1-Node or 2-Node DB System, enter Base Database Service DB System.
For Exadata Database Service Dedicated, enter Exadata Database Service.
============================================================================ Migrate Oracle E-Business Suite - Enter Oracle Cloud Infrastructure Details ============================================================================ [Ctrl-B: Back, Ctrl-H: Main Menu] Oracle Cloud User OCID : ocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Oracle Cloud Fingerprint : xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx Oracle Cloud User Private Key Path on Database Tier : /u01/install/APPS/.oci/oci_api_key.pem Oracle Cloud User Private Key Path on APPS Tier : /u01/install/APPS/.oci/oci_api_key.pem Oracle Cloud Tenancy OCID : ocid1.tenancy.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Oracle Cloud Region : xx-xxxxxx-1 Oracle Cloud Tenant Name : example Oracle Cloud Compartment OCID : ocid1.compartment.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Target Database Type - ( Compute | Base Database Service DB System | Exadata Database Service ): Base Database Service DB System
Review the values specified for the backup creation. The mode is set automatically based on your database release and target database type.
BMCS
- Environments with Oracle Database Release 11.2.0.4, or environments with Oracle Database Release 12.1.0.2 or 19c where the target database service is Compute
BMCS_CDB
- Environments with Oracle Database Release 12.1.0.2 or 19c where the target database service is Base Database Service or Exadata Database Service Dedicated
The custom private key locations for the source database tier and source application tier are shown only if you chose to authenticate the OS user on those tiers with a custom private SSH key.
If you are satisfied with the values shown, enter option 1 to proceed.
========================================= Migrate Oracle E-Business Suite - Review ========================================= [Ctrl-B: Back, Ctrl-H: Main Menu] Mode : BMCS_CDB Source Database Details: Host Name : demo.example.com Custom Private Key Location : /home/oracle/.ssh/id_rsa OS User Name : oracle Stage Directory : /u01/install/stage/dbStage Context File : /u01/install/APPS/12.1.0/appsutil/EBSDB_apps.xml OS Time Zone : America/Los_Angeles Source Application Tier Details: Hostname : demo.example.com OS User Name : oracle Custom Private Key Location : /home/oracle/.ssh/id_rsa Stage Directory : /u01/install/stage/appsStage Context File : /u01/install/APPS/fs1/inst/apps/EBSDB_apps/appl/admin/EBSDB_apps.xml OSS - Backup Details: Backup Identifier Tag : EBS122EXAMPLE Backup Thread Count : 4 Backup Archive Type : tgz RMAN Advanced Configuration Parameter File Path : /u01/install/APPS/RC06/RemoteClone/EBS-METADATA/template/advanced-config-param.txt Oracle Cloud Infrastructure Details: Oracle Cloud User OCID : ocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Oracle Cloud Fingerprint : xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx Oracle Cloud Tenancy OCID : ocid1.tenancy.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Oracle Cloud Region : xx-xxxxxx-1 Oracle Cloud Tenant Name : example Oracle Cloud Compartment OCID : ocid1.compartment.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Target Database Type : Base Database Service DB System ============================= Proceed With Selected Action ============================= [Ctrl-B: Back, Ctrl-H: Main Menu] 1: Yes 2: No Enter your choice from above list: 1
The script performs the following tasks:
Validates OS level authentications.
Validates whether the Oracle Database version is certified.
Validates whether the database is archivelog enabled.
Validates whether mandatory patches are present.
Creates a database backup.
Performs remote calls to the application tier to create a tar package containing the application files. For Oracle E-Business Suite Release 12.2, the tar package includes the contents of the EBSapps
directory on the run file system, including the APPL_TOP
directory, the COMMON_TOP
directory, the OracleAS 10.1.2
directory, and a packaged version of the Oracle Fusion Middleware home. For Oracle E-Business Suite Release 12.1.3, the tar package includes the contents of the APPL_TOP
, COMMON_TOP
, OracleAS 10.1.2
, and OracleAS 10.1.3
directories.
Transfers the application tier tar package and database backup to a new bucket in your Oracle Cloud Infrastructure Backup Service account associated with your Oracle Cloud Infrastructure tenancy.
If the script indicates that a validation failed, you can press Ctrl-B to return to previous screens and provide a corrected value. You can review the log files in the RemoteClone/logs
directory to help identify which value failed validation. It is recommended that you do not exit the script; instead, use another UNIX window to view the log file, so that you can return to the previous screens of the script and correct the failed value without needing to re-enter all the values you previously entered.
After the script finishes and the backup is complete, you should notify users that they can resume normal file system activities. You should also restart any application tier or database backup cron jobs that you stopped before you began running the script, and resume patching and maintenance activities as needed.
You can use Oracle E-Business Suite Cloud Manager to provision an environment on Oracle Cloud Infrastructure based on the backup you created. See Review Backups, Review Environment Details, and Advanced Provisioning.
You can also use Oracle E-Business Suite Cloud Manager to delete a backup that you no longer need, or use a command-line API to delete a failed backup. See Delete a Backup.
Review Oracle WebLogic Server Validation Warnings
The Oracle E-Business Suite Cloud Backup Module performs certain validations on the Oracle WebLogic Server domain and exits with a warning if the default threshold values are exceeded. If the script returns one of these warning messages, then you should review the source environment to decide whether you will make changes to resolve the issue or whether you can safely ignore the warning and skip the validation to proceed with the backup.
WLS domain size is higher than EBS default threshold: 5120 MB
- Check what factors are causing the Oracle WebLogic Server domain size to be greater than 5120 MB (5 GB). If the domain size is due to large log files or temporary files, then you should first clean up those files to reduce the domain size, and then rerun the Oracle E-Business Suite Cloud Backup Module. However, if you determine that the contents of the Oracle WebLogic Server domain are valid, such as if the domain includes a large number of managed servers that add to the overall domain size, then you can choose to skip this validation.
ERROR : Backup config.xml file count is higher than EBS default threshold : 500. Please cleanup some of the backup config.xml file available in <EBS_DOMAIN_HOME>/config directory
. - Check the <EBS_DOMAIN_HOME>/config
directory to determine whether you can delete any older Oracle WebLogic Server backup configuration files (backup_config*.xml
) before rerunning the Oracle E-Business Suite Cloud Backup Module. If you want to retain all the backup configuration files, then you can choose to skip this validation.
If you determine that you can safely ignore any Oracle WebLogic Server warning messages, then you can skip these validations by setting the SKIP_WLS_DOMAIN_VALIDATION_THRESHOLD
parameter according to the following steps.
Follow the instructions in Create an Advanced Configuration Parameters File to create an advanced configuration parameter file and set the SKIP_WLS_DOMAIN_VALIDATION_THRESHOLD
parameter to true
.
If you choose to skip the Oracle WebLogic Server validations, ensure that you tune the JVM heap memory size accordingly using the CONFIG_JVM_ARGS
environment variable. Otherwise, the preclone process for the Oracle WebLogic Server domain may run successfully, but the apply clone may later fail with an error due to the heap space being exceeded.
Finally, rerun the Oracle E-Business Suite Cloud Backup Module following the instructions in Create a Backup with the Oracle E-Business Suite Cloud Backup Module, and specify the location of your advanced configuration parameter file at the RMAN Advanced Configuration Parameter File Path prompt.
Troubleshoot Known Issue for Custom Log Locations
This workaround resolves a known issue that can occur during a traditional lift and shift if a utility writes to a directory such as a log file within the Oracle home on the database tier of your Oracle E-Business Suite environment during the backup process. This issue can occur because the database is online while the backup is being created, so log entries might be generated while the backup is in progress. The Oracle E-Business Suite Cloud Backup Module skips standard log locations, but if you have configured any custom log locations and the logs are updated while the script is running, you may encounter errors such as the following:
Error: tar: custom_logs/sqlnet_server_1586.trc: file changed as we read it tar: custom_logs: file changed as we read it
If you identify custom log locations to exclude from the backup before you begin running the Oracle E-Business Suite Cloud Backup Module, you can create an advanced configuration parameter file specifying the directories or files to exclude. See Create an Advanced Configuration Parameters File.
If you encounter such errors while running the Oracle E-Business Suite Cloud Backup Module, then as a workaround, if you are certain that the directories do not need to be included in the backup, perform the following steps to specify the directories that should be skipped and then restart the backup process.
Review the database tier upload log file <STAGE_DIRECTORY>/session/<SESSION_ID>/logs/<TIMESTAMP>/dbTierUpload.log
on the database node to determine the directory for which the backup failed.
Locate the following file in the stage area directory on the database node: <STAGE_DIRECTORY>/session/<SESSION_ID>/db_manifest.json
Make a backup copy of this file, and then open the db_manifest.json
file in a text editor.
Search for the directory for which the backup failed.
Specify that this directory should be skipped during the backup process by adding the directory under the "excludes" array. For example, if you have a directory named custom_logs
within the Oracle home directory, look for the lines similar to the following in the db_manifest.json
file:
<db_manifest.json> { "sourcePath":"/scratch/oracle/12.1.0", "binName":"s_db_ohBin1", "contents":[ "custom_logs" ], "excludes":[], "sizeInBytes":15838395906, "objectNameInBucket":"db/s_db_oh/s_db_ohBin1.tar.enc", "targetPath":"s_db_oh" }
Change these lines by adding the directory to be skipped under the "excludes" array. Note that the directory paths in the "excludes" array are relative to your Oracle home directory. Then save your changes to the db_manifest.json
file. Ensure that the modified file does not contain any syntax errors. For example:
{ "sourcePath":"/scratch/oracle/12.1.0", "binName":"s_db_ohBin1", "contents":[ "custom_logs" ], "excludes":[ "custom_logs" ], "sizeInBytes":15838395906, "objectNameInBucket":"db/s_db_oh/s_db_ohBin1.tar.enc", "targetPath":"s_db_oh" }
Restart the Oracle E-Business Suite Cloud Backup Module. It will continue from the point where it previously failed.