Skip to content

Commit

Permalink
Merge pull request #201 from danielcsant/bugfixing/package-generation…
Browse files Browse the repository at this point in the history
…-doc

Add build package depencencies in documentations #186
  • Loading branch information
Sergio Gómez committed May 26, 2015
2 parents 9af104b + 549f70b commit 5154340
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 11 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,28 @@ Outputs
- Spark's DataFrames Outputs
- PrintOut

Build
-----

You can generate rpm and deb packages by running:

`mvn clean package -Ppackage`

**Note:** you need to have installed the following programs in order to build these packages:

In a debian distribution:

- fakeroot
- dpkg-dev
- rpm

In a centOS distribution:

- fakeroot
- dpkg-dev
- rpmdevtools


Sandbox
-------------
- [All about how to start running the sandbox] (http://docs.stratio.com/modules/sparkta/development/sandbox.html)
Expand Down
2 changes: 1 addition & 1 deletion doc/src/site/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@

# The short X.Y version.

version = '0.4.0'
version = '0.5.0-SNAPSHOT'
# The full version, including alpha/beta/rc tags.
release = version

Expand Down
44 changes: 34 additions & 10 deletions doc/src/site/sphinx/usingSparkta.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,44 @@
Using Sparkta
******************
Using SpaRkTA
*************

Running Sparkta
============
Installing SpaRkTA
==================

Once Sparkta has been installed, you can run ``sh $SPARKTA_HOME/bin/run``.
You can install SpaRkTA by unpackaging a `release <https://github.com/Stratio/sparkta/releases>`__ or by
generating the deb or rpm packages from the `source code <https://github.com/Stratio/sparkta>`__.

You can generate rpm and deb packages by running::

mvn clean package -Ppackage

**Note:** you need to have installed the following programs in order to build these packages:

* In a debian distribution:

- fakeroot
- dpkg-dev
- rpm

* In a centOS distribution:

- fakeroot
- dpkg-dev
- rpmdevtools

Running SpaRkTA
===============

Once SpaRkTA has been installed, you can run ``sh $SPARKTA_HOME/bin/run``.
Default installation directory is ``/opt/sds/sparkta``

* Starting the Stratio Sparkta Shell::
* Starting the Stratio SpaRkTA Shell::

cd /opt/sds/sparkta

sh bin/run

Aggregation Policy
============
==================

An aggregation policy it's a JSON document. It's composed of:

Expand Down Expand Up @@ -214,7 +238,7 @@ You can save the raw data to HDFS+Parquet with only two parameters:
"rawDataGranularity": "day"

Stateful Operations
-------------
-------------------

The system runs with time windows, these windows are configurable and allow us to not associative operations:
::
Expand Down Expand Up @@ -279,8 +303,8 @@ The system runs with time windows, these windows are configurable and allow us t
"checkpointTimeAvailability": (TIME_IN_MILLISECONDS) Default: 60000


Submiting Policy
============
Submitting Policy
=================

The policy must be submitted via POST with the following syntax:
::
Expand Down

0 comments on commit 5154340

Please sign in to comment.