diff --git a/README.md b/README.md index 288c6d22..1a993c3d 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,14 @@ * [Updating aggregated time series information] (#section1.3) * [Dependencies](#section2) * [Installation](#section3) -* [Running the STH server](#section4) -* [Inserting data (random single events and its aggregated data) into the database](#section5) -* [STH component complete test coverage](#section6) -* [Performance tests](#section7) -* [Additional resources] (#section8) -* [How to contribute] (#section9) -* [Contact](#section10) +* [Automatic deployment using Docker](#section4) +* [Running the STH server](#section5) +* [Inserting data (random single events and its aggregated data) into the database](#section6) +* [STH component complete test coverage](#section7) +* [Performance tests](#section8) +* [Additional resources] (#section9) +* [How to contribute] (#section10) +* [Contact](#section11) ## Introduction The STH component is a FIWARE component in charge of providing aggregated time series information about the evolution in @@ -270,7 +271,14 @@ The STH component server is ready to be started. [Top](#section0) -##Running the STH server +## Automatic deployment using Docker +To ease the testing and deployment of the STH component we have prepared a Docker repository which can be found at +[https://registry.hub.docker.com/u/gtorodelvalle/iot-sth/](https://registry.hub.docker.com/u/gtorodelvalle/iot-sth/), +including all the information needed to try and to deploy the STH component via the execution of a simple Docker command. + +[Top](#section0) + +##Running the STH server 1. To run the STH server, just execute: 
 npm start
@@ -352,7 +360,7 @@ of the collection names and the combination of concrete services, service paths, [Top](#section0) -## Inserting data (random single events and its aggregated data) into the database +## Inserting data (random single events and its aggregated data) into the database The STH component source code includes a set of tests to validate the correct functioning of the component. Amongst these tests, there is a suite to validate the insertion of aggregated time series information into the MongoDB instance. @@ -394,7 +402,7 @@ In case of executing the tests with the CLEAN option set to false, the contents [Top](#section0) -## STH component complete test coverage +## STH component complete test coverage The STH component source code includes a set of tests to validate the correct functioning of the whole set of capabilities exposed by the component. This set includes: @@ -446,20 +454,20 @@ In case of executing the tests with the CLEAN option set to false, the contents [Top](#section0) -##Performance tests +##Performance tests The [Performance tests](performance/README.md) section of the repository includes information to run performance tests on the STH component. If you are interested on them, please navigate to that section of the repository for further information. [Top](#section0) -##Additional resources +##Additional resources The [Additional resources](resource/README.md) section of the repository includes some scripts and utilities which may make the developer's life easier. If you are interested on them, please navigate to that section of the repository for further information. [Top](#section0) -##How to contribute +##How to contribute Would you like to contribute to the project? This is how you can do it: @@ -492,7 +500,7 @@ in the issue's comments to get help from them during its resolution. They will b [Top](#section0) -##Contact +##Contact * Germán Toro del Valle (german.torodelvalle@telefonica.com, @gtorodelvalle) * Francisco Romero Bueno (francisco.romerobueno@telefonica.com) * Iván Arias León (ivan.ariasleon@telefonica.com) diff --git a/package/rpm/SPECS/sth.spec b/package/rpm/SPECS/sth.spec index 675a6333..28ae8779 100644 --- a/package/rpm/SPECS/sth.spec +++ b/package/rpm/SPECS/sth.spec @@ -159,3 +159,4 @@ rm -rf $RPM_BUILD_ROOT - [FEATURE] Set the SHOULD_HASH default option to false (#95) - [BUG] Entity id and entity type are converted to lowercase in Cygnus but not in STH (#119) - [BUG] In raw request with hlimit and offset returns the last attributes firstly (#121) +- [FEATURE] Add Dockerfile for automated build generation using Docker (#149)