Create your Docker Swarm Cluster
We document here how you can create your Docker Swarm Cluster both in the FIWARE Lab and in your local development environment (see further below).
Create your Docker Swarm Cluster in FIWARE Lab
Register in FIWARE Lab
Fist of all, you need to register at the site https://account.lab.fiware.org/. The first time you have to click the “Sing up” button to be redirected to the Sing up form.
The first time you have to click the “Sing up” button to be redirected to the Sing up form:
Complete the form with your personal data and agree with the FIWARE Lab Term and Conditions:
Complete the registration steps by following the instruction found in the registration email.
Configure your cluster
Go to the home page of the SmartSDK Platform Manager and click on “Authenticate with Fiware”.
You will be redirected to the Fiware Lab login page. Insert your credentials.
Once you login, you need to authorize the SmartSDK Platform to access your public information in order to create and enable your account.
Then you will be redirected to the SmartSDK Platform as an authorized user.
Setup Swarm on Fiware Lab
In the SmartSDK platform, depending on what is enabled by the administrator, you can create your own environment(s).
Once the environment is created, you can add new host(s) in the environment.
Once a host is added you can deploy your application on it.
Here we document the creation of a “Docker Swarm” environment, with hosts running on the FIWARE Lab.
First, in the “Environment” tab select the “Manage Environments”.
Then click the “Add Environment” button.
Name and the optional
Description and ensure the
Enviroment Template is set to
You will be redirected to the environments list. Select the newly created environment and switch to it! (it should now appear selected in the top-left corner).
In the new environment you will see the list of the users. A warning at the top of the page will invite you to click on the “Add a host” link. Click the link and continue reading.
Deploy your cluster
Before deploying your cluster you will need to prepare a Security Group in your FIWARE Lab Cloud to make sure all required ports are open. You need to go to your FIWARE Lab Cloud account in section "Access & Security".
For this demo, you need to have the following rules:
|Protocol||Port||Notes (just FYI)|
Now, back to the Platform Manager, in the "Add Host" procedure we can leverage on the FIWARE Lab Rancher UI driver in order to automatically create hosts on the FIWARE Lab.
The alternative is for you to have the VMs created outside this platform manager (for example from your FIWARE LAB ui), get the same Docker version installed in those VMs and afterwards come here to add such hosts following the instructions in the "Custom" selection shown in the figure below.
However, in this guide we will use the recommended FIWARE Lab Option, because it is much easier (i.e, it creates the VMs for you with required pieces of software and configurations).
In the initial page select the “FIWARE Lab” driver.
Then insert your FIWARE Cloud Lab credentials. Please note that those credential are usually different from the ones used for the OAuth2 procedure. Those credentials are the ones used for the OpenStack authentication and are the same you would use on the cloud lab. Note the username is actually the complete email address, not your "alias".
If you have more than one region enabled, you can choose where to create new hosts. Make sure you created the Security Group in the region you are about to select.
Then you need to provide some information regarding the host configuration you want to deploy. If you have resources for more than one VM, you can set the quantity accordingly and the VM names will be suffixed by instance number.
The supported configuration requires the following settings:
Ubuntu 16.04 LTS
- Security Groups: Select the one you created in the previous steps.
- Docker Install Url:
- Storage Driver:
- Docker Engine Options: key:
- FIP Pool:
To set some of those you will need to expand the "ADVANCED OPTIONS". Your config should end up looking like the example below.
Note: If your OpenStack installation uses a lower MTU than the
de-facto standard of 1500 bytes, you need to configure the Docker
Engine Option properly. The example uses
1400 because it's the one required
At the end of the page then click the “Save” button.
For a few minutes you will see a waiting page. In the background the driver is starting and provisioning the newly created hosts.
After waiting for a while (usually a couple of minutes) your host(s) should be in the “active” state.
Follow the “Swarm -> Portainer” menu to start our customized portainer web interface.
First be sure that in the settings the correct templates are loaded from the url: https://raw.githubusercontent.com/smartsdk/smartsdk-recipes/master/portainer/templates.json.
For SmartSDK recipes, two docker overlay networks named
backend need to be create as in the following screenshot. Pay close attention
to include the
com.docker.network.driver.mtu option with the value of
if your network requires to reduce the MTU, as is the case of
This ends our web graphical user interface tour. The next section explores the command-line-oriented tools in case you are interested in working from the CLI. Otherwise, you are ready to jump to the Deploy your platform services section.
Export configuration for Docker CLI
Once the host is up you can export the settings. The settings are
useful if you want to manage the host using the
You can also use the setting to connect to the host directly using
ssh. Go to "Infrastructure -> Hosts" and click in "Machine Config" as shown
below. Notice the IP address of the host whose config you are downloading.
For the ssh connection see the following example. Extract the downloaded settings file.
user@localhost tar xvzf h1.tar.gz f92db4d8-5b28-44d8-ae54-7fcb823e2e4a f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/certs f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/certs/ca-key.pem f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/certs/ca.pem f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/certs/cert.pem f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/certs/key.pem f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1 f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/ca.pem f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/cert.pem f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/config.json f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/created f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/id_rsa f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/id_rsa.pub f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/key.pem f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/server-key.pem f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/server.pem
Use ssh to connect tho the host and show the running docker containers. Check the values of your folder name and IP of the host whose config you downloaded.
user@localhost ssh -i f92db4d8-5b28-44d8-ae54-7fcb823e2e4a/machines/h1/id_rsa \ -o IdentitiesOnly=yes email@example.com sudo docker ps ################################################################################## NOTE: You have accessed a system owned by FIWARE Lab. You must have authorisation before using it, and your use will be strictly limited to that indicated in the authorisation. Unauthorised access to this system or improper use of the same is prohibited and is against the FIWARE Terms & Conditions Policy and the legislation in force. The use of this system may be monitored. ################################################################################# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 1f6bc6ebfee8 portainer/portainer:pr572 "/portainer --no-a..." 2 hours ago Up 2 hours r-portainer-portainer-ui-1-adaec9cb 15a9693cbca5 rancher/portainer-agent:v0.1.0 "/.r/r portainer-a..." 2 hours ago Up 2 hours r-portainer-portainer-1-08b16b2d 95b1d98105b9 rancher/scheduler:v0.8.3 "/.r/r /rancher-en..." 2 hours ago Up 2 hours r-scheduler-scheduler-1-59a39b48 13a513eddb52 rancher/net:v0.13.9 "/rancher-entrypoi..." 2 days ago Up 2 days r-ipsec-ipsec-connectivity-check-3-25da01ae 1d8863a459c6 rancher/net:v0.13.9 "/rancher-entrypoi..." 2 days ago Up 2 days r-ipsec-ipsec-router-3-8d16ea87 5ac088c73d44 rancher/net:holder "/.r/r /rancher-en..." 2 days ago Up 2 days r-ipsec-ipsec-3-e7a7301d 2277dc19441a rancher/net:v0.13.9 "/rancher-entrypoi..." 2 days ago Up 2 days r-ipsec-cni-driver-1-81ee523d 04262f5583fe rancher/dns:v0.17.2 "/rancher-entrypoi..." 2 days ago Up 2 days r-network-services-metadata-dns-1-30407e50 dfe285a4a9cb rancher/healthcheck:v0.3.3 "/.r/r /rancher-en..." 2 days ago Up 2 days r-healthcheck-healthcheck-1-fef6c66b c40e56bd9b43 rancher/metadata:v0.10.2 "/rancher-entrypoi..." 2 days ago Up 2 days r-network-services-metadata-1-5dc37eca 81391c45319b rancher/network-manager:v0.7.20 "/rancher-entrypoi..." 2 days ago Up 2 days r-network-services-network-manager-1-870cfe55 1d3df351c60e rancher/agent:v1.2.10-rc3 "/run.sh run" 2 days ago Up 2 days rancher-agent
In order to use the
rancher-compose CLI you need to
download the tools and the API keys.
Download them from the right bottom corner of the interface the
Download them from the right bottom corner of the interface the
Create and download the account and environment API keys from the API tab.
Make sure you have selected the correct environment.
An overview of the API page. Click on “Add Account API Key”.
Fill the name and description for the account API key
Take note of the access and secrey keys in a secure place.
Now the Environment API Key (may be hidden in "ADVANCED OPTIONS"). Click "Add Environment API Key" and fill the name and description for the Environment API key.
Take note of the access and secret keys in a secure place.
Create your Docker Swarm Cluster on your laptop
In this section we discuss how to create a cluster on your own laptop.
To create a swarm cluster on your laptop you need to:
Install Docker Machine.
Install PowerShell (only on Windows).
Create your cluster on MacOS X or Linux using miniswarm
Once you completed the installation of the above tools, on Linux and MacOS you can create your cluster using miniswarm:
$ curl -sSL https://raw.githubusercontent.com/aelsabbahy/miniswarm/master/miniswarm -o /usr/local/bin/miniswarm $ chmod +rx /usr/local/bin/miniswarm
Create a cluster of three nodes (1 master and 2 workers):
$ miniswarm start 3
Connect to your cluster:
$ eval $(docker-machine env ms-manager0)
If you are interested to explore miniswarm usage:
$ miniswarm -h
Create your cluster step-by-step on Windows / Mac / Linux
Create 3 docker virtual machines:
$ docker-machine create --driver virtualbox ms-manager0 $ docker-machine create --driver virtualbox ms-worker0 $ docker-machine create --driver virtualbox ms-worker1
Check that the virtual machines are correctly deployed:
$ docker-machine ls NAME ACTIVE DRIVER STATE URL SWARM DOCKER ERRORS ms-manager0 * virtualbox Running tcp://192.168.99.100:2376 v18.02.0-ce ms-worker0 - virtualbox Running tcp://192.168.99.101:2376 v18.02.0-ce ms-worker1 - virtualbox Running tcp://192.168.99.102:2376 v18.02.0-ce
Initialise the swarm cluster (adjust to your manager IP):
$ docker-machine ssh ms-manager0 "docker swarm init --advertise-addr <ms-manager0-ip>" Swarm initialized: current node <node ID> is now a manager.
To add a worker to this swarm, run the following command:
$ docker swarm join --token <token> <ms-manager0-ip>:<port>
To add a manager to this swarm, run (and follow the instructions)...
$ docker swarm join-token manager
Add the workers to the swarm using the token provided by the swarm manager:
$ docker-machine ssh ms-worker0 "docker swarm join \ --token <token> \ <ms-manager0-ip>:<port>" $ docker-machine ssh ms-worker1 "docker swarm join \ --token <token> \ <ms-manager0-ip>:<port>"
Connect to your cluster:
$ eval $(docker-machine env ms-manager0)
Test your cluster
List nodes in your cluster:
$ docker node ls ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS w697ke0djs3cfdf3bgbrcblam * ms-manager0 Ready Active Leader fw2ajm8zw4f12ut3sgffgdwsl ms-worker0 Ready Active z69rvapjce827l69b6zehceal ms-worker1 Ready Active
Launch a docker service:
$ docker service create --name helloworld --restart-condition=none alpine ping -c 4 docker.com sm3hi368lbsxye3n2rgdwv5xo overall progress: 1 out of 1 tasks 1/1: running [==================================================>] verify: Service converged
Check the service logs (Quit with ctrl+C)
$ docker service logs -f helloworld helloworld.1.k5jtv8w7zyu2@ms-manager0 | PING docker.com (22.214.171.124): 56 data bytes helloworld.1.k5jtv8w7zyu2@ms-manager0 | helloworld.1.k5jtv8w7zyu2@ms-manager0 | --- docker.com ping statistics --- helloworld.1.k5jtv8w7zyu2@ms-manager0 | 4 packets transmitted, 0 packets received, 100% packet loss
Remove the service (don't leave it pinging)
$ docker service rm helloworld helloworld