1. Copy upgradeFrom5.13.tgz to all nodes, and extract the .tgz file.

   Code Block
   title Extract
   tar -xzf upgradeFrom5.13.tgz

   
   

2.  Run upgrade.sh to migrate files/configuration from the existing setup. It will create a .tgz file in upgrade/scripts/da_migrate_5.13.tgz. Copy this file to the new machine.

   Run the below commands with --manager on the manager node and --worker on the worker nodes:

   Code Block
   title Run upgrade script
   sudo bash upgrade/scripts/upgrade.sh --manager --export_da (on node running administration-service) sudo bash upgrade/scripts/upgrade.sh --worker --export_da (on all other worker nodes)

   After running the commands above you will be asked: "Do you wish to stop the existing services ?- [y/n]". It is recommended to select y for yes. The same configuration and database settings will be copied over to the new setup and there is a possibility of connecting the new instance too with the same database, if the database settings and other configurations are not modified before starting the services. 

   Note
   If you select n for no, the services on the older existing machines will not stop.

   The system will now create a dump of the locally running PostgreSQL database. Note that the database dump will only be created in the administration service node.

1. Copy upgradeFrom5.13.tgz to all nodes, and extract the .tgz file.

   Code Block
   title Extract
   tar -xzf upgradeFrom5.13.tgz

   
   

2. Edit the configuration files in the manager node.

1. Verify if all nodes are part of the cluster by running this command.

   Code Block
   title Verify if all nodes are part of cluster
   sudo docker node ls

   Example:
   Image Modified

2. Identify nodes ID, master and worker where the service will be distributed.

   Code Block
   title Identify nodes
   sudo docker node inspect --format '{{ .Status }}' h9u7iiifi6sr85zyszu8xo54l

   
   

3. Output from this command:

   No Format
   {ready 192.168.86.129}

   IP address will help to identify the Digital Access node.

Add new labels for each service which you want to run. Choose any name based on requirement, but make sure they are in accordance with what you have defined in the constraint section in the docker-compose.yml file.

1. Use these commands to add label for each service:

   Code Block
   title Commands to add labels
   sudo docker node update --label-add da-policy-service=true <manager node ID> sudo docker node update --label-add da-authentication-service=true <manager node ID> sudo docker node update --label-add da-administration-service=true <manager node ID> sudo docker node update --label-add da-access-point=true <manager node ID> sudo docker node update --label-add da-distribution-service=true <manager node ID> sudo docker node update --label-add da-policy-service1=true <worker node ID> sudo docker node update --label-add da-access-point1=true <worker node ID>

   
   

2. Deploy your Digital Access stack using this command. 

   Verify that the required images are available on the nodes. Then run the start-all.sh script in the manager node.

   Code Block
   title Deploy Digital Access stack
   sudo bash /opt/nexus/scripts/start-all.sh

   
   

1. Log in to Digital Access Admin. If you use an internal database for configurations, provide the host machine IP address to connect the databases (HAG, Oath, Oauth). 
   
   Image Modified
2. Publish the configurations.
3. Change the internal host and port for each added service according to the docker-compose.yml and network.yml files.
4. Go to Manage System > Distribution Services and check “Listen on All Interfaces”.
   Image Modified
5. Go to Manage System >Access Points and provide the IP address instead of the service name. Also check "Listen on all Interfaces".
   Image Modified
6. If you want to enable XPI and SOAP services, the expose port ID should be 0.0.0.0 in Digital Access Admin.
   
   Image Modified

7. Redeploy the services using this command on the manager node.

   Code Block
   title Restart
   sudo bash /opt/nexus/scripts/start-all.sh

1. Expand the root partition, since on 5.13.x appliance the size of the disk is only 4 GB. It must be expanded before upgrading, for docker to work, since it requires more space.
   1. Boot the virtual machine and log in to it.
   2. To find out which hard disk to expand, do df -h to see which disk partition is mounted for root file system, /dev/sdc1 or /dev/sdb1.
   3. Assuming that sdb1 is the primary hard disk, shut down the virtual machine and expand the size of the virtual machine's disk (as mentioned in step 1 above), from 4GB to minimum 16GB via editing the Virtual Machine settings.
      
      1. If /dev/sdb1is mounted, hard disk 2 needs to be expanded.
      2. If /dev/sdc1is mounted, hard disk 3 needs to be expanded.
   4. Boot the virtual machine and log in again.
   5. Verify the disk size of mounted disk by running this command:

      
      

      Code Block
      title Check disk size
      fdisk -l

      
      

   6. Once the disk is successfully expanded, resize the partition and expand the file system.

      1. Resize the partition using the command below. This will display the free space available on the disk.

         Code Block
         title Resize
         sudo cfdisk /dev/sdb

         Image Modified

      2. Select the Resize menu in the bottom. Once resize is selected, it displays the disk size after resizing as 16GB (or the size that was set in step 1 above).
      3. Select the Write menu, to write the new partition table on disk.
      4. Select Quit to exit from command.
      5. Expand the file system on the root partition:

         
         

         Code Block
         title resize
         sudo resize2fs /dev/sdb1

         
         

      6. Verify the size of the disk partition:

         
         

         Code Block
         title check disk size
         df -h

         
         

2. The following ports shall be open to traffic to and from each Docker host participating on an overlay network:
   1. TCP port 2377 for cluster management communications.
   2. TCP and UDP port 7946 for communication among nodes.
   3. UDP port 4789 for overlay network traffic.
3. Copy upgradeFrom5.13.tgz to the manager node (node where administration service is running) and all worker (other) nodes. In this setup we will set and consider the administration-service node as the manager node.

   Extract the tar file:

   Code Block
   title Extract
   tar -xzf upgradeFrom5.13.tgz

    

4. Set up the docker daemon and pull images:
   1. Verify the Digital Access tag in versiontag.yml (<path to upgrade folder>/docker-compose/versiontag.yml) file. The same tag will be installed as part of the upgrade. If it is not the correct tag, update it manually.
   2. Although the upgrade script installs docker and pulls the images from repository, it is recommended to install docker and pull the images before running the upgrade. This will reduce the script run time and also the downtime of the system.

   3. Run the script pull_image.sh to pull images on all nodes.

      Note
      In case of offline upgrade, load the Digital Access docker images to the machine. Also, if you are using internal postgres, load postgres:9.6-alpine image on the manager node.

      
      

      Code Block
      title Pull images
      sudo bash upgrade/scripts/pull_image.sh

      
      

   4. Make sure there is a backup/snapshot of the machine before starting the upgrade.

Step-by-step instruction

Upgrade manager node

To upgrade the manager node (the node on which the administration service runs):

1. Run the upgrade script with this command line option:

   Code Block
   title Run upgrade script
   sudo bash upgrade/scripts/upgrade.sh --manager

   
   

2. To set Docker Swarm provide your manager node host IP address. 
3. In case you are using an external database, select No to skip postgres installation.

   
   

   Note
   title (Only applicable for High Availability or distributed setup)
   The script prints a token in the output. This token will be used while setting up worker node

   
   

Example:

docker swarm join --token SWMTKN-1-5dxny21y4oslz87lqjzz4wj2wejy6vicjtqwq33mvqqni42ki2-1gvl9xiqcrlxuxoafesxampwq 192.168.253.139:2377

Here the token part is:

SWMTKN-1-5dxny21y4oslz87lqjzz4wj2wejy6vicjtqwq33mvqqni42ki2-1gvl9xiqcrlxuxoafesxampwq 192.168.253.139:2377

Optional: If you cannot find token in upgrade script output on the manager node, get the cluster join token by running this command:

If you have HA setup, multiple instances of services running on different nodes, then you must edit the yml configuration.

Navigate to the docker-compose folder (/opt/nexus/docker-compose) and edit these files:

• docker-compose.yml
• network.yml
• versiontag.yml

docker-compose.yml

For each service, add one section in the docker-compose.yml file.

Change the values for the following keys:

• Service name
• Hostname
• Constraints

For example, if you want to deploy two policy services on two nodes you will have two configuration blocks as shown in the example below.  

  policy:
    # configure image tag from versiontag.yaml
    hostname: policy
    deploy:
      mode: replicated
      replicas: 1
      placement:
        constraints:
         #If you need to set constraints using node name
         #- node.hostname ==<node name> 
         # use node label
         [node.labels.da-policy-service == true ]
      resources:
        limits:
          cpus: "0.50"
          memory: 512M
        reservations:
          cpus: "0.10"
          memory: 128M
    volumes:
      - /opt/nexus/config/policy-service:/etc/nexus/policy-service:z
      - /etc/localtime:/etc/localtime
      - /etc/timezone:/etc/timezone
    logging:
      options:
       max-size: 10m

  policy1:
    # configure image tag from versiontag.yaml
    hostname: policy1
    deploy:
      mode: replicated
      replicas: 1
      placement:
        constraints:
         #If you need to set constraints using node name
         #- node.hostname ==<node name> 
         # use node label
         [node.labels.da-policy-service1 == true ]
      resources:
        limits:
          cpus: "0.50"
          memory: 512M
        reservations:
          cpus: "0.10"
          memory: 128M
    volumes:
      - /opt/nexus/config/policy-service:/etc/nexus/policy-service:z
      - /etc/localtime:/etc/localtime
      - /etc/timezone:/etc/timezone
    logging:
      options:
       max-size: 10m

network.yml

For each service add network configuration in the network.yml file. For example, if you want to deploy two policy services on two nodes you will have two blocks of configuration as shown below.

• Service name: Service name should be identical to what is mentioned in docker-compose.yml.

Example:

policy :
ports:
      - target: 4443
        published: 4443
        mode: host
    networks:
      - da-overlay

policy1:
ports:
      - target: 4443
        published: 4443
        mode: host
    networks:
      - da-overlay

Also, make sure all the listeners that are used for access point Load balance are exposed in network.yml.

versiontag.yml

Add one line for each service. If you have two policy services with name policy and policy1, you will have entries for each service.

Example:

policy :
image: nexusimages.azurecr.io/smartid-digitalaccess/policy-service:6.0.x.xxxxx

policy1:
image: nexusimages.azurecr.io/smartid-digitalaccess/policy-service:6.0.x.xxxxx

1. Keep note of token, ip and port from the above steps.

2. Run the upgrade script, follow the command line options:

   Code Block
   title Get cluster join token
   sudo bash upgrade/scripts/upgrade.sh --worker --token <token value> --ip-port <ip:port>

   
   

1. Verify if all nodes are part of cluster by running this command.

   Code Block
   title Verify if all nodes are part of cluster
   sudo docker node ls

   Example:
   Image Modified

2. Identify nodes ID, master and worker where the service will be distributed.

   Code Block
   title Identify nodes
   sudo docker node inspect --format '{{ .Status }}' h9u7iiifi6sr85zyszu8xo54l

   
   

3. Output from this command:

   No Format
   {ready 192.168.86.129}

   IP address will help to identify the Digital Access node.

Add new labels for each service which you want to run. Choose any name based on requirement, but make sure they are in accordance with what you have defined in the constraint section in the docker-compose.yml file.

1. Use these commands to add label for each service:

   Code Block
   title Commands to add labels
   sudo docker node update --label-add da-policy-service=true <manager node ID> sudo docker node update --label-add da-authentication-service=true <manager node ID> sudo docker node update --label-add da-administration-service=true <manager node ID> sudo docker node update --label-add da-access-point=true <manager node ID> sudo docker node update --label-add da-distribution-service=true <manager node ID> sudo docker node update --label-add da-policy-service1=true <worker node ID> sudo docker node update --label-add da-access-point1=true <worker node ID>

   
   

2. Deploy your Digital Access stack using this command. 

   Verify that the required images are available on the nodes. Then run the start-all.sh script on the manager node.

   Code Block
   title Deploy DA stack
   sudo bash /opt/nexus/scripts/start-all.sh

   
   

1. Log in to Digital Access Admin. If you use an internal database for configurations, provide the host machine IP address to connect the databases (HAG, Oath, Oauth).
   
   Image Modified
2. Publish the configurations.
3. Change the internal host and port for each added service according to the docker-compose.yml and network.yml files.
   
   Image Modified
4. Go to Manage System > Distribution Services and select the checkbox for “Listen on All Interfaces” in case of the ports that are to be exposed.
5. Go to Manage System >Access Points and provide the IP address instead of the service name. Also enable the "Listen on all Interfaces" option.
   Image Modified
6. If you want to enable the XPI and SOAP services, the expose port ID should be 0.0.0.0 in Digital Access Admin.
   Image Modified

7. Redeploy the services using this command on the manager node:

   Code Block
   title Deploy Digital Access stack
   sudo bash /opt/nexus/scripts/start-all.sh