Upgrade connectors

This topic describes the connector upgrade process.

 

If you need to upgrade to the new remote-access-cli snap, see Upgrade the Alero connector to Remote Access CLI.

The Remote Access connector installation script upgrades the connector, with no data loss or reconfiguration required.

Upgrade the Remote Access connector

  1. Access the Remote Access connector host machine

  2. Run the following command to confirm that the latest CLI snap package is installed.

      
    sudo snap refresh remote-access-cli

    If the latest cli snap package is installed, the following message appears.

  3. Launch the connector installation script using the command that matches the location of your tenant.

    1. By default, the connector initiates and maintains a secure tunnel with the Remote Access SaaS service via SSH protocol over port 443. To configure the connector to use SSH protocol over port 22, add the --service_port parameter.

        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain [domain] --service_port [22/443]

      To update an existing connector to change the port, run the script without changing the environment_domain parameter and add the --service_port parameter, as shown in the following example.

       

      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain alero.io --service_port 22

      To update the port used by an existing connector for SSH traffic, run the script without changing the environment_domain and add the --service_port parameter, as shown in the following example.

       

      sudo /snap/remote-access-cli/current/installation/install.sh --service_port 22
    2.   
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain alero.io
        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain alero.eu
        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain ca.alero.io
        
      sudo /snap/snap/remote-access-cli/current/installation/install.sh --environment_domain au.alero.io
        
      sudo /snap/snap/remote-access-cli/current/installation/install.sh --environment_domain uk.alero.io
        
      sudo /snap/snap/remote-access-cli/current/installation/install.sh --environment_domain in.alero.io
        
      sudo /snap/snap/remote-access-cli/current/installation/install.sh --environment_domain sg.alero.io

  4. The script runs, and requests the Remote Access user docker repository password.

    Copy this password from the Install Connector wizard in the Remote Access portal.

  5. Enter the password. The script then pulls the latest Remote Access connector docker container and verifies that it is newer than the existing container.

    After the script confirms that the Docker container is newer than the existing one, it does the following:

    • Stops running the current container

    • Removes the previous container but saves the necessary Remote Access volumes (app, logs)

    • Starts running Docker with the new container

    • Checks that the Docker container is 'up'.

  6. Confirm that the Remote Access connector is up and reports verification and upgrade from:to versions.

Upgrade the Alero connector to Remote Access CLI

We have officially renamed the former Alero connector to Remote Access connector. Due to this name change, the Alero-connector snap is being deprecated.

 

None of your existing connector data is impacted when you upgrade to the new Remote Access connector. Your information is saved on the connector component and only the CLI component is changed in this upgrade.

Follow these steps to install the new remote-access-cli snap for continued service.

Step 1: Install the connector CLI

  1. Log in to the connector host machine as a user with sudo rights.

  2. Install the remote-access-cli agent with the following command:

      
    sudo snap install remote-access-cli

Step 2: Install the Remote Access connector

On the connector host machine:

  1. Launch the Remote Access connector installation script using the command that matches the location of your tenant.

    1. By default, the connector initiates and maintains a secure tunnel with the Remote Access SaaS service via SSH protocol over port 443. To configure the connector to use SSH protocol over port 22, add the --service_port parameter.

        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain [domain] --service_port [22/443]

      To update an existing connector to change the port, run the script without changing the environment_domain parameter and add the --service_port parameter, as shown in the following example.

       

      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain alero.io --service_port 22

      To update the port used by an existing connector for SSH traffic, run the script without changing the environment_domain and add the --service_port parameter, as shown in the following example.

       

      sudo /snap/remote-access-cli/current/installation/install.sh --service_port 22
    2.   
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain alero.io
        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain alero.eu
        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain ca.alero.io
        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain au.alero.io
        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain uk.alero.io
        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain in.alero.io
        
      sudo /snap/remote-access-cli/current/installation/install.sh --environment_domain sg.alero.io

  2. When you are prompted for the Remote Access user's password, go back to the Remote Access portal to get the password.

In the Remote Access portal

  1. Under Install from Snap, you can see the command that you used to install the connector CLI, and verification when the CLI has been installed successfully.

  2. Under Run connector installation, you can see the command that you used to launch the connector installation script.

  3. Copy the password and return to the connector hosting machine.

On the connector hosting machine

  1. Paste the password that you copied from the Remote Access portal into the waiting prompt on the connector hosting machine.

After the Remote Access connector has been installed successfully, the connector CLI prompt appears.

Step 3: Remove the previous Alero-Connector

Run this script to remove the previous Alero connector:

  
sudo snap remove alero-connector