To enable or disable TLS on an auxiliary database
Purpose
CAUTION Service Outage |
A change to the auxiliary database security settings requires a restart of each NFM-P main server and each NSP cluster, so is service-affecting.
Ensure that you perform the procedure only during a scheduled maintenance period.
CAUTION Data Loss |
No data is written to an auxiliary database unless the auxiliary database setting that defines whether TLS is enabled or disabled matches the auxiliary database security setting in the NSP and NFM-P.
You must ensure that the security setting on the auxiliary database cluster, NSP cluster, and NFM-P main server match.
The following steps describe how to enable or disable TLS for auxiliary database communication.
Note: TLS must be enabled in the NSP and NFM-P configurations before you can enable TLS on an auxiliary database.
Note: You require root user privileges on each auxiliary database station, each NFM-P main server station, and each NSP deployer host.
Note: You also require nsp user privileges on each NFM-P main server station.
Note: release-ID in a file path has the following format:
R.r.p-rel.version
where
R.r.p is the NSP release, in the form MAJOR.minor.patch
version is a numeric value
Steps
1 |
Start the PKI server, if the server is not running; perform To configure and enable a PKI server. Note: The PKI server is required for internal system configuration purposes. | ||
2 |
Log in as the root user on an auxiliary database station. Note: In a DR NSP deployment, you must log in on a station in the primary auxiliary database cluster. | ||
3 |
If you are configuring a standalone auxiliary database, go to Step 6. | ||
Verify DR cluster-copy | |||
4 |
If you are upgrading the first auxiliary database cluster in a DR NSP deployment, you must verify the success of the most recent copy-cluster operation, which synchronizes the database data between the redundant clusters. Note: You must not proceed to the next step until the copy-cluster operation is complete and successful. Perform one of the following periodically to check the copy-cluster status.
| ||
Stop database proxies | |||
5 |
Perform the following steps on each auxiliary database station in each auxiliary database cluster to stop the database proxy.
| ||
Configure TLS, standalone or primary cluster | |||
6 |
Open the following file using a plain-text editor such as vi: /opt/nsp/nfmp/auxdb/install/config/install.config | ||
7 |
Changing a parameter in the auxiliary database install.config file can have serious consequences that include service disruption. Do not change any parameter in the install.config file, other than the parameters described in the step, without guidance from technical support. Edit the following lines in the file to read as shown below: Note: TLS must be enabled in the NSP and NFM-P configurations before you can enable TLS on an auxiliary database. secure=value pki_server=server pki_server_port=port where value is true or false, and indicates whether TLS is enabled server is the PKI server IP address or hostname port is the PKI server port number | ||
8 |
Save and close the install.config file. | ||
9 |
Enter the following: # /opt/nsp/nfmp/auxdb/install/bin/auxdbAdmin.sh configureTLS ↵ The script prompts for the auxiliary database dba password. | ||
10 |
Enter the required password. The script configures TLS on the station. | ||
11 |
Perform the following steps on each auxiliary database station in the cluster.
| ||
12 |
If you are configuring a standalone auxiliary database, go to Step 24. | ||
Configure TLS, standby cluster | |||
13 |
Log in as the root user on an auxiliary database station in the standby auxiliary database cluster. | ||
14 |
Perform the following steps on each auxiliary database station in the cluster.
| ||
15 |
Enter the following: # ./auxdbAdmin.sh start ↵ The auxiliary database cluster starts. | ||
16 |
Open the following file using a plain-text editor such as vi: /opt/nsp/nfmp/auxdb/install/config/install.config | ||
17 |
Changing a parameter in the auxiliary database install.config file can have serious consequences that include service disruption. Do not change any parameter in the install.config file, other than the parameters described in the step, without guidance from technical support. Edit the following lines in the file to read as shown below: secure=value pki_server=server pki_server_port=port where value is true or false, and indicates whether TLS is enabled server is the PKI server IP address or hostname port is the PKI server port number | ||
18 |
Save and close the install.config file. | ||
19 |
Enter the following: # /opt/nsp/nfmp/auxdb/install/bin/auxdbAdmin.sh configureTLS ↵ The script sequentially prompts for the root user password of each auxiliary database station. | ||
20 |
Enter the required password at each prompt. The script configures TLS on the station. | ||
21 |
Enter the following: # ./auxdbAdmin.sh stop ↵ The auxiliary database cluster stops. | ||
22 |
Perform the following steps on each auxiliary database station in the cluster.
| ||
Start database proxies | |||
23 |
Perform the following steps on each auxiliary database station in each auxiliary database cluster to start the database proxy.
| ||
Configure NFM-P | |||
24 |
Perform Step 25 to Step 27 on each main server. | ||
25 |
Stop the main server.
| ||
26 |
When the main server is stopped, enable secure auxiliary database communication on the main server.
| ||
27 |
Start the main server.
| ||
Configure NSP clusters | |||
28 |
If the NFM-P is not part of a shared-mode deployment that includes an NSP cluster, go to Step 37. | ||
29 |
Log in as the root user on the NSP deployer host in the standalone or primary NSP cluster. | ||
30 |
Open the following file using a plain-text editor such as vi: /opt/nsp/NSP-CN-DEP-release-ID/NSP-CN-release-ID/config/nsp-config.yml | ||
31 |
Locate the following section: auxDb: secure: "value" ipList: "local_cluster_IPs" standbyIpList: "peer_cluster_IPs" where value is true or false, and specifies whether TLS is enabled | ||
32 |
Set the secure parameter to true or false, as required. | ||
33 |
Save and close the nsp-config.yml file. | ||
34 |
Enter the following to start the NSP cluster: Note: If the NSP cluster VMs do not have the required SSH key, you must include the --ask-pass argument in the command, as shown in the following example, and are subsequently prompted for the root password of each cluster member: nspdeployerctl --ask-pass install --config --deploy # /opt/nsp/NSP-CN-DEP-release-ID/bin/nspdeployerctl install --config --deploy ↵ The NSP cluster starts, and the TLS configuration update is put into effect. | ||
35 |
If the NSP is a DR deployment, perform Step 29 to Step 34 on the standby NSP cluster. | ||
36 |
If no other components are to be deployed, stop the PKI server by entering Ctrl+C in the console window. | ||
37 |
Close the open console windows. End of steps |