Introduction
Dockerfile to create a Docker container image for Warp 10.
Getting started
Installation
The easiest way to setup the Warp10 platform is to use Docker. Automated builds of the Docker Warp10 image will be available on Dockerhub and is the recommended method of installation. Until then, you can build the image yourself:
Clone this repository
git clone git@bitbucket.org:cityzendata/docker-warp10.git
Execute docker build inside your local copy
cd docker-warp10
docker build -t warp10/warp10:1.0.1
Running your Warp10 image
Start Warp 10 platform using:
Start your image binding the external ports 8080 and 8081 in all interfaces to your container.
docker run -p 8080:8080 -p 8081:8081 -d -i warp10/warp10:1.0.1
Docker containers are easy to delete. If you delete your container instance, you'll lose the Warp10 store and configuration. If you are serious about keeping Warp data persistently, then consider adding a volume mapping to the containers /data folder:
docker run --volume=/var/warp10:/data -p 8080:8080 -p 8081:8081 -d -i warp10/warp10:1.0.1
In this example you bind the container internal data folder, /data to your local folder /var/warp10.
If you use this option you must use the same --volume option in all your other docker commands on warp10 image.
Generating Tokens
The Warp 10 platform is built with a robust security model that allows you to have a tight control of who has the right to write and/or read data. The model is structured around the concepts of data producer, data owner and application, and WRITE and READ tokens.
For the purposes of this setup, you need to generate write and read tokens for a test application for a test user that is both the producer and the owner of the data. In order to interact with the user/token/application system, you need an interactive access to Warp10's Worf component. You get it by starting another container in interactive mode:
docker run -t -i warp10/warp10:1.0.1 worf.sh
Or, if you used the volume mapping in the precedent section:
docker run --volume=/var/warp10:/data -t -i warp10/warp10:1.0.1 worf.sh
Inside Worf console, you can use the encodeToken command to generate both a READ and a WRITE token for the default users and application.
Testing the container
To test the running container, push a single GTS containing one data in the platform using your WRITE token.
curl -v -H 'X-Warp10-Token: WRITE_TOKEN' --data-binary "1// test{} 42" 'http://127.0.0.1:8080/api/v0/update'
If everything is OK, you should receive a HTTP 200
When using Docker on Mac OS or Windows, there is no binding between Warp 10 API address and the host (docker is runned throw a Virtual Machine). To reach Warp10 you need to replace 127.0.0.1 by the real Ip address of the container. To get it, use a simple
docker-machine ip default>, the container address is also shown in the Settings/Ports page of your container. If you used the shared volume between the container and the host, you can access to the virtual machine usingdocker-machine ssh default>and inspect the repertory/var/warp10. Don't hesitate to check on docker-machine documentation.
Get this data using your READ tokens.
curl -v --data-binary "'READ_TOKEN' 'test' {} NOW -1 FETCH" 'http://127.0.0.1:8080/api/v0/exec'
If everything is OK, you should receive a HTTP 200 OK with your datapoint in JSON format.
A full getting started is available to guide your first steps into Warp 10.
Using Quantum
Warp 10's Quantum is a web application aiming to allow users to interact with the platform in an user-friendly way, offering an alternative to command-line interaction.
A standalone version of Quantum is packaged in the Docker image you have just installed, listening on the port 8081. In a Linux system (with binding between Warp 10 API address and the host) you can access Quantum at
127.0.0.1:8081. In Mac OS or Windows, there is no binding between Warp 10 API address and the host, you need to replace 127.0.0.1 by the real Ip address of the container as explained in the precedent section.
