4 Managing Oracle Key Vault Multi-Master Clusters
You can create, configure, manage, and administer an Oracle Key Vault multi-master cluster by using the Oracle Key Vault management console.
- About Managing Oracle Key Vault Multi-Master Clusters
You can add or remove nodes from the cluster, disable or enable cluster nodes, and manage activities such as node conflicts and replication. - Setting Up a Cluster
After you add an initial node to a cluster, you can add more nodes, thereby creating read-write pairs of nodes or read-only nodes. - Terminating the Pairing of a Node
On the controller node, you can terminate the pairing process for a new node. - Disabling a Cluster Node
You can temporarily disable a cluster node, which is required for upgrades and maintenance. - Enabling a Disabled Cluster Node
You can enable any cluster node that was previously disabled. You must perform this operation from the disabled node. - Deleting a Cluster Node
You can permanently delete a node from the cluster. - Force Deleting a Cluster Node
You can permanently force delete a node from a cluster that is dead, unresponsive, or has exceeded the maximum disabled node time limit. - Managing Replication Between Nodes
You can enable and disable node replication from the Oracle Key Vault management console. - Cluster Management Information
The Cluster Management page provides a concise overview of the cluster and the status of each node. - Cluster Monitoring Information
The Cluster Monitoring page provides the replication health of the cluster and the current node. - Naming Conflicts and Resolution
Oracle Key Vault can resolve naming conflicts that can arise as users create objects such as endpoints, endpoint groups, and user groups. - Multi-Master Cluster Deployment Recommendations
Oracle provides deployment recommendations for deployments that have two or more nodes. - Adding Alternate Name or IP address
In a Multi-Master Cluster environment, you can configure two alternate hostnames for a given Oracle Key Vault server or node.
4.1 About Managing Oracle Key Vault Multi-Master Clusters
You can add or remove nodes from the cluster, disable or enable cluster nodes, and manage activities such as node conflicts and replication.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.2 Setting Up a Cluster
After you add an initial node to a cluster, you can add more nodes, thereby creating read-write pairs of nodes or read-only nodes.
- About Setting Up a Cluster
You create a multi-master cluster by converting a single Oracle Key Vault server to become the initial node. - Creating the First (Initial) Node of a Cluster
To create a cluster, you must convert an existing standalone Oracle Key Vault server to become the first node in the cluster. - Adding Nodes to a Cluster
After you have converted the initial node to a candidate node, you can start building your cluster. Ensure that the candidate node configuration settings, for example, FIPS settings match the cluster settings as closely as possible.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.2.1 About Setting Up a Cluster
You create a multi-master cluster by converting a single Oracle Key Vault server to become the initial node.
This Oracle Key Vault server seeds the cluster data and converts the server into the first cluster node, which is called the initial node.
After the initial cluster is created in the Oracle Key Vault server, you can add the different types of nodes that you need for the cluster. The cluster is expanded when you induct additional Oracle Key Vault servers, and add them as read-write nodes, or as simple read-only nodes.
Parent topic: Setting Up a Cluster
4.2.2 Creating the First (Initial) Node of a Cluster
To create a cluster, you must convert an existing standalone Oracle Key Vault server to become the first node in the cluster.
This first node is called the initial node. The standalone Oracle Key Vault server can also be a server that has been upgraded from an earlier release to Oracle Key Vault release 21.6 or later from a previous release, or it can also be the server that is unpaired from a primary-standby configuration. Check Oracle Key Vault Release Notes for known issues about unpair operations and upgrades.
You can use this node to add one or more nodes to the cluster. The node operates in read-only restricted mode until it is part of a read-write pair.
Parent topic: Setting Up a Cluster
4.2.3 Adding Nodes to a Cluster
After you have converted the initial node to a candidate node, you can start building your cluster. Ensure that the candidate node configuration settings, for example, FIPS settings match the cluster settings as closely as possible.
- Adding a Node to Create a Read-Write Pair
After you create the initial node, you must add an additional read-write peer to the cluster. - Adding a Node as a Read-Only Node
To add a new read-only cluster node, you add a newly configured server from any existing cluster node. - Creating an Additional Read-Write Pair in a Cluster
Any node can be read-write paired with only one other node, and there can be multiple read-write pairs in a cluster.
Parent topic: Setting Up a Cluster
4.2.3.1 Adding a Node to Create a Read-Write Pair
After you create the initial node, you must add an additional read-write peer to the cluster.
You can configure any two nodes as a read-write pair. However, any single node can be read-write paired with only one other node.
To create a read-write pair using two nodes in a cluster, you pair a node (referred to as the controller node) with a newly configured server (referred to as the candidate node). Note that this will take some time: an hour or more, depending on the speed of your server, network, and volume of data in the cluster. Be aware that the controller node will be unable to service endpoints during certain parts of this operation. It is also recommended to configure the candidate node system settings, such as, FIPS, NTP, and HSM similar to the controller node before initiating the pairing.
Parent topic: Adding Nodes to a Cluster
4.2.3.2 Adding a Node as a Read-Only Node
To add a new read-only cluster node, you add a newly configured server from any existing cluster node.
The existing cluster node is referred to as the controller node, and the newly configured server is referred to as the candidate node. This process will take an hour or more, depending on the speed of your server, network, and volume of data in the cluster.
Parent topic: Adding Nodes to a Cluster
4.2.3.3 Creating an Additional Read-Write Pair in a Cluster
Any node can be read-write paired with only one other node, and there can be multiple read-write pairs in a cluster.
- Select a read-only cluster node as the controller node to pair with a new candidate node.
- Follow the steps to create a read-write pair of nodes in a cluster.
Related Topics
Parent topic: Adding Nodes to a Cluster
4.3 Terminating the Pairing of a Node
On the controller node, you can terminate the pairing process for a new node.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.4 Disabling a Cluster Node
You can temporarily disable a cluster node, which is required for upgrades and maintenance.
However, be aware that a node can only be disabled for a set period of time. When it exceeds that time, it cannot be enabled again. The default maximum disable node duration time is 24 hours, but you can set it for as high as 240 hours. Note that as this value is increased, the average amount of disk space consumed by cluster-related data also increases.
DISABLING
state. To return such a node back to the ACTIVE
state, you can cancel the disable operation by clicking the Cancel Disable button.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.5 Enabling a Disabled Cluster Node
You can enable any cluster node that was previously disabled. You must perform this operation from the disabled node.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.6 Deleting a Cluster Node
You can permanently delete a node from the cluster.
Deleted nodes cannot be added back to any cluster, not just to the current cluster from which they were deleted. However, you can reinstall the Oracle Key Vault appliance software on this server and add the deleted node to a cluster. All data will be synchronized with the cluster before the node is deleted. A node cannot delete itself. Be aware that if a deleted node has a read-write peer, then this read-write peer node will experience network changes that will temporarily prevent it from serving endpoints.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.7 Force Deleting a Cluster Node
You can permanently force delete a node from a cluster that is dead, unresponsive, or has exceeded the maximum disabled node time limit.
Forcefully deleting a node that is still a part of a cluster may cause inconsistency in the cluster. Be aware that if the read-write peer of the node that was forcefully deleted is also removed from the cluster before confirming that all critical data from the forcefully deleted node has reached other nodes, then data loss can result. When you forcefully delete a node, ensure that the node to be deleted has first been shut down. A node cannot be deleted from its own management console. When you must forcefully delete a node, ensure that the node to be deleted has first been shut down. Deleted nodes cannot be added back to the cluster. However, you can reinstall the Oracle Key Vault appliance software on a server and then add the deleted node to a cluster. Be aware that if a deleted node has a read-write peer, then this read-write peer node will experience network changes that will temporarily prevent it from serving endpoints.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.8 Managing Replication Between Nodes
You can enable and disable node replication from the Oracle Key Vault management console.
- Restarting Cluster Services
While managing replication between nodes, you can restart a node's cluster services when the cluster service status for the node is down. - Disabling Node Replication
You can disable the replication link between the current node and any other node in a cluster. - Enabling Node Replication
You can enable the replication link between the current node and any other node in a cluster.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.8.1 Restarting Cluster Services
While managing replication between nodes, you can restart a node's cluster services when the cluster service status for the node is down.
- Log into Oracle Key Vault management console of any cluster node as a user who has the System Administrator role.
- Select the Cluster tab, and then Monitoring from the left navigation bar.
- In the Node State pane, click the Restart Cluster Services button.
Parent topic: Managing Replication Between Nodes
4.8.2 Disabling Node Replication
You can disable the replication link between the current node and any other node in a cluster.
- Log into Oracle Key Vault management console of any cluster node as a user who has the System Administrator role.
- Select the Cluster tab, and then Monitoring from the left navigation bar.
- Under Cluster Link State, select the check boxes for the nodes for which you want to disable replication.
- Click Disable.
- Click OK to confirm in the dialog box.
Parent topic: Managing Replication Between Nodes
4.8.3 Enabling Node Replication
You can enable the replication link between the current node and any other node in a cluster.
- As a user who has the System Administrator role, log in to the Oracle Key Vault management console of the node for which replication should be managed.
- Select the Cluster tab, and then Monitoring from the left navigation bar.
- Under Cluster Link State, select the check boxes for the nodes for which you want to enable replication.
- Click Enable.
- Click OK to confirm in the dialog box.
Parent topic: Managing Replication Between Nodes
4.9 Cluster Management Information
The Cluster Management page provides a concise overview of the cluster and the status of each node.
You can also manage the cluster from the cluster details section. When a node is performing a cluster operation it becomes the controller node.
Be aware that because the replication across the cluster takes time, there may be a delay before the Cluster Management page refreshes with the new cluster status. The replication lag in the monitoring page will help estimate the delay.
To view the Cluster Management page, click the Cluster tab, and then Management from the left navigation bar.
Description of the illustration 21_cluster_management.png
Cluster Information
-
Cluster Name: The name of the cluster.
-
Cluster Subgroups: All subgroups within the cluster.
-
Maximum Disable Node Duration: The maximum time, in hours, that a node can be disabled before it can no longer be enabled.
-
Cluster Version: The version of Oracle Key Vault in which the cluster is operating.
Current Node Information
-
Node Name: The name of this node.
-
Node Type: The type of node, such as whether it is read-only or read-write.
-
Cluster Subgroup: The subgroup to which this node belongs.
Cluster Details
-
Select Node: Used to select a node for a specific operation, such as delete, force delete, or disable.
-
Node ID: The ID of the node.
-
Node Name: The name of the node. Clicking the node name takes you to the Cluster Management page of that node.
-
IP Address: The IP address of the node.
-
Mode: The mode in which the node is operating, such as read-write or read-only restricted.
-
Status: The status of the node, such as active, pairing, disabling, disabled, enabling, deleting, or deleted.
-
Read-Write Peer: The read-write peer of the node. If blank, it has no read-write peer.
-
Cluster Subgroup: The subgroup to which the node belongs. You can change this by 1) checking the check box next to a node, 2) clicking the Edit button, which displays a window, 3) entering a new cluster subgroup in the field, and 4) clicking Save.
-
Join Date: The date and time that the node was added to the cluster or most recently enabled
-
Disable Date: The date and time that the node was disabled.
-
Node Version: The current version of the Oracle Key Vault node.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.10 Cluster Monitoring Information
The Cluster Monitoring page provides the replication health of the cluster and the current node.
This page also provides a concise overview of the settings enabled in the cluster. You cannot update the settings on this page. Because the replication across the cluster takes time, there may be a delay before the Cluster Monitoring page refreshes with the new cluster state. Replication lag will help estimate the delay.
To view the cluster monitoring page, click the Cluster tab, and then Monitoring from the left navigation bar.
- Enabled in Cluster
- Enabled in Node
- Disabled in Cluster
- Disabled in Node
Description of the illustration 21_cluster_monitoring_information.png
Cluster Link State
-
Select Node: Used to select nodes for a specific operation, such as enabling or disabling replication. You can click the checkbox on the label row to select all nodes.
-
Node ID: The ID of the node.
-
Node Name: The name of the node.
-
State: The current state of the node. The server is either up or down.
-
Heartbeat Lag: The amount of time since a heartbeat was last received from this node. This setting should be around 60 seconds or lower. If this value is consistently greater than 60 seconds, then it means that one or more replication links may be broken. After the replication problem is fixed, it will then trend back down towards 60 or lower.
-
Replication Lag: The average time it takes for data to replicate from this node to the current node.
-
Enable: Enables the replication between the current node and the node selected.
-
Disable: Disables the replication between the current node and the node selected.
Cluster Settings State
-
Node ID: The ID of the node.
-
Node Name: The name of the node.
-
Audit: Indicates if auditing is enabled or disabled.
-
FIPS: Indicates if FIPS mode is enabled or disabled.
-
HSM: Indicates if HSM integration is enabled or disabled.
-
SNMP: Indicates if SNMP is enabled or disabled.
-
SYSLOG: Indicates if syslog is enabled or disabled.
-
DNS: Indicates if DNS is enabled or disabled.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.11 Naming Conflicts and Resolution
Oracle Key Vault can resolve naming conflicts that can arise as users create objects such as endpoints, endpoint groups, and user groups.
- About Naming Conflicts and Resolution
If you create an object that has the same name as another object on another node, Oracle Key Vault resolves this conflict. - Naming Conflict Resolution Information
The Cluster Conflict Resolution page provides a list of objects with names that conflict with objects created on different nodes. - Changing the Suggested Conflict Resolution Name
You can change the suggested name for an object that conflicts with another object of the same type. - Accepting the Suggested Conflict Resolution Name
You can accept the suggested name for an object name that conflicts with another object of the same type.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.11.1 About Naming Conflicts and Resolution
If you create an object that has the same name as another object on another node, Oracle Key Vault resolves this conflict.
You can create a new object with a name that conflicts with an object of the same type created on another node. If a conflict happens, then Oracle Key Vault will make the name of the conflicting object unique by adding _OKVxx
, where xx
is the node ID of the node on which the object was created. You can choose to accept this new name or change the object name.
Users who have the System Administrator role can resolve the following naming conflicts:
- User names
- Endpoint names
Users who have the Key Administrator role can resolve the following naming conflicts:
- Endpoint groups
- Security objects
- User groups
- Wallets
If an object is stuck in the PENDING
state and will not transition to ACTIVE
, then check for any broken replication links in the cluster. You can find cluster links in the Oracle Key Vault management console by selecting the Cluster tab and then selecting Monitoring.
Parent topic: Naming Conflicts and Resolution
4.11.2 Naming Conflict Resolution Information
The Cluster Conflict Resolution page provides a list of objects with names that conflict with objects created on different nodes.
On this page, you can accept the suggested unique name or edit the object name. To view the Cluster Conflict Resolution page, click the Cluster tab, and then Conflict Resolution from the left navigation bar. Alternatively, you can click on the Click here for details button on a Naming Conflict alert from the Alerts table on the Home page.
Wallet Name Conflicts
-
Unique Name: The unique name assigned to the object by the system.
-
Supplied Name: The original name of the object that conflicts with another object of this type.
-
Name Status: The status of the object. The status can be
PENDING
orACTIVE
. -
Created By: The user that created the conflicting object name.
-
Creator Node: The node on which the conflicting object was created.
-
Description: The description of the object as entered by the user.
-
Rename: The button that links to the object page where it can be renamed. When you click the edit icon, the Wallet Overview page appears. Click Make Unique to give the wallet a unique name, and then click Accept Rename.
-
Accept: Allows you to accept the suggested name for the selected objects.
Parent topic: Naming Conflicts and Resolution
4.11.3 Changing the Suggested Conflict Resolution Name
You can change the suggested name for an object that conflicts with another object of the same type.
- As a user who has the appropriate administrator role, log in to the Oracle Key Vault management console.
- Select the Cluster tab, and then Conflict Resolution from the left navigation bar.
- Locate the object that requires a name change.
- Click the edit icon to the right of the object, under Rename.
- On the object overview page, enter the new name for the object.
- Click Save.
Parent topic: Naming Conflicts and Resolution
4.11.4 Accepting the Suggested Conflict Resolution Name
You can accept the suggested name for an object name that conflicts with another object of the same type.
- As a user who has the appropriate administrator role, log in to the Oracle Key Vault management console.
- Select the Cluster tab, and then Conflict Resolution from the left navigation bar.
- Select the objects for which you want to accept the suggested name.
- Click Accept.
Parent topic: Naming Conflicts and Resolution
4.12 Multi-Master Cluster Deployment Recommendations
Oracle provides deployment recommendations for deployments that have two or more nodes.
Two-Node Deployment Recommendations
Use a two-node deployments for the following situations:
- Non-critical environments, such as test and development
- Simple deployment of read-write pairs with both nodes active, replacing classic primary-standby
- Single data center environments
Considerations for a two-node deployment:
- Availability is provided by multiple nodes.
- Maintenance will require downtime.
- Good network connectivity between data centers is mandatory.
- Take regular backups to remote destinations for disaster recovery.
Three-Node Deployment Recommendations
Use a three-node deployment for the following situations:
- Single data center environments with minimal downtime requirement
- Single read-write pair with additional read-only node to handle load
- One read-only node is available for zero downtime during maintenance
Considerations for a three-node deployment:
- Take regular backups to remote destinations for disaster recovery.
Four or More Node Deployment Recommendations
Use a deployment of four or more nodes for the the following situations:
- Large data centers distributed across geographical locations
- Deployment of read-write pairs with pair members spanning geography
Considerations for a large deployment:
- Availability is provided by multiple nodes.
- Additional read-only nodes can be used to handle load.
- Good network connectivity between data centers is mandatory.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.13 Adding Alternate Name or IP address
In a Multi-Master Cluster environment, you can configure two alternate hostnames for a given Oracle Key Vault server or node.
Note:
You can choose to use either the hostname or the IP address but not both.- Configuring Alternate Hostname for the Endpoint
You can choose the endpoint to use the configured alternate hostname to communicate with the Oracle Key Vault server or node.
Parent topic: Managing Oracle Key Vault Multi-Master Clusters
4.13.1 Configuring Alternate Hostname for the Endpoint
You can choose the endpoint to use the configured alternate hostname to communicate with the Oracle Key Vault server or node.
Parent topic: Adding Alternate Name or IP address