Manage Oracle Database Software Images

Learn about Database Software Image resource type and how you can use it to create Oracle Databases and Oracle Database Homes and to patch databases.

Database Software Images enable you to create a customized Oracle Database software configuration that includes your chosen updates (PSU, RU or RUR), and optionally, a list of one-off (or interim) patches or an Oracle Home inventory file. This reduces the time required to provision and configure your databases, and makes it easy for your organization to create an approved "gold image" for developers and database administrators.

Creation and Storage of Database Software Images

Database software images are resources within your tenancy that you create prior to provisioning or patching an Exadata Cloud@Customer instance, a Database Home, or a database.

There is no limit on the number of database software images you can create in your tenancy, and you can create your images with any Oracle Database software version and update supported in Oracle Cloud Infrastructure.

Database software images are automatically stored in Oracle-managed Object Storage and can be viewed and managed in the Oracle Cloud Infrastructure Console. Note that database software images incur Object Storage usage costs. Database software image are regional-level resources and can be accessed from any availability domain within their region.

For information on creating an image, see Using the Console to Create a Database Software Image.

Using a Database Software Image with an Exadata Cloud@Customer System

Create, save, and reuse an Oracle Database Software Image.

Creating an Oracle Database Software Image enables you to:
  • Create custom Database Home images based on Database Software Images, RU/RUR, and one-off patches.
  • Save a custom image automatically to Object Storage as a resource.
  • Use a Database Software Image to create Database Homes.
  • Patch the Database Home created using the Database Software Image.
  • Clone Database Software Image to another service in the Data Guard creation process.

Provisioning: After you create a database software image, you can use it to create an Oracle Database Home in an Exadata Cloud@Customer system. For more information, see Using the Console to Create Oracle Database Home on Exadata Cloud@Customer.

Patching: To patch a database in an Exadata Cloud@Customer system using a custom database software image, create the Database Home using the image, and then move the database to that Database Home. For more information, see Patching an Exadata Cloud @Customer System.

Setting up Data Guard: When creating an Oracle Data Guard association, the custom Database Software Image associated with the primary database will be used to create a Database Home for the new standby. If the Database Software Image used by the primary database is no longer available, then enable Data Guard operation will not proceed. For more information, see Using Oracle Data Guard with Exadata Cloud@Customer.

Note

The Database Software Images are created and managed by the customer and they are available for use until explicitly deleted.

Using the Console to Create a Database Software Image

To create an Oracle Database Software Image with the console, use this procedure.

  1. Open the navigation menu. Under Oracle Database, click Exadata Cloud@Customer.
  2. Under Resources, click Database Software Images.
  3. Click Create Database Software Image.
  4. In the Display name field, provide a display name for your image. Avoid entering confidential information.
  5. Choose your Compartment.
  6. Choose the Database version for your image.
  7. Choose the patch set update, proactive bundle patch, or release update. For information on Oracle Database patching models, see Release Update Introduction and FAQ (Doc ID 2285040.1).
  8. Optionally, you can enter a comma-delimited list of one-off (interim) patch numbers.
  9. Optionally, you can upload an Oracle Home inventory file from an existing Oracle Database. For more information, see Using the OPatch lsinventory Command to Verify the Patches Applied to an Oracle Home.
  10. Click Show Advanced Options to add tags to your database software image. To apply a defined tag, you must have permission to use the tag namespace. For more information about tagging, see Resource Tags. If you are not sure if you should apply tags, skip this option (you can apply tags later) or ask your administrator.
  11. Click Create Database Software Image.

Using the OPatch lsinventory Command to Verify the Patches Applied to an Oracle Home

OPatch utility enables you to apply the interim patches to Oracle Database software. You can find opatch utility in the $ORACLE_HOME/Opatch directory.

  1. Run the opatch lsinventory command to get the list of interim patches applied.
    $ORACLE_HOME/OPatch/opatch lsinventory
    Oracle Interim Patch Installer version 12.2.0.1.21
    Copyright (c) 2021, Oracle Corporation. All rights reserved.
    
    Oracle Home : /u02/app/oracle/product/19.0.0.0/dbhome_2
    Central Inventory : /u01/app/oraInventory
    from : /u02/app/oracle/product/19.0.0.0/dbhome_2/oraInst.loc
    OPatch version : 12.2.0.1.21
    OUI version : 12.2.0.7.0
    Log file location : /u02/app/oracle/product/19.0.0.0/dbhome_2/cfgtoollogs/opatch/opatch2021-01-21_09-22-45AM_1.log
    
    Lsinventory Output file location : /u02/app/oracle/product/19.0.0.0/dbhome_2/cfgtoollogs/opatch/lsinv/lsinventory2021-01-21_09-22-45AM.txt
  2. Use the lsinventory output file to extract the additional One Off Patches applied to a specific Oracle Home.

Using the Console to Delete a Database Software Image

  1. Open the navigation menu. Under Oracle Database, click Exadata Cloud@Customer.
  2. Under Resources, click Database Software Images.
  3. In the list of database software images, find the image you want to delete and click the action icon (three dots) at the end of the row.
  4. Click Delete.
  5. Enter the Database Software Image name to confirm the deletion and click Delete Database Software Image.

Using the Console to View the Patch Information of a Database Software Image

To view the Oracle Database version, update information (PSU/BP/RU level), and included one-off (interim) patches of a database software image, use the following instructions:

  1. Open the navigation menu. Under Oracle Database, click Exadata Cloud@Customer.
  2. Under Resources, click Database Software Images.
  3. In the list of database software images, find the image you want to view and click on the display name of the image.
  4. On the Database Software Image Details page for your selected image, details about the image are displayed:
    • The Oracle Database version is displayed in the General Information section. For example: 19.0.0.0
    • The PSU/BP/RU field of the Patch Information section displays the update level for the image. For example: 19.5.0.0
    • The One-Off Patches field displays the number of one-off patches included in the image if any. The count includes all patches specified when creating the image (excluding patches listed in lsinventory). To view the included patches (if any are included), click the Copy All link and paste the list of included patches into a text editor. The copied list of patch numbers is comma-delimited and can be used to create additional Database Software Images.

Using the Console to Move Database Software Image to a Different Compartment

Follow these steps to move a Database Software Image to a different compartment of your choice:

  1. Open the navigation menu. Under Oracle Database, click Exadata Cloud@Customer.
  2. Under Resources, click Database Software Images.
  3. In the list of database software images, find the image you want to delete and click the action icon (three dots) at the end of the row.
  4. Click Move Resource.
  5. Choose a new compartment in the Move Resource to a Different Compartment dialog.
  6. Click Move Resource.

Using the API for Managing Oracle Database Software Images

Review the list of API calls to manage Oracle Database Software Image.

For information about using the API and signing requests, see "REST APIs" and "Security Credentials". For information about SDKs, see "Software Development Kits and Command Line Interface".

Use these API operations to manage Database Software Images:
  • CreateDatabaseSoftwareImage
  • ListDatabaseSoftwareImages
  • GetDatabaseSoftwareImage
  • DeleteDatabaseSoftwareImage
  • ChangeDatabaseSoftwareImageCompartment

For the complete list of APIs, see "Database Service API".