Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.

Commit

Permalink
Merge branch 'master' into dev/inventory-0.3.0.Final
Browse files Browse the repository at this point in the history
 Conflicts:
	console/src/main/scripts/plugins/metrics/ts/app-details/appServerDeploymentsDetails.ts
	console/src/main/scripts/plugins/metrics/ts/app-details/appServerJvmAlerts.ts
  • Loading branch information
jkremser committed Aug 20, 2015
2 parents fdd73a1 + 0522ad2 commit 1c015a7
Show file tree
Hide file tree
Showing 37 changed files with 1,405 additions and 1,153 deletions.
23 changes: 14 additions & 9 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
= Hawkular

ifdef::env-github[]
[link=https://travis-ci.org/hawkular/hawkular]
image:https://travis-ci.org/hawkular/hawkular.svg?branch=master["Build Status", link="https://travis-ci.org/hawkular/hawkular"]
endif::[]

Hawkular is a modular systems monitoring suite, that consists of several sub-projects for
storing of metrics, alerting on incoming events and more. Those projects are developed
in their own GitHub repositories and integrated in this project.

Project website: http://www.hawkular.org (its code: https://github.com/hawkular/hawkular.github.io)

Sub-projects are currently:

* https://github.com/hawkular/hawkular-metrics[Hawkular-metrics]: metric storage and retrieval engine
Expand All @@ -17,12 +24,10 @@ Sub-projects are currently:
== About this repository

In this repository we are assembling the individual pieces, sub projects and UI into
the overall Hawkular instance
the overall Hawkular instance.

ifdef::env-github[]
[link=https://travis-ci.org/hawkular/hawkular]
image:https://travis-ci.org/hawkular/hawkular.svg?branch=master["Build Status", link="https://travis-ci.org/hawkular/hawkular"]
endif::[]
In the root `pom.xml` you can actually set the particular versions of the components, but we can't
guarantee the various permutation of component versions to work together.

== Building

Expand All @@ -36,18 +41,18 @@ $ mvn install
----
Once those steps are achieved, .zip and .tgz archives will be available in `dist/target` directory.

TIP: If you build with `mvn install -Pdev` an uncompressed directory will be created in `dist/target`.
TIP: If you build with `mvn install -Pdev`, an uncompressed directory will be created in `dist/target`.
A default user will be created, the username is `jdoe` and the password is `password`. This can be convenient
when you are working on the project as you won't have to unzip/untar and register a new user. The uncompressed directory
can be found in 'dist/target/hawkular-1.0.0-SNAPSHOT/wildfly-8.2.0.Final/' and run with 'bin/standalone.sh' as normally
can be found in `dist/target/hawkular-${version}/hawkular-${version}/` and run with `bin/standalone.sh` as normally
starting a WildFly server.

Please have a look at the
http://www.hawkular.org/docs/dev/development.html[developer documentation] for more information
http://www.hawkular.org/docs/dev/development.html[developer documentation] for more information.

== License

Hawkular is released under Apache License, Version 2.0 as described in the link:LICENSE[LICENSE] document
Hawkular is released under Apache License, Version 2.0 as described in the link:LICENSE[LICENSE] document.

----
Copyright 2015 Red Hat, Inc.
Expand Down
58 changes: 1 addition & 57 deletions console/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,60 +4,4 @@
*Hawkular Console* is the home of the UI console for Hawkular. The current console is based on https://github.com/hawtio/hawtio/blob/master/docs/Overview2dotX.md[Hawt.io 2], which is (now) a javascript based client-side framework.
This console application pulls in various bower packages (libs) and Hawt.io 2 plugins (which are also bower packages) to plug-n-play various functionality to the console. Since one of the bower packages it pulls in is our Hawt.io plugin, it loads this plugin and adds it to the nav bar.

== UI Directory Structure

* ui - directory for various Hawkular UIs (currently only one)

** ui/console - The main angular.js Hawkular UI console. For more info please see: http://www.hawkular.org/docs/dev/ui-dev.html[Hawkular UI Dev Guide]

The general idea here being hawt.io UIs which are composed of plugins (that can swapped around like legos between the various UIs)

== Maven Install

The easiest way to build the console is to use maven (inside the `console` directory):

`mvn install`

No system http://nodejs.org/[Node.js] dependencies are needed.
http://nodejs.org/[Node.js] and its related modules are managed by the https://github.com/eirslett/frontend-maven-plugin[frontend-maven-plugin].
They are downloaded to the build target (./console/target) directory, where the actual http://gulpjs.com/[Gulp] based build process
(triggered by the maven plugin) happens.

To save some time during the build process, the downloaded http://nodejs.org/[Node.js] files and its related modules
don't have to be deleted after invoking the `clean` target. If you want to persist the node.js related stuff in the target
directory, please use the `cache` profile:

`mvn clean -Pcache`

In that case, the http://nodejs.org/[Node.js] is not deleted and doesn't have to be downloaded again, together with
npm modules and bower packages. Be aware, this causes the libraries not being updated.

== Hawkular-ui-components development

For the ease of development we're using the watch feature of the gulp tool. Gulp can watch for changes in source files
and update the compiled console accordingly. To use this feature, you must start Hawkular from the
`$HAWKULAR_ROOT/dist/target/hawkular-x.y.x-SNAPSHOT/wildfly-x.x.z.Final/` directory. Once the server is up and running you have to
start the actual gulp task responsible for watching the changes. To achieve this, traverse to the
`$HAWKULAR_ROOT/ui/console/target/gulp-build/` directory and run:

`gulp watch-server`

The advantage of this approach is, that is scans for file changes in the source directory and apply them directly
into the target directory (`$HAWKULAR_ROOT/dist/target/hawkular-x.y.x-SNAPSHOT/wildfly-x.y.z.Final/`), which is suitable for console
developing since it doesn't require the whole maven build to see the actual changes in the console UI.

== Other packages development

If you want to use a local version of a bower component, you can use the `link` profile together with the
https://oncletom.io/2013/live-development-bower-component/[bower link functionality]. In your bower component,
link the bower package with:

`bower link`

and then build Hawkular with the `bower.link.package` property pointing to the package name, i.e.:

`mvn clean install -Pdev -Dbower.link.package=hawkular-charts`

You don't have to specify the link profile itself with the `-P`, since it's activated everytime the `bower.link.package`
property is passed to the build. Please, be aware, that you can combine the `link` profile with other profiles, like the
`dev` profile. Don't forget to run `bower link` in the package you're about to link before using the maven `link` profile.
For more info on Hawkular UI development, please see: http://www.hawkular.org/docs/dev/ui-dev.html[Hawkular UI Dev Guide]
62 changes: 0 additions & 62 deletions console/src/main/scripts/plugins/directives/alert/html/alert.html

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

123 changes: 0 additions & 123 deletions console/src/main/scripts/plugins/metrics/html/alerts-setup.html

This file was deleted.

0 comments on commit 1c015a7

Please sign in to comment.