Docs
Karaf Deployment
Karaf Deployment Karaf Deployment
First we need to checkout the code: git clone https://github.com/base2Services/kagura.git cd kagura mvn compile package install
Open up another terminal:
In terminal 1, we are going to start the Jetty service, this is where we host the Terminal 1 cd example/javascript mvn org.mortbay.jetty:jetty-maven-plugin:8.1.12.v20130726:run
Press ^C to end it.
In terminal 2, we are going to start the Camel service which provides the REST backend. All calls the the rest services are routed through Jetty to prevent cross domain scripting issues.
Docs
Maven Deployment
Maven Deployment Maven Deployment
First we need to checkout the code: Terminal 1 git clone https://github.com/base2Services/kagura.git cd kagura mvn compile package install
Open up another terminal:
In terminal 1, we are going to start the Jetty service, this is where we host the Terminal 1 cd example/javascript mvn org.mortbay.jetty:jetty-maven-plugin:8.1.12.v20130726:run
Press ^C to end it.
In terminal 2, we are going to start the Camel service which provides the REST backend. All calls the the rest services are routed through Jetty to prevent cross domain scripting issues.
Docs
Report Providers
Report Providers Authentication ProvidersUpdated Feb 12, 2014*
Authentication Providers Feb 12, 2014Cloud editor
Authentications providers are an optional component or base component provided by the reporting-core. They are designed for 2 purposes:
Mapping Reports to Users (via groups)
Restricting the users of the system to users who are allowed to access the product
There are a couple of existing Authentication providers, and planned Authentication providers: (As of 1.4)
Authentication Provider The file Authentication provider expects to see 2 files in the reports directory: users.
Docs
REST API
REST API Report ProvidersPublished Feb 14, 2014*
Report Providers Feb 14, 2014Cloud editor
Report Providers are a tool used to return the report data, they are fairly straightforwards.
Report providers:
Report Provider Currently (1.4) the only supported mechanism for storing a file. It provides a report from a configuration as follows:
/reportconf.yaml or /reportconf.json
It depends on the com.base2.kagura.reportloc configuration option for the location. More information can be found here: Building a basic JNDI/JDBC report
Docs
Screenshots
Screenshots Screenshots
Please note, as the nature of Kagura is more of a library, but provides example service and presentation (web) layers. These screenshots do not dictate the final look of the site and users are encouraged to modify the end site to match their requirements. Version 1.2
The login screen
The welcome page:
List of reports:
A sample page. Remember we recommend you customise this.
A sample of a report configuration & directory structure.
Docs
Setting up File Authentication
Setting up File Authentication Setting up File Authentication Provider user and groups
There are a couple of Authentication providers one is the “File Authentication Provider” which is a simple file based authentication. This particular one does not employ encryption. It’s designed for demo sites. I would suggest using another authentication provider. The setup is simple, you create 2 files in the reports/ directory,
users.yaml groups.yaml Users can’t have direct access to reports, they have be placed in a group in-order to access the reports.
Docs
Use Cases
Use Cases Use Cases
Where would you use Kagura:
When you need a reporting web service that is quick to deploy and more developer friendly than existing frameworks When you need something that you can customize as all levels When you need something you can embed into your application or run separately, with no changes required to port your reports across When you need a report service which you can run in a stateless environment
Docs
War Deployment
War Deployment War Deployment
Goto http://tomee.apache.org/downloads.html download the JaxRS version. As of writing we have developed the War file for version 1.6. % tar xf apache-tomee-1.6.0-jaxrs.tar.gz % ln -sf ~/.m2/repository/com/base2/kagura/war-rest/1.2/war-rest-1.2.war apache-tomee-jaxrs-1.6.0/webapps/ % cd apache-tomee-jaxrs-1.6.0 % ./bin/startup.sh
When it starts visit:
http://localhost:8080/war-rest-1.2/
Reports are embedded into the war.
I recommend you use JNDI, you can find out how to setup JNDI data sources in tomee here: http://tomee.apache.org/configuring-datasources.html.