智能网关>> karaf-runner>> 返回
项目作者： saksmt

项目描述 ：
Cross-platform utility tool for running Apache Karaf
高级语言： Kotlin
项目地址: git://github.com/saksmt/karaf-runner.git
创建时间： 2016-06-29T16:48:29Z
项目社区：https://github.com/saksmt/karaf-runner
开源协议：MIT License
下载


karaf-runner

Cross-platform (actually not tested on M$ Windows) utility tool for running Apache Karaf

Features

  • Locate and pre-install features/kars
  • Handle cross-project dependencies
  • Copy configuration based on environment and project
  • Handling of multiple Karaf images/version/assemblies
  • Locating and running custom Karaf assemblies built with maven karaf-assembly plugin

Quick usage example

Simple as pie - just run the following:

  1. karaf-runner run from-kars --environment dev
  2. # or if you want to run your project from features:
  3. karaf-runner run from-features
  4. # or maybe you want to run custom Karaf assembly?
  5. karaf-runner run from-assembly

For more see sections below

Installation

Unix-like systems

1

  1. sudo ./install [--installation-path /usr/local/bin] [--configuration-file /usr/local/etc/karaf-runner/config]

1.1 (optional)

You may want to configure where your configuration templates and images would live

  1. # /usr/loca/etc/karaf-runner/config
  3. templatesPath += /usr/local/etc/karaf-runner
  4. imagesPath += /opt/karaf-runner/images

2

  1. sudo karaf-runner image install /path/to/directory/with/karaf-assembly

Also you can simply cd into directory with assembly and run command without path.
(Actually path needn’t to be direct parent of assembly, any parent in hierarchy is allowed,
ex. /path/to is also accepted)

3

It’s time to run it!

Windows

Windows users MUST SUFFER :smiling_imp:

OK, it’s just a joke: just build it with maven and at every execution of karaf-runner
pass -Dkaraf-runner.configurationFile=PATH_TO_YOUR_CONFIGURATION, every thing else is
backward compatible with Unix-like-section, just replace prefix according to following table:

Unix Windows
/usr/local/etc %HOME%\.config
/opt %HOME%\.opt

Also you can use configuration file to place your templates and images where you want

Template hierarchy

  1. -- /templates_root
  2.    |
  3.    +-- /base - base configuration, copied to every instance
  4.    |   |
  5.    |   +-- /my.awesome.config.cfg
  6.    |
  7.    +-- /project-skel - configuration for projects (one subdir - one project)
  8.    |   |
  9.    |   +-- /my-project - concrete project configuration
  10.    |       |
  11.    |       +-- /my.another.awesome.config.cfg
  12.    |
  13.    +-- /skel - configuration for environments (one subdir - one environment)
  14.    |   |
  15.    |   +-- /dev - configuration files for dev environment
  16.    |       |
  17.    |       +-- /my.dev.env.related.config.cfg
  18.    |
  19.    +-- /project-config - contains configuration for projects in environments
  20.        |
  21.        +-- /my-project - contains configuration for "my-project" in environments
  22.            |
  23.            +-- /dev - contains configuration for "my-project" in "dev" env
  24.                |
  25.                +-- /config.for.my-project.started.in.dev.env.cfg

Configuration

Every project dir may contain .karaf-runner.project file with karaf-runner configuration for that project.
Configuration consists of 3 parts:

  1. Projects description - contains list of project names, all of them would be used
  2. Dependencies description - contains paths of projects on which current depends
  3. Image - you can specify image to use instead of “default” as default one

Karaf-runner would scan also dependent configurations, so if your project (A) depends on project B, depending on project C
with names: C and D, you’ll have project names as following: C, D, B, A

Dependency paths may be both absolute and relative on your choice.

Format

Format is much like qmake’s .pro files, except of the only operator supported is += ^^

Keys:

  • projects
  • project - alias for projects
  • dependencies
  • dependency - alias for dependencies
  • images
  • image - alias for images

Example

  1. image = caterpillar
  2. projects += pim
  3. projects += pom
  4. dependencies += ../ssm

Usage

  1. Usage
  2.   karaf-runner <install|run|image|get-path|shutdown|help> {arguments} [options]
  4. Modules
  5.   help                              Show this help message
  6.   get-path [OPTIONS]                Get path where karaf currently installed
  7.     Options:
  8.       --image=<IMAGE_NAME>, -i <IMAGE_NAME>   Specifies image name
  9.                                               Defaults to "default" (/opt/karaf-runner/images/$IMAGE_NAME)
  11.       --raw, -r                               Just show path, without user message (useful for scripts)
  13.   install <MODE> [OPTIONS]          Installs karaf of specified version
  14.     Options:
  15.       --image=<IMAGE_NAME>, -i <IMAGE_NAME>      Specifies image name
  16.                                                  Defaults to "default" (/opt/karaf-runner/images/$IMAGE_NAME)
  18.       --project-name=<PROJECT_NAME>,             Explicitly specify project names, repeat option for
  19.       -p <PROJECT_NAME>                          setting more than one project name
  21.       -P                                         Disable ask for project name and don't copy project templates
  23.       --templates-path=<PATH>, -T <PATH>         Specify path, where templates live
  24.                                                  Defaults to /usr/local/etc/karaf
  26.       --environment=<ENV>, --env=<ENV>, -e <ENV> Specifies environment of configuration, if not set
  27.                                                  doesn't copy environment related templates
  29.       --use-assembly, -A                         Tells not to use base image and search
  30.                                                  for assembly dir instead (don't affects assembly mode)
  32.     Arguments (MODES):
  33.       from-features  Install karaf and use features as deployment files
  34.       from-kars      Install karaf and use kar's as deployment files
  35.       assembly       Don't install image and lookup for assembly dir instead
  36.                      (semantically equal to "vanilla -A")
  37.       vanilla        Install karaf and don't use any deployment files
  39.   shutdown [OPTIONS]                Drop currently installed karaf
  40.     Options:
  41.       --image=<IMAGE_NAME>, -i <IMAGE_NAME>    Specifies image name
  42.                                                Defaults to "default" (/opt/karaf-runner/images/$IMAGE_NAME)
  44.   image <MODE> [OPTIONS]            Manipulate image
  45.     Options:
  46.       --image=<IMAGE_NAME>, -i <IMAGE_NAME>   Specifies image name
  47.                                               Defaults to "default" (/opt/karaf-runner/images/$IMAGE_NAME)
  49.     Arguments (MODES):
  50.       drop-cache           Drop image cache (use it when you've updated any base karaf image)
  51.                            If image was updated with karaf-runner it is called automatically
  52.       update [IMAGE_PATH]  Replace current image with specified one (default path is $PWD)
  53.                            Path may be absolute path to image (assembly dir) or just one of
  54.                            the parent paths
  55.       install [IMAGE_PATH] Alias for "update"
  57.   run <MODE> [OPTIONS]              Install karaf and immediately run it
  58.     Options:
  59.       --image=<IMAGE_NAME>, -i <IMAGE_NAME>      Specifies image name
  60.                                                  Defaults to "default" (/opt/karaf-runner/images/$IMAGE_NAME)
  62.       --project-name=<PROJECT_NAME>,             Explicitly specify project names, repeat option for
  63.       -p <PROJECT_NAME>                          setting more than one project name
  65.       -P                                         Disable ask for project name and don't copy project templates
  67.       --templates-path=<PATH>, -T <PATH>         Specify path, where templates live
  68.                                                  Defaults to /usr/local/etc/karaf
  70.       --environment=<ENV>, --env=<ENV>, -e <ENV> Specifies environment of configuration, if not set
  71.                                                  doesn't copy environment related templates
  73.       --use-assembly, -A                         Tells not to use base image and search
  74.                                                  for assembly dir instead (don't affects assembly mode)
  76.       --endless, -E                              Endless run of karaf (restart on exit)
  78.       --debug, -d                                Run karaf in debug mode
  80.     Arguments:
  81.       from-features  Install karaf and use features as deployment files
  82.       from-kars      Install karaf and use kar's as deployment files
  83.       assembly       Don't install image and lookup for assembly dir instead
  84.                      (semantically equal to "vanilla -A")
  85.       vanilla        Install karaf and don't use any deployment files

License

All source code is licensed under MIT license