Nexus' software components have new names:

Nexus PRIME -> Smart ID Identity Manager
Nexus Certificate Manager -> Smart ID Certificate Manager
Nexus Hybrid Access Gateway -> Smart ID Digital Access component
Nexus Personal -> Smart ID clients

Go to Nexus homepage for overviews of Nexus' solutions, customer cases, news and more.


Skip to end of metadata
Go to start of metadata

This article describes how to run Smart ID Digital Access component in distributed mode.

Distributed mode is used when the different functions in Digital Access component are distributed to several virtual appliances. A typical case is when you want to enforce the access in one appliance (PEP, Policy Enforcement Point) and process the authorization and authentication requests in one appliance (PDP, Policy Decision Point). In this case you will need two appliances. One that runs access point and another that runs the other Digital Access component services.

Administration service limitations

There can be only one administration service in a node network. Nodes running other services should be connected to the administration service node. Once a service has successfully connected to an administration service, then that service cannot easily be switched to work with another appliance's administration service. ­­

  • Manager node is the node that hosts the administration service.
  • Worker node is a node that hosts other services, not running the administration service.

Expand/Collapse All

Prerequisites

 Prerequisites

The following prerequisites apply:

  • Two Digital Access components with services and docker swarm available 
  • The following ports shall be open to traffic to and from each Docker host participating on an overlay network:
    • TCP port 2377 for cluster management communications
    • TCP and UDP port 7946 for communication among nodes
    • UDP port 4789 for overlay network traffic
  • For more details refer to: https://docs.docker.com/network/overlay/
  • Keep a note of IP addresses of nodes where access point is running.

Step-by-step instruction

Get token and stop services - manager node

  Get cluster join token
  1. SSH to the node running the administration service, that is, the manager node.
  2. Get the cluster join token by running this command. This token will be used for joining worker nodes to the manager node.

    Get token
    sudo docker swarm join-token worker

    Output of the command will be like:

    Output

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

 Stop services
  1. Stop the running services.

    Stop services
    sudo docker stack rm <your da stack name>

Join as worker nodes

Do these steps on all worker nodes.

 Join the nodes as worker nodes
  1. SSH to the worker node(s).

  2. Stop the running services.

    Stop services
    sudo docker stack rm <your da stack name>
  3. Get the node ID.

    Get node ID
    sudo docker node ls
  4. Remove the labels.

    Remove labels
    sudo docker node update --label-rm  da-accesspoint <nodeid>
    sudo docker node update --label-rm  da-authentication <nodeid>
    sudo docker node update --label-rm  da-distribution <nodeid>
    sudo docker node update --label-rm  da-policy <nodeid>
    sudo docker node update --label-rm  da-admin <nodeid>
  5. if you are using PostgreSQL as database then remove label using this command (not to run on PostgreSQL node):

    If using PostgreSQL
    sudo docker node update --label-rm  postgres <nodeid>
  6. Remove the node from the current swarm.

    Remove node
    sudo docker swarm leave --force
  7. Join to manager swarm using the command output from "Get cluster join token" above.

    Example of output of 'get token' command
    docker swarm join --token SWMTKN-1-5dxny21y4oslz87lqjzz4wj2wejy6vicjtqwq33mvqqni42ki2-1gvl9xiqcrlxuxoafesxampwq 192.168.253.139:2377
    
  8. On success, the output will be: This node joined a swarm as a worker.

At manager node

 Remove labels, verify and identify nodes
  1. SSH to manager node.
  2. Remove label for all services which are not required on this node.

    Remove label
    sudo docker node update --label-rm  da-accesspoint <nodeid>
  3. Verify if all nodes are part of cluster by running this command.

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

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

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

    Output: {ready  192.168.86.129} - IP address will help to identify the DA node  

 Update labels for each service
  1.  Update labels for each service which you want to run on worker nodes.
     <node ID> is the id of the node on which the service will be running.

    Commands to update labels
    sudo docker node update --label-add da-policy=true <node ID> 
    sudo docker node update --label-add da-authentication=true <node ID> 
    sudo docker node update --label-add da-accesspoint=true <node ID> 
    sudo docker node update --label-add da-distribution=true <node ID>
  2. Deploy your stack using this command. To run the command your working directory should be docker-compose.

    Deploy DA stack
    sudo docker stack deploy --compose-file docker-compose.yml -c network.yml -c versiontag.yml <your da stack name>

    Here: 

    • docker stack deploy is the command to deploy services as stack. 
    • compose file flag is used to provide the file name of base docker-compose file. 
    • -c is short for –compose-file flag. It is used to provide override files for docker -compose. 
    • <your da stack name> is the name of the stack. You can change it based on requirements.