Lyftron server installation procedure

Make sure to review our hardware recommendations and installation prerequisites. It is assumed at this stage that hardware and prerequisite requirements are met.

Step 1. Start the installation by running Lyftron.msi.

Installer Loading

Welcome window appears.

Welcome

Click Next.

Step 2. Read the license text and if you agree, accept the license. Then click Next.

License

You may install Lyftron only after you accept the license. If you agree Click Next, otherwise click Cancel to abort the installation.

Step 3. Select destination folder

Destination folder

Step 4. Provide database server name

Deployment of metadata databases to different servers is not supported by installer. If you need such configuration, it has to be done manually.

Provide database server name you want to host Lyftron metabase and Spark metastore databases on.

Do not enter "(local)" alias for local database because it will break Apache Spark. For local database always use localhost with optional instance name like localhost\myinstance.

Database

If you already have MANUALLY installed or upgraded Lyftron and Apache Spark metabases, uncheck the "Install or upgrade Lyftron and local Apache Spark metabases" checkbox to skip automatic database deployment.

Click Next.

Step 5. Provide configuration of the Windows service

Service credentials

Please choose the proper settings using the table below:

Domain Account Password Description
NT AUTHORITY NetworkService not required (leave empty) The NetworkService account is a predefined local account used by the service control manager. It has minimum privileges on the local computer and acts as the computer on the network. This account does not have a password, so any password information that you provide is ignored. A service that runs in the context of the NetworkService account presents the computer's credentials to remote servers. By default, the remote token contains SIDs for the Everyone and Authenticated Users groups.
NT AUTHORITY LocalService not required (leave empty) The LocalService account is a predefined local account used by the service control manager. It has minimum privileges on the local computer and presents anonymous credentials on the network. This account does not have a password, so any password information that you provide is ignored.
Machine name \<custom local user> enter local user designated password Local user account created on machine you install on.
Domain name \<custom domain user> enter domain user designated password Domain user account from your company domain.

Two scenarios are most common for choosing the service account:

  • Local computer Network Service (NT AUTHORITY\NetworkService). To authenticate using computer account pick NetworkService as service user name and NT AUTHORITY as NetBIOS domain name. A password is not required and ignored if entered.
  • Designated Active Directory user (NETBIOS_DOMAIN\user_name), for example CONTOSO\lyftronSvc. To authenticate using designated AD user, pick domain from the list or enter domain name manually, then enter the user name and provide password designated for the user name entered.

Click Next.

Service user name and password will be validated against Active Directory (AD) or local store respectively. In case you provide wrong credentials, an error message will be displayed:

Service credentials

Click OK and correct credentials entered until validation passes.

Step 6. Configure Lyftron instance parameters

Instance configuration

Provide custom TDS port, Web port, and Web SSL port, or accept the defaults.

To change port settings later, use Lyftron Admin Portal. Keep in mind that Windows Firewall rules are automatically configured during installation only. If you change ports in Lyftron Admin Portal, you need to modify the firewall rules too.

If you require Secure Sockets Layer (SSL) to be enabled, check the "Require SSL for Lyftron Administrative Portal and WebApi" checkbox. Installer loads a list of all certificates from local machine store, verifies them and presents in a dropdown list. Verified certificates are marked with "(VERIFIED)" name postfix. Select the desired certificate from the list.

It is recommended to choose from verified certificates because certificated that do not pass verification may not work. Installer will take care of configuring proper certificate binding in Windows.

Click Next.

Step 7. In the confirmation dialog click Install and allow privilege elevation when asked

Confirm installation

A progress windows will appear. Wait for the installation to finish.

Installation progress

When the installation completes successfully click Finish.

Installation finished

Post-installation steps

  1. Launch Web Administrative portal by navigating to http://localhost:9000, assuming you are logged on to Lyftron Windows server using Remote Desktop.

  2. Provide administrative credentials to log in. By default, all users that belong to Administrators group on a machine hosting Lyftron, have administrative privileges in Lyftron.

    Default behavior and security settings can be changed using Lyftron Admin Portal, as described in Configuration section that follows.

  3. Follow the steps described in Configuration section.