Deploy Digital Access component on Docker

This article includes updates for Digital Access 6.3.0.

This article describes how to deploy the Smart ID Digital Access component on Docker using docker swarm.

You can also deploy Smart ID complete package using docker compose for which you can refer to Deploy Smart ID.

Known issue with the network card VMXNET3 on VMware virtualization platform

If you use the network card VMXNET3, there may be an issue with the docker swarm overlay network. The issue is that the swarm containers can ping each other (ICMP protocol), but TCP and UDP fail.

It is recommended to change the network card for all involved servers to E1000. This is done in the VMware configuration of the guest virtual machine.

This issue is only present on the VMware platform, and not on other virtualization platforms, to our knowledge.

Prerequisites

The following is needed:

• Docker client and engine version 20.10.10 or later

• Linux that supports the above docker versions

• Software Components: Any of the PostgreSQL, MySQL, Sql-server, or Oracle database

• Configuration files: setup.tgz

• System Requirements: 8cpu with 32GB RAM and 100 GB physical space is recommended.

• For offline setup, you must install docker

Preparations

• Download the setup.tgz file on system from the support portal.

• It is always recommended to take backup/snapshot before starting setup.

• If you have multiple network interfaces, note down the NIC name or IP address of the network interface which will be used by docker swarm.

  • When docker swarm is initialized it binds to one NIC and one IP address for communication, and if you have multiple NICs, you have to specify which one to use, by NIC name or IP address.

  • If you want traffic for swarm to be restricted to a private/internal network then provide an internal IP address. But if you want to expose some of your service then you need to provide your public IP address.

Step-by-step instruction

Run the setup

1. Copy setup.tgz to your working directory.

2. Extract the file using tar command.

   Extract file

   CODE

   tar -xf setup.tgz

3. Navigate to the scripts folder inside the setup folder.

   Navigate to scripts folder

   CODE

   cd setup/scripts

4. Run the script setup.sh.

   Run the script

   CODE

   sudo bash setup.sh

5. During the setup, provide the below mentioned inputs. 

Inputs

You will need to input the IP address that will be used for the swarm communication based on the NICs. See the "Preparations" section above.

####################################################

Setting up docker swarm...

####################################################

Enter ip address which should be used for docker swarm communication:

To setup PostgreSQL press “Y” (Not recommended for production setup). If you want to use some external database press ‘’n”.

####################################################

setting up PostgreSQL...

####################################################

Do you want to setup PostgreSQL (Not recommended in production environment) [Y/n] Y

Creating a random password
Creating network pg_default
Creating service pg_postgres
Create a new password for all databases
New Password:
Verify New Password:

Next it will setup reporting database using PostgreSQL.

####################################################'
Setting up reporting database...
####################################################'

Creating new customize.conf for administration service..

It will now pull the docker images and start the services

####################################################
Starting Digital Access...
####################################################

Creating network da_da-overlay
Creating service da_admin
Creating service da_authentication
Creating service da_distribution
Creating service da_policy
Creating service da_accesspoint
Successfully deployed

####################################################
Setup script execution completed successfully
####################################################

Wait for all the images to get downloaded. To check status of downloaded images, use this command: 

Check images

sudo docker images

After all the images are downloaded from the repository, the containers will start automatically. It can take a few minutes to start all the containers. To check the container status, use this command:

Check container status

sudo docker ps

Make sure the status of each container is healthy.

Restart the services using this command on the node:

Deploy Digital Access stack

sudo bash /opt/nexus/scripts/start-all.sh

Offline setup

Offline setups consist of two steps:

First step

For the first step you need a system with network connectivity. Download docker images on the system.

1. Make sure docker is installed.

2. Download the images using the command docker pull. 

   pull images

   CODE

   sudo docker pull nexusimages.azurecr.io/smartid-digitalaccess/administration-service:6.0.7.73936
   sudo docker pull nexusimages.azurecr.io/smartid-digitalaccess/policy-service:6.0.7.73936
   sudo docker pull nexusimages.azurecr.io/smartid-digitalaccess/authentication-service:6.0.7.73936
   sudo docker pull nexusimages.azurecr.io/smartid-digitalaccess/distribution-service:6.0.7.73936
   sudo docker pull nexusimages.azurecr.io/smartid-digitalaccess/access-point:6.0.7.73936

3. To verify that all images are downloaded, run this command:

   Check images

   CODE

   sudo docker images

4. Save all images in tar files. Run these commands: 

   image to tar

   CODE

   sudo docker save nexusimages.azurecr.io/smartid-digitalaccess/administration-service:6.0.7.73936 > admin.tar
   sudo docker save nexusimages.azurecr.io/smartid-digitalaccess/authentication-service:6.0.7.73936 > authentication.tar
   sudo docker save nexusimages.azurecr.io/smartid-digitalaccess/distribution-service:6.0.7.73936 > distribution.tar
   sudo docker save nexusimages.azurecr.io/smartid-digitalaccess/policy-service:6.0.7.73936 > policy.tar
   sudo docker save nexusimages.azurecr.io/smartid-digitalaccess/access-point:6.0.7.73936 > accesspoint.tar

5. Copy all the tar files onto the system where you want to setup Digital Access.

Second step

On the system where the Digital Access setup will be done:

1.  Go to the folder where all the tar files are copied.

2. Load the images to a local docker repository using the command:

   load Images

   CODE

   sudo ls -1 *.tar | xargs --no-run-if-empty -L 1 sudo  docker load -i

3. Run the installation process, and follow the steps mentioned above.

Additional information