Discover an Oracle E-Business Suite Instance

This chapter covers the following topics:

Overview

You can use the Discovery feature in Oracle E-Business Suite Cloud Manager to register Oracle E-Business Suite environments that follow our documented standards. The types of environments you can discover include the following:

The process for discovering your Oracle E-Business Suite instance is as follows:

  1. Ensure all prerequisites are met.

  2. Perform steps to prepare for discovering your environment.

  3. Submit the Discovery request.

  4. Review the resulting report and make any necessary changes to bring the environment into compliance.

  5. Register the environment once it passes all compliance checks.

Once your environment is registered, you can use Oracle E-Business Suite Cloud Manager to perform lifecycle management activities, such as backing up or restoring your instance. For a full list of Oracle E-Business Suite Cloud Manager features, see Features.

Note the following Discovery implementation details:

If your environment has any of the following characteristics, you cannot use the Discovery feature at this time:

The Discovery feature is introduced in Oracle E-Business Suite Cloud Manager version 21.1.1.1.

Note: Some earlier versions of Oracle E-Business Suite Cloud Manager provide scripts that you can use to unregister and rediscover environments. For instructions on using these scripts, see Rediscover an Upgraded Environment.

For details on performing the discovery process, see the following sections:

Prerequisites

You must have the following prerequisites in place in order to discover an Oracle E-Business Suite environment in Oracle Cloud Infrastructure:

Review Discovery Requests

  1. To review the discovery requests that have been submitted in Oracle E-Business Suite Cloud Manager, click the Navigator icon, select Administration, and then select Discovery.

  2. The Discovery Requests page displays the discovery requests that have been submitted in your Oracle E-Business Suite Cloud Manager instance, within the compartment you chose in the EBS Compartment field in the Oracle E-Business Suite Cloud Manager header. You can optionally enter a full or partial value in the search field to display only requests whose properties contain that value. You can search by the following properties shown in this page:

    • Request name

    • Environment name

    The page also displays the status of the discovery job and the date and time the request was submitted.

  3. To submit a discovery request, first perform the tasks required to prepare your environment for discovery, and then click Submit Discovery Request. See Prepare for Discovery and Submit a Discovery Request.

  4. To review the job details for a discovery job, click the job status link for that request. See Review Job Status.

  5. To review the Discovery Report for a discovery request, click the View Discovery Report icon in the Compliance column. See Review the Discovery Report.

  6. To register an environment that meets all the standards for discovery, click the Actions icon next to that request and then select Register Environment. See Register a Compliant Environment.

  7. To remove a discovery request for an environment that has not yet been registered, click the Actions icon next to that request and then select Remove Discovery Request. For example, you can remove a request if you no longer want to register that environment.

    Note: If you submit multiple discovery requests for an environment as you prepare it for discovery, any superseded requests are automatically removed when the environment is successfully registered. However, the final successful discovery request for the environment remains displayed in the Discovery Requests page after the environment is registered, as a record of the environment's history. You cannot remove that request unless you later unregister the environment.

  8. To review the environment details for a successfully registered environment, click the environment name link. See Review Environment Details (Standard).

Prepare for Discovery

Perform the following tasks to prepare to discover an environment.

Enable SSH Connectivity

SSH connectivity must be enabled from the Oracle E-Business Suite Cloud Manager instance to all application tier and database tier nodes. To enable this connectivity, log in to the Oracle E-Business Suite Cloud Manager VM as the oracle user and copy the contents of ~/.ssh/id_rsa.pub into ~/.ssh/authorized_keys for the opc user on all nodes that are part of the environment to be discovered.

Create a Network Profile

As an Oracle E-Business Suite Cloud Manager administrator, use Oracle E-Business Suite Cloud Manager to create a network profile describing the network on which the candidate Oracle E-Business Suite instance is deployed. This network profile includes key network characteristics such as compartment, region, VCN, availability domain and subnets. For detailed instructions, see Create a Network Profile.

Create a Stage Directory

Create a directory on the database server to use as the database node stage directory. The stage directory is a temporary storage directory used by the discovery process, and must be writable by the oracle user. For example, /u01/install/APPS/stage.

Submit a Discovery Request

You can now submit a discovery request in Oracle E-Business Suite Cloud Manager. The discovery request process identifies the candidate environment to Oracle E-Business Suite Cloud Manager. The Prevalidation phase ensures that prerequisites are met, then the discovery check itself runs and generates a report which will validate whether the environment meets predefined standards.

  1. In Oracle E-Business Suite Cloud Manager, click the Navigator icon, select Administration, and then select Discovery.

  2. In the Discovery Requests page, click Submit Discovery Request.

  3. In the Submit Discovery Request window, enter the following details:

    1. Name - Enter a unique name for your discovery request. The name must meet the following requirements:

      • The name must contain no more than 50 characters.

      • The first character cannot be a numeral.

      • Special characters and spaces are not allowed.

    2. EBS Compartment - Select the Oracle E-Business Suite compartment associated with the Oracle Cloud Infrastructure resources for the environment.

    3. Network Profile - Select the network profile that contains the network resources for the environment.

    4. DB Node IP Address - Enter the private IP address of the database node for the environment being discovered.

      Note: For an Oracle RAC database, you can enter the private IP address of any of the database nodes in this field.

    5. DB Context File - Enter the full path for the database context file.

      Note: For an Oracle RAC database, enter the context file corresponding to the database node IP specified in DB Node IP Address.

    6. DB Node Stage Directory - Provide the stage directory location previously created to store metadata gathered during the discovery job.

      Note: For an Oracle RAC database, the stage directory should be located on the database node IP specified in DB Node IP Address.

    7. APPS Password - Enter the APPS user password for the Oracle E-Business Suite source environment.

    8. Optionally, if the candidate Oracle E-Business Suite environment for discovery is already configured with an Oracle Cloud Infrastructure load balancer, click the Discover OCI Load Balancers toggle switch. Then, click Add to specify the details of the load balancer and listener. An environment can have multiple load balancers and zones associated with it.

      If the candidate Oracle E-Business Suite Environment has an Oracle Cloud Infrastructure load balancer associated with it but you do not specify the load balancer details when you submit the discovery request, or if the specified load balancer and listener mappings do not match the environment's configuration, then the web entry point identified by the discovery process is registered with a default web entry type as follows:

      • If the environment includes only one application tier node, then its web entry type is set to Application Tier Node.

      • If the environment includes multiple application tier nodes, then its web entry type is set to Manually Configured Load Balancer.

      You can unregister the environment and submit a new discovery request to supply the corrected load balancer information.

  4. Click Submit when you are ready to submit the request. Ensure that the EBS Compartment field in the Oracle E-Business Suite Cloud Manager header is set to the compartment associated with the request. Oracle E-Business Suite Cloud Manager then displays the request in the Discovery Requests page.

In the Discovery Requests page, your newly submitted request with an automatically populated environment name appears. The request then goes through the Prevalidation phase, which ensures that Oracle E-Business Suite Cloud Manager can locate the environment and prerequisites are met. Refresh the page to view an updated job status.

You can click the status link to view the Job Details page. The Job Details page provides an option to auto-refresh every 20 seconds as the various compliance checks are performed and completed. Click the Auto Refresh toggle switch to enable and disable this feature. See Review Job Status.

Once Prevalidation succeeds, the request status will change to Waiting for User to Register Environment. At this point, you can review the Discovery Report and ensure that all artifacts identified by this process are consistent with your environment.

Review the Discovery Report

To review the Discovery Report, navigate to the Discovery Requests page. Click the View Discovery Report icon in the Compliance column associated with your environment.

In the report, each row corresponds to a standard listed in My Oracle Support Knowledge Document 2656874.1, Standards Used by the Oracle E-Business Suite Cloud Manager for Provisioning Oracle E-Business Suite on Oracle Cloud Infrastructure. Each row containing a standard includes the following information:

Resubmit a Discovery Request

If the Discovery Report indicates that your environment does not meet the standards for discovery, you can make the necessary changes and resubmit the discovery request. To do so, click Submit Discovery Request in the Discovery Requests page. See Submit a Discovery Request.

After you submit another request for the same environment, your initial request appears in the Discovery Requests page with a status of Superseded by discover request <environment name>.

Register a Compliant Environment

If the Discovery Report indicates that your environment meets the standards for discovery, you can proceed to register your environment. An environment that is compliant and ready to be registered appears with the status Waiting for User to Register Environment.

Click the Actions icon and select Register Environment. In the Register Environment window, enter the APPS user password and click Register.

The message Successfully submitted registration request appears on the Discovery Requests page. The status then changes to Discovery Input Validation in Progress.

After the registration completes, the status of the request changes to Discovery Successful.

Unregister an Environment

If an environment goes through a major change, you must unregister and rediscover the environment in order to register the updates within Oracle E-Business Suite Cloud Manager. For example, you should unregister and reregister your environment in the following scenarios:

When you unregister an environment, the metadata for the environment is removed from Oracle E-Business Suite Cloud Manager. This process does not delete the environment itself. After unregistering, you can submit a new discovery request to rediscover the environment.

Note: Single VM instances, such as instances provisioned by the One-Click Provisioning feature, cannot be registered or unregistered.

To Unregister an Environment

  1. Click the Navigator icon and select Environments.

  2. Navigate to the Environment Details page for the environment that you want to unregister by clicking the environment name link.

  3. Click Unregister.

  4. The Confirm Unregister window appears. Enter the environment name to confirm your choice. Then click Yes.

Note: After you complete the unregister action, you can no longer view or manage the environment in Oracle E-Business Suite Cloud Manager. To continue managing the environment, submit a discovery request and re-register the environment.

Rediscover an Upgraded Environment

You can rediscover an environment to refresh its metadata in Oracle E-Business Suite Cloud Manager after an upgrade. If you are using the most current version of Oracle E-Business Suite Cloud Manager, you can unregister and rediscover environments using the Oracle E-Business Suite Cloud Manager user interface. If you are on a version of Oracle E-Business Suite Cloud Manager earlier than 21.1.1.1, scripts are provided that you can use to unregister and rediscover environments.

Rediscovery is available for the following use cases, where the database can be running on any supported cloud service:

Note: If you plan to perform an out-of-place Oracle E-Business Suite or Oracle Database upgrade, where your new application tier or database tier resides on a different host, you need to run Unregister prior to using the Oracle Cloud Infrastructure console to delete the original environment.

Prerequisite Steps Prior to Rediscovery

Before performing rediscovery, it is important to complete the following prerequisite tasks:

  1. Check the Oracle E-Business Suite Cloud Manager registration settings.

    Ensure that the Resource Owner option is selected under Allowed Grant Types in the registration of Oracle E-Business Suite Cloud Manager as an application in Oracle Identity Cloud Service (IDCS). See Register Oracle E-Business Suite Cloud Manager as a Confidential Application.

  2. Configure the load balancer (conditional).

    If you upgraded your Oracle E-Business Suite environment from Release 12.1.3 to Release 12.2 using a new VM, separate from the VM where the Release 12.1.3 environment is located, then you must perform the corresponding load balancer configuration after the upgrade. You should complete the load balancer configuration before performing rediscovery. See "Upgrading to Oracle E-Business Suite Release 12.2" in My Oracle Support Knowledge Document 2517025.1, Getting Started with Oracle E-Business Suite on Oracle Cloud Infrastructure.

    If you performed the Oracle E-Business Suite upgrade on the same VM as the Release 12.1.3 environment, then you do not need to change the load balancer configuration.

  3. Make note of the database node IP address and context file location (conditional).

    For in-place Oracle E-Business Suite or Oracle Database upgrades, where your application tier or database tier does not change, make note of the database node IP address and context file location prior to proceeding with the unregister process, so that you can use these when you re-register the environment.

Use the Oracle E-Business Suite Cloud Manager User Interface to Rediscover an Upgraded Environment

The Discovery feature was introduced in the Oracle E-Business Suite Cloud Manager user interface (UI) in version 21.1.1.1.

Note: If you need to update your version, follow the instructions in Update Oracle E-Business Suite Cloud Manager to the Latest Version.

Follow these steps to register an environment deployed by Oracle E-Business Suite Cloud Manager that was later upgraded:

  1. Unregister an Environment

  2. Submit a Discovery Request

  3. Register a Compliant Environment

Use Scripts to Rediscover an Upgraded Environment

Oracle E-Business Suite Cloud Manager also provides scripts that you can use to unregister and rediscover environments if you are on a version of Cloud Manager earlier than 21.1.1.1.

If you used Oracle E-Business Suite Cloud Manager to deploy your environment and now plan to upgrade either Oracle E-Business Suite or the Oracle E-Business Suite database, you can continue to use Oracle E-Business Suite Cloud Manager after the upgrade by rediscovering the environment using the steps in this section.

The following scripts are provided to enable rediscovery:

These scripts are located in the /u01/install/APPS/apps-unlimited-ebs/bin/rediscovery directory. The log file for the scripts is stored in the following location: /u01/install/APPS/apps-unlimited-ebs/out/NodeJSClient.log

To rediscover an updated environment, perform the following steps:

  1. Ensure you are using the minimum Oracle E-Business Suite Cloud Manager version required for your use case, as shown in the following table.

    Table 10-1 Upgrade Types and Corresponding Minimum Versions of Oracle E-Business Suite Cloud Manager
    Upgrade Type Oracle E-Business Suite Cloud Manager Minimum Version
    Oracle E-Business Suite upgrade 20.2.1.1
    Oracle Database upgrade on Compute 21.1.1
    Oracle Database upgrade on VM DB Systems and Exadata Cloud Services 21.1.1.0.1
  2. Run the unregister-environment.js script using the following commands.

    $ cd /u01/install/APPS/apps-unlimited-ebs/bin/rediscovery
    $ node unregister-environment.js

    When prompted, specify the name of the upgraded environment, your Oracle Identity Cloud Service user name and password, and your Oracle E-Business Suite Cloud Manager administrator password.

  3. Create a stage directory on the database node of the upgraded environment to store metadata gathered during the discovery job. For example: /tmp/stage

  4. Run the discover-environment.js script using the following commands.

    $ cd /u01/install/APPS/apps-unlimited-ebs/bin/rediscovery
    $ node discover-environment.js

    When prompted, specify the following details:

    • A name for the discovery request.

    • The name of the network profile used to provision the environment.

    • The IP address for the environment's database node.

    • The stage directory you created for the discovery job on the database node.

    • The file path for the environment's database context file.

    • The APPS user password for the environment.

    • Your Oracle Identity Cloud Service user name.

    • Your Oracle Identity Cloud Service password.

    • Your Oracle E-Business Suite Cloud Manager administrator password.

    • The load balancer configured for the environment. The script displays a list of the load balancers that are registered in the load balancer subnet within the specified network profile. If this environment uses multiple zones for the application tier and has more than one load balancer, enter the list of load balancer names separated by commas.

    • The listener for the environment. The script displays a list of the listeners configured for the specified load balancer. If this environment uses more than one listener, enter the list of listener names separated by commas.

  5. If you need to check the status of a discovery job, run the discovery-status.js script using the following commands.

    $ cd /u01/install/APPS/apps-unlimited-ebs/bin/rediscovery
    $ node discovery-status.js

    When prompted, specify the discovery job ID assigned by the discover-environment.js script and your Oracle E-Business Suite Cloud Manager administrator password.

    Tip: The discover-environment.js script may take some time to complete. If you want to check the progress of a discovery job that is still running, open a separate terminal window to run the discovery-status.js script without disrupting the running discovery job.

  6. After the discovery job completes successfully, log into Oracle E-Business Suite Cloud Manager and verify the updated information for the environment in the environment details page. See Access Oracle E-Business Suite Cloud Manager and Review Environment Details (Standard).

  7. If a discovery job failed, you must withdraw the failed discovery request before retrying discovery. To withdraw a request, run the withdraw-discover.js script using the following commands.

    $ cd /u01/install/APPS/apps-unlimited-ebs/bin/rediscovery
    $ node withdraw-discover.js

    When prompted, specify the name of the failed discovery request, your Oracle Identity Cloud Service user name and password, and your Oracle E-Business Suite Cloud Manager administrator password.

    After you have withdrawn the previous discovery request and corrected any issues that caused the discovery to fail, you can retry discovery by rerunning the discover-environment.js script.