Before You Begin
In this tutorial, you'll learn how to deploy the EBS Cloud Admin Tool to Oracle Cloud Infrastructure Compute Classic. This tool can then be used to perform the following procedures in Oracle Cloud:
- Provision a new installation of Oracle E-Business Suite
- Create an Oracle E-Business Suite environment from a backup
- Manage and configure Oracle E-Business Suite environments
Time to Complete
- A minimum of 15 minutes to create the EBS Cloud Admin Tool virtual machine.
What Do You Need?
To perform the steps in this tutorial, you must have:
- Met the relevant requirements listed My Oracle Support Knowledge Document 2066260.1, Getting Started with Oracle E-Business Suite on Oracle Cloud.
- Additional cloud service resources that match or exceed the following minimum requirements:
|Requirements||Number of Virtual Machines (VMs)||Number of OCPUs||Memory||Block Storage||External IP addresses|
|EBS Cloud Admin Tool virtual machine (VM)
(also called the Provisioning VM)
|1||1||7.5 GB||20 GB||1|
To deploy the EBS Cloud Admin Tool to Oracle Cloud Infrastructure Compute Classic (which will be referred to as "Compute Classic" in this document), you must complete the following tasks:
- Generate an SSH key pair on your local system and upload the public key to Compute Classic.
- Copy required machine images from Oracle Cloud Marketplace into your Compute Classic account.
- Create a Compute Classic instance (which we will refer to as the EBS Cloud Admin Tool instance) using the EBS Provisioning Tools image.
- Configure the instance for SSH access.
- Log in to the EBS Cloud Admin Tool instance.
- Update the Installation image list.
- Update EBS Cloud Admin Tool to the latest version.
Generating an SSH Key Pair
Before you create your Compute Classic instance (in a subsequent section), you must:
- Generate an SSH key pair on your local system (UNIX or Windows).
Note: This SSH key pair can use a passphrase only if it will be used for the EBS Cloud Admin Tool VM. If the SSH key has a passphrase, it cannot be used for provisioning a new environment.
- Upload the SSH public key to Compute Classic. This SSH public key is used for authentication when you log in to the instance.
Note: Carefully record the public and private key names, where you saved them, and your key passphrase.
Copying Required Machine Images from Oracle Cloud Marketplace into Your Compute Account
To deploy the EBS Cloud Admin Tool for the first time, you will use the Oracle Cloud Marketplace images listed in the following table:
|Marketplace Listing Name||Application Machine Image Name Example||Comments|
|EBS Provisioning Tools Image||OPC_OL6_9_X86_64_EBS_ORCH_VM_<Date>||Includes the EBS Cloud Admin Tool|
|EBS OS-Only Image||OPC_OL6_9_X86_64_EBS_OS_VM_<Date>||Required for deploying EBS instances|
- <Date> is the date (US format) an image was created, such as 06042018. The dates for different images may vary.
- If you are an existing customer who has deployed an earlier version of the tool and would like to continue to use the tool to manage existing environments, you must follow the instructions in "Updating EBS Cloud Admin Tool to Latest Codeline" below.
The required images may already be in your account if you have performed an installation previously. To retrieve images that are not already in your account, or obtain newer versions, perform the following steps:
- Go to the Oracle Cloud Marketplace at https://cloud.oracle.com/marketplace/.
- Click on the PRODUCTS drop-down menu and select INFRASTRUCTURE (IaaS) > Compute Classic
- Enter 'e-business' in the search field and click Go to see the full list of available Oracle E-Business Suite images. Look for the images you will need for your installation, as listed in the above tables.
- For each Marketplace listing in the applicable table above:
- Select the image listing to bring up a screen with more information on that image.
- Click Get App.
- Select a Compute account from the drop-down list. Then, select the checkbox to accept the Oracle Standard Terms and Restrictions.
- Click Install.
- Exit the confirmation screen. Do not start the Compute Classic console.
- You will receive an email notification confirming that your application has been installed.
Once all the images are in your account, move on to the next section, "Creating the EBS Cloud Admin Tool Instance."
Creating the EBS Cloud Admin Tool Instance
In this section, you will create the EBS Cloud Admin Tool instance in Compute Classic from the EBS Provisioning Tools image. The OS-only image you moved into your Compute account will later be used by the automated provisioning tool to install your chosen Oracle E-Business Suite topology.
- Compute Classic resources such as instances and storage volumes are created using orchestrations. Compute Classic orchestrations are used to manage the lifecycle of those resources. It is possible to suspend, terminate or delete orchestrations. However, if you terminate or delete the orchestration associated with the EBS Cloud Admin Tool instance, you will lose all of the metadata information for the EBS environments created from the EBS Cloud Admin Tool. Therefore, you must not delete or terminate this orchestration. If you wish to free up OCPU resources associated with the EBS Cloud Admin Tool VM, you can suspend the orchestration temporarily. This would preserve the information about your EBS environments. You would have access to this information after restarting the orchestration.
- Create only one EBS Cloud Admin Tool instance per domain and use it for all Oracle E-Business Suite operations. Attempting to run the tool from multiple VMs in the same domain can give undefined results and is not supported.
To create the EBS Cloud Admin Tool instance, follow these steps:
- Navigate to the Oracle Compute Cloud Service console by following these steps:
- Sign in to the Oracle Cloud My Services application by navigating to https://cloud.oracle.com/sign-in.
- In the Cloud Account region, select the "Traditional Cloud Account" option in the account type drop-down list.
- Then, select your data center from the data center drop-down list.
- Click My Services.
- On the next screen, enter your identity domain. Click Go.
- Enter your sign in credentials. Click Sign In. This takes you to the Oracle Cloud My Services Dashboard.
- Click the menu button near the upper left corner of the Dashboard page to bring up the Navigation menu.
- Select Compute Classic to view the Compute Classic console.
- On the Compute Classic console, click the Instances tab, and then click Create Instance. The Create Instance wizard starts.
- Click Customize at the top right corner of the screen.
- This will bring up the Image screen. On this screen:
- Select Private Images in the side navigation menu.
- Enter "EBS_ORCH_VM" in the Search field to search for all images containing this description.
- Select the "EBS Provisioning Tools Image" with a description that includes the most recent date (for example, "OPC_OL6_9_X86_64_EBS_ORCH_VM_06042018").
- Click the > button to proceed to the Shape screen.
- On the Shape screen, select an appropriate shape for your instance. The shape specifies the number of CPUs and amount of memory your instance will have.
- For example, select oc3 (OCPUs: 1, Memory: 7.5 GB).
- Click the > button to proceed to the Instance screen.
- On the Instance screen, perform the following steps:
- Using the Persistent drop-down list, ensure that the default option "False" is selected.
- Using the Placement drop-down list, ensure that the default option "Auto" is selected.
- In the Name field, enter an appropriate name. If you don’t specify a name, the instance name will be generated automatically based on the date and time.
- In the Label field, enter a description to help identify the instance. If you provide a label, the label is used to list the instance on the Instances tab.
- In the SSH Keys field, if you have already uploaded your SSH Public Key you created earlier, select it from the drop-down list.
- Otherwise, click on Add SSH Public Key, then:
- In the Add SSH Public Key dialog box, enter a name and the value of the SSH public key you generated earlier.
- Paste the key value into the Value field exactly as it was generated. Do not append or insert any extra characters, line breaks, or spaces.
- Click Add to add your SSH public key and associate it with the instance being created.
- Click the > button to proceed to the Network screen.
- On the Network screen, perform the following steps:
- In the DNS Hostname Prefix field, enter a string that will be used as a prefix in the domain host name for your instance. For the purpose of this tutorial, you can leave this blank.
- For Network Options, select Shared Network. Ensure that IP Network is not selected.
- Using the Public IP Address drop-down, choose Persistent Public IP Reservation.
- An IP Reservation drop-down list will appear. If you have reserved an IP address, choose it from the list.
- Otherwise, click Create IP Reservation, then:
- In the Create Public IP Reservation dialog box, enter the desired name of your IP reservation
- Click Create.
- In the Security Lists field, either specify an existing security list (substep 1 below) or create a new one (substep 2 below).
- If you created a security list previously, enter its name.
- If you did not create a security list earlier, click Create Security List. In the dialog box, supply the following and then click Create:
- Name: Enter the desired name of your security list. For example, you could enter ebs-net.
- Inbound Policy: Retain the default policy, Deny (Drop Packets, No Reply).
Note: Never set Inbound Policy to Permit, as this setting will disable the firewall and will allow any traffic into the VM instance. For more information, refer to About Security Lists in Using Oracle Compute Cloud Service (for PaaS).
- Outbound Policy: Retain the default policy, Permit (Allow packets).
- Description: Enter a description.
- Click the > button to proceed to the Storage screen.
- On the Storage screen:
- Under the Name column, you will see one volume listed, called <instance_name>_storage. The value of <instance_name> is the name you previously entered (or accepted) on the Instance screen. Do not make any changes to this name.
- Click the > button to proceed to the Review screen.
- On the Review screen, check your selections and make any necessary edits.
- When you are ready, click Create to start the creation of your provisioning tools instance. You will see the message: "Starting orchestration <instance name>".
- The instance creation process goes through several phases, and may take a total of around 15 minutes to complete.
Note: You can monitor progress by selecting the Orchestrations tab.
- When the process is complete, you will be able to click on the Instances tab to view your running instance.
Configuring Instance For SSH Access
- Select the Network tab.
- Select Security Rules under Shared Network from the navigation menu on the left.
- Select Create Security Rule and then do the following:
- Name: Enter a name for the rule. For example, allow_ssh
- Status: Select Enabled
- Security Application: Select ssh
- Source: Select the Security IP List radio button and select public-internet from the drop-down list.
- Destination: Select the Security List radio button. Then, from the Security List drop-down list, select the security list (for example, ebs-net) you created earlier.
- Description: Enter a description for the rule (for example, Allow SSH access to instance).
- Click Create.
Logging in to the EBS Cloud Admin Tool Instance
Log in to your EBS Cloud Admin Tool instance using SSH by following the instructions in section "Connect to Your Oracle Cloud Instance Via SSH" in the Oracle by Example tutorial Common Tasks for Oracle E-Business Suite in Oracle Cloud.
Updating the Installation Image List
To conduct an installation, the EBS Cloud Admin Tool utilizes a file,
OCIClassicOSImage.json, which contains an image list. You must modify this file to insert the full path (designated by domain name, user account, and image name) for the OS-only image.
- While logged on to the EBS Cloud Admin Tool instance (VM), switch from the
opcuser to the
oracleuser by running the command:
- Open the
/u01/install/APPS/apps-unlimited-ebs/EBS-METADATA/OCIClassicOSImage.jsonfile and locate the element "name" with value containing "EBS_OS_VM". For example:
$ sudo su - oracle
Modify the value to correspond to the full path of the image in your account, substituting for the values in angle brackets as appropriate:
Proceed to the instructions "Run the Self Update Utility" in the following section, "Updating EBS Cloud Admin Tool to Latest Version".
Updating EBS Cloud Admin Tool to Latest Version
The most current version of the EBS Cloud Admin Tool is Version 18.3.1. Check the version you are on by performing the following:
- Log on to the EBS Cloud Admin Tool VM that you provisioned as the
- Check for the existence of the
/etc/ebscm.conffile and view the first line of the file. For example:
$ cat /etc/ebscm.conf version=18.3.1
ebscm.conf file exists and the version is 18.3.1, no further action is required.
ebscm.conf file exists and the version is either 22.214.171.124, 18.2.1, 126.96.36.199, 188.8.131.52, or 18.1.1, then proceed to the instructions in "Run the Self Update Utility" below.
Otherwise, you are on a version of the tool prior to 18.1.1, and will need to take additional steps to update the tool depending on that version. To determine which prior version of the tool you are using, perform the following steps.
- While still logged into your Provisioning VM, switch from the
opcuser to the
oracleuser using the following command:
$ sudo su - oracle
- Obtain the version of the EBS Cloud Admin Tool by viewing the
VERSIONINFO.txtfile, if it exists. For example:
$ cat /u01/install/APPS/apps-unlimited-ebs/EBS-METADATA/VERSIONINFO.txt VERSIONINFO: E-Business Suite Provisioning Tool Version:1.7.3
If it returns either "VERSIONINFO: E-Business Suite Provisioning Tool Version:1.7.3" or "VERSIONINFO: E-Business Suite Provisioning Tool Version:1.7.2," proceed to the appropriate subsection "Upgrading the EBS Cloud Admin Tool from Version 1.7.3" or "Upgrading the EBS Cloud Admin Tool from Version 1.7.2."
VERSIONINFO.txtfile does not exist, the command will return "No such file or directory". This indicates that you are on EBS Cloud Admin Tool Version 1.7.1 or earlier, so proceed to section "Upgrading the EBS Cloud Admin Tool from Version 1.7.1."
Run the Self Update Utility
EBS Cloud Admin Tool Version 18.1.1 and later include a Self Update Utility that can be used to update the tool to the latest version.
Before you run the Self Update Utility, we strongly recommend that you save a copy of your provisioning VM by creating a backup. See "Backing Up the Provisioning Virtual Machine" for instructions. This will allow you to restore the provisioining VM (as noted in "Restoring the Provisioning Virtual Machine") if needed.
To run the Self Update Utility, perform the following steps:
- Log on to the EBS Cloud Admin Tool VM that you provisioned as the
- Switch from the
opcuser to the
oracleuser using the following command:
$ sudo su - oracle
- If the
OCIClassicOSImage.jsonfile has ever been edited, take a backup of the file.
$ cd /u01/install/APPS/apps-unlimited-ebs $ mkdir ~/ebs-orch-backup $ cp ~/EBS-METADATA/OCIClassicOSImage.json ~/ebs-orch-backup
- Run the Self Update Utility:
$ cd /u01/install/APPS/apps-unlimited-ebs/bin $ perl selfUpdate.pl
- If you backed up the
OCIClassicOSImage.jsonfile, move the file from its backup location to
$ cp /u01/install/APPS/apps-unlimited-ebs/ebs-orch-backup/OCIClassicOSImage.json /u01/install/APPS/apps-unlimited-ebs/EBS-METADATA/
At the present time, this brings you to Version 18.3.1 of the tool.
Upgrading the EBS Cloud Admin Tool from Version 1.7.3
- As the root user, navigate to the
$ sudo su # cd /tmp
- Download the specified tar file as shown:
# wget https://storagesvc-a425918.storage.oraclecloud.com/v1/storagesvc-a425918/PROD/SelfUpdate/EBSCloudAdminTools_v18.1.1.tgz
- Execute the following commands:
# tar -xvzf /tmp/EBSCloudAdminTools_v18.1.1.tgz -C /u01 # cd /u01/EBSCloudAdminTools_v18.1.1/bin # ./setup.sh # sudo su - oracle
At the present time, this brings you to EBS Cloud Admin Tool Version 18.1.1. To upgrade the tool from 18.1.1 to 18.3.1, refer to "Run the Self Update Utility" in this section.
Upgrading the EBS Cloud Admin Tool from Version 1.7.2
If you are on EBS Cloud Admin Tool Version 1.7.2, follow these instructions to update the tool to Version 1.7.3. After doing so, you can update to EBS Cloud Admin Tool Version 18.1.1 and then run the Self Update Utility to obtain release updates, as instructed.
- Connect to your EBS Cloud Admin Tool VM as the
- If 64-bit Java Runtime Environment (JRE) is not installed, follow the instructions in "Installation of the 64-bit JRE on Linux Platforms" in the Oracle Java Documentation Library to do so.
- Then, run the following commands:
$ cd /u01/install/APPS/apps-unlimited-ebs/self-update $ ./selfupdate <stage directory>
The stage directory is any directory you specify (such as
/tmp) to be used as a temporary stage area.
At the present time, this brings you to EBS Cloud Admin Tool Version 1.7.3. From here, you must update the tool to the latest version (currently Version 18.3.1) by following the instructions in "Upgrading the EBS Cloud Admin Tool from Version 1.7.3."
Upgrading the EBS Cloud Admin Tool from Version 1.7.1
To determine if you are on a version of the EBS Cloud Admin Tool prior to Version 1.7.1, check the name of the image used to create the EBS Cloud Admin Tool VM (also called the Provisioning VM). If the image name does not have an embedded date, or has a date prior to "03282017," you are on a version prior to 1.7.1 and should proceed to the next section, "If You Are on EBS Cloud Admin Tool Version Prior to 1.7.1."
Otherwise, you are on EBS Cloud Admin Tool Version 1.7.1. In order to continue to manage environments created with the tool, you must first update to Version 1.7.3 and then update to Version 18.1.1. (18.1.1 and later contain a Self Update Utility to get to the latest patchset.)
Follow these steps to update your tool version to EBS Cloud Admin Tool Version 1.7.3:
- While logged on to your EBS Cloud Admin Tool VM as the
oracleuser, take a backup of the existing
$ mkdir ~/ebs-orch-backup $ cp /u01/install/APPS/apps-unlimited-ebs/ProvisionEBS.xml ~/ebs-orch-backup
- Download the EBS Cloud Admin Tool Version 1.7.3 zip file from the EBS Public Container:
$ cd /u01/install/APPS/ $ wget https://storagesvc-a425918.storage.oraclecloud.com/v1/storagesvc-a425918/self_update/latest/apps-unlimited-ebs.zip
- Still in the
/u01/install/APPSdirectory, unzip the 1.7.1 zip file:
$ unzip -o apps-unlimited-ebs.zip
- Uninstall the existing chef gem libraries and then install the new gem libraries:
$ cd /u01/install/APPS/apps-unlimited-ebs/resources/lib $ chef gem uninstall knife-ebs $ chef gem uninstall knife-oc $ export PATH=/u01/install/APPS/.chefdk/gem/ruby/2.3.0/bin:$PATH $ chef gem install knife-oc-2.0.14.gem $ chef gem install knife-ebs-1.0.0.gem
- Restore the backup
$ cp ~/ebs-orch-backup/ProvisionEBS.xml /u01/install/APPS/apps-unlimited-ebs
Your tool is now on EBS Cloud Admin Tool Version 1.7.3. Now, you must update to Version 18.1.1 by following the instructions in "Upgrading the EBS Cloud Admin Tool from Version 1.7.3."
If You Are on an EBS Cloud Admin Tool Version Prior to 1.7.1
If you are on an EBS Cloud Admin Tool Version prior to Version 1.7.1, you must recreate the VM by following the steps in sections "Copying Required Machine Images from Oracle Cloud Marketplace into Your Compute Account" and "Creating the EBS Cloud Admin Tool Instance" of this tutorial.
Note: All environments created with the previous EBS Cloud Admin Tool VM will still be available, although you will not be able to perform any management activities on them from the new EBS Cloud Admin Tool VM.
Want to Learn More?