To migrate from CAS to OAUTH2 NSP user authentication
Purpose
CAUTION Service disruption |
Performing the procedure requires a restart of each NSP cluster, which is service-affecting.
You must perform the procedure only during a scheduled maintenance period.
Nokia strongly recommends migrating from the deprecated CAS authentication mode to OAUTH2 authentication, as described in the following steps.
Steps
Prepare for migration | |
1 |
As required, edit NFM-P user accounts to prepare for importing to the NSP local user database; for example, remove duplicate user IDs, or enter e-mail addresses. Note: For users whose user account includes an e-mail address, the import operation sends a new randomly generated temporary password. Users who lack an e-mail address are assigned a global temporary password. |
Undeploy standby NSP cluster | |
2 |
Log in as the root user on the NSP deployer host in the standby data center. |
3 |
Open a console window. |
4 |
Perform the following steps to preserve the existing cluster data.
|
5 |
Enter the following: # cd /opt/nsp/NSP-CN-DEP-release-ID/bin ↵ |
6 |
Enter the following: 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 uninstall --undeploy # ./nspdeployerctl uninstall --undeploy ↵ |
Undeploy and configure primary NSP cluster | |
7 |
Log in as the root user on the NSP deployer host in the primary data center. |
8 |
Open a console window. |
9 |
Perform the following steps to preserve the existing cluster data.
|
10 |
Enter the following: # cd /opt/nsp/NSP-CN-DEP-release-ID/bin ↵ |
11 |
Enter the following: 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 uninstall --undeploy # ./nspdeployerctl uninstall --undeploy ↵ |
12 |
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 |
13 |
Configure the authMode parameter in the sso section, as shown below. sso: authMode: "oauth2" |
14 |
Configure other OAUTH2 parameters, as required, such as the following: |
15 |
Disable the CAS configuration; use a leading # symbol to comment out each CAS-specific SSO parameter line in the file. |
16 |
Save and close the nsp-config.yml file. |
17 |
Enter the following: # cd /opt/nsp/NSP-CN-DEP-release-ID/bin ↵ |
18 |
Enter the following: 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 # ./nspdeployerctl install --config --deploy ↵ The NSP configuration change is put into effect, and OAUTH2 authentication is enabled. |
Configure standby NSP cluster | |
19 |
Log in as the root user on the NSP deployer host in the standby data center. |
20 |
Copy the secret files for OAUTH2 deployment from the NSP deployer host in the primary data center.
|
21 |
On the standby NSP deployer host, 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 |
22 |
Configure the authMode parameter in the sso section, as shown below. sso: authMode: "oauth2" |
23 |
Specify the same values for the OAUTH2 parameters that you configured in Step 14. Note: The primary and standby OAUTH2 configurations must match. |
24 |
Disable the CAS configuration; use a leading # symbol to comment out each CAS-specific SSO parameter line in the file. |
25 |
Save and close the nsp-config.yml file. |
26 |
Enter the following: # cd /opt/nsp/NSP-CN-DEP-release-ID/bin ↵ |
27 |
Enter the following: 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 # ./nspdeployerctl install --config --deploy ↵ The NSP configuration change is put into effect, and OAUTH2 authentication is enabled. |
28 |
Close the open console windows. |
Set OAUTH2 mode on NFM-P main servers | |
29 |
If the NSP deployment includes the NFM-P, you must configure each NFM-P main server to align with the NSP authentication mode. Otherwise, go to Step 42. |
30 |
If the NFM-P system is redundant, perform Step 33 to Step 35 on the standby main server. |
31 |
Perform Step 33 to Step 35 on the standalone or primary main server. |
32 |
Go to Step 36. |
33 |
Log in as the root user on the main server station. |
34 |
Stop the main server.
|
35 |
Update the main server configuration.
|
Start NFM-P main servers | |
36 |
Perform the following steps on each main server to start the main server. Note: You must perform the steps first on the standalone or primary main server.
|
Import NFM-P users and groups | |
37 |
Sign in to the NSP as the admin user. You are prompted to change your password. |
38 |
Enter a new password. The NSP UI opens. |
39 |
Open Users and Security. |
40 |
Perform the NFM-P user import procedure in the NSP System Administrator Guide. |
41 |
Inform each imported NFM-P user of the new password sent to their e-mail address, or of the global temporary password assigned to the user account, if an e-mail address is not assigned. |
42 |
Close the open console windows. End of steps |