Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Upgrading the proNX Optical Director Software (Release 18.4 and Higher)

 

Prerequisites

  • The control machine is set up. For convenience, you should use the same control machine that you used to install the existing version of the software.

  • The cluster server host operating system has been upgraded to the version required by the new proNX Optical Director software release. For information on how to do this, see Upgrading the Host OS on the Cluster Server.

  • You have copied the proNX Optical Director software package into the directory on the control machine where you want to run the installation scripts. This directory is called the <install-dir> in the examples in this procedure.

  • The existing proNX Optical Director installation is fully operational with all cluster servers running.

  • You have created or have been assigned a trusted TLS certificate for the cluster.

  • You have the common secret that you specified when you ran the proNX Optical Director installation script for the installation that you are upgrading from.

    Note

    If you have forgotten the common secret, you can retrieve it by issuing the following commands from the master node:

    • Type kubectl get secret common.secret -o yaml to retrieve the encoded password.

    • Type echo '<encoded-password>' | base64 --decode to see the encoded password in clear text.

Note

If you are currently running an existing version of the proNX Optical Director software, close all browser windows to that proNX Optical Director before you upgrade to the new version.

Use this procedure on the control machine to upgrade the proNX Optical Director software to release 18.4 or higher on all the servers in the cluster. When you upgrade the installation, proNX Optical Director settings and runtime information are preserved. You do not require Internet access to use this procedure.

Note

To make the examples in this procedure generic to all releases, the example output does not show release numbers in the filenames.

  1. Untar and uncompress the downloaded archive, for example:
  2. Copy the inventory file from the existing installation to the new installation.
  3. If your existing installation was installed with a TLS certificate, then you can skip this step.

    Otherwise, install a valid and trusted TLS certificate and associated private key for the cluster in <install_dir>/pod-installer-<new-version>/certs. This TLS certificate will be used by the client browser to authenticate the proNX Optical Director server when you later access the proNX Optical Director UI.

    This example shows a certificate and associated private key called pod-cluster.crt and pod-cluster.key respectively.

    Note

    You must have exactly one certificate in this directory. If you have no certificate or more than one certificate, the installation will fail.

    If you do not have a TLS certificate, you can create one for testing purposes, as follows:

    This certificate will allow you to install and try out the proNX Optical Director, but because this certificate has not been signed by a trusted Certificate Authority, you will receive security warnings when trying to access the proNX Optical Director UI.

    In this example, the certificate is created with a Common Name (CN) of pod-cluster.mydomain. This is the resolvable TLS hostname that you will use to access the proNX Optical Director UI.

    Note

    The certificate must contain a Common Name and not a Subject Alternative Name (SAN) or IP address.

  4. Prepare the upgrade. This step backs up current configuration and runtime information, learns about existing cluster settings, deploys new version containers, and copies updated runtime configuration. The proNX Optical Director application remains up in this step.

    You are prompted for the following:

    • A username and password to log in to the cluster servers. This user must be root or a user with no-password sudo access.

    Here is an example of the script output:

    The installation log file is located at <install-dir>/pod-installer-<version>/logs/deploy-cluster.log.

  5. Commit the upgrade. This step upgrades the previously prepared cluster by migrating existing application instances to the new version instances. The proNX Optical Director application goes down in this step.

    You are prompted for the following:

    • A username and password to log in to the cluster servers. This user must be root or a user with no-password sudo access.

    Here is an example of the script output:

    The installation log file is located at <install-dir>/pod-installer-<version>/logs/deploy-cluster.log.

  6. Verify that the upgrade is successful. Note

    Depending on the installation, the kube config file on the control machine might no longer be valid after the upgrade. If the kubectl commands on the control machine return an error, recreate the ~/.kube/config file from the /etc/kubernetes/kubectl.kubeconfig file on the master node.

    # kubectl get pods --show-labels
    Note

    It is normal to see some joc-version values set to the old version because not all pods might be upgraded.

    As the proNX Optical Director starts up, you will see the STATUS of some Kubernetes pods cycle between Running and other values. This is normal. A Kubernetes pod is operational when it has a STATUS of Running and a READY state of 1/1 (number of containers in the pod that are ready / total number of containers in the pod). The installation is complete once all the Kubernetes pods become operational.

  7. If you are installing or upgrading to proNX Optical Director Release 18.4, create the secondary database indexes. This is required to provide increased redundancy in cases of server failure. If you are installing or upgrading to release 19.1 or higher, you are not required to perform this step because this step is automatically performed in those releases.

    To create the secondary database indexes, log in to the master node and run the following commands:

    Note

    You cannot run these commands from the control machine.

    where <common-secret> is the common secret you specified when you installed the proNX Optical Director software version that you just upgraded from. The <common-secret> does not change when you upgrade.

You have now completed the proNX Optical Director upgrade. You can connect to the user interface by pointing your browser to https://<cluster-name> where <cluster-name> is the Common Name used when creating the cluster certificate. In the example certificate above, you connect to the UI using https://pod-cluster.mydomain.

Note

If you did not remember to close all browser windows to the previous version of the proNX Optical Director before you installed this version of the proNX Optical Director, perform a browser window refresh on each open browser window.