Register an Oracle Database on a Compute Instance

You can register Oracle databases on compute instances as target databases in Oracle Data Safe.

In Oracle Data Safe, use the Oracle databases on compute wizard to register the following databases:

  • Oracle database on a compute instance in Oracle Cloud Infrastructure
  • Oracle database on a compute instance in a non-Oracle cloud environment (for example, Amazon Web Services)

Note:

Be sure to complete the preregistration tasks before using the wizard and the post-registration tasks afterward.

Preregistration Tasks

The following table lists the preregistration tasks before you run the Oracle databases on compute registration wizard.

Task Number Task Link to Instructions
1 In Oracle Cloud Infrastructure Identity and Access Management (IAM), obtain permissions to register an Oracle database on a compute instance. Permissions to Register an Oracle Database on a Compute Instance with Oracle Data Safe
2 Create an Oracle Data Safe service account on your target database and grant it Oracle Data Safe roles. Create the service account as the SYS user.

Create an Oracle Data Safe Service Account on Your Database and Grant Roles to the Oracle Data Safe Service Account on Your Target Database
3 (Optional) If you plan to connect to the target database via an Oracle Data Safe private endpoint and want to configure a TLS connection, create a wallet or certificates. Create a Wallet or Certificates for a TLS Connection

Run the Oracle Databases on Compute Wizard

The following sections detail the workflow for the Oracle databases on compute registration wizard.

Step 1: Select database

  1. On the Overview page in Oracle Data Safe, find Oracle databases on compute, and then select Start wizard.
    The wizard opens on step 1, Select database.
  2. Select Oracle Cloud Infrastructure or AWS or other cloud environment.
  3. (Oracle Cloud Infrastructure) For Select compute instance compartment and Select compute instance, select the compute instance's compartment in OCI and the name of your compute instance.
  4. For Data Safe Target Display Name, enter a target display name that is meaningful to you. Data Safe uses this name in its reports. All characters are accepted. The maximum number of characters is 255.
  5. For Compartment, select the compartment where you want to store the target database resource. The compartment doesn't need to be the same compartment where the database is stored.
  6. (Optional) For Description, enter a description that is meaningful to you.
  7. For Database service name, enter the service name of the PDB or CDB.
  8. (AWS or other cloud environment) For Database IP address, enter the IP address of the database.
  9. For Database port number, enter the port number used by your database listener.
  10. If you did not already grant roles to the database user during the preregistration tasks, select Download privilege script and save the datasafe_privileges.sql script to your computer. The script includes instructions on how to use it to grant privileges to the Oracle Data Safe service account on your target database. You should also refer to the preregistration task Grant Roles to the Oracle Data Safe Service on a Non-Autonomous AI Database for additional details.
  11. For Database user name and Database password, enter the name and password of the user you created in the preregistration tasks. If the user name is mixed case, enclose it in double-quotes (" "). Oracle Data Safe uses this account to connect to the database.
  12. (Optional) To add a tag to organize and track this resource in your tenancy, select Add tag. Select a namespace, select a key, and enter a key value.
  13. Select Next.

Step 2: Connectivity option

In this step, choose to connect to the target database through either an Oracle Data Safe on-premises connector or an Oracle Data Safe private endpoint.

Consider the following recommendations:

  • For an Oracle database on a compute instance in Oracle Cloud Infrastructure: Oracle recommends that you use an Oracle Data Safe private endpoint to connect your target database to Oracle Data Safe.
  • For an Oracle database on a compute instance in a non-Oracle cloud environment (for example, in Amazon Web Services or Azure): Oracle recommends that you use an Oracle Data Safe on-premises connector to connect your target database to Oracle Data Safe. You can use a private endpoint, however, to do so you need an existing FastConnect or VPN Connect set up between Oracle Cloud Infrastructure and your non-Oracle cloud environment. The private endpoint then needs to be created in the Virtual Cloud Network (in Oracle Cloud Infrastructure) that has access to your target database. Without this setup, Oracle recommends that you use an on-premises connector instead.
  1. For Choose a connectivity option, select On-premises connector or Private endpoint.
  2. If you are using a private endpoint, for TCP/TLS, select TCP or TLS as the network protocol. If you select TLS, you need to perform the following additional steps:
    1. Select One way TLS or Mutual TLS.
    2. If you select One way TLS, upload the TrustStore of your database in PEM, PKCS#12 wallet, or JKS wallet format. You can also enter the wallet password if required. This file is required whether client authentication is enabled or disabled on your target database.
    3. If you select Mutual TLS, upload the TrustStore of your database in the format of PEM file, PKCS#12 wallet, or JKS wallet and enter the wallet password. This file is required whether client authentication is enabled or disabled on your target database. When client authentication is enabled on your target database, upload the KeyStore of your database in the format of PEM file, PKCS#12 wallet, or JKS wallet. This file is not required when client authentication is disabled.
  3. At Do you want to use an existing on-premises connector (or private endpoint)?, toggle Yes or No.
    • If Yes: Select the compartment where the on-premises connector (or private endpoint) resides, and then select the on-premises connector (or private endpoint). Note that a private endpoint needs to be in a VCN that can access your on-premises database.
    • If No: For a private endpoint, enter a display name, select a compartment to store the private endpoint, select a virtual network compartment and virtual cloud network, select a subnet compartment and subnet, and optionally enter a private IP address. For an on-premises connector, select a compartment to store the on-premises connector, enter name for the on-premises connector, and enter a description.
  4. Select Next.

Step 3: Add peer database

If you're registering an Active Data Guard associated database, then you can add peer databases during this step.

It is also possible to register peer databases after you register the primary database. See Manage Peer Databases Associated with a Registered Active Data Guard Primary Database.

  1. If you're not registering an Active Data Guard associated database, select Next to skip this step.
  2. For each peer database that you want to add, provide the following information as needed:
    • Peer display name
    • Database service name
    • Database IP address
    • Database port number
    • TCP or TLS
    • If you are configuring a TLS connection, select a TLS type (One way TLS or Mutual TLS). For Mutual TLS, upload a truststore wallet, upload a keystore wallet, and enter the wallet password. For One way TLS, upload a truststore wallet and enter the wallet password.
  3. Select Add row.
  4. Repeat steps 2 and 3 to add additional peer databases.
  5. Select Next.

Step 4: Add security rule

This step applies if you are using an Oracle Data Safe private endpoint. To allow communication between an Oracle database on a compute instance and an Oracle Data Safe private endpoint, you must create both an ingress security rule and an egress security rule in Oracle Cloud Infrastructure (OCI). If the database is in a non-Oracle cloud environment, configure the ingress security rule in the non-Oracle Cloud environment. You can allow the wizard to create the rules for you, create them manually in OCI (see Security Rules for Oracle Databases on Compute Instances), or skip this step if you already have security rules you want to use. The ingress and egress rules do not need to be in the same security list, network security group (NSG), or compartment. The target database remains inactive in Oracle Data Safe until the required security rules are configured.

See Also:

For more information about security lists and network security groups, see Access and Security in the Oracle Cloud Infrastructure documentation.
  1. To bypass security rule configuration, select No.
  2. To allow the wizard to configure the security rules, select Yes. For both the ingress and egress security rule configuration, select Security list or Network security group, and then select the name of the security list or NSG. You can change the compartment if needed. The wizard displays the rules that will be added.

    Note:

    If you add peer databases during registration, the same egress rule is created for the database and each peer database.
  3. Select Next to continue in the wizard.

Step 5: Review and submit

The Review and submit page displays the configuration for the previous steps in the wizard.

To review the target database configuration:
  1. If the information is correct, select Register.
  2. If the information is incorrect, select Previous to return to any of the earlier steps, or select Close to cancel the registration.

Step 6: Registration progress

After you select Register in the wizard, you can monitor the progress of the target registration. Each task is listed and processed sequentially. If any errors occur, they are displayed. You can select Previous to return to earlier pages and correct them.

Important:

Do not select the Close button in the wizard, sign out of OCI, or close the browser tab until the wizard shows that all of the tasks listed are resolved. If you close prematurely, then the information for all of the tasks that have not yet been completed is lost and the target database is not registered.

If there is no further work to do, the registration completes, and the wizard presents the Target database information page. Here you can again review the registration details and complete any post-registration tasks as required.

Post Registration Tasks

The following table lists the tasks you need to complete after you run the Oracle databases on compute registration wizard.

Task Number Task Link to Instructions
1

(If you are using an Oracle Data Safe on-premises connector) Download the install bundle for the on-premises connector and then install the on-premises connector on a host machine on your network.

Create an Oracle Data Safe On-Premises Connector
2 (If you are using a TLS connection and an Oracle Data Safe on-premises connector) Configure a TLS connection between the on-premises connector and your target database. Configure a TLS Connection Between the On-Premises Connector on Your Host Machine and Your Database
3

(Optional) Change which features are allowed for the Oracle Data Safe service account on your target database by granting/revoking roles from the account. You need to be the SYS user.

Grant Roles to the Oracle Data Safe Service Account on Your Target Database
4

(Optional) Grant users access to Oracle Data Safe features with the target database by configuring policies in Oracle Cloud Infrastructure Identity and Access Management.

Create IAM Policies for Oracle Data Safe Users
5 Make sure the firewall of the compute instance is configured to allow ingress traffic from the Oracle Data Safe private endpoint or Oracle Data Safe on-premises connector. (none)