There are several options to use Aiakos very easily using docker. These are (in order of complexity):
- "Have everything automatically done for me". See Section 1. The Fastest Way (recommended).
- "Check the unit tests associated to the component". See Section 2. Run Unit Test of Aiakos.
- "Check the acceptance tests are running properly" or "I want to check that my Aiakos instance run properly" . See Section 3. Run Acceptance tests.
You do not need to do all of them, just use the first one if you want to have a fully operational Aiakos instance and maybe third one to check if your Aiakos instance run properly.
You do need to have docker in your machine. See the documentation on how to do this. Additionally, you can use the proper FIWARE Lab docker functionality to deploy dockers image there. See the documentation
Docker allows you to deploy an Aiakos container in a few minutes. This method requires that you have installed docker or can deploy container into the FIWARE Lab (see previous details about it).
Consider this method if you want to try Aiakos and do not want to bother about losing data.
Follow these steps:
- Download Aiakos' source code from GitHub (
git clone https://github.com/telefonicaid/fiware-aiakos.git) cd fiware-aiakos/docker- Using the command-line and within the directory you created type:
docker build -t fiware-aiakos -f Dockerfile ..
After a few seconds you should have your Aiakos image created. Just run the command docker images and you see the following response:
REPOSITORY TAG IMAGE ID CREATED SIZE
fiware-aiakos latest bd78d006c2ea About a minute ago 480.8 MB
centos 7 904d6c400333 2 weeks ago 196.8 MB
...
To execute the Aiakos image, execute the command docker run -p 3001:3001 -d fiware-aiakos. It will launch the Aiakos service listening on port 3001.
Check that everything works with
curl <IP address of a machine>:3001
You can obtain the IP address of the machine just executing docker-machine ip. What you have done with this method is the creation of the Aiakos image from the public repository of images called Docker Hub.
If you want to stop the scenario you have to execute docker ps and you see something like this:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
b8e1de41deb5 fiware-aiakos "/bin/sh -c ./start.s" 6 minutes ago Up 6 minutes 0.0.0.0:3001->3001/tcp fervent_davinci
Take the Container ID and execute docker stop b8e1de41deb5 or docker kill b8e1de41deb5. Note that you will lose any data that was being used in Aiakos using this method.
Taking into account that you download the repository from GitHub (See Section 1. The Fastest Way), this method will launch a container running Aiakos, and execute the unit tests associated to the component. You should move to the UnitTests folder ./UnitTests. Just create a new docker image executind docker build -t fiware-aiakos-unittests -f Dockerfile .. Please keep in mind that if you do not change the name of the image it will automatically create a new one for unit tests and change the previous one to tag none.
To see that the image is created run docker images and you see something like this:
REPOSITORY TAG IMAGE ID CREATED SIZE
fiware-aiakos-unittests latest 103464a8ede0 30 seconds ago 551.3 MB
centos latest 904d6c400333 2 weeks ago 196.8 MB
To execute the unit tests of this component, just execute docker run --name fiware-aiakos-unittests fiware-aiakos-unittests. Finally you can extract the information of the executed tests just executing docker cp fiware-aiakos-unittests:/opt/fiware-aiakos/report .
TIP: If you are trying these methods or run them more than once and come across an error saying that the container already exists you can delete it with
docker rm fiware-aiakos-unittests. If you have to stop it first dodocker stop fiware-aiakos-unittests.
Keep in mind that if you use these commands you get access to the tags and specific versions of Aiakos. If you do not specify a version you are pulling from latest by default.
Taking into account that you download the repository from GitHub (See Section 1. The Fastest Way). This method will launch a container to run the E2E tests of the Aiakos component, previously you should launch or configure a FIWARE Lab access. You have to define the following environment variables:
export BRANCH=develop
export KEYSTONE_IP=<IP of the keystone instance>
export ADM_TENANT_ID=<admin tenant id in the OpenStack environment>
export USER_TENANT_ID=<admin tenant id in the OpenStack environment>
export ADM_TENANT_NAME=<admin tenant name>
export USER_TENANT_NAME=<user tenant name>
export ADM_USERNAME=<admin username>
export USER_USERNAME=<username>
export ADM_PASSWORD=<admin password>
export USER_PASSWORD=<user password>
export Region1=qaregion
export OS_USER_DOMAIN_NAME=<OpenStack user domain name>
export OS_PROJECT_DOMAIN_NAME=<OpenStack project domain name>
Take it, You should move to the UnitTests folder ./AcceptanceTests. Just create a new docker image executing docker build -t fiware-aiakos-acceptance .. To see that the image is created run docker images and you see something like this:
REPOSITORY TAG IMAGE ID CREATED SIZE
fiware-aiakos-acceptance latest eadbe0b2e186 About an hour ago 579.3 MB
fiware-aiakos latest a46ffad45e60 4 hours ago 480.8 MB
centos latest 904d6c400333 2 weeks ago 196.8 MB
...
Now is time to execute the container. This time, we take advantage of the docker compose. Just execute docker-compose up to launch the architecture. You can take a look to the log generated executing docker-compose logs. If you want to get the result of the acceptance tests, just execute docker cp docker_fiware-aiakos-aceptance_1:/opt/fiware-aiakos/test/acceptance/testreport .
Please keep in mind that if you do not change the name of the image it will automatically create a new one for unit tests and change the previous one to tag none.
TIP: you can launch a FIWARE Lab testbed container to execute the Aiakos E2E test. Just follow the indications in FIWARE Testbed Deploy. It will launch a virtual machine in which a reproduction of the FIWARE Lab is installed. Keep in mind that in that case Region1 have to be configured with the value qaregion.
You could move to the PackageGenerator folder ./PackageGenerator in order to create/launch docker container for generate a RPM file and upload it to Fiware lab repositories
First, you must define the following environment variables:
export OS_USERNAME_VALUE = <admin username>
export OS_PASSWORD_VALUE = <admin password>
export OS_TENANT_NAME_VALUE = <admin tenant name>
Execute docker commands as follow:
$ docker build -t fiware-aiakos-rpm .
$ docker run --name fiware-aiakos-rpm fiware-aiakos-rpm
After that, navegate to Fiware lab repositories to download the fiware-aiakos rpm.
You can configure a yum repository /etc/yum.repos.d to install with yum tool:
[fiware]
name=FIWARE repository
baseurl=http://repositories.lab.fiware.org/repo/rpm/x86_64/
enabled=1
gpgcheck=0
Things to keep in mind while working with docker containers and Aiakos.
Everything you do with Aiakos when dockerized is non-persistent. You will lose all your data if you turn off the Aiakos container. This will happen with either method presented in this README.
If you do not want to have to use sudo follow these instructions.