Skip to content

Commit

Permalink
Merge pull request #156 from telefonicaid/release/0.1.0-including_doc…
Browse files Browse the repository at this point in the history
…umentation_about_the_Docker_repository

Including documentation about the automated build generation using Docker
  • Loading branch information
frbattid committed Jul 3, 2015
2 parents 4b7b07a + 98052e2 commit 080a87c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 14 deletions.
36 changes: 22 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

##<a id="section1"></a> Introduction
The STH component is a FIWARE component in charge of providing aggregated time series information about the evolution in
Expand Down Expand Up @@ -270,7 +271,14 @@ The STH component server is ready to be started.

[Top](#section0)

##<a id="section4"></a>Running the STH server
##<a id="section4"></a> 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)

##<a id="section5"></a>Running the STH server
1. To run the STH server, just execute:
<pre> npm start </pre>

Expand Down Expand Up @@ -352,7 +360,7 @@ of the collection names and the combination of concrete services, service paths,

[Top](#section0)

##<a id="section5"></a> Inserting data (random single events and its aggregated data) into the database
##<a id="section6"></a> 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.

Expand Down Expand Up @@ -394,7 +402,7 @@ In case of executing the tests with the CLEAN option set to false, the contents

[Top](#section0)

##<a id="section6"></a> STH component complete test coverage
##<a id="section7"></a> 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:

Expand Down Expand Up @@ -446,20 +454,20 @@ In case of executing the tests with the CLEAN option set to false, the contents

[Top](#section0)

##<a id="section7"></a>Performance tests
##<a id="section8"></a>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)

##<a id="section8"></a>Additional resources
##<a id="section9"></a>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)

##<a id="section9"></a>How to contribute
##<a id="section10"></a>How to contribute

Would you like to contribute to the project? This is how you can do it:

Expand Down Expand Up @@ -492,7 +500,7 @@ in the issue's comments to get help from them during its resolution. They will b

[Top](#section0)

##<a id="section10"></a>Contact
##<a id="section11"></a>Contact
* Germán Toro del Valle (<a href="mailto:[email protected]">[email protected]</a>, <a href="http://www.twitter.com/gtorodelvalle" target="_blank">@gtorodelvalle</a>)
* Francisco Romero Bueno (<a href="mailto:[email protected]">[email protected]</a>)
* Iván Arias León (<a href="mailto:[email protected]">[email protected]</a>)
Expand Down
1 change: 1 addition & 0 deletions package/rpm/SPECS/sth.spec
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 080a87c

Please sign in to comment.