Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Installing the NorthStar Controller 5.0.0

 

You can use the procedures described in the following sections if you are performing a fresh install of NorthStar Controller Release 5.0.0, or upgrading from an earlier release, unless you are using NorthStar analytics. Steps that are not required if upgrading are noted.

Note

If you are upgrading to NorthStar 5.0.0 from an earlier release and you are using NorthStar analytics, you must upgrade NorthStar manually using the procedure described in Upgrading to NorthStar 5.0 from a Pre-4.3 Version with Analytics.

The NorthStar software and data are installed in the /opt directory. Be sure to allocate sufficient disk space. See NorthStar Controller System Requirements for our memory recommendations.

Note

When upgrading NorthStar Controller, ensure that the /tmp directory has enough free space to save the contents of the /opt/pcs/data directory because the /opt/pcs/data directory contents are backed up to /tmp during the upgrade process.

If you are installing NorthStar for a high availability (HA) cluster, ensure that:

  • You configure each server individually using these instructions before proceeding to HA setup.

  • The database and rabbitmq passwords are the same for all servers that will be in the cluster.

  • All server time is synchronized by NTP using the following procedure:

    1. Install NTP.
      yum -y install ntp
    2. Specify the preferred NTP server in ntp.conf.
    3. Verify the configuration.
      ntpq -p
    Note

    All cluster nodes must have the same time zone and system time settings. This is important to prevent inconsistencies in the database storage of SNMP and LDP task collection delta values.

Note

To upgrade NorthStar Controller in an HA cluster environment, see Upgrade the NorthStar Controller Software in an HA Environment.

The following sections describe the download, installation, and initial configuration of the NorthStar Controller.

Note

The NorthStar Controller software includes a number of third-party packages. To avoid possible conflict, we recommend that you only install these packages as part of the NorthStar Controller RPM bundle installation rather than installing them manually.

For HA setup after all the servers that will be in the cluster have been configured, see Configuring a NorthStar Cluster for High Availability.

Download the Software

The NorthStar Controller software download page is available at https://www.juniper.net/support/downloads/?p=northstar#sw.

  1. From the Version drop-down list, select the version number.
  2. Click the NorthStar Application (which includes the RPM bundle) and the NorthStar JunosVM to download them.

If Upgrading, Back Up Your JunosVM Configuration and iptables

If you are doing an upgrade from a previous NorthStar release, and you previously installed NorthStar and Junos VM together, back up your JunosVM configuration before installing the new software. Restoration of the JunosVM configuration is performed automatically after the upgrade is complete as long as you use the net_setup.py utility to save your backup.

  1. Launch the net_setup.py script:
    [root@hostname~]# /opt/northstar/utils/net_setup.py
  2. Type D and press Enter to select Maintenance and Troubleshooting.
  3. Type 1 and press Enter to select Backup JunosVM Configuration.
  4. Confirm the backup JunosVM configuration is stored at '/opt/northstar/data/junosvm/junosvm.conf'.
  5. Save the iptables.
    iptables-save > /opt/northstar/data/iptables.conf

Install NorthStar Controller

You can either install the RPM bundle on a physical server or use a two-VM installation method in an OpenStack environment, in which the JunosVM is not bundled with the NorthStar Controller software.

The following optional parameters are available for use with the install.sh command:

- -vmSame as ./install-vm.sh, creates a two-VM installation.
- -skip-bridgeFor a physical server installation, skips checking if the external0 and mgmt0 bridges exist.

The default bridges are external0 and mgmt0. If you have two interfaces such as eth0 and eth1 in the physical setup, you must configure the bridges to those interfaces. However, you can also define any bridge names relevant to your deployment.

Note

We recommend that you configure the bridges before running install.sh.

  • For a physical server installation, execute the following commands to install NorthStar Controller:

    [root@hostname~]# rpm -Uvh <rpm-filename>
    [root@hostname~]# cd /opt/northstar/northstar_bundle_x.x.x/
    [root@hostname~]# ./install.sh
    Note

    -Uvh works for both upgrade and fresh installation.

  • For a two-VM installation, execute the following commands to install NorthStar Controller:

    [root@hostname~]# rpm -Uvh <rpm-filename>
    [root@hostname~]# cd /opt/northstar/northstar_bundle_x.x.x/
    [root@hostname~]# ./install-vm.sh
    Note

    -Uvh works for both upgrade and fresh installation.

    The script offers the opportunity to change the JunosVM IP address from the system default of 172.16.16.2.

    Checking current disk space
    INFO: Current available disk space for /opt/northstar is 34G. Will proceed with installation.
    System currently using 172.16.16.2 as NTAD/junosvm ip
    Do you wish to change NTAD/junosvm ip (Y/N)? y
    Please specify junosvm ip:

Configure Support for Different JunosVM Versions

If you are using a two-VM installation, in which the JunosVM is not bundled with the NorthStar Controller, you might need to edit the northstar.cfg file to make the NorthStar Controller compatible with the external VM. Use one of the following procedures, depending on your JunosVM version. For a NorthStar cluster configuration, you must perform the procedure for each node in the cluster.

Note

If your JunosVM version is Release 17.2R1 or later, up to, but not including, Release 18.2R1, there is nothing you need to do. Your JunosVM is compatible with NorthStar Controller.

If your external JunosVM is Release 18.3R2 or later, or 18.4R2 or later, perform the following steps:

  1. SSH to the NorthStar server.
  2. Using a text editor such as vi, edit the following statement in the opt/northstar/data/northstar.cfg file from the default of ntad_version=2 to ntad_version=4:
  3. Manually restart the toposerver process:
  4. Set up the SSH key for the external VM by selecting option H from the Setup Main Menu when you run the net_setup.py script, and entering the requested information.

If your external JunosVM is Release 18.2R1 or later, up to 18.3R2 or 18.4R2 where the previous instructions apply, perform the following steps:

  1. SSH to the NorthStar server.
  2. Using a text editor such as vi, edit the following statement in the opt/northstar/data/northstar.cfg file from the default of ntad_version=2 to ntad_version=3:
  3. Manually restart the toposerver process:
  4. Set up the SSH key for the external VM by selecting option H from the Setup Main Menu when you run the net_setup.py script, and entering the requested information.

If your external JunosVM is older than Release 17.2R1, perform the following steps:

Note

If you edit the northstar.cfg file to make the NorthStar Controller compatible with an external JunosVM older than 17.2R1, segment routing on the NorthStar Controller will no longer be supported.

  1. SSH to the NorthStar server.
  2. Using a text editor such as vi, edit the following statement in the opt/northstar/data/northstar.cfg file from the default of use_sr=1 to use_sr=0:
  3. Manually restart the toposerver process:
  4. Set up the SSH key for the external VM by selecting option H from the Setup Main Menu when you run the net_setup.py script, and entering the requested information.

Create Passwords

Note

This step is not required if you are doing an upgrade rather than a fresh installation.

When prompted, enter new database/rabbitmq and web UI Admin passwords.

  1. Create an initial database/rabbitmq password by typing the password at the following prompts:
  2. Create an initial Admin password for the web UI by typing the password at the following prompts:

Enable the NorthStar License

Note

This step is not required if you are doing an upgrade rather than a fresh installation.

You must enable the NorthStar license as follows, unless you are performing an upgrade and you have an activated license.

  1. Copy or move the license file.
  2. Set the license file owner to the PCS user.
  3. Restart the necessary NorthStar Controller processes.
  4. Check the status of the NorthStar Controller processes until they are all up and running.

Adjust Firewall Policies

The iptables default rules could interfere with NorthStar-related traffic. If necessary, adjust the firewall policies.

Refer to NorthStar Controller System Requirements for a list of ports that must be allowed by iptables and firewalls.

Launch the Net Setup Utility

Note

This step is not required if you are doing an upgrade rather than a fresh installation.

Launch the Net Setup utility to perform host server configuration.

Configure the Host Server

Note

This step is not required if you are doing an upgrade rather than a fresh installation.

  1. From the NorthStar Controller setup Main Menu, type A and press Enter to display the Host Configuration menu:

    To interact with this menu, type the number or letter corresponding to the item you want to add or change, and press Enter.

  2. Type 1 and press Enter to configure the hostname. The existing hostname is displayed. Type the new hostname and press Enter.
  3. Type 2 and press Enter to configure the host default gateway. The existing host default gateway IP address (if any) is displayed. Type the new gateway IP address and press Enter.
  4. Type 3A and press Enter to configure the host interface #1 (external_interface). The first item of existing host interface #1 information is displayed. Type each item of new information (interface name, IPv4 address, netmask, type), and press Enter to proceed to the next.Note

    The designation of network or management for the type of interface is a label only, for your convenience. NorthStar Controller does not use this information.

  5. Type A and press Enter to add a host candidate static route. The existing route, if any, is displayed. Type the new route and press Enter.
  6. If you have more than one static route, type A and press Enter again to add each additional route.
  7. Type Z and press Enter to save your changes to the host configuration.Note

    If the host has been configured using the CLI, the Z option is not required.

    The following example shows saving the host configuration.

  8. Press Enter to return to the Main Menu.

Configure the JunosVM and its Interfaces

Note

This step is not required if you are doing an upgrade rather than a fresh installation.

From the Setup Main Menu, configure the JunosVM and its interfaces. Ping the JunosVM to ensure that it is up before attempting to configure it. The net_setup script uses IP 172.16.16.2 to access the JunosVM using the login name northstar.

  1. From the Main Menu, type B and press Enter to display the JunosVM Configuration menu:

    To interact with this menu, type the number or letter corresponding to the item you want to add or change, and press Enter.

  2. Type 1 and press Enter to configure the JunosVM hostname. The existing JunosVM hostname is displayed. Type the new hostname and press Enter.
  3. Type 2 and press Enter to configure the JunosVM default gateway. The existing JunosVM default gateway IP address is displayed. Type the new IP address and press Enter.
  4. Type 3 and press Enter to configure the JunosVM BGP AS number. The existing JunosVM BGP AS number is displayed. Type the new BGP AS number and press Enter.
  5. Type 4A and press Enter to configure the JunosVM interface #1 (external_interface). The first item of existing JunosVM interface #1 information is displayed. Type each item of new information (interface name, IPv4 address, netmask, type), and press Enter to proceed to the next.Note

    The designation of network or management for the type of interface is a label only, for your convenience. NorthStar Controller does not use this information.

  6. Type B and press Enter to add a JunosVM candidate static route. The existing JunosVM candidate static route (if any) is displayed. Type the new candidate static route and press Enter.
  7. If you have more than one static route, type B and press Enter again to add each additional route.
  8. Type Z and press Enter to save your changes to the JunosVM configuration.

    The following example shows saving the JunosVM configuration.

  9. Press Enter to return to the Main Menu.
  10. If you are doing an upgrade from a 2.x release, use the following command to restore the iptables that you previously saved:
    iptables-restore < /opt/northstar/data/iptables.conf

Set Up the SSH Key for External JunosVM

Note

This step is not required if you are doing an upgrade rather than a fresh installation.

For a two-VM installation, you must set up the SSH key for the external JunosVM.

  1. From the Main Menu, type H and press Enter.

    Follow the prompts to provide your JunosVM username and router login class (super-user, for example). The script verifies your login credentials, downloads the JunosVM SSH key file, and returns you to the main menu.

    For example:

Upgrade the NorthStar Controller Software in an HA Environment

There are some special considerations for upgrading NorthStar Controller when you have an HA cluster configured. Use the following procedure:

  1. Before installing the new release of the NorthStar software, ensure that all individual cluster members are working. On each node, execute the supervisorctl status script:

    For an active node, all processes should be listed as RUNNING as shown in this example:

    Note

    This is just an example; the actual list of processes varies according to the version of NorthStar on the node, your deployment setup, and the optional features installed.

    [root@node-1 ~]# supervisorctl status

    For a standby node, processes beginning with “northstar”, “northstar_pcs”, and “netconf” should be listed as STOPPED. Also, if you have analytics installed, some of the processes beginning with “collector” are STOPPED. Other processes, including those needed to preserve connectivity, remain RUNNING. An example is shown here.

    Note

    This is just an example; the actual list of processes varies according to the version of NorthStar on the node, your deployment setup, and the optional features installed.

    [root@node-1 ~]# supervisorctl status
  2. Ensure that the SSH keys for HA are set up. To test this, try to SSH from each node to every other node in the cluster using both user “root” and user “pcs”. If the SSH keys for HA are set up, you will not be prompted for a password. If you are prompted for a password, see Configuring a NorthStar Cluster for High Availability for the procedure to set up the SSH keys. Be sure to do this for both user “root” and user “pcs”.
  3. On one of the standby nodes, install the new release of the NorthStar software according to the instructions at the beginning of this topic. Check the processes on this node before proceeding to the other standby node(s) by executing the supervisorctl status script.

    Since the node comes up as a standby node, some processes will be STOPPED, but the “infra” group of processes, the “listener1” process, the “collector:worker” group of processes (if you have them), and the “junos:junosvm” process (if you have it) should be RUNNING. Wait until those processes are running before proceeding to the next node.

  4. Repeat this process on each of the remaining standby nodes, one by one, until all standby nodes have been upgraded.
  5. On the active node, restart the HA-agent process to trigger a switchover to a standby node.

    One of the standby nodes becomes active and the previously active node switches to standby mode.

  6. On the previously active node, install the new release of the NorthStar software according to the instructions at the beginning of this section. Check the processes in this node using supervisorctl status; their status (RUNNING or STOPPED) should be consistent with the node’s new standby role.
Note

The newly upgraded software automatically inherits the net_setup settings, HA configurations, and all credentials from the previous installation. Therefore, it is not necessary to re-run net_setup unless you want to change settings, HA configurations, or password credentials.