Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updates in Additional steps for specific version

This article describes how to upgrade Smart ID Digital Access component (Hybrid Access Gateway), either from Digital Access Admin or from the console. 

Expandall

Prerequisites

Expand
titlePrerequisites

Before upgrading Digital Access component, make sure that the following things apply:

  • The Digital Access component Appliance must be able to access following url to fetch a new upgrade:
  • There is a service window planned, since the upgrade will result in a short downtime
  • There is a backup or snapshot of the current release

Upgrade from Digital Access Admin

Expand
titleLog in to Digital Access Admin
  1. Log in to Digital Access Admin with an administrator account.


Expand
titleDownload new version
  1. If there are newer versions, the upgrade button is marked red. Click Upgrade. Newer versions are shown.
  2. Download the latest version.
    The new version is downloaded in the background. You can log out, and the download will proceed. The download normally takes a few minutes, depending on your internet connection. When the download is finished, Status is set to Ready


Expand
titleUpgrade new version
  1. For the downloaded version, click Upgrade.
  2. Click Yes to confirm the upgrade. When you confirm the upgrade, the system will be out of service for a short while. The services are turned off, the configuration data is migrated to the new version, and the system is rebooted. 


Expand
titlePublish updates
  1. Log in to Digital Access Admin with an administrator account.
    The Upgrade button is not marked red anymore. The Publish button is marked blue, because the configuration data has been migrated.
  2. Click Publish. The upgrade is done. 

Upgrade from console

Digital Access component can be upgraded from the console (v-apps or command line), for example when the deployment is distributed. For distributed deployment of Digital Access component, there are several appliances with different services, and the administrator interface is only available on the node hosting the administration service. On the other nodes, upgrade using the console instead. It can be done directly in the console or through ssh, for example. 

Upgrade using v-apps within virtual appliance

When Digital Access component is deployed as virtual appliance, the console menu v-apps is included. You can use v-apps to configure, for example, the upgrade. 

Expand
titleLog on to console
  1. Log in to the console (v-apps) with User Name: agadmin.


Expand
titleDownload new version
  1. Select 3) Upgrade System
  2. Select 1) Download
    Available newer versions are displayed. Select the latest version. Download starts. Progress and estimated time left is shown. 


Expand
titleUpgrade to new version
  1. Select 3) upgrade ([downloaded new version])
  2. Do you want to continue? (y/n). Confirm by typing "y"
    When you confirm the upgrade, the system will be out of service for a short while. The services are turned off, the configuration data is migrated to the new version, and the system is rebooted.


Expand
titlePublish updates
  1. When the reboot is finished, on the node hosting the admin service, log on to the administration interface and click Publish

Upgrade using command line with Orchestrator

If Digital Access component was deployed using Orchestrator, the upgrade can be done using command line on the Docker host system. 

Expand
titleLog on to console
  1. Log in to command line of the Docker host.


Expand
titleUpgrade to new version

Upgrade using the following commands:

  1. List available upgrade versions.

    Code Block
    languagebash
    titleList available upgrade versions
    docker exec orchestrator hagcli -o list


  2. Download the wanted version.

    Code Block
    languagebash
    titleDownload wanted version
    docker exec orchestrator hagcli -o download -t x.x.x


  3. Check that the downloaded version is available.

    Code Block
    languagebash
    titleCheck if download available
    docker exec orchestrator hagcli -o version-to-upgrade


  4. Upgrade.

    Code Block
    languagebash
    titleUpgrade
    docker exec orchestrator hagcli -o upgrade -t x.x.x



Expand
titlePublish updates
  1. When the reboot is finished, on the node hosting the admin service, log on to the administration interface and click Publish

Additional steps for a specific version

Some versions of Digital Access component have additional steps that should be considered.

Expand
titleUpgrade from 5.13.x to 6.0.0 and above

Starting from version 6.0.0, Digital Access component will use the Docker technology to run its services. When using the virtual appliance as deployment option, the version 6.0.0 will be the last version where the virtual appliance will be replaced during upgrade. From that version, the virtual appliance will act as a Docker host. Future upgrade will only be done on the Docker containers itself, not the virtual appliance. 

This means, that for every upgrade from a version below 6.0.0 to a version above 6.0.0, Digital Access component needs to be upgraded to version 6.0.0 in between. 

Upgrade from 5.13.x to 6.0.0 and above

Expand
titleExpand size of second partition


Note

If You must extend the disc space size of the virtual appliance is close to be full, an second partition before you can upgrade to version 6.0.0 will fail. In this case the second partition has to be extended first, before doing the upgrade again. 

Follow the instructions to increase the space size of the second partition: 

  1. Expand Boot the virtual machine and login to it.
  2. To find out which hard disk to expand, do df -h to see which disk is mounted, /dev/sdc1 or /dev/sdb1.

    Code Block
    languagebash
    titleCheck which hard disk to expand
    df -h


  3. Shutdown the virtual machine and expand the size of the virtual machines disk (hard disk-3) machine's disk from 4GB to minimum 8GB via editing the VM settings.
  4. Boot the virtual machine and login to it. 
  5. Check available disk space of /dev/sdb1If /dev/sdb1 is mounted, then it is hard disk 3 (which is secondary disk) that must be extended.

    Expand
    titleIf /dev/sdb1 is mounted
    • List available disks and space.

      Code Block
      languagebash
      titleList disks and space
      fdisk -l

      You will see the following output:

      /dev/sdb - 4 gb  
      /dev/sdc - 8 gb 
    • Mount the new disk space.

      Code Block
      languagebash
      title
    Check disk space
    df -h
    • Mount disk space
      fdisk /dev/sdc


    • Follow the wizard and use these commands:  

      1. d - delete partition
      2. n - create new partition
        1. Select default value for Partition type
        2. Select default value for Partition number
        3. Select default value for First sector
        4. Select default value for Last sector
        5. Select Y to remove the Signature
      3. a - toggle boot flag
      4. w - write changes
    • Create a new file system:

      Code Block
      languagebash
      titleCreate file system
      mkfs.ext4 -O ^64bit  -L ag-secondary /dev/sdc1


    • Done. Upgrade Digital Access component now. After upgrade, you can check available space again:

      Code Block
      languagebash
      df -h



  6. If /dev/sdc1 is mounted, then it is hard disk 2 (which is secondary disk) that must be extended.

    Expand
    titleIf /dev/sdc1 is mounted
    • List available disks and space.

      Code Block
      languagebash
      titleList disks and space
      fdisk -l

      You will see the following output:

      /dev/sdb -
    4
    • 8 gb  
      /dev/sdc -
    8
    • 4 gb 
    • Mount the new disk space.

      Code Block
      languagebash
      titleMount disk space
      fdisk /dev/
    sdc
    • sdb


    • Follow the wizard and use these commands:  

      1. d - delete partition
      2. n - create new partition
        1. Select default value for Partition type
        2. Select default value for Partition number
        3. Select default value for First sector
        4. Select default value for Last sector
        5. Select Y to remove the Signature
      3. a - toggle boot flag
      4. w - write changes
    • Create a new file system:

      Code Block
      languagebash
      titleCreate file system
      mkfs.ext4 -O ^64bit  -L ag-secondary /dev/
    sdc1
    • sdb1


    • Done. Upgrade Digital Access component now. After upgrade, you can check available space again:

      Code Block
      languagebash
      df -h




Expand
titleEndpoint identification

Digital Access component now supports endpoint identification during secure interactions with the user storage, due to an update of the Java version. It must be ensured that the certificate is compliant with the fully qualified domain name (FDQN) which is configured in Digital Access component. For more information, see Adapt Hybrid Access Gateway for endpoint identification.


This article is valid from Digital Access 6.0

Related information