Upgrading Skylight orchestrator Docker 22.10

This Skylight orchestrator Docker Upgrade article includes procedures that will help the personnel of mobile network operators, Cable Multi-Service Operators (MSOs), business service providers, and cloud and data center services upgrade and maintain their performance assurance solutions.

Specifically, this article explains how to upgrade the Skylight orchestrator Docker to version 22.10 from any of these previously-installed versions:

• Skylight orchestrator Docker running 21.08 / 21.08.1 5K profile

Prior installation data and configuration information is retained during the upgrade process.

Pre-Upgrade Requirements and Procedures

This section describes the requirements and procedures that must be followed before performing an upgrade.

The following sections cover the procedures for upgrading a Docker host running Skylight orchestrator 21.08 or Skylight orchestrator 21.08.1 software on the Docker host. During the upgrade, the system will be unavailable for approximately 90 minutes.

Before performing the upgrade procedures, you must read through the Release Notes for Skylight orchestrator 22.10.

---

WARNING: If you are using Skylight Performance Analytics, the Roadrunner component must be upgraded to the latest release before upgrading to Skylight orchestrator Docker 22.10. Please contact the Skylight Analytics support team to verify that your Roadrunner version is compatible with Skylight orchestrator Docker 22.10.

---

Requirements

You must ensure you have the following items before starting the upgrade procedure. If you are missing anything, contact Accedian Technical Support.

1. SSH client (such as PuTTY)
2. SCP client (such as WinSCP)
3. The Docker host must have over 25 GiB of free space for Docker images.
4. The Docker host must have 15 GiB of free space for the temporary folder used during the installation.
5. One user must have sudo privileges or root access on the Docker host.
6. The multipath tool (multipath-tools package) must have been installed on the host.
7. To upgrade to version 22.10, you must have access to the following package file:

   docker-dist-22.10-GA-5.sh

8. Feature keys required for your software.

   ---

   Note: Skylight orchestrator uses feature keys to enable certain menus and features. If you do not obtain and install the new keys (as explained later in this section), you will not have access to the new features available in Skylight orchestrator 22.10.

   ---

9. Check and ensure the current deployment profile matches with resource requirements (vCPU, RAM, disk). Please refer to the Docker Deployment Profile Configuration and Docker Disk Configuration articles for additional information

Pre-Upgrade Procedures

This section explains the procedures that must be performed before upgrading to version 22.10.

The pre-upgrade procedures are:

1. Backing up the Data Store
2. Transferring file to the Docker host that deployed Skylight orchestrator Docker

Backing up the Data Store

A database backup of the system is needed.

Requirement:

Skylight orchestrator services must be started.

To back up the mysql database

1. Open an SSH terminal session to the Skylight orchestrator CLI on port 2200.
2. Log in as the skylight user.
3. Create a backup of the data store by entering:

database backup

---

Note: The backup is generated as a tar.gz file in the folder ‘backups’ of the ‘so-mysql’ volume.

---

Transferring File to the Docker host which deployed the Skylight orchestrator Docker

This procedure explains how to install the required upgrade script to the appropriate location.

The following upgrade file must be available:

• docker-dist-22.10-GA-5.sh

To transfer file

The procedure must be executed by the skylight user.

1. From your computer, use an SCP client (such as WinSCP) and the Skylight user to transfer the required file to the /home/skylight folder.

---

CAUTION: The location of the required file must be /home/skylight.

---

Upgrading Skylight orchestrator Docker

This procedure contains instructions on how to upgrade to Skylight orchestrator Docker 22.10. Upgrades are supported from the following releases:

• Skylight orchestrator Docker running 21.08 / 21.08.1 5K profile

Upgrading to the New Software Version

This procedure will install the upgraded software.

To upgrade to the new software

1. Open an SSH terminal session to port 22 of the appliance, log in to the appliance with one user having sudo privileges or root access on the host.
2. Execute the script that does the partition upgrade:

sudo sh /home/skylight/docker-dist-22.10-GA-5.sh

If prompted, provide the password of the user having sudo privileges or root access on the host.

3. When prompted enter:

y

Upgrade Skylight orchestrator version 21.08-GA to 22.10-GA
Proceed ? (y/N)
y
Validate mysql disk space for upgrade
Mysql disk space already to backup database
Stop Skylight orchestrator services version 21.08-GA
Backup database
Backup java for rollback

Install Skylight orchestrator version 22.10-GA

=========================================================================================

Installing Skylight orchestrator 22.10-GA (build 5-aaace227)

=========================================================================================

4. When prompted enter:

y

Proceed ? (y/N)
y

5. Type the temporary installation folder to extract the Docker images or type enter to accept default: /tmp folder

Temporary installation folder? [enter to accept default: /tmp]
/tmp

Checking requirements ...

Requirements are ok.

Extracting installation package to /tmp/so_install ...

Please wait ...

Installation package extracted to /tmp/so_install .

Importing Skylight orchestrator distribution docker images from /tmp/so_install/docker_images.tar ...
b40ed86654e5: Loading layer 75.15MB/75.15MB
8dbe5f6a3a6e: Loading layer 115.9MB/115.9MB
[...]
Loaded image: so-drbd9-focal:22.10-GA

Setup user:group skylight:skylight ...
Found group 'skylight'
skylight:x:2000:

Found user 'skylight'
skylight:x:2000:2000:Accedian Skylight orchestrator:/home/skylight:/bin/bash

user:group skylight:skylight are created.

Resetting the main user in Skylight orchestrator containers to host UID and GID

Resetting 'so-mysql' container user to host UID and GID
Sending build context to Docker daemon 8.704kB
[...]
Successfully built c4c94bc55804
Successfully tagged so-ha:22.10-GA
Untagged: so-ha:22.10-GA-distro

Skylight orchestrator images installed
REPOSITORY TAG IMAGE ID CREATED SIZE
so-ha 22.10-GA c4c94bc55804 1 second ago 880MB
so-export 22.10-GA bd25f964c42e 3 seconds ago 252MB
so-core 22.10-GA b8eeefc85955 6 seconds ago 6.19GB
so-med 22.10-GA a24f3cfecd1a 56 seconds ago 4.48GB
so-nbi 22.10-GA e9640d899cd1 About a minute ago 4.48GB
so-mysql 22.10-GA a69b77268f50 2 minutes ago 8.31GB

Setup Skylight orchestrator configuration ...

Skylight orchestrator configuration is setup.

Installing Skylight orchestrator files and folders ...

Skylight orchestrator files and folders are created.

Setup Skylight orchestrator docker volumes...
Setup so-config volume...
so-config
so-config

Skylight orchestrator docker volumes are setup.

Setup the network for Skylight orchestrator docker containers...
Found network 'so-network'

[
  {
   "Name": "so-network",
   "Id": "3fe5c18c48cfd9aa3afdb445f861cd0f76e84720c36dfa53ad3eb1840c06a304",
   "Created": "2022-07-19T08:23:13.970164575Z",
   "Scope": "local",
   "Driver": "bridge",
   "EnableIPv6": true,
   "IPAM": {
      "Driver": "default",
       "Options": {},
       "Config": [
          {
            "Subnet": "172.18.0.0/24",
            "Gateway": "172.18.0.1"
          },
          {
           "Subnet": "fd00:1::/80",
           "Gateway": "fd00:1::1"
          }
       ]
    },
    "Internal": false,
    "Attachable": false,
    "Ingress": false,
    "ConfigFrom": {
       "Network": ""
    },
    "ConfigOnly": false,
    "Containers": {},
    "Options": {},
    "Labels": {}
   }
]

Starting HA docker container by default...

Creating so-ha-22.10-GA ... done

HA docker container started.

Removing the temporary installation folder /tmp/so_install ...

=================================================================================================================

The installation of Skylight orchestrator 22.10-GA (build 5-aaace227) is complete.

To manage Skylight orchestrator, run:

/usr/bin/socli.sh

=================================================================================================================

Import data upgrade version 22.10-GA
Upgrade database schema for Skylight orchestrator version 22.10-GA
Creating so-mysql-22.10-GA ... done
Successfully upgraded the database schema
Stopping so-mysql-22.10-GA ... done
Removing so-mysql-22.10-GA ... done
Going to remove so-mysql-22.10-GA
Import 'skylight' certificate into the keystore for Skylight orchestrator version 22.10-GA

=========================================================================================

Skylight orchestrator version 22.10-GA upgrade process was successful

=========================================================================================

Post-Installation Procedures

This section explains the procedures applicable after your upgrade.

The post-installation procedures are:

1. Restarting the Skylight orchestrator services
2. Post-Upgrade Installation of Feature Keys
3. Post-Upgrade Checks

Restarting the Skylight orchestrator services

This procedure will start the upgraded software.

1. Open an SSH terminal session to the Skylight orchestrator CLI on port 2200
2. Log in as the skylight user.
3. Start services by entering:

services start

4. When prompted enter:

y

---

Note: It may take up to 10 minutes for the Skylight orchestrator services to be healthy.

---

Verifying the Startup Status

To verify the startup status

1. Enter:

services status

A list of services (that are currently running) is displayed.
Ensure that the state of all services is shown as healthy.

2. Close the terminal session to port 2200 by entering:

exit

Post-Upgrade Installation of Feature Keys

Skylight orchestrator uses feature keys to enable certain menus and features. In this procedure, you will enter the feature keys for the features purchased for your system.

You should have obtained the feature keys for the new features in Skylight orchestrator 22.10. If you do not already have the keys, you can get them from the Accedian Technical Support website.

---

Note: If you do not install the new keys, you will not have access to the new features available in Skylight orchestrator 22.10.

---

To install new feature keys

1. Clear the cache in the web browser that you will use to access the Skylight orchestrator web interface.
   

   ---

   Note: If you do not clear the cache, you may not be able to log in.

   ---

2. Access the Skylight orchestrator web application by entering the following URL in the address bar of the web browser:
   http://ipaddress

3. Enter your username and password to sign in to Skylight orchestrator.

4. Select Admin ▶ Feature Activation page.

5. Remove all of the feature keys that are currently in the list by repeating the following steps for each key:
   a. Select a feature key in the list.
   b. Click the Remove Feature button .
   c. Click the Yes button to confirm removal of the feature key.

6. Import all of the new feature key files by repeating the following steps for each of the key files that you obtained from Accedian Technical Support:
   a. Click the Choose File button.
   b. From the file selector pop-up, select the key file from the local file system.
   c. Click the Import button.
   

   ---

   Note: Keys are in service as soon as they are imported. However, to see the changes, you must either refresh the page, or log out of the application (next step) and log back in (next procedure).

   ---

7. Log out of the Skylight orchestrator application by clicking the button (lower left corner).

---

Note: An activation key with the name "Skylight-orchestrator - Internal License server" is removed and a new one is re-added. Skylight orchestrator services will need to be restarted for this to take effect.

---

Restarting the Skylight orchestrator services

This procedure will start the upgraded software.

1. Open an SSH terminal session to the Skylight orchestrator CLI on port 2200
2. Log in as the skylight user.
3. Stop services by entering:

services stop

4. When prompted, enter:

y

5. Start services by entering:

services start

6. When prompted, enter:

y

---

Note: It may take up to 10 minutes for the Skylight orchestrator services to be healthy.

---

Post-Upgrade Checks

The final step of the upgrade is to check the network inventory and ensure that Skylight orchestrator Docker is operational. The following steps constitute a basic verification of the state of Skylight orchestrator.

To verify network inventory and check Skylight orchestrator functionality

1. Log in to the Skylight orchestrator web application in a supported web browser.
2. Click the Accedian icon to display the About window.
   The Build Version should indicate version 22.10.
3. Access the Device ▶ Managed Elements tab and verify that the total count of network elements at the bottom-left corner is accurate.
4. Click the icon at the bottom-right corner and verify that the current alarm count is accurate.
5. Access the Commission ▶ Jobs tab and verify that any pre-existing configuration jobs are still present.
6. Access the Collection ▶ Reporting Status tab and verify the following:
   • The list of performance elements with a pm collect agent.
   • The CSV time and Transfer time have both recently been updated for all elements with streaming enabled.
7. Access Admin ▶ Licensing to verify that the connection has been established.
8. Check your session status by accessing Sessions tab.

Rollback Procedure

This section explains how to roll back to the original operating system partition and restore the system to its initial state.

If you must roll back a cluster deployment, you must repeat the procedure on all appliances on which the upgrade was performed (successfully or unsuccessfully).

Rollback for Skylight orchestrator Procedure

This procedure explains how to roll Skylight orchestrator back to the previous release.

You would only need to perform the rollback procedure if problems occur during the appliance upgrade procedure, such as:

• An error message occurs during the upgrade process that prevents you from proceeding.
• The upgrade process terminates unexpectedly.
• The application does not function as expected after the upgrade.

Procedure Requirements

The following requirement applies to the procedure:

1. This procedure must be executed with one user having sudo privileges or root access on the host.

Rolling back the upgrade

Repeat this procedure on all appliances that were upgraded.

To roll back the upgrade

1. Using an SSH terminal session to port 22 of the appliance, log in to the appliance with one user having sudo privileges or root access on the host.
2. Execute the script that does the partition upgrade:

sudo sh /home/skylight/docker-dist-22.10-GA-5.sh -r

If prompted, provide the password of the user having sudo privileges or root access on the host.

3. When prompted enter:

y

Proceed ? (y/N)
y
Stop Skylight orchestrator version 22.10-GA
Removing image so-mysql:22.10-GA ...
Untagged: so-mysql:22.10-GA
Deleted: sha256:106f366acdfcc01ab086a4c16082deee7e4b38b1fd797cf8d6e44c17c1b8909a
Deleted: sha256:01e3bb19ce4fce80d8b2ceecf74d022e0edcb3832fe827351f05046d09f3d9dd
Deleted: sha256:b04590d7f551c4962e26031415b13b1e5f823926163e41c932be70eb5482c164
[...]

=========================================================================================

Skylight orchestrator rollback process was successful .

=========================================================================================

Starting the Skylight orchestrator services

This procedure will start the upgraded software.

1. Open an SSH terminal session to the Skylight orchestrator CLI on port 2200
2. Log in as the skylight user.
3. Start services by entering:

services start

4. When prompted enter:

y

---

Note: It may take up to 10 minutes for the Skylight orchestrator services to be healthy.

---