Update Nodinite from v6 to Nodinite v7
Upgrade your Nodinite v6 to Nodinite v7 with confidence. This guide walks you through every step, ensuring a smooth, secure, and efficient transition to the latest version.
Tip
If you have a non-prod environment, we recommend testing the upgrade process there first. This ensures you can validate all steps and configurations before applying them to your production environment.
Looking for a partner to help you update? Please contact any of our certified Partners.
This guide assumes you have Nodinite version 6 potentially with Monitoring Agents and Log Agents installed.
Important
You must have knowledge of account names and their passwords and you must have administrative rights on the Nodinite Application Server to perform the update.
Prerequisites
Before you begin the update process, ensure you have the following prerequisites in place:
- Inform end-users about the update and potential downtime.
- Backup your Nodinite databases and configuration files. This is crucial to prevent data loss in case of any issues during the update.
- Administrator access to the Nodinite Application Server where the update will be performed.
- PowerShell 7 installed on the Nodinite Application Server. This is required to run the update scripts.
- Nodinite 7 product key available in the Nodinite Portal. If you don't have one, contact your partner or Nodinite Support.
- Existing Nodinite v6 installation with Monitoring Agents and Log Agents configured. The update process will migrate these configurations to the new version.
- Latest version of .NET 9.0 Install .NET Runtime 9.0.x AND ASP.NET Core Runtime 9.0.x (Hosting bundle) installed on the Nodinite Application Server. This is required for the new features and improvements in Nodinite v7.
- Latest version of DacFX installed on the Nodinite Application Server. This is required for database migrations and updates.
- Stop the Nodinite Pickup Log Events Service before starting the update process. This ensures no new logs are picked up during the update, preventing potential data loss or corruption. There are changes to the address of the Log API and the configuration database changes its name during the update process, so it is crucial to stop the service before proceeding. After the update you can proceed to update the Pickup Log Events Service Logging Agent.
- Powershell 7 script user must be a member of the sysadmin role on the SQL Server instance where the Nodinite databases are hosted. This is required for the script to perform database migrations and updates.
Estimated time
On a high level, there are a few distinct steps in the update process:
- Register the Environment in the Nodinite Portal.
- Download, extract and and update Nodinite Core Services.
- Export the Monitoring Agent information.
- Import the Monitoring Agents to the Nodinite Portal.
- Download, extract and update the Monitoring Agents.
The update process typically takes only a few minutes. This estimate includes replacing all Monitoring Agents and Log Agents.
Step 1: Register Environment
In the Nodinite Portal, register your environment by following these steps:
Navigate to the existing Customer entry.
Find and Click on the Customer entry.Ensure you have Nodinite 7 product key available. If not, create it by clicking on Create Product Key button.
Example of a Nodinite 7 product key entry.Important
You must have a valid Nodinite 7 product key to proceed with the upgrade. If you can't create one, please contact your partner or Nodinite Support.
Click the Environment tab, then click the Add Environment button.
Click the Add Environment button to register a new environment.A modal appears; The default target run-time platform is Windows. Each has its own tab. At the time of this writing, only the Windows tab is available. Click on the Upgrade from Nodinite 6 button.
Click the Upgrade from Nodinite v6 button to proceed with the Environment registration.The modal changes and presents mandatory steps to follow in the specified order.
Configure Nodinite 7 variables
💡Configure the necessary variables for the Nodinite 7 environment.
In this step, you will set the required variables for your Nodinite 7 environment. These variables are essential for the proper functioning of Nodinite and must be configured correctly.
Some of the values are hard to change later, so ensure you set them correctly. You run-time platform is configured with these values, and they are used in the PowerShell script that is run later in the process. If you need to reconfigure these values, you may end up removing all but the databases and start over.
If you are reluctant to provide some of the values, you must still provide some values to proceed. You can manually change them later in the PowerShell 7 script that is run later in the process.
Mandatory | Variable | Default | Description |
---|---|---|---|
Environment Name* | The name of the target environemnt NOTE: Once set, this cannot be changed. |
||
Description | Description to clarify purpose or usage. | ||
Destination Root Path | C:\Program Files\Nodinite | Leave it empty to select default value. | |
<DomainName> |
Name of the Windows Active Directory Domain; Default prefix for accounts; | ||
Admin Account | <NodiniteAdminUserAccountName> |
Enter Nodinite Administrator Account Name. | |
Enter Nodinite Administrator Account Email. | |||
<DefaultServiceAccountName> |
Enter Default Services Account Name. | ||
Web Client Port | 40000 | IIS Port for Web Client | |
Web API Port | 40001 | IIS Port for Web API | |
Log API Port | 40002 | IIS Port for Log API | |
Logging Service Port | 40003 | IIS Port for Logging Service | |
Monitoring Service Port | 40004 | IIS Port for Monitoring Service |
Configure Database Settings
💡Configure the database settings for Nodinite 7.
There are different settings depending on the type of database you want to use.
- Standalone - Use a single SQL Server instance for all databases. Use this option if you are using SQL Server Standard, Enterprise, or Express edition. Tihs also works for failover clusters.
- Always on - Use a SQL Server Always On Availability Group for high availability and disaster recovery.
- Azure - Managed Instance - Use an Azure SQL Managed Instance for a fully managed database service in the cloud. This option is suitable for cloud-based deployments. If you select this option, you must provide the connection string to the Azure SQL Managed Instance. As this option is NOT using integrated security, you must eventually provide the username and password for the database. This should be done by replacing this value directly in the PowerShell script that is run later in the process.
- You can also choose to Edit Connection String Manually if you prefer to configure the connection string yourself.
Mandatory | Option/Setting | Default | Description |
---|---|---|---|
Database Type |
|
Type of database to use for Nodinite 7. The default is Standalone. If you select Clustered, you must provide a connection string to the SQL Server instance. | |
Database Server Name | localhost |
Name of the SQL Server instance. The default is localhost. If you are using a named instance, use the format ServerName\InstanceName . |
|
Database Name | NodiniteConfig_<EnvironmentName> |
Name of the existing Nodinite version 6 database to use updating to Nodinite 7. NOTE: After the update, this database will be renamed to Nodinite_<EnvironmentName>_Config . You must reflect this change to the Nodinite Pickup Log Events Service once the update is complete. |
|
Edit Connection String Manually | No | Whether to edit the connection string manually. | |
Connect without encrypt | No | Whether to connect without encryption. | |
Encrypt Connection | Yes | Whether to encrypt the connection. | |
Trust server certificate | No | Whether to trust the server certificate. | |
Trust Server Certificate | No | Whether to trust the server certificate. | |
Sql Package Path | C:\Program Files\Microsoft SQL Server\170\DAC\bin\SqlPackage.exe | Path to the SqlPackage.exe tool. |
Step 2: Save
💡Persist your settings.
You must save your settings before proceeding to the next step. Review all settings carefully to ensure they are correct.
Click the Save button to save your settings.
Example Screenshot of the Save Button.
If the save is successful, you will see a confirmation message and the Next button will be enabled.
Click the Next button to proceed to the next step.
Step 3: Review
💡Review settings using a visual graph before you continue with the update operation.
In this step, you have the opportunity to review your settings before you download the necessary binaries for Nodinite 7.
Example of the Review Settings step with a Mermaid diagram.
We recommend reviewing all settings carefully to ensure they are correct before proceeding. Click on the 'Overview' button to open a Mermaid diagram displays the current configuration in a user-friendly graph.
Example of how the updated Environment will look like after the update operation has completed.
Step 4: Download Binaries
In this step, you will download the necessary binaries for Nodinite 7. Click the Download Core button to start the download process.
Example of 'Download Core' binaries button.
Once the download is complete, you can proceed to the next step.
Step 5: Run PowerShell 7 Script
💡Run the PowerShell 7 script to update your environment.
In this step, you will run the PowerShell 7 script to update your environment. This script will perform the necessary actions to update your environment to Nodinite 7.
-
- Open a PowerShell 7 terminal with administrative privileges.
-
- Navigate to the folder where you extracted the downloaded ZIP file.
-
- Run the script by executing the following command:
.\Nodinite7-<%EnvironmentName%>-Instance-Install.ps1
Important
If you provided bogus values in the previous steps, you must edit the script to provide the correct values for the variables. This includes the database connection string, service account names, and other settings you specified in the Nodinite Portal.
-
- Open the Web Client and perform some basic checks to ensure the update was successful.
-
- Head back to the Nodinite Portal and proceed to the next step.
Step 6: Export Monitoring Agent Info
💡Export the Monitoring Agent information for the next step.
In this step, you will export information about the Monitoring Agents; the output is JSON. This information will be used in the next step to help update also the Monitoring Agents for use with your updated Nodinite 7 environment.
- Open the Web Client and navigate to the Tools section in side bar.
- Click the Export Monitoring Agents button to export the information.
Example of the Export Monitoring Agents button in the Tools section.
A modal will appear, the important piece of information is the 'UniqueId' that was set during the update process on each Monitoring Agent.
Example of the Export Monitoring Agents modal.
Click the on the Text area to copy the information to the clipboard. Do NOT change the information in the text area, as it is used in the next step to import the Monitoring Agents information.
Head back to the Nodinite Portal and proceed to the next step.
Step 7: Import Monitoring Agents
💡Import the Monitoring Agents information to the Nodinite Portal.
In this step, you will import the Monitoring Agents information that you exported in the previous step.
- Paste the copied information into the text area and click the 'Upload & Save' button.
Example of the Import Monitoring Agents JSON text area. - A confirmation message will appear, indicating that the Monitoring Agents information has been successfully imported.
- Click the 'Next' button to proceed with the next step.
Step 8: Download and Update Monitoring Agents
💡Download and update the Monitoring Agents for Nodinite 7 using the default ports and the common service account. If you have the need to change these; continue with the Use Custom Ports And Specific Service Accounts sub step.
In this step, you will download the updated Monitoring Agents for Nodinite 7 with default settings and install them in your environment. The process is similar to the previous steps, but now you will download the Monitoring Agents specifically for Nodinite 7. The current Windows Service based Monitoring Agents will be replaced with the new ones hosted in IIS.
Example of the Download Monitoring Agents button.
Use Default Ports
The ports are set to the default values, but you can change them later if needed. Changing the ports will require you to update the IIS bindings and the Nodinite Portal settings.
Click the 'Download Monitoring Agents' button to start the download process.
Once the download is complete, extract the ZIP file to a folder on your Nodinite Application Server.
Open a PowerShell 7 terminal with administrative privileges.
Navigate to the folder where you extracted the downloaded ZIP file.
Run the script by executing the following command:
.\Nodinite7-<%EnvironmentName%>-Agents-Install.ps1
Once the script has completed successfully, you can open the Web Client and perform some basic checks to ensure the update was successful.
- In the Portal, click the 'Next' button to exit the update process.
- In the Nodinite Portal, you can now manage your updated environment and the Monitoring Agents.
Example of the Edit Environment Overview page in the Nodinite Portal for a Windows Server run-time.
Important
You should NOT change the Environment Name or the Destination Root Path after the update process has completed. If you need to change these values, you must remove the environment and start over. Contact your partner or Nodinite Support if you need help on this matter. Changing ports also requires you to update the IIS bindings and the Nodinite Portal settings
Use Custom Ports And Specific Service Accounts
💡A guide for changing ports and service accounts.
If you need to change the ports or use specific service accounts for the Monitoring Agents, follow these steps:
Click on the 'Next' button to continue thus exiting the update process.
Click on the 'Agents' tab to access the Monitoring Agents settings.
- Change ports and service accounts as needed.
Click the *Save' button to save your changes.
Close the Environment modal.
Click the Actions button and select Download Monitoring Agents.
Extract the ZIP file to a folder on your Nodinite Application Server.
Open a PowerShell 7 terminal with administrative privileges.
Navigate to the folder where you extracted the downloaded ZIP file.
Run the script by executing the following command:
.\Nodinite7-<%EnvironmentName%>-Agents-Install.ps1
Contact our support
If you have questions or encounter issues during the upgrade, contact your partner for 1st line support or email us at support@nodinite.com.
Next Step
[Migrating to version 7 of the Pickup LogEvents Service Logging Agent][]