Oracle Key Vault Installation and Configuration

4 Oracle Key Vault Installation and Configuration

Installing Oracle Key Vault entails ensuring that the environment meets the necessary requirements before you begin the installation and configuration.

About Oracle Key Vault Installation and Configuration
Oracle Key Vault is a software appliance that is delivered as an ISO image.
Oracle Key Vault Installation Requirements
The Oracle Key Vault installation requirements cover system requirements such as CPU, memory, disk space, network interfaces, and supported endpoint platforms.
Installing and Configuring Oracle Key Vault
You must download the Oracle Key Vault application software, and then you can perform the installation.
Logging In to the Oracle Key Vault Management Console
To use Oracle Key Vault, you can log in to the Oracle Key Vault management console.
Upgrading a Standalone or Primary-Standby Oracle Key Vault Server
This upgrade includes the Oracle Key Vault server software and utilities that control the associated endpoint software.
Upgrading Oracle Key Vault in a Multi-Master Cluster Environment
Similar to a standalone or primary-standby upgrade, this type of upgrade includes the Oracle Key Vault server software and endpoint software-related utilities.
Overview of the Oracle Key Vault Management Console
The Oracle Key Vault management console provides a graphical user interface for System Administrators, Key Administrators, and Audit Managers.
Performing Actions and Searches
The Oracle Key Vault management console enables you to perform standard actions and search operations, as well as get help information.

4.1 About Oracle Key Vault Installation and Configuration

Oracle Key Vault is a software appliance that is delivered as an ISO image.

The software appliance consists of a pre-configured operating system, an Oracle database, and the Oracle Key Vault application. You must install Oracle Key Vault onto its own dedicated server.

Before you begin the installation or upgrade process for Oracle Key Vault, check the Oracle Key Vault Release Notes for any known issues that you should be aware of.

Parent topic: Oracle Key Vault Installation and Configuration

4.2 Oracle Key Vault Installation Requirements

The Oracle Key Vault installation requirements cover system requirements such as CPU, memory, disk space, network interfaces, and supported endpoint platforms.

System Requirements
System requirements include CPU, memory, disk, network interface, hardware compatibility, and RESTful services client.
Network Port Requirements
Network port requirements includes requirements for SSH/SCP, SNMP, HTTPS, listeners, KMIP, and TCP ports.
Supported Endpoint Platforms
Oracle Key Vault supports both UNIX and Windows endpoint platforms.
Endpoint Database Requirements
For endpoints, Oracle Key Vault supports Oracle Database release 10 and later.

Parent topic: Oracle Key Vault Installation and Configuration

4.2.1 System Requirements

System requirements include CPU, memory, disk, network interface, hardware compatibility, and RESTful services client.

The Oracle Key Vault installation removes existing software on a server.

Deployment on virtual machines is not recommended for production systems. However, virtual machines are useful for testing and proof of concept purposes.

The minimum hardware requirements for deploying the Oracle Key Vault software appliance are:

CPU: Minimum: x86-64 16 cores. Recommended: 24-48 cores with cryptographic acceleration support (Intel AESNI).
Memory: Minimum 16 GB of RAM. Recommended: 32–64 GB.
Disk: Minimum 2 TB. Recommended: 4 TB.
Network interface: One network interface.
Hardware Compatibility: Refer to the hardware compatibility list (HCL) for Oracle Linux Release 6 Update 10 at the link in the Related Topics section.

Note:
You can find the supported hardware from the hardware certification list for Oracle Linux and Oracle VM. Filter the results by selecting All Operating Systems and choosing Oracle Linux 6.10. However, be aware that Oracle Key Vault does not support the QLogic QL4* family of network cards.

Oracle Key Vault supports both Legacy BIOS and UEFI BIOS boot modes. The support for UEFI BIOS mode allows the installation of Oracle Key Vault on servers that exclusively support UEFI BIOS only, such as Oracle X7-2 Server. Oracle Key Vault can be installed on Oracle X7–2 servers as a standalone server, a primary-standby configuration, or a multi-master cluster configuration.
RESTful Services Client: If RESTful Services are enabled, then each endpoint that connects to the Oracle Key Vault management console must have at least Java 1.7.0.21 installed.

The REST API requires the cURL utility. Ensure that you have installed a cURL version that supports Transport Layer Security (TLS) 1.2 or later on the endpoint before using the REST API to provision endpoints.

Note:

For deployment with a large number of endpoints, the hardware requirement may need to scale to meet the workload.

Related Topics

Hardware Certification List for Oracle Linux and Oracle VM

Parent topic: Oracle Key Vault Installation Requirements

4.2.2 Network Port Requirements

Network port requirements includes requirements for SSH/SCP, SNMP, HTTPS, listeners, KMIP, and TCP ports.

Oracle Key Vault and its endpoints use a set of specific ports for communication. Network administrators must ensure that these ports are open in the network firewall.

The following table lists the required network ports for Oracle Key Vault:

Table 4-1 Ports Required for Oracle Key Vault

Port Number	Protocol	Descriptions
`22`	SSH/SCP port	Used by Oracle Key Vault administrators and support personnel to remotely administer Oracle Key Vault
`161`	SNMP port	Used by monitoring software to poll Oracle Key Vault for system information
`443`	HTTPS port	Used by web clients such as browsers and RESTful Administrative commands to communicate with Oracle Key Vault
`5695`	HTTPS port	Used by RESTful Key Management commands to communicate with Oracle Key Vault
`1521` and `1522`	Database TCPS listener ports	In a primary-standby configuration, listener ports used by Oracle Data Guard to communicate between the primary and standby server. In a cluster configuration, listener ports used to communicate between read-write peer nodes.
`7443`	HTTPS port	Listener port used in a primary-standby configuration to run OS commands like synchronizing wallets and configuration files through HTTPS. This port is also used when you add a new node to a cluster.
`5696`	KMIP port	Used by Oracle Key Vault endpoints and third party KMIP clients to communicate with the Oracle Key Vault KMIP Server
`7093`	TCP port	Used by Oracle GoldenGate for transmitting data in a Multi-Master Cluster configuration.

Parent topic: Oracle Key Vault Installation Requirements

4.2.3 Supported Endpoint Platforms

Oracle Key Vault supports both UNIX and Windows endpoint platforms.

Oracle supports 64-bit Linux endpoints, and only 64-bit endpoints are supported for Oracle databases that use the online master key. The operating systems on which the endpoint runs must be compatible with Transport Layer Security (TLS) 1.2, either directly or with appropriate patches.

The supported endpoint platforms in this release are as follows:

Oracle Linux (6 and 7)
Oracle Solaris (10 and 11)
Oracle Solaris Sparc (10 and 11)
RHEL 6 and 7
IBM AIX (6.1, and 7.1) and AIX 5.3 in a limited capacity
HP-UX (IA) (11.31)
Windows Server 2012

Parent topic: Oracle Key Vault Installation Requirements

4.2.4 Endpoint Database Requirements

For endpoints, Oracle Key Vault supports Oracle Database release 10 and later.

Administrators who manage endpoints that are Oracle Database 10g release 2 and later can use the okvutil upload command to upload Oracle wallets to Oracle Key Vault. Administrators who manage endpoints that are Oracle Database 11g release 2 and later can use the online master key to manage TDE master encryption keys.

Administrators who manage endpoints that are Oracle Database may need to set the COMPATIBLE initialization parameter.

For an endpoint that is Oracle Database release 11.2 or 12.1, set the COMPATIBLE initialization parameter to 11.2.0.0 or later. A COMPATIBLE setting of 11.2 or later enables Transparent Data Encryption to work with Oracle Key Vault. For example:

SQL> ALTER SYSTEM SET COMPATIBLE = '11.2.0.0' SCOPE=SPFILE;

This applies to an Oracle Database endpoint that use the online master key to manage TDE master encryption keys. This compatibility mode setting is not required for Oracle wallet upload or download operations.

Also note that after setting the COMPATIBLE parameter to 11.2.0.0, you cannot set it to a lower value such as 10.2. After you set the COMPATIBLE parameter, you must restart the database.

Related Topics

Oracle Database Administrator’s Guide

Parent topic: Oracle Key Vault Installation Requirements

4.3 Installing and Configuring Oracle Key Vault

You must download the Oracle Key Vault application software, and then you can perform the installation.

Downloading the Oracle Key Vault Appliance Software
You can download executable files for both a fresh Oracle Key Vault installation or an upgrade.
Installing the Oracle Key Vault Appliance Software
The Oracle Key Vault installation process installs all the required software components onto a dedicated server.
Performing Post-Installation Tasks
After you install Oracle Key Vault, you must complete a set of post-installation tasks.

Parent topic: Oracle Key Vault Installation and Configuration

4.3.1 Downloading the Oracle Key Vault Appliance Software

You can download executable files for both a fresh Oracle Key Vault installation or an upgrade.

For a fresh installation, you can download the Oracle Key Vault appliance software from Software Delivery Cloud. You cannot use this package to upgrade Oracle Key Vault. For an upgrade, you can download the Oracle Key Vault upgrade software from the My Oracle Support website.

Use a web browser to access the Oracle Software Delivery Cloud portal:
```
https://edelivery.oracle.com
```
Click Sign In, and if prompted, enter your User ID and Password.
In the All Categories menu, select Release. In the next field, enter Oracle Key Vault and then click Search.
From the list that is displayed, select Oracle Key Vault 21.1.0.0.0 or click the +Add to Cart button next to the Oracle Key Vault 21.1.0.0.0.
The download is added to your cart. (To check the cart contents, click View Cart in the upper right of the screen.)
Click Checkout.
On the next page, verify the details of the installation package, and then click Continue.
In the Oracle Standard Terms and Restrictions page, select I have reviewed and accept the terms of the Commercial License, Special Programs License, and/or Trial License, and click Continue.
The download page appears, which lists the following Oracle Key Vault ISO files:
- Vpart_number.iso (Oracle Key Vault 21.1.0.0.0 - Part 1)
- Vpart_number.iso (Oracle Key Vault 21.1.0.0.0 - Part 2)
- Vpart_number.iso (Oracle Key Vault 21.1.0.0.0 - Part 3)
- Vpart_number.iso (Oracle Key Vault 21.1.0.0.0 - Part 4)
To the right of the Print button, click View Digest Details.

The listing for the ISO files expands to display the SHA-1 and SHA-256 checksum reference numbers for each ISO file.
Copy the SHA-256 checksum reference numbers and store them for later reference.
Click Download and select a location to save the ISO files.
You can save each file individually by clicking its name and then specifying a location for the download.
Click Save.

The combined size of the ISO files exceeds 4 GB, and will take time to download, depending on the network speed. The estimated download time and speed are displayed in the File Download dialog box.
After the ISO files are downloaded to the specified location, verify the SHA-256 checksums of the downloaded files:
1. Generate a SHA256 checksum for the first Vpart_number.iso:
```
$ sha256sum Vpart_number.iso
```
  Ensure that the checksum matches the value that you copied from the File Download dialog box in 9.
2. Generate a SHA-256 checksum for the second Vpart_number.iso:
```
$ sha256sum Vpart_number.iso
```
  Ensure that the checksum matches the value that you copied from the File Download dialog box in 9.

Unzip the downloaded files and concatenate the .iso files to one .iso image

cat okv_21.1_installer_disc_part1.iso okv_21.1_installer_disc_part2.iso okv_21.1_installer_disc_part3.iso okv_21.1_installer_disc_part4.iso > okv_21.1_installer_disc.iso

Transfer the concatenated .iso image by using one of the following methods:
- Burn the concatenated .iso image onto a bootable DVD.
- Copy the concatenated .iso image onto a bootable USB stick.
- Mount the concatenated .iso image with your virtualization software, in order to run Oracle Key Vault as a virtual machine, booting from the concatenated .iso image.

You now can install Oracle Key Vault on the server.

Parent topic: Installing and Configuring Oracle Key Vault

4.3.2 Installing the Oracle Key Vault Appliance Software

The Oracle Key Vault installation process installs all the required software components onto a dedicated server.

The installation process may take from 30 minutes or longer to complete, depending on the server resources where you are installing Oracle Key Vault.

Caution:

The Oracle Key Vault installation wipes the server and installs a customized Oracle Linux 6 Update 10. The installation erases existing software and data on the server.

Ensure that the server meets the recommended requirements.
Request a fixed IP address, network mask, and gateway address from your network administrator for the dedicated server. You will need this information to configure the network.

To install the Oracle Key Vault appliance:

Insert OKV Disc 1 into the DVD drive and then restart the computer.

The installation starts, and the initial screen appears.

Description of the illustration installation_01_182.png
Using the up and down arrow keys, select the desired installation option or the option to perform a memory test, and then press Enter.

Choosing Install with FIPS Mode enabled (wipes system) automatically enables FIPS mode on the system.

The installation begins and after several minutes, the message Please insert disc 2 is displayed.
Insert OKV Disc 2 into the DVD drive, and then press Enter.

The installation proceeds and after some time the message Please insert disc 1 is displayed.
Insert OKV Disc 1 into the DVD drive, and press Enter.
The installation proceeds and after some time the message Please enter installation passphrase is displayed.

Description of the illustration installation_02_bp5.png

The installation passphrase must have 8 or more characters and contain at least one of each of the following: an uppercase letter, a lowercase letter, a number, and a special character from the set: period (.), comma (,), underscore (_), plus sign (+), colon (:), exclamation mark (!). In addition, the passphrase may include a space character ( ) provided it is not used as the first or last character of the passphrase.

It is important to store the installation passphrase securely. You will need it later to authenticate yourself at the Oracle Key Vault management console, complete the post-installation tasks, and add nodes in a multi-master cluster.
Enter the installation passphrase, and then press Enter.
Confirm the installation passphrase, and then press Enter.
The message Installation passphrase was successfully configured is displayed. Press Enter. The Select Network Interface screen is displayed.

Description of the illustration installation_03_bp5.png
Select the interface and press Enter. If more than one network interface is available, select the interface that you want to serve as the management interface, and to communicate with endpoints.
The Network Selection Interface screen is displayed.

Description of the illustration installation_04_bp5.png
Press Enter.
The IP Address Setting for Management Interface Screen is displayed.

Description of the illustration installation_05_bp5.png
Enter the fixed IP address, network mask, and gateway address you received from your network administrator. Select Reboot to complete installation and press Enter.

The installer installs and configures the operating system, database, and Oracle Key Vault on the server to make it a self-contained hardened appliance. The installation and configuration process can take between 30 minutes or longer.

If the installation completed successfully, the Oracle Key Vault Server <Release Number> screen appears.

Description of the illustration os_user_pwd_change1.png
Select Display Appliance Info and press Enter to see the IP address settings for the appliance. Make a note of the IP address of the appliance. You will need it to log into the browser-based management console of Oracle Key Vault.

If you need to correct the IP Address, network mask, or the IP gateway for any reason, then you can select Change IP Settings and enter the new IP settings.

Select Set User Passwords to set the root and support user passwords. You can also set the root and support user passwords when performing the post-installation tasks, but be aware that after you set these passwords, you can only change them by using Secure Shell (SSH) on the computer on which these passwords were created.

You have the option to change the installation passphrase by selecting Change Installation Passphrase. For more information about changing the installation passphrase, see Change the Installation Passphrase.

Note:
You will need to enter the old installation passphrase in order to update the installation passphrase.

Make a note of the installation passphrase. You will need it to log into the management console for the first time, in order to complete the post-installation tasks.

Parent topic: Installing and Configuring Oracle Key Vault

4.3.3 Performing Post-Installation Tasks

After you install Oracle Key Vault, you must complete a set of post-installation tasks.

These tasks include configuring the administrative user accounts and passwords for recovery, and operating system accounts and passwords for root and support.

Use a web browser to connect to the Oracle Key Vault server.

For example, to connect in to an Oracle Key Vault server whose IP address is 192.0.2.254, enter the following in the address bar:

https://192.0.2.254
If the web browser displays a security warning message stating that you are connecting to a website with an untrusted or self-signed security certificate, accept the security warning message and proceed to connect to the Oracle Key Vault server.

This message is only temporary. When you configure third-party certificates, this message will no longer appear. After completing the post-installation tasks, you can upload a custom certificate or certificate chain that is trusted by the browser, so that you can connect to the Oracle Key Vault server without encountering the security warning message. For more information about uploading a custom certificate, see Managing Console Certificates.
The Installation Passphrase screen is displayed.

Description of the illustration install_passphrase.png

The Installation Passphrase screen is displayed when you connect to the Oracle Key Vault server for the first time, in order to complete the post-installation tasks. After you complete the post-installation tasks, the Oracle Key Vault login screen is displayed when you access the Oracle Key Vault management console through the web browser.
Enter the installation passphrase.

The Post-Install Configuration screen is displayed.

Description of the illustration screenshot-install-configuration.png
In the User Setup pane, create three administrative user accounts for the Key Administrator, System Administrator, and Audit Manager.
Description of the illustration installation_configuration-user_setup.png

In the User Setup section:
- Enter the user name and password, the full name (optional), and email (optional) for each administrative user account.
  
  Note that the passwords are one-time use passwords which must be changed when the user logs in the first time.
- Ideally, create a different user account for each of these administrative roles for a strict separation of duties, or combine roles as necessary.
- Ensure that passwords have 8 or more characters and contain at least one of each of the following: an uppercase letter, a lowercase letter, a number, and a special character from the set: period (.), comma (,), underscore (_), plus sign (+), colon (:), exclamation mark (!). In addition, the passphrase may include a space character ( ) provided it is not used as the first or last character of the passphrase.
In the Recovery Passphrase section, create the recovery password.
Description of the illustration installation_configuration-recovery_passphrase.png

The recovery passphrase has the same minimum requirements as user passwords. For greater security, Oracle recommends that you make the recovery passphrase longer and more complex. Because this is a critical password, you must properly secure and safeguard the recovery password. The recovery password is required in the following scenarios:
- In an emergency, when there are no administrative users available to access Oracle Key Vault
- To restore Oracle Key Vault data from a backup
- To reset the recovery password
- Induct a new node into a multi-master cluster
- To configure a hardware security module (HSM)
Caution:
It is important to establish a secure process for the storage and retrieval of the recovery passphrase, including older recovery passphrases. The only way to recover from a lost recovery passphrase is to re-install Key Vault. Be aware that if you enter either of these passwords incorrectly three times in a row, then the account is locked for 15 minutes.
Set the root and support user passwords if you did not set the passwords using the Set User Passwords option on the Oracle Key Vault Server screen in the previous procedure, Installing the Oracle Key Vault Appliance Software.

Description of the illustration installation_configuration-root_support_user_passwords.png

The root password is the super user account for the operating system hosting Oracle Key Vault. You will need the support password to log into Oracle Key Vault remotely using the SSH protocol.

Caution:
Keep the root and support user passwords safe because these passwords are set during post-installation only. After post-installation you cannot change them from the Oracle Key Vault management console.

The Time Setup and DNS Setup settings are optional at this stage. The System Administrator can configure these later on.
Click Save in the upper right corner of the Post-Install Configuration screen.

The Oracle Key Vault management console login screen is displayed.

Description of the illustration ep_enroll_sw_dwnload.png

You can now log in to the Oracle Key Vault management console with the credentials of any of the user accounts that were created during the post-installation process.

4.4 Logging In to the Oracle Key Vault Management Console

To use Oracle Key Vault, you can log in to the Oracle Key Vault management console.

Open a web browser.
Connect using an HTTPS connection and the IP address of Oracle Key Vault.

For example, to log in to a server whose IP address is 192.0.2.254, enter:

https://192.0.2.254
After the login screen appears, enter your user name and password.
Click Login.

Parent topic: Oracle Key Vault Installation and Configuration

4.5 Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

This upgrade includes the Oracle Key Vault server software and utilities that control the associated endpoint software.

About Upgrading the Oracle Key Vault Server Software
When you upgrade the Oracle Key Vault server software appliance, also upgrade the endpoint software to get access to the latest enhancements.
Step 1: Back Up the Server Before You Upgrade
Before you upgrade the Oracle Key Vault server, perform a one-time backup to a remote destination so that you can recover data in case the upgrade fails.
Step 2: Perform Pre-Upgrade Tasks
To ensure a smooth upgrade to Oracle Key Vault, you should prepare the server you are upgrading.
Step 3: Upgrade the Oracle Key Vault Server or Server Pair
You can upgrade a standalone Oracle Key Vault server or a pair of Oracle Key Vault servers in a primary-standby deployment.
Step 4: Upgrade the Endpoint Software
As part of the upgrade, you must reenroll endpoints created in earlier releases of Oracle Key Vault, or update the endpoint software.
Step 5: Re-download the RESTful Software Utility
After you complete the upgrade, you must re-download the okvrestservices.jar file, even if you have already downloaded it in previous releases.
Step 6: If Necessary, Remove Old Kernels
Oracle recommends that you clean up the older kernels that were left behind after the upgrade.
Step 7: If Necessary, Add Disk Space to Extend Swap Space
If you upgraded from an earlier release, you should extend swap space to accommodate the new Oracle Key Vault software.
Step 8: If Necessary, Remove SSH-Related DSA Keys
You should remove SSH-related DSA keys left behind after the upgrade, because they can cause problems with some code analysis tools.
Step 9: Back Up the Upgraded Oracle Key Vault Server
You must perform server backup and user password tasks after completing a successful upgrade.

Parent topic: Oracle Key Vault Installation and Configuration

4.5.1 About Upgrading the Oracle Key Vault Server Software

When you upgrade the Oracle Key Vault server software appliance, also upgrade the endpoint software to get access to the latest enhancements.

However, the endpoint software downloaded from the previous Oracle Key Vault release will continue to function with the upgraded Oracle Key Vault server.

You must upgrade in the order shown: first perform a full backup of Oracle Key Vault, upgrade the Oracle Key Vault server or server pair in the case of a primary-standby deployment, the endpoint software, and last, perform another full backup of the upgraded server. Note that upgrading requires a restart of the Oracle Key Vault server.

The Oracle Key Vault server is not available to endpoints for a limited duration during the upgrade. You can enable the persistent cache feature to enable endpoints to continue operation during the upgrade process.

Before you begin the upgrade, refer to Oracle Key Vault Release Notes for additional information about performing upgrades.

4.5.2 Step 1: Back Up the Server Before You Upgrade

Before you upgrade the Oracle Key Vault server, perform a one-time backup to a remote destination so that you can recover data in case the upgrade fails.

Caution:

Do not bypass this step. Back up the server before you perform the upgrade so that your data is safe and recoverable.

Related Topics

Oracle Database Backup and Recovery User’s Guide

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.5.3 Step 2: Perform Pre-Upgrade Tasks

To ensure a smooth upgrade to Oracle Key Vault, you should prepare the server you are upgrading.

Use SSH to log in to the server where Oracle Key Vault is installed.
Ensure that the server meets the minimum disk space requirement for an upgrade. If the /usr/local/dbfw/tmp directory does not have sufficient free space, then delete any diagnostics .zip files that maybe stored in that directory.
To increase available disk space, remove the temporary jar files located in /usr/local/okv/ssl. Be careful in doing so. If you accidentally delete any files other than the jar files in /usr/local/okv/ssl, then the Oracle Key Vault server becomes non-functional.
Ensure that no full or incremental backup jobs are running. Delete all scheduled full or incremental backup jobs before the upgrade.

Plan for downtime according to the following specifications:

Oracle Key Vault Usage	Downtime Required
Wallet upload or download	YES
Java Keystore upload or download	YES
Transparent Data Encryption (TDE) direct connect	YES (NO with persistent cache)

Plan for downtimes:
- If Oracle Key Vault uses an online master key, then plan for a downtime of 15 minutes during the Oracle Database endpoint software upgrades. Database endpoints can be upgraded in parallel to reduce total downtime.
- For a primary server upgrade in a primary-standby deployment, plan for a downtime of a few hours. The persistent cache allows you to upgrade Oracle Key Vault servers without database downtime. The default duration of the persistent cache from the moment the Oracle Key Vault server becomes unavailable is 1,440 minutes (one day).
Set the $OKV_HOME to the location where endpoint is installed so that the upgrade process for the endpoint software can complete successfully.
If the Oracle Key Vault system has a syslog destination configured, ensure that the remote syslog destination is reachable from the Oracle Key Vault system, and that logs are being correctly forwarded. If the remote syslog destination is not reachable from the Oracle Key Vault system, then the upgrade process can become much slower than normal.

Related Topics

Configuring the Syslog Destination for Individual Multi-Master Cluster Nodes

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.5.4 Step 3: Upgrade the Oracle Key Vault Server or Server Pair

You can upgrade a standalone Oracle Key Vault server or a pair of Oracle Key Vault servers in a primary-standby deployment.

About Upgrading an Oracle Key Vault Server or Server Pair
You can deploy Oracle Key Vault as a standalone server in test and development environments or in a primary-standby configuration in production environments.
Upgrading a Standalone Oracle Key Vault Server
A single Oracle Key Vault server in a standalone deployment is the most typical deployment in test and development environments.
Upgrading a Pair of Oracle Key Vault Servers in a Primary-Standby Deployment
You should allocate several hours to upgrade the primary server after upgrading the standby.

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.5.4.1 About Upgrading an Oracle Key Vault Server or Server Pair

You can deploy Oracle Key Vault as a standalone server in test and development environments or in a primary-standby configuration in production environments.

In a standalone deployment you must upgrade a single Oracle Key Vault server, but in a primary-standby deployment you must upgrade both primary and standby Oracle Key Vault servers. Note that persistent caching enables endpoints to continue to be operational during the upgrade process.

Note:

If you are upgrading from a system with 4 GB memory, first add an additional 12 GB memory to the system before upgrading.

Related Topics

About the Persistent Master Encrption Key Cache

Parent topic: Step 3: Upgrade the Oracle Key Vault Server or Server Pair

4.5.4.2 Upgrading a Standalone Oracle Key Vault Server

A single Oracle Key Vault server in a standalone deployment is the most typical deployment in test and development environments.

Ensure that you have backed up the server you are upgrading so your data is safe and recoverable.
Do not proceed without completing this step.
Log into the Oracle Key Vault management console as a user who has the System Administrator role.
Ensure that SSH access is enabled.

Log in to the Oracle Key Vault management console as a user who has the System Administrator role. Select the System Settings tab, then under Network Services, select SSH Access. Select IP address(es) and then enter only the IP addresses that you need. Click Save.
Ensure you have enough space in the destination directory for the upgrade ISO files.
Log in to the Oracle Key Vault server through SSH as user support, then switch user su to root.
If the SSH connection times out while you are executing any step of the upgrade, then the operation will not complete successfully. Oracle recommends that you ensure tht you use the appropriate values for the ServerAliveInterval and ServerAliveCountMax options for your SSH sessions to avoid upgrade failures.
Copy the upgrade ISO file to the destination directory using Secure Copy Protocol or other secure transmission method.
```
root# scp remote_host:remote_path/okv-upgrade-disc-new_software_release.iso /var/lib/oracle/destination_directory_for_iso_file
```
In this specification:
- remote_host is the IP address of the computer containing the ISO upgrade file
- remote_path is the directory of the ISO upgrade file

Make the upgrade accessible by using the mount command:

root# /bin/mount -o loop,ro /var/lib/oracle/okv-upgrade-disc-new_software_release.iso /images

Clear the cache using the clean all command:

root# yum -c /images/upgrade.repo clean all

Apply the upgrade with upgrade.rb command:
```
root# /usr/bin/ruby /images/upgrade.rb --confirm
```
If the system is successfully upgraded, then the command will display the following message:

Remove media and reboot now to fully apply changes.

If you see an error message, then check the log file /var/log/messages for additional information.

If you are performing an HSM upgrade using Entrust (formerly nCipher), at this point you must execute the following commands:
```
usermod -a -G nfast oracle
cd /etc/rc.d/rc5.d
mv S50nc_hardserver S40nc_hardserver
cd /etc/rc.d/rc3.d
mv S50nc_hardserver S41nc_hardserver
```
Restart the Oracle Key Vault server by running reboot command:
```
root# /sbin/reboot
```
On the first restart of the computer after the upgrade, the system will apply the necessary changes. This can take a few hours. Do not shut down the system during this time.

The upgrade is completed when the screen with heading: Oracle Key Vault Server new_software_release appears. The revision should reflect the upgraded release. Following the heading appears the menu item Display Appliance Info. Select Display Appliance Info and press the Enter key to see the IP address settings for the appliance.
Confirm that Oracle Key Vault has been upgraded to the correct version.
1. Log in to the Oracle Key Vault management console as a user who has the System Administrator role.
2. Select the System tab, and then select Status.
3. Verify that the version displayed is the latest release number.
  The release number is also at the bottom of each page, to the right of the copyright information.
If your site uses the Commercial National Security Algorithm (CNSA) suite, then re-install these algorithms onto the standalone server.
Disable SSH access.

Log in to the Oracle Key Vault management console as a user who has the System Administrator role. Select the System Settings tab, then under Network Services, select Disabled. Click Save.

4.5.4.3 Upgrading a Pair of Oracle Key Vault Servers in a Primary-Standby Deployment

You should allocate several hours to upgrade the primary server after upgrading the standby.

You must perform the upgrade standby and primary servers in one session with as little time between the standby and primary upgrade. The upgrade time is approximate and a function of the volume of data stored and managed by Oracle Key Vault. For large volumes of data, the upgrade time may be longer than several hours.

Prepare for the upgrade.
- While the upgrade is in progress, do not change any settings or perform any other operations that are not part of the upgrade instructions below.
- Upgrade the Oracle Key Vault server during a planned maintenance window because the upgrade process requires the endpoints to be shut down during the upgrade, if no persistent cache has been configured. With persistent cache enabled, endpoints will continue to be operational during the upgrade process.
- Ensure that both the primary and standby systems have 8 GB memory.
Ensure that you have backed up the server you are upgrading so your data is safe and recoverable.
You can use Oracle Backup and Recovery (Oracle RMAN) to perform this backup. Ensure that in the time between the backup and shutting down the Oracle Key Vault servers for upgrade, that no databases perform a set or rekey operation (for example, using the ADMINISTER KEY MANAGEMENT statement), since these new keys will not included in the backup.

Do not proceed without completing this step.
First, upgrade the standby server while the primary server is running.

Follow Step 2 through to Step 10 of the standalone mode upgrade process.
Ensure that the upgraded standby Oracle Key Vault server is restarted and running.
Upgrade the primary Oracle Key Vault server following Steps 1-10 of the standalone mode upgrade.

After both the standby and primary Oracle Key Vault servers are upgraded, the two servers will automatically synchronize.
Log in to the Oracle Key Vault management console as a user with the System Administrator role.
Select the System tab, and then Status.
Verify that the Version field displays the new software version.
If your site uses the Commercial National Security Algorithm (CNSA) suite, then re-install these algrorithms onto the primary and standby servers.

4.5.5 Step 4: Upgrade the Endpoint Software

As part of the upgrade, you must reenroll endpoints created in earlier releases of Oracle Key Vault, or update the endpoint software.

If you are upgrading from an earlier release to the latest release of Oracle Key Vault, then you must reenroll the endpoint instead of upgrading the endpoint software. Reenrolling the endpoint automatically updates the endpoint software.

Ensure that you have upgraded the Oracle Key Vault servers. If you are upgrading the endpoint software for an Oracle database configured for direct-connect, then shut down the database.
Download the endpoint software (okvclient.jar) for your platform from the Oracle Key Vault server as follows:
1. Go to the Oracle Key Vault management console login screen.
2. Click the Endpoint Enrollment and Software Download link.
3. In the Download Endpoint Software Only section, select the appropriate platform from the drop-down list.
4. Click the Download button.
Identify the path to your existing endpoint installation that you are about to upgrade (for example, /home/oracle/okvutil).
Install the endpoint software by executing the following command:

java -jar okvclient.jar -d existing_endpoint_directory_path

For example:
```
java -jar okvclient.jar -d /home/oracle/okvutil
```
If you are installing the okvclient.jar file on a Windows endpoint system that has Oracle Database release 11.2.0.4 only, then include the -db112 option. (This option is not necessary for any other combination of endpoint platform or Oracle Database version.) For example:
```
java -jar okvclient.jar -d /home/oracle/okvutil -v -db112
```
Install the updated PKCS#11 library file.
This step is needed only for online TDE master encryption key management by Oracle Key Vault.

If an endpoint uses online TDE master encryption key management by Oracle Key Vault, then it must upgrade the PKCS#11 library while upgrading the endpoint software.
- On UNIX/Linux platforms: Run root.sh from the bin directory of endpoint installation directory to copy the latest liborapkcs.so file for Oracle Database endpoints.
```
$ sudo $OKV_HOME/bin/root.sh
```
  Or
```
$ su - root
# bin/root.sh
```
- On Windows platforms: Run root.bat from the bin directory of endpoint installation directory to copy the latest liborapkcs.dll file for Oracle Database endpoints. You will be prompted for the version of the database in use.
```
bin\root.bat
```
Restart the endpoint if it was shut down.

Related Topics

Reenrolling an Endpoint

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.5.6 Step 5: Re-download the RESTful Software Utility

After you complete the upgrade, you must re-download the okvrestservices.jar file, even if you have already downloaded it in previous releases.

Store this file in a secure location, and ensure that you remove this previous version of okvrestservices.jar.

Related Topics

Step 4: Download the RESTful Software Utility

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.5.7 Step 6: If Necessary, Remove Old Kernels

Oracle recommends that you clean up the older kernels that were left behind after the upgrade.

While the older kernel is not in use, it may be marked as an issue by some code analysis tools.

Log in to the Oracle Key Vault server as the support user.
Switch to the root user.
```
su - root
```
Mount /boot if it was not mounted on the system.
1. Check if the /boot is mounted. The following command should display /boot information if it was mounted.
```
df -h /boot;
```
2. Mount it if /boot is not mounted.
```
/bin/mount /boot;
```
Check the installed kernels and the running kernel.
1. Search for any kernels that are installed.
```
rpm -q kernel-uek | sort;
```
  The following example output shows that two kernels are installed:
```
kernel-uek-4.1.12-103.9.4.el6uek.x86_64
kernel-uek-4.1.12-112.16.7.el6uek.x86_64
```
2. Check the latest kernel.
```
uname -r;
```
  The following output shows an example of a kernel version that was installed at the time:
```
4.1.12-112.16.7.el6uek.x86_64
```
  This example assumes that 4.1.12-112.16.7.el6uek.x86_64 is the latest version, but newer versions may be available by now. Based on this output, you will need to remove the kernel-uek-4.1.12-103.9.4.el6uek.x86_64 kernel. You should remove all kernels that are older than the latest kernel.

Remove the older kernel and its associated RPMs.

For example, to remove the kernel-uek-4.1.12-103.9.4.el6uek.x86_64 kernel:

yum --disablerepo=* remove `rpm -qa | grep 4.1.12-103.9.4.el6uek`;

Output similar to the following appears:

Loaded plugins: security
Setting up Remove Process
Resolving Dependencies
--> Running transaction check
---> Package kernel-uek.x86_64 0:4.1.12-103.9.4.el6uek will be erased
---> Package kernel-uek-devel.x86_64 0:4.1.12-103.9.4.el6uek will be erased
---> Package kernel-uek-firmware.noarch 0:4.1.12-103.9.4.el6uek will be erased
--> Finished Dependency Resolution

Dependencies Resolved

================================================================================================================================================================================================================
 Package                                      Arch                            Version                                        Repository                                                                    Size
================================================================================================================================================================================================================
Removing:
 kernel-uek                                   x86_64                          4.1.12-103.9.4.el6uek                          @anaconda-OracleLinuxServer-201410181705.x86_64/6.6                          241 M
 kernel-uek-devel                             x86_64                          4.1.12-103.9.4.el6uek                          @anaconda-OracleLinuxServer-201410181705.x86_64/6.6                           38 M
 kernel-uek-firmware                          noarch                          4.1.12-103.9.4.el6uek                          @anaconda-OracleLinuxServer-201410181705.x86_64/6.6                          2.9 M

Transaction Summary
================================================================================================================================================================================================================
Remove        3 Package(s)

Installed size: 282 M
Is this ok [y/N]:

Enter y to accept the deletion output.
Repeat these steps starting with Step 4 for all kernels that are older than the latest kernel.

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.5.8 Step 7: If Necessary, Add Disk Space to Extend Swap Space

If you upgraded from an earlier release, you should extend swap space to accommodate the new Oracle Key Vault software.

By default, Oracle Key Vault releases earlier than release 18.1 were installed with approximately 4 GB of disk space. After you complete the upgrade to release 18.1, Oracle recommends that you increase the swap space allocation for the server on which you upgraded Oracle Key Vault. A new Oracle Key Vault installation is automatically configured with sufficient swap space. However, if you upgraded from a previous release, then you must manually add disk space to extend the swap space, particularly if the intention is to convert the upgraded server into the first node of a multi-master cluster.

Log in to the server in which you upgraded Oracle Key Vault and connect as root.
Check the current amount of swap space.
```
[root@my_okv_server support]# swapon -s
```
Output similar to the following appears. This example shows that the system has 4 GB of swap space.
```
Filename Type Size Used Priority
/dev/dm-0 partition 4194300 3368 -1
```

Check the amount of space on the system by executing the vgdisplay and vgs commands.

Run the vgdisplay command.

[root@my_okv_server support]# vgdisplay

Output similar to the following appears. Note the values that are displayed after Alloc PE and Free PE (in bold).

--- Volume group ---
VG Name vg_root
System ID
Format lvm2
Metadata Areas 1
Metadata Sequence No 17
VG Access read/write
VG Status resizable
MAX LV 0
Cur LV 12
Open LV 12
Max PV 0
Cur PV 1
Act PV 1
VG Size 2048.78 GiB
PE Size 32.00 MiB
Alloc PE / Size 7289 / 2027.78 GiB
Free PE / Size 672 / 21.00 GiB
VG UUID HGesFT-0JiY-C47e-kuVn-yzZ0-Htlw-KnUni0

Run the vgs command.

[root@my_okv_server support]# vgs

Output similar to the following appears.

VG #PV #LV #SN Attr VSize VFree
vg_root 1 12 0 wz--n- 2048.78g 21.00g

Follow these guidelines to determine if you need more swap space:
- If the hard disk is equal to or greater than 1 TB in size, then you should have approximately 64 GB of swap space.
- If the hard disk is less than 1 TB in size, then you should have approximately 20 to 25 percent of hard disk space set aside for swap space.
If you need more swap space, then complete the rest of the steps in this procedure.
Shut down the Oracle Key Vault system server.
1. Log in to the Oracle Key Vault management console as a user who has the System Administrator role.
2. Select the System tab, and then select System Settings.
3. Click the Power Off button.
After you shut down the Oracle Key Vault server, you can add a new disk if needed, and then power the server back on.
Run the fdisk -l to find if there are any available partitions on the new disk.
At this stage, there should be no available partitions.
Run the fdisk disk_device_to_be_added command to create the new partition.
For example, to create a disk device named /dev/sdb:
```
fdisk /dev/sdb
```
In the prompts that appear, enter the following commands in sequence:

n for new partition

p for primary

1 for partition number

Accept the default values for cylinder (press Enter twice)

w to write and exit
Use the pvcreate disk_device_partition command to add the newly added disk to the physical volume.
For example, for a disk device named /dev/sdb1, which is the name of the partition on that disk to be created (based on the name used for the disk device that was added).
```
[root@my_okv_server support]# pvcreate /dev/sdb1
```
Output similar to the following appears:
```
Physical volume "/dev/sdb1" successfully created
```
Extend the logical volume with this disk space that you just added:
```
[root@my_okv_server support]# vgextend vg_root /dev/sdb1
```
Output similar to the following appears.
```
Volume group "vg_root" successfully extended
```

Check that the disk space has been successfully extended by running the vgdisplay and vgs commands again.

[root@my_okv_server support]# vgdisplay
 --- Volume group ---
 VG Name vg_root
 System ID
 Format lvm2
 Metadata Areas 2
 Metadata Sequence No 18
 VG Access read/write
 VG Status resizable
 MAX LV 0
 Cur LV 12
 Open LV 11
 Max PV 0
 Cur PV 2
 Act PV 2
 VG Size 328.75 GiB
 PE Size 32.00 MiB
 Total PE 10520
 Alloc PE / Size 7289 / 227.78 GiB
 Free PE / Size 3231 / 100.97 GiB
 VG UUID GeaZEb-Fivt-fFCv-i60c-x598-04Ot-J3GmEF

[root@my_okv_server support]# vgs
 VG #PV #LV #SN Attr VSize VFree
 vg_root 2 12 0 wz--n- 328.75g 100.97g

This output indicates that the space allocation has increased after you added the new disk.

Disable swapping.

[root@my_okv_server support]# swapoff -v /dev/vg_root/lv_swap

To extend the swap space, run the lvresize command.

[root@my_okv_server support]# lvresize -L +60G /dev/vg_root/lv_swap

Output similar to the following appears:

Size of logical volume vg_root/lv_swap changed from 4.00 GiB (128 extents) to 64.00 GiB (2048 extents
Logical volume lv_swap successfully resized.

Format the newly added swap space.

[root@my_okv_server support]# mkswap /dev/vg_root/lv_swap

Output similar to the following appears:

mkswap: /dev/vg_root/lv_swap: warning: don't erase bootbits sectors
on whole disk. Use -f to force.
Setting up swapspace version 1, size = 67108860 KiB
no label, UUID=fea7fc72-0fea-43a3-8e5d-e29955d46891

Enable swapping again.

[root@my_okv_server support]# swapon -v /dev/vg_root/lv_swap

Verify the amount of swap space that is available.

[root@my_okv_server support]# swapon -s

Output similar to the following appears.

Filename Type Size Used Priority

/dev/dm-0 partition 67108860 0 -1

Restart the Oracle Key Vault server.
1. Log in to the Oracle Key Vault management console as a user who has the System Administrator role.
2. Select the System tab, and then select System Settings.
3. Click the Reboot button.

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.5.9 Step 8: If Necessary, Remove SSH-Related DSA Keys

You should remove SSH-related DSA keys left behind after the upgrade, because they can cause problems with some code analysis tools.

Log in to the Oracle Key Vault management console as a user with the System Administrator role.
Enable SSH.

Log in to the Oracle Key Vault management console as a user who has the System Administrator role. Select the System Settings tab, then under Network Services, select SSH Access. Select IP address(es) and then enter only the IP addresses that you need. Click Save.
Login to the Oracle Key Vault support account using SSH.
```
ssh support@OracleKeyVault_serverIPaddress
```
Switch to the root user.
```
su - root
```
Change directory to /etc/ssh.
```
cd /etc/ssh
```

Rename the following keys.

mv ssh_host_dsa_key.pub ssh_host_dsa_key.pub.retire
mv ssh_host_dsa_key ssh_host_dsa_key.retire

Disable SSH access.

Log in to the Oracle Key Vault management console as a user who has the System Administrator role. Select the System Settings tab, then under Network Services, select Disabled. Click Save.

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.5.10 Step 9: Back Up the Upgraded Oracle Key Vault Server

You must perform server backup and user password tasks after completing a successful upgrade.

Take a full backup of the upgraded Oracle Key Vault Server Database to a new remote destination. Avoid using the old backup destination for the new backups.
Schedule a new periodic incremental backup to the new destination defined in the step above.
Password hashing has been upgraded to a more secure standard than in earlier releases. This change affects the operating system passwords, support and root. You must change Oracle Key Vault administrative passwords after the upgrade to take advantage of the more secure hash.

Related Topics

Oracle Database Backup and Recovery User’s Guide

Parent topic: Upgrading a Standalone or Primary-Standby Oracle Key Vault Server

4.6 Upgrading Oracle Key Vault in a Multi-Master Cluster Environment

Similar to a standalone or primary-standby upgrade, this type of upgrade includes the Oracle Key Vault server software and endpoint software-related utilities.

About Upgrading Oracle Key Vault in a Multi-Master Cluster Environment
To perform this upgrade, you must upgrade each multi-master cluster node.
Step 1: Perform Pre-Upgrade Tasks
Similar to a standalone or primary-standby environment, you must prepare the Oracle Key Vault server for the pre-upgrade multi-master cluster process.
Step 2: If Upgrading from Release 18.1, Run the Pre-Upgrade Script on Each Node
If you are upgrading from Oracle Key Vault release 18.1, then run the pre-upgrade on each multi-master cluster node before performing the full upgrade.
Step 3: Upgrade Each Multi-Master Cluster Node
Do not use other Oracle Key Vault features until you have completed upgrading all multi-master cluster nodes.
Step 4: Check the Node Version and the Cluster Version
After you complete the upgrade of at least one node, you can log into any of the upgraded nodes to check the node and cluster versions.
Step 5: Re-download the RESTful Software Utility
After you complete the upgrade, you must re-download the okvrestservices.jar file, even if you have already downloaded it in previous releases.
Rolling Back the Pre-Upgrade Script
After you run the pre-upgrade script, you can roll it back if none of the nodes in the cluster have been successfully upgraded.

Parent topic: Oracle Key Vault Installation and Configuration

4.6.1 About Upgrading Oracle Key Vault in a Multi-Master Cluster Environment

To perform this upgrade, you must upgrade each multi-master cluster node.

The upgrade process involves two main steps: running a pre-upgrade script to prepare all the nodes for upgrade, and then performing the upgrade on each multi-master cluster node. If you are upgrading from Oracle Key Vault release 18.1, then you must run the pre-upgrade script. If you are upgrading from release 18.2 and later, then you must bypass running the pre-upgrade script. After you have begun a cluster upgrade, ensure that you upgrade all the nodes in the cluster one after the other, without too much intervening time between upgrades of two nodes. If you run the pre-upgrade script but then realize that you still must use the previous version of Oracle Key Vault, you can run a rollback script to undo the changes done by pre-upgrade script, so long as no nodes have yet successfully been upgraded. You will need to run pre-upgrade again if you decide to proceed with the upgrade later.

Upgrading an Oracle Key Vault multi-master cluster includes upgrading each cluster node to the new later version. You must upgrade all nodes to the same Oracle Key Vault version. You should first upgrade the read-only nodes of the cluster, and then upgrade the read-write pairs. As each cluster node is upgraded, its node version is updated to the new version of the Oracle Key Vault. After you complete the upgrade of all cluster nodes, the cluster version is updated to the new version of the Oracle Key Vault. (You can check node version or the cluster version by selecting the Cluster tab, then in the left navigation bar, selecting Management.) Oracle Key Vault multi-master cluster upgrade is considered complete when node version and cluster version at each cluster node is updated to the latest version of Oracle Key Vault.

Before you perform the upgrade, note the following:

Perform the entire upgrade process on all multi-master cluster nodes, without interruption. (That is, after you have started the cluster upgrade process, ensure that you try and upgrade all nodes, one after the other.) Do not perform other Oracle Key Vault activities until you have completed upgrading all the nodes in your environment.
Be aware that you cannot use certain new features (for example, certificate rotation) until you have completed upgrading all of the multi-master cluster nodes. An error is returned when such features are used from the node that has been upgraded. Oracle recommends that you plan the upgrade of all cluster nodes close to each other to ensure availability of the new features sooner.

Related Topics

Step 4: Check the Node Version and the Cluster Version

Parent topic: Upgrading Oracle Key Vault in a Multi-Master Cluster Environment

4.6.2 Step 1: Perform Pre-Upgrade Tasks

Similar to a standalone or primary-standby environment, you must prepare the Oracle Key Vault server for the pre-upgrade multi-master cluster process.

Back up the server so that you can recover data in case the upgrade fails.
Perform the pre-upgrade tasks that are described for standalone or primary-standby environments, which include tasks such as ensuring that the server meets the minimum disk space requirements, ensuring that no full or incremental backup jobs are running, and planning for down times.
The pre-upgrade tasks for standalone or primary-standby environments include a table that describes how to plan for downtime for different specifications. This table may not apply to multi-master cluster environments.

4.6.3 Step 2: If Upgrading from Release 18.1, Run the Pre-Upgrade Script on Each Node

If you are upgrading from Oracle Key Vault release 18.1, then run the pre-upgrade on each multi-master cluster node before performing the full upgrade.

If you are upgrading from Oracle Key Vault release 18.2 or later, then you must bypass this step. The pre-upgrade script sets the stage for the upgrade by making some preparatory changes to the nodes that will be upgraded, such as updating the Oracle GoldenGate parameter files and blocking user operations. The cluster_preupgrade_181.zip file is available after you mount the upgrade ISO, at /images/preupgrade/cluster_preupgrade_181.zip.

Log in to the Oracle Key Vault server.
If necessary, enable SSH access.

Log in to the Oracle Key Vault management console as a user who has the System Administrator role. Select the System Settings tab, then under Network Services, select SSH Access. Select IP address(es) and then enter only the IP addresses that you need. Click Save.
SSH into the multi-master cluster node in order to run the pre-upgrade script.
```
ssh support@Oracle_Key_Vault_IP_address
```
Switch to the root user.
```
su - root
```

Unzip the pre-upgrade files into the /tmp directory.

/usr/bin/unzip /images/preupgrade/cluster_preupgrade_181.zip -d /tmp

Execute the pre-upgrade script.
```
/tmp/cluster_preupgrade_181.sh
```
After you have successfully completed this procedure, repeat these pre-upgrade steps on all multi-master cluster nodes.
After you complete these pre-upgrade steps, you are ready to perform the actual upgrade on each multi-master cluster node.

Related Topics

Rolling Back the Pre-Upgrade Script

Parent topic: Upgrading Oracle Key Vault in a Multi-Master Cluster Environment

4.6.4 Step 3: Upgrade Each Multi-Master Cluster Node

Do not use other Oracle Key Vault features until you have completed upgrading all multi-master cluster nodes.

You must perform these steps on each node of the cluster, one after the other.

SSH into the first multi-master cluster node that you want to upgrade.
```
ssh support@Oracle_Key_Vault_IP_address
```
Disable the multi-master cluster node.
In the node's Management page (under the Cluster tab), the node's status will change from DISABLING to DISABLED.
Perform the upgrade as you would upgrade a standalone Oracle Key Vault server (but not a primary-standby pair).
When you run the /usr/bin/ruby /images/upgrade.rb --confirm step during the upgrade, you will be asked to confirm that you completed the pre-upgrade steps.
After the node has been successfully upgraded, re-enable it.
After you re-enable the disabled multi-master cluster node, its status changes from DISABLED to ENABLING, then to ACTIVE. The status of the node will remain at ENABLING and will not change to ACTIVE unless bidirectional replication between it and all other nodes is occurring successfully.
As necessary, disable SSH access on this node.

Log in to the Oracle Key Vault management console as a user who has the System Administrator role. Select the System Settings tab, then under Network Services, select Disabled. Click Save.
After you have successfully completed this procedure, repeat these upgrade steps on all multi-master cluster nodes.

4.6.5 Step 4: Check the Node Version and the Cluster Version

After you complete the upgrade of at least one node, you can log into any of the upgraded nodes to check the node and cluster versions.

Oracle Key Vault tracks the version information of each cluster node as well as the version of the cluster as a whole. The node version represents the version of the Oracle Key Vault software on a given node. When a node is upgraded, its node version is updated to the new version of the Oracle Key Vault software. The cluster version is derived from the version information of the cluster nodes and is set to the minimum version of any cluster node. During cluster upgrade, node version is updated as each cluster node is upgraded to the later version. When all of the cluster nodes have been upgraded, the cluster version is then updated to the new version. (The Cluster Version and Node Version fields are available in Oracle Key Vault release 18.2 and later.)

Log in to the Oracle Key Vault management console as a user who has the System Administrator role.
Select the Cluster tab.
In the left navigation bar, select Management.
Check the following areas:
- To find the node version, check the Cluster Details area.
- To find the cluster version, check the Cluster Information area.

Parent topic: Upgrading Oracle Key Vault in a Multi-Master Cluster Environment

4.6.6 Step 5: Re-download the RESTful Software Utility

After you complete the upgrade, you must re-download the okvrestservices.jar file, even if you have already downloaded it in previous releases.

Store this file in a secure location, and ensure that you remove this previous version of okvrestservices.jar.

Related Topics

Step 4: Download the RESTful Software Utility

Parent topic: Upgrading Oracle Key Vault in a Multi-Master Cluster Environment

4.6.7 Rolling Back the Pre-Upgrade Script

After you run the pre-upgrade script, you can roll it back if none of the nodes in the cluster have been successfully upgraded.

Remember that this pre-upgrade script is only necessary for an upgrade from Oracle Key Vault release 18.1. Upgrades from 18.2 and later do not need this pre-upgrade script run.

Do not roll back the pre-upgrade script if any nodes have been successfully upgraded. You may want to roll back the pre-upgrade script if, for example, you realize that you must still continue using the previous version of Oracle Key Vault. Another reason to roll back the pre-upgrade script is in the event that the upgrade on any node that you attempted to upgrade fails. Then you must roll back the pre-upgrade script from each cluster node. You will need to start the upgrade process from the beginning if you decide to upgrade Oracle Key Vault multi-master cluster later. If you choose to run the rollback script on one node, then you must run through the rollback steps on all other nodes as well, before you a) either continue working, or b) attempt to upgrade the cluster again.

Log in to the Oracle Key Vault server.
If SSH access is disabled, then enable it.

Log in to the Oracle Key Vault management console as a user who has the System Administrator role. Select the System Settings tab, then under Network Services, select SSH Access. Select IP address(es) and then enter only the IP addresses that you need. Click Save.
SSH into the first multi-master cluster node where you want to perform the rollback operation.
```
ssh support@Oracle_Key_Vault_IP_address
```
Switch to the root user.
```
su - root
```
Execute the following command:
```
/tmp/cluster_preupgrade_181.sh ROLLBACK
```
Disable SSH access.

Log in to the Oracle Key Vault management console as a user who has the System Administrator role. Select the System Settings tab, then under Network Services, select Disabled. Click Save.

Parent topic: Upgrading Oracle Key Vault in a Multi-Master Cluster Environment

4.7 Overview of the Oracle Key Vault Management Console

The Oracle Key Vault management console provides a graphical user interface for System Administrators, Key Administrators, and Audit Managers.

The Oracle Key Vault management console is a browser-based console that connects to the server using the https secure communication channel. It provides the graphical user interface for Oracle Key Vault, where users can perform tasks such as the following:

Setting up and managing the cluster
Creating and managing users, endpoints, and their respective groups
Creating and managing virtual wallets and security objects
Setting system settings, like network and other services
Setting up primary-standby
Performing backups

Parent topic: Oracle Key Vault Installation and Configuration

4.8 Performing Actions and Searches

The Oracle Key Vault management console enables you to perform standard actions and search operations, as well as get help information.

Many of the tab and menu pages contain an Actions menu or Search bars that allow you to search and perform actions on lists and the results of searches. The Help selection of the Actions list provides detailed help for using these features.

Actions Menus
The actions available from an Actions drop-down menu can vary but typically include a set of standard menu items.
Search Bars
Along with Actions menus, many tabs in the Oracle Key Vault management console contain search bars.

Parent topic: Oracle Key Vault Installation and Configuration

4.8.1 Actions Menus

The actions available from an Actions drop-down menu can vary but typically include a set of standard menu items.

These items are as follows:

Select Columns: Select which column should be displayed.
Filter: Filter by column or row and a user-defined expression.
Rows Per Page: Choose how many rows you want to view .
Format: Choose formatting such as Sort, Control Break, Highlight, Compute, Aggregate, Chart, and Group By.
Save Report: Save reports.
Reset: Reset the report settings, removing any customizations.
Help: Get information about these actions.
Download: Download the result set in CSV or HTML.

Parent topic: Performing Actions and Searches

4.8.2 Search Bars

Along with Actions menus, many tabs in the Oracle Key Vault management console contain search bars.

This demonstration searches for endpoints, but the process is the same for other searches, except that the column headings are different. Wildcard characters are not supported, but the search does match any letter or phrase that you enter. You can use the Filter menu item under Actions to further fine-tune the search.

Enter a name or other identifier in the search field or (optionally) place your cursor on the magnifying icon in the Search bar to select one of the table headings (in this case, All Columns, Endpoint Name, Endpoint Type, Description, Platform, Status, Enrollment Token, and Alert) and then enter a search term.

Figure 4-1 Endpoints Page

Description of "Figure 4-1 Endpoints Page"
Click Go.

A new endpoint list appears, displaying the endpoints that meet the search criteria. A filter icon (a funnel) indicates that a search has been performed and displays the search criteria.
You can select or deselect the filter icon to disable search and view the entire list.

Parent topic: Performing Actions and Searches